Skip to main content
GET
/
api
/
reserves
/
summary
curl https://api.swiftpay.cx/api/reserves/summary \
  -H "Authorization: Bearer mp_live_your_api_key"
{
  "success": true,
  "data": {
    "totalReservedAmountInCents": 150000,
    "activeReserveCount": 45,
    "upcomingReleaseCount": 5,
    "nextReleaseAt": "2024-02-15T00:00:00Z",
    "nextReleaseAmountInCents": 5000
  }
}

Get Reserve Summary

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

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/summary \
  -H "Authorization: Bearer mp_live_your_api_key"
{
  "success": true,
  "data": {
    "totalReservedAmountInCents": 150000,
    "activeReserveCount": 45,
    "upcomingReleaseCount": 5,
    "nextReleaseAt": "2024-02-15T00:00:00Z",
    "nextReleaseAmountInCents": 5000
  }
}

Dashboard Usage

This endpoint is ideal for displaying reserve summary cards:

Total Reserved

Display totalReservedAmountInCents formatted as currency

Active Reserves

Display activeReserveCount as a number

Next Release

Display nextReleaseAt and nextReleaseAmountInCents
Learn more about how reserves work in our Understanding Reserves guide.
Combine this with the Balance API to show a complete financial overview.