> ## 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.

# Get Account

> Canonical account fetch endpoint for API token integrations. Returns `404 not_found` when the account does not exist or is not visible to the authenticated API token on Waycore's public API surface.



## OpenAPI

````yaml /openapi.json get /v1/accounts/{accountId}
openapi: 3.1.0
info:
  title: Waycore Bank Connections API
  description: >-
    Developer-first API for direct bank connections, accounts, and transactions.


    Design goals:

    - Flat records with minimal nesting.

    - Clear, bank-centric naming.

    - One canonical endpoint per resource.

    - Sparse fieldsets via `fields=`.

    - Historical browsing via `GET /transactions`.

    - Incremental ETL via `GET /transactions/sync`.

    - Discover supported institutions via `GET /institutions`.

    - Model downstream client businesses via `/entities` and explicit `entityId`
    ownership.


    Authentication:

    - Opaque API keys passed as `Authorization: Bearer <key>`.

    - Key format: `way_<environment>_<key_id>_<secret>`.

    - Keys are organization-bound, environment-bound (`live` or `test`),
    scope-carrying, and expiring.

    - Managed via the Waycore Console.
  version: 0.5.0
servers:
  - url: https://api.waycore.com
security: []
paths:
  /v1/accounts/{accountId}:
    get:
      tags:
        - accounts
      summary: Get Account
      description: >-
        Canonical account fetch endpoint for API token integrations. Returns
        `404 not_found` when the account does not exist or is not visible to the
        authenticated API token on Waycore's public API surface.
      operationId: get_account_v1_accounts__accountId__get
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Accountid
        - name: fields
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Fields
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
                type: object
                additionalProperties: true
                title: Response Get Account V1 Accounts  Accountid  Get
        '400':
          description: >-
            Bad Request. `type` may be `invalid_request` for malformed query
            parameters or validation failures, or `invalid_fields` when `fields`
            contains unknown names.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
          description: Forbidden
        '404':
          description: >-
            Not Found. Returned when the account does not exist or is not
            visible to the authenticated API token on Waycore's public API
            surface.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
        '429':
          description: >-
            Too Many Requests. Retry after the number of seconds in
            `Retry-After` when present, then retry the same request.
          headers:
            Retry-After:
              description: >-
                Number of seconds to wait before retrying, when rate limiting
                provides a specific backoff.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
          description: Internal Server Error
      security:
        - apiKeyBearer:
            - accounts:read
