Errors

The API uses HTTP response codes to indicate the success or failure of a request. Codes in the 2xx range indicate success, codes in the 4xx range indicate an error in your request, and codes in the 5xx range indicate an error with Treasury Prime’s servers or the backing bank systems.

Status codes

Status code	Meaning
`400` Bad Request	A required parameter is missing, a parameter is invalid, or the request violates a business rule (for example, an ACH credit that exceeds the account’s available balance).
`403` Forbidden	You don’t have permission to perform the operation, for example, when the account is closed or locked for that operation.
`404` Not Found	The requested record doesn’t exist, or an ID in the request is invalid.
`409` Conflict	An idempotency key was reused on a conflicting ACH request (see Idempotency), or the API returned `Overloaded. Try again at a slower rate.` Retry the overloaded case with backoff.
`429` Too Many Requests	Some API endpoints return a `429` status code during times of high request volume. Your application should implement basic backoff and retry logic for this scenario. Some endpoints also return this status code when a request exceeds an account limit, such as ACH velocity limits. Those endpoints document these cases.
`500` Internal Server Error	An unexpected error occurred in Treasury Prime’s servers. The response body includes a `uuid` you can share with Treasury Prime support.
`502` Bad Gateway	A network failure occurred while communicating with the bank, or the bank returned an error response.
`503` Service Unavailable	The bank’s systems are unavailable, for example, when the bank’s core system is offline for maintenance. Retry the request later. Any asynchronous actions, such as book transfers, complete once the core system is back online.

Error response body

In addition to the HTTP response code, most errors include more detailed information about the problem in a JSON response body. The error key contains the detailed error message. Some errors include additional keys, such as uuid (a request identifier for Treasury Prime support) or conflicting_object_id (the ID of the object that already uses an idempotency key).

Example Response

{
  "error": "Parameter 'amount' must be greater than '0'."
}

Introduction

Account

Account Opening

Cards

Payments

Testing

Utilities

Status codes

Error response body

Example Response

​Status codes

​Error response body

Example Response

Status codes

Error response body