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 TMF Usage Management - TMF635

This service provides comprehensive usage management capabilities for MTN operations including data usage tracking, subscription management, balance inquiries, and usage analytics. The service integrates with various billing and usage systems to provide real-time usage information across the MTN ecosystem.

MTN TMF Usage Management - TMF635 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, TMF635, Côte d’Ivoire, and South Sudan. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 16 operations across 15 paths, organized into 2 resource areas, and defines 61 schemas. It is described by OpenAPI 3.0.1, at version 3.0.0 - Last updated date:2026-06-26 09:07:34.

Requests are made against a single base URL, https://api.mtn.com/v1.

16 operations 15 paths 61 schemas 14 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
3.0.0 - Last updated date:2026-06-26 09:07:34
Base URL
https://api.mtn.com/v1
Authentication
OAuth 2.0, HTTP Bearer
License
Resource Areas
2

Authentication & Security 2

MTN TMF Usage Management - TMF635 declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials flow. It accepts HTTP bearer tokens (JWT) (Bearer). By default, every request must be authenticated.

  • Bearer — Bearer token received from OAuth2.0 authentication with the MADAPI

Paths & Operations 16

Across 15 paths, the API surfaces 16 operations — 14 GET, 1 POST, 1 PUT. They span 2 resource areas: UsageManagement, UsageManagementsSSd. Each is listed below with its method, path, parameters, and response codes.

UsageManagement 13
GET
/agent/loanhistory
Retrieves agent loan history with paging and country-specific DAASAGENT routing support.
UsageManagement_get_getAgentDataBanktech_agentloanhistory 9 params → 200400401403404500502503
GET
/customer/crbRecord
Retrieves a Banktech customer CRB (credit bureau) snapshot via GET /customer/crbRecord when the loan-history response did not include bureau data, typically because the subscriber had no qualifying t…
UsageManagement_get_getCrbRecord_customercrbRecord 5 params → 200400401403404500502503
GET
/customer/loanhistory
Retrieves Banktech loan history with paging and country-specific backend routing support.
UsageManagement_get_getCustomerDataBanktech_customerloanhistory 13 params → 200400401403404500502503
GET
/customer/momo/history
Retrieves MoMo wallet statement history with filters, paging, and country-specific routing.
UsageManagement_get_getMomoTransactionHistory_customermomohistory 15 params → 200400401403404500502503
GET
/customer/momo/history/{requestId}
Retrieves MoMo statement details by requestId with paging and downstream routing support.
UsageManagement_get_getMomoTransactionHistoryById_customermomohistoryr 13 params → 200400401403404500502503
GET
/sim/lastActivityDate/{id}
Retrieves SIM last activity date for a subscriber via configured country-specific DAAS usage routing.
UsageManagement_get_getSimLastActivityDate_simlastActivityDatei 16 params → 200400401403404500502503
GET
/transaction/{id}
Retrieves subscriber transaction details by MSISDN or transaction ID with paging and routing support.
UsageManagement_get_getTransaction_transactionid 16 params → 200400401403404500502503
GET
/usage/{customerId}/alerts
Retrieves active usage alerts and thresholds for a customer MSISDN from IBF systems.
UsageManagement_get_getNotification_usagecustomerIdalert 4 params → 200400401403404500502503
PUT
/usage/{customerId}/alerts
Updates customer's usage alerts details
UsageManagement_put_setNotification_usagecustomerIdalert 2 params body → 200400401403404500502503
POST
/usage/{customerId}/flags
Updates customer marketing and data-sharing preferences through usage flag operations.
UsageManagement_post_setFlag_usagecustomerIdflags 4 params body → 200400401403404500502503
GET
/usage/{customerId}/history
Retrieves customer usage and transaction history with paging, filters, and routing support.
UsageManagement_get_getCustomerData_usagecustomerIdhisto 11 params → 200400401403404500502503
GET
/usage/{id}/deviceOnNetwork
Retrieves device-on-network details including IMEI, model, and activity signals.
UsageManagement_get_getDeviceOnNetworkByID_usageiddeviceOnNetwo 6 params → 200400401403404500502503
GET
/usageManagement/v1/caag/{id}
Retrieves grouped CAAG usage records with filters, masking, and paging for subscriber queries.
UsageManagement_get_getCAAG_caagid 10 params → 200400401403404500502503
UsageManagementsSSd 3
GET
/recharge/{id}
Retrieves recharge history and top-up transactions for a subscriber MSISDN via GET /recharge/{id} on the SSD deployment profile, including financial trace fields and paging metadata resolved through…
UsageManagementsSSd_get_getRechargeHistory_rechargeid 15 params → 200400401403404500502503
GET
/usage/{id}
Retrieves consolidated usage history for a subscriber MSISDN via GET /usage/{id} on the SSD deployment profile, including SMS, voice, and data records with pagination and downstream routing to the co…
UsageManagementsSSd_get_getUsageByID_usageid 17 params → 200400401403404500502503
GET
/usageCharge/{id}
Retrieves out-of-bundle usage charge lines for a subscriber MSISDN via GET /usageCharge/{id} on the SSD deployment profile, returning rated beyond-bundle consumption with paging and downstream retrie…
UsageManagementsSSd_get_getUsageChargeByID_usageChargeid 14 params → 200400401403404500502503

