接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/apiweb/tranx/query
测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/apiweb/tranx/query
ISV接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/apiweb/isv/query
ISV测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/apiweb/isv/query
使用场景:该接口提供交易查询,商户可以通过查询接口主动查询订单状态,完成下一步的业务逻辑。
需要调用查询接口的情况:
- ◆ 当商户后台、网络、服务器等出现异常,商户系统最终未接收到支付通知;
- ◆ 调用支付接口后,返回系统错误或未知交易状态情况;
- ◆ 调用统一被扫接口后,返回交易状态码trxstatus为2000时;
- ◆ 调用关单或撤销接口API之前,需确认支付状态;
备注:如果撤销交易异常,请查询原支付订单状态
请求参数
字段ID |
字段名称 |
取值 |
可空 |
最大长度 |
备注 |
appid |
应用ID |
平台分配的APPID |
否 |
20 |
|
orgid |
机构ID |
实际交易的机构ID |
是 |
11 |
服务商appid调用时必填 |
cusid |
商户号 |
实际交易的店铺ID |
否 |
11 |
|
version |
版本号 |
接口版本号 |
是 |
2 |
默认填11 |
reqsn |
商户订单号 |
商户的交易订单号 |
是 |
64(isv:25) |
|
trxid |
平台交易流水 |
支付的收银宝平台流水 |
是 |
20 |
reqsn和trxid必填其一 |
randomstr |
随机字符串 |
随机生成的字符串 |
否 |
32 |
|
signtype |
签名类型 |
|
是 |
8 |
支持MD5、RSA、SM2,不填默认MD5 |
sign |
签名 |
|
否 |
32 |
详见安全规范 |
响应参数
字段ID |
字段名称 |
取值 |
可空 |
最大长度 |
备注 |
retcode |
返回码 |
SUCCESS/FAIL |
否 |
8 |
此字段是通信标识,非交易结果,交易是否成功需要查看trxstatus来判断 |
retmsg |
返回码说明 |
|
是 |
100 |
|
以下信息只有当retcode为SUCCESS时有返回 |
|||||
cusid |
商户号 |
实际交易的店铺ID |
否 |
15 |
|
appid |
应用ID |
平台分配的APPID |
否 |
20 |
|
orgid |
机构ID |
实际交易的机构ID |
否 |
11 |
|
trxid |
交易单号 |
平台的交易流水号 |
是 |
20 |
|
chnltrxid |
支付渠道交易单号 |
如支付宝,微信平台的交易单号 |
是 |
50 |
|
reqsn |
商户订单号 |
商户的交易订单号 |
否 |
64(isv:25) |
|
trxcode |
交易类型 |
交易类型 |
否 |
8 |
见附录-交易类型 |
trxamt |
交易金额 |
|
否 |
16 |
单位:分 |
trxstatus |
交易状态 |
交易的状态 |
是 |
4 |
见附录-交易返回码说明 |
acct |
支付平台用户标识 |
JS支付时使用 |
是 |
32 |
如果为空,则默认填000000 |
fintime |
交易完成时间 |
yyyyMMddHHmmss |
是 |
14 |
|
randomstr |
随机字符串 |
随机生成的字符串 |
否 |
32 |
|
errmsg |
错误原因 |
失败的原因说明 |
是 |
100 |
|
cmid |
渠道子商户号 |
|
是 |
32 |
限微信/支付宝交易响应 |
chnlid |
渠道号 |
|
是 |
32 |
限微信交易响应 |
initamt |
原交易金额 |
|
是 |
15 |
与请求字段trxamt值一致 |
fee |
手续费 |
|
是 |
15 |
单位:分 |
chnldata |
渠道信息 |
目前返回云闪付/微信/支付宝的活动参数 |
是 |
- |
限交易参与活动 |
accttype |
借贷标识 |
|
是 |
2 |
00-借记卡 |
sign |
签名 |
|
否 |
32 |
详见安全规范 |
balanceamount |
余额抵扣金额 |
|
是 |
20 |
单位:分 |
score |
积分抵扣数量 |
|
是 |
11 |
|
scoreamount |
积分抵扣金额 |
|
是 |
20 |
单位:分 |
bankscore |
银行积分抵扣数量 |
|
是 |
11 |
|
bankscoreamount |
银行积分抵扣金额 |
|
是 |
20 |
单位:分 |
givescore |
返积分数 |
|
是 |
11 |
|
givecouponnum |
返券张数 |
|
是 |
11 |
|
mchtdiscountamount |
商户优惠汇总金额 |
商户积分、余额、卡券优惠抵扣金额,银行活动商户分摊金额 |
否 |
14 |
单位:分 |
bankdiscountamount |
银行补贴汇总金额 |
银行活动银行分摊金额 |
否 |
14 |
单位:分 |
consumecouponlist |
用券列表,ArrayList |
||||
promotionid |
活动编号 |
|
是 |
11 |
|
couponno |
券号 |
|
是 |
32 |
|
coupontype |
券类型 |
|
是 |
2 |
|
couponname |
券名称 |
|
是 |
50 |
|
consumeamount |
抵扣金额 |
|
是 |
20 |
单位:分 |
banksubsidyamount |
银行补贴金额 |
|
是 |
20 |
单位:分 |
splitlist |
分账信息 |
|
是 |
|
分账结果信息,详见附录4.9 |