Usage Management

AVAILABLE IN

Ghana Nigeria Rwanda Zambia

Download

Download Postman collection Download Swagger

Available endpoints

GET usageManagement/v1/usage/{id}

Description

This operation retrieves all the call details record for a subscriber like SMS, Voice and Data usage history.

Header parameters

transactionId string
Client generated Id to include for tracing requests.
countryCode string
Will be used internally by application
Content-Type application/json

Auth parameters

oauth2 Authorization

Query parameters

usageType string required
Type of usage. Valid values are 'VOI' for voice,'SMS' for sms, 'DAT' for data and 'ALL' for all type of usages
startTime string
Query filter based on the start time selected to fetch the CDR.
endTime string
Query filter based on the end time selected to fetch the CDR.
200OK
resultCode string
Result code. Example- '0000'
resultDescription string
Result message. Example- 'Successfully processed'
transactionId string
Transaction id returned by the provider system.
MSISDN string
This is the calling number or subscriber unique identifier, which is subscriber MSSIDN id.
data
id string
Unique identifier. This can be customer's msisdn with country code etc.
description string
Description of usage
usageDate string
Date of usage
balanceType string
Type of balance from where usage got deducted.
usageType string
Type of usage
status string
received,rejected,recycled,guided,rated,rerated,billed
usageCharacteristic
name string
Name of the characteristic
valueType string
Data type of the value of the characteristic
value string
The value of the characteristic
usageSpecification
id string
unique identifier
name string
The name of the usage specification
ratedProductUsage
bucketValueConvertedInAmount
unit string
Currency of the charge aplied
value number
value of the usage charge applied to a subscriber
otherDetails
byteSent string
Quantity of Bytes sent
byteReceived string
Quantity of bytes received
balanceBefore string
Balance amount value before the the service
balanceAfter string
Balance amount after the service
balanceDetails
accountId string
account ID
amountBefore string
amount before
amountAfter string
amount after
amountCharged string
Amount charged
{
    "resultCode": [],
    "resultDescription": [],
    "transactionId": [],
    "MSISDN": [],
    "data": []
}
400Bad Request
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
401Unauthorized
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
403Forbidden
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
404Not Found
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
405Method Not Allowed
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
409Conflict
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
500Internal Server Error
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
GET usageManagement/v1/caag/{id}

Description

This operation retrieves all the call details record for a subscriber like SMS, Voice and Data usage history.

Header parameters

limit integer
pageNo integer
pageSize integer
Will be used internally by application
Content-Type application/json

Auth parameters

oauth2 Authorization

Query parameters

startTime string
Query filter based on the start time selected to fetch the CDR.
endTime string
Query filter based on the end time selected to fetch the CDR.
200OK
resultCode string
Result code. Example- '0000'
resultDescription string
Result message. Example- 'Successfully processed'
transactionId string
Transaction id returned by the provider system.
apiStatus
statusMsg string
Result message. Example- 'Successfully processed'
statusCode string
Result code. Example- '0000'
transactionId string
Transaction id returned by the provider system.
msisdn string
This is the calling number or subscriber unique identifier, which is subscriber MSSIDN id.
dateRange string
contains the date range
apiData
eventTimestampEnrich string
volumeMb string
source string
amount string
usageType string
transactionDate string
billTextCag string
billTextAll string
wallet string
accountBalance string
{
    "resultCode": [],
    "resultDescription": [],
    "transactionId": [],
    "apiStatus": [],
    "apiData": []
}
400Bad Request
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
401Unauthorized
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
403Forbidden
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
404Not Found
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
405Method Not Allowed
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
409Conflict
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
500Internal Server Error
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
GET usageManagement/v1/usageCharge/{id}

Description

This operation retrieves all the out of bundle usage charges applied to a subscriber.

Header parameters

transactionId string
Client generated Id to include for tracing requests.
countryCode string
Will be used internally by application
Content-Type application/json

Auth parameters

oauth2 Authorization

Query parameters

usageType string required
200OK
resultCode string
Result code. Example- '0000'
resultDescription string
Result message. Example- 'Successfully processed'
transactionId string
Transaction id returned by the provider system.
data
usageDate string
Date of usage. Format is 'YYYY-MM-DD'
voiceCharge
unit string
Currency of the charge aplied
value number
value of the usage charge applied to a subscriber
smsCharge
unit string
Currency of the charge aplied
value number
value of the usage charge applied to a subscriber
dataCharge
unit string
Currency of the charge aplied
value number
value of the usage charge applied to a subscriber
{
    "resultCode": [],
    "resultDescription": [],
    "transactionId": [],
    "data": []
}
400Bad Request
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
401Unauthorized
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
403Forbidden
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
404Not Found
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
405Method Not Allowed
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
409Conflict
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
500Internal Server Error
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
GET usageManagement/v1/usage/{customerId}/history

Description

Retrieves data for a specific MSISDN.

Header parameters

transactionId string
Transaction Id to identify the request
x-authorization string
The partner account identifier
Content-Type application/json

Auth parameters

oauth2 Authorization

Query parameters

startDate string
The start date to retrieve records. Format yyyyMMdd eg. 20210302
endDate string
The end date to retrieve records. Format yyyyMMdd eg. 20210302
momoPartnerId string
Momo partner Identifier eg. 2600110005124
200OK
statusCode string
The canonical
statusMessage string
transactionId string
customerId string
The customer msisdn
data
kyc
firstName string
lastName string
dateOfBirth string
format "yyyy-MM-dd"
gender string
idType string
idNumber string
momoId number
msisdnRandom number
momo
withdrawalMaxAmt6m number
sendAmt1m number
bankTransferAmt1m number
bankTransferMaxAmt3m number
billPaymentQty1m number
sendQty1m number
receivedAcceptorsQty3m number
billPaymentAcceptorsQt1 number
billPaymentMaxAmt3m number
sendAcceptorsQty1m number
receivedMaxAmt3m number
withdrawalAmt6m number
receivedQty3m number
withdrawalLastDate string
format "yyyy-MM-dd"
withdrawalAmt3m number
sendMaxAmt1m number
withdrawalAmt1m number
registrationDate string
format yyyy-MM-dd
depositAmt1m number
withdrawalMaxAmt1m number
depositAcceptorsQty3m number
billPaymentAcceptorsQt3 number
depositAmt6m number
withdrawalAcceptorsQty1m number
receivedMaxAmt1m number
depositMaxAmt3m number
depositQty3m number
withdrawalAcceptorsQty6m number
billPaymentLastDate string
format "yyyy-MM-dd"
bankTransferAmt6m number
receivedQty6m number
billPaymentAmt1m number
withdrawalQty3m number
billPaymentQty3m number
billPaymentMaxAmt1m number
receivedaAmt1m number
withdrawalAcceptorsqty3m number
billPaymentQty6m number
sendAmt3m number
bankTransferMaxAmt6m number
receivedLastDate string
format "yyyy-MM-dd"
sendqQty3m number
bankTransferQty6m number
sendAcceptorsQty6m number
withdrawalQty1m number
bankTransferAmt3m number
bankTransferLastDate string
format "yyyy-MM-dd"
sendMaxAmt6m number
sendMaxAmt3m number
depositQty1m number
depositLastDate string
format "yyyy-MM-dd"
receivedAcceptorsQty6m number
sendQty6m number
billPaymentAcceptorsQt6 number
withdrawalQty6m number
depositQty6m number
bankTransferMaxAmt1m number
depositAcceptorsQty1m number
bankTransferAccptrsQt6 number
depositMaxAmt1m number
depositAcceptorsQty6m number
sendAcceptorsQty3m number
depositMaxAmt6m number
receivedQty1m number
receivedAcceptorsQty1m number
withdrawalMaxAmt3m number
billPaymentAmt6m number
bankTransferAccptrsQt3 number
bankTransferQty3m number
bankTransferAccptrsQt1 number
receivedMaxAmt6m number
receivedAmt6m number
receivedAmt3m number
depositAmt3m number
sendAmt6m number
bankTransferQty1m number
sendLastDate string
format "yyyy-MM-dd"
billPaymentAmt3m number
billPaymentMaxAmt6m number
gsm
avgBundSize3m number
topupMethod string
npt string
timesBlockedPoQty6m number
sUcid string
me2uReceivedAmt3m number
datVolAmt6m number
avgTopupAmt6m number
uniqInAnumQty3m number
ntaAmt1m number
dabQty3m number
nauAmt3m number
networkTown string
poLimitAmt number
me2uReceivedQty3m number
pUsid string
deviceMake string
nrd string
format yyyy-MM-dd
imeiQty1m number
daysBundLess2mb1m number
uniqOutbnumQty3m number
nauAmt1m number
inCallsQty3m number
avgBundSize6m number
inCallsQty6m number
datVolAmt3m number
timesBlockedPoQty1m number
outcallsQty1m number
avgTopupAmt3m number
imsiNr string
uniqInAnumQty6m number
avgBundSize1m number
avgTopupAmt1m number
me2uReceivedAmt6m number
activeDaysQty6m number
ntaAmt3m number
laDaysQty number
dabQty1m number
daysBundLess2mb3m number
me2uReceivedQty1m number
inCallsQty1m number
uniqInAnumQty1m number
datVolAmt1m number
imsiQty1m number
outCallsQty6m number
activeDaysQty3m number
uniqOutBnumQty6m number
lastBundlePurchase string
format "yyyy-MM-dd"
timesBlockedPoQty3m number
dabQty6m number
activeDaysQty1m number
me2uReceivedQty6m number
nauAmt6m number
ntaAmt6m number
me2uReceivedAmt1m number
daysBundLess2mb6m number
imeiNr number
uniqOutBnumQty1m number
sUsid string
outCallsQty3m number
atcLoans
overdue number
maxTerm number
totTerm number
lastDate string
format "yyyy-MM-dd"
qty6m number
amtTot number
qty1m number
lastOverdue string
format "yyyy-MM-dd"
firstDate string
format "yyyy-MM-dd"
qty3m number
maxCompletenessDate string
format yyyy-MM-dd
ewpAccountHolderTypeCd string
createDate string
format yyyy-MM-dd
opcoCd string
{
    "statusCode": [],
    "statusMessage": [],
    "transactionId": [],
    "customerId": [],
    "data": []
}
400Bad Request
statusCode string
This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details and corrective actions related to the error which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
msisdn string
This is the same msisdn that is sent in the request
timestamp string
Timestamp of the error
_links
self
href string
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "msisdn": [],
    "timestamp": [],
    "_links": []
}
401Unauthorized
statusCode string
This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details and corrective actions related to the error which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
msisdn string
This is the same msisdn that is sent in the request
timestamp string
Timestamp of the error
_links
self
href string
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "msisdn": [],
    "timestamp": [],
    "_links": []
}
403Forbidden
statusCode string
This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details and corrective actions related to the error which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
msisdn string
This is the same msisdn that is sent in the request
timestamp string
Timestamp of the error
_links
self
href string
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "msisdn": [],
    "timestamp": [],
    "_links": []
}
404Not Found
statusCode string
This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details and corrective actions related to the error which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
msisdn string
This is the same msisdn that is sent in the request
timestamp string
Timestamp of the error
_links
self
href string
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "msisdn": [],
    "timestamp": [],
    "_links": []
}
405Method Not Allowed
statusCode string
This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details and corrective actions related to the error which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
msisdn string
This is the same msisdn that is sent in the request
timestamp string
Timestamp of the error
_links
self
href string
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "msisdn": [],
    "timestamp": [],
    "_links": []
}
406Not Acceptable
statusCode string
This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details and corrective actions related to the error which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
msisdn string
This is the same msisdn that is sent in the request
timestamp string
Timestamp of the error
_links
self
href string
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "msisdn": [],
    "timestamp": [],
    "_links": []
}
415Unsupported Media Type
statusCode string
This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details and corrective actions related to the error which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
msisdn string
This is the same msisdn that is sent in the request
timestamp string
Timestamp of the error
_links
self
href string
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "msisdn": [],
    "timestamp": [],
    "_links": []
}
500Internal Server Error
statusCode string
This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details and corrective actions related to the error which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
msisdn string
This is the same msisdn that is sent in the request
timestamp string
Timestamp of the error
_links
self
href string
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "msisdn": [],
    "timestamp": [],
    "_links": []
}
POST usageManagement/v1/usage/{customerId}/flags

