Parameters
Please, consider the following parameters of this payload:
Element | Mandatory | Description | Type |
action | Yes | Description of the process to be achieved. Fixed value: “pay_out” | string |
pay_out.name | Yes | Description for the current request | string |
pay_out.country | Yes | Three-digit ISO code of the country | string |
pay_out.currency | Yes | Transaction currency in 3 digit ISO numeric value | string |
pay_out.payments. internal_transaction_id | Yes | Transaction operation number | string |
pay_out.payments. payment_date | Yes | Date at which the payment should be done | YYYY-MM-DD |
payee.bank_name | Yes | Name of the bank | string |
payee.first_name | Yes | Fist name of the payee | string |
payee.email_addres | Yes | Email of the payee | string |
payee.account_type | Yes | Type of account (savings, current, vista, rut, etc) | string |
payee. account_number | Yes | The identifier of an account | numeric |
payee.cci_number | Only for Peru, for the rest of the countries it is not mandatory | The interbank account identifier | numeric |
payee.identity_document_countr y | Yes | Country of issuance of the identity document | string |
payee.identity_document_type | Yes | Type of id document | string |
payee. identity_document_identifier | Yes | The identification number | numeric |
This will return a valid response like the following:
{"action": "pay_out",
"success": "true", "pay_out": {
"id": "1fea6786-a0ea-43b6-abe7-e12f00ecf242", "name": "Retiro de apuestas ganadas 20220311134434", "country": "PER",
"payments": [
{
"internal_transaction_id": "123e4567-e89b-12d3-a456-426614174000", "is_valid": "true"
}]
},
"meta": {
"metrics": {
"aggregate": {
"start": "1614875661264",
"end": "1614875672681",
"duration": {
"milliseconds": "1000",
"seconds": "1"
}}
},
"status": { "code": "00",
"message": "OK", "message_ilgn": [
{
"locale": "es_PE", "value": "Pay out creado" }]
}}
}
In the following item you can see examples for each country