External Accounts

Create

Creates an external account.

POST /external-accounts
const response = await client.external_accounts.create(
  { external_id: 'ext_acc_123', name: 'Checking Account' }
);
Parameters
NameDescription
external_idstring, required

User-provided unique ID.

namestring, required

Name of the account.

Response
NameDescription
dataobject

External account object.

{
  "data": {
    "id": "ext_account_YWJjMTIz",
    "external_id": "ext_acc_123",
    "name": "Checking Account"
  }
}

List

Lists all external accounts.

GET /external-accounts
const response = await client.external_accounts.list();
Response
NameDescription
dataobject[]

{
  "data": [
    {
      "id": "ext_account_YWJjMTIz",
      "external_id": "ext_acc_123",
      "name": "Checking Account"
    }
  ]
}