3.标准API


3.1 统一扫码

接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/apiweb/unitorder/scanqrpay

测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/apiweb/unitorder/scanqrpay

使用场景:扫一扫付款二维码,获取付款二维码内容调用此接口进行收款。支持微信、支付宝、手机qq、银联规范付款二维码。
当结果码为“2000”时,商户系统可设置间隔时间(建议10秒)重新查询支付结果,直到支付成功或超时(建议40秒)。

该接口不支持阶梯分账(可正常收款,但不执行阶梯分账规则)。

请求参数

字段ID

字段名称

取值

可空

最大长度

备注

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

服务商appid调用时必填

cusid

商户号

实际交易的店铺ID

11

 

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

分账信息

上送分账信息,json字符串

1024

参照附录4.7asinfo字段说明

fqnum

花呗分期

6-花呗分期6期
12-花呗分期12期

4

暂只支持支付宝花呗分期

notify_url

交易结果通知地址

接收交易结果的通知回调地址,通知url必须为直接可访问的url,不能携带参数。
https只支持默认端口

256

若使用https,需使用默认443端口

signtype

签名方式

 

8

支持MD5、RSA、SM2,不填默认MD5

sign

签名

详见安全规范

32

 

terminfo

终端信息

终端信息的json字符串
详见附录4.6终端字段说明

200

 

membertype

会员账户类型

 

2

1-手机号

2-会员卡号

3-Openid

4-会员动态码

5-外部会员ID

6-内部会员ID

memberid

会员账户

 

180

 

inaccountflag

入金账户标识

0-余额户

1-储值卡专用户

2

不送默认0

splitflag

分账标识

 

2

1-自动分账,默认1

2-不分账

3-延时分账/收款

若上送2时,忽略接口上送的asinfo;若上送3,则必须调用“3.21分账/收款确认”接口完成分账或收款入账。

 

响应参数

字段ID

字段名称

取值

可空

最大长度

备注

retcode

返回码

SUCCESS/FAIL

8

此字段是通信标识,非交易结果,交易是否成功需要查看trxstatus来判断

retmsg

返回码说明

 

100

 

以下信息只有当retcode为SUCCESS时有返回

cusid

商户号

实际交易的店铺ID

11

 

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

 

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

渠道信息

目前返回云闪付/微信/支付宝的活动参数

-

限交易参与活动

accttype

借贷标识

 

2

00-借记卡
02-信用卡
99-其他(花呗/余额等)

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

单位:分

 

备注: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\":\"返回优惠信息券\"}]"}

 

3.2 统一撤销

接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/apiweb/tranx/cancel

测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/apiweb/tranx/cancel

使用场景:只能撤销当天的统一扫码交易,全额退款,实时返回退款结果。开通资金管理的机构不支持撤销交易。

请求参数

参数

参数名称

取值

可空

最大长度

备注

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

服务商appid调用时必填

cusid

商户号

实际交易的店铺ID

11

 

version

版本号

接口版本号

2

默认填11

reqsn

商户退款交易单号

商户的退款交易订单号

32

商户平台唯一

trxamt

交易金额

原订单实际支付金额

16

 

oldreqsn

原交易单号

原交易的商户交易单号

32

 

oldtrxid

原交易流水

原交易的收银宝平台流水

20

oldreqsn和oldtrxid必填其一
建议:商户如果同时拥有oldtrxid和oldreqsn,优先使用oldreqsn;分账订单只能通过reqsn进行撤销。

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

 

reqsn

商户订单号

商户的退款交易订单号

32

 

trxstatus

交易状态

交易的状态

4

见附录-交易返回码说明

fintime

交易完成时间

yyyyMMddHHmmss

14

 

errmsg

错误原因

失败的原因说明

100

 

trxcode

交易类型

 

8

见交易类型说明

randomstr

随机字符串

随机生成的字符串

32

 

sign

签名

 

32

详见安全规范

3.3 统一退款

接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/apiweb/tranx/refund

测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/apiweb/tranx/refund

ISV接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/apiweb/isv/refund

ISV测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/apiweb/isv/refund

使用场景:支持部分金额退款,隔天交易退款。(建议在交易完成后间隔几分钟(最短5分钟)再调用退款接口,避免出现订单状态同步不及时导致退款失败。)
注:1、含商户/银行优惠抵扣、积分、余额的非分账交易,只能整单退款,不支持部分退款;

2、含商户/银行优惠抵扣、积分、余额的分账交易,收款店铺分账部分只能全部退款,不支持部分退款

请求参数

参数

参数名称

取值

可空

最大长度

备注

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

服务商appid调用时必填

cusid

商户号

实际交易的店铺ID

11

 

version

版本号

接口版本号

2

默认填11

trxamt

退款金额

必须小于等于原订单实际支付金额,单位为分

16

 

reqsn

商户退款订单号

商户的退款交易订单号

50

商户平台唯一

oldreqsn

原交易订单号

原交易的商户订单号

50

 

oldtrxid

原交易流水

原交易的收银宝平台流水

20

oldreqsn和oldtrxid必填其一
建议:商户如果同时拥有oldtrxid和oldreqsn,优先使用oldreqsn;分账订单只能通过reqsn进行退款。

remark

备注

备注信息

50

最大50个字节(25个中文字符)

benefitdetail

优惠信息

 

-

只适用于银联单品优惠交易的退货

randomstr

随机字符串

随机生成的字符串

32

 

signtype

签名方式

 

8

支持MD5、RSA、SM2,不填默认MD5

sign

签名

 

32

详见交易返回码说明

splitList

分账退款列表

 

1024

相见附录4.7asinfo字段说明。

分账订单退款使用,整单退不传。部分退时,若不传,则按退款金额与总金额的比例挨个从分账中退款。

nosplitamount

退款未分账金额

 

16

预留字段,暂不可用

响应参数

字段ID

字段名称

取值

可空

最大长度

备注

retcode

返回码

SUCCESS/FAIL

8

此字段是通信标识,非交易结果,交易是否成功需要查看trxstatus来判断

retmsg

返回码说明

 

100

 

以下信息只有当retcode为SUCCESS时有返回

cusid

商户号

实际交易的店铺ID

11

 

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

 

trxid

交易单号

收银宝平台的退款交易流水号

20

 

reqsn

商户订单号

商户的退款交易订单号

32

 

trxstatus

交易状态

交易的状态

4

见附录交易返回码说明

fintime

交易完成时间

yyyyMMddHHmmss

14

 

errmsg

错误原因

失败的原因说明

100

 

fee

手续费

 

15

 

trxcode

交易类型

 

8

见附录交易类型说明

randomstr

随机字符串

随机生成的字符串

32

 

chnltrxid

渠道流水号

如支付宝,微信平台订单号

64

 

sign

签名

 

32

详见安全规范

splitlist

分账信息

 

 

分账结果信息,详见附录4.9

 

3.4 统一查询

接口地址: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

使用场景:该接口提供交易查询,商户可以通过查询接口主动查询订单状态,完成下一步的业务逻辑。

需要调用查询接口的情况:

  1. ◆ 当商户后台、网络、服务器等出现异常,商户系统最终未接收到支付通知;
  2. ◆ 调用支付接口后,返回系统错误或未知交易状态情况;
  3. ◆ 调用统一被扫接口后,返回交易状态码trxstatus为2000时;
  4. ◆ 调用关单或撤销接口API之前,需确认支付状态;

备注:如果撤销交易异常,请查询原支付订单状态

请求参数

字段ID

字段名称

取值

可空

最大长度

备注

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

服务商appid调用时必填

cusid

商户号

实际交易的店铺ID

11

 

version

版本号

接口版本号

2

默认填11

reqsn

商户订单号

商户的交易订单号

32

 

trxid

平台交易流水

支付的收银宝平台流水

20

reqsn和trxid必填其一
建议:商户如果同时拥有trxid和reqsn,优先使用reqsn,trxid只能查询存在实付的订单;分账订单只能通过reqsn进行查询。

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

商户订单号

商户的交易订单号

32

 

trxcode

交易类型

交易类型

8

见附录-交易类型

trxamt

交易金额

 

16

单位:分

trxstatus

交易状态

交易的状态

4

见附录-交易返回码说明
如果trxstatus为空,则交易正在处理中,尚未完成

acct

支付平台用户标识

JS支付时使用
微信支付-用户的微信openid
支付宝支付-用户user_id

32

如果为空,则默认填000000

