v66

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

Hold

Create hold

Create a hold on a financial account. Holds reserve funds by moving them from available to pending balance. They can be resolved via settlement (linked to a payment or book transfer), voiding, or expiration.

post/v1/financial_accounts/{financial_account_token}/holds

Path parameters

financial_account_tokenstring uuid required

Globally unique identifier for the financial account.

Request body

amountinteger required

Amount to hold in cents

memostring nullable

Reason for the hold

tokenstring uuid

Customer-provided token for idempotency. Becomes the hold token.

expiration_datetimestring date-time

When the hold should auto-expire

user_defined_idstring

User-provided identifier for the hold

Response

Created

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