跳到主要内容

查询退款 pix qr code

返回为处于取消流程中的信贷业务先前生成的退款 pix qr code。请在 /debt/reversal 创建退款后使用此接口,重新获取 qr code 数据(例如,用于再次向付款人展示)。

请求​

ENDPOINT
/credit_operation/{credit_operation_key}/pix_qrcode
MÉTODO
GET
信息

此请求没有请求体。必须将 credit_operation_key 作为 URL 中的路径参数传入。

响应​

STATUS
200
响应体
{
  "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
响应体 — 未找到信贷业务
{
  "data": "{\"title\": \"Not Found\", \"description\": \"Credit Operation not found\", \"translation\": \"Operação não encontrada\", \"extra_fields\": {}, \"code\": \"COP000027\"}"
}
响应体 — 未找到退款
{
  "data": "{\"title\": \"Not Found\", \"description\": \"Reversal not found.\", \"translation\": \"Estorno não encontrado.\", \"extra_fields\": {}, \"code\": \"COP000205\"}"
}

字段定义​

路径参数​

字段类型描述
credit_operation_key *string (uuid)为其生成退款 pix qr code 的信贷业务的唯一标识。

响应字段​

字段类型描述
amountstring退款 pix qr code 的金额(单位:雷亚尔)。
copy_paste_pixstring用于支付的 pix 复制粘贴码。
debt_keystring (uuid)与退款关联的信贷业务(债务)标识。
expiration_datestring (date)pix qr code 的过期日期,格式为 YYYY-MM-DD。
payer_document_numberstring付款人的 CPF/CNPJ。
payer_namestring付款人姓名。
qr_code_keystring (uuid)已发行 pix qr code 的唯一标识。
reversal_keystring (uuid)与该 pix qr code 关联的退款的唯一标识。
statusstringpix qr code 的当前状态(例如 waiting_payment)。