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

# List payouts

> Most recent first. Pass `nextCursor` from the previous page as `cursor` to get the next one; `nextCursor` is `null` on the last page.



## OpenAPI

````yaml GET /v1/payouts
openapi: 3.1.0
info:
  title: KryptaPay API
  version: 1.0.0
  description: >-
    Collect and pay out across Africa — Mobile Money, bank transfers and
    stablecoins — through one REST API.


    Authenticate every request with your secret API key: `Authorization: Bearer
    kp_<env>_…`.

    All responses use the envelope `{ "ok": boolean, "data"?: …, "error"?: {
    "code", "message", "details"? } }`.
  contact:
    name: KryptaPay Support
    email: support@krypta-pay.com
    url: https://krypta-pay.com
servers:
  - url: https://staging.api.krypta-pay.com
    description: Sandbox
  - url: https://api.krypta-pay.com
    description: Production
security:
  - apiKey: []
tags:
  - name: Payins
    description: Collect money from your customers' Mobile Money wallets.
  - name: Payouts
    description: Send money to Mobile Money wallets, bank accounts and crypto addresses.
  - name: Fees
    description: Know the exact fee before you move money.
  - name: FX
    description: Exchange rates, quotes and conversions between your wallets.
  - name: Wallets
    description: Balances of your multi-currency wallets.
  - name: Transactions
    description: Unified history of every movement on your account.
  - name: Networks
    description: Which payment networks are currently available.
  - name: Status
    description: Public platform status.
