创建可携性申请

注意

如果申请可携性的密钥类型是手机号或电子邮件，则需要进行双因素验证，令牌将发送到所申请的手机号或电子邮件。如果需要双因素验证，"claim_request_status"将为"pending_claimer_validation"。

令牌发送的说明见 2.5.3.5.2 双因素验证

注意!!

创建可携性申请必须使用沙盒环境中的模拟 Pix 密钥。模拟 Pix 密钥

Request

ENDPOINT

/baas/pix/key_claim_request

MÉTODO

POST

Request Body

{
  "account_key": "169010e3-6c1e-4521-9253-11cbbf36c59j",
  "pix_key": "12345678000190",
  "pix_key_type": "cnpj"
}

Body Params

字段	类型	描述	字符数
`account_key`	string	QIConta 标识键。	36
`pix_key`	enum	申请可携性的密钥。	-
`pix_key_type`	enum	可携性 Pix 密钥类型。	枚举值

枚举值 pix_key_type

枚举值	说明
random_key	随机密钥
email	电子邮件
phone_number	手机号
cpf	cpf
cnpj	cnpj

Pix 密钥类型

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

CPF：11 位整数。

CNPJ：14 位整数。

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

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

随机密钥：UUID。

Response

STATUS

200

Response Body

{
  "max_conclusion_date": "2023-05-26T12:13:25",
  "claim_request_status": "pending",
  "claimant": {
    "document_number": "12345678000190",
    "claimant_key": "6aaadfbc-76ba-45d2-bb21-138bcb2baa62",
    "account_opened_at": "2023-01-17T12:28:37",
    "account_branch": "0001",
    "account_type": "escrow",
    "account_number": "7336349",
    "person_type": "legal",
    "account_digit": "0"
  },
  "max_resolution_date": "2023-05-19T12:13:25",
  "claimant_bank_name": "QI SCD S.A.",
  "pix_key": {
    "pix_key_type": "cnpj",
    "pix_key_status": "pending_confirmation",
    "created_at": "2023-05-12T12:13:24",
    "updated_at": "2023-05-12T12:13:24",
    "account_key": "169010e3-6c1e-4521-9253-11cbbf36c59j",
    "pix_key": "12345678000190"
  },
  "donator_ispb": null,
  "external_key": null,
  "claim_request_key": "7f8b67d2-d8e4-4759-85eb-e4d0ac24708c",
  "claim_request_type": "portability",
  "client_role": "claimant",
  "confirmation_reason": null,
  "requester_key": "e151044c-44d0-48b3-9df1-0b9475077fe5",
  "claimant_bank_code": "329",
  "cancelled_by": null,
  "request_failure_reason": null,
  "donator": null,
  "account_key": "169010e3-6c1e-4521-9253-11cbbf36c59j"
}

STATUS

4XX

Response Body: Error

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

HTTP 代码	QI 代码 `code`	标题 `title`	描述（英文） `Description`	描述（葡萄牙语） `translation`
400	PIX000022	Pix key already registered	Pix key already registered for the account.	Chave pix já cadastrada para a conta.
400	PIX000014	Maximum Number of Pix Keys in Use	Maximum number of pix keys for account {account_key} has reached	A conta {account_key} já tem o número máximo de chaves pix.
400	PIX000003	Account is not Opened	Account {account_key} is not opened	Conta {account_key} não está aberta
400	PIX000053	Invalid Portability Request	Portability within same Financial Institution should follow key alteration flow instead	Não é possível realizar portabilidade dentro da própria instituição financeira. Proceder com o fluxo de alteração
403	PIX000054	Invalid Permission	Person 5dbd5598-6b42-4d80-8e5e-1c616cf8b9ab does not have administration roles for account 169010e3-6c1e-4521-9253-11cbbf36c59j.	Pessoa 5dbd5598-6b42-4d80-8e5e-1c616cf8b9ab não tem credencial de administrador para a conta 169010e3-6c1e-4521-9253-11cbbf36c59j.
404	PIX000017	Pix Key is Unregistered	Pix key 12345678000190 is not currently used.	A chave pix 12345678000190 não está sendo utilizada.
422	PIX000077	Error when querying pix key	Error when querying pix key 12345678000190	Erro ao consultar chave pix 12345678000190
400	PIX000028	Key Type not allowed for portability or claim	Only cpf, cnpj, email and phone_number key_types can be portabilized or claim. Received key_type: random_key	Somente os key_types cpf, cnpj, email e phone_number podem ser portabilizados ou reivindicados. key_type recebido: random_key
400	PIX000061	Invalid Document	Invalid document sent 12345678000190.	Documento enviado é inválido 12345678000190.
404	PIX000026	Account not found	Account not found for account_key: 6aaadfbc-76ba-45d2-bb21-138bcb2baa62	Conta não encontrada para account_key: 6aaadfbc-76ba-45d2-bb21-138bcb2baa62
404	PIX000027	Person not found	Person not found for person_key: {person_key}	Pessoa não encontrada para person_key: {person_key}
422	PIX000069	Pix Key inquiry timeout	Pix key inquiry timeout. Please try again.	Consulta de chave pix excedeu o tempo limite. Por favor tente novamente.
400	PIX000072	Pix Key Claim Non Finished	Pix key 12345678000190, already has a claim request non finished.	Chave pix 12345678000190, já possui um pedido de portabilidade não finalizado.

Request​

Body Params​

枚举值 pix_key_type​

Response​

Request

Body Params

枚举值 pix_key_type

Response