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

# Get pay-in balance

`GET /v1/balances/payin`

## Request

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

Pay-in funds not yet settled to you, and how they split across upcoming settlements.

Reads one pay-in account: `accountType` when given, otherwise your main pay-in account (`payIn` for most merchants, `cryptoPayIn` for merchants set up for crypto pay-ins). It is not a total across accounts.

- `totalBalanceMinor`: net pay-ins not yet settled to you. Negative when refunds or chargebacks exceed unsettled funds. For IC++ pricing, a refund is deducted once it has settled.

- `ready.amountMinor` = amount of the next upcoming settlement; `ready.settlementDate` is when it is expected to be paid.

- `scheduled.amountMinor` = sum of the upcoming settlements after the next one.

- `pending.amountMinor` = `totalBalanceMinor` − `ready.amountMinor` − `scheduled.amountMinor` (funds not yet allocated to a settlement; negative in a deficit).

- `percent` = slice amount ÷ `totalBalanceMinor` × 100; 0 when there is no positive balance.

Amounts are in minor units of `currency`. Balances are cached for up to a minute; `asOf` is when this one was computed.

## Query parameters

- `accountType` 'payIn' | 'cryptoPayIn': Pay-in account to read. Defaults to your main pay-in account: `payIn` (fiat) for most merchants, `cryptoPayIn` for merchants set up for crypto pay-ins. Not a total across accounts.

## Response `200`

Success

- object: Pay-in balance
  - `status` 'SUCCEEDED', required
  - `data` GetPayinBalanceResponse, required: `GET /v1/dashboard/payin-balance`
    - `asOf` number, required: When the balance was computed (unix ms); balances are cached for up to a minute.
    - `totalBalanceMinor` number, required: Signed: negative when the merchant is in deficit.
    - `currency` 'USD' | 'EUR', required
    - `ready` object, required: Amount ready in the next upcoming settlement; `settlementDate` is its expected transfer time (unix ms).
      - `settlementDate` number
      - `amountMinor` number, required
      - `percent` number, required
    - `scheduled` object, required: Amount across settlements scheduled after the next one.
      - `amountMinor` number, required
      - `percent` number, required
    - `pending` object, required: Balance not yet allocated to a settlement: total − ready − scheduled, so negative in a deficit.
      - `amountMinor` number, required
      - `percent` number, required

## 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/payin/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)