Sign in

Generates a BillPay Control Number for a specific customer

post/billpay/create-customer-control-number

Request body

customerNamestring required

Name of the customer

customerEmailstring

Email address of the customer (required if customerPhone is not provided)

customerPhonestring

Phone number of the customer (required if customerEmail is not provided), starting with country code and without the plus sign, e.g., 255712345678

billDescriptionstring

Description of the bill

billPaymentMode'ALLOW_PARTIAL_AND_OVER_PAYMENT' | 'EXACT'

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

billAmountnumber

Amount of the bill

billReferencestring

Custom bill reference (alphanumeric). If provided, this will be the number used to make payment. If not provided, the system auto-generates one

Example request

{
  "billDescription": "Water Bill - July 2024",
  "billAmount": 90900
}

Response

Successfully generated Customer BillPay Control Number

updatedAtstring date-time

Last updated timestamp

createdAtstring date-time

Creation timestamp

idstring

Payout ID

orderReferencestring

Associated order reference

amountstring

Payout amount

currencystring

Currency code

feestring

Transaction fee

status'SUCCESS' | 'PROCESSING' | 'PENDING' | 'FAILED' | 'REFUNDED' | 'REVERSED'

Payout status

channel'BANK TRANSFER' | 'MOBILE MONEY'

Payout channel

channelProviderstring

Name of the payout channel provider

transferType'ACH' | 'RTGS'

Transfer type - when applicable

notesstring

Additional notes if available

clientIdstring

Application Client ID associated with the payout

Changes