Skip to main content
GET
List Payment Links

Overview

Returns your payment links a page at a time, newest first. Each entry carries the link’s status, its buyer, its amount and the order behind it.
PSPs get one list covering every link they can act for — their own and all their sub-merchants’. merchant on each entry says whose it is. X-Merchant-ID does not narrow the list.

Query Parameters

The list takes no filters. There is no status, date or reference filter, so page through every link and filter on your side. To follow one link, call Retrieve Payment Link with its link_id.

Pagination

data wraps the page: Follow next until it is null. A page past the last one is not returned empty — it is refused with a 500:
List returns each link’s status as last recorded. Retrieve Payment Link checks an active link for a payment before answering, so right after a payment it can read paid before List does.

Response Fields

  • link_id is the link’s ID — what Retrieve and Deactivate take. payment_id is the same value, kept for compatibility.
  • amount.amount and amount.total_amount are decimal strings without trailing zeros — "1500", "2499.5". Parse them as decimals, never as floats. total_amount adds GST where GST applies; otherwise it equals amount.
  • mop_type is the method the buyer paid with, in lowercase (upi, credit_card). It is null until the link is paid, and can stay null after. Retrieve Payment Link gives the same value in uppercase.
  • comment says why a link failed or closed, when there is a reason to give; otherwise it is null.
  • payment_link is null for a link that could not be created.
  • order_id is the order behind the link (OD followed by 10 digits).
  • created_at is UTC with microseconds, e.g. 2026-09-14T09:30:15.123456Z.

Authorizations

X-Client-ID
string
header
required

Client Application ID - Your unique application identifier used to authenticate API requests. You can find your Client ID in the Developer Settings section of the merchant dashboard.

X-Client-Secret
string
header
required

Client Secret Key - Your secret key used alongside the Client ID for secure authentication. Keep this confidential and never expose it in client-side code. Available in the Developer Settings section of the merchant dashboard.

X-API-Version
string
header
required

API Version - Specifies which version of the API to use (e.g., '1.X.X', '2.X.X', or '3.X.X'). This header allows you to control which API version your integration uses. Default version information is available in the Developer Settings.

Query Parameters

page
integer
default:1

Page number, starting at 1. Stop when next is null: a page past the last one is refused with a 500.

Required range: x >= 1
page_size
integer
default:250

Links per page. Values above 1000 are capped at 1000.

Required range: 1 <= x <= 1000
ordering
enum<string>
default:-created_at

Sort order. Prefix with - for descending.

Available options:
-created_at,
created_at,
-last_updated_at,
last_updated_at,
-payment_completed_at,
payment_completed_at

Response

A page of payment links

success
boolean
required

Indicates if the request was successful

message
string
required

Response message

data
object
required