Open Platform API Status Code Reference
Document Overview
This document defines the status code conventions returned by Open Platform API endpoints. It clarifies call outcomes, error types, and causes so developers can troubleshoot quickly. All API endpoints follow these status code rules in their responses.
Status Code Ranges
| Code range | Category |
|---|---|
| 200 | Success (request completed normally) |
| 1xxxx | General errors (uncategorized exceptions) |
| 2xxxx | Authentication and authorization errors |
| 4xxxx | Request and parameter validation errors |
| 5xxxx | Endpoint-related errors |
| 6xxxx | Rate limiting errors |
| 7xxxx | Business logic errors |
Status Code Details
1. Success
| Code | Enum | Description |
|---|---|---|
| 200 | SUCCESS | Request succeeded |
2. General errors (1xxxx)
| Code | Enum | Description |
|---|---|---|
| 10000 | UNKNOWN_ERROR | Unknown error; contact technical support |
3. Authentication and authorization errors (2xxxx)
| Code | Enum | Description |
|---|---|---|
| 20001 | API_KEY_MISSING | API key missing (no API Key parameter in the request) |
| 20002 | API_KEY_INVALID | Invalid API key (disabled, expired, or not approved) |
| 20010 | TIMESTAMP_MISSING | Timestamp parameter missing (no timestamp in the request) |
| 20011 | TIMESTAMP_FORMAT_ERROR | Invalid timestamp format (must be 10 or 13 digits) |
| 20012 | TIMESTAMP_EXPIRED | Timestamp expired (request timed out; generate a new timestamp and retry) |
| 20020 | SIGNATURE_MISSING | Signature parameter missing (no signature in the request) |
| 20021 | SIGNATURE_VERIFY_FAILED | Signature verification failed (incorrect signing rule or tampered parameters) |
4. Request and parameter validation errors (4xxxx)
| Code | Enum | Description |
|---|---|---|
| 400 | INVALID_REQUEST | Request body could not be parsed (verify that parameters are sent as documented) |
| 404 | NOT_FOUND | Endpoint path does not exist (verify the request path) |
| 405 | REQUEST_METHOD_NOT_ALLOWED | HTTP method not allowed (verify the method against the documentation) |
| 40001 | REQUIRED_PARAMS_EMPTY | Required parameters missing (a required field was not submitted) |
| 40002 | REQUIRED_PARAMS_ILLEGAL | Invalid parameters (format or value out of allowed range) |
5. Endpoint-related errors (5xxxx)
| Code | Enum | Description |
|---|---|---|
| 50001 | INTERFACE_NOT_FOUND | API endpoint does not exist (incorrect request path) |
6. Rate limiting errors (6xxxx)
| Code | Enum | Description |
|---|---|---|
| 60001 | INTERFACE_RATE_LIMIT | Call rate exceeded; try again later |
7. Business logic errors (7xxxx)
| Code | Enum | Description |
|---|---|---|
| 70001 | NOT_ENOUGH_CREDIT | Insufficient account balance; please top up |