Skip to main content
POST
cURL
Create requests are limited to one per merchant every 60 seconds. Re-submitting earlier returns an error with the remaining wait time.
Create often returns AUTHORIZED. That means the payout was accepted, not that it has settled. Poll payout status or listen for webhooks until SUCCESS or REFUNDED.

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

Create Lipa Namba payout response

updatedAt
string<date-time>
createdAt
string<date-time>
id
string
orderReference
string

Your unique order reference

amount
string

Total amount deducted from your account balance (includes fee)

Example:

"10100.00"

currency
string
Example:

"TZS"

fee
string

Transaction fee deducted from source currency (included in amount)

Example:

"100.00"

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)

status
enum<string>
Available options:
AUTHORIZED,
PROCESSING,
SUCCESS,
FAILED,
REFUNDED,
REVERSED
channel
enum<string>
Available options:
TIPS LIPA NAMBA
channelProvider
string
Example:

"Vodacom M-Pesa"

order
object
beneficiary
object
clientId
string

Application Client ID associated with the payout