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

# Create a Payout

> Create a new payout. An idempotent key is required in the request header.



## OpenAPI

````yaml api-reference/openapi.json post /v1/payouts
openapi: 3.0.1
info:
  title: Monxa API
  description: ''
  version: 1.0.0
servers: []
security:
  - Bearer: []
tags:
  - name: balances
  - name: customers
  - name: merchants
  - name: charges
  - name: payouts
paths:
  /v1/payouts:
    post:
      tags:
        - payouts
      summary: Create a Payout
      description: >-
        Create a new payout. An idempotent key is required in the request
        header.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePayoutRequest'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutDto'
          headers: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          headers: {}
        '401':
          description: Unauthorized
          headers: {}
        '403':
          description: Forbidden
          headers: {}
        '404':
          description: Not Found
          headers: {}
        '409':
          description: Conflict
          headers: {}
        '429':
          description: Too Many Requests
          headers: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          headers: {}
      deprecated: false
      security:
        - Bearer: []
components:
  schemas:
    CreatePayoutRequest:
      required:
        - amount
        - bank_account_name
        - bank_account_number
        - bank_name
        - currency
      type: object
      properties:
        amount:
          type: number
          description: Amount
          format: double
        metadata:
          type: object
          additionalProperties:
            type: string
          description: Metadata
          properties: {}
          nullable: true
        bank_account_name:
          type: string
          description: Bank Account Name
        bank_account_number:
          type: string
          description: Bank Account Number
        bank_name:
          type: string
          description: Bank Name
        currency:
          type: string
          description: Currency
        description:
          type: string
          description: Description
          nullable: true
        reference_id:
          type: string
          description: Reference Id
          nullable: true
    PayoutDto:
      required:
        - fee
        - bank_account_name
        - bank_account_number
        - bank_name
        - currency
        - merchant_id
        - id
        - created_on
      type: object
      properties:
        amount:
          type: number
          format: double
        fee_amount:
          type: number
          format: double
        net_amount:
          type: number
          format: double
        fee:
          $ref: '#/components/schemas/MxFee'
        payout_status:
          $ref: '#/components/schemas/PayoutStatus'
        bank_account_name:
          type: string
        bank_account_number:
          type: string
        bank_name:
          type: string
        currency:
          type: string
        merchant_id:
          type: string
        description:
          type: string
          nullable: true
        id:
          type: string
          format: uuid
        created_on:
          type: string
          format: date-time
        updated_on:
          type: string
          format: date-time
          nullable: true
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
    MxFee:
      required:
        - type
        - value
      type: object
      properties:
        type:
          $ref: '#/components/schemas/FeeTypes'
        value:
          type: number
          format: float
    PayoutStatus: {}
    FeeTypes: {}
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer

````