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 Customer Bill API

The customerBill API from MTN Group — 2 operation(s) for customerbill.

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

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

Requests are made against 2 base URLs: https://api.mtn.com/v1, https://serverRoot/tmf-api/customerBillManagement/v4/.

3 operations 2 paths 44 schemas 2 GET1 PATCH

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 Customer Bill 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 3

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

customerBill 3
GET
/customerBill
List or find CustomerBills
listCustomerBill 13 params → 200400401403404405500
GET
/customerBill/{id}
Retrieves a CustomerBill by ID
getCustomerBillById 11 params → 200400401403404405500
PATCH
/customerBill/{id}
Updates partially a CustomerBill
updateCustomerBill 4 params body → 200400401403404405500

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are CustomerBill_2 (25 properties), AttachmentRefOrValue (14 properties), CustomerBill (13 properties), FinancialAccountRef (8 properties). Each schema is shown below with its type and property counts.

CustomerBill_Complete
object
2 properties 3 required
RelatedParty
array
AppliedPayment
object
Payment associated with the bill. There may be a partial payment, then there should be several applied payments available. On the other hand, more than one bil…
4 properties
CustomerBill_ID
object
2 properties 2 required
ATM
object
Detailed information of the ATM through which bill payment has done.
3 properties 1 required
Bank
object
Detailed information of the Bank through which bill payment has done.
4 properties 2 required
CustomerBill_Payment
object
TokenizedCard
object
Detailed information for a stored tokenized card.
6 properties
DueDetail
array
PaymentRef
object
6 properties 1 required
Error
object
5 properties 2 required
FinancialAccount
array
PaymentMethodRef
object
Reference or value of the method used for payment.
4 properties
TimePeriod
object
2 properties
Cash
object
Detailed information of the service center/shop where bill paid through cash
2 properties 1 required
BankCard
object
Detailed information for a bank card.
8 properties
BillingAccount
array
BillCycle
array
Cheque
object
Detailed information of cheque.
5 properties 1 required
TaxItem
array
PaymentMethodTypeDetails
object
Definition of the payment method. Its content depends on the type field.
6 properties
CustomerBill_Update
object
4 properties 3 required
BillDocument
array
Money
object
2 properties 2 required
PaymentMethodTypeEnum
string
CustomerBill
object
13 properties
Reference
object
3 properties 2 required
CreditLimit
array
PaymentMethodRef_2
object
PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).
7 properties 1 required
AppliedPayment_2
object
The applied payment is the result of lettering process. It enables to assign automatically or manually part of incoming payment amount to a bill.
5 properties
TimePeriod_2
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
AttachmentRefOrValue
object
An attachment by value or by reference. For AttachmentRefOrValue, the attribute type,schemaLocation and referredType are related to the contained entity and no…
14 properties
TaxItem_2
object
A tax item is created for each tax rate and tax type used in the bill.
6 properties
Quantity
object
An amount in a given unit
2 properties
BillingAccountRef
object
Reference to the billing account in case of not billed item.
7 properties 1 required
CustomerBill_Update_2
object
The billing account receives all charges (recurring, one time and usage) of the offers and products assigned to it during order process. Periodically according…
4 properties
Money_2
object
A base / value business entity used to represent money
2 properties
RelatedPartyRef
object
RelatedParty reference. A related party defines party or party role linked to a specific entity.
8 properties 1 required
AccountBalance
object
Balances linked to the account
6 properties 3 required
FinancialAccountRef
object
AccountReceivable reference. An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. An accou…
8 properties 1 required
stateValue
string
PaymentRef_2
object
If an immediate payment has been done at the product order submission, the payment information are captured and stored (as a reference) in the order.
7 properties 1 required
CustomerBill_2
object
The billing account receives all charges (recurring, one time and usage) of the offers and products assigned to it during order process. Periodically according…
25 properties
Error_2
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mtn-group-customerbill-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 Customer Bill 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.