Error Codes

API requests that result in errors will be responded to with one of the following HTTP status codes, as applicable:

400 Bad Request: The request is malformed or missing a required parameter.
401 Unauthorized: Invalid credentials or incorrect security signature.
403 Forbidden: Access to the requested resource is denied.
404 Not Found: The requested resource does not exist.
409 Conflict: Attempt to create a different resource using an already used idempotency key.
422 Unprocessable Entity: When an amount exceeds configured limits.
429 Too Many Requests: Request limit exceeded.
451 Fraud Control: A suspicious usage pattern was detected.
500 Internal Server Error: Unexpected error on our servers.

When this occurs, the response will include a JSON object like the following example:

{
  "error": "2001",
  "title": "INVALID_PAYMENT_NETWORK",
  "message": "The required network is invalid.",
  "timestamp": "2024-04-16T17:44:51Z"
}

In some cases, if necessary, an error message may include a list of details, as in the following example:

{
  "error": "0004",
  "title": "INVALID_REQUEST",
  "message": "The received request contains invalid data.",
  "timestamp": "2024-04-16T17:44:51Z",
  "details": [
    {
      "field": "network",
      "message": "The received field exceeds the maximum allowed length."
    }
  ]
}

In addition to the HTTP status code in the response, each error is categorized with a numeric code and a name for clarity and easier debugging. The error code table is shown below:

Error Codes

General

Code	Name	Description
0000	INTERNAL_ERROR	An internal platform error has occurred. For more details, please contact support.
0001	ELEMENT_NOT_FOUND	The requested element was not found.
0002	RATE_LIMIT_EXCEEDED	The request limit has been exceeded.
0003	OPERATION_NOT_ALLOWED	The requested action is not permitted.
0004	INVALID_REQUEST	The request contains invalid data. For details, check the error message.
0005	IDEMPOTENCY_CONFLICT	An attempt was made to create a resource using an idempotency key already used for a different request.
1001	AUTHENTICATION_REQUIRED	Valid access credentials are required to perform the requested action.
1002	INVALID_CREDENTIALS	The authentication credentials provided are invalid.
1003	INACTIVE_ACCOUNT	Your account has not yet been activated. Contact support for more information.
1004	SUSPENDED_ACCOUNT	Your account has been suspended. Contact support for more information.
1005	INSUFFICIENT_PERMISSIONS	Your account or credentials do not have the required permissions to perform the requested action.
2001	INVALID_PAYMENT_NETWORK	The selected blockchain network is not valid.
2002	INVALID_PAYMENT_TOKEN	The token selected for the payment is not valid.
2003	WALLET_NOT_FOUND	There is no active wallet for the selected network or token.
2004	INVALID_FILTER	One of the filters in the request is not valid, such as future dates or impossible date ranges.
2005	NETWORK_FAILURE	External error related to a blockchain network failure.
2006	UNPROCESSABLE_ENTITY	When an amount exceeds configured limits.
2007	SUSPICIOUS_USAGE_PATTERN	A suspicious usage pattern was detected when executing an action.

Error Codes​

General​

Error Codes

General