ReferencePayment links

List payment links

Required scopepayment_links:readThe API key must hold this scope, otherwise Kivoo answers 403 insufficient_scope.
GET/v1/payment-links

Payment links of the store, newest first, with their counters.

Authorization

apiKey
AuthorizationBearer <token>

Clé API de la boutique, kv_live_…

In: header

Query Parameters

page?number

Page to return, from 1

Range1 <= value
Default1
pageSize?number

Items per page, 1 to 100

Range1 <= value <= 100
Default25
status?string

active: takes payments now; inactive: disabled, expired or exhausted

Value in

  • "active"
  • "inactive"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.kivoo.africa/v1/payment-links" \  -H "Authorization: Bearer kv_live_EXAMPLE0000000000000000000000000000000000"
{  "page": 1,  "pageSize": 25,  "total": 42,  "data": [    {      "id": "9e8d7c6b-5a4f-4e3d-8c2b-1a0f9e8d7c6b",      "code": "ab23cd45",      "url": "https://atelier-nour.kivoo.store/pay/ab23cd45",      "title": "Acompte robe bleue",      "description": "Pour réserver ta robe.",      "coverUrl": null,      "pricing": "FIXED",      "amount": 15000,      "minAmount": null,      "currency": "XAF",      "thankYouMessage": "Merci, à très vite !",      "expiresAt": "2026-12-31T23:00:00.000Z",      "maxPayments": 20,      "disabledAt": null,      "availability": "ACTIVE",      "paidCount": 4,      "paidAmount": 60000,      "lastPaidAt": "2026-09-12T10:05:00.000Z",      "createdAt": "2026-09-01T08:00:00.000Z",      "updatedAt": "2026-09-01T08:00:00.000Z"    }  ]}