Bill Number

This is a POST request that is responsible for saving billing information for a particular service.

Note: A valid token is required for authentication as it expires after every hour. Refer to Token Request to generate a new token.

The required Json body contains :

serviceId: This is a number that represents the different services available. Check the Find Bill Services api for the list of service Ids

accountNumber: Account number reference for pay bill transactions.

phoneNumber: This is the mobile number of the customer doing the payment

transactionDesc: This is a brief description of the payment.

RemindMeDueDate: This is a boolean, that can be set to notify a customer of the due date of payment of a service.

Data definition

Field Name	Data Type	Options
serviceId	integer	Mandatory
accountNumber	string	Mandatory
phoneNumber	string	Optional
transactionDesc	string	Optional
RemindMeDueDate	boolean	Optional

Sample success response:

{
    "message": {
        "appDomainName": "TEST",
        "remarks": "Bill Number submission accepted",
        "serviceCode": null,
        "accountCustomerName": "LTD EXECUTIVE CONCEPTS",
        "systemConversationId": "01100000-0017-0a00-1eb8-08de8fec6193",
        "lastKnownBalance": 231.56,
        "dueDate": "2020-07-03",
        "verified": true,
        "timestamp": "2026-04-01T12:44:16.3555322Z"
    }
}

Sample failed response:

{
    "appDomainName": "LIVE",
    "timestamp": "2021-10-18T07:14:53.1362329Z",
    "reason": "Account number number is invalid."
}

Sample validation errors response:

{
    "errors": {
        "AccountNumber": [
            "The AccountNumber field is required."
        ]
    },
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "traceId": "00-03529608f740804d9e7bf8210d6e1cb9-df15d6e73e04804c-00"
}

curl --location --request POST '/v1/bill-numbers' \ --header 'Content-Type: application/json' \ --data-raw '{ "serviceId": "bc97d2b1-4828-f111-bc5a-0w7d952d79b7", "accountNumber": "1111777", "phoneNumber": "254710000000", "transactionDesc": "TransactionDesc", "RemindMeDueDate": true }'

Data definition#

Sample success response:#

Sample failed response:#

Sample validation errors response:#

Request

Responses

Data definition

Sample success response:

Sample failed response:

Sample validation errors response: