List all payment links
List all the payment links.
Required scope: <code style="background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em">link:read</code>
Query parameters
The cursor parameter is used for pagination. It specifies the pointer to the start of the next set of results in a sequence of paginated data. Typically, this is a unique identifier of the last item from the previous response. If not provided, the API fetches the first page of results.
The limit parameter is used for pagination. It specifies the maximum number of entries to return in a single page of results. Max 100.
UUID from a created Pay By Link.
Filter Pay By Links by a certain amount.
Filter Pay By Links by customer name.
Filter Pay By Links by customer email.
Filter Pay By Links by customer phone number.
Filter Pay By Links by creation date.
Filter Pay By Links by modification date.
Filter Pay By Links by expiration date.
Filter Pay By Links by payment methods.
Filter Pay By Links by payment status.
Response
OK
Example response
{
"metadata": {
"next_cursor": "lL_j7ilk7rc",
"count": 10
},
"data": [
{
"created_at": "2025-06-16T13:32:32Z",
"modified_at": "2025-06-16T13:32:32Z",
"expiration_time": "2026-06-10T09:27:55Z",
"communication_channels": [
"SMS"
],
"customer": {
"name": "Jonh Doe",
"email": "example@easypay.pt",
"phone": "+351911234567"
},
"payment": {
"methods": [
"MBW"
],
"single": {
"requested_amount": "10.45"
},
"frequent": {
"minimum_amount": "5",
"maximum_amount": "10"
},
"subscription": {
"maximum_captures": 100,
"start_time": "2025-01-15 00:00"
}
},
"url": "https://easypay.pt/s/XStDvnMKZaN",
"image": "https://cdn.easypay.pt/images/qr/XStDvnMKZaN"
}
]
}