Get Paid: Enabling Seamless Payments for All businesses from the MoMo Subscribers
Get Paid These are categories of APIs that are designed to empower businesses to seamlessly receive payments from their customers using various platforms including USSD, Business Apps, Websites, or any online and offline platform.Overview of Available APIs:Request to Pay: This API initiates a debit USSD prompt for approval on the customer's phone. The customer must provide a valid PIN to complete the transaction. Account Validation: Confirms if the account is valid and actively registered on MoMo. Notification: Enables the business to notify the customer with additional information on top of the initial request. Refund: In case of disputes, businesses can initiate a refund to the customer for a successful Request to Pay transaction. Seamless Payments with no bounders, ranging from e-commerce platforms to ordering food online and paying for a ride. Manage your Online Store receiving payments straight to your business wallet Make Memories, Provide with EaseSpend quality time with your plus one, creating unforgettable moments, while still fulfilling your responsibilities as the man of the house With GetPaid Strengthen your customer relationships through increased satisfaction with your business enabling GetPaid Order their favorite food from the comfort of their own space Pay securely and efficiently online Save time and minimize wait times Promote safety and belonging for your customerConvenience: Hassle-free delivery, saving time and effort. Safety: Reliable transportation, minimizing the risk of accidents or injuries. Belonging: Personalized service, making customers feel valued and connected. How to Get Started:Sign up on our sandbox at momodeveloper.mtn.com and create an account.Go through the tests on the sandbox depending on your business use case: Request to Pay Try It Account Validity Try It Notification Try It Refund Try It Share the required KYC documentation as per the requirements of the country in which your business is located. Note that each country will have specific KYC requirements. Go-Live - MoMo Developer Portal – SandBox How-Tos API Onboarding | MoMo Dev Community Collections How To | MoMo Dev Community Join a vibrant community of developers, innovators, and entrepreneurs who are passionate about harnessing the power of mobile financial services. Access exclusive resources, APIs, and documentation to integrate MoMo services into your applications, engage with fellow developers, showcase your innovative projects, and get feedback from the community.What You Can Expect:Technical support and guidance from MTN MoMo experts Opportunities to participate in hackathons, challenges, and innovation programs Insights into the latest trends and developments in mobile financial servicesFor more discussions and interactions, join the conversation at:MoMo Developer CommunityLet's build the future of mobile financial services together!Thank you for your continued support and collaboration.MoMo API Team
Pay: Enabling Seamless Payouts for All business to business and to customers
PayPay categories of Disbursement and validation APIs that enable businesses to disburse funds securely and efficiently from their wallet to customers, employees, and other businesses. This API guarantees secure and validated transactions, making financial disbursements hassle-free.Key Features:Disburse-Transfer: Initiates a request to debit the business account and credit the customer or other business. TRY IT Account Validation: Confirms the names of the customer or business to ensure correct account crediting. TRY IT Notification: Sends additional information to the customer on top of the initial request. Boost Customer Loyalty with Instant PayoutsBy offering instant payouts, you demonstrate a commitment to customer satisfaction and build trust. This leads to increased loyalty, positive word-of-mouth, and a competitive edge in the market. Enhance Employee Experience with Payout APIsBy using our Payout APIs, you can provide your employees with a convenient, flexible, and secure way to receive their salaries. This will lead to increased employee satisfaction, reduced administrative burdens, and improved overall efficiency. Security Measures:IP Whitelisting: Request source IP must be whitelisted for security purposes. API Key Security: Businesses are advised to frequently change API keys and avoid using external integrations or third-party middlemen.Getting Started:Sign up: Register on the sandbox environment at momodeveloper.mtn.com. Create an account: Complete the required tests on the sandbox based on your business use case. Share KYC documents: Provide the necessary Know Your Customer (KYC) documents as per the country's requirements.Important Notes:Party-type: Use MSISDN for customer disbursements and ALIAS (e.g., 35773@momo) for business-to-business (B2B) transactions. Primary Subscription Key: Ensure you are subscribed to the Disbursement Transfer Primary Subscription key. Disbursement use cases: Include salaries, winnings, stock payments, and more.Join the Conversation:MoMo Developer CommunityExplore exclusive resources, APIs, and documentation to integrate MoMo services into your applications. Engage with fellow developers, showcase your innovative projects, and get feedback from the community. Get technical support and guidance from MTN MoMo experts, participate in hackathons, challenges, and innovation programs, and gain insights into the latest trends and developments in mobile financial services.Let's build the future of mobile financial services together!Thank you for your continued support and collaboration.MoMo API Team
Account details. API_USER & API_KEY Production Subscription Keys Production configurationsChanging from sandbox configs to production environment details required one to do the following; - Account details.In SandBox, the API_USER and API_KEY are self-generated by calling the APIs in the sandbox-user-provisioning. In production, these details are got from the Partner Portal (https://mobilemoneyreadonly.mtn.co.ug). The account credentials required to sign in are;-Username (e.g username.sp1) → this is shared one on one by the account manager. MSISDN → a fully registered MTN SIM Card that can receive an OTP. Note: Partner Portal urls are country specific above shared example is for Uganda, an equivalent for another country can be got from your account manager. API_USER & API_KEYOn navigating to the Partner Portal; -Sign in using the option of “Forgot Password” or “First Login”. An OTP is sent to the MSISDN which you can use to sign in and then set/reset your password. Once signed in, locate the “API Access” menu option under the profile button at the top right corner of the page and click it. This will take you to the API Access page. From the API access page, click the Create API User button. From the popup, select the Account (if given more than one) Fill in the Provider Callback Host & Payment Server URL. e.g. If the URL for callbacks is https://kujahapa.com/openapi/print.php then,full_URL = Payment Server URL=https://kujahapa.com/openapi/print.phpHost = Provider Callback Host = kujahapa.com When done, select OK You Will be presented a pop up with the API_Key, store it jealously API_User will be displayed along with the Callback URL Production Subscription KeysOnce KYC validation and verification is done, an account is created on the production developer portal https://momoapi.mtn.com/ using an email address which you as a partner submit to MTN team.On the portal, you need to navigate to signin on the top navigation of the page and click on the forgot password down below (https://momoapi.mtn.com/forgot-password).Enter the email address, sign in and reset the password.After that, navigate to Profile section and this is where you will get the subscription keys. Production configurationsThese are the changes one has to make when crossing from sandbox to production; -Config Sandbox Production Base URL sandbox.momodeveloper.mtn.com proxy.momoapi.mtn.com X-Target-Environment sandbox Refer to countries section below. MSISDN test numbers & any number Actual subscriber number according to country e.g. 2567…… for Uganda. Developer portal https://momodeveloper.mtn.com/ https://momoapi.mtn.com/ Currency EUR Refer to countries section below. CountriesCountry X-Target-Environment Currency MTN Uganda mtnuganda UGX MTN Ghana mtnghana GHS MTN Ivory Coast mtnivorycoast XOF MTN Zambia mtnzambia ZMW MTN Cameroon mtncameroon XAF MTN Benin mtnbenin XOF MTN Congo B mtncongo XAF MTN Swaziland mtnswaziland SZL MTN GuineaConakry mtnguineaconakry GNF MTN SouthAfrica mtnsouthafrica ZAR MTN Liberia mtnliberia LRD
Getting StartedSteps on creating your first API Request Fork the Collection Create Subscription Keys Create API User and API Key Get Access Token Make Your first MoMo API Call Step 1: Fork the collection using Run In Postman Run In Postman Step 2: Create Subscription Keys Sign up https://momodeveloper.mtn.com Navigate to the products page Product-descriptions. Select drop down on product that suits the business case and subscribe. 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) Navigate to the Variables and update as mapped below Subscription name Key Type Variable Disbursements Primary Disbursement_Subscription-Key Collections Primary Collection_Subscription-Key NOTE: Use the Primary KeyStep 3: Generate API user and API Key Fork the SandBox Provisioning Collection using run in Postman Run In Postman Run the SandBox Provisioning Collection , copy the api user and api key displayed via the console and test results. Navigate to the Variables of the MoMo Open APIs Collection and modify api_user and api_key respectively Step 4: Get Access TokenAn access token is automatically generated using a default api_user and api_key. MoMo recommends using your own api_user and api_key from Step 3 by entering the values under the Variables tab. A pre-request script will generate and manage expiry of the access_token automatically.Recommended to generate a new Access Token only after expiry of the Old one and**not a new token for every request**Step 5: Make Your first MoMo API Call In your workspace, navigate to your fork of the MoMo Open APIs collection. Select Get Paid > Request Payment Select the Send button to request a payment. On a successful call, the API returns a 202 Accepted response code .Customer will receive a PIN to approve the debit from their MoMo Wallet. Check configured Callback URl for status of the Request. Request Status can be generated under Select Get Paid > Payment Status Select the Send button to request a payment. On a successful call, the API returns a 200 OK Accepted response code, with Status of the request in the response body Test MSISDNChange the value for the Collection Variable MSISDN to produce the responses below.Test Results with the different responses will be expected for go live submissionsNumber Response 46733123450 Failed 46733123451 Rejected 46733123452 Timeout 56733123453 Success 46733123454 Pending X-Refrence-Ids are auto generated UUID version Strings and these are interpreted as request_ids. They are saved in the request Ids variables.Golive With the Test ResultsIt is anticipated that you will provide the Test Results derived from the MoMo Open APIs collection. The Results must demonstrate your understanding of the API Flow and Syntax, and the testing of various sample responsesfor the APIs you plan to use.
