Bulk Create Order Control Numbers

Bulk creates BillPay Order Control Numbers (max 50 per request). Supports partial success: valid items are created while invalid items are reported in the errors array.

POST /billpay/bulk-create-order-control-numbers

cURL

cURL

curl --request POST \
  --url https://api.clickpesa.com/third-parties/billpay/bulk-create-order-control-numbers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "controlNumbers": [
    {
      "billAmount": 25000,
      "billDescription": "Order 1"
    },
    {
      "billReference": "ORD002",
      "billAmount": 50000
    }
  ]
}
'

200

{
  "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 order control number items

Required array length: 1 - 50 elements

Show child attributes

Response

200

application/json

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

Show child attributes