Skip to main content
WEBHOOK
Audience: consumer · Trigger: a Stornorechnung cancels the invoice · Payload: Invoice (consumer view, status void) plus cancellationInvoiceId · Permission: subscribing needs view-consumer-billing
Billing event. Requires a webhook endpoint subscribed by a consumer partner; payloads never include payment-provider messages. See Billing webhooks.
Verify the x-signing-signature header before you trust the body (Verifying signatures). Deliveries are at least once and unordered; deduplicate on event.id.

Authorizations

Authorization
string
header
required

Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.

Headers

x-signing-signature
string
required

t=<unix seconds>,s1=<hex HMAC-SHA256 of "<raw body>.<t>" with your first secret>,s2=<the same with your second secret>. Accept the delivery when either signature matches. See Verifying signatures.

Body

application/json

Body of a invoice-voided webhook.

event
object
required

The event.

payload
object
required

The resource the event is about, starting with resource and id: the consumer view of the resource, or the fields this event type defines.

Response

Acknowledge receipt within 15 seconds.