Idempotência
Toda requisição de mutação (initiate, process, cancel) requer um cabeçalho
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 (ex: o ID interno do seu pedido)
- Comprimento máximo: 255 caracteres
- O plugin atribui cada chave à organização efetiva. A mesma chave 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 300 segundos) - Uma resposta reenviada é byte-idêntica à original: mesmo status code, mesmo body. A resposta não tem um cabeçalho para marcar um replay, então projete seu cliente para ser seguro em qualquer caso.
Detecção de duplicatas
Além das chaves de idempotência, o plugin detecta duplicatas baseadas em conteúdo. Ele gera um fingerprint a partir de:senderAccountId- dados do destinatário (ISPB, agência, conta, documento do titular)
- valor
- finalidade
idempotency.duplicate_guard_ttl_seconds. A organização não faz parte do fingerprint. O isolamento de tenant vem do prefixo da chave Redis. O plugin rejeita a requisição com 409 BTF-0012 se o cliente já enviou uma transferência correspondente dentro da janela.
Isso captura 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 retry
Use backoff exponencial para erros transientes. Não tente novamente todos os erros.
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 do fornecedor JD sem transformação — por exemplo, TRANSPORT para falhas de transporte ou ACE95 para timeouts. O plugin não envelopa as falhas da cadeia JD em um código BTF-. Sinalize a transferência para reconciliação manual depois que as tentativas se esgotarem. Não tente novamente sem limite. A rede JD SPB tem horários de funcionamento definidos.Gerenciamento de estado
Máquina de estados do TED OUT
As transferências seguem uma progressão estrita. Você não pode cancelar uma transferência depois que ela sai deCREATED ou PENDING.
Máquina de estados da iniciação
O endpoint de initiate cria uma entidadePaymentInitiation. Essa entidade tem seu próprio ciclo de vida antes de o plugin criar um Transfer.
Máquina de estados do TED IN
Máquina de estados do P2P
O P2P não tem um estadoPENDING. A liquidação é atômica e instantânea.
Polling vs. webhooks
Prefira webhooks para status em tempo real. Se você ainda não configurou os webhooks, faça polling emGET /v1/transfers/{transferId}. Use no máximo 10 tentativas com o mesmo cronograma de backoff do retry. Sinalize a transferência para revisão manual após 10 minutos sem um estado terminal (COMPLETED, REJECTED, FAILED, CANCELLED).
Consulte Obter Transferência e Webhooks.
Integração com webhooks
Para esquemas de payload de eventos e a lista completa de eventos, consulte Webhooks.
Validação de assinatura
Toda requisição de webhook inclui cabeçalhos que seu endpoint usa para verificar a autenticidade:X-Webhook-Signature— assinatura HMAC-SHA256 versionada no formatov1,sha256=<hex>X-Webhook-Timestamp— timestamp Unix em segundos (UTC) de quando o plugin construiu a requisiçãoX-Webhook-Event— o tipo de evento (por exemplo,transfer.completed). Este cabeçalho não faz parte da assinatura.
v1:, o valor do timestamp de X-Webhook-Timestamp, um único ponto ASCII (.) e depois os bytes brutos do corpo da requisição. Use os bytes do corpo exatamente como chegam pelo fio. Não os analise nem os recodifique primeiro.
Para validar:
- Leia
X-Webhook-SignatureeX-Webhook-Timestampdos cabeçalhos da requisição. - Construa a string assinada:
"v1:" + timestamp + "." + rawBody. - Calcule
HMAC-SHA256sobre a string assinada com seuWEBHOOK_SIGNING_SECRET, depois codifique o resultado em hex. - Anteponha
v1,sha256=, depois compare contraX-Webhook-Signaturecom uma função de igualdade de tempo constante. - Rejeite a requisição se o timestamp estiver fora de uma janela de frescor aceitável (uma tolerância de 5 minutos é típica) para prevenir replay.
X-Webhook-Signature e X-Webhook-Timestamp, o plugin define apenas X-Webhook-Event (o tipo de evento). Ele não envia X-Webhook-Event-Type, X-Webhook-Routing-Key nem X-Webhook-Delivery-Attempt.
JavaScript
JavaScript
Python
Python
Go
Go
Processamento idempotente de webhooks
Seu endpoint pode receber o mesmo evento mais de uma vez (entrega at-least-once). UsetransferId + event como chave composta para deduplicar.
Padrões de tratamento de erros
Mapeie códigos de erro da API para ações voltadas ao usuário. Consulte a lista completa de erros para todos os códigos.
As respostas de erro seguem esta estrutura:
Checklist para entrar em produção
Antes de habilitar a integração em produção:
- Envie
X-Idempotencyem cada requisição de initiate, process e cancel - Lógica de retry implementada com backoff exponencial para erros 5xx/503
- Endpoint de webhook implantado e retornando
200em até 5 segundos - Validação de assinatura ativa no endpoint de webhook
- Deduplicação de eventos de webhook implementada usando
transferId + event - Horários de funcionamento validados no lado do cliente antes de chamar initiate (reduz 422s desnecessários)
- Tanto
transferIdquantoconfirmationNumberarmazenados para reconciliação - Estados terminais (
COMPLETED,REJECTED,FAILED,CANCELLED) tratados na UI - Expiração da iniciação (24h) tratada — solicite ao usuário que reinicie quando a janela encerrar
- Readiness do serviço monitorado no seu sistema de alertas para deployments BYOC
- Redis acessível e monitorado — o serviço rejeita requisições quando o Redis está fora do ar
-
PLUGIN_AUTH_ENABLED=trueconfigurado em produção, com umPLUGIN_AUTH_ADDRESSválido (HTTPS)

