POST
/
v1
/
accounts
/
virtual
/
list
curl --request POST \
  --url https://api.nomba.com/v1/accounts/virtual/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'accountId: <accountid>' \
  --data '{
  "accountName": "Daniel Scorsese",
  "accountRef": "1oWbJQQHLyQqqf1SwxjSpudeA21",
  "bvn": "12234412345",
  "bankAccountNumber": "9391076543",
  "dateCreatedFrom": "2023-08-30T14:56:59.000Z",
  "dateCreatedTo": "2024-08-30T14:56:59.000Z",
  "expired": true,
  "resourceAcquired": true
}'
{
  "code": "00",
  "description": "Success",
  "data": {
    "results": [
      {
        "createdAt": "2023-09-04T07:09:06.900Z",
        "accountHolderId": "01a10aeb-d989-460a-bbde-9842f2b4320f",
        "accountRef": "1oWbJQQHLyQqqf1SwxjSpudeA21",
        "bvn": "12234412345",
        "accountName": "Daniel Scorsese",
        "bankName": "Amucha MFB",
        "bankAccountNumber": "9391076543",
        "bankAccountName": "Nomba/Ifeoluwa Adeboye",
        "currency": "NGN",
        "callbackUrl": "https://webhook.site/98ef100f-5adc-4434-800a-0808h60bd8d7",
        "expired": true
      }
    ],
    "cursor": "xchbaVFsjdsbaADddd"
  }
}

Authorizations

Authorization
string
headerrequired

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

accountId
string
required

The parent accountId of the business.

Query Parameters

limit
integer

This endpoint is paginated. limit describes the size of the page you are querying

cursor
string

The cursor is used to scroll to the next page. When making the first call to list all accounts, there is no need to pass in any cursor since the API has not returned any cursor back to you. Only use cursor when the API provides it

Body

application/json
accountName
string

Account holder's name

accountRef
string

Account reference

bvn
string

Bank Verification Number (BVN)

bankAccountNumber
string

Bank account number

dateCreatedFrom
string

Date created from

dateCreatedTo
string

Date created to

expired
boolean

Whether the virtual account is expired or not

resourceAcquired
boolean

Whether the virtual account is in use or not

Response

200 - application/json
code
string
required

Response Code

description
string
required

Response description

data
object
required
Create virtual accountFetch a virtual account