Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer<int32>
default:0

Page number for pagination (default is 0).

size
integer<int32>
default:10

Number of items per page for pagination (default is 10).

accountTag
enum<string>

This can either be sub-account, or main-account.

Available options:
sub-account,
main-account
currency
enum<string>

Choose the currency you want for your sub account. According, to our currently supported currencies, this is in NGN or GHS.

Available options:
NGN,
GHS
mode
enum<string>

This can either be test or live mode.

Available options:
test,
live
accountNumber
string

This filters by the account number created for the sub accounts.

from
string<date-time>
Example:

"2025-02-28"

to
string<date-time>
Example:

"2025-03-03"

Response

A JSON array of subaccounts objects.

content
object[]
pageNumber
integer
pageSize
integer
totalElements
integer
totalPages
integer