Realtime Transfer
Create a realtime transfer
Create a realtime transfer between a Column account and a counterparty.
Body Parameters
account_number_id
stringOptionalSource account number ID
allow_overdraft
booleanOptionalWhether overdraft is allowed
amount
numberRequiredTransfer amount in smallest unit
bank_account_id
stringOptionalSource bank account ID
counterparty_id
stringOptionalCounterparty ID
currency_code
enumRequiredISO 4217 currency code
Possible values: USD
description
stringOptionalFree-form transfer description
end_to_end_id
stringOptionalEnd-to-end identifier
ultimate_debtor_counterparty
objectOptionalInline ultimate debtor counterparty details
account_number
stringRequiredThe account number for the bank account.
account_type
stringOptionalThe type of the account number. Can be checking or savings.
address
objectOptionalAddresses need to adhere to character validation, as addresses are used across multiple payment rails. Characters are validated according to the Fedwire character validation.
city
stringRequiredCity name
country_code
stringRequiredTwo-letter ISO 3166-1 alpha-2 country code (e.g. US)
line_1
stringRequiredStreet address line 1
line_2
stringOptionalStreet address line 2
postal_code
stringOptionalPostal or ZIP code
state
stringOptionalState or province
description
stringOptionalDescription of the counterparty visible only in your platform. Maximum length: 127 characters.
The email address of the beneficiary.
legal_id
stringOptionalThe 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
stringOptionalThe 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
stringOptionalThe 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
stringOptionalThe 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
stringOptionalThe ISO 3166-1 alpha-2 country code of the beneficiary's local bank.
local_bank_name
stringOptionalName of the beneficiary's local bank.
name
stringOptionalThe 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
stringOptionalThe phone number of the beneficiary. This field is recommended for international wire transfers, and required in some countries. Maximum length: 31 characters.
routing_number
stringRequiredThe routing number of the bank.
routing_number_type
stringOptionalThe type of the routing number. Can be aba, bic, or other.
wire_drawdown_allowed
booleanOptionalWhitelists 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
stringOptionalUltimate debtor counterparty ID