Documentation Index
Fetch the complete documentation index at: https://docs.paywise.de/llms.txt
Use this file to discover all available pages before exploring further.
Available Event Types
Subscribe to the events relevant to your integration. Each event type corresponds to a specific action in the paywise system.
Mandate Events
| Event Type | Description |
|---|
mandate.created | A new mandate has been created for your company |
mandate.updated | Mandate data has changed (e.g. debtor address, contact details) |
mandate.status_updated | The processing status of a mandate has changed (e.g. reminder sent, collection initiated, court proceedings started) |
mandate.closed | A mandate has been closed (e.g. fully paid, discontinued, or written off) |
mandate.balance_updated | The balance of a mandate has changed (e.g. after a payment, cost calculation, or interest accrual) |
mandate.message_created | A new message has been added to a mandate (e.g. debtor correspondence, internal notes) |
Claim Events
| Event Type | Description |
|---|
claim.created | A new claim has been submitted |
claim.updated | Claim data has changed (e.g. amount, due date, or line items) |
Payment Events
| Event Type | Description |
|---|
payment.created | A payment has been reported or received for a mandate |
payment.updated | Payment information has changed (e.g. allocation to claims, confirmation status) |
Statement Events
| Event Type | Description |
|---|
statement.created | A new statement has been created |
statement.updated | Statement data has changed (e.g. published, canceled) |
Request to Client Events
| Event Type | Description |
|---|
request_to_client.created | A new request to the client (“Rückfrage”) has been published |
request_to_client.answered | A request to the client has been answered |
Subscribing to Events
When creating a webhook endpoint, specify the events you want to receive as an array:
{
"url": "https://your-domain.com/webhooks",
"events": [
"mandate.created",
"mandate.status_updated",
"payment.created"
]
}
You can update the subscribed events for an existing endpoint at any time via the API using a PATCH request.
Access Mode
Events are strictly isolated by access mode:
- Test webhooks only receive events from test API operations
- Production webhooks only receive events from production API operations
The access mode is determined by the API token used when creating the webhook endpoint.
