Consultar dados de uma chave Pix.

GET

/pix/keys/{key}

Chaves Pix

Consulta no DICT os dados públicos de qualquer chave Pix informada: titular e conta de destino.

Para listar, criar ou remover as chaves da própria conta, use /accounts/keys.

Requisição

Authorization

OAuth 2.0

Client Credentials

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Token URL: /oauth/token

Scopes:

pix.read-Permite consultar chaves Pix, dados de QR Code, estatísticas e status de pagamentos Pix

Parâmetros de Caminho

Respostas

🟢200

application/json

Sucesso

Bodyapplication/json

🟠400

🟠401

🟠403

🟠429

🔴500

Response Example

200 - Exemplo 1

{
    "name": "string",
    "tradeName": "string",
    "keyType": "CPF",
    "key": "string",
    "document": "string",
    "ispb": "string",
    "ispb_reduced_name": "string",
    "endToEndId": "string"
}

Página anterior

Remover chave Pix da conta.

Próxima página

Iniciar pagamento Pix por QR Code.