Supported Payment Methods & Payload Requirements
Payment Flow: How It Works
Deposits (Collections)
1. Orange Money & Free Money (USSD/STK Push)
- Initiation: Submit a signed POST request to the Unified Collections endpoint with
country_id: 9,currency: "XOF",amount,payment_method_type("orange"or"free"), and the customer’s phone number inmobile(format:221XXXXXXXXX). - 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 by the customer, Niobi delivers an asynchronous webhook callback (
payment_step: 2,status: "success") to yourcallback_url.
2. Wave (Redirect Flow, payment_method_type: "wave")
Wave does not use a USSD push, it’s a redirect-based authorization flow:
- Initiation: Submit the request with
country_id: 9,currency: "XOF",amount,payment_method_type: "wave",successful_url, andfailure_url. - Customer Redirection: Niobi returns an
authorization_url(payment_step: 1). Redirect the customer to this URL. On mobile, it opens directly in the Wave app; on desktop, the page shows a QR code the customer can scan with the Wave app on their phone to authorize instead. - Completion & Callback: Once the customer approves or cancels the payment in Wave, they’re redirected to your
successful_urlorfailure_urlaccordingly, and Niobi delivers the terminal webhook callback (payment_step: 2) to yourcallback_url.
Payouts (Disbursements)
When initiating a payout to Senegal via the Unified Payments endpoint, pass the appropriatepayment_method_type and its corresponding parameters:
- Orange Money: Pass
payment_method_type: "Orange"with anOrangearray containingphone_number. - Free Money: Pass
payment_method_type: "Free"with aFreearray containingphone_number. - Wave: Pass
payment_method_type: "wave"with the recipient’s phone number inmobile.
Sample Requests & Responses
Orange Money Deposit Request
Deposit Response (Initiation)
Payout Request (Orange Money)
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 Senegal deposits.
Try it: POST /api/v4/niobi-unified-payments
Payments API reference for Senegal payouts.


