API Reference

account_delinquency*

Event description lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Example Payload

{
  "data": {
    "account_id": "can_100031",
    "customer_id": "848",
    "statement_id": 77,
    "time_stamp": "2023-01-30 13:25:39.4009-05"
  },
  "event": "minimum_payment_missed",
  "hmac_signature": "YQwoNrn8dFjcjyJ8cXNbvwDqRPYPkw5UJSHoIzDR0Ts="
}

Configure Endpoint

💡

This call needs to be made for each account

PUT /accounts/{{account_id}}/notification_config

{
    "notification_type": "minimum_payment_missed",
    "time_offset": "6 days",
    "time": "00:00:00"
}

Retroactive Behaviors

When a retroactive event (i.e payment reversal) has taken place on an account which has had minimum_payment_missed webhooks configured, any future dated webhooks which would have been scheduled as a result of the reversed payment having never taken place will be re-scheduled for the account.

Webhook Configurations

"time_offset": "3 days": minimum_payment_missed webhooks should be delivered 3 days after a missed payment due date.
"time_offset": "6 days": minimum_payment_missed webhooks should be delivered 6 days after a missed payment due date.

Example Retroactivity

  • Payment A, satisfies minimum payment due balance 2 days before the due date
  • Payment Reversal of Payment A, occurs 4 days after the due date.
  • No minimum_payment_missed will be delivered for the "time_offset": "3 days" configuration as the account is already 4 days past the due date.
  • A webhook will be scheduled for the "time_offset": "6 days" configuration as 6 days has not elapsed since the account has missed its due date.
    • In the event that an additional payment has been made prior to the scheduled delivery of this webhook, which satisfies the delinquent due balances of the accounts, the scheduled delivery of this webhook will be cancelled.