POST
/
customers
/
{customerID}
/
external_accounts
Create a new External Account
curl --request POST \
  --url https://api.bridge.xyz/v0/customers/{customerID}/external_accounts \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{
  "currency": "usd",
  "bank_name": "<string>",
  "account_owner_name": "<string>",
  "account_number": "<string>",
  "routing_number": "<string>",
  "account_type": "us",
  "iban": {
    "account_number": "<string>",
    "bic": "<string>",
    "country": "<string>"
  },
  "account": {
    "account_number": "<string>",
    "routing_number": "<string>",
    "checking_or_savings": "checking"
  },
  "swift": {
    "account": {
      "account_number": "<string>",
      "bic": "<string>",
      "country": "<string>"
    },
    "address": {
      "street_line_1": "<string>",
      "street_line_2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country": "<string>"
    },
    "category": "<string>",
    "purpose_of_funds": [
      "<string>"
    ],
    "short_business_description": "<string>"
  },
  "clabe": {
    "account_number": "<string>"
  },
  "account_owner_type": "individual",
  "first_name": "<string>",
  "last_name": "<string>",
  "business_name": "<string>",
  "address": {
    "street_line_1": "<string>",
    "street_line_2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  }
}'
{
  "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

Headers

​
Idempotency-Key
string
required

Path Parameters

​
customerID
string
required

A UUID that uniquely identifies a resource

Required string length: 1 - 42

Query Parameters

​
limit
integer

The number of items to return (default of 10, max of 100)

​
starting_after
string

This is an external account id. If this is specified, the next page that starts with an external account right AFTER the specified external account id on the external account timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that external accounts older than the specified external account id will be returned (shouldn't be set if ending_before is set)

​
ending_before
string

This is an external account id. If this is specified, the previous page that ends with an external account right BEFORE the specified external account id on the external account timeline, which is always ordered from the newest to the oldest by creation time, will be returned. This also implies that external accounts newer than the specified external account id will be returned (shouldn't be set if starting_after is set)

Body

application/json

New External Account object to be created

The body is of type object.

Response

201
application/json

External Account object created

The response is of type object.