Description

Turns Marketing and Datasharing flags ON/OFF.

Header parameters

x-authorization string
The partner account identifier
Content-Type application/json

Auth parameters

oauth2 Authorization

FormData parameters

operationName string
To specify the flag to be set
200OK
statusCode string
The canonical
statusMessage string
transactionId string
customerId string
The customer msisdn
dataSharing boolean
if data sharing flag is true then sharing is allowed, else if false then sharing is not allowed
dataSharingExpiryDate string
format is yyyyMMdd
subscriberId string
The subscriber's id number
marketing boolean
if marketing sharing flag is true then sharing is allowed, else if false then sharing is not allowed
{
    "statusCode": [],
    "statusMessage": [],
    "transactionId": [],
    "customerId": [],
    "dataSharing": [],
    "dataSharingExpiryDate": [],
    "subscriberId": [],
    "marketing": []
}
400Bad Request
statusCode string
This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details and corrective actions related to the error which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
msisdn string
This is the same msisdn that is sent in the request
timestamp string
Timestamp of the error
_links
self
href string
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "msisdn": [],
    "timestamp": [],
    "_links": []
}
401Unauthorized
statusCode string
This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details and corrective actions related to the error which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
msisdn string
This is the same msisdn that is sent in the request
timestamp string
Timestamp of the error
_links
self
href string
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "msisdn": [],
    "timestamp": [],
    "_links": []
}
403Forbidden
statusCode string
This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details and corrective actions related to the error which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
msisdn string
This is the same msisdn that is sent in the request
timestamp string
Timestamp of the error
_links
self
href string
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "msisdn": [],
    "timestamp": [],
    "_links": []
}
404Not Found
statusCode string
This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details and corrective actions related to the error which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
msisdn string
This is the same msisdn that is sent in the request
timestamp string
Timestamp of the error
_links
self
href string
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "msisdn": [],
    "timestamp": [],
    "_links": []
}
405Method Not Allowed
statusCode string
This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details and corrective actions related to the error which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
msisdn string
This is the same msisdn that is sent in the request
timestamp string
Timestamp of the error
_links
self
href string
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "msisdn": [],
    "timestamp": [],
    "_links": []
}
406Not Acceptable
statusCode string
This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details and corrective actions related to the error which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
msisdn string
This is the same msisdn that is sent in the request
timestamp string
Timestamp of the error
_links
self
href string
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "msisdn": [],
    "timestamp": [],
    "_links": []
}
415Unsupported Media Type
statusCode string
This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details and corrective actions related to the error which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
msisdn string
This is the same msisdn that is sent in the request
timestamp string
Timestamp of the error
_links
self
href string
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "msisdn": [],
    "timestamp": [],
    "_links": []
}
500Internal Server Error
statusCode string
This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details and corrective actions related to the error which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
msisdn string
This is the same msisdn that is sent in the request
timestamp string
Timestamp of the error
_links
self
href string
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "msisdn": [],
    "timestamp": [],
    "_links": []
}
GET usageManagement/v1/recharge/{id}

