Refund an online security deposit

Refunds the security deposit that was held or charged on a card through HQ (the first security deposit payment of the reservation, which must have an online transaction). This moves money at the payment gateway and is not idempotent: do not retry a request that may have succeeded.

refunded_amount is the amount to give back, from 0 up to what can still be refunded on the transaction. 0 settles the hold without giving anything back. When your account adds transaction fees to payments, the amount refunded at the gateway includes the matching fee.

The reservation is looked up by its numeric ID; an unknown ID returns 404.

Responses

🟢200OK

application/json

The refund went through, or a business error with errors.error. HTTP 200 is also used for failures: always check success. When it is false, the body is an ErrorBusinessRule (status_code 410) or an ErrorUnauthorized (status_code 401 or 403).

Bodyapplication/json

Examples

No online depositNothing left to refund

{
    "success": false,
    "status_code": 410,
    "errors": {
        "error": "No security deposit transaction found",
        "error_message": "No security deposit transaction found"
    },
    "data": []
}

🟠404Record Not Found

🟠422Parameter Error

Refund an online security deposit

Request

Responses