---
title: "List Payouts"
method: GET
path: "/v1/payouts"
tags: ["Payouts"]
---

# List Payouts

`GET /v1/payouts`

Retrieves a list of payout transactions. The response can be filtered by specifying a creation date range or payout status.
##### Usage Guidelines:
- If `start_time` and `end_time` are both omitted, the API returns payouts from the last 30 days by default.
- If only `end_time` is provided, it retrieves payouts within the past 30 days up to `end_time`.

## Query parameters

- `page_size` integer, required
- `page_number` integer, required
- `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.
- `start_time` string
- `end_time` string

## Headers

- `x-on-behalf-of` string

## Response `200`

OK - Successfully retrieved a list of payouts.

- object
  - `total_pages` integer — The total pages of available items.
  - `total_items` integer — The total counts of available items.
  - `data` 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)