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

{
  "success": true,
  "data": {
    "id": "res_abc123",
    "paymentId": "sess_xyz789",
    "originalAmountInCents": 10000,
    "reserveAmountInCents": 10000,
    "reservePercentage": 10,
    "status": "active",
    "releasedAmountInCents": 0,
    "releaseAt": "2024-02-15T00:00:00Z",
    "releasedAt": null,
    "reservedAt": "2024-01-15T10:30:00Z"
  }
}

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

Retrieves the details of a specific reserve record.

​
Request

​
Authorization
string
required
Bearer token with your API key
​
id
string
required
The unique identifier of the reserve (e.g., res_abc123)

​
Response

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

{
  "success": true,
  "data": {
    "id": "res_abc123",
    "paymentId": "sess_xyz789",
    "originalAmountInCents": 10000,
    "reserveAmountInCents": 10000,
    "reservePercentage": 10,
    "status": "active",
    "releasedAmountInCents": 0,
    "releaseAt": "2024-02-15T00:00:00Z",
    "releasedAt": null,
    "reservedAt": "2024-01-15T10:30:00Z"
  }
}

​
Amount Tracking

Reserves track both original and current amounts:
FieldDescription
originalAmountInCentsAmount when reserve was created
reserveAmountInCentsRemaining amount currently held
releasedAmountInCentsAmount already released or consumed
When a refund consumes reserve funds:
  • reserveAmountInCents decreases
  • releasedAmountInCents increases
  • Status changes to partially_released or released
If reserveAmountInCents equals 0, the entire reserve was released or consumed.