RESOURCE_ALREADY_EXIST HTTP 409
Duplicated Reference ID.
Every request must have a unique reference ID; using an ID of the previous request will result in this error response
Action-Check X-Reference ID used is unique and is in UUID V4 format
ACCESS DENIED DUE TO INVALID SUBSCRIPTION KEY 401
Authentication failed.
Credentials invalid.
Header Ocp-APIM-Subscription-Key value is incorrect.
Action -
| Check the User Profile Section to verify the related product subscription key is used.
Collection, Disbursement and Remittance have different subscription keys.
If the primary key doesn’t work, try the secondary key. Contact MTN support if both provided keys aren't working.
Sandbox subscription key are located in https://momodeveloper.mtn.com/developer Production subscription key are located in https://momoapi.mtn.com/developer |
RESOURCE NOT FOUND 404
| Reference ID not found. Requested resource does not exist.
Predominantly occurs with Get Status API and implies that the requested reference ID does not exist. This results in the Request to Debit or Transfer transaction being unsuccessful. Action - Check if the original request to pay or the transfer (disbursement) operation was successful with response code 202. |
REQUEST REJECTED/ BAD REQUEST 400
| Bad request. Request does not follow the specification. Action This relates to any of the below scenarios: Incorrect/wrong values in the headers, and/or the X-ref ID does not meet UUID Version 4.
Inputting a Body in an API that is not supported e.g. /Token API
Having unsupported special characters in the Body request for example an apostrophe (').
Invalid currency – needs to match the target environment currency.
More than 160 characters in the note and message; explore utilizing the notification API for increased number of characters.
The URL posted to needs to reviewed e.g. incorrect number of forward slashes (///). |
FORBIDDEN IP 403
| Authorization failed. IP not authorized to utilize Disbursement API. Action Share your originating Public IP from which the APIs are called with your MTN Account Manager |
NOT_ALLOWED 500
Authorization failed. User does not have permission.
The account authenticated with the Request via Token is restricted
Action - Contact your MTN Account Manager
NOT_ALLOWED_TARGET_ENVIRONMENT 500
| Value passed in header X-Target-Environment is incorrect Action - Use the correct X-targetenvironment corresponding to below country:
MTN Uganda= mtnuganda
MTN Ghana= mtnghana
MTN Ivory Coast= mtnivorycoast
MTN Zambia= mtnzambia
MTN Cameroon= mtncameroon
MTN Benin= mtnbenin
MTN Congo= mtncongo
MTN Swaziland= mtnswaziland
MTN GuineaConakry= mtnguineaconakry
MTN SouthAfrica= mtnsouthafrica
MTN Liberia= mtnliberia
For Test Environment = sandbox
|
INVALID_CALLBACK_URL_HOST 500
| Callback URL with different host name to configured for API User.
Check the Host of the Call Back URL in the request header; this needs to match what was configured on the partner portal when creating the API user and Key. Action -Host needs to be configured using Hostname and not IP address. |
INVALID_CURRENCY 500
Currency not supported on the requested account
Action - Use Currency Code specific to the Country.
INTERNAL_PROCESSING_ERROR 500
| Default or Generic error code used when there is no specific error mapping. This predominantly occurs due to insufficient customer funds to complete the transaction. Also related to service denied or Wallet Platform is not reachable Action : Advice customer to ensure they have sufficient funds to complete the transaction. Also request the customer to retry the transaction. If the problem still occurs with sufficient customer funds, please contact your MTN Account Manager for further investigation |
SERVICE_UNAVAILABLE 503
Service temporary unavailable - please try again
Action - Enquire with MTN Support.
PAYEE_NOT_FOUND The MSISDN being paid to is invalid. Action - MSISDN format must include country code.
MSISDN is not registered for Mobile Money Service. |
PAYER_NOT_FOUND MSISDN of the number from whom the money was requested in invalid Action- MSISDN format must include country code.
MSISDN is not registered for Mobile Money Service. |
| This can be attributed to transaction timeout. This predominantly occurs with a delay to approve a transaction within the given time frame (5 minutes). Action- Advise customer to try again and approve transaction within 5 minutes. |
| |
