Payment Link Statuses & Error Codes

Statuses

Status Name	Description
active	The payment link is active.
viewed	The payment link has been viewed.
attempted	There was an attempt to make a payment. However, it has not yet been completed.
expired	The payment link has expired.
cancelled	The payment link has been cancelled.
paid	The payment link has been paid.

Error Codes

For failed requests, the API returns HTTP 4xx or 5xx status codes as below.

HTTP status code	Description
400 Bad Request	Your request is invalid. It is not well-formed or syntactically incorrect.
401 Unauthorized	Invalid authentication credentials.
403 Forbidden	Authorization failed due to insufficient permissions.
404 Not Found	The requested resource does not exist. Please check the URL and retry.
422 Unprocessable Entity	API cannot complete the requested action, or the request action is semantically incorrect or fails business validation.
500 Internal Server Error	An internal server error has occurred. Please try again later.
503 Service Unavailable	We are temporarily offline for maintenance. Please try again later.

JSON Response example

For some failed requests, the API can return JSON response bodies that include information about an error:

{
"code": 275,
"message": "Invalid payment link ID"
}