可携性

Request

ENDPOINT

/baas/pix/key_claim_request/CLAIM_REQUEST_KEY/ CLAIM_ACTION

MÉTODO

PATCH

Path params

字段	类型	描述
`claim_request_key`	string	可携性申请密钥。
`claim_action`	enum	枚举值

枚举值 claim_action

枚举值	说明	描述
confirmed	已确认	使用此操作确认可携性申请
cancelled	已取消	使用此操作取消可携性申请
pending_donator_validation	pending_donator_validation	使用此操作接收双因素认证

注意

在取消"claim_request_type"为"ownership"的申请之前，需要执行"pending_donator_validation"操作以接收双因素认证并在载荷中提交。此类申请取消时唯一接受的"cancelation_reason"是"ownership"和"fraud"。

注意

执行取消操作后，申请流程结束，不会再有 webhooks 接收。

Request Body

Confirmação
{
    "confirmation_reason": "client_request"
}

Cancelamento
{
    "cancellation_reason": "client_request"
}

Cancelamento de ownership
{
    "cancellation_reason": "fraud",
    "verification_code": "432371"
}

Pendente de validação do doador
{}

Body Params

字段	类型	描述	字符数
`confirmation_reason`	enum	枚举值。	14
`cancellation_reason`	enum	枚举值。	14
`verification_code`	string	在手机号或电子邮件中收到的令牌。	6

枚举值 confirmation_reason

枚举值	说明
client_request	客户申请

枚举值 cancellation_reason

枚举值	说明
client_request	客户申请
fraud	欺诈

注意

取消"ownership"类型的可携性申请时，"cancelation_reason"必须始终为"fraud"。

Response

STATUS

200

Response Body

{
    "max_conclusion_date": "2023-05-26T12:13:25",
    "claim_request_status": "confirmed",
    "claimant": {
        "document_number": "12345678000190",
        "claimant_key": "6aaadfbc-76ba-45d2-bb21-138bcb2baa62",
        "account_opened_at": "2023-01-17T12:28:37",
        "account_branch": "0001",
        "account_type": "checking",
        "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": "active",
        "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"
}

HTTP 代码	QI 代码 `code`	标题 `title`	描述（英文） `Description`	描述（葡萄牙语） `translation`
400	PIX000043	Claim request action not allowed on current status	confirmed Claim request action only allowed for pending_confirmation requests	Ação confirmed para claim request permitida somente para pedidos com status pending_confirmation.
400	PIX000036	Claim request action not allowed for claimant	Claim request action not allowed for claimant. Only donator can perform this action	Ação sobre claim request não permitida para reivindicador. Somente o doador pode executar esta ação
400	PIX000044	Claim request confirm action without reason	confirmation_reason is required on action confirmed	confirmation_reason é obrigatório na ação confirmed
400	PIX000045	确认理由不允许	cancellation_reason: invalid not allowed for client_role: donator and claim_request_type: portability	cancellation_reason: invalid não permitida para client_role: donator and claim_request_type: portability
400	PIX000039	Claim request action not allowed on current status	Cancelled Claim request action only allowed for non concluded requests	Ação cancelled para claim request permitida somente para pedidos com status diferente de concluded
400	PIX000040	Claim request cancel action without reason	cancellation_reason is required on action cancelled	cancellation_reason é obrigatório na ação cancelled
400	PIX000042	取消理由不允许	cancellation_reason: client_request not allowed for client_role: donator and claim_request_type: ownership	cancellation_reason: client_request não permitida para client_role: donator and claim_request_type: ownership
400	PIX000051	Verification code required	2FA verification code required.	Código de verificação 2FA necessário.
400	PIX000100	External Claim Already Cancelled	The external claim request has already been cancelled	O pedido de portabilidade externo já foi cancelado
404	PIX000034	Claim Request not found	IClaim Request not found. claim_request_key: 7f8b67d2-d8e4-4759-85eb-e4d0ac24708c external_key: b8e25f24-4051-4b13-90a7-76be7b6e96d2.	Claim Request não encontrada. claim_request_key: 7f8b67d2-d8e4-4759-85eb-e4d0ac24708c external_key: b8e25f24-4051-4b13-90a7-76be7b6e96d2.
401	2FA000401	Unauthorized	Invalid verification combination.	CCódigo de verificação inválido.
403	2FA000403	Forbidden	Code already verified.	Este código já foi utilizado.
410	2FA000410	Gone	Expired Code.	Código de verificação expirado.

Request​

Path params​

枚举值 claim_action​

Body Params​

枚举值 confirmation_reason​

枚举值 cancellation_reason​

Response​