> ## Documentation Index
> Fetch the complete documentation index at: https://diameterpay.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the Aggregated Available Balance for a Product

> GET /v1/products/{id}/balance — Returns the aggregated available balance across all bank accounts associated with a product, in USD.

This endpoint returns the aggregated available balance across all bank accounts associated with a given product. Use it to monitor funding levels before initiating payments, enforce pre-flight balance checks in your application logic, or display available funds in a dashboard. All balances are returned in USD.

## Endpoint

```
GET /v1/products/{id}/balance
```

**Required scope:** `com.diameterpay.api/products.read`

## Request Headers

**Authorization** `string` *required*

Bearer token obtained from your OAuth2 token endpoint. Format: `Bearer {access_token}`

## Path Parameters

**id** `string` *required*

The UUID of the product whose balance you want to retrieve.

## Response

Returns **HTTP 200 OK** with the aggregated balance for the product.

**availableBalance** `number`

The total available balance across all accounts under this product, expressed as a decimal number (e.g. `12500.00`).

**currency** `string`

The currency of the balance. Always `USD`.

## Example

```bash cURL theme={null}
curl --request GET \
  --url https://api.diameterpay.com/v1/products/f47ac10b-58cc-4372-a567-0e02b2c3d479/balance \
  --header "Authorization: Bearer {access_token}"
```

### Response

```json theme={null}
{
  "availableBalance": 12500.00,
  "currency": "USD"
}
```


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