import requests
url = "https://api.paywise.de/v2/webhooks/{id}/"
payload = {
"description": "Primary integration webhook (now with statements)",
"events": ["mandate.created", "payment.reported", "statement.published"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: 'Primary integration webhook (now with statements)',
events: ['mandate.created', 'payment.reported', 'statement.published']
})
};
fetch('https://api.paywise.de/v2/webhooks/{id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.patch("https://api.paywise.de/v2/webhooks/{id}/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"Primary integration webhook (now with statements)\",\n \"events\": [\n \"mandate.created\",\n \"payment.reported\",\n \"statement.published\"\n ]\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v2/webhooks/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"description\": \"Primary integration webhook (now with statements)\",\n \"events\": [\n \"mandate.created\",\n \"payment.reported\",\n \"statement.published\"\n ]\n}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
curl --request PATCH \
--url https://api.paywise.de/v2/webhooks/{id}/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "Primary integration webhook (now with statements)",
"events": [
"mandate.created",
"payment.reported",
"statement.published"
]
}
'{
"auto_disabled": true,
"consecutive_failures": 123,
"contract_version": "v1",
"created_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"last_failure_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"url": "<string>",
"description": "<string>",
"enabled": true,
"events": [
"*"
],
"max_consecutive_failures": 500
}{
"code": "validation_error",
"detail": "The request contains invalid data.",
"errors": [
{
"code": "invalid",
"field": "claims[0].due_date",
"message": "Due date must not precede the document date."
}
]
}{
"code": "not_authenticated",
"detail": "Authentication credentials were not provided."
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"code": "not_found",
"detail": "The requested resource was not found."
}{
"code": "conflict",
"detail": "The resource changed state and cannot accept this command."
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}Update webhook
Company-scoped webhook endpoint management.
import requests
url = "https://api.paywise.de/v2/webhooks/{id}/"
payload = {
"description": "Primary integration webhook (now with statements)",
"events": ["mandate.created", "payment.reported", "statement.published"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: 'Primary integration webhook (now with statements)',
events: ['mandate.created', 'payment.reported', 'statement.published']
})
};
fetch('https://api.paywise.de/v2/webhooks/{id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.patch("https://api.paywise.de/v2/webhooks/{id}/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"Primary integration webhook (now with statements)\",\n \"events\": [\n \"mandate.created\",\n \"payment.reported\",\n \"statement.published\"\n ]\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v2/webhooks/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"description\": \"Primary integration webhook (now with statements)\",\n \"events\": [\n \"mandate.created\",\n \"payment.reported\",\n \"statement.published\"\n ]\n}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
curl --request PATCH \
--url https://api.paywise.de/v2/webhooks/{id}/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "Primary integration webhook (now with statements)",
"events": [
"mandate.created",
"payment.reported",
"statement.published"
]
}
'{
"auto_disabled": true,
"consecutive_failures": 123,
"contract_version": "v1",
"created_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"last_failure_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"url": "<string>",
"description": "<string>",
"enabled": true,
"events": [
"*"
],
"max_consecutive_failures": 500
}{
"code": "validation_error",
"detail": "The request contains invalid data.",
"errors": [
{
"code": "invalid",
"field": "claims[0].due_date",
"message": "Due date must not precede the document date."
}
]
}{
"code": "not_authenticated",
"detail": "Authentication credentials were not provided."
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"code": "not_found",
"detail": "The requested resource was not found."
}{
"code": "conflict",
"detail": "The resource changed state and cannot accept this command."
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
Headers
Body
A webhook subscription. The signing secret is never included; it is returned exactly once on creation or rotation.
Replacement list of public event subscriptions. Use ["*"] for all public events; the wildcard must be the only list entry. Omit to keep the endpoint’s current subscriptions.
*- *order.submitted- order.submittedorder.withdrawn- order.withdrawnorder.rejected- order.rejectedorder.accepted- order.acceptedorder.expired- order.expiredmandate.created- mandate.createdmandate.state.changed- mandate.state.changedmandate.status_update.published- mandate.status_update.publishedmandate.balance_updated- mandate.balance_updatedorder.message.created- order.message.createdmandate.message.created- mandate.message.createdrequest_to_client.created- request_to_client.createdrequest_to_client.answered- request_to_client.answeredpayment.reported- payment.reportedstatement.published- statement.publishedstatement.cancelled- statement.cancelledsingle_mandate_statement.published- single_mandate_statement.publishedsingle_mandate_statement.cancelled- single_mandate_statement.cancelledmandate.correspondence.published- mandate.correspondence.publishedinvoice.created- invoice.createdinvoice.paid- invoice.paidinvoice.cancelled- invoice.cancelledinvoice.written_off- invoice.written_offinvoice.reopened- invoice.reopeneddunning.level_advanced- dunning.level_advanceddunning.handed_to_collection- dunning.handed_to_collection
*, order.submitted, order.withdrawn, order.rejected, order.accepted, order.expired, mandate.created, mandate.state.changed, mandate.status_update.published, mandate.balance_updated, order.message.created, mandate.message.created, request_to_client.created, request_to_client.answered, payment.reported, statement.published, statement.cancelled, single_mandate_statement.published, single_mandate_statement.cancelled, mandate.correspondence.published, invoice.created, invoice.paid, invoice.cancelled, invoice.written_off, invoice.reopened, dunning.level_advanced, dunning.handed_to_collection Automatically disables the endpoint when this many consecutive deliveries reach terminal failure. Retry attempts within one delivery do not each count. Raising it above the failure count of an automatically disabled endpoint makes that endpoint count toward the endpoint limit again and requires a free slot.
1 <= x <= 1000Publicly reachable HTTPS URL for webhook notifications. Must be unique among this company’s v2 endpoints; duplicate checks normalize the scheme, host, and default port. A company can register at most 20 webhook endpoints. Enabled and manually disabled endpoints count toward this limit; automatically disabled endpoints do not, and re-enabling one requires a free slot. Exceeding the limit returns 409 webhook_limit_reached; delete an unused endpoint to free capacity.
1 - 2048Response
A webhook subscription. The signing secret is never included; it is returned exactly once on creation or rotation.
Current public event subscriptions for this endpoint. ["*"] subscribes to all public events; otherwise the list contains the subscribed event types.
*- *order.submitted- order.submittedorder.withdrawn- order.withdrawnorder.rejected- order.rejectedorder.accepted- order.acceptedorder.expired- order.expiredmandate.created- mandate.createdmandate.state.changed- mandate.state.changedmandate.status_update.published- mandate.status_update.publishedmandate.balance_updated- mandate.balance_updatedorder.message.created- order.message.createdmandate.message.created- mandate.message.createdrequest_to_client.created- request_to_client.createdrequest_to_client.answered- request_to_client.answeredpayment.reported- payment.reportedstatement.published- statement.publishedstatement.cancelled- statement.cancelledsingle_mandate_statement.published- single_mandate_statement.publishedsingle_mandate_statement.cancelled- single_mandate_statement.cancelledmandate.correspondence.published- mandate.correspondence.publishedinvoice.created- invoice.createdinvoice.paid- invoice.paidinvoice.cancelled- invoice.cancelledinvoice.written_off- invoice.written_offinvoice.reopened- invoice.reopeneddunning.level_advanced- dunning.level_advanceddunning.handed_to_collection- dunning.handed_to_collection
*, order.submitted, order.withdrawn, order.rejected, order.accepted, order.expired, mandate.created, mandate.state.changed, mandate.status_update.published, mandate.balance_updated, order.message.created, mandate.message.created, request_to_client.created, request_to_client.answered, payment.reported, statement.published, statement.cancelled, single_mandate_statement.published, single_mandate_statement.cancelled, mandate.correspondence.published, invoice.created, invoice.paid, invoice.cancelled, invoice.written_off, invoice.reopened, dunning.level_advanced, dunning.handed_to_collection Automatically disables the endpoint when this many consecutive deliveries reach terminal failure. Retry attempts within one delivery do not each count. Raising it above the failure count of an automatically disabled endpoint makes that endpoint count toward the endpoint limit again and requires a free slot.
1 <= x <= 1000