---
title: "List all Payouts"
method: GET
path: "/v2/payment/payout"
tags: ["Payment Payouts"]
---

# List all Payouts

`GET /v2/payment/payout`

Retrieve a list of payout orders with optional filtering and pagination support.

#### Usage Guidelines
- **Default behavior**: If no date range is specified, returns the first page of payouts created from one month ago to today.
- **Date range filtering**: When using date filters, both `start_time` and `end_time` parameters are required, and `end_time` must be greater than or equal to `start_time`. The time range must not exceed one month.

## Query parameters

- `page_number` integer, required
- `page_size` integer, required
- `start_time` string
- `end_time` string
- `payout_status` 'INITIATED' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'FAILED_REFUNDED' — Payout status enumeration. - `INITIATED`: Payout has been initiated. - `PROCESSING`: Payout is being processed (bank is processing). - `COMPLETED`: Payout completed successfully. - `FAILED`: Payout failed. - `FAILED_REFUNDED`: Payout failed and funds have been refunded.

## Headers

- `x-on-behalf-of` string
- `x-idempotency-key` string, uuid

## Response `200`

List of payouts retrieved successfully

- PayoutListResponse
  - `total_pages` integer, required — The total pages of available items.
  - `total_items` integer, required — The total counts of available items.
  - `data` PayoutResponse[], required — List of payout records.
    - `payout_id` string, required — Payout UUID
    - `payout_currency` string, required — Three-letter currency code
    - `payout_amount` string, required — The amount to be withdrawn through this payout.
    - `internal_note` string — Payout remark information
    - `statement_descriptor` string, required — Payout reference information displayed to the recipient's bank
    - `payout_status` 'INITIATED' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'FAILED_REFUNDED', required — Payout status enumeration. - `INITIATED`: Payout has been initiated. - `PROCESSING`: Payout is being processed (bank is processing). - `COMPLETED`: Payout completed successfully. - `FAILED`: Payout failed. - `FAILED_REFUNDED`: Payout failed and funds have been refunded.
    - `create_time` string, date/time, required
    - `completed_time` string, date/time

---

[API](https://skmtc.dev/uqpay/apis/authentication-api.md) · [All operations](https://skmtc.dev/uqpay/apis/authentication-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/uqpay/authentication-api/revisions/cef532a10777/schema)