Create a Counterparty

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

The counterparty to create

name_on_account

string

required

Name of the account owner. Filterable.

ach

object

Account information for use with ACH transfers

Show child attributes

ach.account_number

string

ach.account_type

string

Either checking or savings.

ach.routing_number

string

Valid 9-digit ABA routing transit number associated with the account. See the Routing Number endpoint for additional information.

plaid_processor_token

string

Plaid processor token, exchanged for an account number and routing number

userdata

object

Arbitrary data the user can attach to the object

wire

object

Account information for use with wire transfers

Show child attributes

wire.account_number

string

Bank account number for wire use (maximum of 34 characters)

wire.address_on_account

object

Physical address associated with the account

Show child attributes

wire.address_on_account.city

string

City (max 18 characters)

wire.address_on_account.country

string

Country (ISO 3166-1 alpha-2). Defaults to US

wire.address_on_account.postal_code

string

Postal code (5-digit or 5+4 Zip Code for U.S. addresses)

wire.address_on_account.state

string

State (max 2 characters for US, max 3 characters for other countries)

wire.address_on_account.street_line_1

string

First line of the address (max 35 characters)

wire.address_on_account.street_line_2

string

Optional second line of the address (max 35 characters)

wire.bank_address

object

Address of the bank

Show child attributes

wire.bank_address.city

string

City (max 18 characters)

wire.bank_address.country

string

A 2 character ISO country code. Required for an international counterparty

wire.bank_address.postal_code

string

Postal code (5-digit or 5+4 Zip Code for U.S. addresses)

wire.bank_address.state

string

U.S. State (two letter abbreviation). If an international wire counterparty this is the Province or Region.

wire.bank_address.street_line_1

string

Street address (first line) (max 35 characters)

wire.bank_address.street_line_2

string

Street address (second line, if applicable) (max 35 characters)

wire.bank_name

string

Name of the bank

wire.routing_number

string

Valid 9-digit ABA routing transit number for the bank holding the account. See the Routing Number endpoint for additional information. For international wires this can be a valid BIC/SWIFT code

Response

200 - application/json

The counterparty created

ach

object

Account information for use with ACH transfers

Show child attributes

ach.account_number

string

ach.account_type

string

Either checking or savings.

ach.routing_number

string

Valid 9-digit ABA routing transit number associated with the account. See the Routing Number endpoint for additional information.

string

Unique identifier for object

name_on_account

string

Name of the account owner. Filterable.

plaid_processor_token

string

Plaid processor token, exchanged for an account number and routing number

userdata

object

Arbitrary data the user can attach to the object

wire

object

Account information for use with wire transfers

Show child attributes

wire.account_number

string

Bank account number for wire use (maximum of 34 characters)

wire.address_on_account

object

Physical address associated with the account

Show child attributes

wire.address_on_account.city

string

City (max 18 characters)

wire.address_on_account.country

string

Country (ISO 3166-1 alpha-2). Defaults to US

wire.address_on_account.postal_code

string

Postal code (5-digit or 5+4 Zip Code for U.S. addresses)

wire.address_on_account.state

string

State (max 2 characters for US, max 3 characters for other countries)

wire.address_on_account.street_line_1

string

First line of the address (max 35 characters)

wire.address_on_account.street_line_2

string

Optional second line of the address (max 35 characters)

wire.bank_address

object

Address of the bank

Show child attributes

wire.bank_address.city

string

City (max 18 characters)

wire.bank_address.country

string

A 2 character ISO country code. Required for an international counterparty

wire.bank_address.postal_code

string

Postal code (5-digit or 5+4 Zip Code for U.S. addresses)

wire.bank_address.state

string

U.S. State (two letter abbreviation). If an international wire counterparty this is the Province or Region.

wire.bank_address.street_line_1

string

Street address (first line) (max 35 characters)

wire.bank_address.street_line_2

string

Street address (second line, if applicable) (max 35 characters)

wire.bank_name

string

Name of the bank

wire.routing_number

string

Valid 9-digit ABA routing transit number for the bank holding the account. See the Routing Number endpoint for additional information. For international wires this can be a valid BIC/SWIFT code

Introduction

Account

Account Opening

Payments

Utilities

Testing

Authorizations

Body

Response