Payout Account Type
| Account Type Value | Description | Remark |
|---|---|---|
| 3 | Bank account number | 16 digits, will validate |
| 40 | Clabe | 18 digits, will validate |
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 Freeze |
| ACCOUNT_BLOCKED | Account frozen |
| TRACKING_KEY_REPEATED | Issuer tracking key exception |
| CODI_WITHOUT_NOTICE | CODI does not notify payment |
| ISSUED_CERT_EXPIRED | The issued certificate has expired |
| COMPLIANCE_REJECT | Payment declined due to compliance |
| INVALID_BANK_INSTITUTION | Invalid operating organization |
| CLABE_INSTITUTION_NOT_MATCH | CLABE does not match institution |
| REJECT_BY_PLD | Rejected by PLD |
| ACCOUNT_CANCEL | Account canceled |
| ACCOUNT_IN_ANOTHER_CURRENCY | Account in another currency |
| ACCOUNT_NOT_BELONG_TO | Account does not belong to receiving participant |
| MCH_NOT_KNOW_PAYMENT | The payee does not acknowledge the payment |
| MISS_MUST_PAYMENT_INFO | Missing required information to complete payment |
| ERROR_PAYMENT_TYPE | Wrong payment method |
| ERROR_OPERATION_TYPE | Error 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 accounts will not receive payments not from Banxico |
| INFO_STRUCTURE_INVALID | The additional information structure is incorrect |
| UNKNOWN_ERROR | Unknown error |
| 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 |
| UP_STREAM_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 |
| 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 |
| 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 |
| PAYMENT_REJECTED_BY_BANK | Payment transaction declined by bank |
| PAYMENT_CANCEL_BY_BANK | The payment transaction was canceled by the bank |
| PAYMENT_REJECTED_BY_BENEFICIARY_BANK | The payment transaction was rejected by the beneficiary bank |
| PAYMENT_REJECTED_BY_BENEFICIARY_USER | The payment transaction was declined by the payee |
Payin PayType Enum
| Paytype Value | Pay Product | Description |
|---|---|---|
| 41 | OXXO | OXXO Store Cash Payment (Supported Stores: OXXO) |
| 69 | SPEI | SPEI (Clabe) - Online Bank Transfer |
| 70 | PAYLINK | Aggregate Cashier - Not Supported |
| 71 | PAYNET | PayNet Store Cash Payment (Supported Stores: 7-11， Walmart (retailer)) |
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 |