Service Choices List

Some service items have choice lists that support their purchase. This section describes how a service's choice list can be obtained.

Obtaining a service choice list relates to services returned here and the value for has_choices is true. Every item in the choice list represents a choice a customer would make in order to facilitate their payment. Currently, only NWSC has a defined choice list and it's ID is NWSC.Area. Whenever more choice list IDs are created, the document will be updated accordingly

Get Service Choices List

GET https://gwapisdbx.ellypayapp.com/service-payments/choice-list?listId=

Returns the list of service choices based on the specified choice list type/ID. The list ID is passed as query parameter to retrieve the choices accordingly.

Query Parameters

Name	Type	Description
listId*	String	The ID for the choice list to be obtained in the request.

Headers

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

Sample Service Choices Request

curl https://gwapisdbx.ellypayapp.com/service-payments/choice-list?listId=NWSC.Area \
   -H "Accept: application/json" \
   -H "x-api-version: 1" \
   -H "public-key: your-public-key"

200: OK Returns the list of choices

{
    "code": 200,
    "status": "success",
    "message": "Request completed successfully.",
    "data": [
        {
            "code": "NWSC.Area:Entebbe",
            "name": "Entebbe",
            "description": "Entebbe",
            "is_active": true
        },
        {
            "code": "NWSC.Area:Iganga",
            "name": "Iganga",
            "description": "Iganga",
            "is_active": true
        },
        {
            "code": "NWSC.Area:Jinja",
            "name": "Jinja",
            "description": "Jinja",
            "is_active": true
        },
        {
            "code": "NWSC.Area:Kajjansi",
            "name": "Kajjansi",
            "description": "Kajjansi",
            "is_active": true
        },
        {
            "code": "NWSC.Area:Kampala",
            "name": "Kampala",
            "description": "Kampala",
            "is_active": true
        },
        {
            "code": "NWSC.Area:Kawuku",
            "name": "Kawuku",
            "description": "Kawuku",
            "is_active": true
        },
        {
            "code": "NWSC.Area:Other",
            "name": "Other NWSC Areas",
            "description": "Other NWSC Areas",
            "is_active": true
        }
    ]
}

Response Description

Parameter	Type	Description
code	string	The unique code for the choice. During validation, this would be sent in the request as one of the additional parameters.
name	string	The name of the choice
description	string	The description of the choice
is_active	Boolean	Whether or not this choice can be used in the payment process

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

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

Supported Choice Lists

List ID	Description
NWSC.Area	Returns the list of the different NWSC areas