fintime

交易完成时间

yyyyMMddHHmmss

14

 

randomstr

随机字符串

随机生成的字符串

32

 

errmsg

错误原因

失败的原因说明

100

 

cmid

渠道子商户号

 

32

限微信/支付宝交易响应

chnlid

渠道号

 

32

限微信交易响应

initamt

原交易金额

 

15

与请求字段trxamt值一致

fee

手续费

 

15

单位:分

chnldata

渠道信息

目前返回云闪付/微信/支付宝的活动参数

-

限交易参与活动

accttype

借贷标识

 

2

00-借记卡
02-信用卡
99-其他(花呗/余额等)

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

3.5 交易结果通知

注意:因为以后可能会增加通知参数,请获取全量变量,然后遍历获取非空变量,而不能用request.getparam(“key”),这样用文档中的字段名来一个个获取,到时候数字营销平台增加通知字段,就无法兼容了。请参考demo。

通知的每一个字段都会进行UTF-8的UrlEncode,如果商户接收结果的服务器用web容器进行接收,例如TOMCAT,IIS。则无需进行URLDecode,如果不是用web容器进行接收,而是读数据流自己进行解析,则需要进行UTF-8的UrlDecode。

以java为例:
String trxreserve = "订购人+10086";
String sendData = URLEncoder.encode(trxreserve, "UTF-8");
String getData = URLDecoder.decode(sendData, "UTF-8");

通知响应结果:
商户服务端在接收到结果通知并正确处理后,应响应消息。正确处理响应success,其他响应或者不响应通联开发平台则通过重发机制进行重发,重发次数为16次。(通知频率为10s/30s/1m/2m/3m/4m/5m/6m/7m/8m/9m/10m/20m/30m/1h/2h)

对后台通知交互时,如果通联收到商户的应答不符合规范或超时,通联认为通知失败,通联会通过一定的策略定期重新发起通知,尽可能提高通知的成功率,但通联不保证通知最终能成功。对于异步支付方式,如js支付和Native支付(刷卡支付不通知),平台会通过主动发起http post请求的方式,把支付结果通知到该交易上送的地址,请求参数如下:

字段名称

类型

可空

说明

最长长度

备注

appid

string

APPID

20

 

outtrxid

string

第三方交易号

50

暂未启用

trxcode

string

交易类型

8

详见附录交易类型

trxid

string

收银宝交易单号

50

通联收银宝交易流水号

initamt

string

原始下单金额

20

与请求trxamt值一致

trxamt

long

交易金额

20

单位:分

trxdate

string

交易请求日期

8

yyyymmdd

paytime

string

交易完成时间

14

yyyymmddhhmmss

chnltrxid

string

渠道流水号

64

如支付宝,微信平台订单号

trxstatus

string

交易结果码

4

交易状态详见交易返回码说明

cusid

string

实际交易的商户编号或店铺ID

11

 

termno

string

终端编号

8

 

termbatchid

string

终端批次号

16

 

termtraceno

string

终端流水号

6

 

termauthno

string

终端授权码

20

 

termrefnum

string

终端参考号

50

 

trxreserved

string

业务关联内容

160

交易备注

srctrxid

string

原交易流水

50

通联原交易流水,冲正撤销交易本字段不为空

cusorderid

string

业务流水

32

统一下单对应的reqsn订单号

或者isv收银台对应的reqsn订单号

acct

string

交易账号

64

如果是刷卡交易,则是隐藏的卡号,例如621700******4586

fee

string

手续费

15

单位:分

signtype

string

签名类型

3

MD5或RSA。为空默认MD5

cmid

string

渠道子商户号

32

仅微信/支付宝交易有效

chnlid

string

渠道号

32

仅微信交易有效

chnldata

string

渠道信息

-

仅返回云闪付/微信/支付宝的渠道信息

accttype

string

借贷标识

2

00-借记卡
02-信用卡
99-其他(花呗/余额等)

sign

string

sign校验码

32

 

mchtdiscountamount

string

商户优惠汇总金额

14

单位:分

bankdiscountamount

string

银行补贴汇总金额

14

单位:分

splitlist

string

分账信息

 

分账结果信息,详见附录4.9

备注: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\":\"返回优惠信息券\"}]"}

3.6 订单生成

接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/apiweb/tranx/createorder

测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/apiweb/tranx/createorder

使用场景:终端POS交易支付,使用本接口请求返回的orderNo订单号,完成支付。如果上送分账信息,调用此接口前需要开通数字营销结算资金管理功能。

该接口不支持阶梯分账(可正常收款,但不执行阶梯分账规则)。

请求参数

字段ID

字段名称

取值

可空

最大长度

备注

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

服务商appid调用时必填

cusid

商户号

实际交易的店铺ID

11

 

version

版本号

接口版本号

2

默认填11

randomstr

随机字符串

随机生成的字符串

32

 

reqsn

商户交易单号

商户的交易订单号

50

保证商户平台唯一

trxamt

交易金额

单位为分

15

 

membertype

会员账户类型

 

2

1-手机号

2-会员卡号

3-Openid

4-会员动态码

5-外部会员ID

6-内部会员ID

memberid

会员账号

 

180

 

remark

备注

备注信息

160

禁止出现+,空格,/,?,%,#,&,=这几类特殊符号

asinfo

分账信息

上送分账信息,json字符串

1024

参照附录4.7asinfo字段说明

signtype

签名类型

 

8

支持MD5、RSA、SM2,不填默认MD5

sign

签名

 

32

详见安全规范

splitflag

分账标识

 

2

1-自动分账,默认1

2-不分账

3-延时分账/收款

若上送2时,忽略接口上送的asinfo;若上送3,则必须调用“3.21分账/收款确认”接口完成分账或收款入账。

 

响应参数

字段ID

字段名称

取值

可空

最大长度

备注

retcode

返回码

SUCCESS/FAIL

8

此字段是通信标识,非交易结果,交易是否成功需要调用查询接口返回状态来判断

retmsg

返回码说明

 

100

 

以下信息只有当retcode为SUCCESS时有返回

cusid

商户号

实际交易的店铺ID

11

 

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

 

reqsn

商户交易单号

商户的交易订单号

32

 

orderno

订单号

 

64

 

randomstr

随机字符串

随机生成的字符串

32

 

initamt

原交易金额

 

15

与请求字段trxamt值一致,单位:分

trxamt

实际交易金额

 

15

用于区分优惠活动的金额,单位:分

signtype

签名类型

 

4

支持MD5、RSA、SM2

sign

签名

 

32

详见安全规范

 

3.7 终端信息采集报备

接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/cusapi/merchantapi/addterm

测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/cusapi/merchantapi/addterm

使用场景:在进行交易前,需要通过此接口进行终端信息报备,否则可能存在无法交易等情况。开通资金分账功能的机构店铺进行终端报备时,建议上送termsn,以自动完成商户信息与终端信息的相关绑定。

请求参数

 

参数

参数名称

取值

可空

最大长度

备注

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

服务商appid调用时必填

cusid

商户号

实际交易的店铺ID

11

 

version

版本号

接口版本号

2

默认填12

termno

终端号

8位数字

8

商户下唯一

devicetype

设备类型

01:自动柜员机(含 ATM 和 CDM)
和多媒体自助终端
02:传统 POS
03:mPOS
04:智能 POS
05:II 型固定电话
06:云闪付终端;
07:保留使用;
08:手机 POS;
09:刷脸付终端;
10:条码支付受理终端;
11:条码支付辅助受理终端;
12:行业终端(公交、地铁用于指
定行业的终端);
13:MIS 终端;

2

 

termsn

终端序列号

 

50

终端类型(device_type)填写为 02、03、04、05、06、08、09 或 10时,必须填写终端序列号。

operation

操作类型

本次操作标识,取值范围:00:新增;01:修改;02:注销;(注销时,仅需上送termno字段)

2

当操作类型为注销02时,termsn,termstate可为空

termstate

终端状态

取值范围:00:启用;01:注销;注:终端注销时非必填

2

 

termaddress

终端地址

上海市-上海市-浦东新区-五星路

100

省-市-区-详细地址,详细地址长度控制在 30 个汉字以内注:取值范围可参考《省市区结构说明》注:终端注销时非必填

signtype

签名方式

 

8

支持MD5、RSA、SM2,不填默认MD5

sign

签名

详见安全规范

32

 

响应参数

字段ID

