MTN Group
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.
MTN Group publishes 115 APIs on the APIs.io network, including MTN Account Decisioning, MTN TMF Customer Bill Management - TMF678, MTN Loans, and 112 more. Tagged areas include Telecommunications, South Africa, Africa, Mobile Network Operator, and Network APIs.
The MTN Group catalog on APIs.io includes 1 event-driven AsyncAPI specification.
MTN Group’s developer surface includes authentication, documentation, API reference, signup flow, FAQ, support, YouTube channel, and 43 more developer resources.
119 APIs
1 MCP Servers
TelecommunicationsSouth AfricaAfricaMobile Network OperatorNetwork APIsOpen GatewayTM ForumBSSMobile MoneyMessagingSMSUSSDIoTSIM SwapIdentity VerificationPayments
Individual APIs this provider publishes, each with its own machine-readable definition.
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.
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 (a...
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 Inve...
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 activi...
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 Se...
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 co...
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 th...
callmeback API will be used to post a request in AYO, when initiated by Users via different Applications like "portal", "IVR" etc.
callmeback API will be used to post a request to Backend systems when initiated by Users via different Applications like "portal", "IVR" etc.
This API Provides a capability to create and send communications, notifications, and instructions to Parties, Individuals, Organizations or Users.
This is Swagger UI environment generated for the TMF Communication Management specification.
This is Swagger UI environment generated for the TMF Communication Management specification.
A suite of apis for customer consent validation.
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.
To facilitate the capability for consumers to retrieve bill information at service level , account level or invoice level etc.
To register services and activate services content tokens.
The Data Gifting API facilitates purchase of data product for Beneficiary subscriber(Customer) and charging shall be done from Charging system using Requesting subscriber(Sponso...
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 man...
To retrieve and schedule delivery information for MTN Customers.
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 Customer KYC Consent API facilitates the consent from the customer while capturing and retrieval of Customer Information. This aggregator service provides comprehensive Know...
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**...
An API to Create customers,create admin users,activate/deactivate,disable Sims.
To facilitate the capability for customer to create/validate/change Pin Information.
The API facilitates product survey with a MTN Customer.
API will enable MTN customers to transfer part of their active airtime or data to another MTN customer. This service excludes special data plans.
API will enable MTN customers to transfer part of their active airtime or data to another MTN customer. This service excludes special data plans.
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 p...
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...
TM Forum Open APIs (Apache 2.0) Party Management API Provides standardized mechanism for digital partner management such as creation, update, retrieval, deletion and notificatio...
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,...
This is Swagger UI environment generated for the TMF Document Management specification.
The Event Management API provides a standardized client interface to the enterprise event management system.
This API provides EEC Token Management.
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 re...
This service provides comprehensive IoT device management capabilities for TMF908 operations including device information retrieval, device management operations, and lifecycle ...
Facility to query failed transactions.
The TMForum Loyalty API Specification as developed by Globetom.
This API provides ability to check the capability of an MSISDN to receive RCS mesages.
Provides a RESTful API to expose SMS capability.
This service provides comprehensive mobile advertisement management capabilities for MTN operations including ad targeting, content delivery, campaign management, and performanc...
A brief description of the API. It can be multiple lines.
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'...
To facilitate the capability for consumers to realize withdrawals via MADAPI. The callback (i.. Completed) will be handled via MADAPI's callback API.
A suite of apis for customer validation.
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 ...
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 http...
This API manages tasks for an MTN customer.
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.
The Customer KYC(Know Your Client) Verification API will validate the 3PP Customer KYC information with MTN Customer KYC information.
This API facilitate loan in advance for an MTN customer.
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.
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://de...
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...
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 ht...
This API assesses risks for an MTN customer as well as creates applications.
This API is used to determine the customer's score through an activities performed within a period of time.
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 ver...
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 p...
API to provide capability to manage Offering specification of products.
Generates an access token based on username and password.
To enable merchants to manage purchases of subscribers.
MTN SMS Messaging API allowing developers to include SMS messaging in their applications.
Provides a RESTful API to expose USSD capability.
A MTN API that controls the display of the catalog of Products available for a customer to purchase.
A MTN API that controls the display of the catalog of Products available for a customer to purchase.
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 Res...
The Shopping Cart API provides a standardized mechanism for the management of shopping carts. Including creation, update, retrieval.
This API assesses risks for an MTN customer as well as creates applications.
This service provides comprehensive party management capabilities for MTN customers including individual and organization management, credit information, and partner services. I...
This service provides comprehensive usage management capabilities for MTN operations including data usage tracking, subscription management, balance inquiries, and usage analyti...
This service provides comprehensive usage management capabilities for MTN operations including data usage tracking, subscription management, balance inquiries, and usage analyti...
Interface to the Apigee Cloud MTN-ID userinfo function.
To facilitate notifications. Allows 3PPs to register and have notifications processed to them from the applicable backends.
To facilitate notifications. Allows 3PPs to register and have notifications processed to them from the applicable backends.
This API provides ability to digital channel to purchase different offers and make payment through Netbanking or Card Payments.
**TMF API Reference : TMF - 683 Party Interaction** **Release : 19.5 - Oct 2019** The Party Interaction Management API provides a mechanism to manage party interactions. Creatio...
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...
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...
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-...
This is the Payment API for MADAPI. Handles payment use cases such as spTransfer, Debit request, Payment request, and related financial transactions. Provides comprehensive paym...
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 lin...
API to provide capability to manage catalog, category, Offerings, Offering price and specification of products.
API to provide capability to manage catalog, category, Offerings, Offering price and specification of products.
API to provide capability to manage catalog, category, Offerings, Offering price and specification of products.
API to provide capability to manage catalog, category, Offerings, Offering price and specification of products.
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...
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...
API to provision,configure and activate Resource Functions.
This is Swagger UI environment generated for the TMF Resource Ordering Management specification.
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 configura...
An API to share an incident tickets between Remedy and ServiceNow.
An API to share an incident tickets between Remedy and ServiceNow.
Provides a RESTful API to expose SMS capability.
Provides a Restful API to expose SMS capability for sending of messages , Mobile originating messages and Delivery Receipts.
This API provides a comprehensive suite of services for managing SIM-related operations, including SIM swap initiation, status tracking, eligibility checks, and resource managem...
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.
This API to be used to manage a Subscriber information.
This service provides comprehensive taxation management capabilities for MTN operations including tax calculation, validation, reporting, and compliance. It handles various taxa...
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 up...
This is Swagger UI environment generated for the TMF Customer Management specification.
**TMF API Reference : TMF 637 - Product Inventory Management**.
TMF666 Account Management API with MTN extensions to retrieve financial account transactions, transaction details, outstanding balances, account balances.
TMF676 Payment Management Aggregator API provides comprehensive payment management capabilities following TM Forum TMF676 standards. This service enables payment processing, pay...
This API provides the option to reserver MSISDN for registration and also validate starter pack pairing.
API to fetch Airtime, Currency, Voice, Data and SMS balance details for a subscriber.
API to fetch Airtime, Currency, Voice, Data and SMS balance details for a subscriber.
Enable remote collection of bills, fees or taxes from consumer and business MoMo wallets. Operations include RequestToPay, invoices, pre-approvals, delivery notification, accoun...
Disburse payments from a business MoMo wallet to consumers or other businesses — salary payments, benefits disbursement and supplier payouts — with deposit, refund, transfer and...
Transfer funds into MTN MoMo wallets from remittance originators, including cash transfer, transfer, account balance and account holder validation operations.
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, Disb...
Model Context Protocol servers that expose these APIs to AI agents.
AsyncAPI definitions for this provider's event-driven and streaming APIs.
Authentication, domain security, vulnerability disclosure, and trust-center signals.
OAuth scopes governing access to this provider's APIs.
Recommended x-agentic-access execution contracts for AI agents.
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
-
# --- truncated at 32 KB (94 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mtn-group/refs/heads/main/apis.yml