Skip to navigation

pix.refund.received

Recebedor de PIX out devolveu o valor por iniciativa própria

Enviado quando o recebedor de um PIX out devolve o valor por iniciativa própria (sem que tenhamos pedido). Difere de pix.refund.completed, que confirma um refund que nós disparamos.

Estrutura do data:

  • transactionId: ID determinístico da row do refund recebido (pix-refund-received-{refundEndToEnd}).
  • refundEndToEnd: D-code do refund (BACEN).
  • originalEndToEnd: E-code do PIX out original que está sendo revertido.
  • originalIdentifier: Identifier do PIX out original (eco do que foi enviado na criação do pagamento), quando disponível.
  • accountId / tenantId: A conta que recebeu o refund.
  • amount: Valor revertido.
  • description: Descrição vinda do partner.
  • receivedAt: Timestamp do refund.
  • payer: Quem devolveu o valor (contraparte / recebedor original do PIX out): nome, documento, banco, agência, conta.
  • payee: Quem recebeu o crédito (nossa conta / pagador original do PIX out): nome, documento, banco, agência, conta.
  • status: Sempre "SUCCESS".

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