curl --request GET \
--url https://api.cashful.africa/api/canary/payment-links \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "plink_001",
"name": "Summer Sale Link",
"description": "Payment link for the summer sale campaign",
"merchantId": "merchant_456",
"url": "https://checkout.cashful.africa/plink_001",
"totalAmount": 15000,
"currency": "ZAR",
"mode": "payment",
"active": true,
"successUrl": "https://example.com/success",
"cancelUrl": "https://example.com/cancel",
"lineItems": [
{
"name": "Product A",
"amount": 15000,
"quantity": 1,
"currency": "ZAR"
}
],
"metadata": {
"campaign": "summer_sale"
},
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2025-01-15T10:30:00.000Z",
"deletedAt": null
}
],
"pagination": {
"limit": 50,
"offset": 0,
"total": 15,
"hasMore": false
}
}Retrieves all payment links created by the merchant
curl --request GET \
--url https://api.cashful.africa/api/canary/payment-links \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "plink_001",
"name": "Summer Sale Link",
"description": "Payment link for the summer sale campaign",
"merchantId": "merchant_456",
"url": "https://checkout.cashful.africa/plink_001",
"totalAmount": 15000,
"currency": "ZAR",
"mode": "payment",
"active": true,
"successUrl": "https://example.com/success",
"cancelUrl": "https://example.com/cancel",
"lineItems": [
{
"name": "Product A",
"amount": 15000,
"quantity": 1,
"currency": "ZAR"
}
],
"metadata": {
"campaign": "summer_sale"
},
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2025-01-15T10:30:00.000Z",
"deletedAt": null
}
],
"pagination": {
"limit": 50,
"offset": 0,
"total": 15,
"hasMore": false
}
}Documentation Index
Fetch the complete documentation index at: https://docs.cashful.africa/llms.txt
Use this file to discover all available pages before exploring further.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The ID of the merchant whose payment links are being requested. If omitted, defaults to the authenticated merchant.
Maximum number of records to return
Number of records to skip
Filter by active status