{ "opencollection": "1.0.0", "info": { "name": "MTN Customer Plans API", "version": "v.2.3" }, "items": [ { "info": { "name": "Customers", "type": "folder" }, "items": [ { "info": { "name": "Retrieves a customers FRI", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/customers/:id/plans/FRI", "headers": [ { "name": "targetSystem", "value": "" }, { "name": "transactionId", "value": "" }, { "name": "x-country-code", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "id" } ] }, "docs": "Retrieves FRI for MTN customer." }, { "info": { "name": "Block and Unblock operations are initiated on Customer FRI", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/customers/:id/plans/FRI/state", "headers": [ { "name": "idType", "value": "" }, { "name": "targetSystem", "value": "" }, { "name": "transactionId", "value": "" }, { "name": "x-origin-channelId", "value": "" }, { "name": "x-authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the customer. It could be MSISDN, email etc. combination of id and idType defines accountHolderId which will be sent to ECW System as identity" } ] }, "docs": "By Interpreting value for 'state' MADAPI initiates Block and Unblock requests on Customer FRI" }, { "info": { "name": "View customer plans", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/customers/:customerId/plans", "headers": [ { "name": "transactionId", "value": "" } ], "params": [ { "name": "customerId", "value": "", "type": "path", "description": "ID of the customer. It could be MSISDN, email address, or any other customer identifier. if id is msisdn, format must be Eg.123" }, { "name": "fixedLine", "value": "", "type": "query", "description": "Fixed line whose balances is fetched" }, { "name": "plan", "value": "", "type": "query", "description": "Plan type to filter list of balances" }, { "name": "momo", "value": "", "type": "query", "description": "Indicates whether to query balances for a MoMo Customer" }, { "name": "includeReservations", "value": "", "type": "query", "description": "Indicates whether reservations should be included in the response. This parameter goes hand in hand with the momo query parameter and will have no use if supplied when momo is not true. Default is false." }, { "name": "referenceid", "value": "", "type": "query", "description": "This is required to handle the correlation between the 2 systems" }, { "name": "quoteid", "value": "", "type": "query", "description": "Indicates whether a corresponding quote should be considered. This parameter goes hand-in-hand with the momo query parameter and will have no use if supplied when momo is not true." }, { "name": "targetSystem", "value": "", "type": "query", "description": "Name of the backend system" }, { "name": "segment", "value": "", "type": "query", "description": "This is the type of customer doing the transaction. This can be agent, admin , merchant or subscriber" }, { "name": "idType", "value": "", "type": "query", "description": "Type of the customerId in the path." }, { "name": "prefLanguage", "value": "", "type": "query", "description": "The language in which the response is required" }, { "name": "amount", "value": "", "type": "query", "description": "The threshold amount against which the actual balance will be compared" }, { "name": "usageType", "value": "", "type": "query", "description": "Type of usage to be fetched. 1 – All, 2 – Active, 3 – Inactive" }, { "name": "extRequest", "value": "", "type": "query", "description": "Define if the request is external or not." } ] }, "docs": "Retrieves the Billing Plan and related details of an MTN customer." }, { "info": { "name": "Tariff plan migration", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/customers/:customerId/plans", "headers": [ { "name": "transactionId", "value": "" } ], "params": [ { "name": "customerId", "value": "", "type": "path", "description": "ID of the customer. It could be MSISDN, email address, or any other customer identifier. if id is msisdn, format must be E.123" } ] }, "docs": "Migrate the customer from one tariff plan to another" }, { "info": { "name": "View customer plans for product", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/customers/:customerId/plans/:productCode", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "ID of the customer. It could be MSISDN, email address, or any other customer identifier. if id is msisdn, format must be E.123" }, { "name": "productCode", "value": "", "type": "path", "description": "Product code for data package" } ] }, "docs": "Retrieves plans for product" }, { "info": { "name": "Airtime Refill", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/customers/:customerId/plans/refill", "headers": [ { "name": "transactionId", "value": "" }, { "name": "sourceSystemId", "value": "" }, { "name": "channel", "value": "" }, { "name": "partnerName", "value": "" } ], "params": [ { "name": "customerId", "value": "", "type": "path", "description": "ID of the customer. It could be MSISDN, email address, or any other customer identifier. if id is msisdn, format must be E.123" } ] }, "docs": "Will be used by 3rd-party partners (3PP) for airtime recharge of a prepaid subscriber" }, { "info": { "name": "Provision the customer and return customer details along with MSISDN", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/customers/:id/plans/provision", "headers": [ { "name": "transactionId", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "This could be either MSISDN or Serial number of the SIM of the customer for who the provision request is raised." }, { "name": "sourceIdentifier", "value": "", "type": "query", "description": "This field denotes the channel that is initiating request to SOA., ex-'Online, USSD, MyMTNApp, Payjoy'" }, { "name": "idType", "value": "", "type": "query", "description": "Mention the type of id- MSISDN or Serial number of the SIM." } ] }, "docs": "Provision the customer and returns customer details along with MSISDN with SIM number as input." } ] }, { "info": { "name": "Premiums", "type": "folder" }, "items": [ { "info": { "name": "Request Premium", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/customers/:customerId/plans", "params": [ { "name": "customerId", "value": "", "type": "path", "description": "ID of the customer who is sending the transaction. It could be MSISDN, email address, or any other customer identifier. if id is msisdn, format must be E.123" } ] }, "docs": "Requesting a MTN customer's premium per product." } ] } ], "bundled": true }