API Status Codes

Every response from the Backoffice API includes an HTTP status code: a short number that summarizes how the request went.

2xx — Accepted

The call was accepted — though not always that a record was found or that the work has finished.

4xx — Your request

Something in the request needs to change before it will succeed.

5xx — Our side

Something usually went wrong on our side while processing your request.

Quick reference

CodeMeaningTypical cause & what to do
200 OKRequest succeeded or was acceptedThe call worked and any data is in the body. For lookups and searches, an empty list means nothing matched rather than an error. For requests that create or change data, a 200 means we queued the work — check the outcome with the returned commandFingerprint.
204 No ContentSingle-item lookup found nothingThe record you asked for does not exist. Several single-record lookups (user, transaction, chargeback, submerchant, command) report a miss this way instead of with a 404. Treat it as not found and check the ID you sent.
400 Bad RequestThe request was invalidSomething in the request was wrong, and the response names the fields that failed. Usually a value is in the wrong format, such as text where a number belongs or a misspelled status. Read the body message, fix the input or credentials, and resend.
401 UnauthorizedAuthentication failed or was missingThe credential is missing, mistyped, revoked, or issued for a different tenant than the one in the URL. The response body is empty, so check the API key headers you sent and confirm the key is active for the tenant you are calling. See Backoffice API Authentication.
403 ForbiddenAuthenticated, but not permitted to use this endpointYour credential is valid, but this endpoint is not part of the Launchpay API offering. Check that the endpoint is listed within the Backoffice API Reference (link coming soon).
404 Not FoundRoute, tenant, or resource does not existThe URL path is wrong. Verify the path.
500 Internal Server ErrorAn unexpected error on our sideSomething failed while processing your request, which may have been valid. Retry and contact us on the Customer Support Portal if it persists.

Support

Have a question? Contact us on the Customer Support Portal.

Learn about updates in our Changelog.






Did this page help you?