Skip to content
Get started

Create

client.externalAccounts.create(ExternalAccountCreateParams { external_id, name } body, RequestOptionsoptions?): ExternalAccountCreateResponse { data }
POST/external-accounts

Creates a new external account

ParametersExpand Collapse
body: ExternalAccountCreateParams { external_id, name }
external_id: string

External ID for the account (user-provided, unique, mutable)

name: string

Human-readable name for the external account (mutable)

ReturnsExpand Collapse
ExternalAccountCreateResponse { data }
data: Data { id, external_id, name }

External account object

id: string

Fragment-generated unique ID for the external account

external_id: string

User-provided external ID

name: string

Human-readable name for the external account

Create

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

const client = new Fragment();

const externalAccount = await client.externalAccounts.create({
  external_id: 'ext_acc_123',
  name: 'Checking Account',
});

console.log(externalAccount.data);
{
  "data": {
    "id": "ext_account_YWJjMTIz",
    "external_id": "ext_acc_123",
    "name": "Checking Account"
  }
}
Returns Examples
{
  "data": {
    "id": "ext_account_YWJjMTIz",
    "external_id": "ext_acc_123",
    "name": "Checking Account"
  }
}