Skip to navigation

policy.violation

Uma regra de policy foi violada — recusa (BLOCK), aviso (NOTIFY_ONLY, ALLOW_AND_NOTIFY), devolução de PIX (AUTO_REFUND), valor travado (LOCK_BALANCE) ou saída cortada (BLOCK_ACCOUNT)

Uma regra de política configurada para a sua conta ou tenant foi violada. O evento cobre todas as seções de política — PIX out, recebimento, QR Code, chaves e estorno — e é enviado tanto quando a operação é recusada (action: "BLOCK") quanto quando ela apenas gera aviso ou uma ação depois do crédito (NOTIFY_ONLY, ALLOW_AND_NOTIFY, AUTO_REFUND, LOCK_BALANCE, BLOCK_ACCOUNT). Use blocked para saber se a operação foi recusada. Num recebimento blocked é sempre false.

Headers

X-SignaturestringOptional

Present when the subscription uses authType: HMAC: base64(HMAC_SHA256(secret, raw_request_body)) (standard Base64, with padding). Compare in constant time against your own computation over the raw body.

Payload

The payload of this webhook request is an object.
idstringRequired

Deterministic event id. Same id means the same event, possibly redelivered — deduplicate on it.

typeenumRequired

Event type. Full list at GET /v1/webhooks/events.

Allowed values:
occurredAtdatetimeRequired

RFC 3339, UTC with Z.

schemaVersionstringRequired

1.0 today; bumped only on breaking payload changes.

environmentenumRequired
Environment that emitted the event.
Allowed values:
tenantIdstringRequired
Tenant the event belongs to.
dataobjectRequired

Event-specific payload. See each webhook.

accountIdstringOptional

CorpX account where the event happened. Empty on cross-account events.

Response

2XX

Acknowledged. Any 2xx within 10 seconds stops retries; anything else is retried with backoff (see the Webhooks guide).