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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
MTN Group

MTN Group Customers API

The Customers API from MTN Group — 21 operation(s) for customers.

Documentation Provider Profile APIs.io OpenAPI GitHub

MTN Group Customers 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 Customers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

Requests are made against 2 base URLs: https://api.mtn.com/v2, https://api.mtn.com/v1.

25 operations 21 paths 97 schemas 2 DELETE16 GET3 PATCH4 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 Customers 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 25

Across 21 paths, the API surfaces 25 operations — 2 DELETE, 16 GET, 3 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Customers 25
POST
/customers/{customerId}/loans/advance
Gets a loan advance.
getLoanAdvance 1 param body → 200401403404
GET
/customers/{customerId}/loans/advance/status
Gets loan advance status.
getLoanAdvanceStatus 2 params → 200401403404
GET
/customers/{customerId}/loans/eligibleBundle
Retrieves the list of eligible loan.
checkLoanEligibility 2 params → 200401403404
GET
/customers/{customerId}/locations
View customer locations
Retrieves the Location details of an MTN customer 1 param → 200400401403404405500
GET
/customers/{id}/plans/FRI
Retrieves a customers FRI
getFRIUsingPOST 4 params body → 200400401403404405500
PATCH
/customers/{id}/plans/FRI/state
Block and Unblock operations are initiated on Customer FRI
UpdateFRIUsingPATCH 6 params body → 200400401403404405500
GET
/customers/{customerId}/plans
View customer plans
15 params → 200207400401403404405500
PATCH
/customers/{customerId}/plans
Tariff plan migration
trariffMigration 2 params body → 200400401403404500503999
GET
/customers/{customerId}/plans/{productCode}
View customer plans for product
2 params → 200207400401403
PATCH
/customers/{customerId}/plans/refill
Airtime Refill
refillAccount 5 params body → 200400401403404500503999
POST
/customers/{id}/plans/provision
Provision the customer and return customer details along with MSISDN
getCustomerDetails 4 params body → 200400401404415500
GET
/customers/{customerId}
View customer profile
4 params → 200207400401403404405500
GET
/customers/upgrade-eligibility/{customerId}
Get customer’s upgrade eligibility
1 param body → 200400401403404405406415
GET
/customers/{customerId}/tenure
Get customer’s tenure
3 params → 200400401403404405406415
GET
/customers/{customerId}/activityStatus
Get customer’s activity status
3 params → 200400401403404405406415
GET
/customers/{customerId}/score
Get Customer score.
getCustomerScore 12 params → 200401403404
POST
/customers/{customerId}/score/creditinfo
Sends Credit Information to CRC
credit-info 2 params body → 200400401403404405409500
GET
/customers/{customerId}/subscriptions
List all Subscriptions
List all Subscriptions 3 params → 200207400401403404405500
POST
/customers/{customerId}/subscriptions
Subscribe the customer to a new service
Subscribe the customer to a new service 4 params body → 201202400401403404405500
DELETE
/customers/{customerId}/subscriptions
Unsubscribe All Subscriptions for a Customer
Delete All subscriptions 3 params body → 200400401403404405500
GET
/customers/{customerId}/subscriptions/{subscriptionId}
Get Subscription details
Get Subscription Details 4 params → 200400401403404405500
DELETE
/customers/{customerId}/subscriptions/{subscriptionId}
Unsubscribe a specific subscription
Delete a specific subscription 4 params → 200400401403404405500
GET
/customers/{customerId}/subscriptions/{subscriptionId}/status/{statusId}
Get provisioning status of a recently added Subscription
Get Subscription Provisioning Status 5 params → 200400401403404405500
GET
/customers/{customerId}/subscriptions-providers
Retrieve subscription providers
Retrieve subscription providers 2 params → 200400401403404405500
GET
/customers/list/subscriptions
List of offers per menu code
List of offers per menu code 7 params → 200

Schemas 97

The contract defines 97 schemas that model the data the API accepts and returns. The most detailed are AdditionalInformationBody (61 properties), creditInfo (25 properties), guarantorInfo (19 properties), principalInfo (17 properties). Each schema is shown below with its type and property counts.

