Skip to navigation

pix.in.completed

PIX recebido com sucesso

Enviado quando um PIX é recebido com sucesso (entrada) na conta. O id do envelope é pix-in-{endToEnd}.

Campos sempre presentes em data:

  • transactionId: ID da transação no nosso sistema.
  • endToEnd: ID E2E do BACEN.
  • accountId / tenantId
  • amount: valor em reais.
  • description: descrição (pode ser vazia).
  • method: STATIC_QR_CODE, DYNAMIC_QR_CODE ou DICT.
  • receivedAt: RFC 3339 UTC (Z).
  • status: "SUCCESS".

Campos condicionais:

  • identifier: txid do QR quando o crédito veio de um QR Code.
  • payer / payee: só entram chaves com valor (name, document, bankCode, bankIspb, branch, account, accountNumber, pixKey). Quando a conta existe, account e accountNumber repetem o mesmo valor.

Este evento não envia reconciliationId nem currency.

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