Response codes

The Payments API uses HTTP response codes to signify the success or failure of an API request.

  • Codes in the 2xx range indicate success.
  • Codes in the 4xx range indicate an error or failure. Examples of issues that could cause a 4xx range failure include:
    • A required parameter was omitted
    • A charge failed
  • Codes in the 5xx range indicate that something has gone wrong on the server side while processing the request.

The detailed reason for the failure should be determined from the response data, for example, response code 200.300.404, and not based solely on the status code.

HTTP status codes

Response codeStatusDescription
200OK.Request processed - for payment transactions, the outcome can be determined from the result code in the response.
400Bad request.Request failed due to missing or invalid parameters being supplied.
401Unauthorised.Incorrect authentication information, for example, one of the authentication parameters is wrong - please check them or contact us for correct parameters.
403Forbidden.Authentication details are valid but do not provide sufficient permissions to access the requested resource.
404Not found.The requested resource or endpoint cannot be found, that is, the endpoint or URL does not exist. Check that you have entered the correct endpoint.
429Too many requests.Exceeded the number of requests allowed within a given time period, for example, you might have exceeded the rate limit for the transaction status API.
500Internal server error.The server encountered an unexpected error while processing the request.
502Bad gateway.The server, while acting as a gateway or proxy, received an invalid response from the upstream server.