Skip to navigation
API BaaSWebhook Events

pix.batch.completed

Lote de PIX terminou com estatísticas de sucesso e falha (cada item também emite pix.out.*)

Enviado quando todos os itens de um lote de PIX chegaram a um desfecho. status é COMPLETED, PARTIAL_FAILED ou FAILED. Cada item do lote é um PIX out comum e já emitiu o seu próprio pix.out.completed, pix.out.failed ou pix.out.timeout; este evento é o fechamento do lote, não substitui os eventos por item.

statistics traz contagens (total, completed, failed) e somas em BRL como string decimal (totalAmount, completedAmount, failedAmount). Para a lista de itens, GET .../pix/batches/{batchId}; para o CSV de correção dos que falharam, GET .../items/export?status=failed; para os comprovantes em ZIP, POST .../receipts.

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: hex(HMAC_SHA256(secret, raw_request_body)) (64 lowercase hex characters). 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).