Passed Data Object

Expected response

Intercept balance check requests to apply validation or custom logic

Balance Check

Nomba Developers

Welcome to Nomba

Get API Keys

Learn about some terminologies used in this documentation

Definitions

Learn how to use our Plugins and SDKs for easier integration

Overview

Start effortlessly with our user-friendly guides

Introduction

Instructions on integrating Nomba's payment gateway for processing online payments.

Accept online payments

Strategies for optimizing the authentication workflow with the Nomba API.

Authentication best practises

Guidance on how to configure your webhooks on your Nomba dashboard.

Setting up webhooks

Instructions on processing subscription based payments with Nomba's payment gateway.

Processing recurring payments

Learn how pagination is implemented in the Nomba API

Pagination

Learn about Nomba's fixed window ratelimit trategy

Ratelimit

Idempotency

Learn about the production and sandbox environment

Environment

Security

Reach out

Stuck? Please see some frequently asked questions

FAQs

Interact with all our available API endpoints

You can use this endpoint to authenticate with Nomba.

Obtain access token

You can use this endpoint to refresh an expired `access_token`.

Refresh an expired token

You can use this endpoint to revoke an `access_token`.

Revoke an access_token

You can use this endpoint to get details of the parent account.

Fetch parent account details

You can use this endpoint to get the balance of the parent account.

Fetch parent account balance

You can use this endpoint to fetch terminals linked to the parent account.

Fetch terminals assigned to the parent account

You can use this endpoint to create a virtual account to receive payments.

Create virtual account

You can use this endpoint to filter your virtual accounts.

Filter virtual accounts

You can use this endpoint to fetch a virtual account.

Fetch a virtual account

You can use this endpoint to update a virtual account.

Update a virtual account

You can use this endpoint to expire a virtual account.

Expire a virtual account

You can use this endpoint to create an online checkout order. Load the URL returned in 'checkoutLink' property in a browser to allow your customer initiate payment.

Create an online checkout order

You can use this endpoint to charge a customer's card using the tokenized card details.

Charge a customer using tokenized card data

List tokenized cards

Update tokenized card data

Delete tokenized card data

Fetch checkout transaction

Use this endpoint to fetch a single checkout order, using the order reference that was returned when the Order was created

Get Order details based on the generated Order reference

Use this endpoint to submit the customers card details

Submit customer card details

Use this endpoint to submit the payment OTP sent to the customer's phones from the payment gateway

Submit customer card OTP

Use this endpoint to resend the payment OTP to the customer's phone

Resend OTP to customer's phone

Use this endpoint to fetch the checkout transaction details and get the status of the transaction after OTP is submitted or transfer is made

Fetch checkout transaction details

Use this endpoint to Get a flash account number which the customer can use to make a transfer payment.

Fetch checkout Flash account number for transfer payment

Use this endpoint to request an OTP to be sent to be sent to the users phone number to authenticate the user before saving the card. This endpoint is called after payment is successful, and the user requested to save their card for later.

Request OTP before saving a user's card

Use this endpoint to request an OTP to be sent to a user's phone number to authenticate before retrieving the saved cards mapped to the user's email. Use this endpoint when the Order details endpoint indicates the user already has saved cards.

Request OTP to validate a user before fetching saved cards

Use this endpoint to submit the user OTP send to the user's mobile number. This will result in the user's card being saved for later use.

Submit user OTP

Use this endpoint to Get a user's saved cards. Requires user OTP send to the user after calling /checkout/user-card/saved-card/auth

Get user saved cards

Use this endpoint to Cancel an incomplete checkout transaction

Cancel Checkout transaction

You can use this endpoint to fetch all banks, their names and codes.

Fetch bank codes and names

You can use this endpoint to perform bank account lookup.

Perform bank account lookup

You can use this endpoint to perform bank account transfer.

Perform bank account transfer from the parent account

You can use this endpoint to perform a wallet transfer.

Perform wallet transfer from the parent account

