GET
/
v1
/
accounts
curl --request GET \
  --url https://api.nomba.com/v1/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'accountId: <accountid>'
{
  "cursor": "xchbaVFsjdsbaADddd",
  "results": [
    {
      "accountHolderId": "412316",
      "accountId": "2242b79d-f2cf-4ccc-ada1-e890bd1a9f0d",
      "accountName": "Testing Testing123",
      "accountRef": "ACT_AMF0YN8UWH8CR8JZ",
      "address": "4, Alagomeji, Yaba, Lagos",
      "banks": [
        {
          "bankAccountName": "M.A Animashaun",
          "bankAccountNumber": "0554772814",
          "bankName": "Wema Bank"
        }
      ],
      "bvn": "12234412345",
      "createdAt": "2022-07-08T14:33:00Z",
      "currency": "NGN",
      "description": "Meat kebab spot",
      "email": "[email protected]",
      "phoneNumber": "2348188667580",
      "status": "active",
      "type": "physical",
      "updatedAt": "2022-07-08T14:33:00Z"
    }
  ]
}

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

Response

200 - application/json
cursor
string

Value used to scroll to next page. It will be empty if there is no more page to scroll to

results
object[]

Contains all accounts tied to a specific merchant/business