跳转到内容

创建代收

请求地址

methodurl
POST/api/pay/payment/create/v1

头部信息(header)

header 参数入参参数描述
timestamp请求时间戳
nonce随机值
countryBR
app_codeapp 编号

支持支付方式列表(paymentType)

支付方式名称PaymentType (入参参数)
PIX(线上银行转账)401

additionalInfo (附加字段)字段说明

字段名类型是否必传说明
----

请求参数

字段类型必需长度描述
merchantOrderNoStringyes32商户订单号
paymentTypeIntyes支付方式: 401-PIX
amountStringyes20代收金额(雷亚尔),小数点不能超过2位
expirationTimeLongno过期时间,毫秒级时间戳 eg:1735660800000
realNameStringno64用户姓名
emailStringno50用户邮箱:满足正则表达式即可
phoneStringno50电话号码
idCardNumberStringno50身份证号码
signStringyes签名
callbackUrlStringno200回调地址
{
"merchantOrderNo": "C27412415HkF6U9SnXRrxitBWD647lw7",
"realName": "aaaaaa",
"amount": "100.1",
"callbackUrl": "http://test.domin.com",
"paymentType": 401,
"email": "1QWWQWQ2891@qq.com",
"phone": "123456789",
"idCardNumber": "1234567890",
"sign": "YOUR SIGN",
"expirationTime": 1717092000000
}

返回参数

字段类型必需长度描述
merchantOrderNoStringyes32商户订单号
tradeNoStringyes32平台订单号
amountStringyes32交易金额
paymentTypeIntyes3支付方式
paymentInfoStringyes32主要付款信息,返回的是实际用于付款的信息,例如:付款编号
additionalInfoJSONObjectno扩展信息
statusIntyes代收状态, 1:成功 3:失败
errorMsgStringno错误信息,失败时返回
{
"msg": "success",
"code": 200,
"data": {
"amount": "100",
"tradeNo": "TS2405220001MX0000048362685411",
"merchantOrderNo": "C31412415HkF6U9SnXRrxitBWD647lw7",
"paymentType": 204,
"additionalInfo": {},
"paymentInfo": "Xsdsadsadsad.com",
"status": 1
},
"success": true
}