Generate Control Number

Description

This endpoint generates a unique payment control number for payments.

Endpoint

Request

Headers

Request Body

The request body must be a JSON object with the following fields:

Field Type Required Description
uid string Yes A unique identifier for the transaction (e.g. invoice number, loan number)
date string (YYYY-MM-DD) Yes The date of the transaction
amount string Yes The amount of the payment
company_uid string Yes The unique ID of the company/hospital
customer_uid string Yes The unique ID of the customer
customer_name string Yes The full name of the customer
customer_phone string Yes The phone number of the customer
account_uid string Yes The unique ID for the specific account
amount_type string Yes The type of amount (e.g., "FIXED", "FLEXIBLE")
payment_channel string Yes The payment channel (e.g., "MKCB" or "CRDB")
payment_description string Yes A brief description of the payment

Example Request

{
    "uid": "2025092302",
    "date": "2025-09-23",
    "amount": "1000",
    "company_uid": "0002",
    "customer_uid": "989898",
    "customer_name": "John Doe",
    "customer_phone": "0657878299",
    "account_uid": "0001",
    "amount_type": "FIXED",
    "payment_channel": "CRDB",
    "payment_description": "School Fees Payment"
}

Response

Success Response (200 OK)

{
    "status": "OK",
    "message": "Payment Control Number Generated successful",
    "returnData": {
        "control_number": "CC9912025092301"
    }
}

Error Responses

{
    "status": "ERROR",
    "message": "Invalid payment channel provided."
}

Payment Channel

The following is the list of payment channels available:

Value Description
CRDB Cooperative and Rural Development Bank
MKCB Mkombozi Commercial Bank PLC
NMB National Microfinance Bank Plc
STANBIC Stanbic Bank Tanzania Limited
TCB Tanzania Commercial Bank Plc