Skip to main content

Welcome to our Dev Docs!

Payment

Payment Data Changed

This webhook is triggered when a new payment bearer is assigned to a contract (e.g. customer has entered new credit card data after the old card expired).

Typical Scenario

The payment data was changed and you want to notify the customer, that the change was successful.

HTTP/1.1
POST /billwerk-hook
Host: example.com
Content-Type: application/json

{
    "ContractId":"6298a006e636b694d807080f",
    "CustomerId":"6298a006e636b694d8070809",
    "Event":"PaymentDataChanged",
    "EntityId":"62148e3c0c14e1609e9ca5c1"
}

Payment Escalation Reset

This webhook is triggered when an escalation process was reset automatically or manually. An automatic reset happens when the customer paid the vacant positions. The process can also be reset manually by you.

Typical Scenario

A customer paid the open receivables and now you want to unlock the service for him.

HTTP/1.1
POST /billwerk-hook
Host: example.com
Content-Type: application/json

{
    "ContractId":"6298a006d2044479fc05e9e4",
    "CustomerId":"6298a006e636b694d8070809",
    "Event":"PaymentEscalationReset",
    "EntityId":"62148e3c0c14e1609e9ca5c1"
}
In this section: