Balances
Get payout balance
Changed onYour payout wallet and what it can fund.
-
payoutWalletBalanceMinor: funds in your payout wallet, read from the chain.
-
inProcessingMinor: payouts in progress (amount + fee) on the wallet's network and token whose funds have not left the wallet yet.
-
balanceMinor = payoutWalletBalanceMinor − inProcessingMinor. Negative when payouts in progress exceed your payout wallet.
-
topUpFromNextSettlementsMinor = minimumRequiredMinor − balanceMinor: what your next settlements add to the payout wallet to reach its minimum (0 when already met or no minimum is set).
Amounts are in minor units of currency. Balances are cached for up to a minute; asOf is when this one was computed.
get/v1/balances/payout
Request
- Base URLhttps://api.breeze.cash
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Response
Success
Changes
- info
endpoint added
- info