Services List

This section of the documentation describes how the list of services can be retrieved. Services are categorised and can be retrieved based on the category

Get Services List

GET https://gwapisdbx.ellypayapp.com/service-payments/services-list?category=

Returns the list of services based on the category. Supported categories are AIRTIME, INTERNET, WATER, ELECTRICITY, TAXES, MMONEY

Query Parameters

Name	Type	Description
category*	String	The category of services to be retrieved

Headers

Name	Type	Description
public-key*	String	The Public Key as shared in the approval email

Sample Services Request

curl https://gwapisdbx.ellypayapp.com/service-payments/services-list?category=AIRTIME \
   -H "Accept: application/json" \
   -H "x-api-version: 1" \
   -H "public-key: your-public-key"

200: OK Returns the list of services matching the query

{
    "code": 200,
    "status": "success",
    "message": "Request completed successfully.",
    "data": [
        {
            "code": "MTNAirtime",
            "name": "MTN Airtime",
            "category_code": "AIRTIME",
            "category": "Airtime",
            "has_packages": false,
            "has_choices": false,
            "is_billable": false,
            "account_field_label": "MTN Phone Number",
            "account_length": 12,
            "min_amount": 500,
            "max_amount": 1500000,
            "is_active": true
        },
        {
            "code": "MTNVoice",
            "name": "MTN Voice Bundles",
            "category_code": "AIRTIME",
            "category": "Airtime",
            "has_packages": true,
            "has_choices": false,
            "is_billable": false,
            "account_field_label": "MTN Phone Number",
            "account_length": 10,
            "min_amount": 500,
            "max_amount": 2000000,
            "is_active": true
        }
    ]
}

Response Description

Parameter	Type	Description
code	string	The unique code for the service. It is required for other API requests as will be described
name	string	The name of the service
category_code	string	The service category code
category	string	The service category name
has_packages	Boolean	Indicates whether the service has a price list of packages that are subscribed for.
has_choices	Boolean	Indicates wether the service has a list of choices that support its purchase.
is_billable	Boolean	Indicates whether EllyPay charges you for purchasing this service
account_field_label	string	A suggested label to be used on when displaying the payment form on your platform
account_length	Number	The expected length of the account number used for the service payment e.g. a phone number
min_amount	Number	The minimum allowed amount for this service
max_amount	Number	The maximum allowed amount for this service
is_active	Boolean	Whether the service is active to be transacted with.

400: Bad Request When the request is not formed as expected

{
  "code": 400,
  "status": "error",
  "message": "unrecognized category",
  "data": {}
}