Skip to navigation

List holds

Lists the account’s holds, most recent first. Scopes read, holds.read or holds.write.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequired
Account identifier.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.

Query parameters

statusenumOptional

Filter by status. held is not a status: it lists the holds still locking balance at the banking provider (active, plus releasing/cancelling not yet unlocked). Their sum is the heldAmount of GET /balance.

limitintegerOptionalDefaults to 100

Page size (1–200).

Response

Holds
itemslist of objectsOptional

Errors

400
Bad Request Error
404
Not Found Error