Skip to main content

Customer Approaching Arrears

Webhook

Type: customer.approaching_arrears_block.v1

Starts occurring 7 days before a customer enters into arrears, meaning they have an unpaid invoice that is than 21 days or more past due and are about to be unable to place orders until they repay their most overdue invoices that meet this past 28 days condition

Payload​

The data object in the payload contains data that indicates the customer details who is about to enter into arrears, and further details on the invoices that are most overdue if they belong to this merchant

Example​

{
    "specversion": "1.0",
    "id": "01FBJ0PYJ7931K0CJ6GMP8N3WG",
    "type": "customer.approaching_arrears_block.v1",
    "time": "2023-06-21T12:34:56.123456Z",
    "source": "https://api.two.inc",
    "subject": "approaching_arrears_block",
    "twomerchantid": "b6b9d5d1-f6b7-4e15-9703-9c32c6e5c1c2",
    "message": (
        "Two B2b LTD (13078389)  is approaching arrears with another "
        f"merchant in 5 days. Please encourage them to repay any severely "
        "overdue invoices they have to be able to place orders on your website again""
    ),
    "data": {
        "buyer_company_name": "Two B2b LTD",
        "buyer_organization_number": "13078389",
        "days_until_arrears": 5,
        "earliest_invoice_due_belongs_to_merchant": False,
        "earliest_invoice_number": None,
        "earliest_invoice_due_date": None,
        "earliest_invoice_gross_amount": None,
        "earliest_invoice_currency": None
    }
}

Triggering in sandbox​

There is no active trigger to send this webhook as it runs as a cronjob on a daily schedule if the arrears conditions are met for any customer from this merchant. The SVIX portal however allows for test events to be sent to a given endpoint

Request​

Responses​

Successful Response