Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.waycore.com/llms.txt

Use this file to discover all available pages before exploring further.

An Account represents a single bank account discovered on a Connection. Accounts are read-only and are created automatically as Waycore activates and syncs a connection.

Account types today

The public API uses the canonical account type enum: checking · savings · moneyMarket · creditCard · loan · investment · wallet · other · unknown

Current balance fields

FieldDescription
currentBalanceCurrent ledger balance as reported by the bank.
availableBalanceFunds available to spend (may differ for pending items).
balanceAsOfTimestamp of the balance snapshot.
updatedAtBest-effort timestamp for the current public account representation.
Balance values are signed decimal strings (e.g. "1234.56"). They may be null if the institution does not expose them.

Daily balance history

Use GET /v1/balances when you need date-indexed balance rows for reconciliation, reporting, or cash position views. The endpoint returns projected balances visible to your API key, ordered by date desc, accountId asc. Each balance row belongs to an account, connection, and entity, and includes:
FieldDescription
dateBalance date.
ledgerBalanceEnd-of-day posted/current ledger balance for that date.
postedTransactionDeltaSum of posted transaction amounts on that date. Pending transactions are excluded.
sourcebankProvided when the balance came from bank data; derived when Waycore computed it from an observed balance anchor and posted transactions.
updatedAtWhen the projected public balance row last changed.
Balance rows are mutable projections. After a connection sync or transaction backfill, call GET /v1/balances again for the date ranges you care about instead of treating previously fetched rows as immutable ledger snapshots.
Filter balances by entityId, connectionId, accountId, dateGte, and dateLt. Use cursor and limit to page through larger ranges; cursors are valid only with the same query filters.

Payment identifiers

Accounts expose canonical routing details through paymentIdentifiers. Each identifier is typed by scheme, and all bank account values are strings so leading zeros are preserved. Current schemes include:
SchemeDetails
us_achUS routing number and account number.
uk_sort_code_account_numberUK sort code and account number.
ibanIBAN and optional BIC.
Example:
{
  "paymentIdentifiers": [
    {
      "scheme": "us_ach",
      "countryCode": "US",
      "currency": "USD",
      "details": {
        "routingNumber": "011000015",
        "accountNumber": "000123456789"
      }
    }
  ]
}
The legacy flat fields accountNumber, routingNumber, and swiftBic are deprecated and always return null. Use paymentIdentifiers for account payment details.

Filtering

GET /v1/accounts supports filtering by connectionId, type, currency, and status. The type filter uses the same canonical account type enum shown above. Use fields= to request a sparse fieldset and reduce payload size.

Endpoints

List accounts

Get account

List balances

Required scopes

ScopeUsed by
accounts:readList accounts, get account, list balances