Sign in

v1

latestOpenAPI 3.0.02026-07-246335313.6 KB
Payment APIs

Fetch Merchant Transactions

post/api/merchant/{key}/fetch-all-payments

Path parameters

keystring required

The PortOne Key of the merchant.

Headers

X-Portone-Client-Keystring
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>

Request body

pageinteger required

The page number of the data to be fetched.

sizeinteger required

The page size of the data to be fetched.

fromstring required

The from Date to fetch the sub-merchant.

tostring required

The to Date to fetch the sub-merchant.

environment'live' | 'sandbox' required

The environment of the transaction is either live OR sandbox

Example request

{
  "page": 1,
  "size": 10,
  "from": "2022-12-11T09:05:35.803Z",
  "to": "2024-12-11T09:05:35.803Z",
  "environment": "sandbox"
}

Response

Successful response

messagestring

The description of the API request execution result

status_codestring

The status code of API response

status_reasonstring

The status reason of API response