LoanStatusResponse
object
5 properties
LoanAdvanceResponse
object
5 properties
Amount
object
4 properties
LoanEligibilityTypes
object
2 properties
LoanProvisioningDetails
object
4 properties
Error
object
6 properties 2 required
EligibilityResponse
object
6 properties
CustomerLocations
object
2 properties 1 required
ErrorDefault
object
2 properties
Locations
object
3 properties 3 required
CustomerLinks
object
1 property 1 required
Error_2
object
5 properties
Error400
object
5 properties
UpdateFRIResponse
object
4 properties
Plans
object
The plan details for the customer.
11 properties 7 required
LoyaltyBalances
object
Contains all the loyalty balances associated with a customer.
3 properties
BalanceDetail
object
The details for a balance type.
5 properties 3 required
UsageThreshold
object
4 properties
GetFRIRequest
object
3 properties
UsageCounterUsageThreshold
object
2 properties
Accumulator
object
4 properties
Error401
object
5 properties
Error415
object
5 properties
AdditionalInformationBody
object
61 properties
CustomerBalance
object
The plan balance details for the customer.
8 properties 4 required
Links
object
1 property
Error_3
object
8 properties 2 required
MomoBalanceDetail
object
The MoMo Balance details for a requested customer.
6 properties
CustomerPlans
object
7 properties 1 required
UsageCounter
object
4 properties
Wallet
object
The details for a wallet account.
4 properties 4 required
OfferDetails
object
The Offer Details per customer.
5 properties
Amount_2
object
The amount details for a wallet.
3 properties 3 required
UpdateFRIRequest
object
3 properties
Error500
object
6 properties
provisionResponse
object
6 properties
OverdraftInformation
object
Contains overdraft balances if available
4 properties
customerDetails_Request
object
11 properties 1 required
Error404
object
5 properties
GetFRIResponse
object
4 properties
Plans_2
object
The plan details for the customer.
8 properties 5 required
Locations_2
object
2 properties 2 required
billPayments
object
5 properties
received
object
2 properties
GenderEnum
string
Loans
object
The loans details of a customer, if it exists
3 properties 1 required
ErrorNew
object
6 properties 2 required
CustomerUpgradeEligibilityResponse
object
5 properties
transfers
object
2 properties
tenure
object
1 property
timePeriodEnum
string
a time period for which data is available. Usually data is available for multiple time periods, like 1 month, 3 month, and 6 month. Each time period will be re…
Any
links
object
1 property
AccountRef
object
2 properties
send
object
5 properties
Error_4
object
5 properties
deposits
object
5 properties
CustomerProfile
object
7 properties 2 required
status
object
1 property
CustomerLoans
object
2 properties 1 required
CustomerPlans_2
object
3 properties 1 required
momo-loans
object
8 properties
KYC
object
2 properties
UpgradeEligibilityParams
object
Describes a given characteristic of an object or entity through a name/value pair.
3 properties 2 required
CustomerCharacteristics
object
Describes a given characteristic of an object or entity through a name/value pair.
4 properties 2 required
CustomerBalances
object
1 property
activity
object
Actvity related to GSM calls, data bundles, and airtime
3 properties
withdrawals
object
5 properties
CustomerStatusResponse
object
5 properties
transactions-summaries
object
3 properties
Customer
object
14 properties 2 required
CustomerTenureResponse
object
5 properties
Upgrade
object
1 property
Devices
object
2 properties
businessInfo
object
8 properties
ErrorResponseBody
object
An response body that defines the structure of an error
6 properties
guarantorInfo
object
19 properties
CreditInfoRequest
object
1 property
creditInfo
object
25 properties
principalInfo
object
17 properties
Error_5
object
7 properties 2 required
SubscriptionTypeEnum
string
Callback
object
2 properties
CustomerSubscriptionProvider
object
2 properties
Subscription
object
16 properties 3 required
ServiceDetails
object
3 properties
StatusEnum
string
SubscriptionStatusEnum
string
OffersPerMenuCode
object
4 properties
SubscriptionServices
object
3 properties
Unsubscribe
object
5 properties 3 required
SubscriptionServicesProviders
object
3 properties
CustomerSubscription
object
2 properties
SubscribeAsync
object
5 properties 3 required
subscription
object
15 properties 3 required
SubscriptionDetails
object
15 properties
Error_6
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs MTN Group publishes across the network.

MTN MoMo Collection API
AE Profile APIs.io
MTN MoMo Disbursements API
AE Profile APIs.io
MTN MoMo Remittance API
AE Profile APIs.io
MTN MoMo Sandbox User Provisioning API
AE Profile APIs.io
MTN Group Accessible to 3PP API
AE Profile APIs.io
MTN Group Accessible to USSD Gateway API
AE Profile APIs.io
MTN Group Activation API
AE Profile APIs.io
MTN Group Add User API
AE Profile APIs.io
MTN Group Admin Suspend API
AE Profile APIs.io
MTN Group Adverts API
AE Profile APIs.io
MTN Group Advice Reconcile API
AE Profile APIs.io
MTN Group Agents API
AE Profile APIs.io
#Customers
← Back to M APIs
API Details
ID
mtn-group:mtn-group-customers-api
Base URL
https://api.mtn.com/accountDecisioning/v1
Docs
https://developers.mtn.com/products/account-decisioning
Provider
MTN Group
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=mtn-group-customers-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/mtn-group-customers-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of MTN Group Customers 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.