X-Account-Id.
Vínculos e chaves
Um vínculo associa uma chave Pix a uma das suas contas. O plugin resolve os dados da conta e do titular a partir do CRM. Você cria vínculos por tipo de chave, em vez de por dados da conta. Tipos de chave aceitos:
/v1/dict/entries). A criação e a exclusão validam as reivindicações ativas e conferem a chave com o documento do titular. Por exemplo, uma chave CPF deve corresponder ao CPF do titular.
O plugin não valida chaves na Receita Federal e não executa verificações de posse com MFA. Ele supõe que você concluiu essas verificações antes de chamá-lo. Veja os pré-requisitos no guia de integração.
GET /v1/dict/keys/{key}) resolvem uma chave para pagamento. A resposta traz o dono atual e a conta, para você iniciar um pagamento. A consulta exige o header X-End-To-End-Id para o rastreamento do pagamento. Use POST /v1/dict/keys/check para checar a existência em lote. O plugin devolve os dados como os recebe do BTG. Mascare os campos sensíveis antes de mostrá-los no seu lado.
Referência: Criar vínculo · Listar · Consultar · Atualizar · Excluir · Consultar uma chave · Checar chaves
Reivindicações: portabilidade e posse
Uma reivindicação transfere uma chave Pix entre instituições. Existem dois tipos:
- PORTABILITY: move uma chave para outro banco para o mesmo titular. Permitida para
CPF,CNPJ,PHONEeEMAIL. - OWNERSHIP: reivindica uma chave de uma pessoa diferente. Permitida apenas para
PHONE.
X-Account-Id. O BTG define claimerParticipant e donorParticipant automaticamente.
Ciclo de vida da reivindicação
Enquanto uma reivindicação está ativa (
OPEN, WAITING_RESOLUTION ou CONFIRMED), ela trava a chave. O plugin bloqueia novos vínculos e exclusões. Durante OPEN e WAITING_RESOLUTION, o doador ainda pode atualizar os dados da conta, e as consultas de chave devolvem os dados do doador. Depois de CONFIRMED, as consultas devolvem “chave não encontrada” até a reivindicação chegar a COMPLETED ou CANCELLED.
- PORTABILITY pode ser concluída logo após a confirmação.
- OWNERSHIP acrescenta uma janela de conclusão. O BTG devolve
resolutionPeriodEnd(D+7) ecompletionPeriodEndna reivindicação.
Operações de reivindicação
Os webhooks de saída CLAIM entregam as mudanças de status das reivindicações ao seu sistema. Veja o guia de Webhooks.
Referência: Criar uma reivindicação · Listar · Consultar · Reconhecer · Confirmar · Concluir · Cancelar
Conciliação (VSync)
A conciliação mantém seus dados locais do DICT consistentes com os registros oficiais do BACEN. Ela usa dois conceitos:
- CID (Content Identifier): um hash HMAC-SHA256 de 256 bits dos atributos de um vínculo (tipo de chave, chave, dono, participante, agência, conta etc.).
- VSync: um único checksum que aplica XOR a cada CID de um tipo de chave. Como o XOR é comutativo, você compara o seu VSync com o do BTG/BACEN para revelar se seus vínculos estão sincronizados, sem trocar todos os registros.
- API manual / administrativa: os operadores disparam verificações sob demanda, baixam arquivos de CID e investigam inconsistências. Use Iniciar conciliação completa e Listar jobs de conciliação.
- Worker VSync: um processo automático em background que compara periodicamente os vínculos internos com o DICT e concilia as divergências sem intervenção do usuário.
Estatísticas
O domínio Statistics expõe os agregados de risco e de uso do Pix do BACEN. Você pode avaliar uma contraparte antes de liquidar um pagamento. Os dois endpoints consultam o provedor diretamente e não armazenam dados localmente. Trate cada chamada como uma consulta nova, em tempo real. Os dois endpoints exigem autenticação bearer.
Estatísticas da pessoa
Passe o documento fiscal (CPF ou CNPJ) no path. A resposta agrega dados de liquidação, marcações de fraude, relatos de infração e informações de vínculo. Ela cobre três janelas móveis: d90 (últimos 90 dias), m12 (últimos 12 meses) e m60 (últimos 60 meses).Estatísticas da chave
Passe a chave Pix no path. A resposta devolve duas estatísticas em uma única chamada: no nível da chave e no nível do dono. As estatísticas no nível da chave se ligam à chave como entidade, independentemente do dono atual dela. As estatísticas no nível do dono correspondem às estatísticas da pessoa referentes ao dono atual da chave.Use as estatísticas da chave quando você paga uma chave específica. Use as estatísticas da pessoa para uma visão mais ampla do risco da contraparte. O plugin não persiste nenhum dos dois resultados. Faça cache com responsabilidade no seu lado se reutilizar um resultado dentro de um fluxo de requisição.
Marcações de fraude e MED 1.0
O DICT também expõe as ferramentas de prevenção a fraude do MED (Mecanismo Especial de Devolução) do BACEN. As marcações de fraude sinalizam uma chave ou conta como associada a fraude. Você pode criar e cancelar essas marcações (tipos de fraude:
APPLICATION_FRAUD, MULE_ACCOUNT, SCAMMER_ACCOUNT, OTHER). Os relatos de infração e as solicitações de devolução relacionados conduzem o workflow de disputa do MED 1.0.
Referência: Criar uma marcação de fraude · Cancelar uma marcação de fraude · Listar marcações de fraude
Relatos de infração
Um relato de infração avisa o PSP da contraparte que você contesta uma transação como fraude. Você pode abrir um relato apenas dentro de 90 dias a partir da data da transação. O relato segue um ciclo de vida criar → reconhecer → encerrar/cancelar:- Criar: abre o relato contra o end-to-end ID contestado, por exemplo
reason: REFUND_REQUEST,situationType: SCAM. - Reconhecer: o PSP que recebe confirma o recebimento do relato.
- Encerrar: o PSP que responde envia o resultado da análise (por exemplo
TOTALLY_ACCEPTED) em até 7 dias. O PSP do recebedor fecha as infraçõesREFUND_REQUEST. O PSP do pagador fecha as infraçõesREFUND_CANCELLED. Depois do encerramento, o relato fica imutável. - Cancelar: o relator retira um relato que ele abriu.
Solicitações de devolução
Uma solicitação de devolução é o mecanismo do MED 1.0 para pedir ao PSP da contraparte que devolva os recursos contestados. Ela espelha o mesmo ciclo de vida criar → reconhecer → encerrar/cancelar:
Encerrar registra o resultado da análise e finaliza a solicitação. Cancelar retira uma solicitação pendente. Os webhooks de saída entregam as mudanças de status tanto dos relatos de infração quanto das solicitações de devolução. Veja o guia de Webhooks.
Referência: Criar um relato de infração · Reconhecer · Encerrar · Cancelar · Criar uma solicitação de devolução
Para os fluxos de recuperação de recursos, veja Operações de devolução e MED 2.0 — Funds Recovery.
Próximos passos
- QR Codes: gerar QR Codes em chaves registradas
- Webhooks: notificações de reivindicação, de infração e de devolução
- Integração: conciliação do DICT e configuração do worker

