CleonPay
Sign up
Solutions PaymentsPayoutsMethodsDocs Sign in Sign up

API: Balance

What each of your prefunded accounts holds: the money a payout spends.

Payouts are prefunded. You hold a balance per account: a payout rail (card, SEPA, Faster Payments) in a given currency, and a payout draws its matching account down by the amount plus any fee. An account that cannot cover a payout refuses it with insufficient_balance rather than sending money that was never funded. Balances are separate per environment: sandbox is seeded so you can rehearse, live is what you have funded.

On this page

GET Retrieve your balance /v1/balance

Retrieve your balance

GET /v1/balance

Every funded account in the key’s environment, with the payout methods each one can spend.

Response

{
  "object": "balance",
  "environment": "live",
  "balances": [
    {
      "account": "fps",
      "account_label": "Faster Payments",
      "currency": "GBP",
      "available": 1000000,
      "available_decimal": "10000.00",
      "payout_methods": ["faster_payments"]
    },
    {
      "account": "sepa",
      "account_label": "SEPA",
      "currency": "EUR",
      "available": 750000,
      "available_decimal": "7500.00",
      "payout_methods": ["sepa_credit_transfer"]
    }
  ]
}

available is in minor units; available_decimal is the same figure as a string for display. A payout's amount plus its fee must fit within the matching account and currency, or it is refused with insufficient_balance.

With named balance accounts enabled, each row also carries an accounts array splitting that balance by account — {"balance_account": "client-a", "available": 250000, "available_decimal": "2500.00"} — with main as your default. A payout draws from one by sending metadata.balance_account. The field is omitted while you hold no named accounts.

On every request

HeaderDescription
Authorization Bearer <api key>. The key decides whether you are in sandbox or live; the host is the same either way.
Content-Type application/json on every request with a body.
Idempotency-Key On every creating request. Up to 255 characters, unique per operation, valid for 24 hours.

Errors follow one shape across every endpoint, described in errors.

PreviousAPI: Payouts NextAPI: Payment methods