List Payment Links

The List Payment Links API allows partners to list all Payment Links for a given merchant ID.
Pagination meta data is provided in the response to support lazy loading and pagination.
"meta": {
"total": 12,
"current_page": 1,
"total_pages": 6
}
Sample Request
Sample Response
1
curl --location --request GET '<API_HOST>/api/merchant/1cc7b594-b80f-4227-a0fa-299c4c6ce8ab/payment-link?page=1&limit=2' \
2
--header 'Authorization: Basic <API_KEY>'
{
"data": [
{
"merchantId": "1cc7b594-b80f-4227-a0fa-299c4c6ce8ab",
"oneTimeOnly": true,
"amount": "1270.22",
"currencyCode": "USD",
"salesTax": "0.00",
"orderNumber": null,
"payerId": "1234",
"payerEmail": null,
"description": "A coffee cup in the morning",
"startDate": null,
"endDate": null,
"createdAt": "2022-09-11T02:30:12.618Z",
"updatedAt": "2022-09-11T02:30:12.618Z",
"merchantName": "Test Business",
"paymentLinkId": "41ke9",
"paymentLinkStatus": "ACTIVE",
"paymentLinkUrl": "https://staging-sandbox.payengine.dev/payment-link/41ke9",
"qrCodeUrl": "https://staging-sandbox.payengine.dev/payment-link/41ke9/qr"
},
{
"merchantId": "1cc7b594-b80f-4227-a0fa-299c4c6ce8ab",
"oneTimeOnly": true,
"amount": "1270.22",
"currencyCode": "USD",
"salesTax": "0.00",
"orderNumber": null,
"payerId": "1234",
"payerEmail": null,
"description": "A coffee cup in the morning",
"startDate": null,
"endDate": null,
"createdAt": "2022-09-11T02:30:12.618Z",
"updatedAt": "2022-09-11T02:30:12.618Z",
"merchantName": "Test Business",
"paymentLinkId": "dtvxs",
"paymentLinkStatus": "ACTIVE",
"paymentLinkUrl": "https://staging-sandbox.payengine.dev/payment-link/dtvxs",
"qrCodeUrl": "https://staging-sandbox.payengine.dev/payment-link/dtvxs/qr"
}
],
"meta": {
"total": 12,
"current_page": 1,
"total_pages": 6
}
}