aid: mtn-group url: https://raw.githubusercontent.com/api-evangelist/mtn-group/refs/heads/main/apis.yml name: MTN Group kind: company description: 'MTN Group is Africa''s largest mobile network operator, headquartered in Johannesburg, South Africa, serving roughly 290 million subscribers across around 16 markets in Africa. Beyond mobile voice, data and enterprise connectivity it runs MoMo, one of the continent''s largest mobile-money platforms. Unusually for a carrier, MTN publishes a genuinely open developer surface: the MTN Developer Platform (MADAPI) at developers.mtn.com lists 221 API products across 15 African markets and lets anyone download the OpenAPI/Swagger definition for a product without an account, and momodeveloper.mtn.com is a self-serve Azure API Management portal with a sandbox for the MoMo Collection, Disbursements and Remittance APIs. Its catalogue is heavily TM Forum Open API shaped (TMF620, TMF621, TMF622, TMF629, TMF632, TMF633, TMF635, TMF637, TMF639, TMF652, TMF654, TMF658, TMF666, TMF667, TMF676, TMF677, TMF678, TMF681, TMF683, TMF685, TMF688, TMF720). MTN South Africa is a GSMA Open Gateway participant — it announced Number Verification and SIM Swap with Cell C and Telkom in February 2024 — but nothing in its published catalogue is CAMARA-shaped: its SIM Swap and Device Swap APIs are MTN-proprietary designs secured with OAuth2 client-credentials rather than the CAMARA OIDC/CIBA profile, and no CAMARA API is callable from either portal. MTN is not an Aduna shareholder. Sandbox access is self-serve; production access is vetted and commercially negotiated.' image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg tags: - Telecommunications - South Africa - Africa - Mobile Network Operator - Network APIs - Open Gateway - TM Forum - BSS - Mobile Money - Messaging - SMS - USSD - IoT - SIM Swap - Identity Verification - Payments created: '2026-07-25' modified: '2026-07-25' specificationVersion: '0.19' apis: - aid: mtn-group:account-decisioning name: MTN Account Decisioning description: 'API to consume and process account management actions to perform account status changes to customers with a MoMo Advance account. ChangeLog: 03-March-23 - First version.' humanURL: https://developers.mtn.com/products/account-decisioning baseURL: https://api.mtn.com/accountDecisioning/v1 tags: - Customer - Uganda - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/account-decisioning - type: APIReference url: https://developers.mtn.com/products/account-decisioning - type: OpenAPI url: openapi/mtn-group-account-decisioning.yml - type: Overlay url: overlays/mtn-group-account-decisioning-overlay.yaml - aid: mtn-group:tmf-customer-bill-management name: MTN TMF Customer Bill Management - TMF678 description: 'TMF API Reference: TMF 678 - Customer bill Management Release: 19.5 - December 2019 The Customer Bill Management API allows to find and retrieve one or several customer bills (also called invoices) produced for a customer. A customer bill is an electronic or paper document produced at the end of the billing process. The customer...' humanURL: https://developers.mtn.com/products/tmf-customer-bill-management tags: - TM Forum - TMF678 - Benin - South Sudan - Eswatini properties: - type: Documentation url: https://developers.mtn.com/products/tmf-customer-bill-management - type: APIReference url: https://developers.mtn.com/products/tmf-customer-bill-management - type: OpenAPI url: openapi/mtn-group-tmf-customer-bill-management.yml - type: Overlay url: overlays/mtn-group-tmf-customer-bill-management-overlay.yaml baseURL: https://api.mtn.com/tmf-api/customerBillManagement/v4 - aid: mtn-group:mtn-customer-loans-api-v1 name: MTN Loans description: Api Documentation. humanURL: https://developers.mtn.com/products/mtn-customer-loans-api-v1 baseURL: https://loan-channelvas-system-mtnapitest.e4ff.pro-eu-west-1.openshiftapps.com/ tags: - Customer - Nigeria properties: - type: Documentation url: https://developers.mtn.com/products/mtn-customer-loans-api-v1 - type: APIReference url: https://developers.mtn.com/products/mtn-customer-loans-api-v1 - type: OpenAPI url: openapi/mtn-group-mtn-customer-loans-api-v1.yml - type: Overlay url: overlays/mtn-group-mtn-customer-loans-api-v1-overlay.yaml - aid: mtn-group:subscriber-details name: MTN Subscriber Details description: Api Documentation. humanURL: https://developers.mtn.com/products/subscriber-details baseURL: https://za.api.mtn.com/subscriberdetails tags: - Customer - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/subscriber-details - type: APIReference url: https://developers.mtn.com/products/subscriber-details - type: OpenAPI url: openapi/mtn-group-subscriber-details.yml - type: Overlay url: overlays/mtn-group-subscriber-details-overlay.yaml - aid: mtn-group:subscriber-type name: MTN Subscriber Type description: Api Documentation. humanURL: https://developers.mtn.com/products/subscriber-type baseURL: https://za.api.mtn.com/customermanagement tags: - Customer - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/subscriber-type - type: APIReference url: https://developers.mtn.com/products/subscriber-type - type: OpenAPI url: openapi/mtn-group-subscriber-type.yml - type: Overlay url: overlays/mtn-group-subscriber-type-overlay.yaml - aid: mtn-group:provisioning name: MTN Provisioning description: Api Documentation. humanURL: https://developers.mtn.com/products/provisioning baseURL: https://za.api.mtn.com/VasServices tags: - Customer - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/provisioning - type: APIReference url: https://developers.mtn.com/products/provisioning - type: OpenAPI url: openapi/mtn-group-provisioning.yml - type: Overlay url: overlays/mtn-group-provisioning-overlay.yaml - aid: mtn-group:unified-balance-v1 name: MTN Unified Balance V1 description: Api Documentation. humanURL: https://developers.mtn.com/products/unified-balance-v1 baseURL: https://za.api.mtn.com/v1 tags: - Customer - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/unified-balance-v1 - type: APIReference url: https://developers.mtn.com/products/unified-balance-v1 - type: OpenAPI url: openapi/mtn-group-unified-balance-v1.yml - type: Overlay url: overlays/mtn-group-unified-balance-v1-overlay.yaml - aid: mtn-group:tmf-resourceinventorymanagement-tmf639 name: MTN TMF Resource Inventory Management - TMF639 description: 'TMF API Reference: TMF639 - Resource Inventory Release : 19.5 - December 2019 Resource Inventory API goal is to provide the ability to manage Resources. Operations Resource Inventory API performs the following operations on the resources : - Retrieve an entity or a collection of entities depending on filter criteria - Partial...' humanURL: https://developers.mtn.com/products/tmf-resourceinventorymanagement-tmf639 tags: - TM Forum - TMF639 - Benin - Côte d'Ivoire - South Sudan - Eswatini properties: - type: Documentation url: https://developers.mtn.com/products/tmf-resourceinventorymanagement-tmf639 - type: APIReference url: https://developers.mtn.com/products/tmf-resourceinventorymanagement-tmf639 - type: OpenAPI url: openapi/mtn-group-tmf-resourceinventorymanagement-tmf639.yml - type: Overlay url: overlays/mtn-group-tmf-resourceinventorymanagement-tmf639-overlay.yaml baseURL: https://api.mtn.com/tmf-api/resourceInventoryManagement/v4 - aid: mtn-group:sales-management name: MTN Sales Lead description: 'TMF API Reference : TMF 699 - Sales This API provides interfaces for Sales Lead, Sales Opportunity, Sales Quote and the other management capabilities to support the sales activities to build relationship with the prospect customer who could be a person or organization that has an interest in the goods and/or services and possibly...' humanURL: https://developers.mtn.com/products/sales-management baseURL: https://za.api.mtn.com/sales/v1/ tags: - Customer - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/sales-management - type: APIReference url: https://developers.mtn.com/products/sales-management - type: OpenAPI url: openapi/mtn-group-sales-management.yml - type: Overlay url: overlays/mtn-group-sales-management-overlay.yaml - aid: mtn-group:service-activation-and-configuration name: MTN Service Activation and Configuration description: 'TMF API Reference: TMF640 - Service Activation and Configuration Version 4.0 Service Activation and Configuration API goal is to provide the ability to activate and configure Service. This API features Monitor pattern allowing to manage service configuration/activation asynchronous request (server side will provide monitor as...' humanURL: https://developers.mtn.com/products/service-activation-and-configuration baseURL: https://api.mtn.com/v1 tags: - Customer - Nigeria - Uganda - South Africa - Zambia properties: - type: Documentation url: https://developers.mtn.com/products/service-activation-and-configuration - type: APIReference url: https://developers.mtn.com/products/service-activation-and-configuration - type: OpenAPI url: openapi/mtn-group-service-activation-and-configuration.yml - type: Overlay url: overlays/mtn-group-service-activation-and-configuration-overlay.yaml - aid: mtn-group:service-ordering name: MTN Service Ordering description: 'TMF API Reference : TMF 641 - Service Ordering Management Version 4.1 TMF641 performs the following operations on service order resource : - Retrieval of a service order or a collection of service orders by id - Creation of a service order - Deletion of service order Copyright © TM Forum 2020. All Rights Reserved.' humanURL: https://developers.mtn.com/products/service-ordering tags: - Customer - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/service-ordering - type: APIReference url: https://developers.mtn.com/products/service-ordering - type: OpenAPI url: openapi/mtn-group-service-ordering.yml - type: Overlay url: overlays/mtn-group-service-ordering-overlay.yaml baseURL: https://api.mtn.com/tmf-api/serviceOrdering/v4 - aid: mtn-group:bss-tt-oauth-v1 name: MTN BSS TT OAuth V1 description: Authentication API. humanURL: https://developers.mtn.com/products/bss-tt-oauth-v1 baseURL: https://api.mtn.com/v1/bss-oauth tags: - TM Forum - Eswatini - Zambia properties: - type: Documentation url: https://developers.mtn.com/products/bss-tt-oauth-v1 - type: APIReference url: https://developers.mtn.com/products/bss-tt-oauth-v1 - type: OpenAPI url: openapi/mtn-group-bss-tt-oauth-v1.yml - type: Overlay url: overlays/mtn-group-bss-tt-oauth-v1-overlay.yaml - aid: mtn-group:balance-management-v1 name: MTN Balance Management V1 description: The Balance Management API facilitates the management of Customer Account capabilitites. It provides a generic API any client or back-end can call to request a Topup function that allows a reseller to refill/credit a subscriber airtime account from the reseller’s account. humanURL: https://developers.mtn.com/products/balance-management-v1 baseURL: https://api.mtn.com/v1 tags: - Customer - Côte d'Ivoire - Liberia - Zambia - Nigeria properties: - type: Documentation url: https://developers.mtn.com/products/balance-management-v1 - type: APIReference url: https://developers.mtn.com/products/balance-management-v1 - type: OpenAPI url: openapi/mtn-group-balance-management-v1.yml - type: Overlay url: overlays/mtn-group-balance-management-v1-overlay.yaml - aid: mtn-group:callmeback-v1 name: MTN Callmeback V1 description: callmeback API will be used to post a request in AYO, when initiated by Users via different Applications like "portal", "IVR" etc. humanURL: https://developers.mtn.com/products/callmeback-v1 baseURL: https://za.api.mtn.com tags: - Customer - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/callmeback-v1 - type: APIReference url: https://developers.mtn.com/products/callmeback-v1 - type: OpenAPI url: openapi/mtn-group-callmeback-v1.yml - type: Overlay url: overlays/mtn-group-callmeback-v1-overlay.yaml - aid: mtn-group:callmeback-v2 name: MTN Callmeback V2 description: callmeback API will be used to post a request to Backend systems when initiated by Users via different Applications like "portal", "IVR" etc. humanURL: https://developers.mtn.com/products/callmeback-v2 baseURL: https://za.api.mtn.com/v2 tags: - Customer - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/callmeback-v2 - type: APIReference url: https://developers.mtn.com/products/callmeback-v2 - type: OpenAPI url: openapi/mtn-group-callmeback-v2.yml - type: Overlay url: overlays/mtn-group-callmeback-v2-overlay.yaml - aid: mtn-group:rcs-communication name: MTN RCS Communication description: This API Provides a capability to create and send communications, notifications, and instructions to Parties, Individuals, Organizations or Users. humanURL: https://developers.mtn.com/products/rcs-communication baseURL: https://api.mtn.com/v1 tags: - Customer - Nigeria properties: - type: Documentation url: https://developers.mtn.com/products/rcs-communication - type: APIReference url: https://developers.mtn.com/products/rcs-communication - type: OpenAPI url: openapi/mtn-group-rcs-communication.yml - type: Overlay url: overlays/mtn-group-rcs-communication-overlay.yaml - aid: mtn-group:communication-management-v1 name: MTN Communication Management V1 description: This is Swagger UI environment generated for the TMF Communication Management specification. humanURL: https://developers.mtn.com/products/communication-management-v1 baseURL: https://api.mtn.com/v1 tags: - Customer - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/communication-management-v1 - type: APIReference url: https://developers.mtn.com/products/communication-management-v1 - type: OpenAPI url: openapi/mtn-group-communication-management-v1.yml - type: Overlay url: overlays/mtn-group-communication-management-v1-overlay.yaml - aid: mtn-group:tmf681-communication-management name: MTN TMF681 Communication Management description: This is Swagger UI environment generated for the TMF Communication Management specification. humanURL: https://developers.mtn.com/products/tmf681-communication-management tags: - Customer - TMF681 - TM Forum - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/tmf681-communication-management - type: APIReference url: https://developers.mtn.com/products/tmf681-communication-management - type: OpenAPI url: openapi/mtn-group-tmf681-communication-management.yml - type: Overlay url: overlays/mtn-group-tmf681-communication-management-overlay.yaml baseURL: https://api.mtn.com/tmf-api/communicationManagement/v4 - aid: mtn-group:ayo-preapproval name: MTN Consent Validation V1 description: A suite of apis for customer consent validation. humanURL: https://developers.mtn.com/products/ayo-preapproval baseURL: https://api.mtn.com/v1 tags: - Customer - Benin - Congo - Côte d'Ivoire - Cameroon properties: - type: Documentation url: https://developers.mtn.com/products/ayo-preapproval - type: APIReference url: https://developers.mtn.com/products/ayo-preapproval - type: OpenAPI url: openapi/mtn-group-ayo-preapproval.yml - type: Overlay url: overlays/mtn-group-ayo-preapproval-overlay.yaml - aid: mtn-group:content-push name: MTN Content Push description: The API provides a target system with data content to be pushed via a channel to a customer. Supported Actions 1. SendSms. **Supported OpCo's:** MTN Uganda, MTN Ghana, MTN SA. humanURL: https://developers.mtn.com/products/content-push baseURL: https://api.mtn.com/v1 tags: - Customer - Ghana - Côte d'Ivoire - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/content-push - type: APIReference url: https://developers.mtn.com/products/content-push - type: OpenAPI url: openapi/mtn-group-content-push.yml - type: Overlay url: overlays/mtn-group-content-push-overlay.yaml - aid: mtn-group:mtn-customer-bill-management name: MTN Customer Bill Management description: To facilitate the capability for consumers to retrieve bill information at service level , account level or invoice level etc. humanURL: https://developers.mtn.com/products/mtn-customer-bill-management baseURL: https://api.mtn.com/v1 tags: - Customer - Ghana - Nigeria - Rwanda - Eswatini properties: - type: Documentation url: https://developers.mtn.com/products/mtn-customer-bill-management - type: APIReference url: https://developers.mtn.com/products/mtn-customer-bill-management - type: OpenAPI url: openapi/mtn-group-mtn-customer-bill-management.yml - type: Overlay url: overlays/mtn-group-mtn-customer-bill-management-overlay.yaml - aid: mtn-group:customer-billing-token-v1 name: MTN Customer Billing Token V1 description: To register services and activate services content tokens. humanURL: https://developers.mtn.com/products/customer-billing-token-v1 baseURL: https://api.mtn.com/v1/customer tags: - Customer - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/customer-billing-token-v1 - type: APIReference url: https://developers.mtn.com/products/customer-billing-token-v1 - type: OpenAPI url: openapi/mtn-group-customer-billing-token-v1.yml - type: Overlay url: overlays/mtn-group-customer-billing-token-v1-overlay.yaml - aid: mtn-group:mtn-nigeria-data-gifting-v1 name: MTN Data Gifting description: The Data Gifting API facilitates purchase of data product for Beneficiary subscriber(Customer) and charging shall be done from Charging system using Requesting subscriber(Sponsor) msisdn and SMS will be sent to both subscriber’s. humanURL: https://developers.mtn.com/products/mtn-nigeria-data-gifting-v1 baseURL: https://api.mtn.com/v1/datagifting tags: - Customer - Nigeria properties: - type: Documentation url: https://developers.mtn.com/products/mtn-nigeria-data-gifting-v1 - type: APIReference url: https://developers.mtn.com/products/mtn-nigeria-data-gifting-v1 - type: OpenAPI url: openapi/mtn-group-mtn-nigeria-data-gifting-v1.yml - type: Overlay url: overlays/mtn-group-mtn-nigeria-data-gifting-v1-overlay.yaml - aid: mtn-group:mtn-nigeria-customer-datashare name: MTN Customer Datashare description: 'The Data Share API facilitates data share between Data Share Agent(Data Sender) and Customer(Data Receiver) also provides a data analytics. It also provides functionality to manage provider and consumer msisdns that are linked as part of the Internet Share Bundles Product **26-August-21: ChangeID: 0000000327** - Added a new GET endpoint...' humanURL: https://developers.mtn.com/products/mtn-nigeria-customer-datashare baseURL: https://api.mtn.com/v1/datashare tags: - Customer - Congo - Nigeria - Cameroon properties: - type: Documentation url: https://developers.mtn.com/products/mtn-nigeria-customer-datashare - type: APIReference url: https://developers.mtn.com/products/mtn-nigeria-customer-datashare - type: OpenAPI url: openapi/mtn-group-mtn-nigeria-customer-datashare.yml - type: Overlay url: overlays/mtn-group-mtn-nigeria-customer-datashare-overlay.yaml - aid: mtn-group:customer-delivery-booking name: MTN Customer Delivery Booking description: To retrieve and schedule delivery information for MTN Customers. humanURL: https://developers.mtn.com/products/customer-delivery-booking baseURL: https://api.mtn.com/v1 tags: - Customer - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/customer-delivery-booking - type: APIReference url: https://developers.mtn.com/products/customer-delivery-booking - type: OpenAPI url: openapi/mtn-group-customer-delivery-booking.yml - type: Overlay url: overlays/mtn-group-customer-delivery-booking-overlay.yaml - aid: mtn-group:customer-identification-v1 name: MTN Customer Identification V1 description: The Customer Identification API provides information about a customer and their historical usage events on voice, data, SMS, Roaming etc. Information can be retrieved by stating the date range for the period the API consumer is interested in. It will return date and time on which a specific event occurred on a customer's MSISDN as... humanURL: https://developers.mtn.com/products/customer-identification-v1 baseURL: https://api.mtn.com/v1/customerIdentification/ tags: - Customer - Congo properties: - type: Documentation url: https://developers.mtn.com/products/customer-identification-v1 - type: APIReference url: https://developers.mtn.com/products/customer-identification-v1 - type: OpenAPI url: openapi/mtn-group-customer-identification-v1.yml - type: Overlay url: overlays/mtn-group-customer-identification-v1-overlay.yaml - aid: mtn-group:kyc-consent name: MTN KYC Consent description: The Customer KYC Consent API facilitates the consent from the customer while capturing and retrieval of Customer Information. This aggregator service provides comprehensive Know Your Customer (KYC) consent management capabilities, enabling secure customer data capture, consent validation, and information retrieval operations across... humanURL: https://developers.mtn.com/products/kyc-consent baseURL: https://api.mtn.com/v1 tags: - Customer - Congo - Cameroon - Eswatini - Zambia properties: - type: Documentation url: https://developers.mtn.com/products/kyc-consent - type: APIReference url: https://developers.mtn.com/products/kyc-consent - type: OpenAPI url: openapi/mtn-group-kyc-consent.yml - type: Overlay url: overlays/mtn-group-kyc-consent-overlay.yaml - aid: mtn-group:customer-loyalty-management name: MTN Customer Loyalty Management description: 'An API to manage customer loyalty operations. Can also be used by 3rd-party partners (3PP) to get a customer''s loyalty products and rewards **04-Oct-21 ChangeID: 0000000000235** -Branched off from the original TMF document.' humanURL: https://developers.mtn.com/products/customer-loyalty-management baseURL: https://api.mtn.com/v1/loyaltyManagement tags: - Customer - Ghana - Nigeria - Uganda - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/customer-loyalty-management - type: APIReference url: https://developers.mtn.com/products/customer-loyalty-management - type: OpenAPI url: openapi/mtn-group-customer-loyalty-management.yml - type: Overlay url: overlays/mtn-group-customer-loyalty-management-overlay.yaml - aid: mtn-group:customer-management-coe-za-preprod name: MTN Customer Management - COE description: An API to Create customers,create admin users,activate/deactivate,disable Sims. humanURL: https://developers.mtn.com/products/customer-management-coe-za-preprod baseURL: https://coe.api.mtn.com/customerManagement/v1 tags: - Customer - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/customer-management-coe-za-preprod - type: APIReference url: https://developers.mtn.com/products/customer-management-coe-za-preprod - type: OpenAPI url: openapi/mtn-group-customer-management-coe-za-preprod.yml - type: Overlay url: overlays/mtn-group-customer-management-coe-za-preprod-overlay.yaml - aid: mtn-group:customer-pin-management-v2 name: MTN Customer Pin Management v2 description: To facilitate the capability for customer to create/validate/change Pin Information. humanURL: https://developers.mtn.com/products/customer-pin-management-v2 baseURL: https://api.mtn.com/customerPinManagement/v2 tags: - Customer - Cameroon - Liberia - Nigeria properties: - type: Documentation url: https://developers.mtn.com/products/customer-pin-management-v2 - type: APIReference url: https://developers.mtn.com/products/customer-pin-management-v2 - type: OpenAPI url: openapi/mtn-group-customer-pin-management-v2.yml - type: Overlay url: overlays/mtn-group-customer-pin-management-v2-overlay.yaml - aid: mtn-group:customer-promotion name: MTN Customer Promotion description: API Documentation. humanURL: https://developers.mtn.com/products/customer-promotion baseURL: https://za.api.mtn.com/customerPromotion/v1 tags: - Customer - Ghana - Nigeria - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/customer-promotion - type: APIReference url: https://developers.mtn.com/products/customer-promotion - type: OpenAPI url: openapi/mtn-group-customer-promotion.yml - type: Overlay url: overlays/mtn-group-customer-promotion-overlay.yaml - aid: mtn-group:customer-survey name: MTN Customer Survey description: The API facilitates product survey with a MTN Customer. humanURL: https://developers.mtn.com/products/customer-survey baseURL: https://api.mtn.com/v1/survey tags: - Customer - Nigeria - Eswatini - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/customer-survey - type: APIReference url: https://developers.mtn.com/products/customer-survey - type: OpenAPI url: openapi/mtn-group-customer-survey.yml - type: Overlay url: overlays/mtn-group-customer-survey-overlay.yaml - aid: mtn-group:customer-data-transfer-ng-prod name: MTN Customer Data Transfer(ng prod) description: API will enable MTN customers to transfer part of their active airtime or data to another MTN customer. This service excludes special data plans. humanURL: https://developers.mtn.com/products/customer-data-transfer-ng-prod baseURL: https://api.mtn.com/v1 tags: - Customer - Nigeria properties: - type: Documentation url: https://developers.mtn.com/products/customer-data-transfer-ng-prod - type: APIReference url: https://developers.mtn.com/products/customer-data-transfer-ng-prod - type: OpenAPI url: openapi/mtn-group-customer-data-transfer-ng-prod.yml - type: Overlay url: overlays/mtn-group-customer-data-transfer-ng-prod-overlay.yaml - aid: mtn-group:mtn-customer-datatransfer name: MTN Customer Data Transfer description: API will enable MTN customers to transfer part of their active airtime or data to another MTN customer. This service excludes special data plans. humanURL: https://developers.mtn.com/products/mtn-customer-datatransfer baseURL: https://api.mtn.com/v1 tags: - Customer - Congo - Côte d'Ivoire - Cameroon - Ghana properties: - type: Documentation url: https://developers.mtn.com/products/mtn-customer-datatransfer - type: APIReference url: https://developers.mtn.com/products/mtn-customer-datatransfer - type: OpenAPI url: openapi/mtn-group-mtn-customer-datatransfer.yml - type: Overlay url: overlays/mtn-group-mtn-customer-datatransfer-overlay.yaml - aid: mtn-group:device-swap-v1 name: MTN Device Swap V1 description: The Device Swap API is designed to detect changes in the International Mobile Equipment Identity (IMEI) associated with a mobile subscriber's number (MSISDN) within a specific period, typically the last 30 days. Supported Operations 1.Checks if the IMEI linked to an MSISDN has changed. 2.Returns the date of the latest IMEI change.... humanURL: https://developers.mtn.com/products/device-swap-v1 baseURL: https://api.mtn.com/v1/devices tags: - Customer - Cameroon - Nigeria - South Africa - Zambia properties: - type: Documentation url: https://developers.mtn.com/products/device-swap-v1 - type: APIReference url: https://developers.mtn.com/products/device-swap-v1 - type: OpenAPI url: openapi/mtn-group-device-swap-v1.yml - type: Overlay url: overlays/mtn-group-device-swap-v1-overlay.yaml - aid: mtn-group:tmf-720-digital-identity-management name: MTN TMF 720 - Digital Identity Management description: 'TMF API Reference: TMF720 - Digital Identity Management Digital Identity Management API goal is to provide the ability to manage a digital identity. This digital identity allows to identify an individual, a resource, or a partyRole (a specific role - or set of roles - for a given individual). A digital identity is associated with...' humanURL: https://developers.mtn.com/products/tmf-720-digital-identity-management tags: - TM Forum - TMF720 - Cameroon - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/tmf-720-digital-identity-management - type: APIReference url: https://developers.mtn.com/products/tmf-720-digital-identity-management - type: OpenAPI url: openapi/mtn-group-tmf-720-digital-identity-management.yml - type: Overlay url: overlays/mtn-group-tmf-720-digital-identity-management-overlay.yaml baseURL: https://api.mtn.com/tmf-api/digitalIdentityManagement/v4 - aid: mtn-group:digital-partner-management name: MTN Digital Partner Management description: TM Forum Open APIs (Apache 2.0) Party Management API Provides standardized mechanism for digital partner management such as creation, update, retrieval, deletion and notification of events. Partner is an organization that has any kind of relation with the enterprise. humanURL: https://developers.mtn.com/products/digital-partner-management baseURL: https://api.mtn.com/digitalPartners/v1 tags: - Customer - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/digital-partner-management - type: APIReference url: https://developers.mtn.com/products/digital-partner-management - type: OpenAPI url: openapi/mtn-group-digital-partner-management.yml - type: Overlay url: overlays/mtn-group-digital-partner-management-overlay.yaml - aid: mtn-group:document-managment name: MTN Document Management description: TMF667 Document API describes the meta-data of a Document, such as the name, creationDate and lifecycle status. The (typically binary) body of this document (such as a Word.doc, PDF, Video clip, or Image) will be held in the associated Attachment(s) either by Ref or Value. If by value - the binary content is held in the... humanURL: https://developers.mtn.com/products/document-managment baseURL: https://mtn.com/tmf-api/document/v4/ tags: - Customer - Uganda - Nigeria - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/document-managment - type: APIReference url: https://developers.mtn.com/products/document-managment - type: OpenAPI url: openapi/mtn-group-document-managment.yml - type: Overlay url: overlays/mtn-group-document-managment-overlay.yaml - aid: mtn-group:tmf-document-management-tmf667 name: MTN TMF Document Management - TMF667 description: This is Swagger UI environment generated for the TMF Document Management specification. humanURL: https://developers.mtn.com/products/tmf-document-management-tmf667 baseURL: https://mtn.com/tmf-api/documentManagement tags: - TM Forum - TMF667 - Côte d'Ivoire - South Sudan - Eswatini - Zambia properties: - type: Documentation url: https://developers.mtn.com/products/tmf-document-management-tmf667 - type: APIReference url: https://developers.mtn.com/products/tmf-document-management-tmf667 - type: OpenAPI url: openapi/mtn-group-tmf-document-management-tmf667.yml - type: Overlay url: overlays/mtn-group-tmf-document-management-tmf667-overlay.yaml - aid: mtn-group:tmf688-event-management name: MTN TMF688 - Event Management description: The Event Management API provides a standardized client interface to the enterprise event management system. humanURL: https://developers.mtn.com/products/tmf688-event-management tags: - TM Forum - TMF688 - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/tmf688-event-management - type: APIReference url: https://developers.mtn.com/products/tmf688-event-management - type: OpenAPI url: openapi/mtn-group-tmf688-event-management.yml - type: Overlay url: overlays/mtn-group-tmf688-event-management-overlay.yaml baseURL: https://api.mtn.com/tmf-api/event/v4 - aid: mtn-group:eec-token-management name: MTN EEC Token Management description: This API provides EEC Token Management. humanURL: https://developers.mtn.com/products/eec-token-management baseURL: https://api.mtn.com/v1/eec/ tags: - Customer - Eswatini properties: - type: Documentation url: https://developers.mtn.com/products/eec-token-management - type: APIReference url: https://developers.mtn.com/products/eec-token-management - type: OpenAPI url: openapi/mtn-group-eec-token-management.yml - type: Overlay url: overlays/mtn-group-eec-token-management-overlay.yaml - aid: mtn-group:insurance name: MTN Insurance description: List of services to integrate with insurance service provider to manage insurance policies and policy related information. It provides the ability for channel applications to request for quote, submit application, manage application and fetch list of policies. humanURL: https://developers.mtn.com/products/insurance baseURL: https://za.api.mtn.com/insurance tags: - Customer - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/insurance - type: APIReference url: https://developers.mtn.com/products/insurance - type: OpenAPI url: openapi/mtn-group-insurance.yml - type: Overlay url: overlays/mtn-group-insurance-overlay.yaml - aid: mtn-group:iot-device-management name: MTN IoT Device Management description: This service provides comprehensive IoT device management capabilities for TMF908 operations including device information retrieval, device management operations, and lifecycle management. The service integrates with various IoT platforms and provides standardized APIs for device operations across the MTN ecosystem. humanURL: https://developers.mtn.com/products/iot-device-management baseURL: https://api.mtn.com/v1 tags: - Customer - Congo - Ghana - Nigeria - Eswatini properties: - type: Documentation url: https://developers.mtn.com/products/iot-device-management - type: APIReference url: https://developers.mtn.com/products/iot-device-management - type: OpenAPI url: openapi/mtn-group-iot-device-management.yml - type: Overlay url: overlays/mtn-group-iot-device-management-overlay.yaml - aid: mtn-group:hcm-v1 name: MTN HCM V1 description: Api Documentation. humanURL: https://developers.mtn.com/products/hcm-v1 baseURL: https://za.api.mtn.com/v1 tags: - Customer - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/hcm-v1 - type: APIReference url: https://developers.mtn.com/products/hcm-v1 - type: OpenAPI url: openapi/mtn-group-hcm-v1.yml - type: Overlay url: overlays/mtn-group-hcm-v1-overlay.yaml - aid: mtn-group:logback-v1 name: MTN LogBack V1 description: Facility to query failed transactions. humanURL: https://developers.mtn.com/products/logback-v1 baseURL: https://api.mtn.com/v1 tags: - Analytics - South Africa - Nigeria - Ghana - Côte d'Ivoire properties: - type: Documentation url: https://developers.mtn.com/products/logback-v1 - type: APIReference url: https://developers.mtn.com/products/logback-v1 - type: OpenAPI url: openapi/mtn-group-logback-v1.yml - type: Overlay url: overlays/mtn-group-logback-v1-overlay.yaml - aid: mtn-group:tmf-loyalty-management-tmf658 name: MTN TMF Loyalty Management - TMF658 description: The TMForum Loyalty API Specification as developed by Globetom. humanURL: https://developers.mtn.com/products/tmf-loyalty-management-tmf658 baseURL: https://api.mtn.com/tmf-api/loyaltyManagement/v1 tags: - TM Forum - TMF658 - Benin - Côte d'Ivoire - South Sudan - Eswatini properties: - type: Documentation url: https://developers.mtn.com/products/tmf-loyalty-management-tmf658 - type: APIReference url: https://developers.mtn.com/products/tmf-loyalty-management-tmf658 - type: OpenAPI url: openapi/mtn-group-tmf-loyalty-management-tmf658.yml - type: Overlay url: overlays/mtn-group-tmf-loyalty-management-tmf658-overlay.yaml - aid: mtn-group:rcs-capability name: MTN RCS Capability description: This API provides ability to check the capability of an MSISDN to receive RCS mesages. humanURL: https://developers.mtn.com/products/rcs-capability baseURL: https://api.mtn.com/v1 tags: - Customer - Nigeria properties: - type: Documentation url: https://developers.mtn.com/products/rcs-capability - type: APIReference url: https://developers.mtn.com/products/rcs-capability - type: OpenAPI url: openapi/mtn-group-rcs-capability.yml - type: Overlay url: overlays/mtn-group-rcs-capability-overlay.yaml - aid: mtn-group:medallia-sms-v2 name: MTN Medallia SMS V2 description: Provides a RESTful API to expose SMS capability. humanURL: https://developers.mtn.com/products/medallia-sms-v2 baseURL: https://api.mtn.com/v2m/ tags: - Messaging - Congo - Côte d'Ivoire - Cameroon - Guinea properties: - type: Documentation url: https://developers.mtn.com/products/medallia-sms-v2 - type: APIReference url: https://developers.mtn.com/products/medallia-sms-v2 - type: OpenAPI url: openapi/mtn-group-medallia-sms-v2.yml - type: Overlay url: overlays/mtn-group-medallia-sms-v2-overlay.yaml - aid: mtn-group:advertising-v2 name: MTN Advertising V2 description: This service provides comprehensive mobile advertisement management capabilities for MTN operations including ad targeting, content delivery, campaign management, and performance analytics. The service integrates with various advertising platforms to provide personalized ad experiences across the MTN ecosystem. humanURL: https://developers.mtn.com/products/advertising-v2 baseURL: https://api.mtn.com/v1 tags: - Advertising - Eswatini properties: - type: Documentation url: https://developers.mtn.com/products/advertising-v2 - type: APIReference url: https://developers.mtn.com/products/advertising-v2 - type: OpenAPI url: openapi/mtn-group-advertising-v2.yml - type: Overlay url: overlays/mtn-group-advertising-v2-overlay.yaml - aid: mtn-group:mtn-advertising-api-v1 name: MTN Advertising description: A brief description of the API. It can be multiple lines. humanURL: https://developers.mtn.com/products/mtn-advertising-api-v1 baseURL: https://api.mtn.com tags: - Advertising - South Africa - Nigeria - Ghana - Uganda properties: - type: Documentation url: https://developers.mtn.com/products/mtn-advertising-api-v1 - type: APIReference url: https://developers.mtn.com/products/mtn-advertising-api-v1 - type: OpenAPI url: openapi/mtn-group-mtn-advertising-api-v1.yml - type: Overlay url: overlays/mtn-group-mtn-advertising-api-v1-overlay.yaml - aid: mtn-group:mobile-customer-information name: MTN Mobile Customer Information description: The mobile info API provides network related data. Supported Operations 1. Get last SIM Swap date of an MSISDN. 2. Get last SIM Swap date indicator of a MSISDN **Supported OpCo's:** MTN Uganda, MTN Ghana, MTN SA. humanURL: https://developers.mtn.com/products/mobile-customer-information baseURL: https://api.mtn.com/v1/mobile tags: - Customer - Ghana - Uganda - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/mobile-customer-information - type: APIReference url: https://developers.mtn.com/products/mobile-customer-information - type: OpenAPI url: openapi/mtn-group-mobile-customer-information.yml - type: Overlay url: overlays/mtn-group-mobile-customer-information-overlay.yaml - aid: mtn-group:withdrawals-v1 name: MTN MoMo Withdrawals V1 description: To facilitate the capability for consumers to realize withdrawals via MADAPI. The callback (i.. Completed) will be handled via MADAPI's callback API. humanURL: https://developers.mtn.com/products/withdrawals-v1 baseURL: https://preprod.mtn.com/v1 tags: - Payments - Benin - Congo - Cameroon - Ghana properties: - type: Documentation url: https://developers.mtn.com/products/withdrawals-v1 - type: APIReference url: https://developers.mtn.com/products/withdrawals-v1 - type: OpenAPI url: openapi/mtn-group-withdrawals-v1.yml - type: Overlay url: overlays/mtn-group-withdrawals-v1-overlay.yaml - aid: mtn-group:momo-verification name: MTN MoMo Verification V1-ToBeDeleted description: A suite of apis for customer validation. humanURL: https://developers.mtn.com/products/momo-verification baseURL: https://api.mtn.com/v1 tags: - Payments - Cameroon - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/momo-verification - type: APIReference url: https://developers.mtn.com/products/momo-verification - type: OpenAPI url: openapi/mtn-group-momo-verification.yml - type: Overlay url: overlays/mtn-group-momo-verification-overlay.yaml - aid: mtn-group:ayoaccountholderinfo name: MTN AccountHolders V1 description: The Accountholders API returns basic information of the Accountholder including MTN Mobile Money account status. i.e. ACTIVE, SUSPENDED, BLOCKED etc. It also support validation of a MoMo accountholder, as well as the verification of financial resourceinformation. humanURL: https://developers.mtn.com/products/ayoaccountholderinfo baseURL: https://api.mtn.com/v1 tags: - Customer - Benin - Congo - Côte d'Ivoire - Cameroon properties: - type: Documentation url: https://developers.mtn.com/products/ayoaccountholderinfo - type: APIReference url: https://developers.mtn.com/products/ayoaccountholderinfo - type: OpenAPI url: openapi/mtn-group-ayoaccountholderinfo.yml - type: Overlay url: overlays/mtn-group-ayoaccountholderinfo-overlay.yaml - aid: mtn-group:agent-profile name: MTN Agent Profile description: An API to retrieve the profile of an MTN field agent. Please refer to the reference guides https://developers.mtn.com/getting-started and Response and Error Codes documents https://developers.mtn.com/getting-started/response-and-error-codes. humanURL: https://developers.mtn.com/products/agent-profile baseURL: https://api.mtn.com/v1/agents tags: - Agent - Ghana - Uganda - Eswatini - Nigeria properties: - type: Documentation url: https://developers.mtn.com/products/agent-profile - type: APIReference url: https://developers.mtn.com/products/agent-profile - type: OpenAPI url: openapi/mtn-group-agent-profile.yml - type: Overlay url: overlays/mtn-group-agent-profile-overlay.yaml - aid: mtn-group:customer-account-management-v1 name: MTN Customer Account Management V1 description: This API manages tasks for an MTN customer. humanURL: https://developers.mtn.com/products/customer-account-management-v1 baseURL: https://api.mtn.com/v1 tags: - Customer - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/customer-account-management-v1 - type: APIReference url: https://developers.mtn.com/products/customer-account-management-v1 - type: OpenAPI url: openapi/mtn-group-customer-account-management-v1.yml - type: Overlay url: overlays/mtn-group-customer-account-management-v1-overlay.yaml - aid: mtn-group:mtn-customer-kyc-api-v1-product name: MTN KYC v1 description: MTN Customer KYC API allows clients to view the KYC (Know Your Customer) details of an MTN customer. The KYC API is a subset of the Customer Profile API. humanURL: https://developers.mtn.com/products/mtn-customer-kyc-api-v1-product baseURL: https://api.mtn.com/v1/customers tags: - Customer - Côte d'Ivoire - Congo - Cameroon - Ghana properties: - type: Documentation url: https://developers.mtn.com/products/mtn-customer-kyc-api-v1-product - type: APIReference url: https://developers.mtn.com/products/mtn-customer-kyc-api-v1-product - type: OpenAPI url: openapi/mtn-group-mtn-customer-kyc-api-v1-product.yml - type: Overlay url: overlays/mtn-group-mtn-customer-kyc-api-v1-product-overlay.yaml - aid: mtn-group:customer-kyc-verification name: MTN Customer KYC Verification description: The Customer KYC(Know Your Client) Verification API will validate the 3PP Customer KYC information with MTN Customer KYC information. humanURL: https://developers.mtn.com/products/customer-kyc-verification baseURL: https://api.mtn.com/v1/kycVerification/ tags: - Customer - Benin - Côte d'Ivoire - Cameroon - Ghana properties: - type: Documentation url: https://developers.mtn.com/products/customer-kyc-verification - type: APIReference url: https://developers.mtn.com/products/customer-kyc-verification - type: OpenAPI url: openapi/mtn-group-customer-kyc-verification.yml - type: Overlay url: overlays/mtn-group-customer-kyc-verification-overlay.yaml - aid: mtn-group:loans-v2 name: MTN Loans v2 description: This API facilitate loan in advance for an MTN customer. humanURL: https://developers.mtn.com/products/loans-v2 baseURL: https://api.mtn.com/v2 tags: - Customer - Benin - Congo - Côte d'Ivoire - Cameroon properties: - type: Documentation url: https://developers.mtn.com/products/loans-v2 - type: APIReference url: https://developers.mtn.com/products/loans-v2 - type: OpenAPI url: openapi/mtn-group-loans-v2.yml - type: Overlay url: overlays/mtn-group-loans-v2-overlay.yaml - aid: mtn-group:mtn-customer-locations-api-v1 name: MTN Locations description: An API to retrieve the Location details of an MTN customer. Please refer to the Response and Error Codes documents https://developers.mtn.com/insights/response-codes. humanURL: https://developers.mtn.com/products/mtn-customer-locations-api-v1 baseURL: https://api.mtn.com/v1 tags: - Customer - South Africa - Nigeria - Ghana - Côte d'Ivoire properties: - type: Documentation url: https://developers.mtn.com/products/mtn-customer-locations-api-v1 - type: APIReference url: https://developers.mtn.com/products/mtn-customer-locations-api-v1 - type: OpenAPI url: openapi/mtn-group-mtn-customer-locations-api-v1.yml - type: Overlay url: overlays/mtn-group-mtn-customer-locations-api-v1-overlay.yaml - aid: mtn-group:customer-management name: MTN Customer Management description: An API to register MoMo on Tier 0 for BSS. Please refer to the reference guides https://developers.mtn.com/API-Reference-Guides and Response and Error Codes documents https://developers.mtn.com/ResponseCodes. humanURL: https://developers.mtn.com/products/customer-management baseURL: https://api.mtn.com/v1/customerManagement tags: - Customer - Uganda - Ghana properties: - type: Documentation url: https://developers.mtn.com/products/customer-management - type: APIReference url: https://developers.mtn.com/products/customer-management - type: OpenAPI url: openapi/mtn-group-customer-management.yml - type: Overlay url: overlays/mtn-group-customer-management-overlay.yaml - aid: mtn-group:mtn-customer-plans-api-v2 name: MTN Plans v2 description: 'An API to retrieve the Plan details of an MTN customer and calculate aYo premiums. Can also be used by 3rd-party partners (3PP) for airtime recharge of a prepaid subscriber **24-June-21: ChangeID: c835ca3** - Added an optional channel parameter on the /customers/{customerId}/plans/refill endpoint **09-August-21: ChangeID: 87f0b10** -...' humanURL: https://developers.mtn.com/products/mtn-customer-plans-api-v2 baseURL: https://api.mtn.com/v2 tags: - Customer - Benin - Cameroon - Congo - Côte d'Ivoire properties: - type: Documentation url: https://developers.mtn.com/products/mtn-customer-plans-api-v2 - type: APIReference url: https://developers.mtn.com/products/mtn-customer-plans-api-v2 - type: OpenAPI url: openapi/mtn-group-mtn-customer-plans-api-v2.yml - type: Overlay url: overlays/mtn-group-mtn-customer-plans-api-v2-overlay.yaml - aid: mtn-group:mtn-customer-profiles-api-v2-product name: MTN Profiles V2 description: An API to retrieve the profile of an MTN customer. Please refer to the reference guides https://developers.mtn.com/API-Reference-Guides and Response and Error Codes documents https://developers.mtn.com/ResponseCodes. humanURL: https://developers.mtn.com/products/mtn-customer-profiles-api-v2-product baseURL: https://api.mtn.com/v2 tags: - Customer - Benin - Congo - Côte d'Ivoire - Cameroon properties: - type: Documentation url: https://developers.mtn.com/products/mtn-customer-profiles-api-v2-product - type: APIReference url: https://developers.mtn.com/products/mtn-customer-profiles-api-v2-product - type: OpenAPI url: openapi/mtn-group-mtn-customer-profiles-api-v2-product.yml - type: Overlay url: overlays/mtn-group-mtn-customer-profiles-api-v2-product-overlay.yaml - aid: mtn-group:risk-management name: MTN Risk Management description: This API assesses risks for an MTN customer as well as creates applications. humanURL: https://developers.mtn.com/products/risk-management baseURL: https://za.api.mtn.com/v1/riskManagement tags: - Customer - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/risk-management - type: APIReference url: https://developers.mtn.com/products/risk-management - type: OpenAPI url: openapi/mtn-group-risk-management.yml - type: Overlay url: overlays/mtn-group-risk-management-overlay.yaml - aid: mtn-group:mtn-customer-score name: MTN Customer Score V1 description: This API is used to determine the customer's score through an activities performed within a period of time. humanURL: https://developers.mtn.com/products/mtn-customer-score baseURL: https://api.mtn.com/v1 tags: - Customer - Cameroon - Nigeria properties: - type: Documentation url: https://developers.mtn.com/products/mtn-customer-score - type: APIReference url: https://developers.mtn.com/products/mtn-customer-score - type: OpenAPI url: openapi/mtn-group-mtn-customer-score.yml - type: Overlay url: overlays/mtn-group-mtn-customer-score-overlay.yaml - aid: mtn-group:simverification name: MTN SIM Verification description: This API is used to verify/validate SIM Swap status, SIM Activation status and SIM Recycle status of a customer's msisdn. - **'/simSwap/verifyStatus'** capability is used to verify sim swap status as true or false. - **'/simActivation/verifyStatus'** capability is used to verify sim activation status as true or false. -... humanURL: https://developers.mtn.com/products/simverification baseURL: https://api.mtn.com/v1/simVerification tags: - Customer - Nigeria properties: - type: Documentation url: https://developers.mtn.com/products/simverification - type: APIReference url: https://developers.mtn.com/products/simverification - type: OpenAPI url: openapi/mtn-group-simverification.yml - type: Overlay url: overlays/mtn-group-simverification-overlay.yaml - aid: mtn-group:mtn-subscription-api-v2 name: MTN Subscriptions v2 description: MTN Customer Subscription Management API — an MTN Group API product published on the MTN Developer Platform (MADAPI) with a downloadable machine-readable definition covering 6 path(s). humanURL: https://developers.mtn.com/products/mtn-subscription-api-v2 baseURL: https://api.mtn.com/v2 tags: - Customer - Benin - Cameroon - Congo - Côte d'Ivoire properties: - type: Documentation url: https://developers.mtn.com/products/mtn-subscription-api-v2 - type: APIReference url: https://developers.mtn.com/products/mtn-subscription-api-v2 - type: OpenAPI url: openapi/mtn-group-mtn-subscription-api-v2.yml - type: Overlay url: overlays/mtn-group-mtn-subscription-api-v2-overlay.yaml - aid: mtn-group:g2m name: MTN G2M description: API to provide capability to manage Offering specification of products. humanURL: https://developers.mtn.com/products/g2m baseURL: https://api.mtn.com/v1/g2m tags: - Customer - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/g2m - type: APIReference url: https://developers.mtn.com/products/g2m - type: OpenAPI url: openapi/mtn-group-g2m.yml - type: Overlay url: overlays/mtn-group-g2m-overlay.yaml - aid: mtn-group:oauth-v1 name: MTN OAuth V1 description: Generates an access token based on username and password. humanURL: https://developers.mtn.com/products/oauth-v1 baseURL: https://api.mtn.com/v1/oauth tags: - Identity - Benin - Congo - Côte d'Ivoire - Cameroon properties: - type: Documentation url: https://developers.mtn.com/products/oauth-v1 - type: APIReference url: https://developers.mtn.com/products/oauth-v1 - type: OpenAPI url: openapi/mtn-group-oauth-v1.yml - type: Overlay url: overlays/mtn-group-oauth-v1-overlay.yaml - aid: mtn-group:merchant-provisioning-v1 name: MTN Merchant Provisioning V1 description: To enable merchants to manage purchases of subscribers. humanURL: https://developers.mtn.com/products/merchant-provisioning-v1 baseURL: https://api.mtn.com/v1/merchant tags: - Customer - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/merchant-provisioning-v1 - type: APIReference url: https://developers.mtn.com/products/merchant-provisioning-v1 - type: OpenAPI url: openapi/mtn-group-merchant-provisioning-v1.yml - type: Overlay url: overlays/mtn-group-merchant-provisioning-v1-overlay.yaml - aid: mtn-group:mtn-sms-api-v1 name: MTN SMS description: MTN SMS Messaging API allowing developers to include SMS messaging in their applications. humanURL: https://developers.mtn.com/products/mtn-sms-api-v1 baseURL: https://api.mtn.com/v1/messages/ tags: - Messaging - Nigeria properties: - type: Documentation url: https://developers.mtn.com/products/mtn-sms-api-v1 - type: APIReference url: https://developers.mtn.com/products/mtn-sms-api-v1 - type: OpenAPI url: openapi/mtn-group-mtn-sms-api-v1.yml - type: Overlay url: overlays/mtn-group-mtn-sms-api-v1-overlay.yaml - aid: mtn-group:ussd name: MTN USSD interface description: Provides a RESTful API to expose USSD capability. humanURL: https://developers.mtn.com/products/ussd baseURL: https://api.mtn.com/v1/ tags: - Messaging - Benin - Congo - Côte d'Ivoire - Cameroon properties: - type: Documentation url: https://developers.mtn.com/products/ussd - type: APIReference url: https://developers.mtn.com/products/ussd - type: OpenAPI url: openapi/mtn-group-ussd.yml - type: Overlay url: overlays/mtn-group-ussd-overlay.yaml - aid: mtn-group:mtn-product-offering-api-v2 name: MTN Product Offering v2 description: A MTN API that controls the display of the catalog of Products available for a customer to purchase. humanURL: https://developers.mtn.com/products/mtn-product-offering-api-v2 baseURL: https://api.mtn.com tags: - Customer - Rwanda properties: - type: Documentation url: https://developers.mtn.com/products/mtn-product-offering-api-v2 - type: APIReference url: https://developers.mtn.com/products/mtn-product-offering-api-v2 - type: OpenAPI url: openapi/mtn-group-mtn-product-offering-api-v2.yml - type: Overlay url: overlays/mtn-group-mtn-product-offering-api-v2-overlay.yaml - aid: mtn-group:mtn-product-offering-api-v3 name: MTN Product Offering v3 description: A MTN API that controls the display of the catalog of Products available for a customer to purchase. humanURL: https://developers.mtn.com/products/mtn-product-offering-api-v3 baseURL: https://api.mtn.com/v3 tags: - Customer - Benin - Congo - Côte d'Ivoire - Cameroon properties: - type: Documentation url: https://developers.mtn.com/products/mtn-product-offering-api-v3 - type: APIReference url: https://developers.mtn.com/products/mtn-product-offering-api-v3 - type: OpenAPI url: openapi/mtn-group-mtn-product-offering-api-v3.yml - type: Overlay url: overlays/mtn-group-mtn-product-offering-api-v3-overlay.yaml - aid: mtn-group:mtn-ng-retailer-productivity-tracking-v1 name: MTN Retailer Productivity Tracking v1 description: An API to enable MTN retailers track their productivity KPI's over a period of time. Please refer to the reference guides https://developers.mtn.com/API-Reference-Guides and Response and Error Codes documents https://developers.mtn.com/ResponseCodes. humanURL: https://developers.mtn.com/products/mtn-ng-retailer-productivity-tracking-v1 baseURL: https://api.mtn.com/v1 tags: - Analytics - Nigeria properties: - type: Documentation url: https://developers.mtn.com/products/mtn-ng-retailer-productivity-tracking-v1 - type: APIReference url: https://developers.mtn.com/products/mtn-ng-retailer-productivity-tracking-v1 - type: OpenAPI url: openapi/mtn-group-mtn-ng-retailer-productivity-tracking-v1.yml - type: Overlay url: overlays/mtn-group-mtn-ng-retailer-productivity-tracking-v1-overlay.yaml - aid: mtn-group:tmf633-shopping-cart-management name: MTN TMF633 - Shopping Cart Management description: The Shopping Cart API provides a standardized mechanism for the management of shopping carts. Including creation, update, retrieval. humanURL: https://developers.mtn.com/products/tmf633-shopping-cart-management baseURL: https://api.mtn.com/tmf-api/shoppingCart/v1/ tags: - Customer - TMF633 - TM Forum - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/tmf633-shopping-cart-management - type: APIReference url: https://developers.mtn.com/products/tmf633-shopping-cart-management - type: OpenAPI url: openapi/mtn-group-tmf633-shopping-cart-management.yml - type: Overlay url: overlays/mtn-group-tmf633-shopping-cart-management-overlay.yaml - aid: mtn-group:siebel name: MTN Siebel description: This API assesses risks for an MTN customer as well as creates applications. humanURL: https://developers.mtn.com/products/siebel baseURL: https://api.mtn.com/v1 tags: - Customer - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/siebel - type: APIReference url: https://developers.mtn.com/products/siebel - type: OpenAPI url: openapi/mtn-group-siebel.yml - type: Overlay url: overlays/mtn-group-siebel-overlay.yaml - aid: mtn-group:tmf-party-management name: MTN TMF Party Management - TMF632 description: This service provides comprehensive party management capabilities for MTN customers including individual and organization management, credit information, and partner services. It serves as the aggregator layer for all TMF632 party-related operations across the MTN ecosystem. humanURL: https://developers.mtn.com/products/tmf-party-management baseURL: https://api.mtn.com/v1 tags: - TM Forum - TMF632 - Benin - Congo - Côte d'Ivoire - South Sudan properties: - type: Documentation url: https://developers.mtn.com/products/tmf-party-management - type: APIReference url: https://developers.mtn.com/products/tmf-party-management - type: OpenAPI url: openapi/mtn-group-tmf-party-management.yml - type: Overlay url: overlays/mtn-group-tmf-party-management-overlay.yaml - aid: mtn-group:tmf-usage-management-tmf635 name: MTN TMF Usage Management - TMF635 description: This service provides comprehensive usage management capabilities for MTN operations including data usage tracking, subscription management, balance inquiries, and usage analytics. The service integrates with various billing and usage systems to provide real-time usage information across the MTN ecosystem. humanURL: https://developers.mtn.com/products/tmf-usage-management-tmf635 baseURL: https://api.mtn.com/v1 tags: - TM Forum - TMF635 - Côte d'Ivoire - South Sudan properties: - type: Documentation url: https://developers.mtn.com/products/tmf-usage-management-tmf635 - type: APIReference url: https://developers.mtn.com/products/tmf-usage-management-tmf635 - type: OpenAPI url: openapi/mtn-group-tmf-usage-management-tmf635.yml - type: Overlay url: overlays/mtn-group-tmf-usage-management-tmf635-overlay.yaml - aid: mtn-group:usage-management name: MTN Usage Management description: This service provides comprehensive usage management capabilities for MTN operations including data usage tracking, subscription management, balance inquiries, and usage analytics. The service integrates with various billing and usage systems to provide real-time usage information across the MTN ecosystem. humanURL: https://developers.mtn.com/products/usage-management baseURL: https://api.mtn.com/v1 tags: - Customer - Benin - Côte d'Ivoire - Congo - Cameroon properties: - type: Documentation url: https://developers.mtn.com/products/usage-management - type: APIReference url: https://developers.mtn.com/products/usage-management - type: OpenAPI url: openapi/mtn-group-usage-management.yml - type: Overlay url: overlays/mtn-group-usage-management-overlay.yaml - aid: mtn-group:mtnid-getinfo name: MTN MTNID-getInfo description: Interface to the Apigee Cloud MTN-ID userinfo function. humanURL: https://developers.mtn.com/products/mtnid-getinfo baseURL: https://api.mtn.com/mtn-id tags: - Identity - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/mtnid-getinfo - type: APIReference url: https://developers.mtn.com/products/mtnid-getinfo - type: OpenAPI url: openapi/mtn-group-mtnid-getinfo.yml - type: Overlay url: overlays/mtn-group-mtnid-getinfo-overlay.yaml - aid: mtn-group:notification-production name: MTN Notification V1 description: To facilitate notifications. Allows 3PPs to register and have notifications processed to them from the applicable backends. humanURL: https://developers.mtn.com/products/notification-production baseURL: https://api.mtn.com/v1 tags: - Messaging - Congo - Côte d'Ivoire - Cameroon - Ghana properties: - type: Documentation url: https://developers.mtn.com/products/notification-production - type: APIReference url: https://developers.mtn.com/products/notification-production - type: OpenAPI url: openapi/mtn-group-notification-production.yml - type: Overlay url: overlays/mtn-group-notification-production-overlay.yaml - aid: mtn-group:notification-v2 name: MTN Notification v2 description: To facilitate notifications. Allows 3PPs to register and have notifications processed to them from the applicable backends. humanURL: https://developers.mtn.com/products/notification-v2 baseURL: https://api.mtn.com/v2 tags: - Messaging - Congo - Côte d'Ivoire - Cameroon - Ghana properties: - type: Documentation url: https://developers.mtn.com/products/notification-v2 - type: APIReference url: https://developers.mtn.com/products/notification-v2 - type: OpenAPI url: openapi/mtn-group-notification-v2.yml - type: Overlay url: overlays/mtn-group-notification-v2-overlay.yaml - aid: mtn-group:order-fulfillment name: MTN Order Fulfillment description: This API provides ability to digital channel to purchase different offers and make payment through Netbanking or Card Payments. humanURL: https://developers.mtn.com/products/order-fulfillment baseURL: https://api.mtn.com/v1 tags: - Customer - Nigeria properties: - type: Documentation url: https://developers.mtn.com/products/order-fulfillment - type: APIReference url: https://developers.mtn.com/products/order-fulfillment - type: OpenAPI url: openapi/mtn-group-order-fulfillment.yml - type: Overlay url: overlays/mtn-group-order-fulfillment-overlay.yaml - aid: mtn-group:tmf-party-interaction-tmf683 name: MTN TMF Party Interaction - TMF683 description: '**TMF API Reference : TMF - 683 Party Interaction** **Release : 19.5 - Oct 2019** The Party Interaction Management API provides a mechanism to manage party interactions. Creation, update and retrieval. Including creation, update, retrieval, deletion and notification of event. A Party Interaction captures information about past...' humanURL: https://developers.mtn.com/products/tmf-party-interaction-tmf683 baseURL: https://api.mtn.com/partyInteraction/v1 tags: - TM Forum - TMF683 - Cameroon - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/tmf-party-interaction-tmf683 - type: APIReference url: https://developers.mtn.com/products/tmf-party-interaction-tmf683 - type: OpenAPI url: openapi/mtn-group-tmf-party-interaction-tmf683.yml - type: Overlay url: overlays/mtn-group-tmf-party-interaction-tmf683-overlay.yaml - aid: mtn-group:mtn-party-management name: MTN Party Management description: This API provides standardized mechanism for party management such as creation, update, retrieval and deletion of a party. Party can be an individual or an organization that has any kind of relation with the enterprise. humanURL: https://developers.mtn.com/products/mtn-party-management baseURL: https://api.mtn.com/party/v1 tags: - Customer - Nigeria - Ghana properties: - type: Documentation url: https://developers.mtn.com/products/mtn-party-management - type: APIReference url: https://developers.mtn.com/products/mtn-party-management - type: OpenAPI url: openapi/mtn-group-mtn-party-management.yml - type: Overlay url: overlays/mtn-group-mtn-party-management-overlay.yaml - aid: mtn-group:rwanda-party-management name: MTN Rwanda Party Management description: This API provides standardized mechanism for party management such as creation, update, retrieval and deletion of a party. Party can be an individual or an organization that has any kind of relation with the enterprise. humanURL: https://developers.mtn.com/products/rwanda-party-management baseURL: https://api.mtn.com/party/v1 tags: - Customer - Rwanda properties: - type: Documentation url: https://developers.mtn.com/products/rwanda-party-management - type: APIReference url: https://developers.mtn.com/products/rwanda-party-management - type: OpenAPI url: openapi/mtn-group-rwanda-party-management.yml - type: Overlay url: overlays/mtn-group-rwanda-party-management-overlay.yaml - aid: mtn-group:payment-methods-management-sa name: MTN Payment Methods V1 description: 'A suite of apis for customer payment method details and its data type. **07-July-21: ChangeID: 00000** - Updated the response body for the /paymentMethod endpoint **06-December-21:** - Added a new method for updating the payment method details, as below: PUT /paymentMethod.' humanURL: https://developers.mtn.com/products/payment-methods-management-sa baseURL: https://api.mtn.com/v1 tags: - Payments - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/payment-methods-management-sa - type: APIReference url: https://developers.mtn.com/products/payment-methods-management-sa - type: OpenAPI url: openapi/mtn-group-payment-methods-management-sa.yml - type: Overlay url: overlays/mtn-group-payment-methods-management-sa-overlay.yaml - aid: mtn-group:payments-v1 name: MTN Payments V1 description: This is the Payment API for MADAPI. Handles payment use cases such as spTransfer, Debit request, Payment request, and related financial transactions. Provides comprehensive payment processing capabilities including merchant payments, customer payments, transaction status queries, payment history, and reverse payment operations. humanURL: https://developers.mtn.com/products/payments-v1 baseURL: https://api.mtn.com/v1 tags: - Payments - Benin - Cameroon - Congo - Côte d'Ivoire properties: - type: Documentation url: https://developers.mtn.com/products/payments-v1 - type: APIReference url: https://developers.mtn.com/products/payments-v1 - type: OpenAPI url: openapi/mtn-group-payments-v1.yml - type: Overlay url: overlays/mtn-group-payments-v1-overlay.yaml - aid: mtn-group:tmf-prepay-balance-management-tmf654 name: MTN TMF Prepay Balance Management - TMF654 description: This is a sample representation of the Prepay Balance Management TMForum API. It is important to bear in mind that swagger 2.0 does not properly support polymorphism, so the link between the payment method details and its data types should be looked up in the API specification pdf file. humanURL: https://developers.mtn.com/products/tmf-prepay-balance-management-tmf654 baseURL: https://api.mtn.com/tmf-api/prepaybalancemanagement/v1/ tags: - TM Forum - TMF654 - South Sudan - Eswatini properties: - type: Documentation url: https://developers.mtn.com/products/tmf-prepay-balance-management-tmf654 - type: APIReference url: https://developers.mtn.com/products/tmf-prepay-balance-management-tmf654 - type: OpenAPI url: openapi/mtn-group-tmf-prepay-balance-management-tmf654.yml - type: Overlay url: overlays/mtn-group-tmf-prepay-balance-management-tmf654-overlay.yaml - aid: mtn-group:product-catalog-coe name: MTN Product Catalog - COE description: API to provide capability to manage catalog, category, Offerings, Offering price and specification of products. humanURL: https://developers.mtn.com/products/product-catalog-coe baseURL: https://api.mtn.com/tmf-api/productcatalog/v1 tags: - Customer - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/product-catalog-coe - type: APIReference url: https://developers.mtn.com/products/product-catalog-coe - type: OpenAPI url: openapi/mtn-group-product-catalog-coe.yml - type: Overlay url: overlays/mtn-group-product-catalog-coe-overlay.yaml - aid: mtn-group:product-catalog-management-v1 name: MTN Product Catalog Management V1 description: API to provide capability to manage catalog, category, Offerings, Offering price and specification of products. humanURL: https://developers.mtn.com/products/product-catalog-management-v1 baseURL: https://api.mtn.com/productCatalogManagement/v1/ tags: - Customer - Rwanda - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/product-catalog-management-v1 - type: APIReference url: https://developers.mtn.com/products/product-catalog-management-v1 - type: OpenAPI url: openapi/mtn-group-product-catalog-management-v1.yml - type: Overlay url: overlays/mtn-group-product-catalog-management-v1-overlay.yaml - aid: mtn-group:product-catalogue-management name: MTN Product Catalogue Management description: API to provide capability to manage catalog, category, Offerings, Offering price and specification of products. humanURL: https://developers.mtn.com/products/product-catalogue-management baseURL: https://api.mtn.com/productCatalogManagement/v1/ tags: - Customer - Nigeria properties: - type: Documentation url: https://developers.mtn.com/products/product-catalogue-management - type: APIReference url: https://developers.mtn.com/products/product-catalogue-management - type: OpenAPI url: openapi/mtn-group-product-catalogue-management.yml - type: Overlay url: overlays/mtn-group-product-catalogue-management-overlay.yaml - aid: mtn-group:tmf-product-catalog-tmf620 name: MTN TMF Product Catalog - TMF620 description: API to provide capability to manage catalog, category, Offerings, Offering price and specification of products. humanURL: https://developers.mtn.com/products/tmf-product-catalog-tmf620 baseURL: https://api.mtn.com/tmf-api/productcatalog/v1 tags: - TM Forum - TMF620 - Benin - Côte d'Ivoire - South Sudan - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/tmf-product-catalog-tmf620 - type: APIReference url: https://developers.mtn.com/products/tmf-product-catalog-tmf620 - type: OpenAPI url: openapi/mtn-group-tmf-product-catalog-tmf620.yml - type: Overlay url: overlays/mtn-group-tmf-product-catalog-tmf620-overlay.yaml - aid: mtn-group:product-ordering-coe name: MTN Product Ordering - COE description: A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa. Main Product Order attributes are its identifier, state, priority category (mass market, Enterprise, etc.) related dates (start, completion, etc.), related billing... humanURL: https://developers.mtn.com/products/product-ordering-coe baseURL: https://api.mtn.com/tmf-api/productordering/v1 tags: - Customer - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/product-ordering-coe - type: APIReference url: https://developers.mtn.com/products/product-ordering-coe - type: OpenAPI url: openapi/mtn-group-product-ordering-coe.yml - type: Overlay url: overlays/mtn-group-product-ordering-coe-overlay.yaml - aid: mtn-group:tmf-product-ordering-tmf622 name: MTN TMF Product Ordering - TMF622 description: A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa. Main Product Order attributes are its identifier, state, priority category (mass market, Enterprise, etc.) related dates (start, completion, etc.), related billing... humanURL: https://developers.mtn.com/products/tmf-product-ordering-tmf622 baseURL: https://api.mtn.com/tmf-api/productordering/v1 tags: - TM Forum - TMF622 - Benin - Côte d'Ivoire - South Sudan - Eswatini properties: - type: Documentation url: https://developers.mtn.com/products/tmf-product-ordering-tmf622 - type: APIReference url: https://developers.mtn.com/products/tmf-product-ordering-tmf622 - type: OpenAPI url: openapi/mtn-group-tmf-product-ordering-tmf622.yml - type: Overlay url: overlays/mtn-group-tmf-product-ordering-tmf622-overlay.yaml - aid: mtn-group:resource-config-v1 name: MTN Resource Configuration V1 description: API to provision,configure and activate Resource Functions. humanURL: https://developers.mtn.com/products/resource-config-v1 baseURL: https://api.mtn.com/v1 tags: - Customer - Rwanda properties: - type: Documentation url: https://developers.mtn.com/products/resource-config-v1 - type: APIReference url: https://developers.mtn.com/products/resource-config-v1 - type: OpenAPI url: openapi/mtn-group-resource-config-v1.yml - type: Overlay url: overlays/mtn-group-resource-config-v1-overlay.yaml - aid: mtn-group:tmf-resource-ordering-tmf652 name: MTN TMF Resource Ordering - TMF652 description: This is Swagger UI environment generated for the TMF Resource Ordering Management specification. humanURL: https://developers.mtn.com/products/tmf-resource-ordering-tmf652 baseURL: https://api.mtn.com/tmf-api/resourceOrderingManagement/v4/ tags: - TM Forum - TMF652 - Benin - Côte d'Ivoire - Eswatini - Zambia properties: - type: Documentation url: https://developers.mtn.com/products/tmf-resource-ordering-tmf652 - type: APIReference url: https://developers.mtn.com/products/tmf-resource-ordering-tmf652 - type: OpenAPI url: openapi/mtn-group-tmf-resource-ordering-tmf652.yml - type: Overlay url: overlays/mtn-group-tmf-resource-ordering-tmf652-overlay.yaml - aid: mtn-group:tmf-service-activation-tmf678 name: MTN TMF Service Activation - TMF640 description: Service Activation and Configuration API goal is to provide the ability to activate and configure Service. This API features Monitor pattern allowing to manage service configuration/activation asynchronous request (server side will provide monitor as POST/PATCH response). humanURL: https://developers.mtn.com/products/tmf-service-activation-tmf678 baseURL: https://api.mtn.com/ tags: - TM Forum - TMF640 - Benin - Eswatini - Zambia - Liberia properties: - type: Documentation url: https://developers.mtn.com/products/tmf-service-activation-tmf678 - type: APIReference url: https://developers.mtn.com/products/tmf-service-activation-tmf678 - type: OpenAPI url: openapi/mtn-group-tmf-service-activation-tmf678.yml - type: Overlay url: overlays/mtn-group-tmf-service-activation-tmf678-overlay.yaml - aid: mtn-group:job-card-management name: MTN Job Card Management description: An API to share an incident tickets between Remedy and ServiceNow. humanURL: https://developers.mtn.com/products/job-card-management tags: - Customer - Nigeria properties: - type: Documentation url: https://developers.mtn.com/products/job-card-management - type: APIReference url: https://developers.mtn.com/products/job-card-management - type: OpenAPI url: openapi/mtn-group-job-card-management.yml - type: Overlay url: overlays/mtn-group-job-card-management-overlay.yaml baseURL: https://api.mtn.com - aid: mtn-group:ticket name: MTN Incident API description: An API to share an incident tickets between Remedy and ServiceNow. humanURL: https://developers.mtn.com/products/ticket baseURL: https://api.mtn.com/ tags: - Ticketing - Benin - Cameroon - Congo - Côte d'Ivoire properties: - type: Documentation url: https://developers.mtn.com/products/ticket - type: APIReference url: https://developers.mtn.com/products/ticket - type: OpenAPI url: openapi/mtn-group-ticket.yml - type: Overlay url: overlays/mtn-group-ticket-overlay.yaml - aid: mtn-group:mtn-sms-interface name: MTN SMS V2 description: Provides a RESTful API to expose SMS capability. humanURL: https://developers.mtn.com/products/mtn-sms-interface baseURL: https://api.mtn.com/v2/ tags: - Messaging - Côte d'Ivoire - Congo - Cameroon - Ghana properties: - type: Documentation url: https://developers.mtn.com/products/mtn-sms-interface - type: APIReference url: https://developers.mtn.com/products/mtn-sms-interface - type: OpenAPI url: openapi/mtn-group-mtn-sms-interface.yml - type: Overlay url: overlays/mtn-group-mtn-sms-interface-overlay.yaml - aid: mtn-group:sms-v3-api name: MTN SMS v3 API description: Provides a Restful API to expose SMS capability for sending of messages , Mobile originating messages and Delivery Receipts. humanURL: https://developers.mtn.com/products/sms-v3-api baseURL: https://api.mtn.com/v3/sms/ tags: - Messaging - Benin - Congo - Côte d'Ivoire - Cameroon properties: - type: Documentation url: https://developers.mtn.com/products/sms-v3-api - type: APIReference url: https://developers.mtn.com/products/sms-v3-api - type: OpenAPI url: openapi/mtn-group-sms-v3-api.yml - type: Overlay url: overlays/mtn-group-sms-v3-api-overlay.yaml - aid: mtn-group:sim-management-staging name: MTN SIM Management V1 description: This API provides a comprehensive suite of services for managing SIM-related operations, including SIM swap initiation, status tracking, eligibility checks, and resource management. It ensures secure and efficient handling of customer SIM lifecycle events. humanURL: https://developers.mtn.com/products/sim-management-staging baseURL: https://api.mtn.com/v1 tags: - Customer - Benin - Côte d'Ivoire - Cameroon - Congo properties: - type: Documentation url: https://developers.mtn.com/products/sim-management-staging - type: APIReference url: https://developers.mtn.com/products/sim-management-staging - type: OpenAPI url: openapi/mtn-group-sim-management-staging.yml - type: Overlay url: overlays/mtn-group-sim-management-staging-overlay.yaml - aid: mtn-group:sim-swap-verification-v1 name: MTN SIM Swap Verification V1 description: The SIM Swap Verification API provides information about an MSISDN's sim-swap details. Supported Operations 1. Get last SIM Swap date of a phone Number. humanURL: https://developers.mtn.com/products/sim-swap-verification-v1 baseURL: https://api.mtn.com/v1/mobile/phoneNumbers tags: - Customer - Benin - Cameroon - South Sudan properties: - type: Documentation url: https://developers.mtn.com/products/sim-swap-verification-v1 - type: APIReference url: https://developers.mtn.com/products/sim-swap-verification-v1 - type: OpenAPI url: openapi/mtn-group-sim-swap-verification-v1.yml - type: Overlay url: overlays/mtn-group-sim-swap-verification-v1-overlay.yaml - aid: mtn-group:subscriber-management name: MTN Subscriber Management description: This API to be used to manage a Subscriber information. humanURL: https://developers.mtn.com/products/subscriber-management baseURL: https://api.mtn.com/v1 tags: - Customer - Rwanda properties: - type: Documentation url: https://developers.mtn.com/products/subscriber-management - type: APIReference url: https://developers.mtn.com/products/subscriber-management - type: OpenAPI url: openapi/mtn-group-subscriber-management.yml - type: Overlay url: overlays/mtn-group-subscriber-management-overlay.yaml - aid: mtn-group:taxation-v1 name: MTN Taxation V1 description: This service provides comprehensive taxation management capabilities for MTN operations including tax calculation, validation, reporting, and compliance. It handles various taxation scenarios including service tax, VAT, and regulatory tax requirements, integrating with multiple tax systems across the MTN ecosystem. humanURL: https://developers.mtn.com/products/taxation-v1 baseURL: https://api.mtn.com/v1 tags: - Customer - Ghana properties: - type: Documentation url: https://developers.mtn.com/products/taxation-v1 - type: APIReference url: https://developers.mtn.com/products/taxation-v1 - type: OpenAPI url: openapi/mtn-group-taxation-v1.yml - type: Overlay url: overlays/mtn-group-taxation-v1-overlay.yaml - aid: mtn-group:tmf-trouble-ticket-tmf621 name: MTN TMF Trouble Ticket - TMF621 description: TMF621 Trouble Ticket Management Aggregator This service provides endpoint to fetch the ticket details with ticket id, create ticket, fetch list of tickets by customer id and update the existing tickets. humanURL: https://developers.mtn.com/products/tmf-trouble-ticket-tmf621 tags: - TM Forum - TMF621 - Benin - Congo - Cameroon - Liberia properties: - type: Documentation url: https://developers.mtn.com/products/tmf-trouble-ticket-tmf621 - type: APIReference url: https://developers.mtn.com/products/tmf-trouble-ticket-tmf621 - type: OpenAPI url: openapi/mtn-group-tmf-trouble-ticket-tmf621.yml - type: Overlay url: overlays/mtn-group-tmf-trouble-ticket-tmf621-overlay.yaml baseURL: https://api.mtn.com - aid: mtn-group:tmf629-customer-management name: MTN TMF629 - Customer Management description: This is Swagger UI environment generated for the TMF Customer Management specification. humanURL: https://developers.mtn.com/products/tmf629-customer-management tags: - TM Forum - TMF629 - South Africa - Ghana properties: - type: Documentation url: https://developers.mtn.com/products/tmf629-customer-management - type: APIReference url: https://developers.mtn.com/products/tmf629-customer-management - type: OpenAPI url: openapi/mtn-group-tmf629-customer-management.yml - type: Overlay url: overlays/mtn-group-tmf629-customer-management-overlay.yaml baseURL: https://api.mtn.com/tmf-api/customerManagement/v4 - aid: mtn-group:tmf637-product-inventory name: MTN TMF637 Product Inventory description: '**TMF API Reference : TMF 637 - Product Inventory Management**.' humanURL: https://developers.mtn.com/products/tmf637-product-inventory tags: - TM Forum - TMF637 - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/tmf637-product-inventory - type: APIReference url: https://developers.mtn.com/products/tmf637-product-inventory - type: OpenAPI url: openapi/mtn-group-tmf637-product-inventory.yml - type: Overlay url: overlays/mtn-group-tmf637-product-inventory-overlay.yaml baseURL: https://api.mtn.com/tmf-api/productInventory/v4 - aid: mtn-group:account-management-coe name: MTN Account Management - COE description: TMF666 Account Management API with MTN extensions to retrieve financial account transactions, transaction details, outstanding balances, account balances. humanURL: https://developers.mtn.com/products/account-management-coe baseURL: https://api.mtn.com/tmf-api/financialProfile/v1 tags: - Customer - TMF666 - TM Forum - South Africa properties: - type: Documentation url: https://developers.mtn.com/products/account-management-coe - type: APIReference url: https://developers.mtn.com/products/account-management-coe - type: OpenAPI url: openapi/mtn-group-account-management-coe.yml - type: Overlay url: overlays/mtn-group-account-management-coe-overlay.yaml - aid: mtn-group:tmf-payment-management-tmf676 name: MTN TMF Payment Management - TMF676 description: TMF676 Payment Management Aggregator API provides comprehensive payment management capabilities following TM Forum TMF676 standards. This service enables payment processing, payment method management, payment status tracking, and payment reconciliation operations. It serves as the central aggregator for all payment-related operations,... humanURL: https://developers.mtn.com/products/tmf-payment-management-tmf676 baseURL: https://api.mtn.com/v1 tags: - TM Forum - TMF676 - Benin properties: - type: Documentation url: https://developers.mtn.com/products/tmf-payment-management-tmf676 - type: APIReference url: https://developers.mtn.com/products/tmf-payment-management-tmf676 - type: OpenAPI url: openapi/mtn-group-tmf-payment-management-tmf676.yml - type: Overlay url: overlays/mtn-group-tmf-payment-management-tmf676-overlay.yaml - aid: mtn-group:resource-pool-management name: MTN TMF Resource Pool Management - TMF685 description: This API provides the option to reserver MSISDN for registration and also validate starter pack pairing. humanURL: https://developers.mtn.com/products/resource-pool-management tags: - TM Forum - TMF685 - Benin - Côte d'Ivoire - Eswatini - Zambia properties: - type: Documentation url: https://developers.mtn.com/products/resource-pool-management - type: APIReference url: https://developers.mtn.com/products/resource-pool-management - type: OpenAPI url: openapi/mtn-group-resource-pool-management.yml - type: Overlay url: overlays/mtn-group-resource-pool-management-overlay.yaml baseURL: https://ugandaprod.api.mtn.com/drm/resource-pool/v1 - aid: mtn-group:tmf-usage-consumption-tmf677 name: MTN TMF Usage Consumption - TMF677 description: API to fetch Airtime, Currency, Voice, Data and SMS balance details for a subscriber. humanURL: https://developers.mtn.com/products/tmf-usage-consumption-tmf677 baseURL: https://api.mtn.com/usageConsumption/v1/ tags: - TM Forum - TMF677 - Côte d'Ivoire - South Sudan properties: - type: Documentation url: https://developers.mtn.com/products/tmf-usage-consumption-tmf677 - type: APIReference url: https://developers.mtn.com/products/tmf-usage-consumption-tmf677 - type: OpenAPI url: openapi/mtn-group-tmf-usage-consumption-tmf677.yml - type: Overlay url: overlays/mtn-group-tmf-usage-consumption-tmf677-overlay.yaml - aid: mtn-group:usage-consumption name: MTN Usage Consumption V1 description: API to fetch Airtime, Currency, Voice, Data and SMS balance details for a subscriber. humanURL: https://developers.mtn.com/products/usage-consumption baseURL: https://api.mtn.com/usageConsumption/v1/ tags: - Customer - Rwanda properties: - type: Documentation url: https://developers.mtn.com/products/usage-consumption - type: APIReference url: https://developers.mtn.com/products/usage-consumption - type: OpenAPI url: openapi/mtn-group-usage-consumption.yml - type: Overlay url: overlays/mtn-group-usage-consumption-overlay.yaml - aid: mtn-group:momo-collection name: MTN MoMo Collection API description: Enable remote collection of bills, fees or taxes from consumer and business MoMo wallets. Operations include RequestToPay, invoices, pre-approvals, delivery notification, account balance and account holder validation, plus a bc-authorize backchannel consent flow. humanURL: https://momodeveloper.mtn.com/api-documentation baseURL: https://sandbox.momodeveloper.mtn.com/collection tags: - Mobile Money - Payments - Collections properties: - type: Documentation url: https://momodeveloper.mtn.com/api-documentation - type: APIReference url: https://momodeveloper.mtn.com/apis - aid: mtn-group:momo-disbursement name: MTN MoMo Disbursements API description: Disburse payments from a business MoMo wallet to consumers or other businesses — salary payments, benefits disbursement and supplier payouts — with deposit, refund, transfer and transaction-status operations. humanURL: https://momodeveloper.mtn.com/api-documentation baseURL: https://sandbox.momodeveloper.mtn.com/disbursement tags: - Mobile Money - Payments - Disbursements properties: - type: Documentation url: https://momodeveloper.mtn.com/api-documentation - type: APIReference url: https://momodeveloper.mtn.com/apis - aid: mtn-group:momo-remittance name: MTN MoMo Remittance API description: Transfer funds into MTN MoMo wallets from remittance originators, including cash transfer, transfer, account balance and account holder validation operations. humanURL: https://momodeveloper.mtn.com/api-documentation baseURL: https://sandbox.momodeveloper.mtn.com/remittance tags: - Mobile Money - Remittance - Payments properties: - type: Documentation url: https://momodeveloper.mtn.com/api-documentation - type: APIReference url: https://momodeveloper.mtn.com/apis - aid: mtn-group:momo-sandbox-user-provisioning name: MTN MoMo Sandbox User Provisioning API description: Provision sandbox API users and API keys for the MTN MoMo Open API test environment, the self-serve step that lets a developer obtain credentials before calling Collection, Disbursements or Remittance. humanURL: https://momodeveloper.mtn.com/api-documentation baseURL: https://sandbox.momodeveloper.mtn.com tags: - Mobile Money - Sandbox - Onboarding properties: - type: Documentation url: https://momodeveloper.mtn.com/api-documentation - type: APIReference url: https://momodeveloper.mtn.com/apis common: - type: AgenticAccess url: agentic-access/mtn-group-agentic-access.yml - type: DomainSecurity url: security/mtn-group-domain-security.yml - type: OAuthScopes url: scopes/mtn-group-scopes.yml - type: Authentication url: authentication/mtn-group-authentication.yml - type: Website url: https://www.mtn.com/ - type: DeveloperPortal url: https://developers.mtn.com/ - type: Documentation url: https://developers.mtn.com/getting-started - type: APIReference url: https://developers.mtn.com/products - type: DeveloperPortal url: https://momodeveloper.mtn.com/ - type: Documentation url: https://momodeveloper.mtn.com/api-documentation - type: SignUp url: https://developers.mtn.com/register - type: SignUp url: https://momodeveloper.mtn.com/signup - type: Authentication url: https://developers.mtn.com/getting-started - type: FAQ url: https://developers.mtn.com/faq - type: Support url: https://developers.mtn.com/contact - type: TermsOfService url: https://developers.mtn.com/terms-and-conditions - type: PrivacyPolicy url: https://developers.mtn.com/privacy-policy - type: GitHubOrganization url: https://github.com/MTN-Group - type: LinkedIn url: https://www.linkedin.com/company/mtn/ - type: Twitter url: https://twitter.com/MTNGroup - type: YouTube url: https://www.youtube.com/user/TheMTNGroup - type: GettingStarted url: https://developers.mtn.com/getting-started - type: Blog url: https://www.mtn.com/news/ - type: Community url: https://momodevelopercommunity.mtn.com/ - type: Support url: https://momodeveloper.mtn.com/contact-support - type: Login url: https://developers.mtn.com/login - type: APIReference url: https://momodeveloper.mtn.com/API-collections - type: BestPractices url: https://momodeveloper.mtn.com/best-practices - type: ErrorCodes url: https://developers.mtn.com/getting-started/response-and-error-codes - type: Packages url: packages/mtn-group-packages.yml - type: MCPServer url: mcp/mtn-group-mcp.yml - type: ToolCrosswalk url: mcp/mtn-group-tool-crosswalk.yml - type: LLMsTxt url: llms/mtn-group-llms.txt - type: Conformance url: conformance/mtn-group-conformance.yml - type: ErrorCatalog url: errors/mtn-group-error-codes.yml - type: DeclineCodes url: errors/mtn-group-decline-codes.yml - type: Lifecycle url: lifecycle/mtn-group-lifecycle.yml - type: Deprecation url: https://developers.mtn.com/getting-started/things-every-developer-should-know - type: Sandbox url: sandbox/mtn-group-sandbox.yml - type: Conventions url: conventions/mtn-group-conventions.yml - type: Idempotency url: conventions/mtn-group-conventions.yml - type: Components url: components/mtn-group-components.yml - type: DataModel url: data-model/mtn-group-data-model.yml - type: Webhooks url: asyncapi/mtn-group-webhooks.yml - type: AgentSkill url: skills/_index.yml - type: AgentSkill url: skills/mtn-group-send-sms.md name: Send an SMS and track delivery - type: AgentSkill url: skills/mtn-group-collect-a-payment.md name: Collect and reconcile a payment - type: AgentSkill url: skills/mtn-group-momo-request-to-pay.md name: Request a MoMo payment and handle the callback - type: AgentSkill url: skills/mtn-group-place-a-product-order.md name: Place a TM Forum product order - type: AgentSkill url: skills/mtn-group-manage-subscriptions.md name: Subscribe a customer to a value-added service maintainers: - FN: Kin Lane email: kin@apievangelist.com