Simulate portability status change

Request

ENDPOINT

/mock/pix_keys/key_claim_simulation/CLAIM_REQUEST_KEY /receive_response/CLAIM_ACTION

METHOD

PATCH

Path params

Field	Type	Description
claim_request_key	uuidv4	Unique identification key for the portability request.
claim_action	string	Enumerators

Enumerators claim_action

Enumerator	Translation	Description
failed	failed	The portability request failed
confirmed	confirmed	The portability request is confirmed, requires approval from the donor bank to be completed or rejection to be cancelled
cancelled	cancelled	The portability request is cancelled, therefore, to make a claim on this key, a new portability request must be opened
concluded	concluded	The portability request is concluded

Request Body

{}

Response

STATUS

204

Response Body

{}

STATUS

4XX

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

HTTP Code	QI Code code	Title title	Description (eng) Description	Description (ptbr) translation
404	PIX000034	Claim Request not found	Claim Request not found. claim_request_key: claim_request_key external_key: external_key.	Claim Request não encontrada. claim_request_key: claim_request_key external_key: external_key.
400	PIX000035	Claim request action not allowed for donator	Claim request action not allowed for donator. Only claimant can perform this action	Ação sobre claim request não permitida para doador. Somente o reinvidicador pode executar esta ação