List outlets
Returns Outlets under your Business, paginated (default 20 per page, max 200). Each Outlet carries its outletId, walletId, balances, and embedded virtual account.
Returns all outlets under the authenticated Business, paginated with sensible defaults (20 per page). Two filters are available:
status— exact match on the outlet lifecycle status (currentlyACTIVE).search— case-insensitive match againstaccountNameandexternalReference. Useful when the partner’s backend stores the partner-side identifier and needs to map it back to aoutletId.
pagination carries total, per_page, current_page, last_page. Walk pages by passing page=N&per_page=N in the query string. Note that the canonical signing string includes the canonical query segment — see the Authentication page for the canonicalisation rules.
Performance
Don’t paginate beyond per_page=200 in a single request — split into multiple calls if you need more.
Authorizations
Partner public key (pk_live_… or pk_test_…). Required on every request.
Partner secret. Used in the v1-static profile only.
Query Parameters
ACTIVE, SUSPENDED, CLOSED Free-text match on accountName or externalReference.
1-indexed page number.
Page size. Server caps at 200.
Response
Boolean success flag.
HTTP status code mirrored in the body for convenience.
Endpoint-specific payload (object or array).
Pagination envelope returned alongside data on paginated list endpoints.