Integrated payments financial reconciliation

This event occurs after an integrated payments transaction has been cleared and accounts debited and credited. The Pay bank slip and Cash-out transfer endpoints generate this event.

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

provider required

Title: Provider
Description: Provider that created the external transfer.
Type: string
Example:
BTG

provider_authorization_id

Title: Provider authorization ID
Description: Provider's authorization ID.
Type: string or null
Example:
0a2a85a3-ca26-4f00-97a6-c23825f1df7e

provider_id

Title: Provider bank slip ID
Description: Provider's bank slip ID
Type: string
Example:
78ebbdeb-5084-4741-b2af-0b531f9d1099

authorization_id

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

authorization_datetime

Title: Authorization datetime
Description: Authorization datetime on Pismo platform
Type: string or null
Format: date-time
Example:
2021-10-29T11:00:00.000Z

result required

Title: Result
Description: Financial reconciliation result.
Type: boolean
Example:
true
false

result_description required

Title: ResultdDescription
Description: Financial reconciliation result description
Type: string
Example:
OK
PISMO_TRANSACTION_NOT_FOUND
PROVIDER_TRANSACTION_INVALID_STATUS
TRANSACTION_AMOUNT_DIVERGENT

amount

Title: Amount authorized
Description: Authorization amount on Pismo platform
Type: number or null
Format: double
Example:
125.5

provider_amount

Title: Provider amount
Description: Provider returned amount
Type: number or null
Format: double
Example:
125.5

transaction_id required

Title: Transaction Identifier
Description: Integrated payments transaction ID
Type: string
Example:
0a2a85a3-ca26-4f00-97a6-c23825f1df7e

transaction_type

Title: Transaction type
Description: Integrated payments transaction type
Type: string
Must be one of the following:
CASHOUT
CASHIN
BANKSLIP
Example:
CASHOUT

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "Integrated payments financial reconciliation",
    "description": "This event occurs after an integrated payments transaction has been cleared and accounts debited and credited. The [Pay bank slip](https://developers.pismo.io/pismo-docs/reference/post-integrated-payments-api-v1-bankslips-pay) and [Cash-out transfer](https://developers.pismo.io/pismo-docs/reference/post-integrated-payments-api-v1-bankslips-cashout) endpoints generate this event.",
    "required": [
        "provider",
        "result",
        "result_description",
        "transaction_id"
    ],
    "properties": {
        "provider": {
            "type": "string",
            "title": "Provider",
            "description": "Provider that created the external transfer.",
            "examples": [
                "BTG"
            ]
        },
        "provider_authorization_id": {
            "type": [
                "string",
                "null"
            ],
            "title": "Provider authorization ID",
            "description": "Provider's authorization ID.",
            "examples": [
                "0a2a85a3-ca26-4f00-97a6-c23825f1df7e"
            ]
        },
        "provider_id": {
            "type": "string",
            "title": "Provider bank slip ID",
            "description": "Provider's bank slip ID",
            "examples": [
                "78ebbdeb-5084-4741-b2af-0b531f9d1099"
            ]
        },
        "authorization_id": {
            "type": [
                "integer",
                "null"
            ],
            "title": "Authorization ID",
            "description": "Pismo authorization ID",
            "examples": [
                123
            ]
        },
        "authorization_datetime": {
            "type": [
                "string",
                "null"
            ],
            "title": "Authorization datetime",
            "description": "Authorization datetime on Pismo platform",
            "format": "date-time",
            "examples": [
                "2021-10-29T11:00:00.000Z"
            ]
        },
        "result": {
            "type": "boolean",
            "title": "Result",
            "description": "Financial reconciliation result.",
            "examples": [
                true,
                false
            ]
        },
        "result_description": {
            "type": "string",
            "title": "ResultdDescription",
            "description": "Financial reconciliation result description",
            "examples": [
                "OK",
                "PISMO_TRANSACTION_NOT_FOUND",
                "PROVIDER_TRANSACTION_INVALID_STATUS",
                "TRANSACTION_AMOUNT_DIVERGENT"
            ]
        },
        "amount": {
            "type": [
                "number",
                "null"
            ],
            "format": "double",
            "title": "Amount authorized",
            "description": "Authorization amount on Pismo platform",
            "examples": [
                125.5
            ]
        },
        "provider_amount": {
            "type": [
                "number",
                "null"
            ],
            "format": "double",
            "title": "Provider amount",
            "description": "Provider returned amount",
            "examples": [
                125.5
            ]
        },
        "transaction_id": {
            "type": "string",
            "title": "Transaction Identifier",
            "description": "Integrated payments transaction ID",
            "examples": [
                "0a2a85a3-ca26-4f00-97a6-c23825f1df7e"
            ]
        },
        "transaction_type": {
            "type": "string",
            "title": "Transaction type",
            "description": "Integrated payments transaction type",
            "enum": [
                "CASHOUT",
                "CASHIN",
                "BANKSLIP"
            ],
            "example": "CASHOUT"
        }
    }
}

{
    "provider": "BTG",
    "provider_authorization_id": "0a2a85a3-ca26-4f00-97a6-c23825f1df7e",
    "provider_id": "78ebbdeb-5084-4741-b2af-0b531f9d1099",
    "authorization_id": 123,
    "authorization_datetime": "2021-10-29T11:00:00.000Z",
    "result": true,
    "result_description": "OK",
    "amount": 125.5,
    "provider_amount": 125.5,
    "transaction_id": "0a2a85a3-ca26-4f00-97a6-c23825f1df7e",
    "transaction_type": "CASHOUT"
}

Updated 16 days ago