Forgedocs

通过二维码发送 PIX 付款(Cash-Out QR Code)

POST /api/pix/cash-out-qrcode

通过扫描或复制的二维码(复制粘贴)发送 PIX 付款。二维码必须符合中央银行 EMV PIX 标准。

认证

需要在 Authorization 头中提供 Bearer 令牌。

请求体

字段类型必填描述
valuenumber付款金额(巴西雷亚尔,最多 2 位小数)。如果二维码中包含金额,必须与之匹配
qrCodestringPIX 二维码内容(EMV 字符串)。最少 50 个字符,最多 500 个字符。必须以 000201 开头
externalIdstring交易的唯一外部标识符
descriptionstring可选的付款描述
namestring收款人姓名(可能包含在二维码中)
documentstring收款人 CPF 或 CNPJ(可能包含在二维码中)
{
  "value": 15.50,
  "qrCode": "00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890520400005303986540515.505802BR5925DESTINATARIO LTDA6009SAO PAULO62070503***6304ABCD",
  "externalId": "QRPAY-987654-20240119",
  "description": "Pagamento fornecedor XYZ via QR Code",
  "name": "Destinatário Ltda",
  "document": "12345678000190"
}

响应 (201)

字段类型描述
transactionIdstring生成的交易内部标识符
externalIdstring请求中提供的外部标识符
statusstring当前交易状态(PENDINGCONFIRMEDERROR
generateTimestring交易生成日期/时间(ISO 8601)
{
  "transactionId": "456",
  "externalId": "QRPAY-987654-20240119",
  "status": "PENDING",
  "generateTime": "2024-01-19T14:30:00.000Z"
}

错误

状态码描述
400数据无效、二维码无效、金额不匹配或余额不足
401令牌缺失或无效
409externalId 已在其他交易中使用
500通过二维码处理 PIX 付款时出错

本页目录