v1

latestOpenAPI 3.0.1MIT2026-07-26294473.4 KB
Payments
Preview

Validates push details like phone number, amount, order-reference and verifies payment channels availability

post/payments/preview-ussd-push-request

Request body

amountstring required

Your payment amount

currency'TZS' required
orderReferencestring required

Your unique Order reference

phoneNumberstring

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

fetchSenderDetailsboolean

If true, fetch sender details. Defaults to false.

checksumstring

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

Response

Preview USSD Push response

Example response

{
  "sender": {
    "accountName": "Mathayo John",
    "accountNumber": "255712345678",
    "accountProvider": "TIGO-PESA"
  }
}