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

# Create a payout

> Requires the request IP to be whitelisted for the merchant. The `x-uniq-id` header (UUIDv4) is mandatory and provides idempotency for 2 hours.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v2/payouts
openapi: 3.1.0
info:
  title: PawPayments API
  description: >-
    Public REST API for the PawPayments crypto payment gateway.


    All `/api/v2/*` endpoints require an `x-api-key` header issued in the
    merchant dashboard. Responses are wrapped in `{"ok": true, "result": ...}`
    on success and `{"ok": false, "error": {code, message, details?}}` on
    failure.
  version: 2.0.0
servers:
  - url: https://api.pawpayments.com
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Catalog
  - name: Merchant
  - name: Invoices
  - name: Payouts
  - name: Notifications
  - name: Permanent addresses
paths:
  /api/v2/payouts:
    post:
      tags:
        - Payouts
      summary: Create a payout
      description: >-
        Requires the request IP to be whitelisted for the merchant. The
        `x-uniq-id` header (UUIDv4) is mandatory and provides idempotency for 2
        hours.
      operationId: post__api_v2_payouts
      parameters:
        - name: X-Uniq-Id
          in: header
          schema:
            description: UUIDv4 for idempotency.
            title: X-Uniq-Id
            type: string
          required: true
          description: UUIDv4 for idempotency.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePayoutV2.a1ea1bf'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutCreatedEnvelope.d4a12ff'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope.d4a12ff'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope.d4a12ff'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope.d4a12ff'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope.d4a12ff'
        '422':
          description: Unprocessable Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope.d4a12ff'
components:
  schemas:
    CreatePayoutV2.a1ea1bf:
      properties:
        address:
          minLength: 10
          title: Address
          type: string
        amount:
          anyOf:
            - exclusiveMinimum: 0
              type: number
            - type: string
          title: Amount
        fiat_currency:
          title: Fiat Currency
          type: string
        asset:
          title: Asset
          type: string
        ref:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Ref
        fee_bearer:
          default: client
          enum:
            - merchant
            - client
          title: Fee Bearer
          type: string
      required:
        - address
        - amount
        - fiat_currency
        - asset
      title: CreatePayoutV2
      type: object
    PayoutCreatedEnvelope.d4a12ff:
      properties:
        ok:
          const: true
          title: Ok
          type: boolean
        result:
          $ref: '#/components/schemas/PayoutCreatedEnvelope.d4a12ff.PayoutCreated'
      required:
        - ok
        - result
      title: PayoutCreatedEnvelope
      type: object
    ErrorEnvelope.d4a12ff:
      example:
        error:
          code: VALIDATION_ERROR
          details:
            - field: amount
              message: Field required
          message: Validation failed
        ok: false
      properties:
        ok:
          const: false
          title: Ok
          type: boolean
        error:
          $ref: '#/components/schemas/ErrorEnvelope.d4a12ff.ErrorBody'
      required:
        - ok
        - error
      title: ErrorEnvelope
      type: object
    PayoutCreatedEnvelope.d4a12ff.PayoutCreated:
      example:
        order_id: 65f1c3a4e8b1c2d3a4b5c6e0
      properties:
        order_id:
          title: Order Id
          type: string
      required:
        - order_id
      title: PayoutCreated
      type: object
    ErrorEnvelope.d4a12ff.ErrorBody:
      properties:
        code:
          description: Machine-readable error code (e.g. NOT_FOUND, VALIDATION_ERROR).
          title: Code
          type: string
        message:
          title: Message
          type: string
        details:
          anyOf:
            - {}
            - type: 'null'
          default: null
          description: >-
            Optional context. For VALIDATION_ERROR contains a list of {field,
            message}.
          title: Details
      required:
        - code
        - message
      title: ErrorBody
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      name: x-api-key
      in: header

````