Get Cleff Account

Returns the Business’s provisioned Cleff Account as a provider-neutral DTO — currency, balance, derived status, and the deposit instructions it funds the account with. Scoped to the caller’s Business and environment.

GET /v1/funding/account

Get the current Business's Cleff Account

cURL

curl --request GET \
  --url https://api.example.com/v1/funding/account \
  --header 'Authorization: Bearer <token>'

200

{
  "currency": "<string>",
  "available_balance_minor": 123,
  "total_balance_minor": 123,
  "status": "pending",
  "reported_at": "2023-11-07T05:31:56Z",
  "deposit_instructions": {
    "bank_name": "<string>",
    "routing_number": "<string>",
    "account_number": "<string>",
    "account_holder_name": "<string>",
    "reference": "<string>"
  }
}

Authorizations

Authorization · string · header · required

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

Response

200

application/json

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.

Show child attributes