Cancelar Reivindicação

Esse endpoint tem como finalidade cancelar o processo de reivindicação.

POST /api/v1/pix/:account_id/entry_claims/cancel

x-stone-idempotency-key string
Chave de idempotência

claim_id String (obrigatório)
Identificador da reivindicação.

reason String (obrigatório)
Valores permitidos: user_requested

direction string
Valores permitidos: outbound, inbound

participant_ispb string (obrigatório)
Identificador da instituição.

Exemplo:

{
  "claim_id": "390d7eda-e948-4552-bcdf-886c62e5923b",
  "reason": "user_requested",
  "direction": "outbound",
  "participant_ispb": "16501555"
}

202 Accepted

Pedido de cancelamento realizado com sucesso.
Body

{  
  "pix_entry_claim": "390d7eda-e948-4552-bcdf-886c62e5923b",
  "claim_type": "ownership" | "portability"
}

401 Unauthenticated

Usuário não está autenticado.
Body

{  
    "type": "srn:error:unauthenticated"
}

403 Forbidden

Usuário não autorizado a realizar a ação.
Body

{  
     "type": "srn:error:unauthorized"
}

422 Unprocessable Entity

Reivindicação á foi cancelada ou confirmada.
Body

{  
    "type": "srn:error:already_cancelled" | "srn:error:already_confirmed"
}

Última modificação: 21.11.2022