Consultar Informações de uma Chave PIX

Retorna os dados bancários e cadastrais associados a uma chave PIX informada, permitindo validar o destinatário antes de uma transferência.

Este endpoint permite consultar informações detalhadas de uma chave PIX, informando a chave no corpo da requisição.

A operação retorna dados essenciais sobre o titular da chave e o banco de destino, incluindo:

• Nome e documento do titular;

• Banco e código ISPB;

• Código identificador da chave (id);

• Identificador endToEndId.

⚠️ O campo id retornado é fundamental para realizar o envio do PIX em etapas seguintes, pois ele identifica unicamente a chave no sistema e deve ser utilizado no payload do endpoint de envio de PIX.

Endpoint para Consultar Chave Pix

POST /accounts/{accountId}/pix/key-info

Este endpoint é protegido e requer o uso do cabeçalho Authorization: Bearer <token> e x-tenant-id.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>
x-tenant-id	Tenant ID

Body

Name	Type	Description
key	string	Chave PIX

Response

200

{
  "key": {
    "id": "c5a81db4-926b-4cb7-85f9-7d2e5b421ac2",
    "key": "[email protected]",
    "ispb": "12345678",
    "document": "***.987.654-**",
    "name": "Juliana Santos Almeida",
    "bankName": "Banco Stric Digital",
    "bankCode": "777",
    "endToEndId": "E202510081045STRIC1A2B3C4D5E6F7G8H"
  }
}

400

{
    "code": "BAD_REQUEST",
    "error": "Não foi possível consulta a key XXXXX.",
    "message": "Não foi possível consulta a key XXXX."
}