Update/Deactivate a PIX QR Code

Only dynamic-type PIX QR Codes can be updated. Upon updating, identified by the qr_code_key generated when creating the QR Code, it becomes invalid for subsequent payments. There are several reasons to request an update of a PIX QR Code, but in the internal system, the deactivation can be performed by a request from the alias (write_off).

Request

ENDPOINT

/account/ACCOUNT_KEY/alias/ALIAS_KEY/qrcode/QR_CODE_KEY

METHOD

PATCH

Request Body: Write off QR Code

{
  "request_control_key": "76d4506d-31a4-48db-bc71-61068b138ffd",
  "qr_code_status": "written_off",
}

Field	Type	Description	Characters
request_control_key *	string	Unique UUID4 identifier of the request.	-
qr_code_status *	string	QR Code status	-

Object qr_code_status

Field	Type	Description	Characters
active	string	QR Code is active and available for payment.	-
finished	string	QR Code has been paid.	-
written_off	string	QR Code has been canceled by the client.	-
bank_written_off	string	QR Code was automatically canceled due to expiration.	-

Response

STATUS

204 No content

Response Body

{}

STATUS

404

Response Body

{
    "title": "Not found",
    "description": "Could not find the queried QR Code.",
    "translation": "Não possível encontrar o QR Code buscado.",
    "code": "QRI000002"
}