POST
/
payments
/
preview-ussd-push-request
cURL
curl --request POST \
  --url https://api.clickpesa.com/third-parties/payments/preview-ussd-push-request \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "<string>",
  "currency": "TZS",
  "orderReference": "<string>",
  "phoneNumber": "<string>",
  "fetchSenderDetails": false,
  "checksum": "<string>"
}'
{
  "activeMethods": [
    {
      "name": "<string>",
      "status": "AVAILABLE",
      "fee": 123,
      "message": 123
    }
  ],
  "sender": {
    "accountName": "Mathayo John",
    "accountNumber": "255712345678",
    "accountProvider": "TIGO-PESA"
  }
}

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
amount
string
required

Your payment amount

currency
enum<string>
required
Available options:
TZS
orderReference
string
required

Your unique Order reference

phoneNumber
string

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

fetchSenderDetails
boolean
default:false

If true, fetch sender details. Defaults to false.

checksum
string

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

Response

Preview USSD Push response

activeMethods
object[]
sender
object