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 Customer Promotion

API Documentation.

MTN Customer Promotion 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, Ghana, Nigeria, and South Africa. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 18 schemas. It is described by OpenAPI 2.0, at version 0.1.

Requests are made against the base URL https://za.api.mtn.com/customerPromotion/v1.

3 operations 3 paths 18 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
0.1
Base URL
https://za.api.mtn.com/customerPromotion/v1
Authentication
API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 2

MTN Customer Promotion 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 3

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

Customer Promotion 3
GET
/tbd/promo
some function here
→ 200
GET
/eligibilityCheck/{msisdn}
ELigibility check of customer.
getUserProfile 3 params → 200400401404415500
POST
/optin
This API is used to optin users on campaigns
3 params → 200400401404415500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are reward1 (13 properties), reward (13 properties), eligibilityCheckResponse (10 properties), Draw (8 properties). Each schema is shown below with its type and property counts.

eligibilityCheckResponse
object
10 properties
optinRequest
optinResponse
balanceType
object
status: DAILY - Daily plays awarded LOYALTYSPEND1 - plays awarded for loyalty points redeptions of less than 50 points LOYALTYSPEND2 - plays awarded for loyalt…
2 properties 2 required
category1
Draw
object
drawStatus: OPEN - The draw is accepting entries CLOSED - The draw is no longer accepting entries LIVE - The draw winners are being announced
8 properties 6 required
History
object
4 properties 4 required
Recharges
object
4 properties 4 required
RechargeOptions
object
2 properties 2 required
reward1
object
source: DAILY - A prize won when playing the game using daily plays LOYALTYSPEND1 - A prize won when playing the game using low value loyalty spend plays LOYAL…
13 properties
reward
object
source: DAILY - A prize won when playing the game using daily plays LOYALTYSPEND1 - A prize won when playing the game using low value loyalty spend plays LOYAL…
13 properties
LogHistory
object
4 properties
Error400
object
4 properties
Error401
object
5 properties
Error404
object
5 properties
Error405
object
5 properties
Error415
object
5 properties
Error500
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mtn-group-customer-promotion.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 Customer Promotion, 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.