Payouts

Example of callbacks for Payout transaction

Locked

{
    "transactionType": "PayOut",
    "transactionFlow": null,
    "country": "COL",
    "data": {
        "externalId": "{{externalId}}",
        "internalId": "{{internalId}}",
        "paymentMethod": {
            "code": "0060"
        },
        "country": "Country",
        "currency": "Currency",
        "amount": 0.0,
        "accountNumber": "yourAccount",
        "confirmed": {
            "currency": "Country",
            "fxQuote": 0.0,
            "amount": 100.0
        },
        "payment": {
            "currency": "Currency",
            "fxQuote": 0.0,
            "amount": 100.0
        },
        "localTaxes": [
            {
                "description": "ROUTERTEST",
                "currency": "currency",
                "fxSource": 0,
                "fxQuote": 0.0,
                "amount": 0.0,
                "account": "{{yourAccount}}"
            }
        ],
        "withHoldings": [],
        "fees": {
            "description": "Fee",
            "currency": "currency",
            "fxSource": 0,
            "fxQuote": 0,
            "amount": 0,
            "account": "{{yourAccount}}"
        },
        "status": {
            "code": "101",
            "description": "LOCKED",
            "detail": "The payout has been confirmed and passed AML validations"
        },
        "sender": {
            "type": "INDIVIDUAL",
            "name": "John",
            "lastName": " LastName",
            "document": {
                "type": "CC",
                "id": "111111111"
            },
            "birthdate": "0001-01-01T00:00:00Z"
        },
        "beneficiary": {
            "type": "INDIVIDUAL",
            "name": "Name Test  ",
            "lastName": "LastName Test",
            "document": {
                "type": "CC",
                "id": "1000000000"
            },
            "birthdate": "0001-01-01T00:00:00Z",
            "bank": {
                "name": "Bank",
                "code": "1062",
                "account": {
                    "type": "S",
                    "number": "accountNumber"
                }
            }
        },
        "merchant": {
            "type": "COMPANY",
            "name": "Merchant Name",
            "birthdate": "0001-01-01T00:00:00Z"
        },
        "date": {
            "creationDate": "2024-07-31T14:45:28Z",
            "processedDate": "2024-07-31T14:45:30Z"
        }
    }
}

Completed

{
    "transactionType": "PayOut",
    "transactionFlow": null,
    "country": "COL",
    "data": {
        "externalId": "{{externalId}}",
        "internalId": "internalId",
        "paymentMethod": {
            "code": "0060"
        },
        "country": "country",
        "currency": "currency",
        "amount": 0.0,
        "accountNumber": "{{yourAcccount}}",
        "confirmed": {
            "currency": "COP",
            "fxQuote": 0.0,
            "amount": 0.0
        },
        "payment": {
            "currency": "COP",
            "fxQuote": 0.0,
            "amount": 00.0
        },
        "localTaxes": [
            {
                "description": "ROUTERTEST",
                "currency": "currency",
                "fxSource": 0.0,
                "fxQuote": 0,
                "amount": 00,
                "account": "{{yourAccount}}"
            }
        ],
        "withHoldings": [],
        "fees": {
            "description": "Fee",
            "currency": "COP",
            "fxSource": 0.0,
            "fxQuote": 0.0,
            "amount": 0.0,
            "account": "{{yourAccount}}"
        },
        "status": {
            "code": "200",
            "description": "COMPLETED",
            "detail": "The payout was debited"
        },
        "sender": {
            "type": "INDIVIDUAL",
            "name": "Name",
            "lastName": " LastName",
            "document": {
                "type": "CC",
                "id": "11111111"
            },
            "birthdate": "0001-01-01T00:00:00Z"
        },
        "beneficiary": {
            "type": "INDIVIDUAL",
            "name": "Name Test  ",
            "lastName": "LastName Test",
            "document": {
                "type": "CC",
                "id": "2222222222"
            },
            "birthdate": "0001-01-01T00:00:00Z",
            "bank": {
                "name": "Bank",
                "code": "1062",
                "account": {
                    "type": "S",
                    "number": "111820063694"
                }
            }
        },
        "merchant": {
            "type": "COMPANY",
            "name": "Merchant Name",
            "birthdate": "0001-01-01T00:00:00Z"
        },
        "date": {
            "creationDate": "2024-07-31T15:06:18Z",
            "processedDate": "2024-07-31T15:18:34Z"
        }
    }
}

Rejected