字段名称

取值

可空

最大长度

备注

retcode

返回码

SUCCESS/FAIL

8

SUCCESS表示报备受理成功

retmsg

返回码说明

 

100

 

 

 

 

3.8 统一支付

接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/apiweb/unitorder/pay

测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/apiweb/unitorder/pay

使用场景:请求扫码支付的二维码串(支持支付宝、数字人民币、云闪付),公众号JS支付(支付宝,微信,数字人民币,云闪付),微信小程序支付。

该接口不支持阶梯分账(可正常收款,但不执行阶梯分账规则)。

请求参数

参数

参数名称

取值

可空

最大长度

备注

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

服务商appid调用时必填

cusid

商户号

实际交易的店铺ID

11

 

version

版本号

接口版本号

2

默认填11

trxamt

交易金额

单位为分

15

 

reqsn

商户交易单号

商户的交易订单号

50

保证商户平台唯一

paytype

交易方式

详见附录交易方式

3

 

randomstr

随机字符串

商户自行生成的随机字符串

32

 

body

订单标题

订单商品名称,为空则以商户名作为商品名称

100

最大100个字节(注:utf8下,一个中文字符是3个字节)

remark

备注

备注信息

160

最大160个字节(80个中文字符)
禁止出现+,空格,/,?,%,#,&,=这几类特殊符号

validtime

有效时间

订单有效时间,以分为单位,不填默认为5分钟

4

最大1440分钟

acct

支付平台用户标识

JS支付时使用
微信支付-用户的微信openid
支付宝支付-用户user_id
微信小程序-用户小程序的openid
云闪付JS-用户userId

32

 

notify_url

交易结果通知地址

接收交易结果的通知回调地址,通知url必须为直接可访问的url,不能携带参数。
https只支持默认端口

256

若使用https,需使用默认443端口

limit_pay

支付限制

no_credit--指定不能使用信用卡支付

32

暂时只对微信支付和支付宝有效,仅支持no_credit

sub_appid

微信子appid

微信小程序/微信公众号/APP的appid

32

只对微信支付有效

goods_tag

订单优惠标识

订单优惠标记,用于区分订单是否可以享受优惠,字段内容在微信后台配置券时进行设置,说明详见代金券或立减优惠

32

只对微信支付有效
W01交易方式不支持

benefitdetail

优惠信息

Benefitdetail的json字符串,注意是String
填写格式详见附录5.8

 

-

微信单品优惠
W01交易方式不支持
支付宝智慧门店
支付宝单品优惠

chnlstoreid

渠道门店编号

商户在支付渠道端的门店编号

 

例如:
对于支付宝支付,支付宝门店编号
对于微信支付,微信门店编号
W01交易方式不支持

subbranch

门店号

 

4

 通联系统门店号

extendparams

拓展参数

json字符串,注意是String
一般用于渠道的活动参数填写

 

参考5.9拓展参数附录说明

cusip

终端ip

用户下单和调起支付的终端ip地址

16

payType=U02云闪付JS支付不为空

front_url

支付完成跳转

必须为https协议地址,且不允许带参数

128

只支持payType=U02云闪付JS支付
payType=W02微信JS支付

idno

证件号

实名交易必填.填了此字段就会验证证件号和姓名

32

暂只支持支付宝支付,微信支付(微信支付的刷卡支付除外)

truename

付款人真实姓名

实名交易必填.填了此字段就会验证证件号和姓名

32

暂只支持支付宝支付,微信支付(微信支付的刷卡支付除外)

asinfo

分账信息

上送分账信息,json字符串

1024

参照附录4.7asinfo字段说明

fqnum

分期

3  花呗分期3期
6  花呗分期6期
12  花呗分期12期
3-cc 支付宝信用卡分期3期
6-cc 支付宝信用卡分期6期
12-cc 支付宝信用卡分期12期

8

暂只支持支付宝花呗分期,支付宝信用卡分期
仅支持A01/A02

signtype

签名方式

 

8

支持MD5、RSA、SM2,不填默认MD5

unpid

银联pid

 

 

 

仅支持代理商/服务商角色调用

sign

签名

详见安全规范

32

 

terminfo

终端信息

终端信息的json字符串
详见附录4.6终端字段说明

200

paytype=A04,W04,U04时,terminfo字段必填

operatorid

收银员号

 

20

 

membertype

会员账户类型

 

2

1-手机号

2-会员卡号

3-Openid

4-会员动态码

5-外部会员ID

6-内部会员ID

memberid

会员账户

 

180

 

inaccountflag

入金账户标识

0-余额户

1-储值卡专用户

2

不送默认0

splitflag

分账标识

 

2

1-自动分账,默认1

2-不分账

3-延时分账/收款

若上送2时,忽略接口上送的asinfo;若上送3,则必须调用“3.21分账/收款确认”接口完成分账或收款入账。

 

各交易方式必填字段(M:必填):

 

W01|A01|S01

W02|A02|U02

A03|S03

W06

动态码CSB支付

JSAPI支付

支付宝APP支付

微信小程序支付

acct

 

M

 

M

notify_url

M

M

M

M

sub_appid

 

M

 

M

idno

仅实名支付需要

truename

asinfo

仅分账支付需要

 

响应参数

字段ID

字段名称

取值

可空

最大长度

备注

retcode

返回码

SUCCESS/FAIL

8

此字段是通信标识,非交易结果,交易是否成功需要查看trxstatus来判断

retmsg

返回码说明

 

100

 

以下信息只有当retcode为SUCCESS时有返回

cusid

商户号

实际交易的店铺ID

11

 

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

 

trxid

交易单号

收银宝平台的交易流水号

20

 

chnltrxid

渠道平台交易单号

例如微信,支付宝平台的交易单号

50

 

reqsn

商户交易单号

商户的交易订单号

32

 

randomstr

随机字符串

随机生成的字符串

32

 

trxstatus

交易状态

交易的状态,
对于刷卡支付,该状态表示实际的支付结果,其他为下单状态

4

详见交易返回码说明

fintime

交易完成时间

yyyyMMddHHmmss

14

对于微信刷卡支付有效

errmsg

错误原因

失败的原因说明

100

 

payinfo

支付串

扫码支付则返回二维码串,js支付则返回json字符串
QQ钱包及云闪付的JS支付返回支付的链接,商户只需跳转到此链接即可完成支付
支付宝App支付返回支付信息串;

聚合支付返回支付链接,跳转到此链接进行支付;

小程序聚合支付返回json串,商户小程序跳转至appid小程序的paypath进行支付

不限

 

sign

签名

 

32

详见安全规范

mchtdiscountamount

商户优惠汇总金额

商户积分、余额、卡券优惠抵扣金额,银行活动商户分摊金额

14

单位:分

bankdiscountamount

银行补贴汇总金额

银行活动银行分摊金额

14

单位:分

 

向front_url跳转

支付完成后,交易成功后点击跳往商户网站,会跳往交易上送的front_url

注意:不能以此为支付结果,以交易结果通知接口为最终交易结果

 

云闪付JS完成跳转请求参数:

参数

参数名称

取值

appid

应用ID

平台分配的应用ID

cusid

商户号

平台分配的商户号

cusorderid

商户订单号

交易上送的订单号(reqsn)

trxcode

交易类型

见附录:交易类型说明

trxid

通联交易流水号

通联系统内唯一

trxamt

交易金额

分为单位

trxdate

交易请求日期

yyyyMMdd

paytime

交易完成时间

yyyyMMddHHmmss

trxstatus

交易状态

见附录:交易状态说明

trxreserved

交易备注

返回商品号(goodsid)

sign

签名信息

详见接口规则:安全规范

 

 

微信JS完成跳转请求参数:

微信js支付完成跳转改造参考 https://aipboss.allinpay.com/know/devhelp/main.php?pid=65#mid=748

参数

参数名称

取值

appid

应用ID

平台分配的应用ID

cusid

商户号

平台分配的商户号

reqsn

商户订单号

交易上送的订单号(reqsn)

trxid

通联交易流水号

通联系统内唯一

trxamt

交易金额

分为单位

remark

交易备注

 

randomstr

随机串

 

sign

签名信息

详见安全规范

 

调起通联小程序支付流程:

1. 请求参数的支付方式 `paytype` 上送 “IM01”,并调用接口 3.8 获取支付信息。

2. 接收返回的 `payinfo`,其中包含通联小程序的 `appid` 和支付路径 `paypath`。

