Sign in

v1

latestOpenAPI 3.0.02026-07-246335313.6 KB
Payout APIs

Fetch Payouts List

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

post/api/merchant/{key}/payouts

Path parameters

keystring required

Headers

Authorizationstring

The Authorization header is used to include the JWT for authenticating API requests; learn how to generate the token <a href="/docs/jwt-authentication" target="_blank">in this guide</a>

X-Portone-Client-Keystring

Request body

pageinteger required

The page number of the data to be fetched.

pagesizeinteger required

The page size of the data to be fetched.

tostring required

The to Date to fetch the sub-merchant.

fromstring required

The from Date to fetch the sub-merchant.

filtersobject

The Payment Method Key listed in PortOne docs

environment'live' | 'sandbox' required

The environment of the transaction is either live OR sandbox

Example request

{
  "page": 1,
  "pagesize": 10,
  "from": "2006-01-02 15:04:05",
  "to": "2026-09-13 16:04:00",
  "filters": {},
  "environment": "sandbox"
}

Response

Successful response

total_elementsstring

The total number of elements in the response.

total_pagesstring

The total pages in the response.

sizestring

The size of the response

pagestring

the current page in the response.

number_of_elementsstring

The total number of elements in the response.