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.

Path Params
uuid
required

Globally unique identifier for the financial account.

Body Params
integer
required
≥ 1

Amount to hold in cents

string | null

Reason for the hold

uuid

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

date-time

When the hold should auto-expire

string

User-provided identifier for the hold

Responses

Language
Credentials
Header
Request
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json