URL Expired

The URL for this request expired after 30 days.

bankAccountId

uuid

required

accept

string

enum

Defaults to application/json

Generated from available response content types

application/jsonapplication/problem+json

Allowed:

application/json``application/problem+json

``200 Successful operation

object

_links

object

required

HAL-style links to related resources.

self

object

required

self object

transactions

object

required

transactions object

statements

object

required

statements object

bankLink

object

bankLink object

id

uuid

required

The unique identifier of the bank account.

accountId

uuid

required

The unique identifier of the account that owns this bank account.

subaccountId

uuid

required

The unique identifier of the subaccount associated with this bank account.

bankLinkId

string | null

The identifier of the bank link that created this account. Null for virtual accounts.

externalId

string

required

The external identifier provided at creation for virtual accounts, or the provider account ID for Plaid-connected accounts.

cardIds

array of uuids

required

The identifiers of cards linked to this bank account for transaction matching, always current — linked immediately at bank-link completion when an enrolled card's last 4 digits match a credit account's mask, detected automatically on the first high-confidence match between a card's transactions and this account's feed, or set manually via PATCH. Cards must belong to the same subaccount.

cards

array of objects

Cards MATERIALIZED from this bank account (bank-feed enrollments minted at bank-link completion for credit accounts whose mask matched no already-enrolled card). Distinct from cardIds, which is the link surface: a mask-matched or discovered card appears in cardIds only, while a minted card appears in both. Empty for depository, virtual, and mask-matched-only accounts.

cards

object

id

uuid

required

The minted card's identifier on the cards platform.

subscriptionId

uuid

required

The bank-feed card subscription created by the mint.

last4digits

string

required

^\d{4}$

The card number's last 4 — equals this account's mask by construction.

network

string | null

required

The card network when the institution implies it (e.g. amex); null until a PAN enrollment upgrades the card in place.

enrollmentType

string

enum

required

Always bank-feed — the enrollment transport this card was materialized through.

bank-feed

virtual

boolean

required

Whether this is a virtual (manually created) bank account.

institutionName

string

required

The name of the connected financial institution.

institutionId

string | null

The provider identifier of the connected institution (Plaid ins_*). Null for virtual accounts and connections made before this field was captured.

name

string

required

The display name of the bank account (e.g. "Checking", "Savings").

mask

string | null

The last 4 digits of the account number. For credit accounts this is the card number's last 4 — the per-card identity for bank-connected (e.g. American Express) card enrollments. Not guaranteed to be per-card when the institution combines multiple cards into a single account.

type

string

enum

required

The normalized type of bank account. (Correction — the service has always returned normalized values; the previous depository/credit enum understated live behavior. Codegen consumers should regenerate.)

checking``savings``prepaid``credit``loan``investment``other

subtype

string | null

The raw provider account subtype (e.g. Plaid credit card, checking). Null when the provider did not supply one or for accounts connected before this field was captured.

currency

string

required

length between 3 and 3

The currency of the account following ISO 4217 format.

state

string

enum

required

Current state of the bank account.

• active: The account is connected and functioning normally.
• auth_required: The account requires re-authentication.
• disconnected: The account has been disconnected from the provider.

active``auth_required``disconnected

createdAt

date-time

required

Date and time when this resource was created, in UTC, following ISO 8601 format.

updatedAt

date-time

required

Date and time when this resource was last updated, in UTC, following ISO 8601 format.

``401 Authentication credentials were either missing or incorrect

``403 Authentication credentials used do not have permissions to perform the request

``404 The requested resource was not found on the server

``500 The server encountered an unexpected condition that prevented it from fulfilling the request

Updated 12 days ago

ShellNodeRubyPHPPython

Bearer

xxxxxxxxxx

curl --request GET \
 \
     --url https://api.astrada.co/bank-accounts/bankAccountId \
     --header 'accept: application/json'

xxxxxxxxxx

{
  "_links": {
    "self": {
      "href": "/bank-accounts/3a8f2c1d-5e7b-4d9a-b6c8-9f0e1d2a3b4c"
    },
    "transactions": {
      "href": "/bank-transactions/1fcb895e-9217-4a6f-9d10-5a7dcef86c11?bankAccountId=3a8f2c1d-5e7b-4d9a-b6c8-9f0e1d2a3b4c"
    },
    "statements": {
      "href": "/bank-accounts/3a8f2c1d-5e7b-4d9a-b6c8-9f0e1d2a3b4c/statements"
    },
    "bankLink": {
      "href": "/bank-links/enrollment_792dcb7d"
    }
  },
  "id": "3a8f2c1d-5e7b-4d9a-b6c8-9f0e1d2a3b4c",
  "accountId": "8f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
  "subaccountId": "1fcb895e-9217-4a6f-9d10-5a7dcef86c11",
  "bankLinkId": "enrollment_792dcb7d",
  "externalId": "plaid_acc_792dcb7d",
  "cardIds": [\
    "5dec2c49-0aa5-4683-a317-427eb5d115f3"\
  ],
  "virtual": false,
  "institutionName": "Chase",
  "name": "Checking",
  "mask": "1234",
  "type": "checking",
  "currency": "USD",
  "state": "active",
  "createdAt": "2025-10-03T10:55:42.000Z",
  "updatedAt": "2025-10-03T10:55:42.000Z"
}