> ## Documentation Index
> Fetch the complete documentation index at: https://docs.slash.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve an account

> Retrieve an Account and its user-facing balance components. Components are omitted when the credential cannot view balances.



## OpenAPI

````yaml /openapi-v2.json get /v2/accounts/{accountId}
openapi: 3.1.0
info:
  title: Slash Public API V2
  description: >-
    Send money for a Slash legal entity. Every request uses an API key. Transfer
    creation returns a Transfer that links its resulting transactions.
  version: 0.0.1
servers:
  - url: https://api.slash.com
    description: production
security:
  - api_key: []
paths:
  /v2/accounts/{accountId}:
    parameters:
      - name: x-legal-entity
        in: header
        required: true
        description: >-
          The legal entity to act on. Required on every request; a user API key
          can act on any legal entity its user has access to.
        schema:
          type: string
          pattern: ^le_[a-zA-Z0-9]+$
      - name: accountId
        in: path
        required: true
        description: Account id with the `sa_group_` prefix.
        schema:
          type: string
    get:
      summary: Retrieve an account
      description: >-
        Retrieve an Account and its user-facing balance components. Components
        are omitted when the credential cannot view balances.
      responses:
        '200':
          description: The requested Account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/account'
              example:
                id: sa_group_primary123
                name: Slash Platinum
                type: secured_charge_card
                status: open
                currency: USD
                accountNumber: '123456789'
                routingNumber: '021000021'
                createdAt: '2026-08-18T01:00:00.000Z'
                balanceComponents:
                  - type: transactional
                    balance:
                      amount: 25000
                      currency: USD
                  - type: collateral
                    balance:
                      amount: 100000
                      currency: USD
                  - type: credit
                    creditLimit:
                      amount: 100000
                      currency: USD
                    availableToSpend:
                      amount: 75000
                      currency: USD
                    pendingBalance:
                      amount: 5000
                      currency: USD
                    settledBalance:
                      amount: 20000
                      currency: USD
        '400':
          $ref: >-
            #/components/responses/PublicApiV2Error400InvalidRequestShapeAccountsGet
        '401':
          $ref: '#/components/responses/PublicApiV2Error401Unauthorized'
        '403':
          $ref: >-
            #/components/responses/PublicApiV2Error403ForbiddenLegalEntityUserApiKeyRequired
        '404':
          $ref: '#/components/responses/PublicApiV2Error404NotFoundNotFoundNotEnabled'
        '429':
          $ref: '#/components/responses/PublicApiV2RateLimited'
        '500':
          $ref: '#/components/responses/PublicApiV2Error500Internal'