Schemas 61

The contract defines 61 schemas that model the data the API accepts and returns. The most detailed are rw_co_mtn_usage_aggregator_model_res_BanktechUserData (202 properties), rw_co_mtn_usage_aggregator_model_res_Momo (139 properties), rw_co_mtn_usage_aggregator_model_res_BankTechAgentData (101 properties), rw_co_mtn_usage_aggregator_model_data_DeviceOnNetworkData (76 properties). Each schema is shown below with its type and property counts.

rw_co_mtn_usage_aggregator_model_ussd_response_Data
object
4 properties
rw_co_mtn_usage_aggregator_model_banktechCrbRecord_Crb
object
5 properties
rw_co_mtn_usage_aggregator_model_data_UsageChargeData
object
4 properties
rw_co_mtn_usage_aggregator_model_data_TransactionData
object
33 properties
rw_co_mtn_usage_aggregator_model_banktechCrbRecord_Account
object
1 property
rw_co_mtn_usage_aggregator_model_res_UsageTransactionResponse
object
12 properties
rw_co_mtn_usage_aggregator_model_banktechCrbRecord_AccountList
object
1 property
rw_co_mtn_usage_aggregator_model_data_RechargeData
object
9 properties
rw_co_mtn_usage_aggregator_model_res_BankTechResponse
object
8 properties
rw_co_mtn_usage_aggregator_model_data_DeviceOnNetworkData
object
76 properties
rw_co_mtn_usage_aggregator_model_data_AgentRecordData
object
61 properties
rw_co_mtn_usage_aggregator_model_res_CAAGGroupedResponse
object
2 properties
rw_co_mtn_usage_aggregator_model_banktechCrbRecord_ScoreOutput
object
7 properties
rw_co_mtn_usage_aggregator_model_data_AdditionalInformation
object
2 properties
APIError
object
Generic MADAPI error response structure
9 properties 2 required
rw_co_mtn_usage_aggregator_model_res_APIStatus
object
13 properties
rw_co_mtn_usage_aggregator_model_res_UsageResponse
object
23 properties
rw_co_mtn_usage_aggregator_model_banktechCrbRecord_PaClosedAccounts
object
2 properties
rw_co_mtn_usage_aggregator_model_res_UsageUnit
object
2 properties
rw_co_mtn_usage_aggregator_model_flags_SystemFlagReq
object
1 property
rw_co_mtn_usage_aggregator_model_banktechCrbRecord_PaOpenAccounts
object
2 properties
rw_co_mtn_usage_aggregator_model_res_AtcLoans
object
15 properties
rw_co_mtn_usage_aggregator_model_ussd_response_NotificationResponse
object
7 properties
rw_co_mtn_usage_aggregator_model_banktechCrbRecord_CreditHistory
object
2 properties
rw_co_mtn_usage_aggregator_model_data_UsageCharacteristic
object
4 properties
rw_co_mtn_usage_aggregator_model_res_DataFetchResponse
object
7 properties
rw_co_mtn_usage_aggregator_model_res_BanktechUserData
object
202 properties
rw_co_mtn_usage_aggregator_model_data_AccountDetails
object
4 properties
rw_co_mtn_usage_aggregator_model_res_UsageGsm
object
2 properties
rw_co_mtn_usage_aggregator_model_res_Kyc
object
13 properties
rw_co_mtn_usage_aggregator_model_common_CommonUnit
object
3 properties
rw_co_mtn_usage_aggregator_model_EfloatTransferSummary
object
11 properties
rw_co_mtn_usage_aggregator_model_banktechCrbRecord_PersonalProfile
object
10 properties
rw_co_mtn_usage_aggregator_model_res_BankTechAgentResponse
object
6 properties
rw_co_mtn_usage_aggregator_model_banktechCrbRecord_PaAccounts
object
2 properties
rw_co_mtn_usage_aggregator_model_banktechCrbRecord_NpaAccounts
object
2 properties
rw_co_mtn_usage_aggregator_model_res_Gsm
object
62 properties
rw_co_mtn_usage_aggregator_model_res_UsageSpend
object
16 properties
rw_co_mtn_usage_aggregator_model_data_RechargeHistory
object
5 properties
rw_co_mtn_usage_aggregator_model_data_BalanceDetails
object
4 properties
rw_co_mtn_usage_aggregator_model_data_BinaryAttachment
object
7 properties
rw_co_mtn_usage_aggregator_model_res_RechargeResponse
object
13 properties
rw_co_mtn_usage_aggregator_model_banktechCrbRecord_NpaOpenAccounts
object
2 properties
rw_co_mtn_usage_aggregator_model_res_UserData
object
34 properties
rw_co_mtn_usage_aggregator_model_data_UsageDataResponse
object
69 properties
rw_co_mtn_usage_aggregator_model_res_DeviceOnNetworkResponse
object
5 properties
rw_co_mtn_usage_aggregator_model_data_UsageSpecification
object
6 properties
rw_co_mtn_usage_aggregator_model_res_UsageChargeResponse
object
11 properties
rw_co_mtn_usage_aggregator_model_res_UsageBand
object
7 properties
rw_co_mtn_usage_aggregator_model_ussd_request_AlertDetails
object
3 properties
rw_co_mtn_usage_aggregator_model_data_MomoDataResponse
object
14 properties
rw_co_mtn_usage_aggregator_model_res_MomoTransactionResponse
object
12 properties
rw_co_mtn_usage_aggregator_model_AgentRecord
object
9 properties
rw_co_mtn_usage_aggregator_model_data_RatedProductUsage
object
2 properties
rw_co_mtn_usage_aggregator_model_data_OtherDetails
object
13 properties
rw_co_mtn_usage_aggregator_model_res_Momo
object
139 properties
rw_co_mtn_usage_aggregator_model_banktechCrbRecord_NpaClosedAccounts
object
2 properties
rw_co_mtn_usage_aggregator_model_banktechCrbRecord_Header
object
6 properties
rw_co_mtn_usage_aggregator_model_res_CrbRecordResponse
object
13 properties
rw_co_mtn_usage_aggregator_model_res_BankTechAgentData
object
101 properties
rw_co_mtn_usage_aggregator_model_banktechCrbRecord_Summary
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mtn-group-tmf-usage-management-tmf635.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 TMF Usage Management - TMF635, 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.