3. 使用接口返回的参数调起通联小程序发起支付,代码示例如下:

 

4. 支付完成或失败后,通联小程序前端通过 `extraData` 返回 `payStatus` 给来源小程序,具体值为:

- "0":支付失败

- "1":支付成功

- "2":用户取消支付

5. 来源小程序结合以上结果和后台查询的支付结果状态实现具体的业务需求,建议来源小程序调用查询接口主动查询订单结果。

 

具体业务需求建议:

  • 在接收到 `payStatus` 结果后,来源小程序应调用查询接口确认订单支付结果,以确保支付结果的准确性。
  • 实现支付结果的业务逻辑处理,包括支付成功、失败、用户取消支付等情况的处理。

 

注意事项:

  • 确保传递的参数符合接口要求,尤其是 `paytype` 参数必须为 “IM01”。
  • 小程序支付路径 `paypath` 和 `appid` 应从返回的 `payinfo` 中获取并正确使用。

 

 

3.9 资金管理余额查询

接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/apiweb/fund/balanceQuery

测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/apiweb/fund/balanceQuery

使用场景:开通了数字营销结算资金管理的商户,可以通过此接口查询余额。

请求参数

字段ID

字段名称

取值

可空

最大长度

备注

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

服务商appid调用时必填

cusid

商户号

店铺ID

分佣方Id

_platform_

11

_platform_表示平台会员

version

版本号

接口版本号

2

默认填11

randomstr

随机字符串

随机生成的字符串

32

 

signtype

签名类型

 

8

支持MD5、RSA、SM2,不填默认MD5

sign

签名

 

32

详见安全规范

 

响应参数

字段ID

字段名称

取值

可空

最大长度

备注

retcode

返回码

SUCCESS/FAIL

8

 

retmsg

返回码说明

 

100

 

以下信息只有当retcode为SUCCESS时有返回

cusid

商户号

店铺ID

分佣方Id

_platform_

11

 

externamCode

外部商户号

店铺编号

外部分佣方编号

30

 

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

 

accountUserId

账户Id

 

11

 

accountSetNo

账户集编号

100001,余额户

2000000,营销户

8

 

referenceType

账户来源

11,大B

13,店铺

49,外部分佣方

 

2

 

shopName

店铺名

 

50

 

accountName

账户名称

 

200

 

balance

余额

单位:分

 

15

和云商通余额保持一致

frozenBalance

冻结金额

单位:分

 

15

和云商通冻结金额保持一致

availableBalance

可用余额

单位:分

 

15

当前余额 – 当前冻结金额 + 今日退款金额 – 今日代付金额 

withdrawBalance

可提现金额

单位:分

 

15

根据T/D+n,推算出n - 1天前的余额 + 该天的退款金额– 该天的代付金额 - 当前冻结金额

signtype

签名类型

 

4

支持MD5、RSA、SM2

sign

签名

 

32

详见安全规范

 

3.10 资金管理提现

接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/apiweb/fund/withdraw

测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/apiweb/fund/withdraw

使用场景:开通了数字营销结算资金管理的商户,可以通过此接口发起提现。本接口如果返回的状态是1-提现中,则需要通过查询接口查询最终状态。

请求参数

字段ID

字段名称

取值

可空

最大长度

备注

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

服务商appid调用时必填

cusid

商户号

店铺ID

分佣方Id

_platform_

11

_platform_表示平台会员

reqsn

提现申请单号

 

20

保证商户平台唯一

withdrawAmount

提现金额

单位:分

15

 

notifyUrl

提现结果通知地址

 

300

设置该地址后,提现成功或者失败将发起通知

注意:本请求直接返回失败时,没有通知

version

版本号

接口版本号

2

默认填11

randomstr

随机字符串

随机生成的字符串

32

 

signtype

签名类型

 

8

支持MD5、RSA、SM2,不填默认MD5

sign

签名

 

32

详见安全规范

 

响应参数

字段ID

字段名称

取值

可空

最大长度

备注

retcode

返回码

SUCCESS/FAIL

8

此字段是通信标识,非交易结果,交易是否成功需要查看withdrawStatus和结果查询接口返回的withdrawStatus来判断

retmsg

返回码说明

 

100

 

以下信息只有当retcode为SUCCESS时有返回

cusid

商户号

店铺ID

分佣方Id

_platform_

11

 

externalCode

外部商户号

店铺编号

外部分佣方编号

30

 

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

 

reqsn

提现申请单号

 

20

 

withdrawTId

提现流水编号

 

11

通联返回的提现交易流水号

accountUserId

账户Id

 

11

 

accountSetNo

账户集编号

100001,余额户

2000000,营销户

8

 

referenceType

账户来源

11,大B

13,店铺

49,外部分佣方

 

2

 

shopName

店铺名

 

50

 

accountName

账户名称

 

200

 

withdrawAmount

提现金额

单位:分

15

实际到账金额

fee

手续费

单位:分

15

提现手续费

withdrawStatus

提现状态

1,提现中

3,提现失败

2

 

withdrawStatusDesc

提现状态描述

1,提现中

3,提现失败原因

100

 

signtype

签名类型

 

4

支持MD5、RSA、SM2

sign

签名

 

32

详见安全规范

3.11 资金管理提现结果查询

接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/apiweb/fund/withdrawResultQuery

测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/apiweb/fund/withdrawResultQuery

使用场景:开通了数字营销结算资金管理的商户,可以通过此接口发起提现。本接口如果返回的状态是1-提现中,则需要继续通过查询接口查询最终状态。

请求参数

字段ID

字段名称

取值

可空

最大长度

备注

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

服务商appid调用时必填

cusid

商户号

店铺ID

分佣方Id

_platform_

11

_platform_表示平台会员

reqsn

提现申请单号

 

20

 

version

版本号

接口版本号

2

默认填11

randomstr

随机字符串

随机生成的字符串

32

 

signtype

签名类型

 

8

支持MD5、RSA、SM2,不填默认MD5

sign

签名

 

32

详见安全规范

 

响应参数

字段ID

字段名称

取值

可空

最大长度

备注

retcode

返回码

SUCCESS/FAIL

8

此字段是通信标识,非交易结果,交易是否成功需要查看withdrawStatus来判断

retmsg

返回码说明

 

100

 

以下信息只有当retcode为SUCCESS时有返回

cusid

商户号

店铺ID

分佣方Id

_platform_

11

 

externalCode

外部商户号

店铺编号

外部分佣方编号

30

 

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

 

reqsn

提现申请单号

 

20

 

withdrawTId

提现流水编号

 

11

通联返回的提现交易流水号

accountUserId

账户Id

 

11

 

accountSetNo

账户集编号

100001,余额户

2000000,营销户

8

 

referenceType

账户来源

11,大B

13,店铺

49,外部分佣方

 

2

 

shopName

店铺名

 

50

 

accountName

账户名称

 

200

 

withdrawAmount

提现金额

单位:分

15

实际到账金额

fee

手续费

单位:分

15

提现手续费

withdrawStatus

提现状态

1,提现中

2,交易成功

3,提现失败

2

 

withdrawStatusDesc

提现状态描述

1,提现中

2,交易成功

3,提现失败原因

100

 

notifyUrl

提现结果通知地址

 

300

 

signtype

签名类型

 

4

支持MD5、RSA、SM2

sign

签名

 

32

详见安全规范

3.12 资金管理转账

接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/apiweb/fund/transfer

测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/apiweb/fund/transfer

使用场景:开通了数字营销结算资金管理的商户,可以通过此接口发起转账。本接口如果返回的状态是1-转账中,则需要通过查询接口查询最终状态。

请求参数

字段ID

字段名称

取值

可空

最大长度

备注

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

服务商appid调用时必填

cusid

付款商户号

店铺ID

分佣方Id

_platform_

11

_platform_表示平台会员

reqsn

转账申请单号

 

20

保证商户平台唯一

oppositionCusId

收款商户号

店铺ID

分佣方Id

_platform_

11

_platform_表示大B

不能跟cusid相同

transferAmount

转账金额

单位:分

15

 

notifyUrl

转账结果通知地址

 

300

设置该地址后,转账成功或者失败将发起通知

注意:本请求直接返回失败时,没有通知

remark

备注

 

100

 

version

版本号

接口版本号

2

默认填11

randomstr

随机字符串

随机生成的字符串

32

 

signtype

签名类型

 

8

