Skip to main content
GET
/
api
/
v1
/
payment-links
List payment links
curl --request GET \
  --url https://core.quidkey.com/api/v1/payment-links \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "merchant": {
        "id": "m1234567-abcd-ef01-2345-678901234567",
        "brand_name": "Acme Corp"
      },
      "amount": "50.00",
      "currency": "EUR",
      "payment_reference": "INV-2024-001",
      "order_id": null,
      "status": "active",
      "link_type": "single_use",
      "views_count": 3,
      "first_viewed_at": "2024-04-01T14:30:00.000Z",
      "expires_at": "2024-04-07T12:00:00.000Z",
      "created_at": "2024-03-31T12:00:00.000Z",
      "transaction_id": null
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "totalPages": 1
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

status
enum<string>

Filter by payment link status

Available options:
active,
used,
expired,
cancelled

Search by payment reference or order ID

merchant_id
string<uuid>

Filter by merchant ID (partner authentication only)

page
integer
default:1

Page number (1-based)

Required range: x >= 1
limit
integer
default:20

Items per page (max 100)

Required range: 1 <= x <= 100

Response

Payment links retrieved successfully

success
boolean
required
Example:

true

data
Payment Link List Item · object[]
required
pagination
object
required