Sign in

v1

latestOpenAPI 3.0.02026-07-246335313.6 KB
MasterMerchant APIs

Fetch All Sub-merchants Paginated

post/api/master-merchant/{mkey}/merchants/paginated

Path parameters

mkeystring required

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

pagestring required

The page number of the data to be fetched.

pagesizestring 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 required

The filters to apply to the sub-merchant, check examples.

environment'live' | 'sandbox' required

The environment of the transaction is either live OR sandbox

Example request

{
  "page": 1,
  "pagesize": 20,
  "filters": {
    "merchant_status": [
      "ACTIVE"
    ]
  },
  "from": "2006-01-02 15:04:05",
  "to": "2022-09-13 16:04:00"
}

Response

Successful response

messagestring

The description of the API request execution result

status_codestring

The status_code for API request execution result

status_reasonstring

The status_reason for API request execution result