Clear a book transfer

POST/transfers/book/{book_transfer_id}/clear

Clear a book transfer by its ID. Transfer must be in a "hold" state. If the amount is specified, then that amount will be cleared, regardless of the amount of the hold. If no amount is specified, then the amount of the hold will be cleared.

Path Parameters

book_transfer_id

stringRequired

Unique identifier for the book transfer.

Body Parameters

allow_overdraft

booleanOptional

Allow the account to go negative for the transfer. The bank account needs to have is_overdraftable enabled with an overdraft reserve account linked to it.

amount

numberOptional

Amount (in cents) to clear. If not provided, the original transfer amount is used.

currency_code

stringOptional

The three-letter ISO 4217 currency code (e.g., USD).