Overview - Cleff API

Payouts draw from your Cleff Account, the funding balance held per Business and environment. Read the Account to see its balance and details; how that balance partitions into fee earmark, committed payouts, and remaining headroom is the Treasury view.

Endpoints

Method	Path	Purpose
`GET`	`/v1/funding/account`	Read the current Business’s Cleff Account
`POST`	`/v1/business/funding-account/sandbox-balance`	Top up the sandbox Account (sandbox only)

Sandbox top-up

POST /v1/business/funding-account/sandbox-balance credits the sandbox Account so you can exercise payouts end to end without moving real money. It is rejected outside sandbox; production balances are funded through the real funding path, never an API call.

Tenant scoping

Both routes are scoped to the Business and environment of the credential; a sandbox credential can neither read nor top up a production Account.

⌘I