方案适用场景:协同收银接口是pos收银的扩展辅助,提供商户通过系统对接的方式发起预授权完成,消费退货,扫码类撤销,扫码类退货。
预授权完成
生产环境地址:https://vsp.allinpay.com/apiweb/posol/authfin
测试环境地址:https://syb-test.allinpay.com/apiweb/posol/authfin
使用场景:线上进行消费预授权完成
请求参数:
参数 |
参数名称 |
取值 |
可空 |
最大长度 |
备注 |
---|---|---|---|---|---|
orgid |
集团商户号 |
平台分配的集团商户号 |
否 |
15 |
|
cusid |
商户号 |
实际交易的商户号 |
否 |
15 |
|
appid |
应用ID |
平台分配的APPID |
否 |
8 |
|
version |
版本号 |
接口版本号 |
可 |
2 |
默认填11 |
reqsn |
商户预授权完成交易流水号 |
商户预授权完成交易流水号,即本次请求流水 |
否 |
32 |
商户平台唯一 |
trxid |
交易单号 |
要预授权完成的收银宝平台交易订单号 |
否 |
32 |
|
trxamt |
交易金额 |
单位为分 |
否 |
16 |
|
randomstr |
随机字符串 |
商户自行生成的随机字符串 |
否 |
32 |
|
signtype |
签名类型 |
|
否 |
8 |
RSA |
sign |
签名 |
详见安全规范 |
否 |
32 |
|
响应参数:
字段ID |
字段名称 |
取值 |
可空 |
最大长度 |
备注 |
---|---|---|---|---|---|
retcode |
返回码 |
SUCCESS/FAIL
|
否 |
8 |
此字段是通信标识,非交易结果,交易是否成功需要查看trxstatus来判断 |
retmsg |
返回码说明 |
|
是 |
100 |
|
以下信息只有当retcode为SUCCESS时有返回 |
|||||
cusid |
商户号 |
平台分配的商户号 |
否 |
15 |
|
appid |
应用ID |
平台分配的APPID |
否 |
8 |
|
outtrxid |
交易单号 |
授权完成交易单号 |
否 |
20 |
本次授权完成交易的平台单号,可用于查询 |
fintime |
交易完成时间 |
yyyyMMddHHmmss |
是 |
14 |
|
trxstatus |
交易状态 |
交易的状态 |
否 |
4 |
见附录-交易返回码说明 |
errmsg |
错误原因 |
失败的原因说明 |
是 |
100 |
|
acct |
卡号 |
|
是 |
32 |
|
bankname |
发卡机构 |
|
是 |
100 |
|
aptcode |
收单机构 |
|
是 |
32 |
|
termauthno |
授权码 |
|
是 |
16 |
|
randomstr |
随机字符串 |
随机生成的字符串 |
否 |
32 |
|
sign |
签名 |
|
否 |
32 |
详见安全规范 |
交易退货
生产环境地址:https://vsp.allinpay.com/apiweb/posol/refund
测试环境地址:https://syb-test.allinpay.com/apiweb/posol/refund
使用场景:支持收银宝POS产品收单消费类交易退货,扫码类交易退货
请求参数:
参数 |
参数名称 |
取值 |
可空 |
最大长度 |
备注 |
---|---|---|---|---|---|
orgid |
集团商户号 |
平台分配的集团商户号 |
是 |
15 |
|
cusid |
商户号 |
实际交易的商户号 |
否 |
15 |
|
appid |
应用ID |
平台分配的APPID |
否 |
8 |
|
version |
版本号 |
接口版本号 |
可 |
2 |
默认填11 |
reqsn |
商户退货交易流水号 |
商户退货交易流水号,即本次请求流水 |
否 |
32 |
商户平台唯一 |
trxid |
交易单号 |
要退货的收银宝平台交易单号 |
否 |
32 |
|
trxamt |
退款金额 |
单位为分 |
否 |
16 |
|
remark |
交易备注 |
|
是 |
160 |
|
randomstr |
随机字符串 |
商户自行生成的随机字符串 |
否 |
32 |
|
signtype |
签名类型 |
|
否 |
8 |
RSA |
sign |
签名 |
详见安全规范 |
否 |
32 |
|
响应参数:
字段ID |
字段名称 |
取值 |
可空 |
最大长度 |
备注 |
---|---|---|---|---|---|
retcode |
返回码 |
SUCCESS/FAIL
|
否 |
8 |
此字段是通信标识,非交易结果,交易是否成功需要查看trxstatus来判断 |
retmsg |
返回码说明 |
|
是 |
100 |
|
以下信息只有当retcode为SUCCESS时有返回 |
|||||
cusid |
商户号 |
平台分配的商户号 |
否 |
15 |
|
appid |
应用ID |
平台分配的APPID |
否 |
8 |
|
outtrxid |
交易单号 |
本次退款平台交易单号 |
否 |
20 |
本次交易的平台单号,可用于查询 |
fintime |
交易完成时间 |
yyyyMMddHHmmss |
是 |
14 |
|
trxstatus |
交易状态 |
交易的状态 |
否 |
4 |
见附录-交易返回码说明 |
errmsg |
错误原因 |
失败的原因说明 |
是 |
100 |
|
randomstr |
随机字符串 |
随机生成的字符串 |
否 |
32 |
|
fee |
手续费 |
|
否 |
15 |
|
acctno |
卡号 |
|
是 |
32 |
仅限预授权完成退款,消费退款交易返回 |
bankname |
发卡机构 |
|
是 |
100 |
|
aptcode |
收单机构 |
|
是 |
32 |
|
authcode |
授权码 |
|
是 |
16 |
|
sign |
签名 |
|
否 |
32 |
详见安全规范 |
交易撤销
生产环境地址:https://vsp.allinpay.com/apiweb/posol/cancel
测试环境地址:https://syb-test.allinpay.com/apiweb/posol/cancel
使用场景:只支持扫码类及预授权交易的撤销,不支持银行卡消费交易的撤销
请求参数:
参数 |
参数名称 |
取值 |
可空 |
最大长度 |
备注 |
---|---|---|---|---|---|
orgid |
集团商户号 |
平台分配的集团商户号 |
是 |
15 |
|
cusid |
商户号 |
实际交易的商户号 |
否 |
15 |
|
appid |
应用ID |
平台分配的APPID |
否 |
8 |
|
version |
版本号 |
接口版本号 |
可 |
2 |
默认填11 |
reqsn |
商户撤销交易流水号 |
商户撤销交易流水号,即本次请求流水 |
否 |
32 |
商户平台唯一 |
trxid |
交易单号 |
要撤销的收银宝平台交易单号 |
否 |
32 |
|
trxamt |
撤销金额 |
单位为分 |
否 |
16 |
|
randomstr |
随机字符串 |
商户自行生成的随机字符串 |
否 |
32 |
|
signtype |
签名类型 |
|
否 |
8 |
MD5 |
sign |
签名 |
详见安全规范 |
否 |
32 |
|
响应参数:
字段ID |
字段名称 |
取值 |
可空 |
最大长度 |
备注 |
---|---|---|---|---|---|
retcode |
返回码 |
SUCCESS/FAIL
|
否 |
8 |
此字段是通信标识,非交易结果,交易是否成功需要查看trxstatus来判断 |
retmsg |
返回码说明 |
|
是 |
100 |
|
以下信息只有当retcode为SUCCESS时有返回 |
|||||
cusid |
商户号 |
平台分配的商户号 |
否 |
15 |
|
appid |
应用ID |
平台分配的APPID |
否 |
8 |
|
outtrxid |
交易单号 |
本次撤销平台交易单号 |
否 |
20 |
本次交易的平台单号,可用于查询 |
fintime |
交易完成时间 |
yyyyMMddHHmmss |
是 |
14 |
|
trxstatus |
交易状态 |
交易的状态 |
否 |
4 |
见附录-交易返回码说明 |
errmsg |
错误原因 |
失败的原因说明 |
是 |
100 |
|
randomstr |
随机字符串 |
随机生成的字符串 |
否 |
32 |
|
sign |
签名 |
|
否 |
32 |
详见安全规范 |
交易查询
生产环境地址:https://vsp.allinpay.com/apiweb/posol/query
测试环境地址:https://syb-test.allinpay.com//apiweb/posol/query
使用场景:
通过协同收银API发起的预授权完成、交易退货及交易撤销的交易查询。原交易优先使用平台单号.如果没有平台单号,再使用商户流水(reqsn)。
若查询POS终端发起的交易.原交易必须使用平台交易单号查询(trxid)。
注意:
1.如果同一个订单号发起了多笔交易,只返回最新的一笔
2.有些商户交易会用同一订单号发起多次交易,建议商户在同时获得orderid和trxid的情况下,请只用trxid进行查询,这样能确定唯一交易
3.验签要用返回的所有非空字段进行组装验签,这样才能很好的兼容以后收银宝增加字段的情况
请求参数:
参数 |
参数名称 |
取值 |
可空 |
最大长度 |
备注 |
---|---|---|---|---|---|
orgid |
集团商户号 |
平台分配的集团商户号 |
否 |
15 |
|
cusid |
商户号 |
平台分配的商户号 |
否 |
15 |
|
appid |
应用ID |
平台分配的集团商户APPID |
否 |
8 |
|
reqsn |
订单号 |
商户平台订单号,同接口reqsn |
可 |
32 |
|
trxid |
收银宝交易流水 |
收银宝平台交易流水 |
可 |
18 |
reqsn和trxid不能同时为空 |
randomstr |
随机字符串 |
商户自行生成的随机字符串 |
否 |
32 |
|
signtype |
签名类型 |
|
否 |
8 |
RSA |
sign |
签名 |
详见安全规范 |
否 |
32 |
|
响应参数:
字段ID |
字段名称 |
取值 |
可空 |
最大长度 |
备注 |
---|---|---|---|---|---|
retcode |
返回码 |
SUCCESS/FAIL
|
否 |
8 |
retcode=SUCCESS情况下,表示查询成功,交易状态按照trxstatus判断;retcode=FAIL表示接口拒绝交易,如验签失败/数据格式错误/数据字段缺失。 |
以下信息只有当retcode为SUCCESS时有返回 |
|||||
retmsg |
返回码说明 |
|
是 |
100 |
|
cusid |
商户号 |
平台分配的商户号 |
否 |
15 |
|
appid |
应用ID |
平台分配的APPID |
否 |
8 |
|
trxcode |
交易类型 |
|
否 |
8 |
详见附录 |
trxamt |
金额 |
单位:分 |
否 |
20 |
单位分 |
fee |
手续费 |
单位:分 |
否 |
20 |
单位分 |
trxstatus |
交易结果码 |
|
否 |
4 |
详见附录 |
errmsg |
交易错误信息 |
|
可 |
100 |
交易失败不为空 |
reqsn |
商户平台订单号
|
如:微信支付的商户交易单号 支付宝支付的商户交易单号 订单支付的商户订单号 |
否 |
32 |
如订单号,保单号,缴费编号等 |
trxid |
交易流水号 |
|
否 |
18 |
通联收银宝交易流水号 |
srctrxid |
原交易流水 |
|
可 |
18 |
通联收银宝原交易流水,冲正撤销退货交易本字段不为空 |
chnltrxid |
支付渠道流水号 |
如: 支付宝平台交易单号 微信平台交易单号
|
可 |
100 |
|
fintime |
交易完成时间 |
|
否 |
14 |
yyyymmddhhmmss |
termauthno |
授权码 |
|
是 |
16 |
授权码 |
randomstr |
随机字符串 |
|
否 |
32 |
主要用于加签 |
sign |
sign校验码 |
|
否 |
32 |
|
acct |
交易账号 |
|
否 |
32 |
|