支持MD5、RSA、SM2,不填默认MD5

sign

签名

 

32

详见安全规范

 

响应参数

字段ID

字段名称

取值

可空

最大长度

备注

retcode

返回码

SUCCESS/FAIL

8

此字段是通信标识,非交易结果,交易是否成功需要查看transferStatus和结果查询接口返回transferStatus来判断

retmsg

返回码说明

 

100

 

以下信息只有当retcode为SUCCESS时有返回

cusid

付款商户号

店铺ID

分佣方Id

_platform_

11

 

externalCode

付款商户外部商户号

店铺编号

外部分佣方编号

30

 

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

 

reqsn

转账申请单号

 

20

 

transferTId

转账流水编号

 

11

通联返回的转账交易流水号

accountUserId

付款账户Id

 

11

 

accountSetNo

付款账户集编号

100001,余额户

2000000,营销户

8

 

referenceType

付款账户来源

11,大B

13,店铺

49,外部分佣方

 

2

 

shopName

付款店铺名

 

50

 

accountName

付款账户名称

 

200

 

oppositionCusId

收款商户号

店铺ID

分佣方Id

_platform_

11

 

oppositionExternalCode

付款商户外部商户号

店铺编号

外部分佣方编号

30

 

oppositionAccountUserId

收款账户Id

 

11

 

oppositionAccountSetNo

收款账户集编号

100001,余额户

2000000,营销户

8

 

oppositionReferenceType

收款账户来源

11,大B

13,店铺

49,外部分佣方

 

2

 

oppositionShopName

收款店铺名

 

50

 

oppositionAccountName

收款账户名称

 

200

 

transferAmount

转账金额

单位:分

15

 

transferStatus

转账状态

1,转账中

3,转账失败

2

 

transferStatusDesc

转账状态描述

1,转账中

3,转账失败原因

100

 

remark

备注

 

100

 

signtype

签名类型

 

4

支持MD5、RSA、SM2

sign

签名

 

32

详见安全规范

 

3.13 资金管理转账结果查询

接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/apiweb/fund/transferResultQuery

测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/apiweb/fund/transferResultQuery

使用场景:开通了数字营销结算资金管理的商户,可以通过此接口发起提现。本接口如果返回的状态是1-提现中,则需要通过查询接口查询最终状态。

请求参数

字段ID

字段名称

取值

可空

最大长度

备注

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

服务商appid调用时必填

cusid

付款商户号

店铺ID

分佣方Id

_platform_

11

_platform_表示平台会员

reqsn

转账申请单号

 

20

保证商户平台唯一

version

版本号

接口版本号

2

默认填11

randomstr

随机字符串

随机生成的字符串

32

 

signtype

签名类型

 

8

支持MD5、RSA、SM2,不填默认MD5

sign

签名

 

32

详见安全规范

 

响应参数

字段ID

字段名称

取值

可空

最大长度

备注

retcode

返回码

SUCCESS/FAIL

8

此字段是通信标识,非交易结果,交易是否成功需要查看transferStatus来判断

retmsg

返回码说明

 

100

 

以下信息只有当retcode为SUCCESS时有返回

cusid

付款商户号

店铺ID

分佣方Id

_platform_

11

 

externalCode

付款商户外部商户号

店铺编号

外部分佣方编号

30

 

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

 

reqsn

转账申请单号

 

20

 

transferTId

转账流水编号

 

11

通联返回的转账交易流水号

accountUserId

付款账户Id

 

11

 

accountSetNo

付款账户集编号

100001,余额户

2000000,营销户

8

 

referenceType

付款账户来源

11,大B

13,店铺

49,外部分佣方

2

 

shopName

付款店铺名

 

50

 

accountName

付款账户名称

 

200

 

oppositionCusId

收款商户号

店铺ID

分佣方Id

_platform_

11

 

oppositionExternalCode

付款商户外部商户号

店铺编号

外部分佣方编号

30

 

oppositionAccountUserId

收款账户Id

 

11

 

oppositionAccountSetNo

收款账户集编号

100001,余额户

2000000,营销户

8

 

oppositionReferenceType

收款账户来源

11,大B

13,店铺

49,外部分佣方

 

2

 

oppositionShopName

收款店铺名

 

50

 

oppositionAccountName

收款账户名称

 

200

 

transferAmount

转账金额

单位:分

15

 

transferStatus

转账状态

1,转账中

2,交易成功

3,转账失败

2

 

transferStatusDesc

转账状态描述

1,转账中

2,交易成功

3,转账失败原因

100

 

remark

备注

 

100

 

signtype

签名类型

 

4

支持MD5、RSA、SM2

sign

签名

 

32

详见安全规范

 

3.14 终端信息查询

接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/cusapi/merchantapi/queryterm

测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/cusapi/merchantapi/queryterm

使用场景:终端信息采集结果查询。

请求参数

 

参数

参数名称

取值

可空

最大长度

备注

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

服务商appid调用时必填

cusid

商户号

实际交易的店铺ID

11

 

version

版本号

接口版本号

2

默认填12

termno

终端号

8位数字

8

商户下唯一

querytype

查询类型

AT/UAT

100

空或者AT时仅返回AT报备状态;UAT的时候返回AT加银联报备状态

signtype

签名方式

 

8

支持MD5、RSA、SM2,不填默认MD5

sign

签名

详见安全规范

32

 

响应参数

字段ID

字段名称

取值

可空

最大长度

备注

retcode

返回码

SUCCESS/FAIL

8

此字段是通信标识,非交易结果,交易是否成功需要根据返回的状态字段来判断

retmsg

返回码说明

 

100

 

以下信息只有当retcode为SUCCESS时有返回

cusid

商户号

实际交易的店铺ID

11

 

appid

应用ID

平台分配的APPID

20

 

sign

签名

 

32

详见安全规范

termno

终端号

8位数字

8

termno

devicetype

设备类型

01:自动柜员机(含 ATM 和 CDM)和多媒体自助终端

02:传统 POS

03:mPOS

04:智能 POS

05:II 型固定电话

06:云闪付终端;

07:保留使用;

08:手机 POS;

09:刷脸付终端;

10:条码支付受理终端;

11:条码支付辅助受理终端;

12:行业终端(公交、地铁用于指定行业的终端);

13:MIS 终端;

2

 

termsn

终端序列号

 

50

 

termstate

终端状态

00:启用、01:注销

2

 

termaddress

终端地址

上海市-上海市-浦东新区-五星路

100

 

wxstate

微信报备状态

 

4

0000:成功

0001:报备处理中

3999:失败

wxmsg

微信报备错误信息

 

100

 

alstate

支付宝报备状态

 

4

0000:成功

0001:报备处理中

3999:失败

almsg

支付宝报备错误信息

 

100

 

unstate

银联报备状态

 

4

0000:成功

0001:报备处理中

3999:失败

unmsg

银联报备错误信息

 

100

 

yststate

云商通商户及终端信息绑定状态

 

4

0000:成功

3999:失败

 

3.15 订单关闭

接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/apiweb/tranx/close

测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/apiweb/tranx/close

使用场景:对于处理中的交易,可调用该接口直接将未付款的交易进行关闭。

注意:

暂只支持微信、支付宝的正向交易。

订单生成后不能马上调用关单接口,建议最短调用时间间隔为5分钟,时间间隔过短容易导致错账。

请求参数

字段ID

字段名称

取值

可空

最大长度

备注

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

服务商appid调用时必填

cusid

商户号

实际交易的店铺ID

11

 

version

版本号

接口版本号

2

默认填11

oldreqsn

商户订单号

商户的交易订单号

32

 

oldtrxid

平台交易流水

支付的收银宝平台流水

20

oldreqsn和oldtrxid必填其一
建议:商户如果同时拥有oldtrxid和oldreqsn,优先使用oldreqsn。oldtrxid只能关闭存在待实付的订单;分账订单只能通过oldreqsn进行关闭。

randomstr

随机字符串

随机生成的字符串

32

 

signtype

签名类型

 

8

支持MD5、RSA、SM2,不填默认MD5

sign

签名

 

32

详见安全规范

 

响应参数

字段ID

字段名称

取值

可空

最大长度

备注

retcode

返回码

SUCCESS/FAIL

8

 

retmsg

返回码说明

 

100

 

以下信息只有当retcode为SUCCESS时有返回

cusid

商户号

实际交易的店铺ID

15

 

appid

应用ID

平台分配的APPID

