Response code
The response returned by PayBy will contain the response code and message. Different codes represent different meanings, below is a list of possible codes, along with additional information about how to resolve them.
Global
| code | msg | Description |
|---|---|---|
| 0 | SUCCESS | The request has been successful |
| 400 | INVALID_PARAMETER | The parameter has not been passed correctly, please adjust the parameter |
| 400 | REQUESTTIME_TOO_EARLY | The difference between the request time and the current time cannot exceed 15 minutes |
| 400 | REQUESTTIME_TOO_LATER | The difference between the request time and the current time cannot exceed 15 minutes |
| 402 | RATE_LIMIT_REJECT | Request frequency is too high |
| 403 | UNAUTHORIZED | Merchant does not have permission to use this API, please contact PayBy |
| 404 | SERVICE_NOT_AVAILABLE | API service is temporarily unavailable |
| 500 | SYSTEM_ERROR | System error |
| 504 | SERVICE_TIMEOUT | Timeout |
| 601 | RISK_FAIL | The request was intercepted by the risk control system, please contact PayBy |
Payment & Refund
Create order
| code | msg | Description |
|---|---|---|
| 62001 | ORDER_PAID | Create order request cannot be executed when order is in this state |
| 62002 | ORDER_FAILURE | Create order request cannot be executed when order is in this state |
| 62003 | ORDER_SETTLED | Create order request cannot be executed when order is in this state |
| 62008 | EXPIREDTIME_LESS_THAN_REQUESTTIME | The expiredTime should be later than request time |
| 62009 | EXPIREDTIME_TOO_LATER | The expiredTime should not exceed 48 hours after the request time. |
| 62012 | PAYSCENECODE_ILLEGAL | The parameter is outside the range of enumerated values |
| 62016 | MERCHANT_ORDER_NO_EXIST | An order has already been created with the same merchantOrderNumber |
| 62018 | PAYERMID_NOT_EXIST | PayerMid not exist |
| 62019 | PAYEEMID_NOT_EXIST | PayeeMid not exist |
| 62020 | PAYERMID_PAYEEMID_ARE_SAME | PayerMid and PayeeMid cannot be the same |
| 62026 | PRODUCT_IS_NOT_APPLIED | Merchant does not have permission to use this API, please contact PayBy |
| 62031 | MISSING_IAP_DEVICE_ID | Missing iapDeviceId |
| 62032 | MISSING_APP_ID | Missing AppId |
| 62033 | MISSING_AUTHCODE | Missing authCode |
| 62034 | INVALID_APP_ID | Invalid appId |
| 62036 | MERCHANT_DEVICE_NOT_EXIST | This device doesnot exist in merchant account |
| 62037 | DEVICE_ACCESS_FORBIDDEN | This device is forbidden to access |
| 62042 | MISSING_AUTH_PROTOCOL_NO | Missing authProtocolNo |
| 62047 | MISSING_AUTH_TOKEN | Missing authToken |
| 62048 | MISSING_UNIQUE_DEVICE | Missing uniqueDevice |
| 62049 | MISSING_CARD_NO | Missing cardNo |
| 62050 | MISSING_HOLDER_NAME | Missing holderName |
| 62051 | MISSING_CVV | Missing cvv |
| 62052 | MISSING_PLATFORM_TYPE | Missing platformType |
| 62053 | MISSING_EXP_YEAR | Missing expYear |
| 62054 | MISSING_EXP_MONTH | Missing expMonth |
| 62055 | MISSING_CUSTOMER_ID | Missing customerId |
| 62056 | MISSING_EMAIL | Missing email |
| 62057 | INVALID_SAVE_CARD | Invalid saveCard, please pass true or false |
| 62058 | INVALID_THREEDSECURE | Invalid threeDSecure, please pass true or false |
| 62059 | INVALID_EMAIL | Invalid email |
| 62060 | INVALID_PLATFORM_TYPE | Invalid platformType, please check the enumerated values |
| 62061 | MISSING_REAL_IP | Missing realIP |
| 62062 | INVALID_REAL_IP | Invalid realIP |
| 62063 | INVALID_EXP_YEAR | Invalid expYear |
| 62064 | INVALID_EXP_MONTH | Invalid expMonth |
| 62065 | INVALID_CARD_NO | Invalid cardNo |
| 62066 | INVALID_CVV | Invalid cvv |
| 62067 | HOLDER_NAME_TOO_LONG | Holder name max length is 64 |
| 62068 | MISSING_SAVE_CARD | Missing saveCard |
| 62069 | CARD_NO_LENGTH_UNMATCH | cardNo length does not meet the requirements, usually 16 to19 |
| 62070 | CARD_BIN_NOT_SUPPORTED | cardBin does not support |
| 62071 | CARD_BIN_UNAVAILABLE | cardBin unavailable |
| 62072 | MISSING_REDIRECT_URL | Missing redirectUrl |
| 62073 | INVALID_ONE_TIME_PAYMENT | Invalid oneTimePayment, please pass true or false |
| 62078 | CARD_NOT_EXIST | Card not saved or has been deleted |
| 62079 | MISSING_CARD_NO_CARD_TOKEN | cardToken and cardNo cannot be empty at the same time |
| 62080 | MISSING_EWALLET_CODE | Missing eWalletCode |
| 62081 | INVALID_EWALLET_CODE | Invalid eWalletCode, please check the enumerated values |
Cancel order
| code | msg | Description |
|---|---|---|
| 62001 | ORDER_PAID | Cancel order request cannot be executed when order is in this state |
| 62002 | ORDER_FAILURE | Cancel order request cannot be executed when order is in this state |
| 62003 | ORDER_SETTLED | Cancel order request cannot be executed when order is in this state |
| 62004 | MERCHANT_ORDER_NO_NOT_EXIST | The merchant order number being passed does not exist, please check the parameter |
| 62035 | ORDER_NO_NOT_EXIST | Order number does not exist, please check the parameter |
Revoke order
| code | msg | Description |
|---|---|---|
| 62004 | MERCHANT_ORDER_NO_NOT_EXIST | Merchant order number does not exist, please check the parameter |
| 62035 | ORDER_NO_NOT_EXIST | Order number does not exist, please check the parameter |
| 62039 | REVOKE_FAILURE | Request failed, please try again |
| 62041 | ACQUIRE_ORDER_REFUNDED | The order has been refunded and cannot be revoked |
| 62046 | REVOKE_REJECTED | Request is rejected |
Refund order
| code | msg | Description |
|---|---|---|
| 62002 | ORDER_FAILURE | Refund order request cannot be executed when order is in this state |
| 62004 | MERCHANT_ORDER_NO_NOT_EXIST | Merchant order number does not exist, please check the parameter |
| 62006 | REFUND_AMOUNT_EXCEEDED | Refund amount exceeds refundable amount |
| 62015 | ORDER_NOT_PAID | Refund order request cannot be executed when order is in this state |
| 62017 | REFUND_MERCHANT_ORDER_NO_EXIST | The refund merchant order number has generated a refund order |
| 62035 | ORDER_NO_NOT_EXIST | The order number of payment does not exist, please check the parameter |
| 62036 | MERCHANT_DEVICE_NOT_EXIST | This device doesnot exist in merchant account |
| 62038 | INVALID_SECONDARY_MERCHANT | The parameter secondary merchant must be the same with that of the payment order |
| 62040 | ACQUIRE_ORDER_REVOKED | The payment order has been revoked and cannot be refunded |
| 62045 | REFUND_REJECTED | Request is rejected |
Retrieve checkout URL
| code | msg | Description |
|---|---|---|
| 62082 | TOKEN_URL_NOT_EXIST | tokenUrl does not exist or has expired |
Retrieve order detail
| code | msg | Description |
|---|---|---|
| 62004 | MERCHANT_ORDER_NO_NOT_EXIST | The merchant order number being passed does not exist, please check the parameter |
| 62035 | ORDER_NO_NOT_EXIST | The order number being passed does not exist, please check the parameter |
Fundout
Transfer
| code | msg | Description |
|---|---|---|
| 62002 | ORDER_FAILURE | The order has failed |
| 62016 | MERCHANT_ORDER_NO_EXIST | The merchant order number has generated a transfer order |
| 62020 | PAYERMID_PAYEEMID_ARE_SAME | Payer and payee cannot be the same |
| 62023 | NAME_NOT_MATCH | The payee name being passed does not match the KYC information |
| 62026 | PRODUCT_IS_NOT_APPLIED | Merchant does not have permission to use this API, please contact PayBy |
| 62027 | BENEFICIARY_NOT_EXIST | The payee does not exist |
| 62028 | ORDER_SUCCESS | The order has been successful |
| 62029 | ORDER_CREATED | The order has been created |
Transfer to bank
| code | msg | Description |
|---|---|---|
| 62002 | ORDER_FAILURE | The order has failed |
| 62016 | MERCHANT_ORDER_NO_EXIST | The merchant order number has generated a transfer order |
| 62026 | PRODUCT_IS_NOT_APPLIED | Merchant does not have permission to use this API, please contact PayBy |
| 62028 | ORDER_SUCCESS | The order has been successful |
| 62029 | ORDER_CREATED | The order has been created |
Transaction failure reason
| code | msg | Description |
|---|---|---|
| 92000 | Risk control rejection | PayBy risk control system rejected the transaction |
| 92001 | The amount of transaction exceeds the limit | Transaction amount exceeds the maximum limit |
| 92002 | The number of transactions exceeds the limit | The number of transactions exceeds the maximum limit |
| 92003 | Non-KYC user transactions | User has not completed KYC verification |
| 92004 | Channel rejection | The external fundout channel rejected the transaction |
Retrieve order detail
| code | msg | Description |
|---|---|---|
| 62004 | MERCHANT_ORDER_NO_NOT_EXIST | The merchant order number being passed does not exist, please check the parameter |
| 62035 | ORDER_NO_NOT_EXIST | The order number being passed does not exist, please check the parameter |
Card
Unbind card
| code | msg | Description |
|---|---|---|
| 62078 | CARD_NOT_EXIST | Card not saved or has been deleted |
Retrieve card detail
| code | msg | Description |
|---|---|---|
| 62078 | CARD_NOT_EXIST | Card not saved or has been deleted |
Reconciliation
Download statements
| code | msg | Description |
|---|---|---|
| 62013 | STATEMENT_NOT_EXIST | Statement not generated. Please wait a few minutes or check if the date being passed is a future date. |
Digital Receipt
| code | msg | Description |
|---|---|---|
| 76001 | ORDER_NO_NOT_EXIST | The order number being passed does not exist, please check the parameter |
| 76002 | PRODUCT_IS_NOT_APPLIED | Merchant does not have permission to use this API, please contact PayBy |
| 76003 | MEMBER_NOT_EXIST | The payBy partner id being passed does not exist, please check the parameter |
| 76004 | RECEIPT_NO_NOT_EXIST | The receipt number being passed does not exist, please check the parameter |