Description

This operation retrieves all the recharge hostory of a subscriber.

Header parameters

transactionId string
Client generated Id to include for tracing requests.
Content-Type application/json

Auth parameters

oauth2 Authorization

Query parameters

startTime string
Query filter based on the start time selected to fetch the CDR.
endTime string
Query filter based on the end time selected to fetch the CDR.
pageNo integer
Current Page
limit integer
Limit the list of results returned by an API. Optional, If its not specified we should return all the values.
200OK
resultCode string
Result code. Example- '0000'
resultDescription string
Result message. Example- 'Successfully processed'
transactionId string
Transaction id returned by the provider system.
data
subscriberId string
Mobile number that the money is recharged to.
rechargeDate string
Date of recharge
rechargeHistory
description string
Description of recharge
payType string
Type of payment
rechargeAmount string
Total amount used to recharge
adjustmentType string
amountBefore integer
amountAfter string
transaction string
{
    "resultCode": [],
    "resultDescription": [],
    "transactionId": [],
    "data": []
}
400Bad Request
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
401Unauthorized
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
403Forbidden
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
404Not Found
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
405Method Not Allowed
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
409Conflict
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
500Internal Server Error
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
GET usageManagement/v1/transaction/{id}

Description

This operation retrieves all the call details record for a subscriber like SMS, Voice and Data usage history.

Header parameters

Content-Type application/json

Auth parameters

oauth2 Authorization

Query parameters

idType string required
The type of Id to filter with.
subId string
If the idType is set to TRANSACTION_ID, the subId will be set to the account MSISDN.
startTime string
Query filter based on the start time selected to fetch the data.
endTime string
Query filter based on the end time selected to fetch the data.
pageNo integer
Current Page
limit integer
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
offset integer
number of first row to skip before returning maxRowsPerPage. e.g 100, 1000
order string
Ascending ot Descending Order for the list of results returned by an API.
sort string
The field to sort the order by.
200OK
resultCode string
Result code. Example- '0000'
resultDescription string
Result message. Example- 'Successfully processed'
transactionId string
Transaction id returned by the provider system.
data
uid string
unique id
amount integer
account string
date string
bankId string
bankName string
externalCustomerId string
externalTransactionId string
failureType string
merchantName string
paymentMethodId string
productName string
status string
Status value is an enum of pending, pproved and rejected
terminalShortCode string
channel string
_links
self string
{
    "resultCode": [],
    "resultDescription": [],
    "transactionId": [],
    "data": []
}
400Bad Request
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
401Unauthorized
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
403Forbidden
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
404Not Found
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
405Method Not Allowed
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
409Conflict
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}
500Internal Server Error
timestamp string
Time stamp of the error
status string
Status/Error code returned from the provider system
error string
Status/Error description
message string
More error details and corrective measures
path string
the path that caused the error
{
    "timestamp": [],
    "status": [],
    "error": [],
    "message": [],
    "path": []
}