{
    "transactionType ": "PayOut ",
    "transactionFlow ": null,
    "data ": {
        "transactionType ": "payOut ",
        "externalId ": "111111111",
        "internalId ": "11111111111",
        "paymentMethod ": {
            "code ": "0050 "
        },
        "country ": "Country",
        "currency ": "Currency",
        "amount ": 50.0,
        "accountNumber ": "{{AccountNumber}}",
        "confirmed ": {
            "currency ": "Currency",
            "fxQuote ": 1.0,
            "amount ": 1.0
        },
        "payment ": {
            "currency ": "Currency",
            "fxQuote ": 1.0,
            "amount ": 1.0
        },
        "localTaxes ": [],
        "withHoldings ": [],
        "fees ": {
            "description ": "Fee ",
            "currency ": "Currency",
            "fxQuote ": 1.0,
            "amount ": 1.0
        },
        "status ": {
            "code ": "302 ",
            "description ": "REJECTED ",
            "detail ": "Invalid control string characters "
        },
        "sender ": {
            "type ": "INDIVIDUAL ",
            "name ": "Sender",
            "lastname ": "Sender LastName ",
            "document ": {
                "type ": "{{type}}",
                "id ": "{{DocumentId}} "
            },
            "birthdate ": "0001-01-01T00:00:00Z "
        },
        "beneficiary ": {
            "type ": "INDIVIDUAL ",
            "name ": "Beneficiary Name ",
            "lastname ": "Beneficiary LastName  ",
            "document ": {
                "type ": "Type",
                "id ": "{{DocumentId}}"
            },
            "birthdate ": "0001-01-01T00:00:00Z ",
            "bank ": {
                "name ": "Banco",
                "code ": "049 ",
                "account ": {
                    "type ": "Type",
                    "number ": "AccountNumber"
                }
            }
        },
        "merchant ": {
            "type ": "COMPANY ",
            "name ": "Merchant Name ",
            "birthdate ": "0001-01-01T00:00:00Z "
        },
        "date ": {
            "creationDate ": "2023-10-23T19:54:41Z ",
            "processedDate ": "2023-10-23T19:55:51Z "
        }
    }
}

Cancelled

{
    "transactionType": "PayOut",
    "transactionFlow": null,
    "country": "COL",
    "data": {
        "externalId": "{{externalId}}",
        "internalId": "{{internalId}}",
        "paymentMethod": {
            "code": "0060"
        },
        "country": "COL",
        "currency": "COP",
        "amount": 0,
        "accountNumber": "{{yourAccountNumber}}",
        "confirmed": {
            "currency": "COP",
            "fxQuote": 0.0,
            "amount": 0.0
        },
        "payment": {
            "currency": "COP",
            "fxQuote": 0.0,
            "amount": 0.0
        },
        "localTaxes": [
            {
                "description": "ROUTERTEST",
                "currency": "COP",
                "fxSource": 0.0,
                "fxQuote": 0.0,
                "amount": 0.0,
                "account": "{{yourAccountNumber}}"
            }
        ],
        "withHoldings": [],
        "fees": {
            "description": "Fee",
            "currency": "COP",
            "fxSource": 0.0,
            "fxQuote": 0.0,
            "amount": 0.0,
            "account": "{{yourAccountNumber}}"
        },
        "status": {
            "code": "900",
            "description": "CANCELLED",
            "detail": "The payout was cancelled"
        },
        "sender": {
            "type": "INDIVIDUAL",
            "name": "John",
            "lastName": " LastName",
            "document": {
                "type": "documentType",
                "id": "11111111"
            },
            "birthdate": "0001-01-01T00:00:00Z"
        },
        "beneficiary": {
            "type": "INDIVIDUAL",
            "name": "Name Test  ",
            "lastName": "LastName Test",
            "document": {
                "type": "documentType",
                "id": "2222222222"
            },
            "birthdate": "0001-01-01T00:00:00Z",
            "bank": {
                "name": "Banco",
                "code": "1062",
                "account": {
                    "type": "S",
                    "number": "111820063694"
                }
            }
        },
        "merchant": {
            "type": "COMPANY",
            "name": "Merchant Name",
            "birthdate": "0001-01-01T00:00:00Z"
        },
        "date": {
            "creationDate": "2024-08-05T20:48:22Z",
            "processedDate": "2024-08-05T20:48:25Z"
        }
    }
}

Returned

{
    "transactionType": "PayOut",
    "transactionFlow": null,
    "country": "ECU",
    "data": {
        "transactionType": "payOut",
        "externalId": "{{ExternalId}}",
        "internalId": "{{InternalId}}",
        "paymentMethod": {
            "code": "0090"
        },
        "country": "ECU",
        "currency": "USD",
        "amount": 7.33,
        "accountNumber": "{{AcountNumeber}}",
        "confirmed": {
            "currency": "USD",
            "fxQuote": 1,
            "amount": 1
        },
        "payment": {
            "currency": "USD",
            "fxQuote": 1,
            "amount": 1
        },
        "localTaxes": [],
        "withHoldings": [],
        "fees": {
            "description": "Fee",
            "currency": "USD",
            "fxQuote": 1,
            "amount": 1
        },
        "status": {
            "code": "901",
            "description": "RETURNED",
            "detail": "The payout was returned"
        },
        "sender": {
            "type": "INDIVIDUAL",
            "name": "SenderName",
            "lastname": "SenderLastName",
            "document": {
                "type": "CI",
                "id": "{{Id}}"
            },
            "birthdate": "0001-01-01T00:00:00Z"
        },
        "beneficiary": {
            "type": "INDIVIDUAL",
            "name": "Name Test ",
            "lastname": "LastName Test",
            "document": {
                "type": "PASS",
                "id": "{{id}}"
            },
            "birthdate": "0001-01-01T00:00:00Z",
            "bank": {
                "name": "BankName",
                "code": "0017",
                "account": {
                    "type": "S",
                    "number": "1234567890"
                }
            }
        },
        "merchant": {
            "type": "COMPANY",
            "name": "Merchant Name",
            "birthdate": "0001-01-01T00:00:00Z"
        },
        "date": {
            "creationDate": "2023-11-14T14:20:43Z",
            "processedDate": "2023-11-14T14:27:49Z"
        }
    }
}