The API uses conventional HTTP response codes, and every failed request also returns a result object with a detailed code.
HTTP response codes
| Range | Meaning |
|---|---|
2xx | The request was processed. Read result.code for the outcome. |
4xx | The request failed because of the information sent: a missing or invalid parameter, an invalid API key, and so on. Fix the request before sending it again. |
5xx | An error occurred on the platform side. |
Error response
The result object gives a 6-digit code and its description. For an invalid parameter, details tells you which field is wrong and where it was sent.
{
"result": {
"code": "111012",
"description": "invalid parameter"
},
"details": [
{
"field": "uuid",
"description": "not used by customer",
"location": "query",
"value": "69135e58bac66b1f061515ca",
"type": "uuid"
}
]
}Read the result code
The first 4 digits give the context of the response; the last 2 digits give the reason.
| Digit | Meaning | Values |
|---|---|---|
| 1st | Order phase | 1 order creation, 2 tokenization, 3 authentication, 4 authorization, 5 capture, 6 refund, 7 cancel, 9 success |
| 2nd | Origin | 1 technical, 2 processing, 3 risk assessment, 4 account related, 5 routing issue, 6 incomplete |
| 3rd | Fallback | 0 possible, 1 not recommended |
| 4th | Side | 0 undetermined, 1 issuer, 2 acquirer, 3 ACS |
For example, 420230 (risk rejection) is an authorization response (4), from processing (2), where a fallback is possible (0), decided on the acquirer side (2).
Request errors
These codes concern the request itself, whatever the endpoint.
| Code | Description | What to do |
|---|---|---|
111011 | Missing required parameter | Add the required field. Required fields are listed on each endpoint page. |
111012 | Invalid parameter | Check the field named in details: type, format and allowed values. |
111013 | An error occurred | Contact your support team with the request details if it persists. |
111022 | Invalid API key | Check the key and its type. See Authentication. |
111034 | Max attempts reached | No more payment attempts are possible on this order (see max_attempts). |
111035 | Order is already being processed | Retrieve the order to check its current status before sending another request. |
Codes for each phase (tokenization, authentication, authorization, capture, refund, cancel) are listed in Return codes.