Cancel a Portability Request

info

Portability Request cancellations can be made under the following conditions: Status must be waiting resolution. If the cancellation reason is default, the deadline defined by the max_resolution_date field must have passed.

The table below defines, depending on the reason, who can cancel a portability.

Reason	Donor	Claimer
client_request	✓	✓
account_closure	✓
default		✓
fraud	✓	✓

Request

ENDPOINT

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

METHOD

PATCH

Request Body

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

cancellation_reason	Description
client_request	The claimer user requested the cancellation of the portability request
account_closure	The account was closed during the portability process
default	The validation period for the claimer's key ownership expired
fraud	There was fraud in the opening of the portability request

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 of the portability request.	string
created_at	Date of creation of the portability request.	datetime string
request_control_key	Unique UUID4 identifier of the request.	uuid4 string

claim_request_status

Value	Description
waiting_resolution	The notification was received by the counterparty
confirmed	The donor confirmed the claim. It is waiting for the claimer to complete the process.
cancelled	The donor or claimer canceled the portability request
completed	Both the DICT and the claimer updated their records with the new linkage