An external account (eac_*) is a bank account linked to a party: the source of deposits, the destination of withdrawals, and a way to fund a payment request. To learn more, see Deposit and withdraw .
Example
GET /external-accounts/{externalAccountId}
The object is everything inside data. The field names below are relative to it: attributes.lastFour is data.attributes.lastFour in the response.
Fields
Resource type. Always externalAccount.
External account ID (eac_*).
The external account’s details. Last four digits of the external bank account.
Lifecycle status of the external account. One of: pending, new, active, disabled, deleted, unknown. See Statuses . attributes.connectionStatus Bank connection health. Relink the account when it is login_required or disconnected. One of: active, login_required, disconnected.
attributes.availableMethods Withdrawal delivery methods this account supports. Each item is one of: standard, instant.
RFC 3339 timestamp when the account was linked.
Bank institution name, when available.
Bank account display name, when available.
Bank account type, when available. One of: checking, savings, unknown.
Metadata visible to anyone who can read the resource.
Related resources, each by type and ID. Party that owns the external account. Related resource identifier. relationships.party.data.type Resource type. Always party.
relationships.party.data.id Party ID (pty_*).
Statuses
Events
Errors
See the error codes these endpoints return.
Sandbox simulations