在巴西中央银行查询 PIX 密钥数据

请求

ENDPOINT

/pix_key/PIX_KEY

MÉTODO

GET

请求路径参数

字段	类型	描述	字符数
`pix_key` *	string	将被查询的 PIX 密钥。	77

PIX 密钥类型

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

CPF：11 位整数。

CNPJ：14 位整数。

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

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

随机密钥：UUID4。

请求查询参数

字段	类型	描述	字符数
`alias_key` *	uuidv4	Alias 唯一密钥。	36

查询令牌使用说明

为确保 PIX 密钥查询令牌向正确的人收取费用，必须发送 alias_key。

响应

STATUS

200

响应体：活跃密钥

{
  "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"
}

字段	类型	描述	最大字符数
`pix_key`	string	查询的 PIX 密钥。	4
`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
`end_to_end_id`	string	PIX 交易唯一密钥。	32
`owner_name`	string	账户所有者姓名。	120
`owner_trading_name`	string	账户所有者商业名称（仅限 CNPJ）。	100
`ispb`	string	密钥持有参与者的 ISPB。	8
`bank_code`	string	金融机构的 COMPE 代码。	3
`financial_institution`	string	密钥持有金融机构名称。	100
`account_created_at`	string	账户创建日期。	20

STATUS

4XX

响应体：错误

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

HTTP 状态码	QI 错误码 `code`	标题 `title`	英文描述 `Description`	葡文描述 `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

请求​

请求路径参数​

请求查询参数​

响应​

请求

请求路径参数

请求查询参数

响应