v66

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-042174421.1 MB

Hold

Get hold

Get hold by token.

get/v1/holds/{hold_token}

hold_tokenstring uuid required

Globally unique identifier for the hold.

status'PENDING' | 'SETTLED' required

Status of a hold transaction

tokenstring uuid required

Unique identifier for the transaction

createdstring date-time required

ISO 8601 timestamp of when the transaction was created

updatedstring date-time required

ISO 8601 timestamp of when the transaction was last updated

family'HOLD' required

HOLD - Hold Transaction

result'APPROVED' | 'DECLINED' required

financial_account_tokenstring uuid required

pending_amountinteger required

Current pending amount (0 when resolved)

currencystring required

user_defined_idstring nullable required

expiration_datetimestring date-time nullable required

When the hold will auto-expire if not resolved