# Balance

> Retrieve your available and pending VINR account balance.

The balance object shows the funds currently held in your VINR account, split into what is
immediately available for payouts and what is still pending settlement. The balance updates
automatically as payments are captured and payouts are initiated.

> **Illustrative content.** Hand-authored to demonstrate the Standard/Advanced pattern; the production
> page will be generated from the VINR OpenAPI spec (roadmap item #1). Field names are representative.

## The balance object

- **available** `array` — Funds that can be paid out immediately. Each entry represents a currency bucket.
  - **amount** `integer` — Available amount in the smallest currency unit (e.g. cents).
  - **currency** `string` — Three-letter ISO currency code, e.g. `EUR`.
- **pending** `array` — Funds that have been received but are not yet available for payout (e.g. awaiting settlement).
  Each entry represents a currency bucket.
  - **amount** `integer` — Pending amount in the smallest currency unit (e.g. cents).
  - **currency** `string` — Three-letter ISO currency code, e.g. `EUR`.

## Retrieve the balance

The balance is a singleton — there is no ID and no list endpoint. A single GET returns the full
breakdown across all currencies.

`GET /v1/balance`

```bash
curl https://api.vinr.com/v1/balance \
-H "X-Api-Key: $VINR_SECRET_KEY"
```

```js
import { Vinr } from '@vinr/sdk';

const vinr = new Vinr({ secretKey: process.env.VINR_SECRET_KEY });

const balance = await vinr.balance.retrieve();
```

```python
import vinr

balance = vinr.Balance.retrieve()
```

```ruby
balance = Vinr::Balance.retrieve
```

```json
{
"available": [
  { "amount": 428500, "currency": "EUR" },
  { "amount": 12000, "currency": "USD" }
],
"pending": [
  { "amount": 95000, "currency": "EUR" }
]
}
```