Refund Rental Deposit

Overview

The Refund Rental Deposit action refunds the rental deposit for each product on the project. It calculates the refundable amount as TotalRentalDepositAmount - WithheldRentalDepositAmount per product and credits the payment on the linked order.

If a portion of the deposit is intentionally withheld (e.g. due to damage), set WithheldRentalDepositAmount on the product before this action runs — only the remainder is refunded.

Key behaviours:

• Processes all products on the project in sequence
• Splits the refund across multiple active payments if needed (credits each until the refund amount is exhausted)
• Credits the deposit line item specifically (identified by the DepositFor property on the order line)
• If a payment credit fails or is disabled, the remaining amount is skipped for that payment
• The order is updated after each successful credit

Identifier

Configuration

No properties are required. Deposit amounts are read from the project products.

{
  "name": "RefundRentalDeposit",
  "active": true
}

All Available Options

Requirements

• Each product on the project must have a linked OrderId
• The order must have a deposit line item with a DepositFor property matching the product's SkuId
• The order must have active payments with available credit
• The payment provider must support crediting

Deposit amounts on project products

The refunded amount is TotalRentalDepositAmount - WithheldRentalDepositAmount.

Error Handling

Related

• Project Actions overview
• Credit Return — credits the full return payment (not deposit-specific)