为 Alias 创建 PIX 密钥
请求
ENDPOINT
/account/ACCOUNT_KEY/alias/ALIAS_KEY/pix_keyMÉTODO
POST请求体 - 'random_key' 类型密钥
{
"request_control_key": "3d3d0083-ac71-46f0-8a90-c00a157a4893",
"pix_key_type": "random_key"
}
请求体 - CPF 类型密钥
{
"request_control_key": "3d3d0083-ac71-46f0-8a90-c00a157a4893",
"pix_key_type": "cpf",
"pix_key": "67824450007"
}
请求路径参数
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
account_key | uuidv4 | 账户唯一密钥。 | 36 |
alias_key | uuidv4 | Alias 唯一密钥。 | 36 |
请求体参数
| 字段 | 类型 | 描述 | 最大字符数 |
|---|---|---|---|
request_control_key * | string | 用于查询所发起请求的 UUID4。 | 36 |
pix_key_type * | string | 定义将创建的密钥类型。可选值：'cpf'、'cnpj'、'email'、'phone_number'、'random_key' | 10 |
pix_key | string | 要创建的 PIX 密钥值。'random_key' 类型无需发送。 | 10 |
PIX 密钥类型
请求中发送的 pix_key 可以是 CPF、CNPJ、电子邮件或手机号码，格式如下：
CPF：11 位整数。
CNPJ：14 位整数。
电子邮件：包含至少一个"@"的文本。
手机号码：包含以下值的文本："+55" + "手机区号" + "至少 8 位、最多 9 位的手机号码整数"。例如："+5511987654321"。
响应
STATUS
200响应体
{
"pix_key": "asra-4cd6-4c04-9651-1c0a2c30d7dd",
"pix_key_status": "active",
"created_at": "2021-12-06T21:16:11.001Z",
"pix_key_type": "random_key"
}
响应体参数
| 字段 | 类型 | 描述 | 最大字符数 |
|---|---|---|---|
pix_key | string | 创建的 PIX 密钥值。 | 200 |
pix_key_status | string | PIX 密钥激活状态。可以是 "active"、"inactive" 或 "pending" | 8 |
created_at | datetime Zulu | 请求创建日期。 | 20 |
PIX 密钥类型
请求响应中返回的 pix_key 可以是 CPF、CNPJ、电子邮件、手机号码或随机密钥，格式如下：
CPF：11 位整数。
CNPJ：14 位整数。
电子邮件：包含至少一个"@"的文本。
手机号码：包含以下值的文本："+55" + "手机区号" + "至少 8 位、最多 9 位的手机号码整数"。例如："+5511987654321"。
随机密钥：UUIDV4。
STATUS
4XX响应体：错误
{
"title": "titulo",
"description": "description in English",
"translation": "descrição em portugues",
"code": "codigo",
"extra_fields": {}
}
| HTTP 状态码 | QI 错误码code | 标题title | 英文描述Description | 葡文描述translation |
|---|---|---|---|---|
| 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 |