{ "info": { "name": "Usage Management API", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Retrieves usage history for a subscriber's MSISDN", "description": "This operation retrieves all the call details record for a subscriber like SMS, Voice and Data usage history.", "request": { "auth": [], "method": "Get", "header": { "0": { "key": "transactionId", "name": "transactionId", "value": "", "type": "string", "description": "Client generated Id to include for tracing requests." }, "5": { "key": "countryCode", "name": "countryCode", "value": "", "type": "string", "description": "Will be used internally by application" }, "6": { "key": "Content-Type", "name": "Content-Type", "value": "application\/json;charset=utf-8", "type": "application\/json", "description": "" } }, "url": { "raw": "api.mtn.com\/usage\/{id}", "protocol": "https", "host": [ "api", "mtn", "com" ], "path": [ "usageManagement", "v1", "usage", "{id}" ], "query": [ { "key": "usageType", "value": "", "required": true, "type": "string", "description": "Type of usage. Valid values are 'VOI' for voice,'SMS' for sms, 'DAT' for data and 'ALL' for all type of usages" }, { "key": "startTime", "value": "", "required": false, "type": "string", "description": "Query filter based on the start time selected to fetch the CDR." }, { "key": "endTime", "value": "", "required": false, "type": "string", "description": "Query filter based on the end time selected to fetch the CDR." } ] } }, "response": [ { "code": 200, "status": "OK", "name": "Success", "schema": { "resultCode": { "example": "200", "type": "string", "description": "Result code. Example- '0000'" }, "resultDescription": { "example": "Transaction successful", "type": "string", "description": "Result message. Example- 'Successfully processed'" }, "transactionId": { "example": "6f0bece6-7df3-4da4-af02-5e7f16e5e6fc", "type": "string", "description": "Transaction id returned by the provider system." }, "MSISDN": { "example": "234903*******", "type": "string", "description": "This is the calling number or subscriber unique identifier, which is subscriber MSSIDN id." }, "data": { "id": { "type": "string", "description": "Unique identifier. This can be customer's msisdn with country code etc." }, "description": { "type": "string", "description": "Description of usage", "enum": [ "On-net call", "off-net call", "international call" ] }, "usageDate": { "example": "2020-09-21T09:13:16-07:00", "type": "string", "format": "date-time", "description": "Date of usage" }, "balanceType": { "type": "string", "description": "Type of balance from where usage got deducted.", "enum": [ "DA", "MA", "4G-peak time" ] }, "status": { "type": "string", "default": "", "description": "received,rejected,recycled,guided,rated,rerated,billed" }, "usageCharacteristic": { "name": { "type": "string", "description": "Name of the characteristic" }, "valueType": { "type": "string", "description": "Data type of the value of the characteristic" }, "value": { "type": "string", "description": "The value of the characteristic" } }, "usageSpecification": { "id": { "type": "string", "description": "unique identifier" }, "name": { "type": "string", "description": "The name of the usage specification", "enum": [ "Voice", "SMS", "Data" ] } } } }, "body": "{\"resultCode\":\"string\",\"resultDescription\":\"string\",\"transactionId\":\"string\",\"MSISDN\":\"string\",\"data\":{\"id\":\"string\",\"description\":\"string\",\"usageDate\":\"string\",\"balanceType\":\"string\",\"status\":\"string\",\"usageCharacteristic\":{\"name\":\"string\",\"valueType\":\"string\",\"value\":\"string\"},\"usageSpecification\":{\"id\":\"string\",\"name\":\"string\"}}}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 400, "status": "Bad Request", "name": "Bad Request", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": 401, "status": "Unauthorized", "name": "Unauthorized", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": 409, "status": "Conflict", "name": "Conflict", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": "Retrieves Out of bundle usage charge for a Subscriber's MSISDN", "description": "This operation retrieves all the out of bundle usage charges applied to a subscriber.", "request": { "auth": [], "method": "Get", "header": { "0": { "key": "transactionId", "name": "transactionId", "value": "", "type": "string", "description": "Client generated Id to include for tracing requests." }, "2": { "key": "countryCode", "name": "countryCode", "value": "", "type": "string", "description": "Will be used internally by application" }, "3": { "key": "Content-Type", "name": "Content-Type", "value": "application\/json;charset=utf-8", "type": "application\/json", "description": "" } }, "url": { "raw": "api.mtn.com\/usageCharge\/{id}", "protocol": "https", "host": [ "api", "mtn", "com" ], "path": [ "usageManagement", "v1", "usageCharge", "{id}" ], "query": [ { "key": "usageType", "value": "", "required": true, "type": "string", "description": "" } ] } }, "response": [ { "code": 200, "status": "OK", "name": "Success", "schema": { "resultCode": { "example": "200", "type": "string", "description": "Result code. Example- '0000'" }, "resultDescription": { "example": "Transaction successful", "type": "string", "description": "Result message. Example- 'Successfully processed'" }, "transactionId": { "example": "6f0bece6-7df3-4da4-af02-5e7f16e5e6fc", "type": "string", "description": "Transaction id returned by the provider system." }, "data": { "usageDate": { "example": "2020-09-21", "type": "string", "description": "Date of usage. Format is 'YYYY-MM-DD'" }, "voiceCharge": { "unit": { "type": "string", "description": "Currency of the charge aplied", "example": "RWF" }, "value": { "type": "number", "format": "float", "description": "value of the usage charge applied to a subscriber", "example": 133.34 } }, "smsCharge": { "unit": { "type": "string", "description": "Currency of the charge aplied", "example": "RWF" }, "value": { "type": "number", "format": "float", "description": "value of the usage charge applied to a subscriber", "example": 133.34 } }, "dataCharge": { "unit": { "type": "string", "description": "Currency of the charge aplied", "example": "RWF" }, "value": { "type": "number", "format": "float", "description": "value of the usage charge applied to a subscriber", "example": 133.34 } } } }, "body": "{\"resultCode\":\"string\",\"resultDescription\":\"string\",\"transactionId\":\"string\",\"data\":{\"usageDate\":\"string\",\"voiceCharge\":{\"unit\":\"string\",\"value\":\"\"},\"smsCharge\":{\"unit\":\"string\",\"value\":\"\"},\"dataCharge\":{\"unit\":\"string\",\"value\":\"\"}}}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 400, "status": "Bad Request", "name": "Bad Request", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": 401, "status": "Unauthorized", "name": "Unauthorized", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": 409, "status": "Conflict", "name": "Conflict", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": "Retrieves recharge history details for a Subscriber's MSISDN", "description": "This operation retrieves all the recharge hostory of a subscriber.", "request": { "auth": [], "method": "Get", "header": { "1": { "key": "transactionId", "name": "transactionId", "value": "", "type": "string", "description": "Client generated Id to include for tracing requests." }, "2": { "key": "Content-Type", "name": "Content-Type", "value": "application\/json;charset=utf-8", "type": "application\/json", "description": "" } }, "url": { "raw": "api.mtn.com\/recharge\/{id}", "protocol": "https", "host": [ "api", "mtn", "com" ], "path": [ "usageManagement", "v1", "recharge", "{id}" ], "query": [ { "key": "startTime", "value": "", "required": 0, "type": "string", "description": "Query filter based on the start time selected to fetch the CDR." }, { "key": "endTime", "value": "", "required": 0, "type": "string", "description": "Query filter based on the end time selected to fetch the CDR." }, { "key": "pageNo", "value": "", "required": 0, "type": "integer", "description": "Current Page" }, { "key": "limit", "value": "", "required": 0, "type": "integer", "description": "Limit the list of results returned by an API. Optional, If its not specified we should return all the values." } ] } }, "response": [ { "code": 200, "status": "OK", "name": "Success", "schema": { "resultCode": { "example": "200", "type": "string", "description": "Result code. Example- '0000'" }, "resultDescription": { "example": "Transaction successful", "type": "string", "description": "Result message. Example- 'Successfully processed'" }, "transactionId": { "example": "6f0bece6-7df3-4da4-af02-5e7f16e5e6fc", "type": "string", "description": "Transaction id returned by the provider system." }, "data": { "subscriberId": { "example": "250788123456", "type": "string", "description": "Mobile number that the money is recharged to." }, "rechargeDate": { "example": "20200106225722", "type": "string", "format": "date-time", "description": "Date of recharge" }, "rechargeHistory": { "description": { "example": "Recharge description", "type": "string", "description": "Description of recharge" }, "payType": { "type": "string", "description": "Type of payment", "enum": [ "MoMo", "VC", "USSD", "Bank" ] }, "rechargeAmount": { "type": "string", "description": "Total amount used to recharge", "example": "100" } }, "adjustmentType": { "type": "string", "example": "RECHARGE" }, "amountBefore": { "type": "integer", "example": "-108.700000" }, "amountAfter": { "type": "string", "example": "8.700000" }, "transaction": { "type": "string", "example": "Voucher" } } }, "body": "{\"resultCode\":\"string\",\"resultDescription\":\"string\",\"transactionId\":\"string\",\"data\":{\"subscriberId\":\"string\",\"rechargeDate\":\"string\",\"rechargeHistory\":{\"description\":\"string\",\"payType\":\"string\",\"rechargeAmount\":\"string\"},\"adjustmentType\":\"string\",\"amountBefore\":1,\"amountAfter\":\"string\",\"transaction\":\"string\"}}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 400, "status": "Bad Request", "name": "Bad Request", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": 401, "status": "Unauthorized", "name": "Unauthorized", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": 409, "status": "Conflict", "name": "Conflict", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": "Retrieves usage history for a subscriber's MSISDN", "description": "This operation retrieves all the call details record for a subscriber like SMS, Voice and Data usage history.", "request": { "auth": [], "method": "Get", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application\/json;charset=utf-8", "type": "application\/json", "description": "" } ], "url": { "raw": "api.mtn.com\/transaction\/{id}", "protocol": "https", "host": [ "api", "mtn", "com" ], "path": [ "usageManagement", "v1", "transaction", "{id}" ], "query": [ { "key": "idType", "value": "", "required": true, "type": "string", "description": "The type of Id to filter with." }, { "key": "startTime", "value": "", "required": 0, "type": "string", "description": "Query filter based on the start time selected to fetch the data." }, { "key": "endTime", "value": "", "required": 0, "type": "string", "description": "Query filter based on the end time selected to fetch the data." }, { "key": "pageNo", "value": "", "required": 0, "type": "integer", "description": "Current Page" }, { "key": "limit", "value": "", "required": 0, "type": "integer", "description": "Limit the list of results returned by an API. Optional, If its not specified or if specified amount is too big, we should return 50 rows" }, { "key": "offset", "value": "", "required": 0, "type": "integer", "description": "number of first row to skip before returning maxRowsPerPage. e.g 100, 1000" }, { "key": "order", "value": "", "required": 0, "type": "string", "description": "Ascending ot Descending Order for the list of results returned by an API." }, { "key": "sort", "value": "", "required": 0, "type": "string", "description": "The field to sort the order by." } ] } }, "response": [ { "code": 200, "status": "OK", "name": "Success", "schema": { "resultCode": { "example": "200", "type": "string", "description": "Result code. Example- '0000'" }, "resultDescription": { "example": "Success", "type": "string", "description": "Result message. Example- 'Successfully processed'" }, "transactionId": { "example": "6f0bece6-7df3-4da4-af02-5e7f16e5e6fc", "type": "string", "description": "Transaction id returned by the provider system." }, "data": { "uid": { "example": "101114652149351570", "type": "string", "description": "unique id" }, "amount": { "example": 100, "type": "integer", "description": "" }, "account": { "example": "+2347030976868", "type": "string", "description": "" }, "date": { "example": "2016-06-06T11:09:39Z", "type": "string", "description": "" }, "bankId": { "example": 9, "type": "string", "description": "" }, "bankName": { "example": "FBN", "type": "string", "description": "" }, "externalCustomerId": { "example": "+2349001231231", "type": "string", "description": "" }, "externalTransactionId": { "example": "internal-101114652149351570", "type": "string", "description": "" }, "failureType": { "example": "PRODUCT_NOT_FOUND", "type": "string", "description": "" }, "merchantName": { "example": null, "type": "string", "description": "" }, "paymentMethodId": { "example": "202XXXX627", "type": "string", "description": "" }, "productName": { "example": null, "type": "string", "description": "" }, "status": { "example": "successful", "type": "string", "description": "Status value is an enum of pending, pproved and rejected", "enum": [ "successful", "reverted", "failed", "progress", "chargedback" ] }, "terminalShortCode": { "example": null, "type": "string", "description": "" }, "channel": { "example": "USSD", "type": "string", "description": "" }, "_links": { "self": { "type": "string", "example": "https:\/\/api.mtn.com\/usageManagement\/v1\/transaction\/27832000000" } } } }, "body": "{\"resultCode\":\"string\",\"resultDescription\":\"string\",\"transactionId\":\"string\",\"data\":{\"uid\":\"string\",\"amount\":1,\"account\":\"string\",\"date\":\"string\",\"bankId\":\"string\",\"bankName\":\"string\",\"externalCustomerId\":\"string\",\"externalTransactionId\":\"string\",\"failureType\":\"string\",\"merchantName\":\"string\",\"paymentMethodId\":\"string\",\"productName\":\"string\",\"status\":\"string\",\"terminalShortCode\":\"string\",\"channel\":\"string\",\"_links\":{\"self\":\"string\"}}}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 400, "status": "Bad Request", "name": "Bad Request", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": 401, "status": "Unauthorized", "name": "Unauthorized", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": 409, "status": "Conflict", "name": "Conflict", "schema": { "timestamp": { "type": "string", "format": "date-time", "description": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "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": "Time stamp of the error" }, "status": { "type": "string", "description": "Status\/Error code returned from the provider system" }, "error": { "type": "string", "description": "Status\/Error description" }, "message": { "type": "string", "description": "More error details and corrective measures" }, "path": { "type": "string", "description": "the path that caused the error" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] } ] }