Skip to navigation
Settlement Payouts

List Settlement Accounts

View as Markdown

List your company’s settlement (wallet) accounts and their balances.

Behaviour notes

  • Returns a bare JSON array, with no status/data envelope.
  • Each item has id (use as settlementId / fromSettlementId), balance (NGN float), title, is_main and status (boolean, active).
  • Errors: 400 { "error": "Failed to retrieve company" }.

Authentication

AuthorizationBearer

Access token from Generate Access Token (valid 15 minutes).

Response

OK
idintegerOptional
balancedoubleOptional
titlestringOptional
is_mainbooleanOptional
statusbooleanOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error