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

> The unified ledger across every balance: payouts, collections, deposits, conversions, fees and refunds, with a running balance per row. Use it for reconciliation instead of stitching the per-resource lists together.

## Transaction Type Reference

These values describe the economic type of a transaction event. They are **not** accounting classifications; accounting treatment is the selected Chart-of-Accounts account on the linked journal entry.

<Warning>
  Some values use spaces instead of underscores (e.g., `INTERCOMPANY TRANSFER`, `CLAIM REWARD`). Always reference the exact values below.
</Warning>

| Transaction type        | Description                                 |
| ----------------------- | ------------------------------------------- |
| `DEPOSIT`               | Inbound receipt of funds                    |
| `WITHDRAWAL`            | Outbound transfer of funds                  |
| `SWAP`                  | Exchange of one asset for another           |
| `BRIDGE`                | Cross-chain transfer                        |
| `INTERCOMPANY TRANSFER` | Transfer between legal entities             |
| `INTERNAL TRANSFER`     | Transfer within the same legal entity       |
| `FEE`                   | Network gas, exchange, or service fee       |
| `MINTING`               | Creation of new tokens                      |
| `STAKING_REWARD`        | Yield from staking                          |
| `INVOICE`               | Payment received against a customer invoice |
| `BILL`                  | Payment against a vendor bill               |
| `CLAIM REWARD`          | Protocol or ecosystem reward claim          |
| `BORROW`                | Borrowing event                             |
| `REPAYMENT`             | Loan repayment                              |
| `RESERVES CHANGE`       | Treasury reserves adjustment                |
| `REALIZED_PNL`          | Realized profit or loss                     |
| `NFT`                   | NFT mint, sale, or transfer                 |
| `SPAM`                  | Spam/airdrop (auto-hides from accounting)   |
| `UNKNOWN`               | Type not yet determined, pending review     |


## OpenAPI

````yaml /api-reference/openapi.json get /v1/transactions
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://api.platform.chipper.ai
    description: Production (sk_live_ keys)
  - url: https://sandbox-api.platform.chipper.ai
    description: Sandbox (sk_test_ keys — simulated rails, no real money)
security:
  - bearerAuth: []
paths:
  /v1/transactions:
    get:
      tags:
        - Transactions
      summary: List transactions
      description: >-
        The unified ledger across every balance: payouts, collections, deposits,
        conversions, fees and refunds, with a running balance per row. Use it
        for reconciliation instead of stitching the per-resource lists together.
      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
            description: Only this balance account.
            example: GHS
          required: false
          name: currency
          in: query
        - schema:
            type: string
            description: ISO date or datetime, inclusive.
            example: '2026-08-01'
          required: false
          name: from
          in: query
        - schema:
            type: string
            description: >-
              ISO date or datetime, inclusive — a bare date covers the whole
              day.
            example: '2026-08-31'
          required: false
          name: to
          in: query
      responses:
        '200':
          description: Newest first.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Transaction'
                  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:
    Transaction:
      type: object
      properties:
        id:
          type: string
          description: Ledger entry id; the middle segment is the raw ledger type.
          example: le_payout_debit_p95akjfs339uy9icpelj
        type:
          type: string
          description: >-
            One of `payout`, `settlement`, `refund`, `fee`, `fee_refund`,
            `conversion`, `topup`, `deposit`, `collection`, `collection_fee`,
            `reserve`, `reserve_release`. Newer ledger types (e.g.
            `payment_link_credit`, `payment_link_fee`) pass through unmapped.
          example: payout
        reference:
          type:
            - string
            - 'null'
          description: Your `externalReference` for payout-related rows, null otherwise.
          example: inv-1042
        amount:
          type: string
          description: 'Signed: negative debits your balance, positive credits it.'
          example: '-150.00'
        runningBalance:
          type: string
          description: Account balance immediately after this entry.
          example: '1250.00'
        currency:
          type: string
          example: GHS
        description:
          type: string
          example: Payout to Ama Serwaa (gh_mtn)
        status:
          type: string
          description: >-
            Mirrors the related payout or conversion (`pending`, `processing`,
            `completed`, `failed`); ledger-only rows are `completed`.
          example: completed
        relatedId:
          type:
            - string
            - 'null'
          description: The payout, conversion, collection or batch this entry belongs to.
          example: pay_ghs_p95akjfs339uy9icpelj
        createdAt:
          type: string
          format: date-time
          example: '2026-08-01T09:12:44.000Z'
      required:
        - id
        - type
        - reference
        - amount
        - runningBalance
        - currency
        - description
        - status
        - relatedId
        - 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).'

````