查询 Pix 密钥

Request

ENDPOINT

/pix_key/PIX_KEY?authenticated_user_key=CPF/CNPJ

MÉTODO

GET

Request Path Params

字段	类型	描述
pix_key *	string	待查询的 PIX 密钥

Pix 密钥类型

"pix_key" 可以是 CPF、CNPJ、电子邮件、手机号或随机密钥（UUID），格式如下：

CPF：11 位整数。

CNPJ：14 位整数。

电子邮件：包含至少一个"@"的文本。

手机号：包含以下格式的文本："+55" + "手机区号" + "手机号（最少8位、最多9位整数）"。例如："+5511987654321"。

随机密钥：UUID4。

Request Query String Params

字段	类型	描述
authenticated_user_key *	string	账户持有人文件号

Response

STATUS

200

Response Body: 有效密钥

{
  "account_branch": "452",
  "account_digit": "1",
  "account_number": "370158",
  "owner_person_type": "legal",
  "account_type": "checking_account",
  "account_created_at": "2021-10-22T20:30.459Z",
  "end_to_end_id": "E3240250220230404185631R0kjZnC6G",
  "financial_institution": "BCO BRADESCO S.A.",
  "ispb": "60746948",
  "owner_masked_document_number": "***.141.857-**",
  "owner_name": "Teste teste",
  "pix_key": "teste@gmail.com",
  "owner_trading_name": "Teste LTDA."
}

字段	类型	描述	最大字符数
account_branch *	string	机构号，不含校验位	4
account_digit *	string	账户校验位	1
account_number *	string	账号，不含校验位	20
account_type *	string	账户类型定义	20
owner_person_type *	string	账户所有者类型。可以是 "legal" 或 "natural"	7
owner_masked_document_number*	string	CPF 或 CNPJ 号码	14
owner_name *	string	账户所有者姓名	120
owner_trading_name	string	账户所有者商号（仅适用于 CNPJ）	100
ispb *	string	密钥持有参与者的 ISPB	8
financial_institution *	string	持有密钥的金融机构名称	200
created_at *	datetime Zulu	请求创建日期	20

STATUS

404

Response Body: 无效密钥

{
  "title": "Pix Key Not Found",
  "description": "Pix key edd5d727-ddd6-4bbb-8463-2ff1bdb28c89 not found.", 
  "translation": "A chave pix edd5d727-ddd6-4bbb-8463-2ff1bdb28c89 não foi encontrada.",
  "code": "PIX000017"
}

STATUS

4XX

Response Body

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

HTTP 代码	QI 代码 code	标题 title	描述（英文） Description	描述（葡萄牙语） translation
403	PIX000080	Not enough permission	The selected agent doesn't have permission to access this resource.	O agente selecionado não tem permissão para acessar este recurso.
429	PIX000081	Rate Limit Exceeded	Rate Limit Exceeded	Limite de requisições excedido
404	PIX000082	Alias not found	Alias {alias_key} not found	Alias {alias_key} não encontrado
404	PIX000083	Pix Key not found	Pix Key {pix_key} not found for Alias {alias_key}	Chave Pix {pix_key} não encontrada para o Alias {alias_key}
400	PIX000084	Only one query param allowed	Only one query param allowed	Somente um parâmetro de consulta é permitido