Consultar Chaves Pix Externa (DICT)
Consultar uma chave Pix para uma conta
Com essa chamada você consultará uma chave externa Pix e consequentemente irá gerar um endtoend para uma futura transação.
Glossário
DICT -> O Diretório de Identificadores de Contas Transacionais - é o serviço do arranjo Pix que permite buscar detalhes de contas transacionais com chaves de endereçamento mais convenientes para quem faz um pagamento. Entre os tipos de chave atualmente disponíveis estão CPF, CNPJ, telefone, e-mail e EVP.
Entenda o comportamento desse endpoint
Esse endpoint adota um “sistema de baldes e fichas" em conformidade com o Manual Operacional do DICT (seção 13: “mecanismos de prevenção a ataques de leitura”).
Para entender o funcionamento, acesse aqui.
Passos para Integrar
- Realizar autenticação na API - [API Reference]
- Consultar Chaves Pix Externa- [API Reference]
Consultar chaves Pix Externa (DICT)
cURL da chamada
curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/celcoin-baas-pix-dict-webservice/v1/pix/dict/entry/external/30054127367?key=00118111612' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'
Exemplo de retorno
Sucesso 200
{
"status": "SUCCESS",
"body": {
"keyType": "CPF",
"key": "00118111612",
"account": {
"participant": "30980539",
"branch": "9851",
"account": "17619198852",
"accountType": "CACC",
"createDate": "2023-08-22T13:48:43.0000000Z"
},
"owner": {
"type": "NATURAL_PERSON",
"documentNumber": "00118111612",
"name": "teste ldjnnjbnrr tznwmjabtg"
},
"endtoEndId": "E1393589320231107201960B1PH1cr52",
"statistics": {
"lastUpdated": "2023-11-07T20:13:15.01Z",
"counters": [
{
"type": "SETTLEMENTS",
"by": "KEY",
"d3": "0",
"d30": "0",
"m6": "0"
},
{
"type": "SETTLEMENTS",
"by": "OWNER",
"d3": "0",
"d30": "0",
"m6": "0"
},
{
"type": "SETTLEMENTS",
"by": "ACCOUNT",
"d3": "0",
"d30": "0",
"m6": "0"
},
{
"type": "REPORTED_FRAUDS",
"by": "KEY",
"d3": "0",
"d30": "0",
"m6": "0"
},
{
"type": "REPORTED_FRAUDS",
"by": "OWNER",
"d3": "0",
"d30": "0",
"m6": "0"
},
{
"type": "REPORTED_FRAUDS",
"by": "ACCOUNT",
"d3": "0",
"d30": "0",
"m6": "0"
},
{
"type": "CONFIRMED_FRAUDS",
"by": "KEY",
"d3": "0",
"d30": "0",
"m6": "0"
},
{
"type": "CONFIRMED_FRAUDS",
"by": "OWNER",
"d3": "0",
"d30": "0",
"m6": "0"
},
{
"type": "CONFIRMED_FRAUDS",
"by": "ACCOUNT",
"d3": "0",
"d30": "0",
"m6": "0"
},
{
"type": "CONFIRMED_AML_CFT",
"by": "KEY",
"d3": "0",
"d30": "0",
"m6": "0"
},
{
"type": "CONFIRMED_AML_CFT",
"by": "OWNER",
"d3": "0",
"d30": "0",
"m6": "0"
},
{
"type": "CONFIRMED_AML_CFT",
"by": "ACCOUNT",
"d3": "0",
"d30": "0",
"m6": "0"
}
]
}
},
"version": "1.0.0"
}
Error 400
{
"version": "1.0.0",
"status": "ERROR",
"error": {
"errorCode": "CBE177",
"message": "Operação não permitida. Conta esta bloqueada"
}
}
Tabela de errorCode
| Code | Message |
|---|---|
| CBE091 | É necessário informar pelo menos um dos campos: id, clientCode, ou endtoendId. |
| CBE039 | Account invalido. |
| CBE175 | Cadastro de chave não permitido. Verifique o formato da chave informada |
| CBE041 | Account possui tamanho maximo de 20 caracteres |
| CBE174 | O Campo key não pode ultrapassar 77 caracteres |
| CBE176 | Operação não permitida. Conta esta encerrada |
| CBE177 | Operação não permitida. Conta esta bloqueada |
| CBE190 | Operação Não permitida. Chave não esta vinculada a essa conta. |
Updated 5 months ago