Product Offering v3

AVAILABLE IN

Nigeria Rwanda Uganda

Download

Download Postman collection Download Swagger

Available endpoints

GET products/{customerId}

Description

Retrieves the catalogue of Products available for purchase.

Header parameters

Content-Type application/json

Auth parameters

apikey X-API-Key
200OK
customerId string
data
voice
daily
id string
Identifies the product. This must be an echoed back input from the 3pp
name string
The name of the product.
currency string
ISO 4217 Three-letter ISO code for the currency.
amount string
The amount that the product will cost
bundleCategory string
The category of the bundle
bundleType string
The type of the bundle
weekly
id string
Identifies the product. This must be an echoed back input from the 3pp
name string
The name of the product.
currency string
ISO 4217 Three-letter ISO code for the currency.
amount string
The amount that the product will cost
bundleCategory string
The category of the bundle
bundleType string
The type of the bundle
monthly
id string
Identifies the product. This must be an echoed back input from the 3pp
name string
The name of the product.
currency string
ISO 4217 Three-letter ISO code for the currency.
amount string
The amount that the product will cost
bundleCategory string
The category of the bundle
bundleType string
The type of the bundle
_link
self
href string
data
daily
id string
Identifies the product. This must be an echoed back input from the 3pp
name string
The name of the product.
currency string
ISO 4217 Three-letter ISO code for the currency.
amount string
The amount that the product will cost
bundleCategory string
The category of the bundle
bundleType string
The type of the bundle
weekly
id string
Identifies the product. This must be an echoed back input from the 3pp
name string
The name of the product.
currency string
ISO 4217 Three-letter ISO code for the currency.
amount string
The amount that the product will cost
bundleCategory string
The category of the bundle
bundleType string
The type of the bundle
monthly
id string
Identifies the product. This must be an echoed back input from the 3pp
name string
The name of the product.
currency string
ISO 4217 Three-letter ISO code for the currency.
amount string
The amount that the product will cost
bundleCategory string
The category of the bundle
bundleType string
The type of the bundle
_link
self
href string
yolo
daily
id string
Identifies the product. This must be an echoed back input from the 3pp
name string
The name of the product.
currency string
ISO 4217 Three-letter ISO code for the currency.
amount string
The amount that the product will cost
bundleCategory string
The category of the bundle
bundleType string
The type of the bundle
weekly
id string
Identifies the product. This must be an echoed back input from the 3pp
name string
The name of the product.
currency string
ISO 4217 Three-letter ISO code for the currency.
amount string
The amount that the product will cost
bundleCategory string
The category of the bundle
bundleType string
The type of the bundle
monthly
id string
Identifies the product. This must be an echoed back input from the 3pp
name string
The name of the product.
currency string
ISO 4217 Three-letter ISO code for the currency.
amount string
The amount that the product will cost
bundleCategory string
The category of the bundle
bundleType string
The type of the bundle
_link
self
href string 
{
    "customerId": "string",
    "data": {
        "voice": {
            "daily": {
                "id": "string",
                "name": "string",
                "currency": "string",
                "amount": "string",
                "bundleCategory": "string",
                "bundleType": "string"
            },
            "weekly": {
                "id": "string",
                "name": "string",
                "currency": "string",
                "amount": "string",
                "bundleCategory": "string",
                "bundleType": "string"
            },
            "monthly": {
                "id": "string",
                "name": "string",
                "currency": "string",
                "amount": "string",
                "bundleCategory": "string",
                "bundleType": "string"
            },
            "_link": {
                "self": {
                    "href": "string"
                }
            }
        },
        "data": {
            "daily": {
                "id": "string",
                "name": "string",
                "currency": "string",
                "amount": "string",
                "bundleCategory": "string",
                "bundleType": "string"
            },
            "weekly": {
                "id": "string",
                "name": "string",
                "currency": "string",
                "amount": "string",
                "bundleCategory": "string",
                "bundleType": "string"
            },
            "monthly": {
                "id": "string",
                "name": "string",
                "currency": "string",
                "amount": "string",
                "bundleCategory": "string",
                "bundleType": "string"
            },
            "_link": {
                "self": {
                    "href": "string"
                }
            }
        },
        "yolo": {
            "daily": {
                "id": "string",
                "name": "string",
                "currency": "string",
                "amount": "string",
                "bundleCategory": "string",
                "bundleType": "string"
            },
            "weekly": {
                "id": "string",
                "name": "string",
                "currency": "string",
                "amount": "string",
                "bundleCategory": "string",
                "bundleType": "string"
            },
            "monthly": {
                "id": "string",
                "name": "string",
                "currency": "string",
                "amount": "string",
                "bundleCategory": "string",
                "bundleType": "string"
            },
            "_link": {
                "self": {
                    "href": "string"
                }
            }
        }
    }
}
400Bad Request
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string 
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
401Unauthorized
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string 
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
403Forbidden
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string 
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
404Not Found
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string 
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
405Method Not Allowed
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string 
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
500Internal Server Error
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string 
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
GET products/{customerId}/{productId}

Description

Retrieve the details of a given product most especially to view it's price

Header parameters

Content-Type application/json

Auth parameters

apikey X-API-Key

Query parameters

transactionId string
Transaction ID
200OK
customerId string
data object 
{
    "customerId": "string",
    "data": {
        "id": "97",
        "name": "Daily bundle of 15MB",
        "currency": "UGX",
        "amount": 250,
        "bundleCategory": "3G Bundle Daily",
        "bundleType": "DATA",
        "bundleValidaty": "1 Days",
        "_link": {
            "self": {
                "href": "string"
            }
        }
    }
}
400Bad Request
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string 
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
401Unauthorized
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string 
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
403Forbidden
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string 
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
404Not Found
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string 
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
405Method Not Allowed
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string 
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
500Internal Server Error
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string 
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}

Check out some of our other products.

MTN

Transaction Summaries v1

View the product

ug flag
View
MTN

Customer Consent

For Consent validation

ng flag
View
MTN

Customer Authorization

View the product

ng flag
View