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

# Get a payout by id



## OpenAPI

````yaml /api-reference/openapi.json get /api/v2/payouts/{payout_id}
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/{payout_id}:
    get:
      tags:
        - Payouts
      summary: Get a payout by id
      operationId: get__api_v2_payouts_{payout_id}
      parameters:
        - name: payout_id
          in: path
          required: true
          schema:
            type: string
          description: Unique 24-character hex payout id.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutEnvelope.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'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope.d4a12ff'
        '422':
          description: Unprocessable Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope.d4a12ff'
components:
  schemas:
    PayoutEnvelope.d4a12ff:
      properties:
        ok:
          const: true
          title: Ok
          type: boolean
        result:
          $ref: '#/components/schemas/PayoutEnvelope.d4a12ff.Payout'
      required:
        - ok
        - result
      title: PayoutEnvelope
      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
    PayoutEnvelope.d4a12ff.Payout:
      example:
        address: TXk2Y5...redacted
        amount: 25
        created_at: 1763398900
        currency: usdt_tron
        energy_fee_usd: 0.4
        fee: 1
        fee_bearer: merchant
        fee_usd: 1
        fiat_amount_usd: 25
        order_id: 65f1c3a4e8b1c2d3a4b5c6e0
        processed_at: 1763398930
        ref: merchant-ref-1
        status: success
        tx_hashes: null
        txid: 0x9a8b7c6d...
      properties:
        order_id:
          title: Order Id
          type: string
        status:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            One of: first_payout_review, pending, processing, success, failed,
            cancelled.
          title: Status
        address:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Address
        amount:
          anyOf:
            - type: number
            - type: 'null'
          default: null
          description: Amount in `currency`.
          title: Amount
        fiat_amount_usd:
          anyOf:
            - type: number
            - type: 'null'
          default: null
          description: >-
            USD-equivalent of `amount` at payout creation time, before
            withdrawal and energy fees.
          title: Fiat Amount Usd
        debit_usd:
          anyOf:
            - type: number
            - type: 'null'
          default: null
          description: Total USD deducted from merchant balance.
          title: Debit Usd
        currency:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Asset key (e.g. usdt_tron).
          title: Currency
        ref:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Merchant-supplied reference, defaults to `automatic_payout`.
          title: Ref
        fee:
          anyOf:
            - type: number
            - type: 'null'
          default: null
          description: Network fee in the asset's units.
          title: Fee
        fee_usd:
          anyOf:
            - type: number
            - type: 'null'
          default: null
          title: Fee Usd
        energy_fee_usd:
          anyOf:
            - type: number
            - type: 'null'
          default: null
          description: Tron energy surcharge in USD (0 outside Tron).
          title: Energy Fee Usd
        fee_bearer:
          anyOf:
            - enum:
                - merchant
                - client
              type: string
            - type: 'null'
          default: merchant
          title: Fee Bearer
        txid:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Single tx hash for non-batch payouts. Set after broadcast.
          title: Txid
        tx_hashes:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          default: null
          description: Multiple tx hashes for EVM batch payouts (one per chunk).
          title: Tx Hashes
        created_at:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          title: Created At
        processed_at:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Unix timestamp when status flipped from `pending`/`processing`.
          title: Processed At
        voided:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          description: >-
            True if the payout was voided by an operator and is no longer
            counted toward the balance.
          title: Voided
        voided_at:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          title: Voided At
        voided_reason:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Voided Reason
      required:
        - order_id
      title: Payout
      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

````