Skip to main content
POST
/
billpay
/
bulk-create-customer-control-numbers
cURL
curl --request POST \
  --url https://api.clickpesa.com/third-parties/billpay/bulk-create-customer-control-numbers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "controlNumbers": [
    {
      "customerName": "John Doe",
      "customerEmail": "john@example.com",
      "billAmount": 25000
    },
    {
      "customerName": "Jane Smith",
      "customerPhone": "255712345678",
      "billReference": "CUST002"
    }
  ]
}
'
{
  "billPayNumbers": [
    "<string>"
  ],
  "created": 123,
  "failed": 123,
  "errors": [
    {
      "index": 123,
      "reason": "<string>"
    }
  ]
}

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...

Body

application/json
​
controlNumbers
object[]
required

Array of customer control number items

Required array length: 1 - 50 elements

Response

Bulk create result - may include partial success with per-item errors

​
billPayNumbers
string[]

Array of successfully created BillPay numbers

​
created
number

Count of successfully created control numbers

​
failed
number

Count of failed items

​
errors
object[]

Present only when failed > 0