- GETList all accounts
- POSTCreate an account
- GETFetch account details
- GETFetch parent account details
- GETFetch account balance
- GETFetch parent account balance
- PUTSuspend an account
- PUTReactivate an account
- GETFetch terminals assigned to an account
- GETFetch terminals assigned to the parent account
- PUTUpdate access to account
- POSTCreate virtual account
- POSTFilter virtual accounts
- GETFetch a virtual account
- PUTUpdate a virtual account
- DELExpire a virtual account
- POSTCreate an online checkout order
- POSTCharge a customer using tokenized card data
- GETList tokenized cards
- POSTUpdate tokenzied card data
- DELUpdate tokenzied card data
- GETFetch checkout transaction
- GETGet Order details based on the generated Order reference
- POSTSubmit customer card details
- POSTSubmit customer card OTP
- POSTResend OTP to customer's phone
- POSTFetch checkout transaction details
- GETFetch checkout Flash account number for transfer payment
- POSTRequest user OTP
- POSTRequest user OTP
- POSTSubmit user OTP
- GETGet user saved cards
- POSTCancel Checkout transaction
- GETFetch bank codes and names
- POSTPerform bank account lookup
- POSTPerform bank account transfer from the parent account
- POSTPerform bank account transfer from account
- POSTPerform wallet transfer from the parent account
- POSTPerform wallet transfer from account
- POSTAssign a terminal to an account
- POSTAssign a terminal to the parent account
- POSTUn-assign terminal from an account
- POSTUn-assign a terminal from the parent account
- GETFetch credit/debit transactions on an account
- GETFetch credit/debit transactions on the parent account
- GETFetch transactions on an account
- POSTFilter account transactions
- GETFetch transactions on the parent account
- POSTFilter parent account transactions
- GETFetch a single transaction on an account
- GETFetch a single transaction on the parent account
Accounts
Virtual Accounts
Online Checkout
Charge
Transfers
Terminals
Transactions
Obtain access token
You can use this endpoint to authenticate with Nomba.
The parent accountId of the business.
A structure representing an authentication request.
The grant type of the authentication.
The client's id as obtained from your Nomba dashboard.
The client's secret as obtained from your Nomba dashboard. It is securely generated by the Nomba system
curl --request POST \
--url https://api.nomba.com/v1/auth/token/issue \
--header 'Content-Type: application/json' \
--header 'accountId: <accountid>' \
--data '{
"grant_type": "client_credentials",
"client_id": "2242b79d-f2cf-4ccc-ada1-e890bd1a9f0d",
"client_secret": "JFJ8yq3G4+DvjivJMsji0YkZBkkKdSdjifR+TgT9RLM="
}'
{
"code": "00",
"description": "Success",
"data": {
"businessId": "01a10aeb-d989-460a-bbde-9842f2b4320f",
"access_token": "eyJhbGciOiJIUzI1NiJ9.eyJHOjhmYWM4M2FjLTc2YjAtNDM1Zi1hYTM1LThkOTU3ZGQ5MjdkZCI6Ikc6OGZhYzgzYWMtNzZiMC00MzVmLWFhMzUtOGQ5NTdkZDkyN2RkIiwiUjpURUFNU19PV05FUiI6IlI6VEVBTVNfT1dORVIiLCJFbWFpbDp2aWN0b3JzaG9hZ2FAZ21haWwuY29tIjoiRW1haWw6dmljdG9yc2hvYWdhQGdtYWlsLmNvbSIsImlhdCI6MTY4MTkxODU3OSwic3ViIjoiNWUyNmNmYjAtNTI5Zi00MTdiLWI4ZDItYWJjNDcxZjRjOWRiIiwiZXhwIjoxNjgxOTIyMTc5fQ.lQOsyhR1gajKdzE9IHQEtxhQyUrArctEDZiP9pWVTFY",
"refresh_token": "01h4gdx2tctxfjgacbdwrcvs5d1688473602892",
"expiresAt": "2022-07-08T14:33:00Z"
}
}
Headers
The parent accountId of the business.
Body
The grant type of the authentication.
client_credentials
, refresh_token
The client's id as obtained from your Nomba dashboard.
The client's secret as obtained from your Nomba dashboard. It is securely generated by the Nomba system
Response
Response Code
Response description
A structure representing an authentication result.
The accountId of the merchant/business that is connecting to the Nomba system via API
A JWT (Json Web Token) token used to grant access to resources on the Nomba API.
A Base64 Encoded String used to refresh an expired access_token
The date and time this entity was created. This value uses Coordinated Universal Time (UTC) and ISO 8601 format – YYYY-MM-DDThh:mm:ssZ
.
curl --request POST \
--url https://api.nomba.com/v1/auth/token/issue \
--header 'Content-Type: application/json' \
--header 'accountId: <accountid>' \
--data '{
"grant_type": "client_credentials",
"client_id": "2242b79d-f2cf-4ccc-ada1-e890bd1a9f0d",
"client_secret": "JFJ8yq3G4+DvjivJMsji0YkZBkkKdSdjifR+TgT9RLM="
}'
{
"code": "00",
"description": "Success",
"data": {
"businessId": "01a10aeb-d989-460a-bbde-9842f2b4320f",
"access_token": "eyJhbGciOiJIUzI1NiJ9.eyJHOjhmYWM4M2FjLTc2YjAtNDM1Zi1hYTM1LThkOTU3ZGQ5MjdkZCI6Ikc6OGZhYzgzYWMtNzZiMC00MzVmLWFhMzUtOGQ5NTdkZDkyN2RkIiwiUjpURUFNU19PV05FUiI6IlI6VEVBTVNfT1dORVIiLCJFbWFpbDp2aWN0b3JzaG9hZ2FAZ21haWwuY29tIjoiRW1haWw6dmljdG9yc2hvYWdhQGdtYWlsLmNvbSIsImlhdCI6MTY4MTkxODU3OSwic3ViIjoiNWUyNmNmYjAtNTI5Zi00MTdiLWI4ZDItYWJjNDcxZjRjOWRiIiwiZXhwIjoxNjgxOTIyMTc5fQ.lQOsyhR1gajKdzE9IHQEtxhQyUrArctEDZiP9pWVTFY",
"refresh_token": "01h4gdx2tctxfjgacbdwrcvs5d1688473602892",
"expiresAt": "2022-07-08T14:33:00Z"
}
}