查询 PIX QR 码

可以通过创建时生成的 qr_code_key 查询某个 Alias 的特定 QR 码。此端点将返回该 QR 码的所有信息，如状态、支付情况、事件等。

请求

ENDPOINT

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

MÉTODO

GET

响应

STATUS

200 Ok

响应体：通用

{
  "request_control_key": "037b46b1-0c67-4c0d-aac3-1e395dfdcb10",
  "pix_key": "3d7d6a2b-f72f-44z7-bb20-79a94dff5645",
  "receiver_conciliation_id": "01GVGV9NXBCY287Z6CJ4S0ENW9",
  "qr_code_key": "d74bf12a-9243-4bfa-9b00-6b63755b6555",
  "qr_code_status": "active",
  "qr_code_type": "dynamic_instant",
  "amount": 22.34,
  "expiration_seconds": 864000,
  "expiration_date": null,
  "max_payment_days": null,
  "payer_name": "João da Silva",
  "payer_document_number": "00000000000000",
  "payer_person_type": "legal",
  "payer_request": "Payment for order XXXXXXXXXXXX",
  "rebate_amount": 1,
  "interest_amount": 2,
  "fine_amount": 3,
  "discounts": [],
  "additional_data": [
    {
      "key_name": "Juros e Multa",
      "value": "Juros 2 ao mes e multa de 1%"
    }
  ],
  "pix_transfer_key": null,
  "paid_amount": null,
  "base_64_payload": "<BASE64 DA URI DO PIX COPIA E COLA>",
  "qr_code_events": [
    {
      "request_control_key": "037b46b1-0c67-4c0d-aac3-1e395dfdcb10",
      "event_type": "registration",
      "created_at": "2023-03-03T12:04:06.179Z"
    },
    {
      "request_control_key": "cae915c8-1940-43ec-890b-ba1a3a66354c",
      "event_type": "payment",
      "created_at": "2023-03-03T12:04:06.179Z"
    }
  ],
  "created_at": "2023-03-03T12:04:06.179Z"
}

字段	类型	描述	字符数
request_control_key *	string	生成该 QR 码的请求的唯一 UUID4 标识符。	-
pix_key *	string	代表交易目标账户的 PIX 密钥。	-
receiver_conciliation_id *	string	支付后用于对账的 QR 码标识符。	-
qr_code_key *	string	QR 码的 UUID4 标识密钥。	-
qr_code_status *	string	QR 码状态。	-
qr_code_type *	string	QR 码类型。	"dynamic_term" 或 "dynamic_instant"
amount *	float	QR 码在计算折扣或利息罚款前的金额。	-
expiration_seconds	string	QR 码的有效时间（秒），默认 1 天。	-
expiration_date	date	账单到期日（格式 "YYYY-MM-DD"）。	-
max_payment_days	int32	到期后的最长付款天数。	-
payer_name *	string	付款方姓名。	-
payer_document_number *	string	付款方 CPF/CNPJ。	-
payer_request *	string	给付款方的消息。	-
rebate_amount	float	支付前的绝对折扣金额。	-
interest_amount	float	到期后每天逾期的绝对利息金额，若在到期后一天支付，总金额为原始金额加罚款。	-
fine_amount	float	到期后的绝对罚款金额。	-
discounts	array of objects	折扣配置。	-
additional_data	array of objects	将展示给付款方的信息。	-
pix_transfer_key	string	与 QR 码清算对应的 PIX 交易 UUID4 标识密钥。	-
paid_amount	float	考虑罚款、折扣等后的实际支付金额。	-
base_64_payload	string	Base64 格式的 QR 码支付 URL。	-
qr_code_events	array of objects	QR 码经历的状态变更列表。	-
created_at	datetime	QR 码在系统中的创建日期和时间。	-

qr_code_status 对象

字段	类型	描述	字符数
active	string	QR 码处于活跃状态，可用于支付。	-
finished	string	QR 码已支付。	-
written_off	string	QR 码已被客户撤销。	-
bank_written_off	string	QR 码因期限过期被自动撤销。	-

discount 对象

字段	类型	描述	字符数
discount_value *	float	折扣金额。	-
discount_number	int32	折扣应用的顺序。	-
discount_limit_date	string	折扣截止日期。	-

additional_data 对象

字段	类型	描述	字符数
key_name *	string	字段名称。	-
value	string	字段值。	-

qr_code_events 对象

字段	类型	描述	字符数
request_control_key *	string	生成该事件的请求的唯一 UUID4 标识符。	-
event_type *	string	事件类型。	"registration"、"write_off"、"payment"
created_at *	datetime	事件创建的日期和时间。	-

STATUS

400

响应体

{
    "title": "Bad Request",
    "description": "Invalid payload for QR Code creation.",
    "translation": "Payload inválido para a criação de QR Code.",
    "code": "QRI000003"
}

STATUS

404

响应体：未找到 QR 码密钥

{
    "title": "Not found",
    "description": "No Pix QR Code found for qr_code_key {qr_code_key}.",
    "translation": "Não foi encontrado nenhum QR Code com a qr_code_key {qr_code_key}.",
    "code": "QRI000005"
}