Payment Instrument Cancellation

Payment instrument cancellation allows you to cancel an existing payment instrument, changing its status to canceled and canceling the associated postpaid card.

Request

ENDPOINT

/wallet/WALLET_KEY/payment_instrument/PAYMENT_INSTRUMENT_KEY/cancel

METHOD

PATCH

Path Parameters

Field	Type	Description	Characters
wallet_key *	uuidv4	Unique wallet key in UUID v4 format	36
payment_instrument_key *	uuidv4	Unique payment instrument key in UUID v4 format	36

Note

This request does not have a request body. Cancellation is performed only through path parameters.

Response

STATUS

200

Response Body: Canceled payment instrument

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

Response Body Params

Field	Type	Description	Characters
payment_instrument_key *	uuidv4	Unique identification key of the canceled instrument in UUID v4 format	36
payment_instrument_status *	string	Instrument status after cancellation	payment_instrument_status Enumerators

payment_instrument_status Enumerators

Enumerator	Description
canceled	Canceled instrument

Behavior

• The payment instrument will be moved to canceled status after cancellation
• The postpaid card associated with the instrument will also be canceled automatically
• The canceled instrument cannot be used for new transactions
• The canceled instrument can still be queried and listed, but will appear with canceled status

Error Response

STATUS

4xx

Response Body: Error

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

HTTP Code status	QI Code code	Title title	Description (eng) description	Description (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