paths:
  /v1/payouts:
    get:
      tags:
        - Payouts
      summary: List payouts
      description: >-
        Most recent first. Pass `nextCursor` from the previous page as `cursor`
        to get the next one; `nextCursor` is `null` on the last page.
      operationId: listPayouts
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
          in: query
          name: limit
          required: false
        - schema:
            type: string
          in: query
          name: cursor
          required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    properties:
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            reference:
                              type: string
                            status:
                              $ref: '#/components/schemas/TransactionStatus'
                            amount:
                              type: string
                              pattern: ^\d+(\.\d{1,8})?$
                              description: >-
                                Decimal amount with up to 8 fractional digits,
                                e.g. "1500" or "1500.75"
                            currency:
                              $ref: '#/components/schemas/Currency'
                            fee:
                              type: string
                              pattern: ^\d+(\.\d{1,8})?$
                              description: >-
                                Decimal amount with up to 8 fractional digits,
                                e.g. "1500" or "1500.75"
                            network:
                              $ref: '#/components/schemas/Network'
                            description:
                              type:
                                - string
                                - 'null'
                            recipient:
                              type: object
                              properties:
                                msisdn:
                                  type:
                                    - string
                                    - 'null'
                                iban:
                                  type:
                                    - string
                                    - 'null'
                                address:
                                  type:
                                    - string
                                    - 'null'
                                chain:
                                  $ref: '#/components/schemas/Network'
                              required:
                                - msisdn
                                - iban
                                - address
                                - chain
                              additionalProperties: false
                            failureReason:
                              type:
                                - string
                                - 'null'
                            initiatedAt:
                              type: string
                            settledAt:
                              type:
                                - string
                                - 'null'
                            failedAt:
                              type:
                                - string
                                - 'null'
                            idempotencyKey:
                              type:
                                - string
                                - 'null'
                            approvedAt:
                              type:
                                - string
                                - 'null'
                            autoExecuted:
                              type: boolean
                            frozen:
                              type: boolean
                          required:
                            - id
                            - reference
                            - status
                            - amount
                            - currency
                            - fee
                            - network
                            - description
                            - recipient
                            - failureReason
                            - initiatedAt
                            - settledAt
                            - failedAt
                            - idempotencyKey
                            - approvedAt
                            - autoExecuted
                            - frozen
                          additionalProperties: false
                      nextCursor:
                        type:
                          - string
                          - 'null'
                    required:
                      - items
                      - nextCursor
                    additionalProperties: false
                required:
                  - ok
                  - data
                additionalProperties: false
              example:
                ok: true
                data:
                  items:
                    - id: cmgx2k1qv0001s60f8h3n5z7a
                      reference: tx_V1StGXR8Z5jdHi6BmyT
                      status: PROCESSING
                      amount: '15000'
                      currency: XOF
                      fee: '150'
                      network: MTN_BJ
                      description: 'Supplier payment #1042'
                      recipient:
                        msisdn: '22997000000'
                      failureReason: null
                      initiatedAt: '2026-10-27T10:15:00.000Z'
                      settledAt: null
                      failedAt: null
                      idempotencyKey: 4b17ddc6-4d7f-4d3e-a7d5-62e3c7f2d18d
                      approvedAt: '2026-10-27T10:15:00.000Z'
                      autoExecuted: true
                      frozen: false
                  nextCursor: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    TransactionStatus:
      type: string
      enum:
        - PENDING
        - PROCESSING
        - COMPLETED
        - FAILED
        - CANCELLED
        - REFUNDED
      description: >-
        Lifecycle status. `COMPLETED`, `FAILED`, `CANCELLED` and `REFUNDED` are
        final.
    Currency:
      type: string
      enum:
        - XOF
        - XAF
        - NGN
        - GHS
        - CDF
        - EUR
        - USD
        - USDC
        - USDT
      description: ISO currency code (fiat) or stablecoin ticker.
    Network:
      type: string
      enum:
        - MTN_BJ
        - MTN_CI
        - MTN_CM
        - ORANGE_CI
        - ORANGE_SN
        - ORANGE_ML
        - ORANGE_BF
        - ORANGE_CM
        - MOOV_BJ
        - MOOV_TG
        - MOOV_CI
        - MOOV_BF
        - WAVE_CI
        - WAVE_SN
        - FREE_SN
        - TMONEY_TG
        - MOBICASH_ML
        - MOBICASH_BF
        - DJAMO_CI
        - MIXX_SN
        - MTN_CG
        - AIRTEL_CG
        - ORANGE_CD
        - AIRTEL_CD
        - VODACOM_CD
        - AFRICELL_CD
        - AIRTEL_GA
        - MOMO_NG
        - AIRTEL_NG
        - OPAY_NG
        - MTN_GH
        - VODAFONE_GH
        - AIRTELTIGO_GH
        - BANK_XOF
        - BANK_XAF
        - BANK_NGN
        - BANK_GHS
        - BANK_CDF
        - BANK_EUR
        - BANK_USD
        - ETH
        - POLYGON
        - TRON
      description: >-
        Payment network. See [Networks & currencies](/networks) for countries
        and limits.
    Error:
      type: object
      properties:
        ok:
          type: boolean
          enum:
            - false
        error:
          type: object
          properties:
            code:
              type: string
              description: Stable, machine-readable code. Branch on this, not on `message`.
            message:
              type: string
              description: Human-readable explanation. May change; do not parse.
            details:
              description: >-
                Extra context. For `validation_error`: `{ formErrors,
                fieldErrors }`.
          required:
            - code
            - message
      required:
        - ok
        - error
  responses:
    Unauthorized:
      description: Missing, invalid or expired API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            ok: false
            error:
              code: unauthorized
              message: Invalid or expired API key
    Forbidden:
      description: >-
        The key lacks the required scope (`insufficient_scope`), or the account
        is not KYB-approved (`kyb_required`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            ok: false
            error:
              code: kyb_required
              message: Your organization must complete KYB verification.
    RateLimited:
      description: >-
        Too many requests. Wait for the number of seconds in the `retry-after`
        header.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            ok: false
            error:
              code: rate_limited
              message: Rate limit exceeded, retry in 1 minute
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        Secret API key from **Dashboard → Developers**: `kp_sandbox_…` for
        Sandbox, `kp_live_…` for Production. Server-side only.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.