Pular para o conteúdo principal

Consultar chaves Pix

Request

ENDPOINT
/baas/pix/keys/PIX_KEY
MÉTODO
GET

Path params

CampoTipoDescrição
pix_key *stringChave PIX que será consultada.
Tipos de Chave Pix

A “pix_key” pode ser um CPF, CNPJ, E-mail, Celular ou uma Chave Aleatória (UUID), seguindo as seguintes formatações:

CPF: Número inteiro com 11 dígitos.

CNPJ: Número inteiro com 14 dígitos.

E-mail: Texto contendo ao menos um “@”.

Celular: Texto contendo os seguintes valores: “+55” + “DDD do celular“ + “Número Inteiro do Celular com no mínimo 8 e no máximo 9 dígitos”. Ex: “+5511987654321“.

Chave Aleatória: UUID.

Response

STATUS
200
Response Body: Chave Ativa
{
"account_branch": "452",
"account_digit": "1",
"account_number": "370158",
"account_type": "checking_account",
"bank_code": 237,
"end_to_end_id": "E3240250220230404185631R0kjZnC6G",
"exists": true,
"financial_institution": "BCO BRADESCO S.A.",
"ispb": "60746948",
"masked_document_number": "***.141.85*-**",
"name": "Teste teste",
"pix_key": "teste@gmail.com",
"valid": true
}

STATUS
200
Response Body: Chave Inativa
{
"exists": false,
"pix_key": "teste@gmail.com"
}
STATUS
422
Response Body: Tempo limite de consulta de chave
{
"title": "Pix Key inquiry timeout",
"description": "Pix key inquiry timeout. Please try again.",
"translation": "Consulta de chave pix excedeu o tempo limite. Por favor tente novamente.",
"code": "PIX000069"
}
STATUS
422
Response Body: Erro ao consultar chave pix
{
"title": "Unprocessable Entity",
"description": "Error when querying pix key 12345678000190",
"translation": "Erro ao consultar chave pix 12345678000190",
"code": "PIX000077"
}
STATUS
429
Response Body: Limite de requisições atingido
{
"title": "Rate limit reached",
"description": "Rate limit reached when checking key in Bacen",
"translation": "Limite de requisições atingido ao consultar chave no Bacen",
"code": "PIX000079"
}