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

# List virtual accounts



## OpenAPI

````yaml /api-reference/openapi.json get /v1/virtual-accounts
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/virtual-accounts:
    get:
      tags:
        - Virtual accounts
      summary: List virtual accounts
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            description: Page size, 1–100.
            example: 20
          required: false
          name: limit
          in: query
        - schema:
            type: string
            description: The `nextCursor` from the previous page.
          required: false
          name: cursor
          in: query
        - schema:
            type: string
            enum:
              - active
              - paused
          required: false
          name: status
          in: query
        - schema:
            type: string
            example: NGN
          required: false
          name: currency
          in: query
        - schema:
            type: string
            description: Exact match on your reference.
            example: customer-8841
          required: false
          name: externalReference
          in: query
      responses:
        '200':
          description: Newest first.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VirtualAccount'
                  hasMore:
                    type: boolean
                  nextCursor:
                    type:
                      - string
                      - 'null'
                    description: >-
                      Pass as `cursor` to fetch the next page. Null on the last
                      page.
                required:
                  - data
                  - hasMore
                  - nextCursor
        '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
      security:
        - bearerAuth: []
components:
  schemas:
    VirtualAccount:
      type: object
      properties:
        id:
          type: string
          example: va_k3m9x2pq7wz4t6vbn8hd
        status:
          type: string
          enum:
            - active
            - paused
          description: Toggled via PATCH.
        currency:
          type: string
          example: NGN
        bank:
          type:
            - string
            - 'null'
          description: >-
            Bank holding the account — give this to the customer with the
            number.
          example: Wema Bank
        accountNumber:
          type:
            - string
            - 'null'
          example: '7812345678'
        accountName:
          type:
            - string
            - 'null'
          description: Name shown to the sender at their bank.
          example: Chipper / Acme Ltd
        externalReference:
          type:
            - string
            - 'null'
          description: Your reference, e.g. the customer id this account belongs to.
          example: customer-8841
        createdAt:
          type: string
          format: date-time
          example: '2026-08-01T09:12:44.000Z'
      required:
        - id
        - status
        - currency
        - bank
        - accountNumber
        - accountName
        - externalReference
        - 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).'

````