curl --request POST \
--url https://api.primepay.mw/v1/payment-links \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Instagram orders",
"amount": 15000,
"description": "Chitenje dress, size M",
"usage": "once",
"expiresIn": "7d",
"collectName": true,
"collectEmail": false,
"redirectUrl": "https://shop.example.com/thanks"
}
'{
"id": "0b6f6a51-6f1e-4b0e-9a55-2f4f1c9d7e10",
"url": "https://checkout.primepay.mw/l/7KQ2M9XW",
"code": "7KQ2M9XW",
"status": "active",
"liveMode": true,
"name": "Instagram orders",
"description": "Chitenje dress, size M",
"amount": 15000,
"currency": "MWK",
"items": [],
"usage": "once",
"timesPaid": 0,
"collectName": true,
"collectEmail": false,
"redirectUrl": "https://shop.example.com/thanks",
"createdAt": "2026-11-11T10:40:12Z",
"expiresAt": "2026-11-18T10:40:12Z",
"subMerchantAccountCode": null,
"subMerchantName": null
}{
"error": {
"code": "insufficient_funds",
"message": "Not enough available balance for MWK 25,000.00.",
"field": "<string>"
}
}Create a payment link
Makes a link that pays the account that owns the API key. Send either amount with description, or items. Give url to your customer.
Guide: payment links and payment link errors.
curl --request POST \
--url https://api.primepay.mw/v1/payment-links \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Instagram orders",
"amount": 15000,
"description": "Chitenje dress, size M",
"usage": "once",
"expiresIn": "7d",
"collectName": true,
"collectEmail": false,
"redirectUrl": "https://shop.example.com/thanks"
}
'{
"id": "0b6f6a51-6f1e-4b0e-9a55-2f4f1c9d7e10",
"url": "https://checkout.primepay.mw/l/7KQ2M9XW",
"code": "7KQ2M9XW",
"status": "active",
"liveMode": true,
"name": "Instagram orders",
"description": "Chitenje dress, size M",
"amount": 15000,
"currency": "MWK",
"items": [],
"usage": "once",
"timesPaid": 0,
"collectName": true,
"collectEmail": false,
"redirectUrl": "https://shop.example.com/thanks",
"createdAt": "2026-11-11T10:40:12Z",
"expiresAt": "2026-11-18T10:40:12Z",
"subMerchantAccountCode": null,
"subMerchantName": null
}{
"error": {
"code": "insufficient_funds",
"message": "Not enough available balance for MWK 25,000.00.",
"field": "<string>"
}
}Authorizations
Your API key: sk_live_… / sk_test_… (secret), pk_live_… / pk_test_… (publishable, read-only reference data) or rk_live_… / rk_test_… (payments only).
Body
Required with description. Greater than zero, at most 2 decimal places, at most MWK 10,000,000. Don't send it with items.
15000
Required with amount. What the customer is paying for. Shown to the customer.
255"Chitenje dress, size M"
Instead of amount. The amount is their total.
1 - 50 elementsShow child attributes
Show child attributes
A label for you only. Customers never see it.
100"Instagram orders"
many: the link can be paid any number of times. once: it closes after the first payment.
many, once never, 24h, 7d, 30d Ask the customer for their name.
Ask the customer for their email.
Where the customer goes after paying. Must be a public https:// address (sandbox also allows http://localhost). Without it, the customer sees PrimePay's receipt page.
Response
The link.
The checkout address to send to your customer.
active: can be paid. inactive: deactivated by you, can be reactivated. completed: a once link that has been paid (final). expired: its expiresAt has passed (final).
active, inactive, completed, expired "MWK"
Show child attributes
Show child attributes
many, once The number of completed payments.
Was this page helpful?