Response codes

Payment Links uses HTTP response codes to signify the success or failure of an API request.

Codes in the 2xx range indicate success and 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

HTTP status codes

Response codeStatusDescription
200OKRequest successfully processed.
400Bad requestRequest failed due to missing or invalid parameters being supplied. Also returned if the payment failed, for example, if the acquirer declined the transaction.
401UnauthorisedIncorrect authentication information, for example, one of the authentication parameters is wrong - please check them or contact us for correct parameters.
404Not foundThe requested resource or endpoint cannot be found, that is, the endpoint or URL does not exist. Check that you have entered the correct endpoint.

Although not all error codes are mapped, an error object is included when a failed payment link request occurs. This error object explains the reasons for the failed request.