# 2、创建代付
# 代付订单-PIX
用于商户发起 PIX 代付请求,系统将执行向收款方账户的转账。
请求方式
Method:
POST
请求 URL
以下两个 URL 任意一个均可使用(功能一致):
/api/v3/bra/createTransferOrder
/api/v3/bra/pix/createTransferOrder
请求头 Header
Content-Type: application/json; charset=utf-8
请求头参数说明
参数名 | 类型 | 描述 | 示例值 |
---|---|---|---|
access_key | String | 商户后台获取的访问密钥 | pFqV75X3 |
timestamp | int64 | 13 位毫秒时间戳 | 1679724896223 |
nonce | String | UUID V4 随机字符串 | 794c26b0-d33c-4394-b2bb-c485eca16d9e |
sign | String | 计算生成的签名值 | kAXyh+eerqrefyaF8dyFB0M4FVo= |
所有参数需放入 Header 中发送,签名生成请参考数据签名规范。
请求示例:
{
"currencyAmount": "20.01",
"channelType": "PIX",
"externalOrderId": "871049832638078444",
"personIdType": "CPF",
"personId": "18171847084",
"personName": "bob",
"accountType": "CPF",
"accountId": "18171847684",
"remark": "123",
"notifyUrl": "http://192.168.1.135:30002/abc"
}
请求参数说明
建议:为提升代付处理效率,以下字段建议全部传入。
参数名 | 类型 | 是否必填 | 描述 |
---|---|---|---|
currencyAmount | String | 是 | 代付金额,保留小数点后不超过 2 位 |
channelType | String | 是 | 支付类型,枚举值:PIX |
externalOrderId | String(64) | 是 | 商户订单号 |
personIdType | String(64) | 是 | 用户证件类型:CPF, CNPJ 二选一 |
personId | String(64) | 是 | 用户证件号 |
personName | String(255) | 是 | 用户姓名 |
accountType | String | 是 | 收款账号类型,枚举值:CPF, CNPJ, PHONE, EMAIL, EVP 五选一 |
accountId | String | 是 | 收款账号,需与 accountType 匹配 |
remark | String(255) | 否 | 交易备注 |
notifyUrl | String | 否 | 异步通知回调地址(建议公网地址) |
响应示例
响应 Header 类型
Content-Type: application/json; charset=utf-8
响应数据(成功)
{
"code": "200",
"success": true,
"msg": "成功",
"msgEn": "SUCCESS",
"data": {
"currencyType": "BRL",
"externalOrderId": "472512322065926592",
"orderId": "OCURRDAW20230727035446169042954635BDOCKER020000002000000777",
"orderStatus": "Accepted"
}
}
响应字段说明
Param | Type | Desc |
---|---|---|
currencyType | String | 法币类型 |
externalOrderId | String | 商户订单 id |
orderId | String | 系统订单 ID |
orderStatus | String | 订单状态,正常返回“Accept”,后续通过查询/回调更新状态 |