Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-26294473.4 KB
Payments
Initiate

Sends the USSD-PUSH request to customer's mobile device for payment authorization

post/payments/initiate-ussd-push-request

Request body

amountstring required

Your payment amount

currency'TZS' required
orderReferencestring required

Your unique Order reference

phoneNumberstring required

Mobile phone number to receive USSD-PUSH and make payment, starting with country code and without the plus sign, e.g., 255712345678

checksumstring

If enabled, this is the generated checksum of the payload. Refer to the documentation for more details.

Response

Initiate USSD Push response

idstring

Unique identifier for the USSD-PUSH transaction

status'PROCESSING' | 'SUCCESS' | 'FAILED' | 'SETTLED'

Current status of the transaction

channelstring

Payment channel used for the transaction (e.g., TIGO-PESA, M-PESA, AIRTEL-MONEY)

orderReferencestring

Your unique Reference identifier for the order

collectedAmountstring

Amount collected from the transaction

collectedCurrencystring

Currency of the collected amount (e.g., TZS)

createdAtstring date-time

Timestamp when the transaction was created

clientIdstring

Application Client ID associated with the payment