Skip to main content
GET
/
api
/
canary
/
payment-links
List Payment Links
curl --request GET \
  --url http://localhost:3000/api/canary/payment-links \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "plink_001",
      "merchantId": "merchant_456",
      "url": "https://pay.cashful.africa/link/plink_001",
      "productId": "product_001",
      "amount": 15000,
      "currency": "ZAR",
      "mode": "payment",
      "active": true,
      "successUrl": "https://example.com/success",
      "cancelUrl": "https://example.com/cancel",
      "metadata": {
        "campaign": "summer_sale"
      },
      "createdAt": "2025-01-15T10:30:00.000Z",
      "updatedAt": "2025-01-15T10:30:00.000Z"
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total": 15,
    "hasMore": false
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

active
boolean

Filter by active status

merchantId
string
required

The ID of the merchant. This parameter is required.

limit
number

Maximum number of records to return

offset
number

Number of records to skip

Response

Successfully retrieved payment links

data
object[]
required
pagination
object
required