Callback

Setting up a callback URL

• Transfer and RequestToPay APIs are Asynchronous in MTN MoMo API Platform

• When a merchant system sends a POST of either /transfer, or /requesttopay APIs, the Gateway validates the request and then responds with '202 Accepted'

• The transaction is then queued for processing.

• Once processed, a callback with the final result of the transaction is sent to the merchant system

• In order to receive the callback for your transactions, please consider the following:

a) On Sandbox

• Register your callback host by specifying the domain as providerCallbackHost when creating your API Keys. On production this will be done via the Account Portal

• Specify the callback URL in each of your /requesttopay or /tranfer POST

• Use http and not https on sandbox

• Allow PUT & POST on your callback listener host

a) On Production

• After Go-live you will be provided a link to log on to your Accounts Portal

• You will be required to register you callback host on the portal when creating your API keys as shown below

• Only https is allowed on production

• Allow PUT & POST on your callback listener host

  

• Please note that the Wallet Platform sends the callback only once. There is no retry mechanism if the partner system does not respond. To ensure reliability, we strongly recommend that partner systems implement a fallback mechanism by polling the transaction status using the appropriate GET method.

Let's take the Deposit API (Deposit-V1) under the Disbursement product set as an example:

1. The transaction request is sent as described in the documentation: https://momodeveloper.mtn.com/API-collections#api=disbursement&operation=Deposit-V1

2. To receive a callback, you must include your callback URL in the X-Callback-Url header.
This URL must be hosted on the same domain specified when creating the API user.

3. The callback will be a POST request, and the payload will be similar to the response returned by the status check API for the same operation.

NOTE: By implementing status polling, you can ensure transaction completion even in cases where the callback is missed.

Approved Intermediate CA's for Open API

For Open API callbacks to function, the 3PP Intermediate certificate chains must be imported on the OpenAPI Partner Gateway tls_keystore and callback URLs are required to use https L7 protocol:

• CN - Refers to the Common name of the immediate intermediate CA Chain

• Alias - Refers to the name that is used while storing the Certificate in PG's tls_keystore

Below is the list of Approved Intermediate CA's that's already available to use:

NOTE: Incase any Partner's callback URL is not part of the Approved Intermediate CA's, callbacks might not work for the said Partners.

---

← Common Error Codes Brand Guidelines →