Query reversal pix qr code

Returns the reversal pix qr code previously generated for a credit operation that is being canceled. Use this endpoint after creating the reversal at /debt/reversal to retrieve the qr code data again (for example, to re-display it to the payer).

Request

ENDPOINT

/credit_operation/{credit_operation_key}/pix_qrcode

METHOD

GET

info

This request has no body. The credit_operation_key must be provided as a path parameter in the URL.

Response

STATUS

200

Response Body

{
  "amount": "2026.93",
  "copy_paste_pix": "00020126930014br.gov.bcb.pix2571qrcode-h.dev.qitech.app/bacen/cobv/dece8d3e-32ce-439e-8204000053039865802BR5925Joao61080150400062070503***63046ECD",
  "debt_key": "a1f3d9c0-8b7e-4c9f-9d1a-1234567890ab",
  "expiration_date": "2022-09-28",
  "payer_document_number": "000000000008",
  "payer_name": "Teste",
  "qr_code_key": "7c3e5b22-4d8e-4a6b-9f11-abcdef123456",
  "reversal_key": "f98a1b7c-5e3c-4e6f-8887-c7fedfa0d5b5",
  "status": "waiting_payment"
}

STATUS

404

Response Body — Credit Operation not found

{
  "data": "{\"title\": \"Not Found\", \"description\": \"Credit Operation not found\", \"translation\": \"Operação não encontrada\", \"extra_fields\": {}, \"code\": \"COP000027\"}"
}

Response Body — Reversal not found

{
  "data": "{\"title\": \"Not Found\", \"description\": \"Reversal not found.\", \"translation\": \"Estorno não encontrado.\", \"extra_fields\": {}, \"code\": \"COP000205\"}"
}

Definitions

Path parameters

Field	Type	Description
credit_operation_key *	string (uuid)	Unique key of the credit operation for which the reversal pix qr code was generated.

Response fields

Field	Type	Description
amount	string	Reversal pix qr code amount, in BRL.
copy_paste_pix	string	Pix copy-and-paste code to be used for payment.
debt_key	string (uuid)	Key of the credit operation (debt) associated with the reversal.
expiration_date	string (date)	Expiration date of the pix qr code, in YYYY-MM-DD format.
payer_document_number	string	Payer's CPF/CNPJ.
payer_name	string	Payer's name.
qr_code_key	string (uuid)	Unique key of the issued pix qr code.
reversal_key	string (uuid)	Unique key of the reversal associated with the pix qr code.
status	string	Current status of the pix qr code (e.g., waiting_payment).