components:
  schemas:
    Account:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: Stable, immutable identifier for the account.
        connectionId:
          type: string
          format: uuid
          title: Connectionid
          description: Identifier of the parent connection.
        type:
          $ref: '#/components/schemas/AccountType'
          description: Canonical account type.
        currency:
          type: string
          pattern: ^[A-Z0-9]{3,12}$
          title: Currency
          description: Account currency or asset code.
        name:
          type: string
          title: Name
          description: Display name for the account.
        officialName:
          anyOf:
            - type: string
            - type: 'null'
          title: Officialname
          description: Institution-provided account name, when available.
        maskedNumber:
          anyOf:
            - type: string
            - type: 'null'
          title: Maskednumber
          description: Masked account number, when available.
        accountNumber:
          anyOf:
            - type: string
            - type: 'null'
          title: Accountnumber
          description: >-
            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:
          anyOf:
            - type: string
            - type: 'null'
          title: Routingnumber
          description: >-
            Deprecated. This legacy flat field is always null. Use
            `paymentIdentifiers` for canonical account payment details.
          deprecated: true
        swiftBic:
          anyOf:
            - type: string
            - type: 'null'
          title: Swiftbic
          description: >-
            Deprecated. This legacy flat field is always null. Use
            `paymentIdentifiers` for BIC details when available.
          deprecated: true
        paymentIdentifiers:
          items:
            oneOf:
              - $ref: '#/components/schemas/UsAchAccountPaymentIdentifier'
              - $ref: >-
                  #/components/schemas/UkSortCodeAccountNumberAccountPaymentIdentifier
              - $ref: '#/components/schemas/CaEftAccountPaymentIdentifier'
              - $ref: >-
                  #/components/schemas/AuBsbAccountNumberAccountPaymentIdentifier
              - $ref: '#/components/schemas/IbanAccountPaymentIdentifier'
            description: >-
              Canonical account payment identifier. Details are typed by
              `scheme`; values are strings to preserve leading zeros.
            discriminator:
              propertyName: scheme
              mapping:
                au_bsb_account_number:
                  $ref: >-
                    #/components/schemas/AuBsbAccountNumberAccountPaymentIdentifier
                ca_eft:
                  $ref: '#/components/schemas/CaEftAccountPaymentIdentifier'
                iban:
                  $ref: '#/components/schemas/IbanAccountPaymentIdentifier'
                uk_sort_code_account_number:
                  $ref: >-
                    #/components/schemas/UkSortCodeAccountNumberAccountPaymentIdentifier
                us_ach:
                  $ref: '#/components/schemas/UsAchAccountPaymentIdentifier'
          type: array
          title: Paymentidentifiers
          description: >-
            Canonical account payment identifiers captured from the connected
            account.
        currentBalance:
          anyOf:
            - type: string
            - type: 'null'
          title: Currentbalance
          description: Current balance.
        availableBalance:
          anyOf:
            - type: string
            - type: 'null'
          title: Availablebalance
          description: Available balance.
        balanceAsOf:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Balanceasof
          description: Timestamp associated with the balance fields, when available.
        status:
          $ref: '#/components/schemas/AccountStatus'
          description: Account status.
        createdAt:
          type: string
          format: date-time
          title: Createdat
          description: >-
            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:
          type: string
          format: date-time
          title: Updatedat
          description: >-
            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`.
        metadata:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Metadata
          description: Opaque client-defined metadata.
      type: object
      required:
        - id
        - connectionId
        - type
        - currency
        - name
        - status
        - createdAt
        - updatedAt
      title: Account
    PublicErrorResponse:
      properties:
        type:
          title: Type
          type: string
        message:
          type: string
          title: Message
        requestId:
          anyOf:
            - type: string
            - type: 'null'
          title: Requestid
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
      type: object
      required:
        - type
        - message
      title: PublicErrorResponse
    AccountType:
      type: string
      enum:
        - checking
        - savings
        - moneyMarket
        - creditCard
        - loan
        - investment
        - wallet
        - other
        - unknown
      title: AccountType
    UsAchAccountPaymentIdentifier:
      properties:
        countryCode:
          type: string
          title: Countrycode
          description: ISO 3166-1 alpha-2 country code associated with the identifier.
        currency:
          type: string
          pattern: ^[A-Z0-9]{3,12}$
          title: Currency
          description: Currency or asset code associated with the identifier.
        scheme:
          type: string
          const: us_ach
          title: Scheme
          description: US ACH account and routing identifier.
        details:
          $ref: '#/components/schemas/UsAchPaymentIdentifierDetails'
      type: object
      required:
        - countryCode
        - currency
        - scheme
        - details
      title: UsAchAccountPaymentIdentifier
      examples:
        - countryCode: US
          currency: USD
          details:
            accountNumber: '000123456789'
            routingNumber: '011000015'
          scheme: us_ach
    UkSortCodeAccountNumberAccountPaymentIdentifier:
      properties:
        countryCode:
          type: string
          title: Countrycode
          description: ISO 3166-1 alpha-2 country code associated with the identifier.
        currency:
          type: string
          pattern: ^[A-Z0-9]{3,12}$
          title: Currency
          description: Currency or asset code associated with the identifier.
        scheme:
          type: string
          const: uk_sort_code_account_number
          title: Scheme
          description: UK sort-code and account-number identifier.
        details:
          $ref: '#/components/schemas/UkSortCodeAccountNumberPaymentIdentifierDetails'
      type: object
      required:
        - countryCode
        - currency
        - scheme
        - details
      title: UkSortCodeAccountNumberAccountPaymentIdentifier
      examples:
        - countryCode: GB
          currency: GBP
          details:
            accountNumber: '00001234'
            sortCode: '400409'
          scheme: uk_sort_code_account_number
    CaEftAccountPaymentIdentifier:
      properties:
        countryCode:
          type: string
          title: Countrycode
          description: ISO 3166-1 alpha-2 country code associated with the identifier.
        currency:
          type: string
          pattern: ^[A-Z0-9]{3,12}$
          title: Currency
          description: Currency or asset code associated with the identifier.
        scheme:
          type: string
          const: ca_eft
          title: Scheme
          description: Canadian EFT institution, transit, and account identifier.
        details:
          $ref: '#/components/schemas/CaEftPaymentIdentifierDetails'
      type: object
      required:
        - countryCode
        - currency
        - scheme
        - details
      title: CaEftAccountPaymentIdentifier
      examples:
        - countryCode: CA
          currency: CAD
          details:
            accountNumber: '0001234567'
            institutionNumber: '260'
            transitNumber: '00011'
          scheme: ca_eft
    AuBsbAccountNumberAccountPaymentIdentifier:
      properties:
        countryCode:
          type: string
          title: Countrycode
          description: ISO 3166-1 alpha-2 country code associated with the identifier.
        currency:
          type: string
          pattern: ^[A-Z0-9]{3,12}$
          title: Currency
          description: Currency or asset code associated with the identifier.
        scheme:
          type: string
          const: au_bsb_account_number
          title: Scheme
          description: Australian BSB and account-number identifier.
        details:
          $ref: '#/components/schemas/AuBsbAccountNumberPaymentIdentifierDetails'
      type: object
      required:
        - countryCode
        - currency
        - scheme
        - details
      title: AuBsbAccountNumberAccountPaymentIdentifier
      examples:
        - countryCode: AU
          currency: AUD
          details:
            accountNumber: '000782080'
            bsb: '033085'
          scheme: au_bsb_account_number
    IbanAccountPaymentIdentifier:
      properties:
        countryCode:
          type: string
          title: Countrycode
          description: ISO 3166-1 alpha-2 country code associated with the identifier.
        currency:
          type: string
          pattern: ^[A-Z0-9]{3,12}$
          title: Currency
          description: Currency or asset code associated with the identifier.
        scheme:
          type: string
          const: iban
          title: Scheme
          description: IBAN account identifier.
        details:
          $ref: '#/components/schemas/IbanPaymentIdentifierDetails'
      type: object
      required:
        - countryCode
        - currency
        - scheme
        - details
      title: IbanAccountPaymentIdentifier
      examples:
        - countryCode: GB
          currency: GBP
          details:
            bic: HBUKGB4B
            iban: GB22HBUK40040922412489
          scheme: iban
    AccountStatus:
      type: string
      enum:
        - open
        - closed
        - unknown
      title: AccountStatus
    UsAchPaymentIdentifierDetails:
      properties:
        routingNumber:
          type: string
          title: Routingnumber
          description: Nine-digit ABA routing number.
        accountNumber:
          type: string
          title: Accountnumber
          description: ACH account number, preserved as a string.
      type: object
      required:
        - routingNumber
        - accountNumber
      title: UsAchPaymentIdentifierDetails
    UkSortCodeAccountNumberPaymentIdentifierDetails:
      properties:
        sortCode:
          type: string
          title: Sortcode
          description: Six-digit UK sort code.
        accountNumber:
          type: string
          title: Accountnumber
          description: Eight-digit UK account number.
      type: object
      required:
        - sortCode
        - accountNumber
      title: UkSortCodeAccountNumberPaymentIdentifierDetails
    CaEftPaymentIdentifierDetails:
      properties:
        institutionNumber:
          type: string
          title: Institutionnumber
          description: Three-digit Canadian financial institution number.
        transitNumber:
          type: string
          title: Transitnumber
          description: Five-digit Canadian branch transit number.
        accountNumber:
          type: string
          title: Accountnumber
          description: Canadian EFT account number, preserved as a string.
      type: object
      required:
        - institutionNumber
        - transitNumber
        - accountNumber
      title: CaEftPaymentIdentifierDetails
    AuBsbAccountNumberPaymentIdentifierDetails:
      properties:
        bsb:
          type: string
          title: Bsb
          description: Six-digit Australian BSB.
        accountNumber:
          type: string
          title: Accountnumber
          description: Australian account number, preserved as a string.
      type: object
      required:
        - bsb
        - accountNumber
      title: AuBsbAccountNumberPaymentIdentifierDetails
    IbanPaymentIdentifierDetails:
      properties:
        iban:
          type: string
          title: Iban
          description: International Bank Account Number.
        bic:
          anyOf:
            - type: string
            - type: 'null'
          title: Bic
          description: Optional SWIFT/BIC.
      type: object
      required:
        - iban
      title: IbanPaymentIdentifierDetails
  securitySchemes:
    apiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: way_<environment>_<key_id>_<secret>
      description: >-
        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.

````