20

 

trxstatus

交易状态

交易的状态

4

见附录-交易返回码说明
如果trxstatus为空,则交易正在处理中,尚未完成

randomstr

随机字符串

随机生成的字符串

32

 

errmsg

错误原因

失败的原因说明

100

 

sign

签名

 

32

详见安全规范

 

3.16 ISV收银台

接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/apiweb/isv/checkout

测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/apiweb/isv/checkout

使用场景:根据传入的cusid返回跳转到智慧门店ISV收银台的地址,再由对接方跳转到该地址。

该接口不支持阶梯分账(可正常收款,但不执行阶梯分账规则)。

请求参数

参数

参数名称

取值

可空

最大长度

备注

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

服务商appid调用时必填

cusid

商户号

实际交易的店铺ID

11

店铺下至少拥有一个码牌

version

版本号

接口版本号

2

默认填11

trxamt

交易金额

单位为分

15

 

reqsn

商户交易单号

商户的交易订单号

50

无论是否完成支付或者支付成功与否,均不能重复上送

randomstr

随机字符串

商户自行生成的随机字符串

32

 

remark

备注

备注信息

160

最大160个字节(160个中文字符)
禁止出现+,空格,/,?,%,#,&,=这几类特殊符号

notify_url

交易结果通知地址

接收交易结果的通知回调地址,通知url必须为直接可访问的url,不能携带参数。
https只支持默认端口

256

若使用https,需使用默认443端口

front_url

支付完成跳转

必须为https协议地址,且不允许带参数

128

只支持payType=U02云闪付JS支付
payType=W02微信JS支付

membertype

会员账户类型

1-手机号

2-会员卡号

3-Openid

4-会员动态码

5-外部会员ID

6-内部会员ID

2

不传的时候,只能在微信浏览器或者支付宝浏览器进入收银台

如果是APP或者微信小程序接入收银台,必传

memberid

会员账号

 

180

不传的时候,只能在微信浏览器或者支付宝浏览器进入收银台

如果是APP或者微信小程序接入收银台,必传

asinfo

分账信息

上送分账信息,json字符串

1024

参照附录4.7asinfo字段说明

qrcode

码牌号

需要与上送的cusid关联

20

 

trx_type

交易类型

3001

账单收款

11

 

3006

点餐消费

3007

餐饮外卖消费

3008

非餐饮外卖消费

3010

商城消费

page_title

页面标题

 

20

 

signtype

签名方式

 

8

支持MD5、RSA、SM2,不填默认MD5

sign

签名

详见安全规范

32

 

 

响应参数

字段ID

字段名称

取值

可空

最大长度

备注

retcode

返回码

SUCCESS/FAIL

8

 

retmsg

返回码说明

 

100

 

以下信息只有当retcode为SUCCESS时有返回

cusid

商户号

实际交易的店铺ID

15

 

appid

应用ID

平台分配的APPID

20

 

isvurl

跳转地址

 

100

 

randomstr

随机字符串

随机生成的字符串

32

 

errmsg

错误原因

失败的原因说明

100

 

sign

签名

 

32

详见安全规范

 

3.17 ISV前端跳转

接口地址:3.16 ISV收银台接口 传入的的front_url参数

使用场景:这是一个前端页面跳转。支付成功后,ISV收银台页面跳转回ISV调用方

请求参数

参数

参数名称

取值

可空

最大长度

备注

appid

应用ID

平台分配的APPID

20

 

cusid

商户号

实际交易的店铺ID

11

 

trxamt

交易金额

单位为分

15

 

reqsn

商户交易单号

商户的交易订单号

50

 

randomstr

随机字符串

随机生成的字符串

32

 

sign

签名

详见安全规范

32

 

 

3.18 对账流水文件下载

接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/apiweb/trxfile/get

测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/apiweb/trxfile/get

 

获取下载对账流水文件临时url。

请求参数

字段ID

字段名称

取值

可空

最大长度

备注

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

服务商appid调用时必填

cusid

商户号

实际交易的店铺ID

11

 

version

版本号

接口版本号

2

默认填11

date

交易日期

 

10

格式:yyyy-MM-dd

filetype

文件类型

1-订单流水文件

2-分账流水文件

2

见文件详细说明

randomstr

随机字符串

随机生成的字符串

32

 

signtype

签名类型

 

8

支持MD5、RSA、SM2,不填默认MD5

sign

签名

 

32

详见安全规范

 

响应参数

字段ID

字段名称

取值

可空

最大长度

备注

retcode

返回码

SUCCESS/FAIL

8

 

retmsg

返回码说明

 

100

 

以下信息只有当retcode为SUCCESS时有返回

cusid

商户号

实际交易的店铺ID

15

 

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

 

url

文件下载地址

 

 

 

randomstr

随机字符串

随机生成的字符串

32

 

sign

签名

 

32

详见安全规范

 

文件详细说明:

对账文件内容,每一行的记录字段以“,”符号分割,第一行为字段名。

1-订单流水文件

字段:外部订单号,交易订单号,订单原始金额(分),不参与优惠抵扣金额(分),商户活动优惠金额(分),商户卡券抵扣金额(分),钱包消费金额(分),积分抵扣金额(分),银行活动优惠金额(分),充值赠送金额(分),支付方式,用户实际支付金额(分),交易类型,交易时间,店铺ID,店铺编号,店铺名称,顾客ID,收银宝支付流水号,积分(数量),终端编号,原交易订单号,备注,手续费(分)

数据:O2021030811213901,63105215619969768296,100.00,0,0,0,0.00,0.00,0,0,现金,100,1,2021-03-08 10:14:43,147,125,星巴克光华店,123,112002680000003001,0,11754687,,示例数据,0

字段说明:

字段名称

说明

外部订单号

商户订单号

交易订单号

数字营销系统订单号

订单原始金额

订单金额,单位分

不参与优惠抵扣金额

单位分

商户活动优惠金额

单位分

商户卡券抵扣金额

单位分

钱包消费金额

单位分

积分抵扣金额

单位分

银行活动优惠金额

单位分

充值赠送金额

单位分

支付方式

银行卡、微信、支付宝、云闪付、现金、全抵扣

用户实际支付金额

单位分

交易类型

1-消费,2-撤销,3-退款,4-充值

交易时间

格式:yyyy-MM-dd HH:mm:ss

店铺ID

 

店铺编号

 

店铺名称

 

顾客ID

 

收银宝支付流水号

收银宝支付的流水号

积分消费数量

 

终端编号

POS编号,码牌号

原交易订单号

退款交易原消费订单号

备注

 

手续费

单位分

 

2-分账流水文件

字段:店铺编号,店铺名称,交易订单号,渠道订单号,商户订单号,支付类型,收款金额,手续费,支付时间,终端号,财务科目ID,财务科目名称,备注,店铺ID,顾客实付金额

数据:nc01,No.1店,76251827001620728973,240717122792949626,M2024071715302786271,微信,10.00,0.02,2024-07-17 15:28:43,,125,水费,,1,10.00

字段说明:

字段名称

说明

商户号

店铺编号、机构ID或抽佣方外部编号

商户名称

店铺名称、机构名称或抽佣方账户名称

交易订单号

数字营销系统订单号

渠道订单号

支付系统订单号

商户订单号

商户订单号

支付类型

银行卡、微信、支付宝、云闪付、现金、全抵扣

收款金额

商户收款金额(在一笔订单中拆分出该商户的收款金额),如反交易为负值,单位元

手续费

反交易为负值,单位元

支付时间

格式:yyyy-MM-dd HH:mm:ss

终端号

 

财务科目ID

业务方自定义ID(如果为分账方时,显示收款账务科目)

财务科目名称

业务方自定义科目名称

备注

 

店铺ID

店铺ID、机构ID或抽佣方账户ID

顾客实付金额

单位元

 

3.19 根据授权码(付款码)获取用户ID

接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/apiweb/unitorder/authcodetouserid

测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/apiweb/unitorder/authcodetouserid

使用场景:

通过微信付款码换取openid。

通过银联userAuth的code(非付款码)换取userid。

请求参数

字段ID

字段名称

取值

可空

最大长度

备注

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

服务商appid调用时必填

cusid

商户号

实际交易的店铺ID

11

 

version

版本号

接口版本号

2

默认填11

randomstr

随机字符串

商户自行生成的随机字符串

32

 

authcode

授权码

 

32

 

authtype

