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

# Create payout

> Create a quote-backed payout.

Payouts debit the merchant wallet and are processed asynchronously.


## OpenAPI

````yaml POST /payouts
openapi: 3.0.3
info:
  title: Bumxpress Business Merchant API
  version: 1.0.0
  description: >
    Merchant API for customers, KYC, quotes, payins, payouts, transfers, and
    webhooks.

    All merchant resources are scoped to the merchant attached to the API key.
  license:
    name: Proprietary
    url: https://business.bumxpress.com
servers:
  - url: https://api.business.bumxpress.com
    description: Production
security:
  - ApiKeyAuth: []
    ApiSecretAuth: []
tags:
  - name: Customers
    description: Create and retrieve merchant-scoped customer records.
  - name: Customer KYC
    description: Submit and retrieve customer identity document status.
  - name: Quotes
    description: Create and retrieve pricing and routing quotes.
  - name: Payins
    description: Create and retrieve payment collection resources.
  - name: Payouts
    description: Create and retrieve disbursement resources.
  - name: Transfers
    description: Create, retrieve, and relaunch two-leg transfer resources.
paths:
  /payouts:
    post:
      tags:
        - Payouts
      summary: Create payout
      description: Create a quote-backed payout. Payout processing is asynchronous.
      operationId: createPayout
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePayoutRequest'
      responses:
        '201':
          description: Payout created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payout'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          $ref: '#/components/responses/Conflict'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: true
      description: >-
        Unique key for this business intent. Reuse only when retrying the same
        request body.
      schema:
        type: string
      example: payin_2026_06_08_0001
  schemas:
    CreatePayoutRequest:
      type: object
      required:
        - quote_id
        - customer_id
        - recipient
      properties:
        quote_id:
          type: string
          format: uuid
        customer_id:
          type: string
          format: uuid
        payment_reason_code:
          type: string
          example: OTHER
        payment_reason_text:
          type: string
          example: Merchant payout
        recipient:
          $ref: '#/components/schemas/Recipient'
      example:
        quote_id: 33333333-3333-3333-3333-333333333333
        customer_id: 22222222-2222-2222-2222-222222222222
        payment_reason_code: OTHER
        payment_reason_text: Merchant payout
        recipient:
          recipient_type: individual
          first_name: Awa
          last_name: Ngu
          country_code: CM
          rail_type: mobile_money
          phone: '+237670000000'
          email: awa@example.com
          recipient_nationality_code: CM
          operator_code: CM_MTN_MOMO
          address_line1: 123 Main Street
          city: Douala
    Payout:
      allOf:
        - $ref: '#/components/schemas/PaymentBase'
        - type: object
          properties:
            status:
              type: string
              enum:
                - created
                - pending
                - completed
                - failed
            recipient:
              $ref: '#/components/schemas/Recipient'
    Recipient:
      allOf:
        - $ref: '#/components/schemas/RailParty'
        - type: object
          required:
            - recipient_type
          properties:
            recipient_type:
              type: string
              enum:
                - individual
                - business
            first_name:
              type: string
            last_name:
              type: string
            business_name:
              type: string
            email:
              type: string
              format: email
            recipient_nationality_code:
              $ref: '#/components/schemas/CountryCode'
            address_line1:
              type: string
            city:
              type: string
    PaymentBase:
      type: object
      properties:
        id:
          type: string
          format: uuid
        merchant_id:
          type: string
          format: uuid
        customer_id:
          type: string
          format: uuid
        quote_id:
          type: string
          format: uuid
        send_amount:
          $ref: '#/components/schemas/DecimalString'
        send_currency:
          $ref: '#/components/schemas/CurrencyCode'
        receive_amount:
          $ref: '#/components/schemas/DecimalString'
        receive_currency:
          $ref: '#/components/schemas/CurrencyCode'
        country_code:
          $ref: '#/components/schemas/CountryCode'
        rail_type:
          $ref: '#/components/schemas/RailType'
        operator_code:
          type: string
        provider_reference:
          type: string
          nullable: true
        wallet_impact:
          type: object
          additionalProperties: true
        pricing:
          type: object
          additionalProperties: true
        history:
          type: array
          items:
            $ref: '#/components/schemas/StatusHistory'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              example: bad_request
            message:
              type: string
              example: quote_id is required
    RailParty:
      type: object
      required:
        - country_code
        - rail_type
      properties:
        country_code:
          $ref: '#/components/schemas/CountryCode'
        rail_type:
          $ref: '#/components/schemas/RailType'
        phone:
          type: string
          example: '+237670000000'
        operator_code:
          type: string
          example: CM_MTN_MOMO
        bank_name:
          type: string
        bank_code:
          type: string
        account_name:
          type: string
        account_number:
          type: string
    CountryCode:
      type: string
      minLength: 2
      maxLength: 2
      example: CM
    DecimalString:
      type: string
      pattern: ^[0-9]+(\.[0-9]+)?$
      example: '10000'
    CurrencyCode:
      type: string
      minLength: 3
      maxLength: 3
      example: XAF
    RailType:
      type: string
      enum:
        - mobile_money
        - bank_transfer
    StatusHistory:
      type: object
      properties:
        status:
          type: string
        reason:
          type: string
          nullable: true
        created_at:
          type: string
          format: date-time
  responses:
    BadRequest:
      description: >-
        Invalid body, missing field, expired quote, quote mismatch, or
        insufficient balance.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Missing, invalid, expired, or inactive API credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Conflict:
      description: Idempotency conflict or request with same key still processing.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: Public API key from the merchant dashboard.
    ApiSecretAuth:
      type: apiKey
      in: header
      name: X-Api-Secret
      description: Secret shown once when the API key is created.

````