TransferBook

Create a book transfer

A book transfer is a transaction between two Column accounts that you own. They can happen instantly and can be sent 24 hours a day, 7 days a week. Both accounts need to be under your platform, but don't need to be under the same entity. Alternatively, you can send a book transfer in two steps, using the "hold" parameter and "clear" method. Book transfers in a "hold" state can be updated and canceled. There is no reversal functionality for book transfers. Simply swap the sender_account_number_id and receiver_account_number_id and repeat the request.

post/transfers/book

Request

  • Base URL: https://api.column.com
  • URL: https://api.column.com/transfers/book
  • Auth: HTTP basic

Headers

Idempotency-Keystring

Idempotency keys can be up to 255 characters long and are case sensitive. Column reserves the right to expire idempotency keys after 30 days. Only ASCII printable characters (code 32 - 126) are allowed for idempotency keys.

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 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.

currency_codestring required

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

descriptionstring

A description of the transfer visible in account statements.

holdboolean

If set to true, the transfer will be created in a HOLD status instead of completing immediately.

receiver_account_number_idstring

ID of the account number that will receive the transfer.

receiver_bank_account_idstring

ID of the bank account that will receive the transfer.

sender_account_number_idstring

ID of the account number that is sending the transfer.

sender_bank_account_idstring

ID of the bank account that is sending the transfer.

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.