参数名称 |
参数中文名称 |
类型& 长度 |
参数说明 |
是否必填 |
merchantId |
商户编号 |
varchar(9) |
商户在首信易系统的唯一id,可在商户后台查看 |
M |
orderAmount |
订单金额 |
varchar(18) |
单位:分,1元=100分 |
M |
orderCurrency |
订单币种 |
varchar(15) |
默认CNY(人民币) |
M |
requestId |
订单号 |
varchar(50) |
订单号为商户自行拟定,提交的订单号必须在自身平台交易中唯一。首信易支付系统已付或撤销的订单,商户平台不能以相同的订单号再次提交。 |
M |
partnerId |
服务商id |
varchar(9) |
服务商在首信易系统的唯一id,可在商户后台查看 |
C |
notifyUrl |
通知地址 |
varchar(200) |
服务器通知:当订单状态为终态后首信易服务器会向该地址发送通知,该地址可以带参数,如:http://www.5upay.com/callback.action?test=test。 |
M |
callbackUrl |
回调地址 |
varchar(200) |
页面回调:支付成功后会向该地址进行跳转,callbackUrl返回的参数只有:merchantId,requestId.
callbackUrl返回格式示例:
https://demo.5upay.com/sdk/callback?requestId=1446633831896&merchantId=890000593 |
M |
remark |
备注 |
varchar(300) |
商户在首信易为订单进行备注,通过支付结果返回商户 |
O |
paymentModeCode |
支付方式编码 |
varchar(50) |
WEBOX-APP_PAY-P2P 微包支付 |
C |
openId |
openId |
varchar(100) |
此参数传用户的钱包ID |
C |
productDetails |
商品信息 |
Json(数组) |
支付商品信息,见下表 |
M |
splitMark |
分账标识 |
固定值 |
DO_SPLIT 分账 |
C |
NOT_DO_SPLIT 不分帐 不传默认为不分帐 |
payer |
身份信息 |
Json |
此json可空,但不可将此参数整个去掉,可按以下格式传入接口: “payer”:{“idType“: ”IDCARD”},详见下表 |
M |
clientIp |
客户端IP |
varchar(100) |
传递客户端外网IP(需商户收集用户的ip) |
M |
timeout |
订单超时时间 |
Int(4) |
此参数用于设置订单的超时时间(需小于等于24小时),如:输入10,该订单将在10min后过期。应根据商户自身场景设置,分钟为单位 |
O |
reportSerialNo |
报备序列号 |
varchar(50) |
报备序列号(可咨询商务经理) |
C |
limitAccType |
限定账户类型 |
varchar(200) |
见下表,需要传多个枚举值时用半角 逗号“,”分隔 |
O |
subsidyMark |
补贴标识 |
固定值 |
DO_SUBSIDY 补贴 |
O |
NOT_DO_SUBSIDY 不补贴,默认为不补贴 |
subsidyAmount |
补贴金额 |
decimal(18) |
单位:分,1元=100分 |
O |
hmac |
参数签名 |
varchar(500) |
商户生成的参数签名结果,获取hmac的方法请参考请求加密流程 |
M |
参数名称 |
参数中文名称 |
参数说明 |
merchantId |
商户编号 |
同请求参数 |
requestId |
订单号 |
同请求参数 |
partnerId |
服务商Id |
同请求参数 |
status |
请求状态 |
SUCCESS 成功,请求已接收
|
FAILED 失败 |
ERROR 错误(此状态的返回参数见异常情况说明) |
REDIRECT 重定向 |
realBankRequestNumber |
银行订单号 |
银行订单号 |
payeeInfo |
收款人信息 |
当status为SUCCESS,此项只有在支付方式为线下银行汇款时返回见下表payeeInfo |
redirectUrl |
重定向地址 |
当status为REDIRECT时,用户重定向访问的地址 |
walletId |
钱包Id |
微包钱包id(微包扫码支付时返回此参数) |
scanCode |
Base64二维码 |
当status为SUCCESS,Base64格式的二维码,需商户转换成图片,此项为扫码直连返回的参数。 |
scanCodeUrl |
二维码链接 |
当status为SUCCESS,此项为扫码直连返回的参数 |
appParams |
App调用码 |
当status为SUCCESS,此项只有app支付才会返回,利用此项调用移动端sdk。 |
jsString |
微信调起支付数据签名字段 |
此json数据为微信返回,预下单成功后会返回此json,利用此项调用微信支付。 |
wechatId |
微信原始ID |
当status为REDIRECT,此项在小程序非直连支付方式情况下返回,利用此项原始APP可唤起小程序支付。注:走渠道小程序支付才会返回,下单时不用传APPID参数 |
tradeNo |
支付宝交易号 |
当status为SUCCESS,此项在支付宝小程序、生活号预下单成功以后会返回,使用此项调用支付宝支付 |
token |
微包支付调用token |
当status为SUCCESS,此项在微包支付、微包扫码付或微包服务号支付预下单成功以后会返回,使用此项调用微包支付或微包服务号支付 |
openLink |
openLink |
当status为REDIRECT,此项在微信小程序非直连支付方式且needOpenLink为1时返回,浏览器端的JavaScript通过执行location.href = openlink可唤起微信小程序支付 注:走渠道小程序支付才会返回,下单时不用传APPID参数 |
hmac |
参数签名 |
首信易生成的参数签名结果,验签过程请参考解密流程 |