Cancelamento de Instrumento de Pagamento

O cancelamento de instrumento de pagamento permite cancelar um instrumento de pagamento existente, alterando seu status para canceled e cancelando o cartão pós-pago associado.

Request

ENDPOINT

/wallet/WALLET_KEY/payment_instrument/PAYMENT_INSTRUMENT_KEY/cancel

MÉTODO

PATCH

Path Parameters

Campo	Tipo	Descrição	Caracteres
wallet_key *	uuidv4	Chave única da carteira no formato UUID v4	36
payment_instrument_key *	uuidv4	Chave única do instrumento de pagamento no formato UUID v4	36

Observação

Esta requisição não possui request body. O cancelamento é realizado apenas através dos path parameters.

Response

STATUS

200

Response Body: Instrumento de pagamento cancelado

{
  "payment_instrument_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "payment_instrument_status": "canceled"
}

Response Body Params

Campo	Tipo	Descrição	Caracteres
payment_instrument_key *	uuidv4	Chave única de identificação do instrumento cancelado no formato UUID v4	36
payment_instrument_status *	string	Status do instrumento após o cancelamento	Enumeradores payment_instrument_status

Enumeradores payment_instrument_status

Enumerador	Descrição
canceled	Instrumento cancelado

Comportamento

• O instrumento de pagamento será movido para o status canceled após o cancelamento
• O cartão pós-pago associado ao instrumento também será cancelado automaticamente
• O instrumento cancelado não poderá ser utilizado para novas transações
• O instrumento cancelado ainda poderá ser consultado e listado, mas aparecerá com status canceled

Error Response

STATUS

4xx

Response Body: Error

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

Código HTTP status	Código QI code	Título title	Descrição (eng) description	Descrição (pt-br) translation
400	CIN000081	Bad Request	Payment instrument is not active	Instrumento de pagamento não está ativo
400	CIN000100	Bad Request	Error canceling card in card service	Erro ao cancelar cartão no serviço de cartões
404	CIN000007	Wallet not Found	Wallet with key: abeca0d0-a09d-4b3b-a495-40b553422ced was not found	Carteira com a chave: abeca0d0-a09d-4b3b-a495-40b553422ced não foi encontrado
404	CIN000080	Payment Instrument Not Found	Payment instrument was not found	Instrumento de pagamento não foi encontrado