授权码类型

01-微信付款码

02-银联userAuth

2

 

identify

云闪付UA标识

当authtype=02时选送

32

当APP为云闪付时,默认送空。如为其他云闪付系APP,如京东金融,商业银行APP,按照银联要求送对应UA标识

sub_appid

微信支付appid

 

16

针对01有效

signtype

签名方式

 

8

RSA、SM2

sign

签名

 详见安全规范

32

 

 

响应参数

字段ID

字段名称

取值

可空

最大长度

备注

retcode

返回码

SUCCESS/FAIL

8

 

retmsg

返回码说明

 

100

 

以下信息只有当retcode为SUCCESS时有返回

cusid

商户号

实际交易的店铺ID

15

 

 

appid

应用ID

平台分配的APPID

8

 

 

acct

支付平台用户标识

01微信openid

02银联userid

32

 

 

sign

签名

 详见安全规范

32

 

 

3.20 资金管理提现通知

  1. 在10 资金管理提现接口中,直接返回的失败,将不会发起通知
  2. 注意:因为以后可能会增加通知参数,请获取全量变量,然后遍历获取非空变量,而不能用getparam(“key”),这样用文档中的字段名来一个个获取,到时候数字营销平台增加通知字段,就无法兼容了。请参考demo。
  3. 通知的每一个字段都会进行UTF-8的UrlEncode,如果商户接收结果的服务器用web容器进行接收,例如TOMCAT,IIS。则无需进行URLDecode,如果不是用web容器进行接收,而是读数据流自己进行解析,则需要进行UTF-8的UrlDecode。

 

以java为例:
String trxreserve = "订购人+10086";
String sendData = URLEncoder.encode(trxreserve, "UTF-8");
String getData = URLDecoder.decode(sendData, "UTF-8");

  1. 通知响应结果:
    商户服务端在接收到结果通知并正确处理后,应响应消息。正确处理响应success,其他响应或者不响应通联开发平台则通过重发机制进行重发,重发次数为16次。(通知频率为10s/30s/1m/2m/3m/4m/5m/6m/7m/8m/9m/10m/20m/30m/1h/2h)

    对后台通知交互时,如果通联收到商户的应答不符合规范或超时,通联认为通知失败,通联会通过一定的策略定期重新发起通知,尽可能提高通知的成功率,但通联不保证通知最终能成功。

字段ID

字段名称

取值

可空

最大长度

备注

cusid

商户号

店铺ID

分佣方Id

_platform_

11

 

externalCode

外部商户号

店铺编号

外部分佣方编号

30

 

appid

应用ID

平台分配的APPID

20

 

reqsn

提现申请单号

 

20

 

withdrawTId

提现流水编号

 

11

通联返回的提现交易流水号

accountUserId

账户Id

 

11

 

accountSetNo

账户集编号

100001,余额户

2000000,营销户

8

 

referenceType

账户来源

11,大B

13,店铺

49,外部分佣方

 

2

 

shopName

店铺名

 

50

 

accountName

账户名称

 

200

 

withdrawAmount

提现金额

单位:分

15

实际到账金额

fee

手续费

单位:分

15

提现手续费

withdrawStatus

提现状态

2,交易成功

3,提现失败

2

 

withdrawStatusDesc

提现状态描述

2,交易成功

3,提现失败原因

100

 

signtype

签名类型

 

4

支持MD5、RSA、SM2

sign

签名

 

32

详见安全规范

 

3.21 分账/收款确认

接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/apiweb/delay/split/confirm

测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/apiweb/delay/split/confirm

使用场景:对接口3.1统一扫码、3.6订单生成、3.8统一支付上送字段splitflag值为3时,必须调用此接口完成分账/收款的入账确认。一笔交易可以调用多次进行分账/收款确认。接口调用返回成功后,需要调用3.22分账/收款确认结果查询接口获取分账/收款确认结果。

3.8统一支付接口支付类型为W11时,需用户在微信侧“确认收货”后,微信侧才释放资金参与结算,才可调用此接口进行分账/收款确认。

该接口不支持阶梯分账(可正常收款,但不执行阶梯分账规则)。

请求参数

字段ID

字段名称

取值

可空

最大长度

备注

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

服务商appid调用时必填

cusid

商户号

实际交易的店铺ID

11

 

version

版本号

接口版本号

2

默认填11

randomstr

随机字符串

商户自行生成的随机字符串

32

 

trxamt

分账金额

单位为分

15

 

reqsn

分账子订单号

 

64

须保证在一笔交易中各分账单号唯一。如果是支付接口上送的分账子订单号,则按支付接口上送的参数进行分账;如果非支付接口上送的分账子订单号,则按本接口上送的参数进行分账

splitidtype

分账主体类型

 

2

分账确认时使用。0-机构,3-分账方。

非支付接口上送的子订单时必填

splitid

分账主体ID

 

11

非支付接口上送的子订单且分账主体类型上送3时必填

remark

备注

 

50

 

origreqsn

原商户交易单号

 

64

 

signtype

签名方式

 

8

支持MD5、RSA、SM2,不填默认MD5

sign

签名

详见安全规范

32

 

 

响应参数

字段ID

字段名称

取值

可空

最大长度

备注

retcode

返回码

SUCCESS/FAIL

8

此字段是通信标识,非交易结果,交易是否成功需要调用3.22分账/收款确认结果查询接口进行查询

retmsg

返回码说明

 

100

 

以下信息只有当retcode为SUCCESS时有返回

cusid

商户号

实际交易的店铺ID

11

 

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

 

reqsn

分账子单号

 

64

 

randomstr

随机字符串

随机生成的字符串

32

 

trxamt

分账/收款金额

 

15

单位:分

fee

手续费

 

15

单位:分

signtype

签名类型

 

6

 

sign

签名

 

32

详见安全规范

 

3.22 分账/收款确认结果查询

接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/apiweb/delay/split/confirm/query/status

测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/apiweb/delay/split/confirm/query/status

使用场景:查询3.21分账/收款确认的结果

请求参数

字段ID

字段名称

取值

可空

最大长度

备注

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

服务商appid调用时必填

cusid

商户号

实际交易的店铺ID

11

 

version

版本号

接口版本号

2

默认填11

randomstr

随机字符串

商户自行生成的随机字符串

32

 

reqsn

分账子单号

3.21分账确认接口的reqsn

64

 

origreqsn

原商户交易单号

 

64

 

signtype

签名方式

 

8

支持MD5、RSA、SM2,不填默认MD5

sign

签名

详见安全规范

32

 

 

响应参数

字段ID

字段名称

取值

可空

最大长度

备注

retcode

返回码

SUCCESS/FAIL

8

此字段是通信标识,非交易结果,交易是否成功需要查看splitstatus来判断

retmsg

返回码说明

 

100

 

以下信息只有当retcode为SUCCESS时有返回

cusid

商户号

实际交易的店铺ID

11

 

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

 

randomstr

随机字符串

随机生成的字符串

32

 

reqsn

分账子订单号

 

64

 

splitstatus

分账/收款状态

 

2

1-处理中,2-分账/收款成功,3-分账/收款失败

errmsg

错误信息

分账失败原因

100

 

trxamt

分账/收款金额

 

15

单位:分

fee

手续费

分账的手续费

15

单位:分

signtype

签名类型

 

6

 

sign

签名

 

32

详见安全规范

 

3.23 资金管理转账通知

  1. 在12 资金管理转账接口中,直接返回的失败,将不会发起通知
  2. 注意:因为以后可能会增加通知参数,请获取全量变量,然后遍历获取非空变量,而不能用getparam(“key”),这样用文档中的字段名来一个个获取,到时候数字营销平台增加通知字段,就无法兼容了。请参考demo。
  3. 通知的每一个字段都会进行UTF-8的UrlEncode,如果商户接收结果的服务器用web容器进行接收,例如TOMCAT,IIS。则无需进行URLDecode,如果不是用web容器进行接收,而是读数据流自己进行解析,则需要进行UTF-8的UrlDecode。

 

以java为例:
String trxreserve = "订购人+10086";
String sendData = URLEncoder.encode(trxreserve, "UTF-8");
String getData = URLDecoder.decode(sendData, "UTF-8");

  1. 通知响应结果:
    商户服务端在接收到结果通知并正确处理后,应响应消息。正确处理响应success,其他响应或者不响应通联开发平台则通过重发机制进行重发,重发次数为16次。(通知频率为10s/30s/1m/2m/3m/4m/5m/6m/7m/8m/9m/10m/20m/30m/1h/2h)

    对后台通知交互时,如果通联收到商户的应答不符合规范或超时,通联认为通知失败,通联会通过一定的策略定期重新发起通知,尽可能提高通知的成功率,但通联不保证通知最终能成功。

