Sign in

v1

latestOpenAPI 3.1.02026-07-261520561.4 KB
Manual Hold

Create a Manual Hold

post/hold

Request body

account_idstring required

ID of the Account to place the hold. Filterable.

amountstring required

Amount of money to hold, with two decimal precision

expires_atstring

Optional timestamp to expire the hold

hold_descriptionstring

Optional description for the hold transaction

hold_release_descriptionstring

Optional description for the hold release transaction

Response

The manual_hold created

account_idstring

ID of the Account to place the hold. Filterable.

amountstring

Amount of money to hold, with two decimal precision

bank_idstring

ID of the bank with which the object is associated

expires_atstring

Optional timestamp to expire the hold

hold_descriptionstring

Optional description for the hold transaction

hold_release_descriptionstring

Optional description for the hold release transaction

hold_transaction_idstring

ID of the hold transaction

idstring

Unique identifier for object

org_idstring

ID of the organization with which the object is associated

release_transaction_idstring

ID of the hold release transaction

statusstring

Status of the hold, one of active, released, or expired. Filterable.