Request body

Response body

POST /v1/terminals/assign

Nomba Developers

Documentation

API Reference

Dashboard

Guides

Learn how to assign terminals to accounts.

Terminal assignment

Welcome to Nomba

Get API Keys

Dashboard setup

Learn how to ensure secure access to Nomba API Resources.

Introduction

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

Learn about some terminologies used in this documentation

Definitions

Understand everything about accounts in Nomba

Creating sub accounts

Creating virtual accounts

Learn how to fetch all sub accounts tied to your business.

Fetch all sub accounts

Learn how to fetch details of a specific sub account

Fetch sub account details

Fetching account balance

Learn about suspending and reactivating accounts

Suspending and reactivating accounts

Learn about granting permissions to accounts

Granting permissions

Understand Nomba Checkout (Nomba's Online Payment Gateway)

Learn how to create a checkout order to accept payments

Create a checkout order

Learn how to charge tokenized cards with the Nomba API

Charge tokenized cards

Dispute Management

Learn how to appropraitely filter through your transactions with the Nomba API

Verify Transactions

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

Learn how to interact with Nomba webhooks

Learn how to validate our webhook payloads

Signature verification (deprecated)

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

Learn how to filter through transactions on an account.

Filtering through transactions

Fetching a transaction information particularly for cases of status confirmation.

Transaction Requery

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

Fetch Data Plans

Buy Data Bundle

Vend Airtime

Get a list of the available electricity providers

Fetch Electricity Providers (Discos)

This describes the process of paying for electricity

Pay for Electricity

This describes the process of subscribing to a Cable TV network

Subscribe to Cable TV

Describes how to get the information of an electricity vendor's customer

Get customer information for an electricity payment 

Describes how to get the information of a cable tv customer

Get customer information from a cable tv provider 

Start effortlessly with our user-friendly guides

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

Instructions on how to accept online payments with a subaccount.

Online payments with subaccounts

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 endpoints to fetch all the accounts tied to a business. Accounts are sorted by date, with the most recently-created account appearing first.

List all sub accounts

You can use this endpoint to create a sub account that is part of your business.

Create a sub account

You can use this endpoint to get details of a sub account.

Fetch details of a sub account

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 a sub account

Fetch sub account balance

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

Fetch parent account balance

You can use this endpoint to suspend a sub account.

Suspend a sub account

You can use this endpoint to reactivate a sub account

Reactivate a sub account

You can use this endpoint to fetch terminals linked to a sub account

Fetch terminals assigned to a sub account

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 update the access of an api client within an account.

Update access to 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 tokenzied 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 cna 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 fetch credit/debit transactions on a sub account.

Fetch credit/debit transactions on a sub account

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 a sub account.

Fetch transactions on a sub account

You can use this endpoint to filter transactions on an account.

Filter account transactions

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 a sub account

Fetch a single transaction on a sub account

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

Introduction

Getting Started

Products

Guides

API Patterns

Support

Terminal assignment

Assign terminals to the parent account

Assign terminals to sub accounts

`POST /v1/terminals/assign`

Request body

Response body

Introduction

Getting Started

Products

Guides

API Patterns

Support

Assign terminals to the parent account

Assign terminals to sub accounts

​POST /v1/terminals/assign

​Request body

​Response body

`POST /v1/terminals/assign`

Request body

Response body