---
title: "Get payout balance"
method: GET
path: "/v1/balances/payout"
tags: ["Balances"]
---

# Get payout balance

`GET /v1/balances/payout`

## Request

- Base URL: `https://api.breeze.cash`
- URL: `https://api.breeze.cash/v1/balances/payout`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/breeze/apis/breeze-api/docs/v1/balances/payout/get.ts> (a function with typed inputs; its response is checked against the schema)

Your 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.

## Response `200`

Success

- object: Payout balance
  - `status` 'SUCCEEDED', required
  - `data` GetPayoutBalanceResponse, required: `GET /v1/dashboard/payout-balance`
    - `asOf` number, required: When the balance was computed (unix ms); balances are cached for up to a minute.
    - `payoutWalletBalanceMinor` number, required: On-chain balance of the payout wallet (hot + cold wallet) in minor units.
    - `currency` string, required: Crypto token the payout wallet holds (e.g. USDC); empty string when no payout wallet is configured.
    - `fiatCurrency` string, required: Fiat currency the token represents, for display (e.g. USD).
    - `minimumRequiredMinor` number, required
    - `inProcessingMinor` number, required: Payouts currently in processing (+ their fees) that reduce the truly-available balance.
    - `topUpFromNextSettlementsMinor` number, required: Top-up to reach the minimum once in-processing payouts are accounted for, taken from the next settlements.
    - `balanceMinor` number, required: `payoutWalletBalanceMinor − inProcessingMinor`; negative when payouts in processing exceed the wallet.

## Other responses

- `400`: Bad request
- `401`: Unauthorized

## Changes

- **2026-11-03** `4af083d182a6`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/breeze/apis/breeze-api/changes/v1/balances/payout/get.md)

---

[API](https://skmtc.dev/breeze/apis/breeze-api.md) - [All operations](https://skmtc.dev/breeze/apis/breeze-api/llms.txt) - [OpenAPI document](https://skmtc.dev/breeze/apis/breeze-api/revisions/4af083d182a6?raw)