Portabilidade

Request

ENDPOINT

/baas/pix/key_claim_request/CLAIM_REQUEST_KEY/ CLAIM_ACTION

MÉTODO

PATCH

Path params

Campo	Tipo	Descrição
claim_request_key	string	a chave do pedido de portabilidade.
claim_action	enum	Enumeradores

Enumeradores claim_action

Enumerador	Tradução	Descrição
confirmed	confirmado	use essa action para confirmar o pedido de portabilidade
cancelled	cancelado	use essa action para cancelar o pedido de portabilidade
pending_donator_validation	pending_donator_validation	use essa auction para receber a autenticaçã de dois fatores

Atenção

Antes de cancelar uma claim que o "claim_request_type" seja "ownership" é necessário realizar a action "pending_donator_validation" para receber a autenticação de dois fatores e realizar o envio no payload. A única "cancelation_reason" aceita para cancelamento de claims desse tipo são "ownership" e "fraud".

Atenção

Após a action de cancelamento ser executada o processo de claim request chegou ao final e não existem hooks para serem recebidos.

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

Campo	Tipo	Descrição	Caracteres
confirmation_reason	enum	Enumeradores.	14
cancellation_reason	enum	Enumeradores.	14
verification_code	string	token recebido no número de telefone ou e-mail.	6

Enumeradores confirmation_reason

Enumerador	Tradução
client_request	pedido do clitente

Enumeradores cancellation_reason

Enumerador	Tradução
client_request	pedido do clitente
fraud	fraude

Atenção

Ao cancelar um pedido de portabilidade do tipo "ownership" o "cancelation_reason" sempre deve ser "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"
}

Código HTTP	Código QI code	Título title	Descrição (eng) Description	Descrição (ptbr) 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	Razão da confirmação não permitida	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	Razão do cancelamento não permitida	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	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.