---
title: "Fetch All Payment Links Paginated"
method: POST
path: "/api/master-merchant/{mkey}/merchants/payment-links"
tags: ["MasterMerchant APIs"]
---

# Fetch All Payment Links Paginated

`POST /api/master-merchant/{mkey}/merchants/payment-links`

## Path parameters

- `mkey` string, required

## Headers

- `X-Portone-Client-Key` string
- `Authorization` 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.
  - `from` string, required — The from Date to fetch the sub-merchant.
  - `to` string, required — The to Date to fetch the sub-merchant.
  - `merchant_keys` string[], required — The list of Sub-merchants PortOne keys
  - `filters` object, required — 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` SubMerchantPaymentLinkContent[] — The array of Payment Links data of sub merchants
    - `link` string — The URL of the payment link.
    - `currency` string — The currency of the transaction.
    - `link_ref` string — The unique reference of the payment link.
    - `amount` number, double — The amount of the transaction.
    - `countryCode` string — The country code of the transaction.
    - `portone_key` string — The unique PortOne key for merchant.
    - `status` string — The status of the payment link.
    - `success_url` string — The success_url set to redirect_url after payment completion.
    - `cancel_url` string — The cancel_url set to redirect_url after payment completion.
    - `merchant_order_ref` string — The unique merchant order reference of the transaction.
    - `is_billing_shipping_same` boolean — The boolean flag indicating whether the billing and shipping details same of the transaction.
    - `merchant_name` string — The mname of the merchant.
    - `merchant_logo` string — The URL of the merchant logo.
    - `merchant_back_url` string — The URL directed once customer clicks the back button.
    - `merchant_shipping_charges` number, double — The amount of charges configured by the merchant.
    - `merchant_promo_code` string — The promo code applied for the payment link.
    - `merchant_promo_discount` number, double — The promo discount applied for the payment link.
    - `user_agent` string — The user_agent details of the device from which the payment link is created.
    - `ip_address` string — The IP address of the device from which the payment link is created.
    - `expiry_hours` number — The number of hours after which the payment will be expired.
    - `created_at` string — The timestamp of the time when payment link was created.
    - `source` string — The source of the payment link creation. either API or Admin console. Pls refer PortOne docs for additional details.
    - `description` string — The description of the payment link.
    - `mobile_redirect_url` string — The deep link of the merchant app to redirect after payment completion. Refer PortOne docs for additional details.
    - `show_shipping_details` boolean — The boolean value indicating whether to show shipping details.
    - `show_back_button` boolean — The boolean value indicating whether to show the back button.
    - `default_guest_checkout` boolean — The boolean value indicating whether default checkout is allowed.
    - `is_checkout_embed` boolean — The boolean value indicating whether the checkout is embeded.
    - `notify_by_email` boolean — The boolean value indicating whether to notify the merchant by email or not.
    - `notify_by_phone` boolean — The boolean value indicating whether to notify the merchant by phone or not.
    - `show_items` boolean — The boolean flag indicating whether to show items in the checkout UI of payment link.
    - `merchant_key` string — The unique PortOne key for merchant.
    - `merchant_email_address` string — The email address of the merchant.
    - `customer_name` string — The name of the customer.
    - `customer_email_address` string — The email address of the customer.
    - `customer_phone_number` string — The phone number of the customer.
    - `payment_page_ref` string — The unique reference of the payment page.
  - `total_elements` number — The number of total_elements in the response.
  - `total_pages` number — The number of total_pages in the response.
  - `size` number — The size of the current page.
  - `page` number — The current page number.
  - `number_of_elements` number — The number of elements in the current page.

## 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)