Hey! These docs are for version 1.0, which is no longer officially supported. Click here for the latest version, 5.0!

Handling errors


Upodi use conventional HTTP response codes to indicate success or failure of an API request.

Not all errors map cleanly onto HTTP response codes, however. When a request is valid but does not complete successfully (e.g. a card is declined), we return a 402 error code.


##### always
HTTP status code as indicated in the table to the left.
##### optional
A human-readable message in JSON format, providing more details about the error.

A summary of the HTTP status codes and what they represent is listed here.

HTTP status code summary

200 - OKEverything worked as expected.
201 - CreatedObject created. ID of object can be found in body.
204 - No contentThe resource have been executed.
206 - CreatedThe resource have been created. You may find data in the response of the newly created entity.
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 - UnauthorizedNo valid API key provided and/or conducting a request with a wrong scope of the provided API key.
402 - Request FailedThe parameters were valid but the request failed.
403 - ForbiddenThe current API key does not provide proper access scope (READ or WRITE).
404 - Not FoundThe requested resource doesn't exist.
409 - ConflictThe request conflicts with another request (perhaps due to using the same idempotent key).
422 - Unprocessable entityEntity is likely a duplicate or already exists. Please check body for error code. Usually a response of customer if accountnumber is duplicated.
500 - 506 (server errors)Something went wrong on our end. (These are rare but recorded and will issue a system alert to operations ).