TransferBook

Clear a book transfer

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.

post/transfers/book/{book_transfer_id}/clear

Request

  • Base URL: https://api.column.com
  • URL: https://api.column.com/transfers/book/{book_transfer_id}/clear
  • Auth: HTTP basic

Path parameters

book_transfer_idstring required

Request body

allow_overdraftboolean

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.

amountinteger

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

currency_codestring nullable

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

Response

Successful response

allow_overdraftboolean required

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

amountinteger required

Amount (in cents) of the funds that will be transferred between sender and receiver accounts. e.g. $1.75 would be represented by 175.

created_atstring date-time required

The timestamp at which the transfer request is created

currency_codestring required

The three-letter currency code defined in ISO 4217. e.g. USD

descriptionstring required

A description of the transfer visible in account statements

idstring required

The unique ID of the object

idempotency_keystring required

The idempotency key specified in the book transfer

receiver_account_number_idstring required

ID of the account number that will receive the transfer

receiver_bank_account_idstring required

ID of the bank account that will receive the transfer

sender_account_number_idstring required

ID of the account number that is sending the transfer

sender_bank_account_idstring required

ID of the bank account that is sending the transfer

status'COMPLETED' | 'REJECTED' | 'HOLD' | 'CANCELED' required

The current status of the book transfer. Possible values: REJECTED, COMPLETED, HOLD, and CANCELED.

updated_atstring date-time required

The timestamp at which the book transfer was updated (typically a status update)

Changes

No recorded changes to this operation across all 1 revision of this API.