Simular alteração de status de portabilidade

Request

ENDPOINT

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

MÉTODO

PATCH

Path params

Campo	Tipo	Descrição
claim_request_key	uuidv4	Chave única de identificação do pedido de portabilidade.
claim_action	string	Enumeradores

Enumeradores claim_action

Enumerador	Tradução	Descrição
failed	falhou	O pedido de portabilidade falhou
confirmed	confirmado	O pedido de portabilidade está confirmado, necessita de aprovação do banco doador para ser concluido ou de rejeição para ser cancelado
cancelled	cancelado	O pedido de portabilidade está cancelado, logo, para se realizar uma claim sobre está chave deve-se abrir um novo pedido de portabilidade
concluded	concluído	O pedido de portabilidade está concluído

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": {}
}

Código HTTP	Código QI code	Título title	Descrição (eng) Description	Descrição (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