{ "info": { "name": "APN Management API Spec", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "get a list of APNs", "description": "retrieve a list of all active APNs", "request": { "auth": [], "method": "Get", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } ], "url": { "raw": "api.mtn\/apns", "protocol": "https", "host": [ "api", "mtn" ], "path": [ "v1", "networks", "apns" ], "query": [ { "key": "transactionId", "value": "", "required": true, "type": "string", "description": "Transaction ID" }, { "key": "sourceIdentifier", "value": "", "required": true, "type": "string", "description": "Source system" }, { "key": "thirdPartyId", "value": "", "required": true, "type": "string", "description": "Partner" } ] } }, "response": [ { "code": 200, "status": "OK", "name": "Success", "schema": { "transactionId": { "type": "string" }, "statusCode": { "type": "string" }, "supportMessage": { "type": "string" }, "data": { "apnList": { "apnId": { "type": "string" }, "apnName": { "type": "string" }, "thirdPartyId": { "type": "string" }, "customerId": { "type": "string" }, "debtorId": { "type": "string" } } }, "_links": { "self": { "href": { "type": "string" }, "type": { "type": "string", "example": "POST" } } } }, "body": "{\"transactionId\":\"string\",\"statusCode\":\"string\",\"supportMessage\":\"string\",\"data\":{\"apnList\":{\"apnId\":\"string\",\"apnName\":\"string\",\"thirdPartyId\":\"string\",\"customerId\":\"string\",\"debtorId\":\"string\"}},\"_links\":{\"self\":{\"href\":\"string\",\"type\":\"string\"}}}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Unauthorized", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "Text explaining the reason for the error" }, "error": { "type": "string" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 403, "status": "Forbidden", "name": "Forbidden", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "Text explaining the reason for the error" }, "error": { "type": "string" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 404, "status": "Not Found", "name": "Not Found", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "Text explaining the reason for the error" }, "error": { "type": "string" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 405, "status": "Method Not Allowed", "name": "Method Not allowed", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "Text explaining the reason for the error" }, "error": { "type": "string" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 500, "status": "Internal Server Error", "name": "Internal Server Error", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "Text explaining the reason for the error" }, "error": { "type": "string" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] }, { "name": "APN bundle products", "description": "Retrieve APN by ID", "request": { "auth": [], "method": "Get", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } ], "url": { "raw": "api.mtn\/apn-bundles", "protocol": "https", "host": [ "api", "mtn" ], "path": [ "v1", "networks", "apn-bundles" ], "query": [ { "key": "transactionId", "value": "", "required": true, "type": "string", "description": "Transaction ID" }, { "key": "sourceIdentifier", "value": "", "required": true, "type": "string", "description": "Source system" }, { "key": "thirdPartyId", "value": "", "required": true, "type": "string", "description": "Partner" } ] } }, "response": [ { "code": 200, "status": "OK", "name": "An APN", "schema": { "transactionId": { "type": "string" }, "statusCode": { "type": "string" }, "supportMessage": { "type": "string" }, "statusMessage": { "type": "string" }, "data": { "productList": { "productName": { "type": "string" }, "denomination": { "type": "string", "example": "500GB" }, "productCode": { "type": "string" }, "productDescription": { "type": "string" }, "productType": { "type": "string" } } }, "_links": { "self": { "href": { "type": "string" }, "type": { "type": "string", "example": "POST" } } } }, "body": "{\"transactionId\":\"string\",\"statusCode\":\"string\",\"supportMessage\":\"string\",\"statusMessage\":\"string\",\"data\":{\"productList\":{\"productName\":\"string\",\"denomination\":\"string\",\"productCode\":\"string\",\"productDescription\":\"string\",\"productType\":\"string\"}},\"_links\":{\"self\":{\"href\":\"string\",\"type\":\"string\"}}}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 404, "status": "Not Found", "name": "APN not found", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 400, "status": "Bad Request", "name": "Bad Request", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Unauthorized", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 403, "status": "Forbidden", "name": "Forbidden", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 405, "status": "Method Not Allowed", "name": "Method Not allowed", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "Text explaining the reason for the error" }, "error": { "type": "string" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 500, "status": "Internal Server Error", "name": "Internal Server Error", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "Text explaining the reason for the error" }, "error": { "type": "string" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] }, { "name": "To add product to an existing APN of the MTN partner .", "description": "This API is used to add product .", "request": { "auth": [], "method": "Post", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } ], "url": { "raw": "api.mtn\/apn-bundles", "protocol": "https", "host": [ "api", "mtn" ], "path": [ "v1", "networks", "apn-bundles" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "transactionId", "value": "", "description": "Unique identifier of the transaction.Fixed length '15' characters.", "required": 0, "type": "string" }, { "key": "sourceIdentifier", "value": "", "description": "Identifies the source system which is initiating the request.", "required": 0, "type": "string" }, { "key": "apnId", "value": "", "description": "APN Id to which product is being added.", "required": 0, "type": "string" }, { "key": "thirdPartyId", "value": "", "description": "Unique Identifier of the third party system.", "required": 0, "type": "string" }, { "key": "productCode", "value": "", "description": "Code of the product that is being added.", "required": 0, "type": "string" }, { "key": "productType", "value": "", "description": "Ad hoc or Recurring type", "required": 0, "type": "string" }, { "key": "action", "value": "", "description": "Action Code e.g, 'ADD'", "required": 0, "type": "string" } ] } }, "response": [ { "code": 102, "status": "Processing", "name": "Request is received and is under processing", "schema": { "transactionId": { "type": "string", "description": "Unique identifier of the transaction.Fixed length '15' characters" }, "statusCode": { "type": "string", "description": "Status of the transaction \u2022 0- Success \u2022 Any value other than 0- Failure" }, "supportMessage": { "type": "string", "description": "Support message for the transaction." }, "statusMessage": { "type": "string", "description": "Indicates status of transaction" }, "referenceNumber": { "type": "string", "description": "Reference number of the transaction" } }, "body": "{\"transactionId\":\"string\",\"statusCode\":\"string\",\"supportMessage\":\"string\",\"statusMessage\":\"string\",\"referenceNumber\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 400, "status": "Bad Request", "name": "Bad request.", "schema": { "transactionId": { "type": "string", "description": "Unique identifier of the transaction.Fixed length '15' characters" }, "statusCode": { "type": "string", "description": "Status of the transaction" }, "supportMessage": { "type": "string", "description": "Support message for the transaction." }, "statusMessage": { "type": "string", "description": "Indicates status of transaction" } }, "body": "{\"transactionId\":\"string\",\"statusCode\":\"string\",\"supportMessage\":\"string\",\"statusMessage\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Request has not been applied due to lack of valid authentication credentials.", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 403, "status": "Forbidden", "name": "Request recieved successfully but server refuses to authorize.", "schema": { "transactionId": { "type": "string", "description": "Unique identifier of the transaction.Fixed length '15' characters" }, "statusCode": { "type": "string", "description": "Status of the transaction" }, "supportMessage": { "type": "string", "description": "Support message for the transaction." }, "statusMessage": { "type": "string", "description": "Indicates status of transaction" } }, "body": "{\"transactionId\":\"string\",\"statusCode\":\"string\",\"supportMessage\":\"string\",\"statusMessage\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 200, "status": "OK", "name": "Transaction Success", "schema": { "transactionId": { "type": "string", "description": "Unique identifier of the transaction.Fixed length '15' characters" }, "statusCode": { "type": "string", "description": "Status of the transaction \u2022 0- Success \u2022 Any value other than 0- Failure" }, "supportMessage": { "type": "string", "description": "Support message for the transaction." }, "statusMessage": { "type": "string", "description": "Indicates status of transaction" }, "referenceNumber": { "type": "string", "description": "Reference of the transaction." } }, "body": "{\"transactionId\":\"string\",\"statusCode\":\"string\",\"supportMessage\":\"string\",\"statusMessage\":\"string\",\"referenceNumber\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 500, "status": "Internal Server Error", "name": "Other failure", "schema": { "transactionId": { "type": "string", "description": "Unique identifier of the transaction.Fixed length '15' characters" }, "statusCode": { "type": "string", "description": "Status of the transaction \u2022 0- Success \u2022 Any value other than 0- Failure" }, "supportMessage": { "type": "string", "description": "Support message for the transaction." }, "statusMessage": { "type": "string", "description": "Indicates status of transaction" }, "referenceNumber": { "type": "string", "description": "Reference of the transaction." } }, "body": "{\"transactionId\":\"string\",\"statusCode\":\"string\",\"supportMessage\":\"string\",\"statusMessage\":\"string\",\"referenceNumber\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] }, { "name": "To remove product from the existing APN of the MTN partner.", "description": "This API is used to remove product.", "request": { "auth": [], "method": "Delete", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } ], "url": { "raw": "api.mtn\/apn-bundles", "protocol": "https", "host": [ "api", "mtn" ], "path": [ "v1", "networks", "apn-bundles" ], "query": [ { "key": "transactionId", "value": "", "required": true, "type": "string", "description": "Unique identifier of the transaction.Fixed length '15' characters" }, { "key": "sourceIdentifier", "value": "", "required": true, "type": "string", "description": "Identifies the source system which is initiating the request." }, { "key": "apnId", "value": "", "required": true, "type": "string", "description": "APN Id on which the given bundle is removed ." }, { "key": "thirdPartyId", "value": "", "required": true, "type": "string", "description": "Unique Identifier of the third party system." }, { "key": "productCode", "value": "", "required": true, "type": "string", "description": "Code of the product that is being removed ." }, { "key": "productType", "value": "", "required": true, "type": "string", "description": "Type of the product e.g, 'Adhoc' or 'Recurring'" }, { "key": "action", "value": "", "required": true, "type": "string", "description": "Action Code i.e, 'REMOVE'" } ] } }, "response": [ { "code": 102, "status": "Processing", "name": "Request is received and is under processing", "schema": { "transactionId": { "type": "string", "description": "Unique identifier of the transaction.Fixed length '15' characters" }, "statusCode": { "type": "string", "description": "Status of the transaction \u2022 0- Success \u2022 Any value other than 0- Failure" }, "supportMessage": { "type": "string", "description": "Support message for the transaction." }, "statusMessage": { "type": "string", "description": "Indicates status of transaction" }, "referenceNumber": { "type": "string", "description": "Reference number of the transaction" } }, "body": "{\"transactionId\":\"string\",\"statusCode\":\"string\",\"supportMessage\":\"string\",\"statusMessage\":\"string\",\"referenceNumber\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 400, "status": "Bad Request", "name": "Bad request.", "schema": { "transactionId": { "type": "string", "description": "Unique identifier of the transaction.Fixed length '15' characters" }, "statusCode": { "type": "string", "description": "Status of the transaction" }, "supportMessage": { "type": "string", "description": "Support message for the transaction." }, "statusMessage": { "type": "string", "description": "Indicates status of transaction" } }, "body": "{\"transactionId\":\"string\",\"statusCode\":\"string\",\"supportMessage\":\"string\",\"statusMessage\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Request has not been applied due to lack of valid authentication credentials.", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 403, "status": "Forbidden", "name": "Request recieved successfully but server refuses to authorize.", "schema": { "transactionId": { "type": "string", "description": "Unique identifier of the transaction.Fixed length '15' characters" }, "statusCode": { "type": "string", "description": "Status of the transaction" }, "supportMessage": { "type": "string", "description": "Support message for the transaction." }, "statusMessage": { "type": "string", "description": "Indicates status of transaction" } }, "body": "{\"transactionId\":\"string\",\"statusCode\":\"string\",\"supportMessage\":\"string\",\"statusMessage\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 200, "status": "OK", "name": "Transaction Success", "schema": { "transactionId": { "type": "string", "description": "Unique identifier of the transaction.Fixed length '15' characters" }, "statusCode": { "type": "string", "description": "Status of the transaction \u2022 0- Success \u2022 Any value other than 0- Failure" }, "supportMessage": { "type": "string", "description": "Support message for the transaction." }, "statusMessage": { "type": "string", "description": "Indicates status of transaction" }, "referenceNumber": { "type": "string", "description": "Reference of the transaction." } }, "body": "{\"transactionId\":\"string\",\"statusCode\":\"string\",\"supportMessage\":\"string\",\"statusMessage\":\"string\",\"referenceNumber\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 500, "status": "Internal Server Error", "name": "Other failure", "schema": { "transactionId": { "type": "string", "description": "Unique identifier of the transaction.Fixed length '15' characters" }, "statusCode": { "type": "string", "description": "Status of the transaction \u2022 0- Success \u2022 Any value other than 0- Failure" }, "supportMessage": { "type": "string", "description": "Support message for the transaction." }, "statusMessage": { "type": "string", "description": "Indicates status of transaction" }, "referenceNumber": { "type": "string", "description": "Reference of the transaction." } }, "body": "{\"transactionId\":\"string\",\"statusCode\":\"string\",\"supportMessage\":\"string\",\"statusMessage\":\"string\",\"referenceNumber\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] }, { "name": "MSISDN - APN Association", "description": "Associate MSISDN to APN", "request": { "auth": [], "method": "Post", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } ], "url": { "raw": "api.mtn\/apns\/associate-apn", "protocol": "https", "host": [ "api", "mtn" ], "path": [ "v1", "networks", "apns", "associate-apn" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "transactionId", "value": "", "description": "Unique identifier of the transaction.Fixed length '15' characters.", "required": 1, "type": "string" }, { "key": "sourceIdentifier", "value": "", "description": "Identifies the source system which is initiating the request.", "required": 1, "type": "string" }, { "key": "callBackUrl", "value": "", "description": "Partner URL to post associate response", "required": 0, "type": "string" }, { "key": "msisdn", "value": "", "description": "Subscriber mobile number.", "required": 1, "type": "string" }, { "key": "thirdPartyId", "value": "", "description": "Unique Identifier of the third party system.", "required": 1, "type": "string" }, { "key": "apnList", "value": "", "description": "APN List to which given MSISDN is associated.", "required": 0, "type": "array" } ] } }, "response": [ { "code": 102, "status": "Processing", "name": "Request is received and is under processing", "schema": { "transactionId": { "type": "string", "description": "Unique identifier of the transaction.Fixed length '15' characters" }, "statusCode": { "type": "string", "description": "Status of the transaction \u2022 0- Success \u2022 Any value other than 0- Failure" }, "supportMessage": { "type": "string", "description": "Support message for the transaction." }, "statusMessage": { "type": "string", "description": "Indicates status of transaction" }, "referenceNumber": { "type": "string", "description": "Reference number of the transaction" } }, "body": "{\"transactionId\":\"string\",\"statusCode\":\"string\",\"supportMessage\":\"string\",\"statusMessage\":\"string\",\"referenceNumber\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 200, "status": "OK", "name": "OK", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 400, "status": "Bad Request", "name": "Bad Request", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Unauthorized", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 403, "status": "Forbidden", "name": "Forbidden", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 404, "status": "Not Found", "name": "Not Found", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "Text explaining the reason for the error" }, "error": { "type": "string" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 405, "status": "Method Not Allowed", "name": "Method Not allowed", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "Text explaining the reason for the error" }, "error": { "type": "string" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 500, "status": "Internal Server Error", "name": "Internal Server Error", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "Text explaining the reason for the error" }, "error": { "type": "string" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] }, { "name": "MSISDN - APN Dissociation", "description": "Dissociate MSISDN to APN", "request": { "auth": [], "method": "Post", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } ], "url": { "raw": "api.mtn\/apns\/dissociate-apn", "protocol": "https", "host": [ "api", "mtn" ], "path": [ "v1", "networks", "apns", "dissociate-apn" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "transactionId", "value": "", "description": "Unique identifier of the transaction.Fixed length '15' characters.", "required": 1, "type": "string" }, { "key": "sourceIdentifier", "value": "", "description": "Identifies the source system which is initiating the request.", "required": 1, "type": "string" }, { "key": "callBackUrl", "value": "", "description": "Partner URL to post associate response", "required": 0, "type": "string" }, { "key": "msisdn", "value": "", "description": "Subscriber mobile number.", "required": 1, "type": "string" }, { "key": "thirdPartyId", "value": "", "description": "Unique Identifier of the third party system.", "required": 1, "type": "string" }, { "key": "apnList", "value": "", "description": "APN List to which given MSISDN is associated.", "required": 0, "type": "array" } ] } }, "response": [ { "code": 102, "status": "Processing", "name": "Request is received and is under processing", "schema": { "transactionId": { "type": "string", "description": "Unique identifier of the transaction.Fixed length '15' characters" }, "statusCode": { "type": "string", "description": "Status of the transaction \u2022 0- Success \u2022 Any value other than 0- Failure" }, "supportMessage": { "type": "string", "description": "Support message for the transaction." }, "statusMessage": { "type": "string", "description": "Indicates status of transaction" }, "referenceNumber": { "type": "string", "description": "Reference number of the transaction" } }, "body": "{\"transactionId\":\"string\",\"statusCode\":\"string\",\"supportMessage\":\"string\",\"statusMessage\":\"string\",\"referenceNumber\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 200, "status": "OK", "name": "OK", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 400, "status": "Bad Request", "name": "Bad Request", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Unauthorized", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 403, "status": "Forbidden", "name": "Forbidden", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 404, "status": "Not Found", "name": "Not Found", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "Text explaining the reason for the error" }, "error": { "type": "string" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 405, "status": "Method Not Allowed", "name": "Method Not allowed", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "Text explaining the reason for the error" }, "error": { "type": "string" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 500, "status": "Internal Server Error", "name": "Internal Server Error", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "Text explaining the reason for the error" }, "error": { "type": "string" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] }, { "name": "Validate third party", "description": "Third party verificatiom", "request": { "auth": [], "method": "Post", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } ], "url": { "raw": "api.mtn\/apns\/validate-party", "protocol": "https", "host": [ "api", "mtn" ], "path": [ "v1", "networks", "apns", "validate-party" ], "query": [ { "key": "transactionId", "value": "", "required": true, "type": "string", "description": "Transaction ID" }, { "key": "sourceIdentifier", "value": "", "required": true, "type": "string", "description": "Source system" }, { "key": "thirdPartyId", "value": "", "required": true, "type": "string", "description": "Partner" } ] } }, "response": [ { "code": 200, "status": "OK", "name": "ThirdParty APN Information", "schema": { "transactionId": { "type": "string" }, "statusCode": { "type": "string" }, "supportMessage": { "type": "string" }, "statusMessage": { "type": "string" }, "data": { "apnDetails": { "apnId": { "type": "string" }, "apnName": { "type": "string" }, "thirdPartyId": { "type": "string" }, "customerId": { "type": "string" }, "debtorId": { "type": "string" } } }, "_links": { "self": { "href": { "type": "string" }, "type": { "type": "string", "example": "POST" } } } }, "body": "{\"transactionId\":\"string\",\"statusCode\":\"string\",\"supportMessage\":\"string\",\"statusMessage\":\"string\",\"data\":{\"apnDetails\":{\"apnId\":\"string\",\"apnName\":\"string\",\"thirdPartyId\":\"string\",\"customerId\":\"string\",\"debtorId\":\"string\"}},\"_links\":{\"self\":{\"href\":\"string\",\"type\":\"string\"}}}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 404, "status": "Not Found", "name": "not found", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 400, "status": "Bad Request", "name": "Bad Request", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Unauthorized", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 403, "status": "Forbidden", "name": "Forbidden", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 405, "status": "Method Not Allowed", "name": "Method Not allowed", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "Text explaining the reason for the error" }, "error": { "type": "string" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 500, "status": "Internal Server Error", "name": "Internal Server Error", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "Text explaining the reason for the error" }, "error": { "type": "string" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] }, { "name": "Verify APN", "description": "remove msisdn from a given APN", "request": { "auth": [], "method": "Post", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } ], "url": { "raw": "api.mtn\/apns\/verify-apn", "protocol": "https", "host": [ "api", "mtn" ], "path": [ "v1", "networks", "apns", "verify-apn" ], "query": [ { "key": "transactionId", "value": "", "required": true, "type": "string", "description": "Transaction ID" }, { "key": "sourceIdentifier", "value": "", "required": true, "type": "string", "description": "Source system" }, { "key": "apnId", "value": "", "required": true, "type": "string", "description": "apn id" }, { "key": "thirdPartyId", "value": "", "required": true, "type": "string", "description": "Partner" } ] } }, "response": [ { "code": 200, "status": "OK", "name": "APN info for third party", "schema": { "transactionId": { "type": "string" }, "statusCode": { "type": "string" }, "supportMessage": { "type": "string" }, "statusMessage": { "type": "string" }, "data": { "apnDetails": { "apnId": { "type": "string" }, "apnName": { "type": "string" }, "thirdPartyId": { "type": "string" }, "customerId": { "type": "string" }, "debtorId": { "type": "string" } } }, "_links": { "self": { "href": { "type": "string" }, "type": { "type": "string", "example": "POST" } } } }, "body": "{\"transactionId\":\"string\",\"statusCode\":\"string\",\"supportMessage\":\"string\",\"statusMessage\":\"string\",\"data\":{\"apnDetails\":{\"apnId\":\"string\",\"apnName\":\"string\",\"thirdPartyId\":\"string\",\"customerId\":\"string\",\"debtorId\":\"string\"}},\"_links\":{\"self\":{\"href\":\"string\",\"type\":\"string\"}}}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 400, "status": "Bad Request", "name": "Bad Request", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Unauthorized", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 403, "status": "Forbidden", "name": "Forbidden", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 404, "status": "Not Found", "name": "Not Found", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "Text explaining the reason for the error" }, "error": { "type": "string" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 405, "status": "Method Not Allowed", "name": "Method Not allowed", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "Text explaining the reason for the error" }, "error": { "type": "string" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 500, "status": "Internal Server Error", "name": "Internal Server Error", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "Text explaining the reason for the error" }, "error": { "type": "string" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] }, { "name": "Sim swap", "description": "Sim swap", "request": { "auth": [], "method": "Put", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } ], "url": { "raw": "api.mtn\/sims", "protocol": "https", "host": [ "api", "mtn" ], "path": [ "v1", "networks", "sims" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "transactionId", "value": "", "description": "Unique identifier of the transaction.", "required": 0, "type": "string" }, { "key": "sourceIdentifier", "value": "", "description": "Identifies the source system which is initiating the request.", "required": 0, "type": "string" }, { "key": "msisdn", "value": "", "description": "Subscriber mobile number.Atleast oldSimNumber or msisdn need to be provided in the request.", "required": 0, "type": "string" }, { "key": "oldSimNumber", "value": "", "description": "Subscriber Identity Module number of the subscriber.Atleast oldSimNumber or msisdn need to be provided in the request.", "required": 0, "type": "string" }, { "key": "newSimNumber", "value": "", "description": "Subscriber Identity Module number of the subscriber.", "required": 0, "type": "string" }, { "key": "thirdpartyId", "value": "", "description": "Unique Identifier of the third party system.", "required": 0, "type": "string" }, { "key": "requestedProcessingStartDate", "value": "", "description": "Processing start date of the given request as wished by the third party customer. E.g :- 2019-04-21T17:32:28Z", "required": 0, "type": "string" } ] } }, "response": [ { "code": 200, "status": "OK", "name": "OK", "schema": { "transactionId": { "type": "string", "description": "Unique identifier for every request to SOA. Mapped from input request" }, "statusCode": { "type": "string", "description": "Status of the transaction \u2022 0- Success \u2022 Any value other than 0- Failure" }, "supportMessage": { "type": "string", "description": "Support message for the transaction." }, "statusMessage": { "type": "string", "description": "Indicates status of transaction" } }, "body": "{\"transactionId\":\"string\",\"statusCode\":\"string\",\"supportMessage\":\"string\",\"statusMessage\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 400, "status": "Bad Request", "name": "Bad Request", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Unauthorized", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "Text explaining the reason for the error" }, "error": { "type": "string" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 403, "status": "Forbidden", "name": "Forbidden", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "Text explaining the reason for the error" }, "error": { "type": "string" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 404, "status": "Not Found", "name": "Not Found", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "Text explaining the reason for the error" }, "error": { "type": "string" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 405, "status": "Method Not Allowed", "name": "Method Not allowed", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "Text explaining the reason for the error" }, "error": { "type": "string" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 500, "status": "Internal Server Error", "name": "Internal Server Error", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Error response code" }, "status": { "type": "string", "description": "Text explaining the reason for the error" }, "error": { "type": "string" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] } ] }