Consulta chave Pix - DICT
Permite que empresas parceiras e integradoras da solução de pagamento da NDD consultem a chave Pix no DICT do Bacen para validar se ela pertence ao transportador cadastrado, assegurando que os pagamentos sejam direcionados corretamente ao titular legítimo e reduzindo riscos de fraude ou erro.
O parceiro só poderá consultar a chave PIX das contratantes vinculadas ao seu Client ID.
Para consultar a chave Pix do transportador no BACEN e necessário que o contratante possua uma conta do NDD Cargo.
Método e rota
- Criação (POST):
/consulta/Dict/:enterpriseId
Estrutura da requisição
Cabeçalhos
-
Authorization: o token JWT deve ser enviado no header.
Authorization: Bearer {token}
Corpo
Confira o exemplo abaixo, descrição dos campos e veja aqui a definição completa.
{
"tipoChave": 1,
"chavePix": "diogo.lopes@ndd.tech",
"nome": "Diogo Bruno Lopes",
"documento": "08099945604",
"contrantante": "420966903000127"
}
Layout
| Parâmetro | Tipo | Descrição |
|---|---|---|
| tipoChave | Enum | E-mail = 1; CPF/CNPJ = 2; Telefone = 3; Aleatória = 4; DadosBancários = 5. |
| chavePix | string | Chave PIX. |
| nome | string | Nome do transportador. |
| documento | integer | CPF ou CNPJ. |
| Contratante | integer | CNPJ da contratante. |
O sistema compara os dados retornados pelo DICT com as informações do transportador.
Resposta do POST
Após o processamento da consulta, a API retornará um JSON com os seguintes dados:
Exemplo de resposta bem-sucedida:
{
"titularChave": "Diogo Bruno Lopes",
"pertenceTransportador": true
}
| Parâmetro | Tipo | Descrição |
|---|---|---|
| titularChave | string | Titular da chave PIX de acordo com o retorno do DICT. |
| result | string | Resultado da consulta. true quando a chave PIX pertence ao transportador e false quando não pertence. |
Exemplo de resposta caso a chave PIX não seja encontrada:
{
"chavePix": "08099945604",
"message": "Chave não localizada"
}