{ "info": { "name": "Customer Data Share API", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Share Data", "description": "Provides the ability to share data with customer.", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" } ] }, "method": "Post", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } ], "url": { "raw": "api.mtn.com\/customers\/{senderMsisdn}\/dataShare", "protocol": "https", "host": [ "api", "mtn", "com" ], "path": [ "v1", "datashare", "customers", "{senderMsisdn}", "dataShare" ], "query": [ { "key": "productcode", "value": "", "required": true, "type": "string", "description": "The product code e.g NACT_NG_others_1" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "receiverMsisdn", "value": "", "description": "The beneficiary msisdn. The format must be E.123", "required": 1, "type": "string" }, { "key": "requestedDataAmount", "value": "", "description": "Total amount of data to be shared with the customer in MBs", "required": 1, "type": "string" } ] } }, "response": [ { "code": 200, "status": "OK", "name": "Success", "schema": { "statusCode": { "type": "string", "description": "HTTP Error code extension", "example": "0000" }, "statusMessage": { "type": "string", "example": "Success" }, "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "data": { "productName": { "type": "string", "example": "Share 100MB" }, "notification": { "type": "string", "example": "You have successfully transferred 100MB Data to 2349062058463." } }, "_link": { "self": { "href": { "type": "string", "example": "https:\/\/api.mtn.com\/v1\/customers\/2348064816493\/dataShare" } } } }, "body": "{\"statusCode\":\"string\",\"statusMessage\":\"string\",\"transactionId\":\"string\",\"data\":{\"productName\":\"string\",\"notification\":\"string\"},\"_link\":{\"self\":{\"href\":\"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": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"string\",\"Error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Unauthorized", "schema": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"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": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"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": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"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 No Allowed", "schema": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"string\",\"Error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 406, "status": "Not Acceptable", "name": "Not acceptable", "schema": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"string\",\"Error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 415, "status": "Unsupported Media Type", "name": "Unsupported media Type", "schema": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"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": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"string\",\"Error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] }, { "name": "Retrieve Receivers' MSISDN", "description": "Provides the ability to retrieve all registered receiver's msisdn.", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" } ] }, "method": "Get", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } ], "url": { "raw": "api.mtn.com\/customers\/{senderMsisdn}\/dataShare", "protocol": "https", "host": [ "api", "mtn", "com" ], "path": [ "v1", "datashare", "customers", "{senderMsisdn}", "dataShare" ] } }, "response": [ { "code": 200, "status": "OK", "name": "Success", "schema": { "statusCode": { "type": "string", "description": "HTTP Error code extension" }, "statusMessage": { "type": "string", "example": "Data Successfully Retrieved" }, "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "data": { "receiverMsisdn": { "type": "string", "example": "2345957585859", "description": "The beneficiary msisdn. The format must be E.123" }, "requestedDataAmount": { "type": "string", "example": "100", "description": "Total amount of data to be shared with the customer in MBs" } }, "_link": { "self": { "href": { "type": "string", "example": "https:\/\/api.mtn.com\/v1\/customers\/2348064816493\/dataShare" } } } }, "body": "{\"statusCode\":\"string\",\"statusMessage\":\"string\",\"transactionId\":\"string\",\"data\":{\"receiverMsisdn\":\"string\",\"requestedDataAmount\":\"string\"},\"_link\":{\"self\":{\"href\":\"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": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"string\",\"Error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Unauthorized", "schema": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"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": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"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": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"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 No Allowed", "schema": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"string\",\"Error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 406, "status": "Not Acceptable", "name": "Not acceptable", "schema": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"string\",\"Error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 415, "status": "Unsupported Media Type", "name": "Unsupported media Type", "schema": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"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": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"string\",\"Error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] }, { "name": "Update Receiver's information", "description": "Provides the ability to update the receiver's msisdn and sharable data amount.", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" } ] }, "method": "Patch", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } ], "url": { "raw": "api.mtn.com\/customers\/{senderMsisdn}\/dataShare", "protocol": "https", "host": [ "api", "mtn", "com" ], "path": [ "v1", "datashare", "customers", "{senderMsisdn}", "dataShare" ] }, "body": { "mode": "formdata", "formdata": [ { "key": "receiverMsisdn", "value": "", "description": "The beneficiary msisdn. The format must be E.123", "required": 1, "type": "string" }, { "key": "requestedDataAmount", "value": "", "description": "Total amount of data to be shared with the customer in MBs", "required": 1, "type": "string" } ] } }, "response": [ { "code": 200, "status": "OK", "name": "Success", "schema": { "statusCode": { "type": "string", "description": "HTTP Error code extension", "example": "0000" }, "statusMessage": { "type": "string", "example": "Action Successful" }, "_link": { "self": { "href": { "type": "string", "example": "https:\/\/api.mtn.com\/v1\/customers\/2348064816493\/dataShare" } } } }, "body": "{\"statusCode\":\"string\",\"statusMessage\":\"string\",\"_link\":{\"self\":{\"href\":\"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": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"string\",\"Error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Unauthorized", "schema": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"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": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"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": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"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 No Allowed", "schema": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"string\",\"Error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 406, "status": "Not Acceptable", "name": "Not acceptable", "schema": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"string\",\"Error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 415, "status": "Unsupported Media Type", "name": "Unsupported media Type", "schema": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"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": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"string\",\"Error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] }, { "name": "Remove Receiver's Msisdn", "description": "Provides the ability for removing receiver's msisdn.", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" } ] }, "method": "Delete", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } ], "url": { "raw": "api.mtn.com\/customers\/{senderMsisdn}\/dataShare", "protocol": "https", "host": [ "api", "mtn", "com" ], "path": [ "v1", "datashare", "customers", "{senderMsisdn}", "dataShare" ], "query": [ { "key": "receiverMsisdn", "value": "", "required": 0, "type": "string", "description": "The beneficiary msisdn. The format must be E.123" } ] } }, "response": [ { "code": 200, "status": "OK", "name": "Success", "schema": { "statusCode": { "type": "string", "description": "HTTP Error code extension", "example": "0000" }, "statusMessage": { "type": "string", "example": "Action Successful" }, "_link": { "self": { "href": { "type": "string", "example": "https:\/\/api.mtn.com\/v1\/customers\/2348064816493\/dataShare" } } } }, "body": "{\"statusCode\":\"string\",\"statusMessage\":\"string\",\"_link\":{\"self\":{\"href\":\"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": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"string\",\"Error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Unauthorized", "schema": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"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": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"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": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"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 No Allowed", "schema": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"string\",\"Error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 406, "status": "Not Acceptable", "name": "Not acceptable", "schema": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"string\",\"Error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 415, "status": "Unsupported Media Type", "name": "Unsupported media Type", "schema": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"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": { "transactionId": { "type": "string", "description": "Client generated Id to include for tracing requests." }, "timestamp": { "type": "string", "format": "date-time", "description": "Timestamps of Error", "example": "2020-04-02T07:29:25.593+0000" }, "statusCode": { "type": "string", "description": "Error Code", "example": "1000" }, "Error": { "type": "string", "description": "Short Description", "example": "NOT_FOUND" }, "message": { "type": "string", "description": "More Error details and corrective measures", "example": "" }, "path": { "type": "string", "description": "The path to the request", "example": "https:\/\/api.mtn.com\/v1\/" } }, "body": "{\"transactionId\":\"string\",\"timestamp\":\"string\",\"statusCode\":\"string\",\"Error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] } ] }