{ "opencollection": "1.0.0", "info": { "name": "MTN Usage Management", "version": "3.0.0 - Last updated date:2026-06-26 09:07:34" }, "request": { "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.mtn.com/v1/oauth/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "UsageManagement", "type": "folder" }, "items": [ { "info": { "name": "Retrieves agent loan history with paging and country-specific DAASAGENT routing support.", "type": "http" }, "http": { "method": "GET", "url": "https://api.mtn.com/v1/agent/loanhistory", "headers": [ { "name": "country", "value": "" }, { "name": "partnerName", "value": "" }, { "name": "transactionId", "value": "" } ], "params": [ { "name": "customerIdHash", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "maxResults", "value": "", "type": "query" }, { "name": "momoPartnerId", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "startDate", "value": "", "type": "query" } ] }, "docs": "Retrieves agent loan history with pagination, supported country validation, date filtering, and downstream DAASAGENT routing for Banktech reconciliation, audit requirements, and agent financial workflows." }, { "info": { "name": "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 transactions in the configured look-back window.", "type": "http" }, "http": { "method": "GET", "url": "https://api.mtn.com/v1/customer/crbRecord", "headers": [ { "name": "country", "value": "" }, { "name": "transactionId", "value": "" } ], "params": [ { "name": "customerIdHash", "value": "", "type": "query" }, { "name": "partnerId", "value": "", "type": "query" }, { "name": "providerId", "value": "", "type": "query" } ] }, "docs": "Retrieves customer CRB record. This endpoint will be called if the CRB record was not returned in the LoanHistory endpoint due to that the customer has not transacted in the past 30 days" }, { "info": { "name": "Retrieves Banktech loan history with paging and country-specific backend routing support.", "type": "http" }, "http": { "method": "GET", "url": "https://api.mtn.com/v1/customer/loanhistory", "headers": [ { "name": "country", "value": "" }, { "name": "transactionId", "value": "" }, { "name": "x-origin-channelid", "value": "" } ], "params": [ { "name": "appName", "value": "", "type": "query" }, { "name": "customerIdHash", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "hostName", "value": "", "type": "query" }, { "name": "maxResults", "value": "", "type": "query" }, { "name": "momoPartnerId", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" }, { "name": "startDate", "value": "", "type": "query" }, { "name": "userID", "value": "", "type": "query" } ] }, "docs": "Retrieves customer loan history including disbursement and repayment details with paging, partner identifiers, and routing to DAAS, DASS_MFS, or EVA backends for Banktech operations and financial tracking." }, { "info": { "name": "Retrieves MoMo wallet statement history with filters, paging, and country-specific routing.", "type": "http" }, "http": { "method": "GET", "url": "https://api.mtn.com/v1/customer/momo/history", "headers": [ { "name": "queryType", "value": "" }, { "name": "transactionId", "value": "" }, { "name": "x-country-code", "value": "" }, { "name": "x-origin-channelid", "value": "" } ], "params": [ { "name": "appName", "value": "", "type": "query" }, { "name": "attributes", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query" }, { "name": "hostName", "value": "", "type": "query" }, { "name": "msisdn", "value": "", "type": "query" }, { "name": "pageNum", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" }, { "name": "startDate", "value": "", "type": "query" }, { "name": "userId", "value": "", "type": "query" } ] }, "docs": "Retrieves detailed MoMo wallet transaction history for a subscriber MSISDN within a specified date range, supporting filters, formats, pagination, and country-specific routing to the appropriate MoMo integration endpoint." }, { "info": { "name": "Retrieves MoMo statement details by requestId with paging and downstream routing support.", "type": "http" }, "http": { "method": "GET", "url": "https://api.mtn.com/v1/customer/momo/history/:requestId", "headers": [ { "name": "transactionId", "value": "" }, { "name": "x-country-code", "value": "" }, { "name": "x-origin-channelid", "value": "" } ], "params": [ { "name": "appName", "value": "", "type": "query" }, { "name": "attributes", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query" }, { "name": "hostName", "value": "", "type": "query" }, { "name": "msisdn", "value": "", "type": "query" }, { "name": "pageNum", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" }, { "name": "requestId", "value": "", "type": "path" }, { "name": "userId", "value": "", "type": "query" } ] }, "docs": "Retrieves detailed MoMo wallet transactions by requestId, supporting paging, query parameters, asynchronous retrieval flows, and downstream routing to the appropriate MoMo history service." }, { "info": { "name": "Retrieves SIM last activity date for a subscriber via configured country-specific DAAS usage routing.", "type": "http" }, "http": { "method": "GET", "url": "https://api.mtn.com/v1/sim/lastActivityDate/:id", "headers": [ { "name": "countryCode", "value": "" }, { "name": "targetSystem", "value": "" }, { "name": "transactionId", "value": "" }, { "name": "x-origin-channelid", "value": "" } ], "params": [ { "name": "appName", "value": "", "type": "query" }, { "name": "attributes", "value": "", "type": "query" }, { "name": "endTime", "value": "", "type": "query" }, { "name": "hostName", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path" }, { "name": "maxRecords", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" }, { "name": "referenceID", "value": "", "type": "query" }, { "name": "startTime", "value": "", "type": "query" }, { "name": "usageType", "value": "", "type": "query" }, { "name": "userID", "value": "", "type": "query" } ] }, "docs": "Retrieves subscriber SMS, voice, and data usage records to determine SIM last activity date, supporting dormancy analysis, engagement checks, and country-specific DAAS routing with detailed usage tracking." }, { "info": { "name": "Retrieves subscriber transaction details by MSISDN or transaction ID with paging and routing support.", "type": "http" }, "http": { "method": "GET", "url": "https://api.mtn.com/v1/transaction/:id", "headers": [ { "name": "countryCode", "value": "" }, { "name": "targetSystem", "value": "" }, { "name": "transactionId", "value": "" }, { "name": "x-origin-channelid", "value": "" } ], "params": [ { "name": "bundleType", "value": "", "type": "query" }, { "name": "endTime", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path" }, { "name": "idType", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "pageNo", "value": "", "type": "query" }, { "name": "queryType", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "startTime", "value": "", "type": "query" }, { "name": "subId", "value": "", "type": "query" } ] }, "docs": "Retrieves subscriber transaction details for wallet, bundle, and agent queries with paging, routing rules, subscription history support, analytics, and comprehensive transaction tracking across supported channels." }, { "info": { "name": "Retrieves active usage alerts and thresholds for a customer MSISDN from IBF systems.", "type": "http" }, "http": { "method": "GET", "url": "https://api.mtn.com/v1/usage/:customerId/alerts", "headers": [ { "name": "transactionId", "value": "" } ], "params": [ { "name": "customerId", "value": "", "type": "path" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "startDate", "value": "", "type": "query" } ] }, "docs": "Retrieves customer usage alert settings, thresholds, and notification preferences for a specific MSISDN from IBF systems, supporting spend monitoring, bundle warnings, alert tracking, and self-service management." }, { "info": { "name": "Updates customer's usage alerts details", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mtn.com/v1/usage/:customerId/alerts", "headers": [ { "name": "transactionId", "value": "" } ], "params": [ { "name": "customerId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates customer's usage alerts details with comprehensive alert management, notification preferences, and customer alert configuration capabilities." }, { "info": { "name": "Updates customer marketing and data-sharing preferences through usage flag operations.", "type": "http" }, "http": { "method": "POST", "url": "https://api.mtn.com/v1/usage/:customerId/flags", "headers": [ { "name": "transactionId", "value": "" }, { "name": "x-origin-channelid", "value": "" }, { "name": "xAuthorization", "value": "" } ], "params": [ { "name": "customerId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates customer marketing and data-sharing consent preferences using operationName values such as DATA_SHARING_ON, MARKETING_ON, and MARKETING_OFF through downstream usage-flags integration." }, { "info": { "name": "Retrieves customer usage and transaction history with paging, filters, and routing support.", "type": "http" }, "http": { "method": "GET", "url": "https://api.mtn.com/v1/usage/:customerId/history", "headers": [ { "name": "country", "value": "" }, { "name": "countryCode", "value": "" }, { "name": "transactionId", "value": "" }, { "name": "x-origin-channelid", "value": "" }, { "name": "xAuthorization", "value": "" } ], "params": [ { "name": "customerId", "value": "", "type": "path" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "maxResults", "value": "", "type": "query" }, { "name": "momoPartnerId", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "startDate", "value": "", "type": "query" } ] }, "docs": "Retrieves customer usage and transaction history with date range, MoMo partner, paging, and channel-based routing to DAAS or BIB systems, supporting detailed reporting, analytics, and transaction tracking." }, { "info": { "name": "Retrieves device-on-network details including IMEI, model, and activity signals.", "type": "http" }, "http": { "method": "GET", "url": "https://api.mtn.com/v1/usage/:id/deviceOnNetwork", "headers": [ { "name": "transactionId", "value": "" }, { "name": "type", "value": "" } ], "params": [ { "name": "enddate", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path" }, { "name": "sourceIdentifier", "value": "", "type": "query" }, { "name": "startdate", "value": "", "type": "query" } ] }, "docs": "Retrieves device information active on the network for a subscriber, including IMEI, device model, last seen activity, type filters, and optional date range support for fraud detection and customer care use cases." }, { "info": { "name": "Retrieves grouped CAAG usage records with filters, masking, and paging for subscriber queries.", "type": "http" }, "http": { "method": "GET", "url": "https://api.mtn.com/v1/usageManagement/v1/caag/:id", "headers": [ { "name": "transactionId", "value": "" }, { "name": "x-authorization-claims", "value": "" }, { "name": "x-origin-channelid", "value": "" } ], "params": [ { "name": "endTime", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "pageNo", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" }, { "name": "startTime", "value": "", "type": "query" } ] }, "docs": "Retrieves CAAG call detail records for subscriber usage analysis, billing verification, and call history tracking with configurable filters, optional masking, paging, and protected downstream DAAS routing support." } ] }, { "info": { "name": "UsageManagementsSSd", "type": "folder" }, "items": [ { "info": { "name": "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 the same streamlined routing model used for other SSD usage endpoints.", "type": "http" }, "http": { "method": "GET", "url": "https://api.mtn.com/v1/recharge/:id", "headers": [ { "name": "countryCode", "value": "" }, { "name": "transactionId", "value": "" }, { "name": "x-origin-channelid", "value": "" } ], "params": [ { "name": "appName", "value": "", "type": "query" }, { "name": "endTime", "value": "", "type": "query" }, { "name": "historyType", "value": "", "type": "query" }, { "name": "hostName", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "maxRecords", "value": "", "type": "query" }, { "name": "pageNum", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" }, { "name": "referenceID", "value": "", "type": "query" }, { "name": "startTime", "value": "", "type": "query" }, { "name": "userID", "value": "", "type": "query" } ] }, "docs": "This operation retrieves comprehensive recharge history details for a subscriber, supporting financial tracking, transaction analysis, and customer service with complete recharge transaction records." }, { "info": { "name": "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 configured single-system usage path for the requesting country.", "type": "http" }, "http": { "method": "GET", "url": "https://api.mtn.com/v1/usage/:id", "headers": [ { "name": "countryCode", "value": "" }, { "name": "targetSystem", "value": "" }, { "name": "transactionId", "value": "" }, { "name": "x-origin-channelid", "value": "" } ], "params": [ { "name": "appName", "value": "", "type": "query" }, { "name": "attributes", "value": "", "type": "query" }, { "name": "endTime", "value": "", "type": "query" }, { "name": "hostName", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path" }, { "name": "maxRecords", "value": "", "type": "query" }, { "name": "noOfDays", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" }, { "name": "referenceID", "value": "", "type": "query" }, { "name": "startTime", "value": "", "type": "query" }, { "name": "usageType", "value": "", "type": "query" }, { "name": "userID", "value": "", "type": "query" } ] }, "docs": "This operation retrieves all the call details record for a subscriber like SMS, Voice and Data usage history with comprehensive transaction tracking and detailed usage analytics." }, { "info": { "name": "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 retrieval aligned to the simplified system selection rules for this stack.", "type": "http" }, "http": { "method": "GET", "url": "https://api.mtn.com/v1/usageCharge/:id", "headers": [ { "name": "countryCode", "value": "" }, { "name": "transactionId", "value": "" }, { "name": "x-origin-channelid", "value": "" } ], "params": [ { "name": "appName", "value": "", "type": "query" }, { "name": "endTime", "value": "", "type": "query" }, { "name": "hostName", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path" }, { "name": "maxRecords", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" }, { "name": "referenceID", "value": "", "type": "query" }, { "name": "startTime", "value": "", "type": "query" }, { "name": "usageType", "value": "", "type": "query" }, { "name": "userID", "value": "", "type": "query" } ] }, "docs": "This operation retrieves comprehensive out of bundle usage charges applied to a subscriber, supporting detailed billing analysis, cost tracking, and financial reporting with complete charge breakdown." } ] } ], "bundled": true }