Skip to main content
WEBHOOK

Webhook overview

Webhooks work differently to the API endpoints. Take a read of our guide to understand how they work.
This event is sent when Runa’s fraud checks block a recipient from redeeming a payout link. The link’s value is not released. Runa also tries to cancel the link. cancelled says whether it did:
  • true: the link is cancelled.
  • false: the link is still active, but its redemptions keep being blocked.
Quote the assessment_id when you contact us about the payout.

Body

application/json

The blocked payout

Standard Webhooks envelope sent when Runa's fraud checks block the redemption of a payout link. The blocked payout is in data.

type
string
required

Always payout.blocked for this event.

Allowed value: "payout.blocked"
timestamp
string<date-time>
required

When the payout was blocked (RFC 3339, UTC).

Example:

"2026-10-23T10:15:00Z"

data
Blocked payout · object
required

Response

200

Return a 200 status to indicate that the data was received successfully