Error Codes
Error
BasicEx Pay uses traditional HTTP response codes to indicate the success or failure of an API request. In general: codes in the 2xx range indicate success, 4xx range indicate an error due to the provided information (e.g., missing required parameters), and 5xx range indicate a BasicEx Pay business or server error.
Status Code | Description |
---|---|
200 - OK | Success, all operations completed |
400 - Bad Request | The request was not processed correctly, incorrect parameters |
401 - Unauthorized | Incorrect signature or not provided correctly |
429 - Too Many Requests | Request rate limit exceeded |
500, 502, 503, 504 - Server Errors | Business processing error or server error |
Error Response Format
When the HTTP status code is not 200, an error response will be returned as follows:
{
"code": "GW400001",
"data": null,
"message": "Invalid invoice status",
"param": "",
"requestId": "d5678c4d-adf5-40ed-8061-70aa047a70ae"
}
Name | Description | Type |
---|---|---|
code | Error code, if not 0000, indicates failure | string |
data | The error response will be empty | string |
param | Returned when HTTP Status is 400 for parameter errors | string |
requestId | Unique identification ID for each request, used to identify the request | string |
Request Parameter Error: GW400xxx
When the request parameters are not validated, an error code starting with GW400xxx will be returned, and the param will return the corresponding parameter that is not validated.
Invoice Payment Errors: GW5011xx
These errors are mapped to invoice resources.
Name | Description | Type |
---|---|---|
GW501102 | Invoice does not exist or no permission to operate | string |
GW501103 | Payment feature is disabled for this merchant | string |
GW501104 | Failed to retrieve cryptocurrency information | string |
GW501106 | Exchange rate calculation failed | string |
GW501107 | Payment amount exceeds the merchant's daily limit | string |
Payout Request Errors: GW5012xx
These errors are mapped to payout resources.
Name | Description | Type |
---|---|---|
GW501202 | Payout feature is disabled for this merchant | string |
GW501203 | Payout amount exceeds the merchant's daily limit | string |
GW501204 | Failed to retrieve order information | string |
GW501205 | Payout object does not exist | string |
GW501206 | Merchant order number already exists | string |
GW501211 | Failed to query payout address | string |
GW501212 | Payout object account status abnormal | string |
GW501213 | Payout failed: insufficient balance | string |
GW501214 | This currency is not supported | string |
GW501215 | This blockchain is not supported | string |
GW501216 | Payout amount below the minimum threshold | string |
GW501217 | Error getting account configuration | string |
BasicEx Server Errors: GW500xxx
When returning an error code starting with GW500xxx, it indicates a BasicEx system server failure. This is generally less encountered. If you encounter such error codes, please contact the BasicEx customer support team.