GET
/
customers
/
{customerID}
/
external_accounts
/
{externalAccountID}
Retrieve an External Account object
curl --request GET \
  --url https://api.bridge.xyz/v0/customers/{customerID}/external_accounts/{externalAccountID} \
  --header 'Api-Key: <api-key>'
{
  "id": "ea_123",
  "account_type": "us",
  "currency": "usd",
  "customer_id": "cust_123",
  "account_owner_name": "John Doe",
  "bank_name": "Wells Fargo",
  "last_4": "1111",
  "active": true,
  "beneficiary_address_valid": true,
  "account": {
    "last_4": "1111",
    "routing_number": "121000248",
    "checking_or_savings": "checking"
  },
  "created_at": "2020-01-01T00:00:00.000Z",
  "updated_at": "2020-01-02T00:00:00.000Z"
}

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

​
id
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 length: 1
​
currency
enum<string>
required

Currency associated with the bank account. Default is usd. When eur is specified, the account type must be iban

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_type
enum<string>
required

Type of the bank account. The default is us

Available options:
us,
iban,
clabe,
unknown
​
iban
object
required

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

​
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 length: 1
​
account
object

US bank account information. Required when the account_type is us. However, the top-level account_number and routing_number fields in deprecation will continue to be supported. US bank account information. It's populated when the account_type is us

​
swift
object

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

​
clabe
object

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

​
account_owner_type
enum<string>

The type of the account ownership. Required when the account_type is iban. For individual ownership, first_name and last_name are required. For business ownership, business_name is required. Type of the account ownership

Available options:
individual,
business
​
first_name
string

First name of the individual account holder. Required when the account_owner_type is individual First name of the individual account owner

​
last_name
string

Last name of the individual account holder. Required when the account_owner_type is individual Last name of the individual account owner

​
business_name
string

Business name of the business account holder. Required when the account_owner_type is business Business name of the business account owner

​
address
object

Address of the beneficiary of this account. Please ensure the address is valid (Google Maps is good for this). US addresses used to receive wires must include a street number.

​
beneficiary_address_valid
boolean

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