Consulta de pix qr code de devolução

Retorna o pix qr code de devolução previamente gerado para uma operação de crédito em processo de desistência. Utilize este endpoint após criar o estorno em /debt/reversal para reobter os dados do qr code (por exemplo, para reexibi-los ao pagador).

Request

ENDPOINT

/credit_operation/{credit_operation_key}/pix_qrcode

MÉTODO

GET

informação

Esta requisição não possui corpo. A credit_operation_key deve ser informada como parâmetro de caminho na 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 — Operação não encontrada

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

Response Body — Estorno não encontrado

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

Definições

Parâmetros de caminho

Campo	Tipo	Descrição
credit_operation_key *	string (uuid)	Chave única da operação de crédito para a qual o pix qr code de devolução foi gerado.

Campos da resposta

Campo	Tipo	Descrição
amount	string	Valor do pix qr code de devolução, em reais.
copy_paste_pix	string	Código pix copia-e-cola gerado para o pagamento.
debt_key	string (uuid)	Chave da operação de crédito (dívida) associada ao estorno.
expiration_date	string (date)	Data de expiração do pix qr code, no formato YYYY-MM-DD.
payer_document_number	string	CPF/CNPJ do pagador.
payer_name	string	Nome do pagador.
qr_code_key	string (uuid)	Chave única do pix qr code emitido.
reversal_key	string (uuid)	Chave única do estorno associado ao pix qr code.
status	string	Status atual do pix qr code (por exemplo, waiting_payment).