Skip to main content
GET
/
api
/
reserves
/
config
curl https://api.swiftpay.cx/api/reserves/config \
  -H "Authorization: Bearer mp_live_your_api_key"

{
  "success": true,
  "data": {
    "reservePercentage": 10,
    "reservePeriodDays": 30,
    "isActive": true
  }
}

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 Configuration

Retrieves your business’s current rolling reserve configuration.

​
Request

​
Authorization
string
required
Bearer token with your API key

​
Response

​
success
boolean
Whether the request was successful
​
data
object
curl https://api.swiftpay.cx/api/reserves/config \
  -H "Authorization: Bearer mp_live_your_api_key"

{
  "success": true,
  "data": {
    "reservePercentage": 10,
    "reservePeriodDays": 30,
    "isActive": true
  }
}

​
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)
Reserve configuration is managed by your account administrator. Contact support to request changes. Learn more in the Understanding Reserves guide.