Error codes
Return object
Each request made to the API may return an error object of the following shape:
Field | Type | Description |
---|---|---|
code | Number | A 3-digit identifier |
timestamp | Number | The time when the error occurred |
message | String | A description of the error |
[details] | Object | Optional, may contain information specific to the error. Used for debugging |
The complete list of codes is given right below.
The code
field is something on which one can rely: it will remain the same in future
implementations and it is easy to parse. The message
and details
properties however
are not intended to be manipulated by a program. They would rather serve for debugging and are
only expected to be read by human beings: they are likely to be adjusted in the future (to make them
clearer or more precise).
Error code overview
Code | Http status | Message |
---|---|---|
100 | 500 Internal Server Error | Unexpected error: if the error persists, please contact an administrator.' |
101 | 400 Bad Request | The submitted username or password is invalid. |
102 | 403 Forbidden | This user has been temporarily blocked. Please try again later. |
103 | 401 Unauthorized | Invalid API key. |
104 | 403 Forbidden | Insufficient permissions. Your current user roles don't allow you to perform this query. |
105 | 403 Forbidden | The requested endpoint is unreachable due to IP whitelist restrictions. |
106 | 404 Not Found | The requested resource, or one of its sub-resources, can't be found. |
107 | 404 Not Found | The requested file can't be found. Make sure the requested file hasn't been deleted. |
108 | 400 Bad Request | At least one parameter is invalid. Examine the details property for more information. |
109 | 400 Bad Request | The submitted or requested resource is invalid. Examine the details property for more information. |
110 | 501 Not Implemented | The transaction relates to an unknown processor. Please verify the processor configuration used by this payment profile. |
111 | 500 Internal Server Error | Something went wrong with the processor. The processor replied with something unexpected, which makes it difficult to handle. This error shouldn't occur. |
112 | 403 Forbidden | The submitted transaction has been blocked by a ruleset specified by the organisation owning the payment profile, or by a superior organisation. |
113 | 400 Bad Request | This transaction is not voidable. Either because this payment product doesn't support voiding or because the transaction is already voided or captured. |
114 | 400 Bad Request | This transaction cannot be captured. Either because this payment product doesn't support capture or because the transaction is already captured. |
115 | 400 Bad Request | This transaction is not refundable. Either because this payment product doesn't support refunds or because the transaction is already refunded. |
116 | 400 Bad Request | It is not possible to disable or restrict your own user permissions. |
117 | 400 Bad Request | It is not possible to disable your own user's organisation. |
118 | 400 Bad Request | Cannot remove [item] because it's still in use by [object]. |
119 | 400 Bad Request | Cannot delete an object that has one or more associated [object] objects. |
120 | 429 Too Many Requests | API rate limit reached |
121 | 403 Forbidden | One-off has already been applied to a settlement. Therefore, it cannot be updated or deleted. |
122 | 422 Unprocessable Content | Cannot update [item], because it's in use by [object]. |
123 | 400 Bad Request | Cannot add a subscription discount, because a subscription already has an active discount. |