Skip to main content
POST
cURL
Provide exactly one destination: lipaNamba + providerCode, or TanQR qrCode. Preview must resolve a beneficiary name before you create the payout.

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
number
required

Your payout amount

currency
enum<string>
required

Account currency to pay out from (TZS or USD). Recipient receives TZS.

Available options:
TZS,
USD
orderReference
string
required

Your unique Order reference

lipaNamba
string

Recipient Lipa Namba (merchant code). Required if qrCode is not sent. Do not send with qrCode.

Example:

"48001268"

providerCode
string

Required when lipaNamba is provided. Use a providerCode from Retrieve Lipa Namba Providers.

Example:

"503"

qrCode
string

Full TanQR string. Must include tz.go.bot.tips. Required if lipaNamba is not sent. Do not send with lipaNamba.

checksum
string

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

Response

Lipa Namba payout preview response

amount
number

Total amount to be deducted from your account balance (includes fee)

Example:

10100

balance
number
Example:

250000

channelProvider
string
Example:

"Vodacom M-Pesa"

fee
number

Transaction fee deducted from source currency (included in amount)

Example:

100

exchanged
boolean

Indicates if currency conversion was applied (true when source currency differs from receiving currency)

Example:

true

exchange
object

Exchange rate details (only present when exchanged is true)

order
object
payoutFeeBearer
enum<string>
Available options:
merchant,
both,
customer
Example:

"merchant"

receiver
object