Webhooks can be configured to be sent in various situations regarding late or missed payments. The configuration options allow for notifications to be scheduled for any point before the due date as a warning that the due date is approaching, or after the due date to notify of any missed or late payments.
The webhooks that are relevant to late payments are
account_delinquency. These must first be configured for each account, as they are not sent by default. The configurations allow specifying the time when the notifications will be sent relative to the event triggering them, for example a
payment_due_date notification two day before the due date, and multiple configurations can exist for the same event type.
The configuration for
account_delinquency allows for a recurring notification, such as daily or weekly, rather than at a specific date.
In order to receive one of the relevant webhooks, they must first be configured. This needs to be done for each individual account, and is performed through our subscription API. Once configured, the notifications will be automatically sent.
Although the time and date are entirely configurable, some event types set restraints on the time offset that can be configured. In such cases, the attempt to create the configuration will fail with a bad request, stating what restraint caused this.
Scheduled notifications are not sent if their conditions are not met. For example, a
minimum_payment_missed notification scheduled to be sent five days after the due date will not be sent if the payment was not missed. Similarly, a delinquency notification set to be sent daily will be canceled once the account leaves the state of delinquency.
To create a configuration for a webhook, the following endpoint must be called:
The body of the request must set the
notification_type to one of our supported configurable webhooks, and provide either an
Can I schedule multiple webhooks for the same event type?Yes, there can be multiple configurations for the same event type to be sent at different time offsets.
Can I create a configuration with a time offset and one with a periodic interval for the same event type?No, currently the configuration with a periodic interval takes precedence over any configuration with a time offset.
Do I have to configure every date a notification should be sent for every cycle?No, the configurations are created with a time offset from their respective event. Creating a configuration with a time offset of two days past the due date will ensure it will be sent two days past the due date of every cycle, and not only at one specific date.
Updated about 1 month ago