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 Product Offering v3

A MTN API that controls the display of the catalog of Products available for a customer to purchase.

MTN Product Offering v3 is one of 119 APIs that MTN Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Customers, Benin, Congo, Côte d’Ivoire, and Cameroon. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 13 operations across 13 paths, and defines 48 schemas. It is described by OpenAPI 2.0, at version 3.0.9.

Requests are made against the base URL https://api.mtn.com/v3.

13 operations 13 paths 48 schemas 11 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
3.0.9
Base URL
https://api.mtn.com/v3
Authentication
API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 2

MTN Product Offering v3 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 application flow. By default, every request must be authenticated.

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
View product Catalog
9 params → 200400401403404405500
GET
/products/{customerId}
View product Catalog.
15 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
5 params → 200400401403404405500
POST
/products/{customerId}/dormant
Make a customer dormant in relation to a to a product
4 params → 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 48

The contract defines 48 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.

Response_ProductOffering
object
9 properties 5 required
roamingProductOffering
object
6 properties 5 required
roamingProducts
object
Displays the roaming bundles that are available for the country and subscriber type.
14 properties
Money
object
A base / value business entity used to represent money
2 properties
ProductOffering
object
Represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
15 properties
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
ProductOfferingTerm
Contains Offer Freebies details
Freebies
object
Displays the freebies associated with the plan
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
ProductSpecificationRef
object
7 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
ProductInfo
object
11 properties
OfferCategory
array
OfferCategoryResponse
object
6 properties
OfferResponse
object
6 properties
ProductCatalogue
object
6 properties 4 required
Links
object
1 property 1 required
Data
object
11 properties 6 required
ProductFrequency
object
5 properties 1 required
OthersProductFrequency
object
6 properties 1 required
ProductBundlePrice
object
4 properties 1 required
Product
object
The product a customer can purchase.
15 properties 3 required
AdditionalInformation
object
Additional information related to the item details.
66 properties
OtherProduct
object
The product a customer can purchase.
19 properties 3 required
ProductEligibilityResponse
object
11 properties 1 required
Error
object
6 properties
Response_ProductCatalogue
object
6 properties 4 required
ProductCatalogData
object
38 properties 1 required
PlanMapping
object
Represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
43 properties 3 required
FallBackPlanResponse
object
16 properties
FallBackPlanChildResponse
object
Displays the freebies associated with the plan
15 properties
RenewalFallBackPlanResponse
object
17 properties
RenewalFallBackPlanChildResponse
object
Displays the freebies associated with the plan
16 properties
PlanMsgList
object
7 properties
MessageList
object
6 properties
BeareList
object
Represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
3 properties
ConsentChannel
object
Represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
4 properties
BlacklistRequest
object
4 properties
DormantRequest
object
4 properties
Response_AcsProductResponse
object
5 properties 4 required
AcsProductResponseData
object
10 properties 10 required
productConfigurationResponse
object
5 properties
digitalProductsResponse
object
1 property
checkBalanceResponse
object
6 properties
ProductBalances
object
7 properties
Error400
object
4 properties
Error401
object
5 properties
Error404
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mtn-group-mtn-product-offering-api-v3.yml Raw ↑

Other APIs MTN Group publishes across the network.

MTN Account Decisioning
MTN TMF Customer Bill Management - TMF678
MTN Loans
MTN Subscriber Details
MTN Subscriber Type
MTN Provisioning
MTN Unified Balance V1
MTN TMF Resource Inventory Management - TMF639
MTN Sales Lead
MTN Service Activation and Configuration
MTN Service Ordering
MTN BSS TT OAuth V1
Where this information came from

This is an independent, third-party profile of MTN Product Offering v3, 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.