Skip to navigation

boleto.charge.batch.completed

Lote de emissão de boletos terminou com estatísticas de sucesso e falha

Enviado quando todas as tentativas de emissão de um lote terminam. status é COMPLETED, PARTIAL_FAILED ou FAILED. Isso encerra o processamento do lote, não o ciclo individual: registro, pagamento, vencimento e expiração dos boletos emitidos continuam depois.

statistics traz total, issued e failed, o retrato terminal das tentativas de emissão. Pagamento continua depois: consulte o lote para statistics.payment e a conversão atualizada (paid / issued × 100).

Assine este evento com authType: HMAC. A entrega traz X-Signature; valide o HMAC-SHA256 sobre os bytes brutos do corpo e deduplique pelo id.

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