Supported Payment Methods & Payload Requirements
Payment Flow: How It Works
Deposits (Collections)
- Initiation: Submit a signed POST request to the Unified Collections endpoint with
country_id: 10,currency: "TZS",amount,payment_method_type("airtel","halotel","tigo", or"vodacom"), and the customer’s phone number inmobile(format:255XXXXXXXXX). - Handset Authorization: The customer receives a prompt on their handset to enter their PIN and authorize the debit.
- Initial Response: Niobi returns an acknowledgement (
payment_step: 1) containing the assigneddepositId. - Callback Confirmation: Once authorized, Niobi delivers an asynchronous webhook callback (
payment_step: 2,status: "success") to yourcallback_url.
Payouts (Disbursements)
When initiating a payout to Tanzania via the Unified Payments endpoint, pass the appropriatepayment_method_type and its corresponding nested array:
- Airtel Money: Pass
payment_method_type: "Airtel"with anAirtelarray containingphone_number. - Halotel: Pass
payment_method_type: "Halotel"with aHalotelarray containingphone_number. - Tigo (Mixx by YAS): Pass
payment_method_type: "Tigo"with aTigoarray containingphone_number. - Vodacom M-Pesa: Pass
payment_method_type: "Vodacom"with aVodacomarray containingphone_number.
Sample Requests & Responses
Vodacom M-Pesa Deposit Request
Deposit Response (Initiation)
Payout Request (Vodacom M-Pesa)
Payout Response (Initiation)
Webhook/Callback Examples
Successful Deposit Callback
Successful Payout Callback
Try it
Try it: POST /api/v4/niobi-unified-collections
Collections API reference for Tanzania deposits.
Try it: POST /api/v4/niobi-unified-payments
Payments API reference for Tanzania payouts.


