Consulta de chaves para transferência

Este endpoint permite realizar a consulta no DICT de todas as informações vinculadas à chave Pix que receberá uma transferência ou pagamento.

Essa consulta é um pré-requisito para realizar transações via Pix e abrange todas as chaves cadastradas no Bacen, não apenas aquelas vinculadas às contas Bankly.

Condições para consulta

Como mecanismo de prevenção a ataques de leitura, o DICT possui um controle de requisições baseado em consultas de chaves que não possuam liquidação e consultas inválidas.

Caso o Bankly identifique a recorrência de consultas sem vínculo com transações Pix, o uso do serviço será bloqueado.

❗️

Atenção

O DICT não deve ser utilizado para consulta cadastral e nem para qualquer outra finalidade que não seja transacionar para uma chave Pix. Para mais informações, consulte a documentação Manual Operacional do Diretório de Identificadores de Contas Transacionais (DICT).

Requisição

Requisição HTTP

GET https://api-mtls.sandbox.bankly.com.br/pix/entries/{{addressingKeyValue}}

curl --request GET \ 
     --url 'https://api-mtls.sandbox.bankly.com.br/pix/entries/{{addressingKeyValue}}' \
     --header 'Accept: application/json' \
     --header 'api-version: 1.0' \
     --header 'x-bkly-pix-user-id: {{userDocument}}' \
     --header 'x-correlation-id: {{GUID}}' \ 
     --header 'Authorization: Bearer {{Token}}'

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:

Cabeçalhos (Headers)

🚧

Importante

Só será possível realizar a consulta por chave se o x-bkly-pix-user-id do payer estiver cadastrado em nossa base de dados. Caso contrário, será retornado o erro 403 - FORBIDDEN.

Parâmetros da rota (Path)

No path desta requisição envie os seguintes campos:

Chave de endereçamento

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

O status code 200 indicará sucesso na consulta.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

🚧

Importante

O campo endToEndId possui duração de 15 minutos e só poderá ser utilizado em uma única transferência.

{
    "endToEndId": "E1314008820210629151241054156224",
    "addressingKey": {
        "type": "CPF",
        "value": "***426630**"
    },
    "holder": {
        "type": "CUSTOMER",
        "name": "Nísia Floresta",
        "socialName": "Nísia Floresta",
        "document": {
            "value": "***426630**",
            "type": "CPF"
        }
    },
    "status": "OWNED",
    "createdAt": "2020-11-06T01:07:12.351+00:00",
    "ownedAt": "2020-11-06T01:07:12.337+00:00"
}

{
    "endToEndId": "E1314008820210629151241054156224",
    "addressingKey": {
        "type": "EVP",
        "value": "73275ad1-ae06-4407-b488-d86c9f502bac"
    },
    "holder": {
        "type": "BUSINESS",
        "name": "Nísia Floresta",
        "tradingName": "Editora Nísia Floresta",
        "document": {
            "value": "*456070001",
            "type": "CNPJ"
        }
    },
    "status": "OWNED",
    "createdAt": "2020-11-06T01:07:12.351+00:00",
    "ownedAt": "2020-11-06T01:07:12.337+00:00"
}

👍

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

Status da chave de endereçamento

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.