Mobile money
Follow these steps to accept payment using our mobile money API:
Initiate the Payment
Validate the OTP (optional)
Check Status
Coverage
The gateway parameter should be set to anyone of the following currencies.
Country | Country Code | Currency | Network |
---|---|---|---|
Democratic Republic of the Congo | COD | CDF | vodacom, airtel, orange |
Kenya | KEN | KES | mpesa |
Uganda | UGA | UGX | airtel, mtn |
Senegal | SEN | XOF | free, orange |
Ivory Coast (Côte d'Ivoire) | CIV | XOF | mtn, orange |
Cameroon | CMR | XAF | mtn, orange |
Rwanda | RWA | RWF | airtel, mtn |
Zambia | ZMB | ZMW | airtel, mtn, zamtel |
Malawi | MWI | MWK | airtel, tnm |
Benin | BEN | XOF | mtn, moov |
Sierra Leone | SLE | SLE | orange |
Tanzania | TZA | TZS | airtel, vodacom, tigo, halotel |
Initiate the Payment
POST
{{env_url}}/pay/aggregators/{{gateway}}/mobilemoney/v3
You would need to pass, as header the x-auth-token
. This can be obtained from your merchant dashboard → Settings → Generate API keys → Merchant public key.
Headers
Name | Value |
---|---|
Content-Type |
|
x-auth-token | Your merchant public key |
Request Body (encrypted)
Request Body (plain)
Response
Validate OTP
POST
{{env_url}}/pay/aggregators/{{gateway}}/mobilemoney/v3
The customer will need to enter the OTP sent to their provided phone number when the payment is initiated and the message in the response shows "Please enter otp".
You would need to pass, as header the x-auth-token
. This can be obtained from your merchant dashboard → Settings → Generate API keys → Merchant public key.
Headers
Name | Value |
---|---|
Content-Type |
|
x-auth-token | Your merchant public key |
Request Body (encrypted)
Request Body (plain)
Response
Check Status
Click the "Transaction status" link below to check the status of the transaction by passing your tnx_ref as request body.
Last updated