Payout Payee ID Type
idType | 说明 |
|---|---|
| CPF | CPF |
| CNPJ | CNPJ |
Payout Account Type
| accountType | Description | Example | remarks |
|---|---|---|---|
| 1 | CPF | 22*****99 | 11 digits (excluding . and -) |
| 2 | CNPJ | 23*******31 | 14 digits |
| 3 | merchant@example.com | User email | |
| 4 | PHONE | +5511987654321 | Must start with +55 |
| 5 | EVP | Temporarily deactivate this payment method UUID-like format xxxxx-xxxx-xxxx-xxx | 32-digit alphanumeric string sent from the central bank to the institution |
| 6 | RANDOM | Random payment |
TIP
- We will perform format verification and validity verification on CPF and CNPJ, and the channel will perform authenticity verification on CPF and CNPJ.
- Format verification and validity verification will return the verification results synchronously. Orders that fail the verification will be directly rejected.
- The authenticity verification will be verified by the Central Bank of Brazil after the order is submitted to the Central Bank of Brazil. Failure to pass the verification will result in withdrawal failure.
- CPF verification algorithmRefer
- CNPJ verification algorithmRefer
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 |
|---|---|
| ACCOUNT_NOT_EXIST | Account does not exist |
| ACCOUNT_FREEZING | Account is frozen |
| ACCOUNT_CANCEL | Account is canceled |
| ACCOUNT_IN_ANOTHER_CURRENCY | Account in another currency |
| ACCOUNT_NOT_BELONG_TO | Account does not belong to the receiving participant |
| ACCOUNT_EXCEPTION | Receiving account exception |
| MCH_NOT_KNOW_PAYMENT | Receiptee does not acknowledge payment |
| MISS_MUST_PAYMENT_INFO | Required information to complete payment is missing |
| ERROR_PAYMENT_TYPE | Wrong payment method |
| ERROR_OPERATION_TYPE | Wrong operation type |
| ACCOUNT_TYPE_NOT_APPLICABLE | Account type not applicable |
| INVALID_CHARACTER | Invalid character |
| OUT_ACCOUNT_BALANCE | Exceeded authorized account balance limit |
| OUT_ACCOUNT_MONTH_BALANCE | Exceeded the credit limit allowed for the account for the month |
| NOT_REGISTER_TELPHONE | Unregistered mobile number |
| NOT_RECEIVE_BANXICO_PAYMENT | Additional account will not receive payments not from Banxico |
| INFO_STRUCTURE_INVALID | Additional information structure is incorrect |
| UNKNOWN_ERROR | Unknown exception |
| SUCCESS | Success |
| AMOUNT_ERROR | Amount error |
| PARAM_ERROR | Parameter error |
| NOT_SUPPORTED_CASH | Cash payment is not supported |
| NOT_SUPPORTED_CREDIT | Credit card payment is not supported |
| SYSTEM_ERROR | System exception |
| INVALID_BANK_ACCOUNT | Invalid bank account |
| RUT_INVALID | Invalid RUT (Chile) |
| COMPLIANCE_REJECT | Payment rejected for compliance reasons (Chile) |
| INVALID_CCI | Invalid CCI (Peru) |
| PAYMENT_REJECT_BY_RECEIPT_PSP | Payment rejected by the beneficiary's PSP (Brazil) |
| BENEFICIARY_ACCOUNT_FREQUENCY_RISK_BY_BANK | Beneficiary account triggers upstream bank transaction frequency risk control (Brazil), in this case, please suspend the withdrawal operation of the beneficiary account and try again after a period of time |
| ACCOUNT_NOT_FOUND | The corresponding beneficiary account was not found |
| PAGAMENTO_EXPIRADO_POR_TIMEOUT | (Pagamento expirado por timeout) Payment expired due to timeout (Brazil), usually caused by fluctuations in the Brazilian Central Bank |
| CHANNEL_IB_TRY_AGAIN_LATER | Channel abnormality, please try again later |
Payin Payer ID Type
idType | Description |
|---|---|
| CPF | CPF |
Payin PayType Enum
| Value | Description |
|---|---|
| 140 | PIX |
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.
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 |