Payout Account Type
accountType | Description |
|---|---|
| 1 | Bank Account Number |
| 2 | Wallet Account |
TIP
When the payment recipient bank is an e-wallet, accountType needs to be 2, and accountNo is the e-wallet payment account.
Payout Payee ID Type
idType | Description |
|---|---|
| SSS | Social Security System |
| TIN | Tax Identification Number |
| Passport | Passport Number |
| PhiHealth | Philippine Health Card, a medical certificate similar to a health insurance card. |
| Driver's license | Voter ID |
| UMID | Unique Multi-Purpose ID |
| PRC ID | Philippine Permanent Resident Card |
| GSIS ID | Education Certificate |
| Student's ID | Student ID |
| ｜Pag-IBIG | People's Insurance Company of the Philippines |
| National ID | National ID |
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
| 值 | Description |
|---|---|
| CHANNEL_SYSTEM_BUSY | 上游渠道繁忙 |
| BENEFICIARY_BANK_ACCOUNT_ERROR | 收款银行账户异常 |
| BANK_ACCOUNT_BLOCKED | 收款银行账户被冻结 |
| EXCEEDED_BENEFICIARY_ACCOUNT_AMOUNT_LIMIT | 超过账户收款金额限制 |
| CHANNEL_EXCEPTION | 上游渠道异常 |
| PAYMENT_REJECTED_BY_CHANNEL | 付款交易被渠道拒绝 |
| UNKNOWN_ERROR | 未知错误 |
TIP
附加解释:
EXCEEDED_BENEFICIARY_ACCOUNT_AMOUNT_LIMIT, 以Gcash为例：不同认证等级的账户会有不同的月/日收款限额
Payin Payer ID Type
idType | Description |
|---|---|
| SSS | Social Security System |
| TIN | Tax Identification Number |
| Passport | |
| PhiHealth | Philippine Health Card, a medical certificate similar to a health insurance card. |
| Driver's license | Voter ID |
| UMID | Unique Multi-Purpose ID |
| PRC ID | Philippine Permanent Resident Card |
| GSIS ID | Education Certificate |
| Student's ID | Student ID |
| ｜Pag-IBIG | People's Insurance Company of the Philippines |
| National ID | National ID |
Payin PayType Enum
payType | Description | Status | Product Description | Notes |
|---|---|---|---|---|
| 401 | QRPH_STATIC | Enable | QRPh static QR code | No amount limit, multiple payments |
| 402 | QRPH_DYNAMIC | Enable | QRPh dynamic QR code | Limited amount, single payment |
| 403 | BANK_TRANSFER_INSTA | Enable | INSTA bank virtual account | No amount limit, multiple payments (less than 50,000 yuan) |
| 404 | BANK_TRANSFER_PESONET | Enable | PESONET bank virtual account | No amount limit, multiple payments (more than 50,000 yuan) |
| 410 | RefNo (Bill Payment) | Enable | Repayment code (Bill Payment) | Unlimited amount, multiple payments, multiple repayment methods |
| 431 | GCASH_WEB_ONLINE | Enable | Gcash e-wallet online payment | Limited amount, single payment |
| 432 | PAYMAYA_WEB_ONLINE | Enable | Paymaya e-wallet online payment | Limited amount, single payment |
| 433 | COINS_WEB_ONLINE | Enable | Coins e-wallet online payment | Limited amount, single payment |
| 434 | GRABPAY_WEB_ONLINE | Enable | GrabPay e-wallet online payment | Limited amount, single payment |
| 435 | BPIA_WEB_ONLINE | Enable | BPIA online banking online payment | Limited amount, single payment |
| 436 | UBPB_WEB_ONLINE | Enable | UBPB online banking online payment | Limited amount, single 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.
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 |