跳转至

Qrcode

二维码汇款

HTTP请求

二维码汇款是PIX的一种跨银行转账交易的识别方式，可以24/7全天候从一个电子钱包向另一个电子钱包进行转移和付款。

POST /v1/payments/payouts/pix/qrcode

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Request Body
{
    "idempotencyKey": "qrCodeTest20220722_05",
    "qrCode": "18000110088.ojaisdhofa.leimen",
    "country": "BR",
    "currency": "BRL",
    "callbackUrl": "https://api.client.com/callback/",
    "subMerchantId": "UUID"
}
Content-Type: application/json
{
    "idempotencyKey": "qrCodeTest20220722_05",
    "statusCode": 200,
    "errorMsg": "",
    "transferStatus": "IN_PROGRESS",
    "transferStatusCode": 200,
    "transferErrorMsg": ""
}

HTTP Headers 字段说明

Key Value
Content-Type application/json
Authorization "bearer"+ "" + {{access_token}}
x-api-key {{api_key}}

Request Body 字段说明

参数 是否必填 类型 描述
idempotencyKey String 此参数用于幂等目的，交易的唯一标识ID 长度不大于128个字节。
country String 国家编码，如巴西BR
qrCode String 从PIX支付二维码中识别出来的字符串
currency String 汇款货币代码，长度为3个字节，BRL、USD
callbackUrl String 接收交易状态变更通知的地址，接收post请求
subMerchantId String 子商户ID。商户类型为PSP时必填。

Response Body 字段说明

参数 类型 描述
idempotencyKey String 交易的唯一标识ID
statusCode Integer 此次请求API状态代码，200代表API请求成功, 401 访问受限, 422 参数错误, 500 内部错误
errorMsg String 如果API请求失败，返回的错误信息
transferStatus String 此次交易的目前状态, 枚举值，"SETTLED", "IN_PROGRESS", "FAILED" 或者 "REJECTED"，交易状态应以transferStatus为准
transferStatusCode Integer 此次交易的状态码，交易异常码
transferErrorMsg String 此次交易失败原因
回到页面顶部