Counterparty

Create a counterparty

A counterparty is the legal entity on the other side of the transaction. Depending on the type of transaction, we may need to know more or less about them. A domestic ACH only requires a counterparty's account and routing number. If you include a counterparty name, Column will by default populate receiver_name on the ACH transfer request. Domestic and international wires require full name and address. Certain countries may require additional fields. Learn more about country-specific details here.

post/counterparties

Request

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

Request body

account_numberstring required

The account number for the bank account.

account_typestring

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

descriptionstring

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

emailstring

The email address of the beneficiary.

legal_idstring

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_typestring nullable

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_numberstring

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_codestring

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_codestring nullable

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

local_bank_namestring nullable

Name of the beneficiary's local bank.

namestring

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.

phonestring

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

routing_numberstring required

The routing number of the bank.

routing_number_typestring

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

wire_drawdown_allowedboolean

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.

Response

Successful response

account_numberstring required

The account number for the bank account.

account_typestring required

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

created_atstring date-time required

The timestamp the object was created.

descriptionstring required

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

emailstring required

The email address of the beneficiary.

idstring required

The unique ID of the object

is_column_accountboolean required

Indicates whether this counterparty account is actually a Column account.

legal_idstring required

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_typestring required

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_numberstring required

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_codestring required

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_codestring required

ISO 3166-1 Alpha-2 country code of the beneficiary's bank.

local_bank_namestring required

Name of the beneficiary's local bank.

namestring required

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.

phonestring required

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

routing_numberstring required

The routing number of the bank.

routing_number_typestring required

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

updated_atstring date-time required

The timestamp the object was last updated.

wire_drawdown_allowedboolean required

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.

Changes

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