Pular para o conteúdo principal
O DICT gerencia o diretório de chaves Pix e os fluxos de disputa relacionados. Use a API pública para as ações do cliente. O plugin coordena as chamadas ao provedor e o estado local.

​
Registrar e resolver uma chave

  1. Crie uma entrada com Criar entrada. Envie o escopo da conta, o motivo obrigatório e os cabeçalhos de idempotência.
  2. Salve o identificador da entrada e leia-a com Obter entrada.
  3. Resolva uma chave com Consultar chave antes de um pagamento baseado em chave ou use Verificar existência de chaves para uma verificação em lote.
  4. Atualize ou exclua somente pelas rotas públicas do ciclo de vida da entrada. Não trate uma consulta como prova de titularidade de outra conta.
Uma conta-salário (SLRY) não pode receber uma nova chave: a API a recusa com 422 (PIX-0176). Se o diretório tiver a chave registrada para outra pessoa, a API responde 409 (PIX-0177), e uma reivindicação de titularidade é o próximo passo usual. Se o diretório tiver a chave registrada para o mesmo titular em outro participante, a API responde 409 (PIX-0178), e uma reivindicação de portabilidade é o próximo passo usual. A criação e a atualização de entradas podem falhar de forma fechada quando o armazenamento de replay estiver indisponível. Um 503 nessa condição não é um sinal seguro para repetir a ação de negócio com uma nova chave.

​
Mover uma chave por meio de uma reivindicação

As reivindicações cobrem titularidade e portabilidade. Um fluxo do cliente é:
  1. Abra a reivindicação com Criar reivindicação.
  2. Leia-a com Obter reivindicação.
  3. Use a transição correspondente ao papel e ao estado da reivindicação: confirmar, concluir, reconhecer ou cancelar.
As mutações de reivindicação, exceto o cancelamento, ficam indisponíveis enquanto o VSync concilia. O cancelamento da reivindicação é intencionalmente separado: ele continua sendo uma saída para uma reivindicação ativa, não uma nova fonte de divergência do diretório.

​
Trabalhar em um caso de MED 2.0

Uma recuperação de fundos abre um caso acompanhado. Ela não prova, por si só, que os fundos foram devolvidos.
  1. Abra-o com Criar recuperação de fundos e mantenha o identificador interno retornado. Envie userComplaintAt, o momento em que a reclamação do usuário pagador foi registrada no seu canal de atendimento. O campo é obrigatório, e um momento posterior à abertura da recuperação é recusado com 422 (PIX-0100). Uma resposta 202 significa que o BACEN ainda não resolveu a criação, e a recuperação fica PENDING. Leia-a de novo mais tarde: ela passa a CREATED ou responde 404 (PIX-0110) quando o BACEN não aplicou a criação.
  2. Leia o caso, os relatórios de infração relacionados e o grafo de rastreamento por meio das operações de referência correspondentes.
  3. Atualize somente os campos mutáveis de contato ou relatório com o contrato documentado de merge patch.
  4. Quando o caso chegar ao estado que permite a ação, inicie a devolução por meio da operação documentada de devolução da recuperação de fundos. Leia o caso novamente para observar o novo estado.
  5. Cancele somente quando o estado atual permitir o cancelamento.
O plugin limita as recuperações de fundos ao participante autenticado. Você não deve usar uma resposta de não encontrado para distinguir o recurso de outro participante de um identificador desconhecido.

​
Reter o saldo para um relatório de infração

Criar um bloqueio de saldo em um relatório de infração retém um valor contra o relatório. Repetir o mesmo requestRef repete o bloqueio. Liberar um bloqueio de saldo de um relatório de infração o libera.

​
Registrar e cancelar um marcador de fraude

Use Criar marcador de fraude com uma identidade de requisição criada pelo chamador. Um replay com a mesma identidade e o mesmo payload retorna o mesmo marcador. Um payload diferente é rejeitado. Use Listar marcadores de fraude ou Obter marcador de fraude para inspecioná-lo e Cancelar marcador de fraude quando o marcador não dever mais se aplicar.

​
Deixar o VSync proteger a consistência das chaves

O VSync concilia o estado local das chaves com o diretório por escopo. Ele avança da verificação para a sincronização de eventos e, quando necessário, para a conciliação de arquivos. Leia-o com Listar estados do VSync, Listar jobs de conciliação e Listar logs de conciliação. Inicie uma verificação com Disparar uma verificação de sincronização ou Disparar a conciliação de arquivos. Enquanto um escopo é conciliado, o DICT recusa mutações protegidas com 503, em vez de aceitar uma alteração que poderia adicionar uma nova divergência. Aguarde o escopo ficar disponível e leia o estado do VSync se o bloqueio persistir. Não contorne o bloqueio com callbacks do adaptador ou alterações diretas no armazenamento. Para retenções e devoluções de pagamentos em disputa, continue com SPI e o Block Balancer.