/ping
endpoint.
X-Idempotency-Key
header.
application/json
in the Content-Type
HTTP header for most POST
and PUT
calls.
status
field is set to pending
, the corresponding field and value can be filtered using a query string in parameter=value
format.
Parameter | Type | Required? | Description |
---|---|---|---|
page_cursor | string | Pagination cursor, value is the object ID. | |
page_size | number | Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100 . | |
from_date | string | Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”). | |
to_date | string | Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”). |
userdata
parameter.
User data is useful for storing additional, structured data along side an API object. For example, you may wish to store an ID or key that correlates an API object with a unique ID in your own application or database. User data is not used by Treasury Prime and won’t be visible to your users (unless you expose it to them in your own application).
You may pass any arbitrary JSON object for userdata
. The total size of the object, serialized, must be less than 1KB in size.
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. In particular, an HTTP 502 error most often indicates that the bank’s core system is offline due to maintenance. Any asynchronous actions, such as book transfers, will be completed once the core system is back online. Please note that some API endpoints may return a 429
status code during times of high request volume, your application should be expected to implement some basic backoff and retry logic for this scenario. Some endpoints will return this status code as part of exceeding an account limit though, instances of this will be covered in those endpoints respectively.
In addition to the HTTP response code, most errors also include more detailed information about the problem in the response body. The detailed error message will be encoded in a JSON response under the error
key.