Payout Account Type
| accountType Value | Description |
|---|---|
| 0 | (Corriente) |
| 1 | (Ahorro) |
TIP
If the beneficiary bank is an electronic wallet, please use 1 Savings Account (Ahorro) as the account type.
Payout Payee ID Type
| idType Value | Abbreviation | Description |
|---|---|---|
| 1 | CC | Cedula de Ciudadania |
| 2 | CE | Cedula de Extranjeria |
| 3 | TI | Tarjeta de ldentidad |
| 4 | NIT | Numero deldentificacion Tributaria |
| 5 | PA | Pasaporte |
TIP
When initiating a payment transaction, pls refer to the actual document type used when opening the beneficiary bank account. Inconsistency will result in payment failure.
For example: If the user uses an NIT certificate to open an account, and the type of certificate that is transparently transmitted when initiating payment is CC, the payment will fail.
Payout Bank List
TIP
The bank support list is subject to the actual support status of the production environment. It is recommended that you call our bank list query interface to confirm the production bank support status before entering the production environment.
Payout Order Status Enum
| Parameter | Description | Remark |
|---|---|---|
| PROCESSING | PROCESSING | |
| WAITING | Wait for payment | |
| PAYING | Payment Paying | |
| SUCCESS | Payment successful | Order final status |
| FAIL | Payment failed | Order final status |
| CANCEL | Order Canceled | Order final status |
TIP
Note that when processing callbacks or query results from Cashy, the order status should be accurately judged. Only the final result can be considered as a clear success of the collection order.
Payout Order Status Description
| Value | Description |
|---|---|
| GATEWAY_TIMEOUT | Payment gateway timeout |
| AMOUNT_ERROR | Wrong amount |
| PARAM_IS_NULL | Required parameters are empty |
| NONSUPPORT_PAY_CASH | Does not support cash payment |
| NONSUPPORT_CREDIT_CARD | Credit cards are not supported |
| APPID_ERROR | Wrong application ID |
| PARAM_ERROR | Parameter error |
| SYSTEM_EXCEPTION | Upstream system exception |
| PAYMENT_TRANSACTION_EXCEPTION | Payment transaction exception |
| PAYMENT_QUERY_FAIL | Payment query failed |
| BANK_NAME_ERROR | Wrong bank name |
| BANK_CODE_ERROR | Bank coding error |
| BANK_ACCOUNT_ERROR | Wrong bank account number |
| PAYMENT_OFFSET | Payment offset |
| INFO_STRUCTURE_INVALID | Customer information error |
| OUT_ACCOUNT_BALANCE | Exceeded account amount limit |
| ACCOUNT_NOT_EXIST | Account does not exist |
| INVALID_ACCOUNT_NUMBER | Invalid account number |
| ACCOUNTS_NOT_AUTHORISED_FOR_CREDITING | Unauthorized crediting to account |
| NUMBER_AND_DOCUMENTS_NOT_MATCH | Account number and ID do not match |
| NAME_AND_ACCOUNT_NOT_MATCH | Name and Account number do not match |
| DOCUMENTS_INVALID | The document number is invalid |
| ACCOUNT_NOT_ENABLED | Account is not enabled |
| BLOCKED_ACCOUNTS | Blocked accounts |
| ACCOUNT_TYPE_NOT_VALID_FOR_TARGET_BANK | The account type is invalid for the target bank |
| EACH_PAYMENT_LIMIT_EXCEEDED | The payment amount exceeds the maximum limit for a single payment |
| DAILY_PAYMENT_LIMIT_EXCEEDED | The payment amount exceeds the maximum daily cumulative payment limit |
| MONTHLY_PAYMENT_LIMIT_EXCEEDED | The payment amount exceeds the maximum monthly cumulative payment limit |
| YEARLY_PAYMENT_LIMIT_EXCEEDED | The payment amount exceeds the maximum annual cumulative payment limit |
| AMOUNT_TOO_SMALL | The payment limit was too low and was rejected by the bank |
| ACCOUNTING_BILL_ERROR | Error paying bill |
| PHONE_NUMBER_INVALID | Invalid mobile number |
| EMAIL_INVALID | Invalid email |
| NAME_INVALID | Invalid name |
| PAYMENT_REJECTED_BY_BANK | Payment transaction declined by bank |
| UNKNOWN_ERROR | Unknown error |
Payin User Type
| userType | Abbreviation | Description |
|---|---|---|
| 1 | NATURAL | NATURAL |
| 2 | LEGAL | LEGAL |
TIP
Only when idCard is NIT, userType is LEGAL, otherwise it is NATURAL.
Payin Payer ID Type
| idType | Abbreviation | Description |
|---|---|---|
| 1 | CC | Cedula de Ciudadania |
| 2 | CE | Cedula de Extranjeria |
| 3 | TI | Tarjeta de ldentidad |
| 4 | NIT | Numero deldentificacion Tributaria 2-14 digits |
| 5 | PA | Pasaporte |
- CC:
Cedula de Ciudadania(Civil Identity Card) is the main document used to prove resident status in Colombia. It is the primary legal document used by residents to prove their identity and residency. - CE:
Cedula de Extranjeria(Foreigner’s Identity Card) is an identity document used by foreigners residing in Colombia. It is the main document for foreigners to prove their identity and legal residence. - TI:
Tarjeta de ldentidad(Minors’ Identity Card) is an identity document used to prove the identity of minors in Colombia. It is the main document for minors under 18 years of age to prove their identity and enjoy their rights. - NIT:
Numero deldentificacion Tributaria(Taxpayer Identification Number) is a taxpayer identification number used to identify an individual or legal entity. In business and tax circles, NIT is a unique identifier used to identify a taxpayer. - PA:
Pasaporte(Passport) is an international travel document used to prove the identity and nationality of the holder and is recognized for international travel. It is usually issued by the country's diplomatic service or consulate.
Payin PayType Enum
| Payment Methods | payType | Description | Support status |
|---|---|---|---|
| PayDesk | 153 | Paylink | The payin interface does not currently support this payment method. |
| NEQUI_PUSH | 154 | Nequi Wallet App Push | The payin interface does not currently support this payment method. |
| NEQUI | 155 | Nequi Wallet Payment | |
| EFECTY | 156 | Efecty Cash payment | |
| PSE | 157 | PSE Online | |
| BANCOLOMBIA_BUTTON | 158 | Bancolombia online bank transfer | The payin interface does not currently support this payment method. |
| BANCOLOMBIA_CASH | 159 | Bancolombia-Cash | The payin interface does not currently support this payment method. |
| COBRU | 161 | Cobru QR | The payin interface does not currently support this payment method. |
| CORRESPONSAL_BANCOLOMBIA | 162 | Cash payment |
Payin Order Status Enum
| Parameter | Description | Remark |
|---|---|---|
| PAYING | Wait for payment | |
| SUCCESS | Payment successful | Order final status |
| FAIL | Payment failed | Order final status |
TIP
Note that when processing callbacks or query results from Cashy, the order status should be accurately judged. Only the final result can be considered as a clear success of the collection order.
Paydesk Order Status Enum
| Value | Description |
|---|---|
| PAYING | Order awaiting payment |
| SUCCESS | payment successful |
Common Error Messages
| Value | Description | Countries covered |
|---|---|---|
System_error | System error | All |
System_busy | System busy (Can retry) | All |
System_Maintenance | System Maintenance (Can retry) | All |
MerchantId_is_null | MerchantId is empty | All |
Sign_verify_error | Merchant signature verification error | All |
RequestMethod_not_post | Not a POST request | All |
RequestContentType_not_json | Not an application/json request | All |
RequestBody_is_null | The request body is empty | All |
MerchantId_not_Number | MerchantId is not a number | All |
MerchantId_is_error | Merchant Id error | All |
Request_ip_notWhiteList | Request ip non-whitelist | All |
Params_jsonFormat_error | Request body json format error | All |
Params_xxx_Required | Parameter xxx is required | All |
Params_xxx_error | Parameter xxx error | All |
Params_accountNo_Format_isIncorrect | The bank account number format is incorrect (the length of the bank card number does not match the bank) | Some countries |
Merchant_amount_notEnough | Merchant balance is insufficient | All |
Merchant_not_enabled | Merchant is not enabled | All |
Merchant_not_exist | Merchant does not exist | All |
Params_order_notExist | The platform order number does not exist | All |
Params_mchOrderNo_notExist | The Merchant order number does not exist | All |
Params_mchOrderNo_repeat | Duplicate Merchant order number | All |
Channel_Maintenance_time | The channel is under maintenance, please contact technical support for testing environment | All |
Tran_risk_intercept | Transaction risk control interception, check whether the amount meets the restriction conditions | All |
Params_accountName_Maximum<40>characters | Payout (beneficiary) payee name is too long | Some countries，MX is 40 characters |
Params_realName_not_contain_Chinese | Account names are not allowed to contain Chinese | All |
Params_accountName_not_contain_Chinese | Account names are not allowed to contain Chinese | All |
Params_accountNo_Clabe_Invalidate | Clabe is invalid | Mexico |
Params_accountNo_CardNumber_Invalidate | Bank CardNumber is invalid | Mexico |
Params_email_format_invalid | The email format is invalid | Mexico |
Params_email_length_exceeds<64>characters | The mailbox length exceeds 64 characters (the mailbox length should be kept below 64 characters) | All |
Params_accountName_Required | Please pass the recipient account name | Some countries |
Params_accountName_Maximum<64>characters | The recipient account name must not exceed 64 characters | Some countries |
Params_accountName_not_contain_Chinese | The recipient account name must not contain Chinese | Some countries |
Params_CPF_accountNo_Invalid | The recipient account number in CPF format is invalid | Brazil |
Params_idType_Required | ID type must be passed | Some countries |
Params_idType_Invalid | Invalid ID type | Some countries |
Params_idCard_Required | ID number must be passed | Some countries |
Params_idCard_CPF_Invalid | Invalid CPF ID number | Brazil |
Params_realName_Required | The name of the payee must be passed | Some countries |
Params_realName_Maximum<64>characters | The name of the payee must not exceed 64 characters | Some countries |
Params_realName_not_contain_Chinese | The name of the payee must not contain Chinese | Some countries |
COLLECTION_ACCOUNT_DAY_LIMIT | The number of times the payment card number reaches the daily limit limit | All |
COLLECTION_NAME_DAY_LIMIT | The number of times the payee name reaches the daily limit limit | All |
LIMIT_MIN_AMOUNT | The order amount is less than the minimum amount limit | All |
LIMIT_MAX_AMOUNT | The order amount is higher than the maximum amount limit | All |
BLACK_LIST_USER_LIMIT | The user is on the blacklist | All |