Skip to main content
GET
Get the current Business's Cleff Account

Authorizations

Authorization
string
header
required

Cleff API key issued to a Business that self-registers via POST /v1/registration

Response

currency
string
required
available_balance_minor
number
required

Available balance, in minor units.

total_balance_minor
number
required

Total balance, in minor units.

status
enum<string>
required

Neutral account status derived server-side: 'pending' until the provider first reports, 'active' thereafter, 'suspended' when frozen.

Available options:
pending,
active,
suspended
reported_at
string<date-time> | null
required

Instant Cleff last applied a balance report from the provider — the balance is only as fresh as this. Always Cleff's own clock, whether the provider pushed the balance or Cleff polled for it, so it is directly comparable with the timestamps on your payouts. A report that arrives out of order is discarded and does not move this. Null until the first report lands (status 'pending').

deposit_instructions
object | null
required

The coordinates the Business funds this account with; absent on non-Checkbook paths.