# List all reserves
curl "https://api.swiftpay.cx/api/reserves?limit=20" \
-H "Authorization: Bearer mp_live_your_api_key"
# Filter by status
curl "https://api.swiftpay.cx/api/reserves?status=active&limit=50" \
-H "Authorization: Bearer mp_live_your_api_key"
# Paginate
curl "https://api.swiftpay.cx/api/reserves?cursor=cursor_abc123" \
-H "Authorization: Bearer mp_live_your_api_key"
{
"success": true,
"data": {
"items": [
{
"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"
},
{
"id": "res_def456",
"paymentId": "sess_uvw123",
"originalAmountInCents": 5000,
"reserveAmountInCents": 3000,
"reservePercentage": 10,
"status": "partially_released",
"releasedAmountInCents": 2000,
"releaseAt": "2024-02-10T00:00:00Z",
"releasedAt": null,
"reservedAt": "2024-01-10T14:20:00Z"
}
],
"nextCursor": "cursor_xyz789"
}
}
List all reserve records with filtering and pagination
# List all reserves
curl "https://api.swiftpay.cx/api/reserves?limit=20" \
-H "Authorization: Bearer mp_live_your_api_key"
# Filter by status
curl "https://api.swiftpay.cx/api/reserves?status=active&limit=50" \
-H "Authorization: Bearer mp_live_your_api_key"
# Paginate
curl "https://api.swiftpay.cx/api/reserves?cursor=cursor_abc123" \
-H "Authorization: Bearer mp_live_your_api_key"
{
"success": true,
"data": {
"items": [
{
"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"
},
{
"id": "res_def456",
"paymentId": "sess_uvw123",
"originalAmountInCents": 5000,
"reserveAmountInCents": 3000,
"reservePercentage": 10,
"status": "partially_released",
"releasedAmountInCents": 2000,
"releaseAt": "2024-02-10T00:00:00Z",
"releasedAt": null,
"reservedAt": "2024-01-10T14:20:00Z"
}
],
"nextCursor": "cursor_xyz789"
}
}
active, partially_released, released, consumedShow properties
Show reserve object
# List all reserves
curl "https://api.swiftpay.cx/api/reserves?limit=20" \
-H "Authorization: Bearer mp_live_your_api_key"
# Filter by status
curl "https://api.swiftpay.cx/api/reserves?status=active&limit=50" \
-H "Authorization: Bearer mp_live_your_api_key"
# Paginate
curl "https://api.swiftpay.cx/api/reserves?cursor=cursor_abc123" \
-H "Authorization: Bearer mp_live_your_api_key"
{
"success": true,
"data": {
"items": [
{
"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"
},
{
"id": "res_def456",
"paymentId": "sess_uvw123",
"originalAmountInCents": 5000,
"reserveAmountInCents": 3000,
"reservePercentage": 10,
"status": "partially_released",
"releasedAmountInCents": 2000,
"releaseAt": "2024-02-10T00:00:00Z",
"releasedAt": null,
"reservedAt": "2024-01-10T14:20:00Z"
}
],
"nextCursor": "cursor_xyz789"
}
}
| Status | Description |
|---|---|
active | Reserve is locked, awaiting release date |
partially_released | Some funds consumed by refund, remainder still locked |
released | Full amount released to available balance |
consumed | Entire reserve used for refund/chargeback |