Fetch all sub accounts

Fetch all sub accounts tied to your business

GET /v1/accounts

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. For more information, please see Pagination

Response body

code
string
required

Response code

description
string
required

Response description

data
object
required
cursor
string

Cursor for pagination. It will be empty if there is no more page to scroll to.

results
object[]
createdAt
string
required

Creation timestamp.

accountId
string
required

Account ID.

accountHolderId
string
required

Account holder ID.

accountRef
string
required

Account reference.

phoneNumber
string
required

Phone number.

email
string
required

Email address.

bvn
string
required

Bank Verification Number (BVN).

status
enum<string>
required

Account status.

type
enum<string>
required

Account type.

accountName
string
required

Account holder’s name.

currency
string
required

Currency code.

callbackUrl
string

Callback url.

expiryDate
string

Expiry date.