接口地址:https://vsp.allinpay.com/apiweb/unitorder/scanqrpay
测试地址:https://syb-test.allinpay.com/apiweb/unitorder/scanqrpay
使用场景:扫一扫付款二维码,获取付款二维码内容调用此接口进行收款.支持微信,支付宝,数字人民币,银联规范付款二维码
当结果码为“2000”时,商户系统可设置间隔时间(建议10秒)重新查询支付结果,直到支付成功或超时(建议50秒)
请求参数:
参数 | 参数名称 | 取值 | 可空 | 最大长度 | 备注 |
---|---|---|---|---|---|
orgid | 集团/代理商商户号 | 是 | 15 | 共享集团号/代理商参数时必填 | |
cusid | 商户号 | 实际交易的商户号 | 否 | 15 | |
appid | 应用ID | 平台分配的APPID | 否 | 8 | |
version | 版本号 | 接口版本号 | 可 | 2 | 默认填11 |
randomstr | 随机字符串 | 商户自行生成的随机字符串 | 否 | 32 | |
trxamt | 交易金额 | 单位为分 | 否 | 15 | |
reqsn | 商户交易单号 | 商户的交易订单号 | 否 | 50 | 保证商户平台唯一 |
body | 订单标题 | 订单商品名称,为空则以商户名作为商品名称 | 是 | 100 | 最大100个字节(50个中文字符) |
remark | 备注 | 备注信息 | 是 | 160 | 禁止出现+,空格,/,?,%,#,&,=这几类特殊符号 |
authcode | 支付授权码 | 如微信,支付宝,银联的付款二维码 | 否 | 32 | |
limit_pay | 支付限制 | no_credit--指定不能使用信用卡支付 | 是 | 32 | 暂时只对微信支付和支付宝,支付宝支付有效,仅支持no_credit |
goods_tag | 订单优惠标记 |
订单优惠标记,用于区分订单是否可以享受优惠, 字段内容在微信后台配置券时进行设置,说明详见代金券或立减优惠 |
是 | 32 | 只对微信支付有效 |
benefitdetail | 优惠信息 |
Benefitdetail的json字符串,注意是String 填写格式详见附录5.8 |
是 | - |
微信单品优惠 支付宝智慧门店 银联云闪付单品优惠 |
sub_appid | 微信子appid | 微信小程序/微信公众号/APP的appid | 是 | 32 | 只对微信支付有效 |
chnlstoreid | 渠道门店编号 | 商户在支付渠道端的门店编号 |
例如 对于支付宝支付,支付宝门店编号 对于微信支付,微信门店编号 |
||
subbranch | 门店号 | 是 | 4 | ||
idno | 证件号 | 实名交易必填.填了此字段就会验证证件号和姓名 | 是 | 32 | 暂只支持支付宝 |
extendparams | 拓展参数 |
json字符串,注意是String 一般用于渠道的活动参数填写 |
是 | 参考5.9拓展参数附录说明 | |
truename | 付款人真实姓名 | 实名交易必填.填了此字段就会验证证件号和姓名 | 是 | 32 | 暂只支持支付宝 |
asinfo | 分账信息 |
格式: cusid:type:amount;cusid:type:amount 其中 cusid:接收分账的通联商户号 type分账类型(01:按金额 02:按比率) 如果分账类型为02,则分账比率为0.5表示50%。如果分账类型为01,则分账金额以元为单位表示 |
是 | 1024 | 开通此业务需开通分账配置 |
fqnum | 分期 |
3 花呗分期3期 6 花呗分期6期 12 花呗分期12期 24 花呗分期24期 3-cc 支付宝信用卡分期3期 6-cc 支付宝信用卡分期6期 12-cc 支付宝信用卡分期12期 24-cc 支付宝信用卡分期24期 3,1 花呗分期3期(商户贴息) 6,1 花呗分期6期(商户贴息) 12,1 花呗分期12期(商户贴息) 24,1 花呗分期24期(商户贴息) 3-cc,1 支付宝信用卡分期3期(商户贴息) 6-cc,1 支付宝信用卡分期6期(商户贴息) 12-cc,1 支付宝信用卡分期12期(商户贴息) 24-cc,1 支付宝信用卡分期24期(商户贴息) |
是 | 8 | 暂只支持支付宝花呗分期,支付宝信用卡分期 |
notify_url | 交易结果通知地址 |
接收交易结果的通知回调地址,通知url必须为直接可访问的url,不能携带参数。 https只支持默认端口 |
是 | 256 | 若使用https,需使用默认443端口 |
signtype | 签名方式 | 是 | 8 |
RSA SM2 |
|
unpid | 银联pid | 仅支持代理商/服务商角色调用 | |||
sign | 签名 | 详见安全规范 | 否 | 32 | |
terminfo | 终端信息 |
终端信息的json字符串 详见附录5.9终端字段说明 |
否 | 200 | |
operatorid | 收银员号 | 是 | 20 |
响应参数:
字段ID | 字段名称 | 取值 | 可空 | 最大长度 | 备注 |
---|---|---|---|---|---|
retcode | 返回码 | SUCCESS/FAIL | 否 | 8 | 此字段是通信标识,非交易结果,交易是否成功需要查看trxstatus来判断 |
retmsg | 返回码说明 | 是 | 100 | ||
以下信息只有当retcode为SUCCESS时有返回 | |||||
cusid | 商户号 | 平台分配的商户号 | 否 | 15 | |
appid | 应用ID | 平台分配的APPID | 否 | 8 | |
trxid | 交易单号 | 收银宝平台的交易流水号 | 否 | 20 | |
chnltrxid | 渠道平台交易单号 | 例如微信,支付宝平台的交易单号 | 是 | 50 | |
reqsn | 商户交易单号 | 商户的交易订单号 | 否 | 32 | |
trxstatus | 交易状态 |
交易的状态, 对于刷卡支付,该状态表示实际的支付结果,其他为下单状态 |
否 | 4 | 详见交易返回码说明 |
acct | 支付平台用户标识 |
微信支付-用户的微信openid 支付宝支付-用户user_id |
是 | 32 | 如果为空,则默认填000000 |
trxcode | 交易类型 | 交易类型 | 否 | 8 | 见交易类型 |
fintime | 交易完成时间 | yyyyMMddHHmmss | 是 | 14 | |
errmsg | 错误原因 | 失败的原因说明 | 是 | 100 | |
randomstr | 随机字符串 | 随机生成的字符串 | 否 | 32 | |
initamt | 原交易金额 | 是 | 15 | 与请求字段trxamt值一致 | |
trxamt | 实际交易金额 | 是 | 15 | 用于区分优惠活动的金额 | |
fee | 手续费 | 是 | 15 | 单位:分 | |
cmid | 渠道子商户号 | 是 | 32 | 限微信/支付宝交易响应 | |
chnlid | 渠道号 | 是 | 32 | 限微信交易响应 | |
chnldata | 渠道信息 | 目前返回云闪付/微信/支付宝的活动参数 | 是 | - | 限交易参与活动 |
bankcode | 发卡行号 | 是 | 8 |
|
|
accttype | 借贷标识 | 是 | 2 |
00-借记卡 02-信用卡 99-其他(花呗/余额等) |
|
tlopenid | 通联渠道侧OPENID | 是 | 32 |
|
|
sign | 签名 | 否 | 32 | 详见安全规范 |
备注:chnldata
云闪付示例:{"couponInfo":"[{"id":"2112020052715193","desc":"2020年银联62节-永旺超市蒙牛百利包单品营","type":"CP01","spnsrId":"00010000","offstAmt":"1100"},{"id":"2112020052715193","desc":"2020年银联62节-永旺超市蒙牛百利包单品营","type":"CP01","spnsrId":"82119105411XXXX","offstAmt":"900"}]"}
支付宝示例:{"voucher_detail_list":"[{"amount":"0.20","merchantContribute":"0.20","name":"0.20元代金券","otherContribute":"0.00","type":"ALIPAY_BIZ_VOUCHER","voucherId":"2020060400073002293805XTTADO"}]","fund_bill_list":"[{"amount":"0.80","fundChannel":"ALIPAYACCOUNT"},{"amount":"0.20","fundChannel":"MDISCOUNT"}]"}
微信示例: {"promotion_detail":"[{"amount":100,"merchant_contribute":"100","other_contribute":"0","promotion_id":"11605335223","type":"DISCOUNT","wxpay_contribute":"0","scope":"GLOBAL","activity_id":"10722272","name":"返回优惠信息券"}]"}