How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

MTN Group Products API

The products API from MTN Group — 13 operation(s) for products.

MTN Group Products API is one of 148 APIs that MTN Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Product. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 13 operations across 13 paths, and defines 52 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://www.api.mtn.com, https://api.mtn.com/v3.

13 operations 13 paths 52 schemas 11 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.mtn.com/accountDecisioning/v1
Authentication
API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 2

MTN Group Products API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-Key (ApiKeyAuth). It supports OAuth 2.0 (OAuth2) using the clientCredentials flow.

Paths & Operations 13

Across 13 paths, the API surfaces 13 operations — 11 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

products 13
GET
/products/{customerId}
View product catalogue.
1 param → 200400401403404405500
GET
/products
View product Catalog
9 params → 200400401403404405500
GET
/products/{customerId}/{productId}
Retrieve the details of a given product - Query bundle price
5 params → 200400401403404405500
GET
/products/{customerId}/eligibility/{productId}
Check the eligibility of a customer to buy a product
10 params → 200400401403404405500
POST
/products/{customerId}/blacklist/{productId}
Blacklist the customer to consume a product
4 params body → 200400401403404405500
POST
/products/{customerId}/dormant
Make a customer dormant in relation to a to a product
3 params body → 200400401403404405500
GET
/products/{customerId}/category
Get product Category
getProductCategory 5 params → 200400401403404405406415
GET
/products/{customerId}/eligible
Get list of eligible Offers
getOffers 10 params → 200400401403404405406415
GET
/products/productOffering
List or find ProductOffering objects
listProductOffering 5 params → 200400401403404405409500
GET
/products/productOffering/roaming
List of roaming ProductOffering objects
listofRoamingproducts 6 params → 200400401404
GET
/products/{id}/comvCatalogue
List or find ProductCatalogue objects
listProductCatalogue 3 params → 200400401403404405409500
GET
/products/productConfiguration/{id}
productConfiguration
configuration 5 params → 200400401403404405500
GET
/products/{customerId}/productCheckBalance
Get All Type of balance for a subscriber product
getAllTypesOfbalances 6 params → 200400401403404405406415

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are AdditionalInformation (66 properties), PlanMapping (43 properties), ProductCatalogData (38 properties), OtherProduct (19 properties). Each schema is shown below with its type and property counts.

Error
object
5 properties
Data
object
3 properties
Product
object
The product a customer can purchase.
6 properties 3 required
ErrorDefault
object
2 properties
ProductFrequency
object
4 properties 1 required
Links
object
1 property 1 required
ProductCatalogue
object
2 properties 2 required
Error400
object
4 properties
FallBackPlanChildResponse
object
Displays the freebies associated with the plan
15 properties
digitalProductsResponse
object
1 property
DormantRequest
object
4 properties
OfferCategoryResponse
object
6 properties
ProductFrequency_2
object
5 properties 1 required
Response_ProductCatalogue
object
6 properties 4 required
ProductOfferingTerm
Contains Offer Freebies details
ProductCatalogData
object
38 properties 1 required
roamingProductOffering
object
6 properties 5 required
RenewalFallBackPlanResponse
object
17 properties
OtherProduct
object
The product a customer can purchase.
19 properties 3 required
FallBackPlanResponse
object
16 properties
ProductEligibilityResponse
object
11 properties 1 required
Error401
object
5 properties
ProductSpecificationCharacteristicValue
object
A ProductSpecificationCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a…
5 properties
BlacklistRequest
object
4 properties
ConsentChannel
object
Represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
4 properties
ProductInfo
object
11 properties
checkBalanceResponse
object
6 properties
Product_2
object
The product a customer can purchase.
15 properties 3 required
Response_ProductOffering
object
9 properties 5 required
ProductBalances
object
7 properties
AdditionalInformation
object
Additional information related to the item details.
66 properties
Error_2
object
6 properties
ProductCatalogue_2
object
6 properties 4 required
RenewalFallBackPlanChildResponse
object
Displays the freebies associated with the plan
16 properties
ProductBundlePrice
object
4 properties 1 required
OthersProductFrequency
object
6 properties 1 required
Data_2
object
11 properties 6 required
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
OfferResponse
object
6 properties
BeareList
object
Represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
3 properties
PlanMsgList
object
7 properties
OfferCategory
array
PlanMapping
object
Represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
43 properties 3 required
Error404
object
1 property
productConfigurationResponse
object
5 properties
ProductSpecificationCharacteristicValueUse
object
A use of the ProductSpecificationCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of simil…
11 properties
roamingProducts
object
Displays the roaming bundles that are available for the country and subscriber type.
14 properties
Freebies
object
Displays the freebies associated with the plan
5 properties
Money
object
A base / value business entity used to represent money
2 properties
ProductSpecificationRef
object
7 properties
MessageList
object
6 properties
ProductOffering
object
Represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
15 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mtn-group-products-api-openapi.yml Raw ↑

Other APIs MTN Group publishes across the network.

MTN MoMo Collection API
MTN MoMo Disbursements API
MTN MoMo Remittance API
MTN MoMo Sandbox User Provisioning API
MTN Group Accessible to 3PP API
MTN Group Accessible to USSD Gateway API
MTN Group Activation API
MTN Group Add User API
MTN Group Admin Suspend API
MTN Group Adverts API
MTN Group Advice Reconcile API
MTN Group Agents API
Where this information came from

This is an independent, third-party profile of MTN Group Products API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.