You can use this endpoint to assign a terminal to the parent account.

Assign a terminal to the parent account

You can use this endpoint to un-assign a terminal from the parent account.

Un-assign a terminal from the parent account

You can use this endpoint to trigger a payment request on a nomba terminal

Send payment request to terminal

You can use this endpoint to fetch credit/debit transactions on the parent account.

Fetch credit/debit transactions on the parent account

You can use this endpoint to fetch transactions on the parent account.

Fetch transactions on the parent account

You can use this endpoint to filter transactions on the parent account.

Filter parent account transactions

You can use this endpoint to fetch a single transaction on the parent account.

Fetch a single transaction on the parent account

This endpoint is for fetching (requerying) a transaction status.

Confirm a transaction's status by sessionId

You can use this endpoint to fetch data plans available on a telco (network provider)

Fetch data plans available on a telco (network provider)

You can use this endpoint to make airtime purchases via parent account

Make airtime purchases via parent account

You can use this endpoint to vend data via parent account

Vend data bundles via parent account

You can use this endpoint to fetch electricity providers/discos

Fetch discos/electricity providers

You can use this endpoint to vend electricity via parent account

Vend electricity via parent account

You can use this endpoint to make cable tv subscription via parent account

CableTv subscription via parent account

This endpoint is for fetching customer information data

Fetch customer information from a cable tv provider

This endpoint is for fetching customer information data from an electricity vending provider

Fetch customer information from an electricity provider

This endpoint is for fetching customer information data from a bet vending provider

Fetch customer information from a betting provider

You can use this endpoint to fetch betting providers

Fetch betting providers

You can use this endpoint to vend betting via parent account

Vend betting via parent account

Keep track of changes and upgrades to the Nomba API.

Product Update

Documentation

API Reference

Changelog

Dashboard

Guides

Learn about the test cards we use for testing purposes

Cards

Learn how you can quickly get started with Account creation

Learn how to create a Nomba cooperate account

Account Setup

Learn the documents needed for KYC verification

Acceptable Documents

Learn how to ensure secure access to Nomba API Resources.

Generate the access_token needed to access the API Resources

Obtaining access token

Refresh your access_token to maintain access to the API Resources

Refreshing access token

Revoke your access_token from gaining access to the API Resources

Revoking access token

Understand everything about accounts in Nomba

Creating virtual accounts

Fetching account balance

Suspending accounts

Learn how to perform account lookup with virtual account number

Perform virtual account lookup

Learn how to process bank transfers with the Nomba API

Explore the process of performing bank account lookups through the Nomba API

Bank account lookup

Fetch the necessery bank codes and names of your desired banks

Fetch bank codes

Learn how to perform bank transfers using the Nomba API

Transfer to banks

Learn how to use the Nomba API to move money between accounts

Transfer between accounts

Learn how to assign terminals to accounts

Assigning terminals

Learn how to unassign terminals from accounts

Unassigning terminals

How to initiate and process payments using the Nomba payment terminal

Push Payment to Terminal

Learn how to interact with Nomba webhooks

Learn how to validate our webhook payloads

Signature verification

Learn about Nomba's webhook retry mechanism (exponential backoff policy)

Retries (Backoff Policy)

Learn how to fetch transactions associated with an account.

Fetch account transactions

Learn how to fetch bank transactions associated with an account.

Fetch bank transactions

Fetching a transaction information particularly for cases of status confirmation.

Transaction Requery

Retrieve transaction history for a specific virtual account

Fetch Virtual Account Transactions

Get a list of available data bundles that can be purchased based on the network or telco

Introduction

Getting Started

Plugins and SDKs

Products

Guides

API Patterns

Support

Balance Check

Payout Transactions

Passed Data Object

Expected response

Introduction

Getting Started

Plugins and SDKs

Products

Guides

API Patterns

Support

Payout Transactions

​Passed Data Object

​Expected response

Passed Data Object

Expected response