Skip to main content
GET
Get a hold

Authorizations

Authorization
string
header
required

An API key, pk_live_… or pk_test_….

Path Parameters

id
string
required

The id.

Response

OK

id
string

hld_…

accountId
string
accountName
string
currency
string
amount
string

Minor units, as a string.

captured
string

Minor units, as a string.

status
enum<string>

CAPTURED: fully captured

Available options:
ACTIVE,
CAPTURED,
RELEASED,
EXPIRED
reason
string
entryId
string

the pending entry this hold protects, if any

expiresAt
string<date-time>
createdAt
string<date-time>
updatedAt
string<date-time>