Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.niobi.co/llms.txt

Use this file to discover all available pages before exploring further.

This documentation outlines the three primary methods for collection available via the API: USSD push, payment links, and bank deposits. Accepted Payment Methods
  1. Payment Collection via USSD Push
  2. Payment Collection via Payment Links
  3. Payment Collection via Bank Deposits
MethodAccessibilitySpeedSupported Countries
USSD PushAll mobile phonesSwiftMultiple
Payment LinksDigital platformsReal-timeMultiple
Bank DepositsBank transfersStandardNigeria, South Africa
Wave (Senegal)Redirect-based (browser required)Real-timeSenegal
Wave Senegal uses a redirect-based authorization flow — it is not a USSD push. After initiating the collection, your customer must be redirected to an authorization URL in their browser to complete the payment. See the Collect Payments guide for implementation details.

​
Payment Collection via USSD Push

USSD push is a convenient way to collect payments directly from a customer’s mobile phone. This method is widely used due to its simplicity and accessibility, even on basic mobile devices. How It Works:
  • Initiate Request: Your system initiates a USSD push request to the customer’s mobile number.
  • Customer Authorization: The customer receives a prompt on their phone to authorize the payment.
  • Completion: Once the customer authorizes, the transaction is processed, and funds are transferred to your Niobi wallet.
Benefits:
  • Accessibility: Works on all mobile phones.
  • Security: Payments are secured with customer authorization.
  • Speed: Transactions are completed swiftly.
Payment links are a flexible way to collect payments without the need for a physical point of sale or a complex integration. How It Works:
  • Create a Payment Link: Generate a unique payment link through your Niobi Payments dashboard or via our Payment Links API.
  • Share the Link: Send this link to your customers via email, SMS, or any other communication platform.
  • Customer Payment: The customer clicks on the link, which takes them to a secure payment page where they can choose their preferred method of payment.
  • Receive Confirmation: Once the payment is completed, you receive an email notification with the transaction details, and the funds are credited to your Niobi wallet. The customer will also receive an email notification upon successful payment.
Supported Payment Methods on Payment Links:
  • Mobile Money
  • Credit/Debit Cards (coming soon)
Benefits:
  • Convenience: Easily shareable via any digital platform.
  • Flexibility: Accepts various payment methods.
  • Real-Time Tracking: Monitor payments in real-time.

​
Payment Collection via Bank Deposits

You can collect payments in Nigeria and South Africa using bank deposits. How It Works:
  1. Initiate a deposit: Make an API request with your name and account name.
    • (For Nigeria) - Receive a virtual bank account number: You will receive a unique one-time virtual bank account number to facilitate the payment.
    • (For South Africa) - Receive an authorization url: You will receive an authorization url for which you will use to make the bank transfer from your end.
  3. Make Payment: Transfer the funds from your bank of choice using the unique virtual bank account number.
  4. Receive Confirmation: Once the payment is completed, you receive an email notification with the transaction details, and the funds are credited to your Niobi wallet.
Supported Countries:
  • Nigeria, South Africa
Benefits:
  • Seamless Transactions: Secure and efficient for bank transfers.
  • Wider coverage: Collect payments in Nigeria and South Africa easily.