Skip to main content

​
Idempotent requests

To safely retry a create without producing duplicates, include an Idempotency-Key header. Generate a new UUID per logical operation. Replaying a request with the same key returns the original result instead of creating a second resource.
​
string
required
Required on Create Account, Create Virtual Account, Create Transfer, and Create Payment; other create endpoints do not take this header.Must be a UUID in the canonical 8-4-4-4-12 form (e.g. 550e8400-e29b-41d4-a716-446655440000). Anything else is rejected with a 422 validation error — including the unhyphenated, braced and urn:uuid: spellings, since keys are compared as strings and two spellings of one UUID would count as two different keys.
Keys are scoped to your account, so a key another platform customer has used never collides with yours. A concurrent retry that arrives while the first request is still in flight returns 409 IDEMPOTENCY_REQUEST_IN_PROGRESS — retry it after a short backoff.

​
Pagination

List endpoints accept page and size query parameters. size defaults to 10 on most lists — 20 on List Transfers and 64 on List Agreements, so rely on the size returned in the response rather than assuming a default with a maximum of 100. Responses use a paginated list envelope — continue requesting pages until page equals pages to ensure no records are missed.
Response — paginated list envelope
​
T[]
Items in the current page.
​
integer
Current page number (1-indexed).
​
integer
Items per page.
​
integer
Total items across all pages.
​
integer
Total number of pages.