---
title: "Fetch Payouts List"
method: POST
path: "/api/merchant/{key}/payouts"
tags: ["Payout APIs"]
---

# Fetch Payouts List

`POST /api/merchant/{key}/payouts`

Use this API for fetching the list of payouts for a merchant.

## Path parameters

- `key` string, required

## Headers

- `Authorization` string
- `X-Portone-Client-Key` string

## Request body

- object
  - `page` integer, required — The page number of the data to be fetched.
  - `pagesize` integer, required — The page size of the data to be fetched.
  - `to` string, required — The to Date to fetch the sub-merchant.
  - `from` string, required — The from Date to fetch the sub-merchant.
  - `filters` object — The Payment Method Key listed in PortOne docs
  - `environment` 'live' | 'sandbox', required — The environment of the transaction is either live OR sandbox

## Response `200`

Successful response

- object
  - `content` unknown[] — The object containing the Payouts data of the sub-merchant.
    - unknown
  - `total_elements` string — The total number of elements in the response.
  - `total_pages` string — The total pages in the response.
  - `size` string — The size of the response
  - `page` string — the current page in the response.
  - `number_of_elements` string — The total number of elements in the response.

## Other responses

- `400` — Failure response
- `401` — Failure response

---

[API](https://skmtc.net/portone/apis/payment-apis.md) · [All operations](https://skmtc.net/portone/apis/payment-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/portone/payment-apis/revisions/f3ccea652555/schema)