创建支付 / 二维码
创建 PIX 支付订单并获取二维码内容。
接口
POST/cashin/pix/create-qrcode认证
Merchant Credential。详见 认证。
请求头
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|---|
Content-Type | header | string | 是 | application/json | |
X-Nonce | header | string | 是 | a9f3c1d47e8b9a2c4d1f9e8a7b6c5d4e | |
X-Merchant-Id | header | string | 是 | 2492265300 | |
X-Timestamp | header | string | 是 | 1638123456 | |
Digest | header | string | 是 | SHA-256=Jr9cX0nM6yT7uF9GQ5G8ZC5M8vRZrQZP9+VbQ8Z8z0Q= | |
Authorization | header | string | 是 | Signature keyId="m123456",alg="ES256",headers="(request-target) x-timestamp x-nonce digest",signature="MEUCIQD8VxkzR7q5hF3k9dY0v6mKk7K0Nq9nYw+7Ck8LJr9mYAIgC5VQ7J0Z9YqL5F8Wc6E2Yw5qf1z8bYyYcR9kX8pY=" |
请求体
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
amount | number | 是 | 订单金额 — 单位：雷亚尔(BRL), 支持小数点后两位 (min=10; max=50000) |
mchOrderNo | string | 是 | 商户订单号 — 商户订单号 (maxLength=32; pattern=^[A-Za-z0-9|_|-]{1-32}) |
expireTime | integer | 否 | 过期时间戳，默认30分钟 |
payerName | string | 否 | 姓名 |
payerDocument | string | 否 | 税号 — 个人主体为CPF，公司主体为CNPJ。该字段必须真实有效 |
请求示例
json
{
"mchOrderNo": "order_1770134058",
"amount": 1,
"payerDocument": "47929001230",
"payerName": "Jon",
"expireTime": 1770134058
}响应
HTTP 200 — 成功
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
status | integer | 是 | 状态 |
msg | string|null | 是 | 信息 |
data | object|null | 是 | 数据 |
data 字段
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
applyTime | integer | 是 | 申请时间 — 秒级时间戳格式 |
amount | number | 是 | 订单金额 — 订单金额 |
mchOrderNo | string | 是 | 商户订单号 |
platOrderNo | string | 是 | 平台订单号 |
qrcode | string|null | 是 | 支付码 — 商户可以根据该值自己生成二维支付码 |
expireTime | integer|null | 是 | 过期时间 — 秒级时间戳格式 |
响应示例
json
{
"status": 200,
"msg": null,
"data": {
"mchOrderNo": "order_1662112944",
"platOrderNo": "P5nosqyWAQsQZNtYa5OW",
"applyTime": 1662112986,
"amount": 1200,
"qrcode": "00020101021226840023br.gov.bcb.pix2563qr.iugu.com/public/payload/v2/68A08B21C34E43B398137645AC2BF5E7520400015313986540520.005802BR5912AAAAABB LTDA6009SAO PAULO62070503***63046D60",
"expireTime": 1662199387
}
}