Usage Management

AVAILABLE IN

Nigeria

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

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.
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
{
    "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"
        }
    }
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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

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": "string",
    "resultDescription": "string",
    "transactionId": "string",
    "data": {
        "usageDate": "string",
        "voiceCharge": {
            "unit": "string",
            "value": ""
        },
        "smsCharge": {
            "unit": "string",
            "value": ""
        },
        "dataCharge": {
            "unit": "string",
            "value": ""
        }
    }
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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

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": "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"
    }
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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

Query parameters

idType string required
The type of Id to filter with.
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": "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"
        }
    }
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
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": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}