International Wire
Create an international wire transfer
Create an international wire transfer between a Column account and a counterparty. Transfer status can be tracked via the Tracking API.
Body Parameters
account_number_id
stringOptionalID of the account number sending the transfer. Exactly one of bank_account_id or account_number_id must be provided.
allow_overdraft
booleanRequiredWhether overdraft is allowed for this transfer
amount
numberRequiredAmount in the smallest unit of the currency. e.g., 1756 means 1.756 in KWD, 17.56 in USD, or 1756 in JPY.
bank_account_id
stringOptionalID of the bank account sending the transfer. Exactly one of bank_account_id or account_number_id must be provided.
charge_bearer
stringRequiredThe charge bearer code. Can be DEBT, CRED, or SHAR.
counterparty_id
stringRequiredID of the counterparty receiving the transfer
currency_code
stringRequiredCurrency code (ISO 4217). e.g. EUR, GBP, JPY.
description
stringRequiredA description of the transfer
fx_quote_id
stringRequiredThe ID of an FX quote to use for this transfer
intermediary_bank
stringRequiredSWIFT BIC of the intermediary bank
message_to_beneficiary_bank
stringRequiredMessage to the beneficiary bank
purpose_code
stringRequiredPurpose code for the transfer
remittance_info
objectRequiredRemittance information for the transfer
beneficiary_reference
stringOptionalReference for the beneficiary
general_info
stringOptionalGeneral remittance information
ultimate_originator_counterparty
objectOptionalInline ultimate originator counterparty details. See counterparty creation for full field reference.
account_number
stringRequiredThe account number for the bank account.
account_type
stringRequiredThe type of the account number. Can be checking or savings.
address
objectRequiredAddresses 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
stringRequiredDescription of the counterparty visible only in your platform. Maximum length: 127 characters.
The email address of the beneficiary.
legal_id
stringRequiredThe 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
stringRequiredThe 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
stringRequiredThe 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
stringRequiredThe 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
stringRequiredThe ISO 3166-1 alpha-2 country code of the beneficiary's local bank.
local_bank_name
stringRequiredName of the beneficiary's local bank.
name
stringRequiredThe 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
stringRequiredThe 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
stringRequiredThe type of the routing number. Can be aba, bic, or other.
wire
objectRequiredWire-specific details for this counterparty, including beneficiary information and local bank details.
beneficiary_address
objectRequiredThe address of the wire beneficiary.
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
beneficiary_email
stringRequiredThe email address of the wire beneficiary.
beneficiary_legal_id
stringRequiredThe legal identification number of the wire beneficiary (e.g. EIN or SSN).
beneficiary_name
stringRequiredThe name of the wire beneficiary.
beneficiary_phone
stringRequiredThe phone number of the wire beneficiary.
beneficiary_type
stringRequiredThe type of the wire beneficiary. Possible values: individual, business
local_account_number
stringRequiredThe local account number at the beneficiary's bank (used for international counterparties).
local_bank_code
stringRequiredThe local bank code of the beneficiary's bank (used for international counterparties).
wire_drawdown_allowed
booleanRequiredWhitelists 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_originator_counterparty_id
stringRequiredID of the ultimate originator counterparty