Service Packages List

Some services have packages OR a price list that describes the available items for payment/subscription. This section describes how a service's price/package list can be obtained.

Obtaining a packages list relates to services returned here and the value for has_packages is true

Get Service Packages List

GET https://gwapisdbx.ellypayapp.com/service-payments/service-packages?serviceCode=

Returns the list of service packages based on the service code. The service code is passed as query parameter to retrieve the packages accordingly.

Query Parameters

Name	Type	Description
serviceCode*	String	The service code for the service whose packages are to be obtained in the request.

Headers

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

Sample Service Packages Request

curl https://gwapisdbx.ellypayapp.com/service-payments/service-packages?serviceCode=MTNData \
   -H "Accept: application/json" \
   -H "x-api-version: 1" \
   -H "public-key: your-public-key"

200: OK Returns the list of service packages

{
    "code": 200,
    "status": "success",
    "message": "Request completed successfully.",
    "data": [
        {
            "code": "MTNData_33067121",
            "name": "MTN 70MB Daily Bundle",
            "currency": "UGX",
            "price": 500
        },
        {
            "code": "MTNData_9259874",
            "name": "MTN 25MB Monthly Bundle",
            "currency": "UGX",
            "price": 1500
        },
        {
            "code": "MTNData_40297551",
            "name": "MTN 512MB Monthly Bundle",
            "currency": "UGX",
            "price": 5500
        },
        {
            "code": "MTNData_49894758",
            "name": "MTN 165MB Daily Bundle",
            "currency": "UGX",
            "price": 1000
        }
    ]
}

Response Description

Parameter	Type	Description
code	string	The unique code for the service package. During validation, this would be the service code.
name	string	The name of the service package
currency	string	The currency in which the service payment is done
price	Number	The cost of the service package. This is what the merchant pays for the package

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

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