Recurring Repayment Events
Unit raises events related to recurring repayments that you can subscribe to via webhooks. These events allow you to track the lifecycle of recurring repayments and respond to status changes in real-time.
Available Events
| Event | Description |
|---|---|
| recurringRepayment.created | Raised when a new recurring repayment is created. |
| recurringRepayment.statusChanged | Raised when the status of a recurring repayment changes (e.g., from Active to Disabled). |
| recurringRepayment.failed | Raised when a recurring repayment fails to create a scheduled repayment. |
| recurringRepayment.skipped | Raised when a scheduled repayment is skipped (e.g., due to zero balance). |
Event Payloads
recurringRepayment.created
This event is raised when a recurring repayment is successfully created.
Related resource types:
- RecurringAchRepayment
- RecurringBookRepayment
- RecurringCapitalPartnerAchRepayment
- RecurringCapitalPartnerBookRepayment
recurringRepayment.statusChanged
This event is raised when the status of a recurring repayment changes. Common status transitions include:
Active→Disabled(Recurring repayment disabled manually or due to account closure)Disabled→Active(Recurring repayment re-enabled)
Related resource types:
- RecurringAchRepayment
- RecurringBookRepayment
- RecurringCapitalPartnerAchRepayment
- RecurringCapitalPartnerBookRepayment
recurringRepayment.failed
This event is raised when a recurring repayment schedule fails to create a repayment. This may occur due to issues with the counterparty account, insufficient funds, or other payment failures.
Related resource types:
- RecurringAchRepayment
- RecurringBookRepayment
- RecurringCapitalPartnerAchRepayment
- RecurringCapitalPartnerBookRepayment
recurringRepayment.skipped
This event is raised when a scheduled repayment is skipped because the remaining amount due on the credit account is 0.
Related resource types:
- RecurringAchRepayment
- RecurringBookRepayment
- RecurringCapitalPartnerAchRepayment
- RecurringCapitalPartnerBookRepayment
Related Events
When working with recurring repayments, you may also want to subscribe to these related events:
| Event | Description |
|---|---|
| repayment.created | Raised when a repayment is created by the recurring repayment schedule. |
| repayment.statusChanged | Raised when the status of the underlying repayment changes. |
| payment.created | Raised when the underlying payment for a native repayment is created. |
| payment.sent | Raised when the underlying payment is sent/completed. |
| payment.returned | Raised when the underlying ACH payment is returned. |
For more details on all available events and their payloads, see the Events API reference.