Skip to main content
GET
Get Account

Authorizations

Authorization
string
header
required

Opaque API key passed as Authorization: Bearer <key>. Keys are organization-bound, environment-bound (live or test), scope-carrying, and expiring. Create and manage keys via the console.

Path Parameters

accountId
string<uuid>
required

Query Parameters

fields
string | null

Response

Successful Response

id
string<uuid>
required

Stable, immutable identifier for the account.

connectionId
string<uuid>
required

Identifier of the parent connection.

type
enum<string>
required

Canonical account type.

Available options:
checking,
savings,
moneyMarket,
creditCard,
loan,
investment,
wallet,
other,
unknown
currency
string
required

Account currency or asset code.

Pattern: ^[A-Z0-9]{3,12}$
name
string
required

Display name for the account.

status
enum<string>
required

Account status.

Available options:
open,
closed,
unknown
createdAt
string<date-time>
required

Proxy timestamp inherited from the parent connection's createdAt. In this release, it is the best-effort creation marker exposed for the account and may predate the account's first public appearance on Waycore's public API.

updatedAt
string<date-time>
required

Best-effort timestamp associated with the current public account representation. In this release, it matches balanceAsOf when present; otherwise it falls back to the parent connection's updatedAt.

officialName
string | null

Institution-provided account name, when available.

maskedNumber
string | null

Masked account number, when available.

accountNumber
string | null

Best available account identifier for the account, when known. This may be a domestic account number or, when no domestic account number is available, another provider-supplied account identifier such as an IBAN. Use paymentIdentifiers for canonical payment-ready account details.

routingNumber
string | null
deprecated

Deprecated. This legacy flat field is always null. Use paymentIdentifiers for canonical account payment details.

swiftBic
string | null
deprecated

Deprecated. This legacy flat field is always null. Use paymentIdentifiers for BIC details when available.

paymentIdentifiers
(UsAchAccountPaymentIdentifier · object | UkSortCodeAccountNumberAccountPaymentIdentifier · object | CaEftAccountPaymentIdentifier · object | AuBsbAccountNumberAccountPaymentIdentifier · object | IbanAccountPaymentIdentifier · object)[]

Canonical account payment identifiers captured from the connected account.

Canonical account payment identifier. Details are typed by scheme; values are strings to preserve leading zeros.

Example:
currentBalance
string | null

Current balance.

availableBalance
string | null

Available balance.

balanceAsOf
string<date-time> | null

Timestamp associated with the balance fields, when available.

metadata
Metadata · object | null

Opaque client-defined metadata.