This section describes a list of errors caused by issues in the client's request, such as invalid data, missing fields, or insufficient permissions.

Client Errors

Niobi

API Reference

Release Notes

Guides

Payment Portal

Support

Home

This section outlines the initial steps needed to begin using the Niobi Payments API.

Initial Steps

Getting Credentials

Collection Methods

Collect Payments

Make Payments

Authenticating API Requests

To maintain the Niobi payment system security and integrity, users are required to sign their request messages using their private key. By following these steps, you'll learn how to make a signature for your message and how Niobi checks that signature to make sure it's really from you. If the signature doesn't check out, Niobi won't accept the message.

Creating and Verifying Signatures

This section outlines the transaction status API, which allows you to query details of a specific transaction, including both payouts and deposits. Access the API endpoint [here](https://docs.niobi.co/api-reference/payment/niobi-get-transaction-status).

Verifying Transaction Status

This section outlines the supported countries that you can use while making a payment using Niobi's Payment API. Please note that all countries are available in  the sandbox environment. For production environment, only the countries you select will be available to you.

Supported Countries

This section outlines the transactions limit amounts while making a payment using Niobi's Payment API.

Transaction Limits

With Niobi's payment API, you'll get access to our sandbox environment, where you can safely test your integration with all available MNOs. Use special phone numbers (MSISDNs) to simulate different scenarios without involving real money or mobile wallets.

Testing our API

Once your sandbox testing has been successful for all endpoints, you are ready to go live.

Steps to Go Live

If you need to request a refund or reverse a transaction, you can easily initiate the process through the payment portal. Below are the steps and details about how refunds are handled.

Refund Requests

FAQs

HTTP Status Codes Overview

This section describes a list of errors related to security credentials while accessing the api endpoints.

Authentication Errors

This section describes a list of errors caused by issues on the server-side.

Server Errors

This section describes a list of errors that are returned by the provider when a transaction fails.

Transaction-Related Errors

This section describes the transaction status codes you will expect once a transaction has been processed.

Transaction Status Codes

Our payments API uses callbacks to notify you of final statuses of payments.

Callback URLS

API Version 4 Release Notes

Niobi has a set of APIs which allows you to authenticate to the platform, accept payments from using payment links, make payments and viewing you account balance in your Niobi wallet

Introduction

need to get bearer token first to use niobi payment api

get-Token

Returns the status of a user by their email address, including KYC status information.

Get user status by email

This endpoint allows you to access a list of all the payment links created under your Niobi account.

Get Payment Links

Niobi create payment-link

Niobi STK Deposit

Niobi Unified Payment

This endpoint allows you to query your account balance.

Get Account Balance

This endpoint is for integration with Niobi. It generates signature used in the requests.

Generate Signature

This endpoint verifies the signature of a request to ensure its integrity and authenticity.

Error Code	Error Message	Action Required
400	Account details are missing.	Account details for the payment method are missing. Ensure that you have provided the necessary account details for the specified payment method.
400	Country was not found	The country id used is incorrect or missing. Make sure you are using the correct country id as listed in the supported countries section
400	Niobi user not found.	User or api credentials do not exist. Ensure the integration being used is active and that a valid user linked to it.
400	Payment method type is wrong or missing	The payment method in the API request is invalid or missing. Make sure you are using one of the supported payment methods found in the collections or disbursements page
400	Your account has insufficient balance to complete this transaction. Please top up the account and try again.	There are insufficient funds in your currency wallet. Top up your account to complete the transaction.
400	Your transaction amount exceeded the limit. Please input an amount below {amount}.	The transaction limit has been exceeded. Reduce the transaction amount to a value below the maximum limit as listed here
400	Your transaction amount is not sufficient.	The transaction amount is lower than the minium transacion limit. Ensure the amount is above the minimum limit supported by a specific country or payment method as listed here
403	Client id not matched	The client ID is incorrect. Ensure you are using the correct client key for the integration, which is generated when creating API credentials. Please refer to API Credentials Section for more information on generating credentials.
403	Entity integration record not found	The integration name is invalid. Verify that the sender value used in signing the request matches the API integration title created. Please refer to API Credentials Section for more information on generating credentials.

Get Started with Niobi

Collecting Payments

Making Payments

API Authentication

Transaction Status

Coverage

Going Live

Troubleshooting

Webhooks

Client Errors