Error Responses
The API categorises the various failures by their respective error codes. The body of the response will be JSON in the following format:
{"errors": [
{
error: "string",
error_code: "string",
error_handling: "string"
}
]
}
The field error
returns the error message specific to your request, error_code
returns the unique code identifying the error and error_handling
returns the instruction on how to resolve the error.
Should you face any difficulties with solving the errors, please contact Developer Support.
Error Classes
Authentication (HTTP Error Code: 401)
STX Error Code | Error Message | Error Handling |
---|---|---|
STXE-1000 | Missing API Key in Header | Please include your API key in the Authorization header of your request. |
STXE-1000 | Invalid API Key | Please ensure that you have provided the correct API key. |
STXE-1000 | Missing API Key Pair in Header | Please include your API key and secret in the Authorization header of your request. |
STXE-1000 | Invalid API Key Pair | Please ensure that you have provided the correct API key and secret. |
STXE-1000 | Invalid IP Address | Please ensure that you have whitelisted the correct IP Address. |
Old error codes that are still in use:
STX Error Code | Error Message |
---|---|
XFE5 | :error_code_description: "Api token is invalid" :error_handling: "Make sure you entered the correct API key or contact customer support at https://support.straitsx.com/support/home." |
XFE16 | :error_code_description: "Invalid request" or "Duplicated request" :error_handling: "API request not supported. Make sure you entered the correct API key or contact customer support at https://support.straitsx.com/support/home." |
Authorization (HTTP Error Code: 403)
STX Error Code | Error Message | Error Handling |
---|---|---|
STXE-2000 | Restricted API Access | You do not have permission to use this API. |
STXE-2000 | Restricted API Access | Your account is locked, please contact Customer Support at https://support.straitsx.com/support/home. |
STXE-2000 | Restricted API Access | Bank transfers for USD are currently unavailable for users identified as Chinese Nationals residing in Mainland China, in line with local regulations. |
Old error codes that are still in use:
STX Error Code | Error Message |
---|---|
XFE6 | :error_code_description: "Access to this endpoint is denied" :error_handling: "You do not have the necessary permissions to access this endpoint. Please contact customer support at https://support.straitsx.com/support/home for assistance." |
XFE603 | :error_code_description: "Not allowed to carry out request" :error_handling: "Invalid request. Please call another API or contact customer support." |
Bad Request (HTTP Error Code: 400)
STX Error Code | Error Message | Error Handling |
---|---|---|
STXE-3000 | Custom message | Please ensure that you are using the correct parameters. |
Old error codes that are still in use:
STX Error Code | Error Message |
---|---|
XFE12 | :error_code_description: "Invalid parameter" :error_handling: "Make sure you entered the correct parameters." |
XFE15 | :error_code_description: "Required parameter empty" :error_handling: "Make sure you entered the correct required parameter." |
Conditions Not Met (HTTP Error Code: 400)
STX Error Code | Error Message | Error Handling |
---|---|---|
STXE-4000 | Resource Object Not Verified. | Please verify your accounts first. |
STXE-4000 | Feature Unavailable For Your Region. | Please make sure your region is able to access this feature. |
STXE-4000 | Feature Unavailable For This Request. | Please make sure your parameters are valid to access this feature. |
STXE-4000 | Threshold Exceeded. | Please make sure you have enough limits. |
STXE-4000 | Invalid State Transition. | Please try again later. |
STXE-4000 | Invalid OTP. | Please make sure you provide correct OTP. |
STXE-4000 | Insufficient Balance. | Please make sure your account has sufficient balance. |
STXE-4000 | Customer Profile Is Not Verified. | Please make sure your customer profile is verified. |
STXE-4000 | Customer Profile Has Insufficient Info. | Please make sure you provide sufficient information. |
STXE-4000 | Amount Exceed Limit. | Please make sure your requested amount within the limit. |
STXE-4000 | Amount Exceed Daily Limit. | Please make sure your requested amount within the limit. |
STXE-4000 | Amount Exceed Annual Limit. | Please make sure your requested amount within the limit. |
STXE-4000 | Resubmission of Verification Info Not Allowed. | We cannot render service to this customer due to StraitsX Policy. |
STXE-4000 | Failure in a contract processing. | Please contact the support. |
Old error codes that are still in use:
STX Error Code | Error Message |
---|---|
XFE17 | :error_code_description: "Insufficient customer profile data for USD" :error_handling: "Please supplement missing information on Customer Profile required for USD capability" |
XFE18 | :error_code_description: "Invalid bank account for USD withdrawal" :error_handling: "SWIFT code of this bank account is invalid" |
XFE19 | :error_code_description: "Invalid bank account for USD withdrawal" :error_handling: "Bank account from a nonbank financial institution is not allowed for USD withdrawal" |
XFE21 | :error_code_description: "Insufficient account balance" :error_handling: "Make sure you have sufficient balance and try again." |
XFE22 | :error_code_description: "Insufficient user kyb data for USD" :error_handling: "Please supplement missing information on User KYB required for USD capability" |
XFE503 | :error_code_description: "Failed name check" :error_handling: "Bank account name and name provided have to be similar." |
XFE504 | :error_code_description: "Maximum number of bank accounts" :error_handling: "Delete existing bank accounts." |
XFE505 | :error_code_description: "Bank abbrev provided invalid" :error_handling: "Use GET base-api-url api/v3/banks to get the correct bank abbrev." |
XFE506 | :error_code_description: "Required bank data are empty" :error_handling: "Bank abbrev, bank account no, and bank account name are required." |
XFE601 | :error_code_description: "Conditions to withdraw not met. Can be solved by changing amount" :error_handling: "Your withdrawal does not meet the conditions required. Please follow the instructions in the response." |
XFE602 | :error_code_description: "Exceeds limit. Need to wait it out." :error_handling: "Your withdrawal exceeds the limit for the time period. Please change the amount or verify your account." |
Not Found (HTTP Error Code: 404)
STX Error Code | Error Message | Error Handling |
---|---|---|
STXE-5000 | Record Not Found | The requested resource could not be found. Please ensure that you have provided valid parameters and try again. |
STXE-5000 | Configuration Not Found | The requested resource could not be found. Please ensure that you have provided valid parameters and try again. |
STXE-5000 | Risk Rating Not Found | The requested resource could not be found. Please ensure that you have provided valid parameters and try again. |
Old error codes that are still in use:
STX Error Code | Error Message |
---|---|
XFE13 | :error_code_description: "Record not found" :error_handling: "Please check that you provided the correct API Key and the correct parameters." |
Method Not Allowed (HTTP Error Code: 405)
STX Error Code | Error Message | Error Handling |
---|---|---|
STXE-6000 | Restricted Endpoints Access in Live Mode | The requested endpoint is only available in sandbox mode. Please switch to sandbox mode. |
Old error codes that are still in use:
STX Error Code | Error Message |
---|---|
XFE10 | :error_code_description: "Invalid environment" :error_handling: "Request not supported for this environment." |
Unprocessable Content (HTTP Error Code: 422)
STX Error Code | Error Message | Error Handling |
---|---|---|
STXE-7000 | Duplicated Idempotency Key. | Idempotency Key has already been used in different request. Please use another idempotency key. |
STXE-7000 | Record Existed. | Please check your parameters and ensure it's valid. |
Failed Dependency (HTTP Error Code: 424)
STX Error Code | Error Message | Error Handling |
---|---|---|
STXE-8000 | Remote API Request Failed | An unexpected error occurred, please try again. If the problem persists, please retry in a few minutes. |
STXE-8000 | API Request to BAAS Failed | An unexpected error occurred, please try again. If the problem persists, please retry in a few minutes. |
STXE-8000 | API Request to Notification Service Failed | An unexpected error occurred, please try again. If the problem persists, please retry in a few minutes. |
STXE-8000 | API Request to Payment Service Failed | An unexpected error occurred, please try again. If the problem persists, please retry in a few minutes. |
STXE-8000 | API Request to Sage Maker Failed | An unexpected error occurred, please try again. If the problem persists, please retry in a few minutes. |
STXE-8000 | API Request to Identity Service Failed | An unexpected error occurred, please try again. If the problem persists, please retry in a few minutes. |
Too Many Requests (HTTP Error Code: 429)
STX Error Code | Error Message | Error Handling |
---|---|---|
STXE-9000 | Rate Limit ReachedRate limit reached for requests. | Rate limit reached for requests. Please retry in a few minutes. |
Old error codes that are still in use:
STX Error Code | Error Message |
---|---|
XFE604 | :error_code_description: "Maximum Limit Merchant Withdrawal" :error_handling: "You have reached the maximum number of withdrawal request per day. Please try again tomorrow. If you still wish to make a withdrawal, please contact our customer support." |
Internal Server Error (HTTP Error Code: 500)
STX Error Code | Error Message | Error Handling |
---|---|---|
STXE-9100 | Internal Server Error | Try again later or contact customer support at https://support.straitsx.com/support/home. |
Old error codes that are still in use:
STX Error Code | Error Message |
---|---|
XFE3 | :error_code_description: "Internal" :error_handling: "Unexpected error. Try again later or contact customer support at https://support.straitsx.com/support/home." |
Deprecated Error Codes
STX Error Code | Error Message |
---|---|
XFE1 | Error response has been deprecated |
XFE2 | Error response has been deprecated |
XFE4 | Error response has been deprecated |
XFE7 | Error response has been deprecated |
XFE8 | Error response has been deprecated |
XFE9 | Error response has been deprecated |
XFE11 | Error response has been deprecated |
XFE14 | Error response has been deprecated |
XFE501 | Error response has been deprecated |
XFE502 | Error response has been deprecated |
XFE507 | Error response has been deprecated |
Updated 26 minutes ago