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

# Create a payout

> Sends money to a bank account, mobile money wallet, or crypto address. Amount goes on exactly one side: `to.amount` ("deliver exactly this much") or `from.amount` ("debit exactly this much" — cross-currency converts at the live rate). `externalReference` is your idempotency key: retrying with the same value returns the original payout with status 200 instead of creating a duplicate.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/payouts
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/payouts:
    post:
      tags:
        - Payouts
      summary: Create a payout
      description: >-
        Sends money to a bank account, mobile money wallet, or crypto address.
        Amount goes on exactly one side: `to.amount` ("deliver exactly this
        much") or `from.amount` ("debit exactly this much" — cross-currency
        converts at the live rate). `externalReference` is your idempotency key:
        retrying with the same value returns the original payout with status 200
        instead of creating a duplicate.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                from:
                  type: object
                  properties:
                    amount:
                      type: number
                      exclusiveMinimum: 0
                    currency:
                      type: string
                      minLength: 3
                      maxLength: 4
                    kyc:
                      type: object
                      additionalProperties: {}
                to:
                  type: object
                  properties:
                    code:
                      type: string
                      minLength: 1
                    accountNumber:
                      type: string
                      minLength: 1
                    address:
                      type: string
                      minLength: 1
                    tag:
                      type: string
                    amount:
                      type: number
                      exclusiveMinimum: 0
                    currency:
                      type: string
                      minLength: 3
                      maxLength: 4
                    recipient:
                      type: object
                      properties:
                        name:
                          type: string
                          minLength: 1
                          maxLength: 200
                      required:
                        - name
                    kyc:
                      type: object
                      properties:
                        accountName:
                          type: string
                          minLength: 1
                          maxLength: 200
                      required:
                        - accountName
                  required:
                    - code
                    - currency
                narration:
                  type: string
                  maxLength: 500
                externalReference:
                  type: string
                  minLength: 1
                  maxLength: 100
                metadata:
                  type: object
                  additionalProperties: {}
              required:
                - to
                - externalReference
      responses:
        '200':
          description: >-
            Idempotent replay — this externalReference was already used, the
            original payout is returned.
          content:
            application/json:
              schema:
                type: object
                properties:
                  payout:
                    $ref: '#/components/schemas/Payout'
                required:
                  - payout
        '201':
          description: The payout was created and is processing.
          content:
            application/json:
              schema:
                type: object
                properties:
                  payout:
                    $ref: '#/components/schemas/Payout'
                required:
                  - payout
        '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
        '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
      security:
        - bearerAuth: []
components:
  schemas:
    Payout:
      type: object
      properties:
        id:
          type: string
          example: pay_ghs_p95akjfs339uy9icpelj
        status:
          type: string
          enum:
            - pending
            - processing
            - completed
            - failed
        from:
          type: object
          properties:
            accountNumber:
              type:
                - string
                - 'null'
              description: The balance account that was debited.
              example: GHS12345678
            amount:
              type: string
              description: Decimal string — never parse as float for arithmetic.
              example: '150.00'
            currency:
              type: string
              example: GHS
            kyc:
              type: object
              additionalProperties: {}
              description: Sender KYC you supplied, echoed back.
          required:
            - accountNumber
            - amount
            - currency
        to:
          type: object
          properties:
            accountNumber:
              type:
                - string
                - 'null'
              description: Fiat destinations.
              example: '233559630374'
            address:
              type:
                - string
                - 'null'
              description: Crypto destinations.
            tag:
              type: string
            code:
              type:
                - string
                - 'null'
              example: gh_mtn
            amount:
              type: string
              description: Decimal string — never parse as float for arithmetic.
              example: '150.00'
            currency:
              type: string
              example: GHS
            kyc:
              type: object
              additionalProperties: {}
              description: >-
                Recipient KYC; `accountName` reflects the validated holder name
                where we have one.
          required:
            - code
            - amount
            - currency
        fee:
          type:
            - object
            - 'null'
          properties:
            amount:
              type: string
              description: Decimal string — never parse as float for arithmetic.
              example: '1.50'
            currency:
              type: string
              example: GHS
          required:
            - amount
            - currency
        rate:
          type:
            - string
            - 'null'
          description: FX rate applied on cross-currency payouts, null otherwise.
          example: '15.9800'
        narration:
          type:
            - string
            - 'null'
          example: 'Invoice #1042'
        externalReference:
          type: string
          description: >-
            Your idempotency key — retries with the same value replay the
            original payout.
          example: inv-1042
        metadata:
          type: object
          additionalProperties: {}
        statusMessage:
          type:
            - string
            - 'null'
          description: Failure reason when status is failed.
        completedAt:
          type:
            - string
            - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - status
        - from
        - to
        - fee
        - rate
        - narration
        - externalReference
        - metadata
        - statusMessage
        - completedAt
        - createdAt
        - updatedAt
    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).'

````