Portability

Request

ENDPOINT

/baas/pix/key_claim_request/CLAIM_REQUEST_KEY/ CLAIM_ACTION

METHOD

PATCH

Path params

Field	Type	Description
claim_request_key	string	the key of the portability request.
claim_action	enum	Enumerators

Enumerators claim_action

Enumerator	Translation	Description
confirmed	confirmed	use this action to confirm the portability request.
cancelled	canceled	use this action to cancel the portability request.
pending_donator_validation	pending_donator_validation	use this action to receive two-factor authentication.

Warning

Before canceling a claim with "claim_request_type" as "ownership", it is necessary to perform the "pending_donator_validation" action to receive two-factor authentication and send it in the payload. The only accepted "cancelation_reason" for canceling claims of this type are "ownership" and "fraud".

Warning

After the cancellation action is executed, the claim request process is concluded, and there are no further hooks to be received.

Request Body

Confirmation

{
    "confirmation_reason": "client_request"
}

Cancellation

{
    "cancellation_reason": "client_request"
}

Ownership cancellation

{
    "cancellation_reason": "fraud",
    "verification_code": "432371"
}

Pending Donor Validation

{}

Body Params

Field	Type	Description	Characters
confirmation_reason	enum	Enumerators.	14
cancellation_reason	enum	Enumerators.	14
verification_code	string	token received on the phone number or email.	6

Enumerators confirmation_reason

Enumerator	Translation
client_request	client request

Enumerators cancellation_reason

Enumerator	Translation
client_request	client request
fraud	fraud

Warning

When canceling a portability request of type "ownership", the "cancellation_reason" must always be "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 Code	QI Code code	Title title	Description Description	Translation 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	Confirmation reason not allowed	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 not allowed	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.
404	PIX000034	Claim Request not found	Claim 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.	Có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.