Skip to navigation

Create mobile payment request

View as Markdown
Creates a USSD push request for customer payment authorization.

Authentication

x-api-keystring

Dashboard Public Key. Maps to x-api-key.

x-api-secretstring

Dashboard Secret Key. Maps to x-api-secret. Server-side only.

Headers

x-api-secretstringRequired
x-idempotency-keystringRequired
Unique key per transaction to avoid duplicate creates on retries.

Request

This endpoint expects an object.
payment_typeenumRequired
Allowed values:
detailsobjectRequired
phone_numberstringRequired
MSISDN in international format
customerobjectRequired
submerchant_idstringOptional

Optional sub-merchant ID. Send empty string when unused.

webhook_urlstringOptionalformat: "uri"

Response

Payment request accepted
statusstring
codeinteger
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error