Transfer-out created

Cash-out transfer event. The Cash-out transfer endpoint generates this event.

Type: object
Domain: integrated-payments
Event: transfer_out_created
Version: 1

account required

Title: Account ID
Description: Pismo account ID
Type: integer
Example:
31700

authorization required

Title: Authorization ID
Description: Pismo authorization ID
Type: integer
Example:
123

status required

Title: Transaction status
Description: Transaction status
Type: string
Must be one of the following:
PROCESSING
SETTLED
CANCELLED
ERROR
Example:
PROCESSING

amount required

Title: Transaction amount
Description: Transaction amount
Type: number
Format: double
Example:
20.15

credit_party required

Title: Account object
Description: Credit party's account information
Type: object

bank required

Title: Bank ID
Description: Bank ID. In Brazil, this is the bank's ISPB number, an 8-digit value.
Type: string
Example:
30306294

bank_branch required

Title: Bank branch
Description: Bank branch ID.
Type: string
Example:
3094

account_number required

Title: Account ID
Description: Account ID such as a bank account number.
Type: string
Example:
98765432

document_number required

Title: Client ID
Description: Client's government document numnber.
Type: string
Example:
12345678900

name required

Title: Client name
Description: Client name.
Type: string
Example:
Forrest Rainger

debit_party required

Title: Account object
Description: Debit party's account information
Type: object

bank required

Title: Bank ID
Description: Bank ID. In Brazil, this is the bank's ISPB number, an 8-digit value.
Type: string
Example:
30306294

bank_branch required

Title: Bank branch
Description: Bank branch ID.
Type: string
Example:
3094

account_number required

Title: Account ID
Description: Account ID such as a bank account number.
Type: string
Example:
98765432

document_number required

Title: Client ID
Description: Client's government document numnber.
Type: string
Example:
12345678900

name required

Title: Client name
Description: Client name.
Type: string
Example:
Forrest Rainger

transaction_datetime required

Title: Transaction datetime
Description: Transaction created UTC date and time
Type: string
Format: date-time
Example:
2023-01-01T10:10:00Z

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "Transfer-out created",
    "description": "Cash-out transfer event. The [Cash-out transfer](https://developers.pismo.io/pismo-docs/reference/post-integrated-payments-api-v1-bankslips-cashout) endpoint generates this event.",
    "required": [
        "account",
        "authorization",
        "status",
        "amount",
        "credit_party",
        "debit_party",
        "transaction_datetime"
    ],
    "properties": {
        "account": {
            "type": "integer",
            "title": "Account ID",
            "description": "Pismo account ID",
            "examples": [
                31700
            ]
        },
        "authorization": {
            "type": "integer",
            "title": "Authorization ID",
            "description": "Pismo authorization ID",
            "examples": [
                123
            ]
        },
        "status": {
            "type": "string",
            "title": "Transaction status",
            "description": "Transaction status",
            "enum": [
                "PROCESSING",
                "SETTLED",
                "CANCELLED",
                "ERROR"
            ],
            "examples": [
                "PROCESSING"
            ]
        },
        "amount": {
            "type": "number",
            "format": "double",
            "title": "Transaction amount",
            "description": "Transaction amount",
            "examples": [
                20.15
            ]
        },
        "credit_party": {
            "description": "Credit party's account information",
            "$ref": "#/definitions/account"
        },
        "debit_party": {
            "description": "Debit party's account information",
            "$ref": "#/definitions/account"
        },
        "transaction_datetime": {
            "title": "Transaction datetime",
            "type": "string",
            "format": "date-time",
            "description": "Transaction created UTC date and time",
            "examples": [
                "2023-01-01T10:10:00Z"
            ]
        }
    },
    "definitions": {
        "account": {
            "type": "object",
            "title": "Account object",
            "description": "Account information object",
            "required": [
                "bank",
                "bank_branch",
                "account_number",
                "document_number",
                "name"
            ],
            "properties": {
                "bank": {
                    "type": "string",
                    "title": "Bank ID",
                    "description": "Bank ID. In Brazil, this is the bank's ISPB number, an 8-digit value.",
                    "examples": [
                        "30306294"
                    ]
                },
                "bank_branch": {
                    "type": "string",
                    "title": "Bank branch",
                    "description": "Bank branch ID.",
                    "examples": [
                        "3094"
                    ]
                },
                "account_number": {
                    "type": "string",
                    "title": "Account ID",
                    "description": "Account ID such as a bank account number.",
                    "examples": [
                        "98765432"
                    ]
                },
                "document_number": {
                    "type": "string",
                    "title": "Client ID",
                    "description": "Client's government document numnber.",
                    "examples": [
                        "12345678900"
                    ]
                },
                "name": {
                    "type": "string",
                    "title": "Client name",
                    "description": "Client name.",
                    "examples": [
                        "Forrest Rainger"
                    ]
                }
            }
        }
    }
}

{
    "account": 31700,
    "authorization": 123,
    "status": "PROCESSING",
    "amount": 20.15,
    "credit_party": {
        "bank": "30306294",
        "bank_branch": "3094",
        "account_number": "98765432",
        "document_number": "12345678900",
        "name": "Forrest Rainger"
    },
    "debit_party": {
        "bank": "30306294",
        "bank_branch": "3094",
        "account_number": "98765432",
        "document_number": "12345678900",
        "name": "Forrest Rainger"
    },
    "transaction_datetime": "2023-01-01T10:10:00Z"
}

Updated 4 days ago