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

# Get an account

> Balances are computed from the ledger on every call, so `availableBalance` is what a payout created right now could draw on.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/accounts/{id}
openapi: 3.1.0
info:
  title: Chipper Platform API
  version: '2026-02-20'
  description: >-
    Payouts, collections, and FX across African rails — bank, mobile money, and
    stablecoins — through one API.
servers:
  - url: https://sandbox-api.platform.chipper.ai
    description: Sandbox (sk_test_ keys — simulated rails, no real money)
  - url: https://api.platform.chipper.ai
    description: Production (sk_live_ keys)
security:
  - bearerAuth: []
paths:
  /v1/accounts/{id}:
    get:
      tags:
        - Accounts & Ledger
      summary: Get an account
      description: >-
        Balances are computed from the ledger on every call, so
        `availableBalance` is what a payout created right now could draw on.
      parameters:
        - schema:
            type: string
            description: Account number.
            example: GHS12345678
          required: true
          name: id
          in: path
      responses:
        '200':
          description: The account.
          content:
            application/json:
              schema:
                type: object
                properties:
                  account:
                    $ref: '#/components/schemas/Account'
                required:
                  - account
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: unauthorized
                message: Invalid API key
                requestId: req_q7vei435zifs51ia0lqr
        '403':
          description: The API key lacks the required scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: forbidden
                message: API key does not have the required scope
                requestId: req_q7vei435zifs51ia0lqr
        '404':
          description: No such resource in this organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: not_found
                message: Account not found
                requestId: req_q7vei435zifs51ia0lqr
      security:
        - bearerAuth: []
components:
  schemas:
    Account:
      type: object
      properties:
        id:
          type: string
          description: >-
            Account number: currency code + 8 digits. This is the
            `accountNumber` that appears on payouts, collections, and ledger
            entries.
          example: GHS12345678
        currency:
          type: string
          example: GHS
        availableBalance:
          type: string
          description: What you can spend right now — total minus active holds.
          example: '1250.00'
        pendingBalance:
          type: string
          description: >-
            Held for in-flight payouts and batches; released or debited when
            they settle.
          example: '150.00'
        totalBalance:
          type: string
          description: Sum of every ledger entry on the account.
          example: '1400.00'
        estimatedUsd:
          type:
            - string
            - 'null'
          description: >-
            Available balance converted to USD at the current mid-market rate —
            indicative only. Null when no rate is available.
          example: '80.03'
        createdAt:
          type: string
          format: date-time
          example: '2026-08-01T09:12:44.000Z'
      required:
        - id
        - currency
        - availableBalance
        - pendingBalance
        - totalBalance
        - estimatedUsd
        - createdAt
    Error:
      type: object
      properties:
        error:
          type: string
          description: Stable machine-readable code.
        message:
          type: string
          description: Human-readable explanation.
        requestId:
          type: string
          description: Echoed in the x-request-id response header — quote it to support.
      required:
        - error
        - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key: `sk_test_…` (sandbox) or `sk_live_…` (production).'

````