Payout Payee ID Type
No specified
Payout Account Type
| accountType Value | Description |
|---|---|
3 | Bank Account |
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 |
|---|---|
| CHANNEL_IB_TRY_AGAIN_LATER | Channel abnormality, please try again later |
| CHANNEL_NETWORK_FLUCTUATION | The channel network fluctuates. Please confirm that the account is correct and try again. |
| UPSTREAM_CHANNEL_EXCEPTION | The upstream channel is abnormal, please try again later |
| BANK_ACCOUNT_INVALID | Invalid bank account number |
| TEMPORARILY_UNABLE_PROCESS_FOR_THIS_BANK | Transactions for this bank cannot be processed temporarily |
| UNKNOWN_ERROR | Unknown error |
Payin PayType Enum
| Value | Description |
|---|---|
411 | BANK transfer |
412 | PromptPay transfer |
413 | Truemoney E-wallet |
414 | Truemoney payment page |
ImportantReminder 1
Currently, the PromptPay method is used for collection. The validity period of the generated QR code is five minutes. Please inform the user to pay within five minutes. Orders after five minutes need to be manually recorded by the bank. At that time, the user's payment voucher will be required to record the corresponding order.
ImportantReminder 2
Currently, the bank transfer method is used for collection by card. When the corresponding bank card is frozen and offline, please inform the user not to save the card number for payment. A new card number needs to be obtained through the app. We are not responsible for the amount transferred after offline.
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 |