Cancelar um Pedido de Portabilidade

info

Cancelamentos de Pedido de Portabilidade podem ser realizados com as seguintes condições:

Status deve ser waiting resolution.

Se razão de cancelamento for default, prazo definido pelo campo max_resolution_date deve ter passado.

A tabela abaixo define, a depender da razão, quem pode cancelar uma portabilidade.

Razão	Doador	Reivindicador
client_request	✓	✓
account_closure	✓
default		✓
fraud	✓	✓

Request

ENDPOINT

/account/ACCOUNT_KEY/alias/ALIAS_KEY/claim/CLAIM_REQUEST_KEY

MÉTODO

PATCH

Request Body

{
    "request_control_key": "8a923886-afce-4116-ac1f-69bdffcf8da9",
    "claim_request_status": "cancelled",
    "cancellation_reason": "client_request",
}

cancellation_reason	Descrição
client_request	O usuário reivindicador solicitou cancelamento do pedido de portabilidade
account_closure	A conta foi encerrada durante o processo de portabilidade
default	O prazo de validação de posse da chave do usuário reivindicador expirou
fraud	Houve fraude na abertura do pedido de portabilidade

Response

STATUS

200

Response Body

{
	"request_control_key": "95968498-5ad0-465a-9174-969d0bd1e84a",
	"claim_request_status": "cancelled",
    "created_at": "2024-05-25T12:13:25"
}

Value	Description	type
claim_request_status	Status do pedido de portabilidade.	string
created_at	Data de criação do pedido de portabilidade	datetime string
request_control_key	Identificador UUID4 único da request.	uuid4 string

claim_request_status	Descrição
waiting_resolution	A notificação foi recebida pela contraparte
confirmed	O doador confirmou a reivindicação. Está aguardando o reivindicador encerrar o processo.
cancelled	O doador ou reivindicador cancelou o pedido de portabilidade
completed	Tanto o DICT quanto o reivindicador atualizaram suas bases com o novo vínculo