Skip to navigation

transfer.internal.in

Transferência interna creditada na conta

Enviado à conta que recebe uma transferência interna entre contas do mesmo ecossistema bancário. Transferências internas são instantâneas e liquidadas no mesmo banco — não trafegam pelo SPI do PIX, portanto não possuem endToEndId.

Estrutura do data:

  • transactionId: ID da transação no nosso sistema (formato internal-{uuid}). Use no GET /v1/accounts/{accountId}/statement.
  • amount: Valor recebido.
  • status: Sempre SUCCESS (transferências internas são atômicas).
  • completedAt: Data/hora da liquidação.
  • identifier: Identificador fornecido pelo pagador no POST /transfers/internal* (se informado). O mesmo valor chega nas duas pernas (transfer.internal.out e transfer.internal.in).
  • payerDescription / description: Descrição informada pelo pagador.
  • source: Dados do pagador — name, taxId, providerAccountId e, quando a conta é gerenciada por nós, accountId e tenantId.
  • destination: Dados do recebedor, nos mesmos campos.
  • payer / receiver: as mesmas duas pontas, com document no lugar de taxId. Só aparecem quando a transferência foi iniciada fora da API (app ou console do liquidante). Mantidos por compatibilidade — prefira source/destination, que chegam nas duas origens.

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