Consulta de Dados de Chave Pix no Banco Central

Request

ENDPOINT

/pix_key/PIX_KEY

MÉTODO

GET

Request Path Params

Campo	Tipo	Descrição	Caracteres
pix_key *	string	Chave PIX que será consultada.	77

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: UUID4.

Request Query Params

Campo	Tipo	Descrição	Caracteres
alias_key *	uuidv4	Chave única do alias.	36

Utilização de tokens de consulta

Para que o token de consulta de chave pix seja cobrado da pessoa correta, é obrigatório que o alias_key seja enviado.

Response

STATUS

200

Response Body: Chave Ativa

{
  "account_branch": "0001",
  "account_created_at": "2023-09-06T22:03:34.000Z",
  "account_digit": "8",
  "account_number": "2897775",
  "account_type": "checking",
  "bank_code": null,
  "end_to_end_id": "E73856642202309201429bZKfklNlbwu",
  "financial_institution": "BANCO INDIRETO PRUPRU",
  "ispb": "32402502",
  "owner_masked_document_number": "**.458.****/0001-**",
  "owner_name": "Empresa teste 01",
  "owner_person_type": "legal",
  "owner_trading_name": null,
  "pix_key": "0f723f66-b333-4187-be16-97fc37c86052"
}

Campo	Tipo	Descrição	Max. Caracteres
pix_key	string	Chave pix da consulta	4
account_branch	string	Agência, sem o dígito verificador	4
account_digit	string	Dígito verificador da conta	1
account_number	string	Número de conta, sem o dígito verificador	20
account_type	string	Definição do tipo de conta	20
owner_person_type	string	Tipo de dono da contaPode ser "legal" ou "natural"	7
owner_masked_document_number	string	Numero de CPF ou CNPJ	14
end_to_end_id	string	Chave unitária da transação PIX	32
owner_name	string	Nome do dono da conta	120
owner_trading_name	string	Nome fantasia do dono da conta (somente para CNPJ)	100
ispb	string	ISPB do Participate detentor da chave	8
bank_code	string	Código COMPE da instituição financeira	3
financial_institution	string	Nome da instituição financeira detentora da chave	100
account_created_at	string	Data de criação da conta	20

STATUS

4XX

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

Código HTTP	Código QI code	Título title	Descrição (eng) Description	Descrição (ptbr) translation
400	PIX000086	Invalid Query Params Combination	Account_key and Alias_key are mutually exclusive query parameters. Choose one	Account_key e Alias_key são parâmetros mutualmente exclusivos. Escolha apenas um
403	PIX000080	Not enough permission	The selected agent is not an Pix Indirect Participant	O agente selecionado não é um Participante Indireto do Pix
404	PIX000082	Alias not found	Alias {alias_key} not found	Alias {alias_key} não encontrado
404	PIX000017	Pix Key is Unregistered	Pix key {pix_key} is not currently used	A chave pix {pix_key} não está sendo utilizada
400	PIX000081	Rate Limit Exceeded	Rate Limit Exceeded	Limite de requisições excedido