B External Accounts#

a. Create

#

Creates a new external account

POST /external-accounts
import Fragment from '@fragment-dev/ts-node';

const client = new Fragment({
  clientId: process.env['FRAGMENT_CLIENT_ID'],
  clientSecret: process.env['FRAGMENT_CLIENT_SECRET'],
});

const response = await client.external_accounts.create(
  {
      external_id: 'ext_acc_123',
      name: 'Checking Account'
    }
);
Parameters
external_id
string, required
External ID for the account (user-provided, unique, mutable)
name
string, required
Human-readable name for the external account (mutable)
Response
{
  "data": {
    "id": "ext_account_YWJjMTIz",
    "external_id": "ext_acc_123",
    "name": "Checking Account"
  }
}

b. List

#

Lists all external accounts for the workspace

GET /external-accounts
import Fragment from '@fragment-dev/ts-node';

const client = new Fragment({
  clientId: process.env['FRAGMENT_CLIENT_ID'],
  clientSecret: process.env['FRAGMENT_CLIENT_SECRET'],
});

const response = await client.external_accounts.list();
Response
{
  "data": [
    {
      "id": "ext_account_YWJjMTIz",
      "external_id": "ext_acc_123",
      "name": "Checking Account"
    }
  ]
}