Skip to main content
Este guia é para desenvolvedores que implementam a integração com o plugin Bank Transfer. Ele cobre os padrões e as decisões que vão além de chamadas isoladas a endpoints: idempotência, estratégia de novas tentativas, tratamento de estado e validação de webhook. Para parâmetros de endpoint e schemas de resposta, veja a Referência da API.

Idempotência


Cada requisição que altera dados (initiate, process, cancel) exige um header X-Idempotency. Se você enviar a mesma chave duas vezes, o plugin retorna a resposta original sem criar uma operação duplicada. Regras:
  • Use um UUID v4 ou um identificador de negócio único (por exemplo, o ID do pedido no seu sistema)
  • Comprimento máximo: 255 caracteres
  • O plugin dá a cada chave o escopo da organização efetiva. A mesma chave vinda de duas organizações conta como duas requisições distintas.
  • O plugin retorna uma resposta em cache durante a janela de idempotência configurada (IDEMPOTENCY_RETRY_WINDOW_SEC, padrão de 300 segundos)
  • Uma resposta reenviada é idêntica byte a byte à original: mesmo código de status, mesmo corpo. A resposta não tem header que marque um reenvio, então projete seu cliente para ficar seguro nos dois casos.
Não reutilize chaves de idempotência entre operações diferentes. Não reutilize uma chave de initiate para processar ou cancelar a mesma transferência.

Detecção de duplicatas

Além das chaves de idempotência, o plugin detecta duplicatas por conteúdo. Ele monta uma impressão digital a partir de:
  • senderAccountId
  • dados do destinatário (ISPB, agência, conta, documento do titular)
  • valor
  • finalidade
O plugin guarda a impressão digital no Redis por 5 minutos. O padrão é 300 segundos. Os operadores ajustam isso por tenant pela configuração idempotency.duplicate_guard_ttl_seconds do systemplane. A organização não faz parte da impressão digital. O isolamento de tenant vem do prefixo da chave no Redis. O plugin rejeita a requisição com 409 BTF-0012 se o cliente já enviou uma transferência correspondente dentro da janela. Isso pega os casos em que o cliente envia a mesma transferência com uma chave de idempotência diferente. Um exemplo é uma nova tentativa após um timeout, quando o cliente não recebeu a resposta original.

Estratégia de novas tentativas


Use backoff exponencial para erros transitórios. Não repita a tentativa em todo erro. Cronograma de backoff recomendado para 5xx/503: 0s, 5s, 25s, 60s, 120s (5 tentativas no total).
Quando o JD SPB está indisponível, a resposta é HTTP 503. O campo error.code carrega então o código bruto do fornecedor JD, por exemplo TRANSPORT para falhas de transporte ou ACE95 para timeouts. O plugin não embrulha as falhas da cadeia JD em um código BTF-. Sinalize a transferência para conciliação manual depois que as novas tentativas se esgotam. Não tente de novo sem limite. A rede JD SPB tem horário de funcionamento definido.

Tratamento de estado


Máquina de estados da TED OUT

As transferências seguem uma progressão estrita. Você não pode cancelar uma transferência depois que ela sai de CREATED ou PENDING.
Máquina de estados da TED OUT
O que fazer em cada estado:

Máquina de estados da iniciação

O endpoint initiate cria uma entidade PaymentInitiation. Essa entidade tem seu próprio ciclo de vida antes de o plugin criar um Transfer.
Máquina de estados da iniciação

Máquina de estados da TED IN

Máquina de estados da TED IN

Máquina de estados do P2P

O P2P não tem estado PENDING. A liquidação é atômica e instantânea.
Máquina de estados do P2P

Polling vs. webhooks

Prefira webhooks para status em tempo real. Se você ainda não configurou webhooks, consulte GET /v1/transfers/{transferId}. Use no máximo 10 tentativas com o mesmo cronograma de backoff das novas tentativas. Sinalize a transferência para revisão manual depois de 10 minutos sem estado terminal (COMPLETED, REJECTED, FAILED, CANCELLED). Veja Obter transferência e Webhooks.

Integração de webhook


Para os schemas de payload dos eventos e a lista completa de eventos, veja Webhooks.

Validação da assinatura

Cada requisição de webhook inclui headers que seu endpoint usa para verificar a autenticidade:
  • X-Webhook-Signature: assinatura HMAC-SHA256 versionada no formato v1,sha256=<hex>
  • X-Webhook-Timestamp: timestamp Unix em segundos (UTC) de quando o plugin montou a requisição
  • X-Webhook-Event: o tipo do evento (por exemplo, transfer.completed). Este header não faz parte da assinatura.
O plugin calcula a assinatura assim:
A string assinada tem quatro partes, nesta ordem: o prefixo v1:, o valor do timestamp vindo de X-Webhook-Timestamp, um ponto ASCII (.) e então os bytes brutos do corpo da requisição. Use os bytes do corpo exatamente como chegam pela rede. Não os analise nem os recodifique antes. Para validar:
  1. Leia X-Webhook-Signature e X-Webhook-Timestamp nos headers da requisição.
  2. Monte a string assinada: "v1:" + timestamp + "." + rawBody.
  3. Calcule HMAC-SHA256 sobre a string assinada com seu WEBHOOK_SIGNING_SECRET e codifique o resultado em hexadecimal.
  4. Coloque v1,sha256= na frente e compare com X-Webhook-Signature usando uma função de igualdade de tempo constante.
  5. Rejeite a requisição se o timestamp estiver fora de uma janela de validade aceitável (uma tolerância de 5 minutos é típica) para evitar replay.
Além de X-Webhook-Signature e X-Webhook-Timestamp, o plugin define apenas X-Webhook-Event (o tipo do evento). Ele não envia X-Webhook-Event-Type, X-Webhook-Routing-Key nem X-Webhook-Delivery-Attempt.

Processamento idempotente de webhook

Seu endpoint pode receber o mesmo evento mais de uma vez (entrega pelo menos uma vez). Use transferId + event como chave composta para deduplicar.

Padrões de tratamento de erros


Mapeie os códigos de erro da API para ações voltadas ao usuário. Veja a lista completa de erros para todos os códigos. As respostas de erro seguem esta estrutura:

Checklist de entrada em produção


Antes de habilitar a integração em produção:
  • Envie X-Idempotency em cada requisição de initiate, process e cancel
  • Lógica de nova tentativa implementada com backoff exponencial para erros 5xx/503
  • Endpoint de webhook com o deploy feito e retornando 200 em até 5 segundos
  • Validação de assinatura ativa no endpoint de webhook
  • Deduplicação de eventos de webhook implementada com transferId + event
  • Horário de funcionamento validado no cliente antes de chamar initiate (reduz 422 desnecessários)
  • transferId e confirmationNumber armazenados para conciliação
  • Estados terminais (COMPLETED, REJECTED, FAILED, CANCELLED) tratados na interface
  • Expiração da iniciação (24h) tratada: peça ao usuário para recomeçar quando a janela passar
  • Readiness do serviço monitorada no seu sistema de alertas para deploys BYOC
  • Redis acessível e monitorado: o serviço rejeita requisições quando o Redis está fora
  • PLUGIN_AUTH_ENABLED=true configurado em produção, com um PLUGIN_AUTH_ADDRESS válido (HTTPS)