Consultar Chaves Pix Externa (DICT)

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

1. Realizar autenticação na API - [API Reference]
2. Consultar Chaves Pix Externa- [API Reference]

Consultar chaves Pix Externa (DICT)

Chaves para Testes

CPF -> 77517432125

Email-> [email protected]

Telefone -> +5532976886942

Verificação de Propriedade da Chave Pix

Ao enviar o parâmetro ownerTaxId na requisição de consulta, validaremos se o proprietário da chave é o mesmo que o titular da conta, o que permitirá identificar se a transferência via Pix é feita entre titulares iguais ou não.

Retorno do campo isSameTaxId:
Na resposta da consulta, temos o campo isSameTaxId, que indicará se o taxId da chave é igual ao ownerTaxId enviado na requisição:

true: Se os documentos forem iguais.
false: Se os documentos forem diferentes.

cURL da chamada

curl --location --request GET 'https://sandbox.openfinance.celcoin.dev/celcoin-baas-pix-dict-webservice/v1/pix/dict/entry/external/30054065526?key=77517432125&ownerTaxId=19702369061' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

Exemplo de retorno

👍

Sucesso 200

{
    "status": "SUCCESS",
    "body": {
        "keyType": "CPF",
        "key": "77517432125",
        "account": {
            "participant": "13935893",
            "branch": "*****",
            "account": "**************",
            "accountType": "TRAN",
            "createDate": "2024-07-18T19:10:57.0000000Z"
        },
        "owner": {
            "type": "NATURAL_PERSON",
            "documentNumber": "***174321**",
            "name": "Margaret Gusikowski"
        },
        "endtoEndId": "E13935893202407181911haBMDtsjBBc",
        "creationDate": "2024-07-18T19:10:58.404Z",
        "keyOwnershipDate": "2024-07-18T19:10:58.402Z",
        "openClaimCreationDate": "0001-01-01T00:00:00",
        "isSameTaxId": false
    },
    "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