Skip to content

解析 PIX 二维码

解析 PIX 二维码内容。

接口

POST /cashin/pix/decode-qrcode

认证

Merchant Credential。详见 认证

请求头

名称位置类型必填说明示例
Content-Typeheaderstringapplication/json
X-Nonceheaderstringa9f3c1d47e8b9a2c4d1f9e8a7b6c5d4e
X-Merchant-Idheaderstring2492265300
X-Timestampheaderstring1638123456
DigestheaderstringSHA-256=Jr9cX0nM6yT7uF9GQ5G8ZC5M8vRZrQZP9+VbQ8Z8z0Q=
AuthorizationheaderstringSignature keyId="m123456",alg="ES256",headers="(request-target) x-timestamp x-nonce digest",signature="MEUCIQD8VxkzR7q5hF3k9dY0v6mKk7K0Nq9nYw+7Ck8LJr9mYAIgC5VQ7J0Z9YqL5F8Wc6E2Yw5qf1z8bYyYcR9kX8pY="

请求体

字段类型必填说明
qrcodestring商户订单号 — 二维码Code (maxLength=32; pattern=^[A-Za-z0-9|_|-]{1-32})

请求示例

json
{
  "qrcode": "00020101021226840023br.gov.bcb.pix2563qr.iugu.com/public/payload/v2/68A08B21C34E43B398137645AC2BF5E7520400015313986540520.005802BR5912AAAAABB LTDA6009SAO PAULO62070503***63046D60"
}

响应

HTTP 200 — 成功

字段类型必填说明
statusinteger
msgnull
dataobject

data 字段

字段类型必填说明
typestringQR类型 (enum=STATIC, DYNAMIC, DYNAMIC_IMMEDIATE)
amountnumber金额
allowsChangeAmountboolean是否允许修改金额
toPixstring收款Pix
toPixTypestring收款Pix类型
toIspbstring收款人PSP ISPB(8 位数字,以零填充)
toNamestring收款人/机构名称
toCpfCnpjstringCFP或者CNPJ
agencystring收款银行分行
toAccountstring账户

响应示例

json
{
  "status": 200,
  "msg": null,
  "data": {
    "type": "STATIC",
    "amount": 1200,
    "allowsChangeAmount": true,
    "toPix": "bd1e5560-2ff9-4a82-82b8-000000000000",
    "toPixType": "EVP",
    "agency": "0001",
    "toAccount": "123456",
    "toIspb": "22896431",
    "toName": "SEBASTIAO CONCEICAO SANTOS",
    "toCpfCnpj": "473******53"
  }
}