Payment Link Statuses & Error Codes

Statuses

Status NameDescription
activeThe payment link is active.
viewedThe payment link has been viewed.
attemptedThere was an attempt to make a payment. However, it has not yet been completed.
expiredThe payment link has expired.
cancelledThe payment link has been cancelled.
paidThe payment link has been paid.

Error Codes

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

HTTP status codeDescription
400 Bad RequestYour request is invalid. It is not well-formed or syntactically incorrect.
401 UnauthorizedInvalid authentication credentials.
403 ForbiddenAuthorization failed due to insufficient permissions.
404 Not FoundThe requested resource does not exist. Please check the URL and retry.
422 Unprocessable EntityAPI cannot complete the requested action, or the request action is semantically incorrect or fails business validation.
500 Internal Server ErrorAn internal server error has occurred. Please try again later.
503 Service UnavailableWe 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"
}