Balances

Last updated: 2026-03-05

Use balances to check merchant funds before creating payouts.

Endpoint

GET /merchant/api/v1/balances
Auth: Secret key (sk_*)

Response schema follows merchants.swagger.json.

Response example

{
  "balances": [
    {
      "accountId": "....",
      "accountType": "ACCOUNT_TYPE_LIABILITY",
      "currencyCode": "NGN",
      "amount": "123456"
    }
  ]
}

Notes

• amount is signed in minor units.
• Negative values indicate net liability/owed position for that account/currency.
• POST /merchant/api/v1/payouts/create does not enforce pre-flight insufficient-balance checks.
• If pre-funding is required in your flow, check balances before creating payout orders.