MTN MoMo icon

MTN MoMo

Interact with MTN Mobile Money API

Payment → Request Payment

AI-generated

Summary

Request a payment from a customer using their phone number, specifying amount, currency, and optional messages.

Inputs

  • Phone Number (required) — Recipient phone number in MSISDN format (e.g., 250788123456).
  • Amount (required) — The amount of money to request from the customer.
  • Currency (required) — Currency code for the transaction, such as RWF, UGX, or XAF.
  • External ID — An internal transaction ID to identify the request; defaults to the current timestamp in milliseconds.
  • Payer Message — Optional message to include for the payer.
  • Payee Note — Optional note to include for the payee.

Output shape

a single JSON object per input item containing success status, a unique MTN referenceId for tracking, amount, currency, phone number, and the externalId used.

The referenceId is used for querying transaction status later. If the operation fails and 'Continue On Fail' is enabled, the output JSON will contain error details for the corresponding input.

Examples

Example 1: Request payment of 1000 RWF from customer with phone number 250788123456

Set Phone Number to 250788123456, Amount to 1000, Currency to RWF, optionally specify External ID and messages.

Links

Discussion