- 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
Fetch parent account details
You can use this endpoint to get details of the parent account.
Nomba authenticates API calls with OAuth2 HTTP bearer tokens. There are two methods of authentication; Client-Credentials method and PKCE (Proof Key for Code Exchange) method. In each of the methods, You will get an ACCESS_TOKEN
. You need to use an "Authorization"
HTTP header to provide your ACCESS_TOKEN
. For example: Authorization: {ACCESS_TOKEN}
.
curl --request GET \
--url https://api.nomba.com/v1/accounts/parent \
--header 'Authorization: Bearer <token>' \
--header 'accountId: <accountid>'
{
"code": "00",
"description": "Success",
"data": {
"createdAt": "2023-09-04T07:09:06.900Z",
"accountId": "fc81b80e-e607-4b86-8591-840925191733",
"accountHolderId": "01a10aeb-d989-460a-bbde-9842f2b4320f",
"accountRef": "1oWbJQQHLyQqqf1SwxjSpudeA21",
"bvn": "12234412345",
"status": "ACTIVE",
"type": "virtual",
"accountName": "Daniel Scorsese",
"currency": "NGN",
"banks": [
{
"bankAccountNumber": "93910",
"bankName": "Sterling Bank",
"bankAccountName": "Nomba/Ifeoluwa Adeboye"
}
]
}
}
Authorizations
Nomba authenticates API calls with OAuth2 HTTP bearer tokens. There are two methods of authentication; Client-Credentials method and PKCE (Proof Key for Code Exchange) method. In each of the methods, You will get an ACCESS_TOKEN
. You need to use an "Authorization"
HTTP header to provide your ACCESS_TOKEN
. For example: Authorization: {ACCESS_TOKEN}
.
Headers
Response
Response Code
Response description
Creation timestamp
Account ID
Account holder ID
Account reference
Bank Verification Number (BVN)
Account status
ACTIVE
, INACTIVE
, SUSPENDED
, PND
, BLACKLISTED
Account type
virtual
, outlet
Account holder's name
Currency code
NGN
List of associated bank accounts
Bank account number
Bank name
Bank account holder name
curl --request GET \
--url https://api.nomba.com/v1/accounts/parent \
--header 'Authorization: Bearer <token>' \
--header 'accountId: <accountid>'
{
"code": "00",
"description": "Success",
"data": {
"createdAt": "2023-09-04T07:09:06.900Z",
"accountId": "fc81b80e-e607-4b86-8591-840925191733",
"accountHolderId": "01a10aeb-d989-460a-bbde-9842f2b4320f",
"accountRef": "1oWbJQQHLyQqqf1SwxjSpudeA21",
"bvn": "12234412345",
"status": "ACTIVE",
"type": "virtual",
"accountName": "Daniel Scorsese",
"currency": "NGN",
"banks": [
{
"bankAccountNumber": "93910",
"bankName": "Sterling Bank",
"bankAccountName": "Nomba/Ifeoluwa Adeboye"
}
]
}
}