> ## 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. # List payouts ## OpenAPI ````yaml /api-reference/openapi.json get /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: get: tags: - Payouts summary: List payouts operationId: get__api_v2_payouts parameters: - name: date_from in: query schema: anyOf: - type: string - type: 'null' default: null description: ISO-8601 datetime or unix timestamp. title: Date From required: false description: ISO-8601 datetime or unix timestamp. - name: date_to in: query schema: anyOf: - type: string - type: 'null' default: null description: ISO-8601 datetime or unix timestamp. title: Date To required: false description: ISO-8601 datetime or unix timestamp. - name: sort in: query schema: default: created_at enum: - created_at - amount title: Sort type: string required: false description: '' - name: order in: query schema: default: desc enum: - asc - desc title: Order type: string required: false description: '' - name: page in: query schema: default: 1 minimum: 1 title: Page type: integer required: false description: '' - name: per_page in: query schema: default: 20 maximum: 100 minimum: 1 title: Per Page type: integer required: false description: '' - name: order_ids in: query schema: anyOf: - type: string - type: 'null' default: null description: Comma-separated list of payout ids. title: Order Ids required: false description: Comma-separated list of payout ids. - name: status in: query schema: anyOf: - type: string - type: 'null' default: null title: Status required: false description: '' - name: asset in: query schema: anyOf: - type: string - type: 'null' default: null description: Filter by asset key (e.g. usdt_tron). title: Asset required: false description: Filter by asset key (e.g. usdt_tron). responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PayoutListEnvelope.d4a12ff' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope.d4a12ff' '422': description: Unprocessable Content content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope.d4a12ff' components: schemas: PayoutListEnvelope.d4a12ff: properties: ok: const: true title: Ok type: boolean result: items: $ref: '#/components/schemas/PayoutListEnvelope.d4a12ff.Payout' title: Result type: array pagination: $ref: '#/components/schemas/PayoutListEnvelope.d4a12ff.Pagination' required: - ok - result - pagination title: PayoutListEnvelope 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 PayoutListEnvelope.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 PayoutListEnvelope.d4a12ff.Pagination: example: page: 1 pages: 1 per_page: 20 total: 1 properties: page: minimum: 1 title: Page type: integer per_page: maximum: 100 minimum: 1 title: Per Page type: integer total: minimum: 0 title: Total type: integer pages: minimum: 0 title: Pages type: integer required: - page - per_page - total - pages title: Pagination 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 ````