Payment links
A hosted page where your customer pays you by MTN MoMo - share a link, no checkout to build.
A payment link opens a page hosted by us where your customer enters their MTN MoMo number and
approves the payment on their phone. Send it by SMS, WhatsApp or email, or print it as a QR code.
Each payment is an ordinary MOMO_DEPOSIT into your balance: it appears in your transactions,
sends its webhook and shows in the Events API.
Create one
From the partner dashboard's Payment links page, or with your API credential
(MOMO_DEPOSIT must be enabled):
POST /api/v1/payment-links{
"title": "Order #1042 - 2 pairs of sandals",
"amount": 12000,
"reference": "INV-1042",
"singleUse": true,
"redirectUrl": "https://shop.example.com/thank-you"
}| Field | |
|---|---|
title | Shown on the page. Required. |
description | More detail on the page. |
amount | Whole XAF. Leave it out to let the customer enter the amount (a donation, a top-up). Must fit your MOMO_DEPOSIT limits. |
reference | Your invoice or order number, for your records. |
singleUse | Close the link after its first successful payment, e.g. for an invoice. |
expiresAt | When the link stops accepting payments. |
redirectUrl | Where the customer goes after paying; we add ?status=success&reference={reference}. |
The response has the link's url: send your customer there. A link uses the environment of the
credential that created it; a Sandbox link only accepts the test numbers and says
so on the page.
Follow its payments
GET /api/v1/payment-links/{id} returns the link with every payment made through it, and
GET /api/v1/payment-links lists your links with what each collected. A payment's
partnerOrderId is pl-{code}-{random}, so you can match the deposit's webhook to the link.
A link's status is:
| Status | Meaning |
|---|---|
OPEN | Accepts payments. |
PAID | A single-use link that has been paid. |
EXPIRED | Past its expiresAt. |
DISABLED | You switched it off with POST /api/v1/payment-links/{id}/disable. |
While a payment on a single-use link is waiting for the customer's approval, the page refuses a second attempt for 5 minutes, so the customer can't pay twice by retrying.
