> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cleo-pay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the balance

> GET /v1/balance reads the Cleo Pay balance: available, cash, reserved, pending in and out, same-day ACH settings and the linked bank.

```
GET /v1/balance
```

**Scope:** `balance:read`

```bash theme={null}
curl https://api.stg.cleo-pay.com/v1/balance \
  --header "Authorization: Bearer $CLEO_API_KEY"
```

## Response

```json theme={null}
{
  "status": "open",
  "availableCents": 4250000,
  "cashCents": 4500000,
  "reservedCents": 250000,
  "pendingInboundCents": 100000,
  "pendingInboundPassThroughCents": 0,
  "pendingOutboundCents": 250000,
  "isReady": true,
  "canSendPayments": true,
  "sameDayAch": { "inbound": false, "outbound": true, "maxAmountCents": 100000000 },
  "linkedBank": { "bankName": "Chase", "last4": "4321" },
  "dashboardUrl": "https://stg.cleo-pay.com/dash/business/settings/balance"
}
```

<ResponseField name="status" type="string">`open` or `closed`.</ResponseField>
<ResponseField name="availableCents" type="integer">What the business can spend or withdraw now.</ResponseField>
<ResponseField name="cashCents" type="integer">Everything in the account, including money set aside for payments on their way.</ResponseField>
<ResponseField name="reservedCents" type="integer">The part of `cashCents` promised to payments on their way to vendors.</ResponseField>
<ResponseField name="pendingInboundCents" type="integer">Deposits and payments on their way in.</ResponseField>
<ResponseField name="pendingInboundPassThroughCents" type="integer">The part of `pendingInboundCents` passing straight through to a vendor. It never becomes available.</ResponseField>
<ResponseField name="pendingOutboundCents" type="integer">Money on its way out.</ResponseField>
<ResponseField name="isReady" type="boolean">The account has its own account and routing numbers, so it can receive money.</ResponseField>
<ResponseField name="canSendPayments" type="boolean">The balance can fund payments now.</ResponseField>

<ResponseField name="sameDayAch" type="object">
  `inbound` (deposits run same-day ACH), `outbound` (vendor payouts run same-day ACH) and `maxAmountCents` (above it, standard ACH applies).
</ResponseField>

<ResponseField name="linkedBank" type="object | null">`bankName` and `last4` of the bank linked to the balance.</ResponseField>
<ResponseField name="dashboardUrl" type="string">The balance page in the Cleo web app.</ResponseField>

Full account and routing numbers are never returned.

## Errors

| Code | When |
| - | - |
| `feature_unavailable` | The Cleo Pay balance is not available for this business. |
| `setup_required` | The business has no Cleo Pay balance yet. `details.actionUrl` links to the web. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.