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

# Export transactions

> Everything in a date range (up to 10,000 rows), for accounting. `format=csv` returns a `text/csv` attachment with columns `id,type,reference,amount,runningBalance,currency,description,status,relatedId,createdAt`; add `email` to have the CSV sent as an attachment instead. `format=json` (default) returns the same rows as objects.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/transactions/export
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/transactions/export:
    get:
      tags:
        - Transactions
      summary: Export transactions
      description: >-
        Everything in a date range (up to 10,000 rows), for accounting.
        `format=csv` returns a `text/csv` attachment with columns
        `id,type,reference,amount,runningBalance,currency,description,status,relatedId,createdAt`;
        add `email` to have the CSV sent as an attachment instead. `format=json`
        (default) returns the same rows as objects.
      parameters:
        - schema:
            type: string
            description: ISO date or datetime, inclusive.
            example: '2026-08-01'
          required: true
          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: true
          name: to
          in: query
        - schema:
            type: string
            description: Only this balance account.
            example: GHS
          required: false
          name: currency
          in: query
        - schema:
            type: string
            enum:
              - json
              - csv
            default: json
          required: false
          name: format
          in: query
        - schema:
            type: string
            format: email
            description: With `format=csv`, email the file here instead of returning it.
            example: finance@zouk.example
          required: false
          name: email
          in: query
      responses:
        '200':
          description: JSON rows, a CSV file, or a confirmation when emailed.
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/Transaction'
                    required:
                      - data
                  - type: object
                    properties:
                      message:
                        type: string
                        example: Export sent to finance@zouk.example
                    required:
                      - message
            text/csv:
              schema:
                type: string
                example: >-
                  id,type,reference,amount,runningBalance,currency,description,status,relatedId,createdAt

                  le_payout_debit_p95akjfs339uy9icpelj,payout,inv-1042,-150.00,1250.00,GHS,"Payout
                  to Ama Serwaa
                  (gh_mtn)",completed,pay_ghs_p95akjfs339uy9icpelj,2026-08-01T09:12:44.000Z
        '400':
          description: Invalid request — the body failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: validation_error
                message: Request validation failed
                requestId: req_q7vei435zifs51ia0lqr
        '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).'

````