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

Request

ENDPOINT

/pix_key/PIX_KEY

MÉTODO

GET

Request Path Params

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

Pix 密钥类型

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

CPF：11 位整数。

CNPJ：14 位整数。

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

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

随机密钥：UUID4。

Request Query Params

字段	类型	描述	字符数
`account_key` *	uuidv4	别名唯一密钥。	36
`document_number`	int	Pix 密钥持有人的 CPF/CNPJ。传递此参数时，`is_pix_key_owner` 字段将返回一个布尔值，标识所提供的 CPF/CNPJ 是否与 Pix 密钥持有人的相同。	14

查询令牌的使用

若要将 Pix 密钥查询令牌计费给账户持有人，必须发送 account_key。若不发送 account_key，则令牌将计费给合作伙伴的文件编号。

Response

STATUS

200

Response Body: 有效密钥

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

字段	类型	描述	最大字符数
`account_branch`	string	与 Pix 密钥绑定的账户机构号，不含校验位。	4
`account_created_at`	string	与 Pix 密钥绑定的账户开户日期，由账户托管机构提供。	21
`account_digit`	string	与 Pix 密钥绑定的账户校验位。	1
`account_number`	string	与 Pix 密钥绑定的账号，不含校验位。	20
`account_type`	enum	Pix 密钥账户类型定义。	枚举值 Account Type
`bank_code`	string	Pix 密钥注册银行代码。对于没有银行代码的机构可能返回空值。	3
`end_to_end_id`	string	在巴西央行查询 Pix 密钥的唯一标识符。应在 Pix 转账中发送，以便恢复查询时消耗的令牌。	32
`financial_institution`	string	Pix 密钥注册金融机构名称。	200
`is_pix_key_owner`	boolean	如果在请求中传递了 `document_number` 参数，则返回布尔值。此字段表示 `document_number` 参数中提供的 CPF/CNPJ 是否与 Pix 密钥持有人的相同。如果未提供 `document_number` 参数，则返回空值。	-
`ispb`	string	Pix 密钥持有参与者的 ISPB。	8
`owner_masked_document_number`	string	Pix 密钥持有人的 CPF 或 CNPJ 号码。	14
`owner_name`	string	Pix 密钥持有人姓名。	120
`owner_person_type`	enum	Pix 密钥持有人的法律性质。	枚举值 Owner Person Type
`owner_trading_name`	string	Pix 密钥持有人商号（仅适用于 `owner_person_type=legal`）。	100
`pix_key`	string	Pix 密钥。	-

枚举值 account_type

枚举值	描述
`payment`	支付账户
`checking`	活期账户
`savings`	储蓄账户
`saving`	储蓄账户
`salary`	工资账户
`saving_account`	储蓄账户
`payment_account`	支付账户
`checking_account`	活期账户
`salary_account`	工资账户
`escrow`	关联账户

信息

不同的枚举值可能代表相同的账户类型，这是由不同机构返回的信息所致。

枚举值 owner_person_type

枚举值	描述
`natural`	string
`legal`	string

STATUS

4XX

Response Body

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

HTTP 代码	QI 代码 `code`	标题 `title`	描述（英文） `Description`	描述（葡萄牙语） `translation`
404	PIX000017	Pix Key Not Found	Pix key {pix_key} not found.	A chave pix {pix_key} não foi encontrada.
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

Request​

Request Path Params​

Request Query Params​

Response​

枚举值 account_type​

枚举值 owner_person_type​