Skip to navigation

fee.charged

Tarifa bancária cobrada

Enviado quando uma tarifa bancária é cobrada na conta (por exemplo, tarifa por transação PIX).

Estrutura do data:

  • transactionId: ID determinístico da row de tarifa no nosso ledger (fee-{coreId}).
  • accountId / tenantId: Conta cobrada e tenant.
  • amount: Valor da tarifa, sempre positivo em reais.
  • description: Descrição da tarifa.
  • feeServiceType: Tipo de serviço que originou a tarifa (PIX, BOLETO, P2P_CRYPTO, etc.) quando o banco informa.
  • originalRef / transactionRef: Referência cruzada com a movimentação que gerou a tarifa, quando disponível.
  • occurredAt: Timestamp da cobrança no banco.
  • status: Sempre "SUCCESS".
  • kind: "CHARGED".

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