Release an offline security deposit

Releases a security deposit hold of this reservation that was recorded offline (a payment with authorization_or_payment authorization, without an online transaction). No money moves through a payment gateway: for a deposit held on a card through HQ, use POST /car-rental/reservations/{reservation_id}/payments/online-security-deposit-refund.

Send amount_to_refund, from 0 up to what is left of the hold. When it is less than the hold amount, the difference is kept as a new approved payment on the reservation (for example to cover damages), using the payment method set for deposit settlements in your settings, or the deposit's own method.

Side effects

Records a refund for amount_to_refund with the hold's method and reference, and marks the reservation deposit as refunded.

Emails the customer the deposit release, unless payment emails are disabled.

Responses

🟢200OK

application/json

The refund that was recorded. HTTP 200 is also used for failures: always check success. When it is false, the body is an ErrorUnauthorized (status_code 401 or 403).

Bodyapplication/json

Example

{
    "success": true,
    "status_code": 200,
    "errors": [],
    "data": {
        "refund": {
            "id": 233,
            "reservation_type": "car_rental.reservations",
            "reservation_id": 1052,
            "amount": {
                "currency": "usd",
                "currency_icon": "$",
                "amount": "200.00",
                "usd_amount": "200.00",
                "amount_for_display": "$200.00"
            },
            "label": "DEP-1052 - Cash",
            "reference": "DEP-1052",
            "refund_type": "Cash",
            "date": "2026-12-06",
            "created_by": "Alex Smith",
            "transaction": null
        }
    }
}

🟠404Record Not Found

🟠422Parameter Error

Release an offline security deposit

Request

Responses