Skip to main content
GET
/
billpay
/
{billPayNumber}
cURL
curl --request GET \
  --url https://api.clickpesa.com/third-parties/billpay/{billPayNumber} \
  --header 'Authorization: Bearer <token>'
{
  "billPayNumber": "55042914871931",
  "billDescription": "Generic Bamboo Chees",
  "billCustomerName": "Mr. Freddie Walker-Graham",
  "billAmount": 90900,
  "billPaymentMode": "EXACT"
}

Authorizations

​
Authorization
string
header
required

Authorization header containing the JWT access token returned from the generate token endpoint. The token already includes the Bearer prefix. Example: Authorization: Bearer eyJhbGciOi...

Path Parameters

​
billPayNumber
string
required

BillPay number to query for details

Response

Successfully queried for BillPay number details

​
billPayNumber
string

BillPay number - This is the number that will be used to make payment. If a custom billReference was provided in the request, this will match that value.

Example:

"55042914871931"

​
billDescription
string

Description of the bill

Example:

"Generic Bamboo Chees"

​
billCustomerName
string

Name of the customer - for customer billpay numbers

Example:

"Mr. Freddie Walker-Graham"

​
billAmount
number

Amount of the bill

Example:

90900

​
billPaymentMode
string

Payment mode for the bill. Applied only when billAmount is set

Example:

"EXACT"