Basic information included in all responses:
| Name | Description | Type |
|---|---|---|
| ReturnCode | A numerical code that indicates the result of the operation | Integer |
| ReturnMessage | A human-readable message describing the status of the response. | String |
| RequestId | Each web service call is given a unique identifier that may be used for troubleshooting purposes. If a problem occurs with a call, you can send its RequestId for analysis. | String |
The exact form of the document you receive will depend on the format that is being used.
Return Codes
Service Codes
| Http code | Return code | Description |
|---|---|---|
| 200 | 1000 | SUCCESS |
| 400 | 2000 | INVALID DATA: One of the parameters included in the request is not compatible with our system (e.g., incorrect length, negative value, invalid email format). Please check the accompanying message for further information. Revise integration of the API before sending the request again. |
| 400 | 2500 | OPERATION NOT ALLOWED: The request is syntactically correct, but it does not comply with our business rules (e.g., incompatible payment order status, insufficient charge amount remaining). Please check the accompanying message for further information. Review the integration of the API before sending the request again. |
| 400 | 3000 | OPERATION REFUSED: The request is correct, but one of the remote payment servers has refused the operation (e.g., card limit exceeded). We recommend that you do not reattempt the call since a change in the situation is unlikely for a certain period. |
| 400 | 5000 | DISTANT SERVER TECHNICAL ERROR: The request is correct, but one of the remote payment servers has reported a technical error, or the connection with this server has been interrupted. The request status is unknown. Do not reattempt the call. |
| 400 | 5050 | DISTANT SERVER NOT AVAILABLE: The request is correct, but one of the remote payment servers is temporarily unavailable. Please try again later. |
Technical Error Codes
| Http code | Return code | Description |
|---|---|---|
| 400 | 9400 | Our server cannot understand the request: incorrect syntax. |
| 401 | 9401 | The request requires user authentication. |
| 403 | 9403 | Unauthorised request, whether or not the caller is authenticated |
| 404 | 9404 | The server cannot identify any resource or action associated with this request. |
| 405 | 9405 | The HTTP method (GET, POST, PUT, etc.) is not authorized for this request type. |
| 500 | 9500 | Internal error on our server |