Products List

EllyPay provides a defined list of items that can be processed for business. The document describes how the list can be obtained.

Get the Products List

Below is the endpoint that's called to get the list of available purchase items. You can alternatively filter using the category by passing the category query parameter:

GET: https://sandbox.ellypayapp.com/merchant/product-list?category=

Request

Query Parameters

Name	Type	Description	Required
category	string	The category of items to be filtered. The value can optionally be one of the following; MMONEY AIRTIME WATER INTERNET TV TAXES ELECTRICITY	NO

Response

Response Body

Parameter	Type	Description
code	string	The unique product code
name	string	Name of the product
category	string	Category of the product
has_price_list	boolean	Indicates whether the product has price list of packages that are subscribed for.
has_choice_list	boolean	Indicates wether the product has a list of choices that support its purchase.
is_billable	boolean	Indicates whether EllyPay charges you for purchasing this product
account_field_label	string	A suggested label to be used on when displaying the payment form on your platform
min_amount	float	The minimum allowed amount for this product
max_amount	float	The maximum allowed amount for this product
status	string	Whether the product is active to be purchase/transacted with.

Sample Response (OK)

{
    "code": 200,
    "status": "success",
    "message": "Request completed successfully.",
    "data": {
        "products": [
            {
                "code": "AZAM",
                "name": "AZAM TV",
                "category": "TV",
                "has_price_list": true,
                "has_choice_list": false,
                "is_billable": true,
                "account_field_label": "Account Number",
                "min_amount": 500,
                "max_amount": 500000,
                "status": "ACTIVE"
            },
            {
                "code": "AfricellAirtime",
                "name": "Africell Airtime",
                "category": "AIRTIME",
                "has_price_list": false,
                "has_choice_list": false,
                "is_billable": false,
                "account_field_label": "Africell Phone Number",
                "min_amount": 500,
                "max_amount": 1000000,
                "status": "ACTIVE"
            },
            {
                "code": "AfricellData",
                "name": "Africell Data Bundles",
                "category": "INTERNET",
                "has_price_list": true,
                "has_choice_list": false,
                "is_billable": false,
                "account_field_label": "Africell Phone Number",
                "min_amount": 500,
                "max_amount": 1000000,
                "status": "ACTIVE"
            },
            {
                "code": "AfricellDeposit",
                "name": "Africell Money Deposit",
                "category": "MMONEY",
                "has_price_list": false,
                "has_choice_list": false,
                "is_billable": false,
                "account_field_label": "Africell Number",
                "min_amount": 500,
                "max_amount": 3000000,
                "status": "INACTIVE"
            },
            {
                "code": "AfricellWithdraw",
                "name": "Africell Money Withdraw",
                "category": "MMONEY",
                "has_price_list": false,
                "has_choice_list": false,
                "is_billable": false,
                "account_field_label": "Africell Number",
                "min_amount": 500,
                "max_amount": 3000000,
                "status": "INACTIVE"
            },
            {
                "code": "AirtelAirtime",
                "name": "Airtel Airtime",
                "category": "AIRTIME",
                "has_price_list": false,
                "has_choice_list": false,
                "is_billable": false,
                "account_field_label": "Airtel Phone Number",
                "min_amount": 500,
                "max_amount": 300000,
                "status": "ACTIVE"
            },
            {
                "code": "AirtelData",
                "name": "Airtel Data Bundles",
                "category": "INTERNET",
                "has_price_list": true,
                "has_choice_list": false,
                "is_billable": false,
                "account_field_label": "Airtel Phone Number",
                "min_amount": 500,
                "max_amount": 1000000,
                "status": "ACTIVE"
            },
            {
                "code": "AirtelDeposit",
                "name": "Airtel Money Deposit",
                "category": "MMONEY",
                "has_price_list": false,
                "has_choice_list": false,
                "is_billable": false,
                "account_field_label": "Airtel Phone Number",
                "min_amount": 500,
                "max_amount": 7000000,
                "status": "ACTIVE"
            },
            {
                "code": "AirtelWithdraw",
                "name": "Airtel Money Withdraw",
                "category": "MMONEY",
                "has_price_list": false,
                "has_choice_list": false,
                "is_billable": false,
                "account_field_label": "Airtel Phone Number",
                "min_amount": 500,
                "max_amount": 7000000,
                "status": "ACTIVE"
            },
            {
                "code": "DSTV",
                "name": "DSTV Multichoice",
                "category": "TV",
                "has_price_list": true,
                "has_choice_list": false,
                "is_billable": true,
                "account_field_label": "Account Number",
                "min_amount": 500,
                "max_amount": 2000000,
                "status": "ACTIVE"
            },
            {
                "code": "GoTV",
                "name": "GoTV",
                "category": "TV",
                "has_price_list": true,
                "has_choice_list": false,
                "is_billable": true,
                "account_field_label": "Account Number",
                "min_amount": 500,
                "max_amount": 2000000,
                "status": "ACTIVE"
            },
            {
                "code": "KCCA",
                "name": "KCCA Payments",
                "category": "TAXES",
                "has_price_list": false,
                "has_choice_list": false,
                "is_billable": true,
                "account_field_label": "PRN",
                "min_amount": 500,
                "max_amount": 7000000,
                "status": "ACTIVE"
            },
            {
                "code": "LYCAMOBILE",
                "name": "LycaMobile Bundles",
                "category": "INTERNET",
                "has_price_list": true,
                "has_choice_list": false,
                "is_billable": false,
                "account_field_label": "LycaMobile Number",
                "min_amount": 500,
                "max_amount": 1000000,
                "status": "ACTIVE"
            },
            {
                "code": "MTNAirtime",
                "name": "MTN Airtime",
                "category": "AIRTIME",
                "has_price_list": false,
                "has_choice_list": false,
                "is_billable": false,
                "account_field_label": "MTN Phone Number",
                "min_amount": 500,
                "max_amount": 1500000,
                "status": "ACTIVE"
            },
            {
                "code": "MTNCombo",
                "name": "MTN Combo Bundles",
                "category": "INTERNET",
                "has_price_list": true,
                "has_choice_list": false,
                "is_billable": false,
                "account_field_label": "MTN Phone Number",
                "min_amount": 500,
                "max_amount": 200000,
                "status": "ACTIVE"
            },
            {
                "code": "MTNData",
                "name": "MTN Data Bundles",
                "category": "INTERNET",
                "has_price_list": true,
                "has_choice_list": false,
                "is_billable": false,
                "account_field_label": "MTN Phone Number",
                "min_amount": 500,
                "max_amount": 1000000,
                "status": "ACTIVE"
            },
            {
                "code": "MTNDeposit",
                "name": "MTN MM Deposit",
                "category": "MMONEY",
                "has_price_list": false,
                "has_choice_list": false,
                "is_billable": false,
                "account_field_label": "MTN Phone Number",
                "min_amount": 500,
                "max_amount": 7000000,
                "status": "ACTIVE"
            },
            {
                "code": "MTNWithdraw",
                "name": "MTN MM Withdraw",
                "category": "MMONEY",
                "has_price_list": false,
                "has_choice_list": false,
                "is_billable": false,
                "account_field_label": "MTN Phone Number",
                "min_amount": 500,
                "max_amount": 7000000,
                "status": "ACTIVE"
            },
            {
                "code": "MTNVoice",
                "name": "MTN Voice Bundles",
                "category": "AIRTIME",
                "has_price_list": true,
                "has_choice_list": false,
                "is_billable": false,
                "account_field_label": "MTN Phone Number",
                "min_amount": 500,
                "max_amount": 200000,
                "status": "ACTIVE"
            },
            {
                "code": "NWSC",
                "name": "National Water & Sewerage Corp",
                "category": "WATER",
                "has_price_list": false,
                "has_choice_list": true,
                "is_billable": true,
                "account_field_label": "NWSC Meter Number",
                "min_amount": 500,
                "max_amount": 1500000,
                "status": "ACTIVE"
            },
            {
                "code": "SmileAirtime",
                "name": "Smile Airtime",
                "category": "AIRTIME",
                "has_price_list": false,
                "has_choice_list": false,
                "is_billable": false,
                "account_field_label": "Smile Account",
                "min_amount": 500,
                "max_amount": 200000,
                "status": "ACTIVE"
            },
            {
                "code": "SmileData",
                "name": "Smile Data Bundles",
                "category": "INTERNET",
                "has_price_list": true,
                "has_choice_list": false,
                "is_billable": false,
                "account_field_label": "Smile Account",
                "min_amount": 500,
                "max_amount": 1000000,
                "status": "ACTIVE"
            },
            {
                "code": "STARTIMES",
                "name": "Startimes",
                "category": "TV",
                "has_price_list": true,
                "has_choice_list": false,
                "is_billable": true,
                "account_field_label": "Account Number",
                "min_amount": 500,
                "max_amount": 2000000,
                "status": "ACTIVE"
            },
            {
                "code": "TUGENDE",
                "name": "Tugende Loan Payments",
                "category": "TAXES",
                "has_price_list": false,
                "has_choice_list": false,
                "is_billable": true,
                "account_field_label": "Customer Number",
                "min_amount": 500,
                "max_amount": 4000000,
                "status": "ACTIVE"
            },
            {
                "code": "UMEMEPp",
                "name": "UMEME Post Paid",
                "category": "ELECTRICITY",
                "has_price_list": false,
                "has_choice_list": false,
                "is_billable": true,
                "account_field_label": "UMEME Meter Number",
                "min_amount": 500,
                "max_amount": 4000000,
                "status": "ACTIVE"
            },
            {
                "code": "YAKA",
                "name": "UMEME Yaka",
                "category": "ELECTRICITY",
                "has_price_list": false,
                "has_choice_list": false,
                "is_billable": true,
                "account_field_label": "YAKA Meter Number",
                "min_amount": 500,
                "max_amount": 4000000,
                "status": "ACTIVE"
            },
            {
                "code": "URA",
                "name": "URA Payments",
                "category": "TAXES",
                "has_price_list": false,
                "has_choice_list": false,
                "is_billable": true,
                "account_field_label": "PRN",
                "min_amount": 500,
                "max_amount": 4000000,
                "status": "ACTIVE"
            },
            {
                "code": "ZUKU",
                "name": "ZUKU TV",
                "category": "TV",
                "has_price_list": true,
                "has_choice_list": false,
                "is_billable": true,
                "account_field_label": "Account Number",
                "min_amount": 500,
                "max_amount": 500000,
                "status": "INACTIVE"
            }
        ]
    }
}

Sample Response (Error)

{
    "code": 422,
    "status": "error",
    "message": "Sorry the request couldn't be completed. System Exception!",
    "data": {}
}