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

# Get Reserve Summary

> Get an overview of your reserve status

# Get Reserve Summary

Returns a summary of your current reserve status including totals and upcoming releases.

## Request

<ParamField header="Authorization" type="string" required>
  Bearer token with your API key
</ParamField>

## Response

<ResponseField name="success" type="boolean">
  Whether the request was successful
</ResponseField>

<ResponseField name="data" type="object">
  <Expandable title="properties">
    <ResponseField name="totalReservedAmountInCents" type="integer">
      Total amount currently held in reserves (in cents)
    </ResponseField>

    <ResponseField name="activeReserveCount" type="integer">
      Number of active reserve records
    </ResponseField>

    <ResponseField name="upcomingReleaseCount" type="integer">
      Number of reserves scheduled for release
    </ResponseField>

    <ResponseField name="nextReleaseAt" type="string">
      ISO 8601 timestamp of next scheduled release. `null` if no upcoming
      releases.
    </ResponseField>

    <ResponseField name="nextReleaseAmountInCents" type="integer">
      Amount to be released on next release date (in cents). `null` if no
      upcoming releases.
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl https://api.swiftpay.cx/api/reserves/summary \
    -H "Authorization: Bearer mp_live_your_api_key"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch("https://api.swiftpay.cx/api/reserves/summary", {
     headers: {
        Authorization: "Bearer mp_live_your_api_key",
     },
  });

  const summary = await response.json();

  console.log(
     `Total reserved: $${(summary.data.totalReservedAmountInCents / 100).toFixed(
        2
     )}`
  );
  console.log(`Active reserves: ${summary.data.activeReserveCount}`);

  if (summary.data.nextReleaseAt) {
     const releaseDate = new Date(summary.data.nextReleaseAt);
     console.log(
        `Next release: $${(summary.data.nextReleaseAmountInCents / 100).toFixed(
           2
        )} on ${releaseDate.toLocaleDateString()}`
     );
  }
  ```

  ```python Python theme={null}
  import requests
  from datetime import datetime

  response = requests.get(
      'https://api.swiftpay.cx/api/reserves/summary',
      headers={'Authorization': 'Bearer mp_live_your_api_key'}
  )

  summary = response.json()
  data = summary['data']

  print(f"Total reserved: ${data['totalReservedAmountInCents'] / 100:.2f}")
  print(f"Active reserves: {data['activeReserveCount']}")

  if data['nextReleaseAt']:
      release_date = datetime.fromisoformat(data['nextReleaseAt'].replace('Z', '+00:00'))
      print(f"Next release: ${data['nextReleaseAmountInCents'] / 100:.2f} on {release_date.strftime('%Y-%m-%d')}")
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "success": true,
    "data": {
      "totalReservedAmountInCents": 150000,
      "activeReserveCount": 45,
      "upcomingReleaseCount": 5,
      "nextReleaseAt": "2024-02-15T00:00:00Z",
      "nextReleaseAmountInCents": 5000
    }
  }
  ```

  ```json 200 (No reserves) theme={null}
  {
     "success": true,
     "data": {
        "totalReservedAmountInCents": 0,
        "activeReserveCount": 0,
        "upcomingReleaseCount": 0,
        "nextReleaseAt": null,
        "nextReleaseAmountInCents": null
     }
  }
  ```
</ResponseExample>

## Dashboard Usage

This endpoint is ideal for displaying reserve summary cards:

<CardGroup cols={2}>
  <Card title="Total Reserved" icon="lock">
    Display `totalReservedAmountInCents` formatted as currency
  </Card>

  <Card title="Active Reserves" icon="clock">
    Display `activeReserveCount` as a number
  </Card>

  <Card title="Next Release" icon="calendar">
    Display `nextReleaseAt` and `nextReleaseAmountInCents`
  </Card>
</CardGroup>

<Tip>
  Learn more about how reserves work in our [Understanding Reserves
  guide](/guides/understanding-reserves).
</Tip>

<Tip>
  Combine this with the [Balance API](/api-reference/balance/get-balance) to
  show a complete financial overview.
</Tip>