Skip to navigation

boleto.charge.beneficiary.approved

Liquidante confirmou o cadastro do beneficiário de boleto da conta

O liquidante confirmou o cadastro do beneficiário de boleto da conta (ou a reativação de um relacionamento encerrado, com reactivated: true). A conta já pode emitir. operationId é o da resposta 202 do credenciamento. Os campos comuns aos quatro eventos de beneficiário são accountId, beneficiaryId, operation (INCLUSION, UPDATE, STATUS_UPDATE ou TERMINATION), result (CONFIRMED ou REJECTED), operationId e occurredAt. Veja o guia de emissão de boleto.

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).