Realtime Transfer

Create a realtime transfer

POST/transfers/realtime

Create a realtime transfer between a Column account and a counterparty.

Body Parameters

account_number_id

stringOptional

Source account number ID

allow_overdraft

booleanOptional

Whether overdraft is allowed

amount

numberRequired

Transfer amount in smallest unit

bank_account_id

stringOptional

Source bank account ID

counterparty_id

stringOptional

Counterparty ID

currency_code

enumRequired

ISO 4217 currency code Possible values: USD

description

stringOptional

Free-form transfer description

end_to_end_id

stringOptional

End-to-end identifier

ultimate_debtor_counterparty

objectOptional

Inline ultimate debtor counterparty details

account_number

stringRequired

The account number for the bank account.

account_type

stringRequired

The type of the account number. Can be checking or savings.

address

objectRequired

Addresses need to adhere to character validation, as addresses are used across multiple payment rails. Characters are validated according to the Fedwire character validation.

city

stringRequired

City name

country_code

stringRequired

Two-letter ISO 3166-1 alpha-2 country code (e.g. US)

line_1

stringRequired

Street address line 1

line_2

stringOptional

Street address line 2

postal_code

stringOptional

Postal or ZIP code

state

stringOptional

State or province

description

stringRequired

Description of the counterparty visible only in your platform. Maximum length: 127 characters.

email

stringRequired

The email address of the beneficiary.

legal_id

stringRequired

The legal ID (e.g., Tax ID, Cedula Juridica, etc.) of the beneficiary. This field is recommended for international wire transfers, and required in some countries. Maximum length: 127 characters.

legal_type

stringRequired

The legal entity type of the beneficiary. Can be business, non_profit, individual, or sole_proprietor. This field is recommended for international wire transfers, and required in some countries.

local_account_number

stringRequired

The local account number (e.g. Cuenta Cliente in Costa Rica) in the beneficiary's bank. This field is recommended for international wire transfers, and required in some countries. Maximum length: 63 characters.

local_bank_code

stringRequired

The local bank code of the beneficiary's bank (e.g., India IFSC, Australia BSB, China CNAPS, etc.). This field is recommended for international wire transfers, and required in some countries. Maximum length: 63 characters.

local_bank_country_code

stringRequired

The ISO 3166-1 alpha-2 country code of the beneficiary's local bank.

local_bank_name

stringRequired

Name of the beneficiary's local bank.

name

stringRequired

The counterparty name who owns the bank account. There is a 127 character limit for this field. For domestic wires, only the first 35 characters are included in the wire message.

phone

stringRequired

The phone number of the beneficiary. This field is recommended for international wire transfers, and required in some countries. Maximum length: 31 characters.

routing_number

stringRequired

The routing number of the bank.

routing_number_type

stringRequired

The type of the routing number. Can be aba, bic, or other.

wire

objectRequired

Wire-specific details for this counterparty, including beneficiary information and local bank details.

beneficiary_address

objectRequired

The address of the wire beneficiary.

city

stringRequired

City name

country_code

stringRequired

Two-letter ISO 3166-1 alpha-2 country code (e.g. US)

line_1

stringRequired

Street address line 1

line_2

stringOptional

Street address line 2

postal_code

stringOptional

Postal or ZIP code

state

stringOptional

State or province

beneficiary_email

stringRequired

The email address of the wire beneficiary.

beneficiary_legal_id

stringRequired

The legal identification number of the wire beneficiary (e.g. EIN or SSN).

beneficiary_name

stringRequired

The name of the wire beneficiary.

beneficiary_phone

stringRequired

The phone number of the wire beneficiary.

beneficiary_type

stringRequired

The type of the wire beneficiary. Possible values: individual, business

local_account_number

stringRequired

The local account number at the beneficiary's bank (used for international counterparties).

local_bank_code

stringRequired

The local bank code of the beneficiary's bank (used for international counterparties).

wire_drawdown_allowed

booleanRequired

Whitelists counterparties for automatic approval of drawdown requests to Column via Fedwire. If false, all inbound drawdown requests from this counterparty will require explicit approval.

ultimate_debtor_counterparty_id

stringOptional

Ultimate debtor counterparty ID