> ## 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 Config

> Get your current reserve configuration settings

# Get Reserve Configuration

Retrieves your business's current rolling reserve configuration.

## 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="reservePercentage" type="integer">
      Reserve percentage (e.g., `10` for 10%)
    </ResponseField>

    <ResponseField name="reservePeriodDays" type="integer">
      Number of days reserves are held before release. `null` means
      indefinite hold.
    </ResponseField>

    <ResponseField name="isActive" type="boolean">
      Whether reserves are currently active for your business
    </ResponseField>
  </Expandable>
</ResponseField>

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

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

  const config = await response.json();

  const reserveRate = config.data.reservePercentage / 100; // Convert to percentage
  console.log(`Reserve rate: ${reserveRate}%`);
  console.log(
     `Hold period: ${config.data.reservePeriodDays ?? "Indefinite"} days`
  );
  ```

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

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

  config = response.json()

  reserve_rate = config['data']['reservePercentage'] / 100
  period = config['data']['reservePeriodDays'] or 'Indefinite'
  print(f"Reserve rate: {reserve_rate}%")
  print(f"Hold period: {period} days")
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "success": true,
    "data": {
      "reservePercentage": 10,
      "reservePeriodDays": 30,
      "isActive": true
    }
  }
  ```

  ```json 200 (Disabled) theme={null}
  {
     "success": true,
     "data": {
        "reservePercentage": 0,
        "reservePeriodDays": null,
        "isActive": false
     }
  }
  ```
</ResponseExample>

## Understanding Reserve Settings

### Reserve Percentage

The `reservePercentage` is an integer between 0 and 100 representing the percentage of each payment held in reserve. For example, a value of `10` means 10% of the payment amount will be reserved.

### Reserve Period

The `reservePeriodDays` determines how long funds are held:

* **30 days**: Standard for new accounts
* **60-90 days**: Higher risk accounts
* **null**: Indefinite hold (manual release required)

<Note>
  Reserve configuration is managed by your account administrator. Contact
  support to request changes. Learn more in the [Understanding Reserves
  guide](/guides/understanding-reserves).
</Note>