在巴西中央银行查询 Pix 键数据
请求
ENDPOINT
/pix_key/PIX_KEY方法
GET请求 Path Params
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
pix_key * | string | 待查询的 Pix 键。 | 77 |
Pix 键类型
"pix_key" 可以是 CPF、CNPJ、电子邮件、手机号码或随机键（UUID），格式如下：
CPF：11位整数。
CNPJ：14位整数。
电子邮件：包含至少一个"@"的文本。
手机号码：包含以下值的文本："+55" + "手机区号" + "最少8位最多9位的手机号码整数"。例如："+5511987654321"。
随机键：UUID4。
请求 Query Params
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
account_key * | uuidv4 | 账户的唯一标识键。 | 36 |
document_number | string | Pix 键持有人的 CPF/CNPJ。传递此参数时，将返回 is_pix_key_owner 字段，布尔值表示所提供的 CPF/CNPJ 是否与 Pix 键持有人的相同。 | 14 或 11 |
查询令牌使用
为使 Pix 键查询令牌从账户持有人处扣除，必须发送 account_key。
如果未发送 account_key，令牌将从集成合作伙伴的文件编号中扣除。
响应
STATUS
200Response Body: 活跃键
{
"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"
}
| 字段 | 类型 | 描述 | 最大字符数 |
|---|---|---|---|
bank_code | string | 注册 Pix 键的银行代码。对于没有银行代码的机构，可能返回 null。 | 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 参数，则返回 null。 | - |
ispb | string | 持有 Pix 键的参与方 ISPB。 | 8 |
owner_masked_document_number | string | Pix 键持有人的掩码 CPF 或 CNPJ 号码。 | 14 |
owner_name | string | Pix 键持有人姓名。 | 120 |
owner_person_type | enum | Pix 键持有人的法律性质。 | Enumeradores Owner Person Type |
owner_trading_name | string | Pix 键持有人的商业名称（仅适用于 owner_person_type=legal）。 | 100 |
pix_key | string | Pix 键。 | - |
Enumeradores account_type
| 枚举值 | 描述 |
|---|---|
payment | 支付账户 |
checking | 支票账户 |
savings | 储蓄账户 |
saving | 储蓄账户 |
salary | 工资账户 |
saving_account | 储蓄账户 |
payment_account | 支付账户 |
checking_account | 支票账户 |
salary_account | 工资账户 |
escrow | 托管账户 |
信息
由于不同机构返回的信息不同，不同的枚举值可能表示同一种账户类型。
Enumeradroes owner_person_type
| 枚举值 | 描述 |
|---|---|
natural | string |
legal | string |
STATUS
4XXResponse 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 | 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 |