This is a sample representation of the Prepay Balance Management TMForum API. It is important to bear in mind that swagger 2.0 does not properly support polymorphism, so the link between the payment method details and its data types should be looked up in the API specification pdf file.
MTN TMF Prepay Balance Management - TMF654 is one of 119 APIs that MTN Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include TM Forum, TMF654, South Sudan, and Eswatini. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.
This API exposes
2 operations
across 2 paths,
organized into 2 resource areas,
and defines 46 schemas.
It is described by OpenAPI 2.0, at version 2.0.4.
Requests are made against the base URL https://api.mtn.com/tmf-api/prepaybalancemanagement/v1/.
2 operations2 paths46 schemas1 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
MTN TMF Prepay Balance Management - TMF654 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 2
Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. They span 2 resource areas: Balance Buckets Methods, BalanceTransfer. Each is listed below with its method, path, parameters, and response codes.
Balance Buckets Methods 1
GET
/bucket
Retrieve balance information stored in the server that can be filtered for specific criteria.
retrieveBuckets1 param→ 200400401403405500
BalanceTransfer 1
POST
/balanceTransfer
request a new transfer operation for a given product (or commercial id reference to a product instance consuming the credit held in a bucket for a specific service).
createTransfer3 params→ 201
Schemas 46
The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are TransferBalance (27 properties), BalanceTopupRequest (16 properties), BalanceTransferRequest (15 properties), BucketBalance (13 properties). Each schema is shown below with its type and property counts.
BucketBalance
object
Represents and tracks the amount remained or owed for a certain type of service by certain customer
13 properties6 required
AccumulatedBalance
object
Represents and tracks the aggregated amount remained or owed in certain account which is owned by certain customer for a set of buckets.
7 properties4 required
BalanceTopupBody
object
4 properties3 required
BalanceTopupRequest
object
Represents a detailed description of a recharge operation requested over a bucket (defined by a specific product or reference to a product (i.e.: a commercial…
16 properties6 required
BalanceTransferBody
object
6 properties3 required
BalanceTransferRequest
object
The BalanceTransfer resource is a detailed description of credit transfer operation requested between two buckets (reference to products owned by customers and…
15 properties6 required
TransferBalance
object
The TransferBalance resource is a detailed description of credit transfer operation requested between two buckets (reference to products owned by customers and…
27 properties3 required
ContactItem
object
2 properties
ContactMedium
object
4 properties
ContactMediumCharacteristic
object
1 property
ProductRef
object
9 properties1 required
LogicalResourceRef
object
reference to the LogicalResource eg MSISDN
7 properties1 required
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
5 properties
Money
object
A base / value business entity used to represent money
3 properties
ChannelRef
object
The channel to which the resource reference to. e.g. channel for selling product offerings, channel for opening a trouble ticket etc..
5 properties1 required
RelatedParty
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
10 properties
BucketRef
object
link to the resource that holds bucket information
11 properties1 required
UsageType
string
Valid values for the usage type are
Quantity
object
An amount in a given unit
2 properties
BalanceAdjustmentBody
object
4 properties3 required
BalanceAdjustmentRequest
object
the BalanceAdjustment resource is a detailed description of credit adjustment operation erformed on a given bucket (defined by a specific product or reference…
9 properties4 required
BalanceActivity
object
The BalanceActivity resource is a detailed description of a specific balance-related action that has happened over a given bucket balance. Typically a recharge…
10 properties6 required
BalanceReserveBody
object
3 properties3 required
BalanceReserveRequest
object
The Balance Reserve Operation resource is a detailed description of a balance reserve operation requested over a bucket (defined by a specific product or refer…
13 properties1 required
BalanceUnreserveBody
object
3 properties3 required
BalanceUnreserveRequest
object
The Balance Unreserve Operation resource is a detailed description of a balance unreserve operation requested over a product
6 properties1 required
BalanceDeductBody
object
4 properties4 required
BalanceDeductRequest
object
The Balance Deduct task resource is a detailed description of deduction operation. If balanceReserve Resource ID is contained in the deduct request message, th…
11 properties1 required
BalanceReserveRefType
object
link to the resource that holds reserved balance information
2 properties2 required
BalanceActionRequestRefType
object
link to the resource that holds balance-related request information
2 properties2 required
ChannelRefType
object
link to the resource that holds information about the channel used to initiate the topup operation request
4 properties2 required
partyAccountRef
object
account owner information
2 properties1 required
PaymentMethodRefOrValueType
object
link to the resource that holds information about the payment mean used to complete the operation
5 properties2 required
BalanceTransferStatusTypeModify
object
1 property1 required
BalanceTopupStatusTypeModify
object
1 property1 required
BalanceTopupStatusType
object
Structure including specific information about change of status for the topup operation
1 property1 required
BucketBalanceRefType
object
link to the resource that holds bucket balance information
2 properties2 required
ProductRefType
object
Representation of a resource that holds information about the product that is linked to the bucket balance.
3 properties2 required
QuantityType
object
Representation of a quantity of something. I can also be used to represent a quantity range
2 properties2 required
TimePeriodType
object
Representation of a time period
2 properties1 required
PartyAccountRefType
object
Information about a resource that holds information about the account that owns the bucket
3 properties2 required
RelatedPartyRefType
object
Information about an associated entity and its role
4 properties2 required
RealizingResourceRefType
object
Information about a resource that holds realizes the product that is linked to the bucket balance
5 properties
NotificationRequest
object
1 property1 required
NotificationResponse
object
3 properties3 required
ListenerRequest
object
3 properties3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
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.
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 TMF Prepay Balance Management - TMF654, 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.
