Every field and event of an external party’s bank account
An external party account (epa_*) holds an external party’s bank details, where ACH, realtime and wire payments go. Responses show only the last four digits. To learn more, see Pay over a specific rail.
Example
GET /external-party-accounts/{externalPartyAccountId}
The object is everything inside data. The field names below are relative to it: attributes.accountDetails is data.attributes.accountDetails in the response.
Fields
string
required
External party account ID (epa_*).
string
required
Resource type. Always externalPartyAccount.
object
required
The account’s details.
Hide attributes
object
required
Type-specific account details.
Hide accountDetails
string
required
Account details type. Always us_bank_account.
string
required
Bank account type. One of: checking, savings.
string
required
Last four account number digits.
string
required
Masked account number.
string
required
Account validation state. pending when validation could not complete at creation; it resolves asynchronously to validated or failed. One of: pending, validated, failed.
string[]
required
Advisory list of payment rails this account is expected to accept. Refreshed periodically from the payment network; the authoritative check happens when a payment is created. Each item is one of: ach, realtime, wire.
string
required
RFC 3339 timestamp when the account was created.
string
required
RFC 3339 timestamp when the account was last updated.