components:
  schemas:
    account:
      title: Account
      description: >-
        A Slash financial product and its user-facing balances. An Account can
        contain a primary virtual account and additional virtual accounts. API
        v2 exposes eligible banking products and Global USD; savings, acquiring,
        and legacy treasury products are omitted. Global USD is readable but
        cannot source an API v2 transfer.
      type: object
      properties:
        id:
          type: string
          description: Account id with the `sa_group_` prefix.
          example: sa_group_primary123
        name:
          type: string
          description: Display name.
          example: Slash Platinum
        type:
          type: string
          description: Financial product represented by this Account.
          enum:
            - checking
            - secured_charge_card
            - unsecured_charge_card
            - business_debit
            - global_usd
        status:
          type: string
          enum:
            - open
            - locked
            - pending_close
            - closed
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          example: USD
        accountNumber:
          type: string
          description: Account number presented to the customer, when applicable.
        routingNumber:
          type: string
          description: Routing number presented to the customer, when applicable.
        createdAt:
          type: string
          format: date-time
        balanceComponents:
          type: array
          description: >-
            User-facing balance breakdown. Returned by account retrieval when
            the credential can view balances.
          items:
            oneOf:
              - title: Transactional
                type: object
                properties:
                  type:
                    type: string
                    enum:
                      - transactional
                  balance:
                    $ref: '#/components/schemas/Money'
                required:
                  - type
                  - balance
                additionalProperties: false
              - title: Collateral
                type: object
                properties:
                  type:
                    type: string
                    enum:
                      - collateral
                  balance:
                    $ref: '#/components/schemas/Money'
                required:
                  - type
                  - balance
                additionalProperties: false
              - title: Credit
                type: object
                properties:
                  type:
                    type: string
                    enum:
                      - credit
                  creditLimit:
                    $ref: '#/components/schemas/Money'
                  availableToSpend:
                    $ref: '#/components/schemas/Money'
                  pendingBalance:
                    $ref: '#/components/schemas/Money'
                  settledBalance:
                    $ref: '#/components/schemas/Money'
                required:
                  - type
                  - creditLimit
                  - availableToSpend
                  - pendingBalance
                  - settledBalance
                additionalProperties: false
              - title: Global USD
                type: object
                properties:
                  type:
                    type: string
                    enum:
                      - global_usd
                  balance:
                    $ref: '#/components/schemas/Money'
                required:
                  - type
                  - balance
                additionalProperties: false
      required:
        - id
        - name
        - type
        - status
        - currency
        - createdAt
      additionalProperties: false
    Money:
      type: object
      description: A signed monetary amount expressed in minor units.
      properties:
        amount:
          type: integer
          description: Amount in the currency's minor units.
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          description: Uppercase ISO 4217 currency code.
      required:
        - amount
        - currency
      additionalProperties: false
      title: Money
    PublicApiV2ErrorInvalidRequestShape:
      title: PublicApiV2ErrorInvalidRequestShape
      description: >-
        The body, query, or headers failed validation, or a required header is
        missing. `details` has one entry per failing location, keyed by JSON
        pointer or header name.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - invalid_request
            details:
              type: object
              properties: {}
              additionalProperties:
                type: string
          required:
            - code
            - details
    PublicApiV2ErrorUnauthorized:
      title: PublicApiV2ErrorUnauthorized
      description: API key authentication is missing or invalid.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - unauthorized
            details:
              type: object
              properties: {}
              additionalProperties: false
          required:
            - code
            - details
    PublicApiV2ErrorForbiddenLegalEntity:
      title: PublicApiV2ErrorForbiddenLegalEntity
      description: The credential is not permitted to act for the selected legal entity.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - forbidden
            details:
              type: object
              properties: {}
              additionalProperties: false
          required:
            - code
            - details
    PublicApiV2ErrorUserApiKeyRequired:
      title: PublicApiV2ErrorUserApiKeyRequired
      description: >-
        The API key is scoped to a legal entity rather than a user. Every v2
        request needs a user API key, created under Settings → API keys in the
        Slash dashboard, together with the `x-legal-entity` header.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - user_api_key_required
            details:
              type: object
              properties: {}
              additionalProperties: false
          required:
            - code
            - details
    PublicApiV2ErrorNotFound:
      title: PublicApiV2ErrorNotFound
      description: >-
        No resource matches the identifier, it belongs to another legal entity,
        or the credential cannot view it. When the identifier is a field of the
        request, `details` names that `field` and the `id` it received.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - not_found
            details:
              type: object
              properties:
                field:
                  type: string
                  description: Dot path of the request field at fault.
                  example: destinationId
                id:
                  type: string
                  description: The identifier that field carried, when it is one.
                  example: le_contact_destination_bank123
              additionalProperties: false
          required:
            - code
            - details
    PublicApiV2ErrorNotFoundNotEnabled:
      title: PublicApiV2ErrorNotFoundNotEnabled
      description: Public API v2 is not enabled for the selected legal entity.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - not_found
            details:
              type: object
              properties: {}
              additionalProperties: false
          required:
            - code
            - details
    PublicApiV2ErrorInternal:
      title: PublicApiV2ErrorInternal
      description: >-
        Slash could not complete the request. Quote `referenceId` when
        contacting Slash support.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - internal
            details:
              type: object
              properties: {}
              additionalProperties: false
          required:
            - code
            - details
    Error:
      type: object
      properties:
        code:
          type: string
          description: >-
            Machine-readable reason; branch on this, not on `message`. Every
            code an endpoint can return is listed on its reference page; the
            ones shared by all endpoints are explained in the Errors guide.
          example: invalid_request
        message:
          type: string
          description: >-
            Human-readable explanation, safe to show to an operator. Wording may
            change; use `code` and `details` programmatically.
        details:
          type: object
          description: >-
            The values behind `message`, keyed per `code`. For example
            `insufficient_funds` carries `available` and `requested`;
            `invalid_request` from contract validation carries one entry per
            failing field, keyed by JSON pointer. Empty when the code has no
            variable data.
          additionalProperties:
            type: string
          example:
            available: $120.00
            requested: $500.00
        referenceId:
          type: string
          description: Unique id of this failure. Quote it when contacting Slash support.
          example: 4001-2alj5if
      required:
        - code
        - message
        - details
        - referenceId
      additionalProperties: false
      title: Error
  responses:
    PublicApiV2Error400InvalidRequestShapeAccountsGet:
      description: >-
        - `invalid_request (request shape)` — The body, query, or headers failed
        validation, or a required header is missing. `details` has one entry per
        failing location, keyed by JSON pointer or header name.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiV2ErrorInvalidRequestShape'
          examples:
            invalid_request_request_shape:
              summary: invalid_request (request shape)
              value:
                code: invalid_request
                message: >-
                  Invalid `accountId`: Expected a valid ID beginning with
                  "sa_group_".
                details:
                  /accountId: Expected a valid ID beginning with "sa_group_".
                referenceId: 4001-2alj5if
    PublicApiV2Error401Unauthorized:
      description: '- `unauthorized` — API key authentication is missing or invalid.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiV2ErrorUnauthorized'
          examples:
            unauthorized:
              summary: unauthorized
              value:
                code: unauthorized
                message: API key authentication is missing or invalid.
                details: {}
                referenceId: 4011-2alj5if
    PublicApiV2Error403ForbiddenLegalEntityUserApiKeyRequired:
      description: >-
        - `forbidden (legal entity)` — The credential is not permitted to act
        for the selected legal entity.

        - `user_api_key_required` — The API key is scoped to a legal entity
        rather than a user. Every v2 request needs a user API key, created under
        Settings → API keys in the Slash dashboard, together with the
        `x-legal-entity` header.
      content:
        application/json:
          schema:
            anyOf:
              - title: forbidden (legal entity)
                allOf:
                  - $ref: '#/components/schemas/PublicApiV2ErrorForbiddenLegalEntity'
              - title: user_api_key_required
                allOf:
                  - $ref: '#/components/schemas/PublicApiV2ErrorUserApiKeyRequired'
          examples:
            forbidden_legal_entity:
              summary: forbidden (legal entity)
              value:
                code: forbidden
                message: This credential is not permitted to do that.
                details: {}
                referenceId: 4031-2alj5if
            user_api_key_required:
              summary: user_api_key_required
              value:
                code: user_api_key_required
                message: >-
                  Public API v2 requires a user API key. Create one under
                  Settings → API keys in the Slash dashboard.
                details: {}
                referenceId: 4031-2alj5if
    PublicApiV2Error404NotFoundNotFoundNotEnabled:
      description: >-
        - `not_found` — No resource matches the identifier, it belongs to
        another legal entity, or the credential cannot view it. When the
        identifier is a field of the request, `details` names that `field` and
        the `id` it received.

        - `not_found (API not enabled)` — Public API v2 is not enabled for the
        selected legal entity.
      content:
        application/json:
          schema:
            anyOf:
              - title: not_found
                allOf:
                  - $ref: '#/components/schemas/PublicApiV2ErrorNotFound'
              - title: not_found (API not enabled)
                allOf:
                  - $ref: '#/components/schemas/PublicApiV2ErrorNotFoundNotEnabled'
          examples:
            not_found:
              summary: not_found
              value:
                code: not_found
                message: '`destinationId` le_contact_destination_bank123 was not found.'
                details:
                  field: destinationId
                  id: le_contact_destination_bank123
                referenceId: 4041-2alj5if
            not_found_not_enabled:
              summary: not_found (API not enabled)
              value:
                code: not_found
                message: The requested resource was not found.
                details: {}
                referenceId: 4041-2alj5if
    PublicApiV2RateLimited:
      description: >-
        The request exceeded the applicable rate limit. The response body is
        plain text; clients must not depend on a response-body schema for this
        status.
    PublicApiV2Error500Internal:
      description: >-
        - `internal` — Slash could not complete the request. Quote `referenceId`
        when contacting Slash support.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiV2ErrorInternal'
          examples:
            internal:
              summary: internal
              value:
                code: internal
                message: >-
                  An unexpected error occurred. If this keeps happening, contact
                  Slash support with the reference id below.
                details: {}
                referenceId: 5001-2alj5if
  securitySchemes:
    api_key:
      type: apiKey
      name: X-API-Key
      in: header
      description: >-
        User API key authentication. Create a key under Settings → API keys in
        the Slash dashboard (https://app.slash.com/global-settings/api-keys) and
        send the `x-legal-entity` header naming the legal entity to act on with
        every request. Keys scoped to a legal entity are rejected with `403
        user_api_key_required`.

````