Retrieve an External Account object

Authorizations

Api-Key

string

header

required

Path Parameters

customerID

string

required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

externalAccountID

string

required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Response

Successful External Account object response

ACH
IBAN
SWIFT
CLABE
Pix

US ACH bank account using account and routing numbers

account_type

enum<string>

required

Type of the bank account.

Available options:

us

string

required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

customer_id

string

required

The id of the Bridge customer that this External Account belongs to

Minimum string length: 1

currency

enum<string>

required

Currency associated with the bank account.

Available options:

usd,

eur,

mxn

account_owner_name

string

required

Owner of the account Bank Account (e.g. "John Doe"). For ach or wire transfers, this field must be at least 3 characters, at most 35 characters, and follow either of the following regex patterns:

ach: ^(?!\s*$)[\x20-\x7E]*$
wire: ^[ \w!"#$%&'()+,\-./:;<=>?@\\_`~]*$

Required string length: 1 - 256

account

object

required

US bank account information. It's populated when the account_type is us

Show child attributes

account.routing_number

string

required

The bank routing number

Required string length: 9

account.last_4

string

required

Last 4 digits of the bank account number

Minimum string length: 1

account.checking_or_savings

enum<string>

Determines whether the US account is treated as checking or savings. All US accounts will be treated as checking by default.

Available options:

checking,

savings

created_at

string<date-time>

required

Time of creation of the External Account

updated_at

string<date-time>

required

Time of last update of the External Account

active

boolean

required

Whether or not this External Account is active

bank_name

string

Bank name of the account (e.g. "Chase")

Required string length: 1 - 256

last_4

string

deprecated

Last 4 digits of the bank account number for us account type. This field is getting deprecated in favor of the account.last_4 field

Minimum string length: 1

iban

object

IBAN bank account information. It's populated when the account_type is iban.

Show child attributes

iban.country

string

required

Country in which the bank account is located. It's a three-letter alpha-3 country code as defined in the ISO 3166-1 spec.

Required string length: 3

iban.last_4

string

required

Last 4 digits of the bank account number

Minimum string length: 1

iban.bic

string

The Bank Identifier Code (BIC) that will be used to send the funds

Minimum string length: 1

swift

object

SWIFT bank account information. Required when using SWIFT payment rails. Supported account types are iban and unknown.

Show child attributes

swift.account

object

required

Option 1
Option 2

Show child attributes

swift.account.country

string

required

Country in which the bank account is located. It's a three-letter alpha-3 country code as defined in the ISO 3166-1 spec.

Required string length: 3

swift.account.last_4

string

required

Last 4 digits of the bank account number

Minimum string length: 1

swift.account.bic

string

The Bank Identifier Code (BIC) that will be used to send the funds

Minimum string length: 1

swift.address

object

required

The bank address

Show child attributes

swift.address.street_line_1

string

required

Minimum string length: 4

swift.address.city

string

required

Minimum string length: 1

swift.address.country

string

required

Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.

Required string length: 3

swift.address.street_line_2

string

Minimum string length: 1

swift.address.state

string

ISO 3166-2 subdivision code. Must be supplied for US addresses.

Required string length: 1 - 3

swift.address.postal_code

string

Must be supplied for countries that use postal codes.

Minimum string length: 1

swift.category

string

required

The context of business operations. Can be client, parent_company, subsidiary, or supplier

swift.purpose_of_funds

string[]

required

The nature of the transactions this account will participate in. Can be intra_group_transfer, invoice_for_goods_and_services

Minimum array length: 1

The purpose of funds for the Swift account. Can be intra_group_transfer, invoice_for_goods_and_services

swift.short_business_description

string

required

How the business uses the funds

clabe

object

CLABE bank account information for the SPEI (Mexican) payment rail. It's populated when the account_type is clabe.

Show child attributes

clabe.last_4

string

required

Last 4 digits of the CLABE

Required string length: 4

pix

pix_key · object

Pix bank account information for the Brazilian Pix payment rail. It's populated when the account_type is pix. Contains either Pix key or BR Code information.

pix_key
br_code

Show child attributes

pix.last_4

string

required

Last 4 characters of the Pix key

Required string length: 4

account_owner_type

enum<string>

Type of the account ownership

Available options:

individual,

business

first_name

string

First name of the individual account owner

last_name

string

Last name of the individual account owner

business_name

string

Business name of the business account owner

beneficiary_address_valid

boolean

Whether the beneficiary address is valid. A valid beneficiary address is required for all US External Accounts

Endpoints

Authorizations

Path Parameters

Response