API reference
Claims
Submit a Transaction ID for a payment.
Claim a payment#
POST
/v1/intents/:id/claimAPI keySubmit the Transaction ID the customer gave you (“I have paid”).
Parameters
transactionIdstringrequiredThe MoMo Transaction ID from the customer’s confirmation SMS (4–40 chars; normalised).
referencestringoptionalThe reference the customer says they typed. Used as supporting evidence only.
Response
{ "outcome": "CLAIM_SUBMITTED", "intent": { "id": "…", "status": "CLAIM_SUBMITTED", … } }| outcome | Meaning |
|---|---|
VERIFIED | The SMS was already here and fits — paid. |
CLAIM_SUBMITTED | Waiting for the SMS; it verifies automatically when it arrives. |
REVIEW | The SMS is here but doesn’t fit; see intent.reviewReason. |
Bare claims#
POST
/v1/claimsAPI keyFor flows where the customer pays first and tells you afterwards (for example “top up any amount”), create and claim in one call. The payment is created with amount policy ANY and you learn the amount from receivedAmountPesewas.
Parameters
orderReferencestringrequiredYour reference for this claim (unique per purpose).
transactionIdstringrequiredThe MoMo Transaction ID.
referencestringoptionalReference typed by the customer.
purposestringoptionalDefault
payment.descriptionstringoptionalFree text.
customerobjectoptional{ ref?, name? }