Skip to main content
POST
Mobile Payout

Overview

The Mobile Payout API lets you send funds directly to a recipient’s mobile money wallet. Use the preview endpoint first to see fee breakdowns, then call initiate to execute the transfer.
Mobile payout is currently restricted to 300,000 TZS in a single transaction

Request Headers

string
required
Bearer token for authentication. Format: Bearer <token>
string
default:"application/json"
Expected response format. Use application/json.
string
default:"application/json"
Format of the request body. Use application/json.
string
required
A unique key to ensure idempotent requests.

Preview Mobile Payout

Calculate fees and preview the payout before committing.

Request Body

integer
required
Amount to send in the specified currency
string
required
Currency code (e.g., TZS)
string
required
Recipient’s phone number (e.g., 07XXXXXXXX)
object
Arbitrary key-value pairs for your reference. Maximum of 3 items, each less than 100 characters.

Example Request


Initiate Mobile Payout

Execute the mobile money transfer to the recipient.

Request Body

Same fields as the preview endpoint.
integer
required
Amount to send in the specified currency
string
required
Currency code (e.g., TZS)
string
required
Recipient’s phone number
object
Arbitrary key-value pairs for your reference. Maximum of 3 items, each less than 100 characters.

Response

boolean
Indicates whether the payout was successful.
string
Human-readable status message.
object
Updated account balance after the payout.
string
Unique identifier for the transaction.
string
Current status of the payout. Example: initiated.
object
Details about the payout amount.
object
Additional metadata attached to the payout.
Always run a preview before initiating a payout to confirm fees and ensure the recipient details are correct.