Skip to main content
POST

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
amount
integer<int32>
required
​
phoneNumber
string
required

In ISO Format - '+' example: 254719624551

​
currency
string
required
​
externalReference
string
required

A unique ID of your liking to reconcile transactions internally.

​
momoOperatorId
string

Some currencies require operator specification. This can be retrieved from the mobile money operators list found under here: https://docs.zerocash.tech/docs/mobile-money-operators

​
otpCode
string

One-time payment code required by some operators before charge initiation. Follow the operator-specific customer instructions for the market you are collecting in and pass the generated code here.

​
externalAccountId
string

Used to pass the information of an existing external account. See external accounts.

​
walletCurrency
string

The currency to settle funds into. Defaults to currency.

​
voucherPin
string

Required for Botswana (BWP) ott voucher charhes

​
successRedirectUrl
string<uri>

Optional URL to return the customer to after a successful provider-hosted redirect, where supported.

​
failureRedirectUrl
string<uri>

Optional URL to return the customer to after a failed provider-hosted redirect, where supported.

Response

200

​
success
boolean
default:true
Example:

true

​
message
string
Example:

"Initiated request."

​
transactionId
string
Example:

"123456789"