Accounts

List all sub accounts

Changed on

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.

get/v1/accounts

Request

  • Base URL
    https://api.nomba.com
  • URL
    https://api.nomba.com/v1/accounts
  • Auth
    HTTP bearer

Query parameters

limitinteger

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

cursorstring

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

Headers

accountIdstring uuid required
Example:890022ce-bae0-45c1-9b9d-ee7872e6ca27

The parent accountId of the business.

Response

OK - your request was successful.

cursorstring int32

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

Example response

{
  "results": [
    {
      "accountId": "2242b79d-f2cf-4ccc-ada1-e890bd1a9f0d",
      "accountHolderId": "412316",
      "accountRef": "ACT_AMF0YN8UWH8CR8JZ",
      "phoneNumber": "2348188667580",
      "email": "test123@exam.ple",
      "bvn": "12234412345",
      "type": "physical",
      "accountName": "Testing Testing123",
      "banks": [
        {
          "bankAccountNumber": "0554772814",
          "bankName": "Wema Bank",
          "bankAccountName": "M.A Animashaun"
        }
      ],
      "address": "4, Alagomeji, Yaba, Lagos",
      "status": "active",
      "currency": "NGN",
      "description": "Meat kebab spot",
      "createdAt": "2022-07-08T14:33:00Z",
      "updatedAt": "2022-07-08T14:33:00Z"
    }
  ],
  "cursor": "xchbaVFsjdsbaADddd"
}

Changes