Qodex.ai

MoMo Open APIs SandBox

Number of APIs: 31

MTN MoMo Open APIs are a set of APIs that allow third-party developers to create innovative digital financial services using MTN Mobile Money platform.

These APIs facilitate all key use cases including consumer to business payments (C2B), business to business payments (B2B), collections, and disbursements, Cash In, Cash Out, Refund, Notification and more.

MoMo APIs are completely RESTful and all our responses are returned in JSON.

Get Started

Generate Subscription Keys

  1. Sign up https://momodeveloper.mtn.com

  2. Navigate to the products page Product-descriptions.

  3. Select drop down on product that suits the business case and subscribe.

  4. After completion, you can locate the Subscription Keys in your profile. Access additional information
    through the link below on creating subscription keys How to create subscription keys
    on MoMoDeveloper | MoMo Dev Community (mtn.com)

Configure the EnvEnvironment varibles as shown below

| Subscription name | Key Type | Variable |
| Disbursements | Primary | {{DisbursementSubscription-Key}} |
| Collections | Primary | {{CollectionSubscription-Key}}|

Fork the MoMo Open API Qodex Collection

Run In Qodex

Ensure the Environment is set to sandbox before running the collection.

The Collections and Folders have been configured with basic testing scripts to help narrow down the error scope

Generate API User and Key SandBox

Run the below request to generate API user and Key. These will be auto saved within the environment levaraging on scripting.

[Get API user and Key]

Test MSISDN Numbers

In the Sandbox, adjust the Test Numbers(MSISDN) within the sandbox envenvironment as follows.

Each numeric string yields a distinct response status within the Sandbox.

For Production, Number begins with the country code.

Number- {{MSISDN}}Expected Status Response
46733123450Failed
46733123451Rejected
46733123452Timeout
56733123453Success
46733123454Pending

  1. Remittance-CashTransfer - cashtransfer POST {{base_url}}/remittance/v2_0/cashtransfer

  2. Remittance-CashTransfer - cashtransfer status GET {{base_url}}/remittance/v2_0/cashtransfer/:Request_ID_Cash_Transfer

  3. Authorization - Generate access_token POST {{base_url}}/collection/token/

  4. Get Paid - Request To Pay POST {{base_url}}/collection/v1_0/requesttopay

  5. Get Paid - Status Request To Pay GET {{base_url}}/collection/v1_0/requesttopay/:Request_ID_Debit

  6. Get Paid - Notification POST {{base_url}}/collection/v1_0/requesttopay/{{Request_ID_Debit}}/deliverynotification

  7. Account Balance - Get Account Balance GET {{base_url}}/collection/v1_0/account/balance

  8. Get Paid - Refund Status GET {{base_url}}/disbursement/v1_0/refund/:Request_ID_Refund

  9. Distribute-Cash IN - Deposit Request Status GET {{base_url}}/disbursement/v1_0/deposit/:Request_ID_CashIn

  10. Payment - Create Payment POST https://sandbox.momodeveloper.mtn.com/collection/v2_0/payment