字段ID

字段名称

取值

可空

最大长度

备注

cusid

付款商户号

店铺ID

分佣方Id

_platform_

11

 

externalCode

付款商户外部商户号

店铺编号

外部分佣方编号

30

 

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

 

reqsn

转账申请单号

 

20

 

transferTId

转账流水编号

 

11

通联返回的转账交易流水号

accountUserId

付款账户Id

 

11

 

accountSetNo

付款账户集编号

100001,余额户

2000000,营销户

8

 

referenceType

付款账户来源

11,大B

13,店铺

49,外部分佣方

2

 

shopName

付款店铺名

 

50

 

accountName

付款账户名称

 

200

 

oppositionCusId

收款商户号

店铺ID

分佣方Id

_platform_

11

 

oppositionExternalCode

付款商户外部商户号

店铺编号

外部分佣方编号

30

 

oppositionAccountUserId

收款账户Id

 

11

 

oppositionAccountSetNo

收款账户集编号

100001,余额户

2000000,营销户

8

 

oppositionReferenceType

收款账户来源

11,大B

13,店铺

49,外部分佣方

 

2

 

oppositionShopName

收款店铺名

 

50

 

oppositionAccountName

收款账户名称

 

200

 

transferAmount

转账金额

单位:分

15

 

transferStatus

转账状态

1,转账中

2,交易成功

3,转账失败

2

 

transferStatusDesc

转账状态描述

1,转账中

2,交易成功

3,转账失败原因

100

 

remark

备注

 

100

 

signtype

签名类型

 

4

支持MD5、RSA、SM2

sign

签名

 

32

详见安全规范

 

3.24 资金管理批量转账

接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/apiweb/fund/batchTransfer

测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/apiweb/fund/batchTransfer

使用场景:开通了数字营销结算资金管理的商户,可以通过此接口发起批量转账。本接口如果返回的列表中,存在状态1-转账中,则需要通过批量查询接口查询最终状态。注意:调用批量转账接口的交易,如果调用3.13资金管理转账结果查询,只会返回一条记录;正确的是调用3.25资金管理批量转账结果查询接口

请求参数

字段ID

字段名称

取值

可空

最大长度

备注

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

服务商appid调用时必填

cusid

付款商户号

店铺ID

分佣方Id

_platform_

11

_platform_表示平台会员

reqsn

转账申请单号

 

20

保证商户平台唯一

oppositionList

收款方列表

JSONArray格式字符串

 

 

 

cusId

收款商户号

店铺ID

分佣方Id

_platform_

11

_platform_表示大B

不能跟付款方cusid相同

 

transferAmount

转账金额

单位:分

15

 

 

remark

备注

 

100

 

notifyUrl

转账结果通知地址

 

300

设置该地址后,转账成功或者失败将发起通知

注意:本请求中响应列表直接返回失败的收款方,没有通知

version

版本号

接口版本号

2

默认填11

randomstr

随机字符串

随机生成的字符串

32

 

signtype

签名类型

 

8

支持MD5、RSA、SM2,不填默认MD5

sign

签名

 

32

详见安全规范

 

响应参数

字段ID

字段名称

取值

可空

最大长度

备注

retcode

返回码

SUCCESS/FAIL

8

此字段是通信标识,非交易结果,交易是否成功需要查看transferStatus和结果查询接口返回transferStatus来判断

retmsg

返回码说明

 

100

 

以下信息只有当retcode为SUCCESS时有返回

cusid

付款商户号

店铺ID

分佣方Id

_platform_

11

 

externalCode

付款商户外部商户号

店铺编号

外部分佣方编号

30

 

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

 

reqsn

转账申请单号

 

20

 

transferTId

转账流水编号

 

11

通联返回的转账交易流水号

accountUserId

付款账户Id

 

11

 

accountSetNo

付款账户集编号

100001,余额户

2000000,营销户

8

 

referenceType

付款账户来源

11,大B

13,店铺

49,外部分佣方

 

2

 

shopName

付款店铺名

 

50

 

accountName

付款账户名称

 

200

 

oppositionList

收款方列表

JSONArray格式字符串

 

 

 

cusId

收款商户号

店铺ID

分佣方Id

_platform_

11

 

 

externalCode

付款商户外部商户号

店铺编号

外部分佣方编号

30

 

 

accountUserId

收款账户Id

 

11

 

 

accountSetNo

收款账户集编号

100001,余额户

2000000,营销户

8

 

 

referenceType

收款账户来源

11,大B

13,店铺

49,外部分佣方

 

2

 

 

shopName

收款店铺名

 

50

 

 

accountName

收款账户名称

 

200

 

 

transferAmount

转账金额

单位:分

15

 

 

transferStatus

转账状态

1,转账中

3,转账失败

2

 

 

transferStatusDesc

转账状态描述

1,转账中

3,转账失败原因

100

 

 

remark

备注

 

100

 

signtype

签名类型

 

4

支持MD5、RSA、SM2

sign

签名

 

32

详见安全规范

 

3.25 资金管理批量转账结果查询

接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/apiweb/fund/batchTransferResultQuery

测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/apiweb/fund/batchTransferResultQuery

使用场景:开通了数字营销结算资金管理的商户,可以通过此接口发起提现。本接口如果返回的状态是1-提现中,则需要通过查询接口查询最终状态。

请求参数

字段ID

字段名称

取值

可空

最大长度

备注

appid

应用ID

平台分配的APPID

20

 

orgid

机构ID

实际交易的机构ID

11

服务商appid调用时必填

cusid

付款商户号

店铺ID

分佣方Id

_platform_

11

_platform_表示平台会员

reqsn

转账申请单号

 

20

保证商户平台唯一

version

版本号

接口版本号

2

默认填11

randomstr

随机字符串

随机生成的字符串

32

 

signtype

签名类型

 

8

支持MD5、RSA、SM2,不填默认MD5

sign

签名

 

32

详见安全规范

 

响应参数

字段ID

字段名称

取值

可空

最大长度

备注

 

retcode

返回码

SUCCESS/FAIL

8

此字段是通信标识,非交易结果,交易是否成功需要查看transferStatus来判断

 

retmsg

返回码说明

 

100

 

 

以下信息只有当retcode为SUCCESS时有返回

 

cusid

付款商户号

店铺ID

分佣方Id

_platform_

11

 

 

externalCode

付款商户外部商户号

店铺编号

外部分佣方编号

30

 

 

appid

应用ID

平台分配的APPID

20

 

 

orgid

机构ID

实际交易的机构ID

11

 

 

reqsn

转账申请单号

 

20

 

 

transferTId

转账流水编号

 

11

通联返回的转账交易流水号

 

accountUserId

付款账户Id

 

11

 

 

accountSetNo

付款账户集编号

100001,余额户

2000000,营销户

8

 

 

referenceType

付款账户来源

11,大B

13,店铺

49,外部分佣方

2

 

 

shopName

付款店铺名

 

50

 

 

accountName

付款账户名称

 

200

 

 

oppositionList

收款方列表

JSONArray格式字符串

 

 

 

cusId

收款商户号

店铺ID

分佣方Id

_platform_

11

 

 

 

externalCode

付款商户外部商户号

店铺编号

外部分佣方编号

30

 

 

 

accountUserId

收款账户Id

 

11

 

 

 

accountSetNo

收款账户集编号

100001,余额户

2000000,营销户

8

 

 

 

referenceType

收款账户来源

11,大B

13,店铺

49,外部分佣方

 

2

 

 

 

shopName

收款店铺名

 

50

 

 

 

accountName

收款账户名称

 

200

 

 

 

transferAmount

转账金额

单位:分

15

 

 

 

transferStatus

转账状态

1,转账中

2,交易成功

3,转账失败

2

 

 

 

transferStatusDesc

转账状态描述

1,转账中

2,交易成功

3,转账失败原因

100

 

 

 

remark

备注

 

100

 

 

signtype

签名类型

 

4

支持MD5、RSA、SM2

 

sign

签名

 

32

详见安全规范

 

卜子超buzc 2025年4月1日 09:24 收藏文档