2.1交易

1.小程序下单

使用场景：

用户在业务系统下单，业务系统获取了订单信息后，根据业务系统的具体应用环境（小程序、APP或H5），使用本接口下方对应的调用方法将相关参数传入并拉起通企付小程序，通企付小程序负责渠道下单支付，并返回交易结果。

请求参数：

参数名	必选	类型	说明
orgId	否	string	服务商id，用于服务商代发起交易，传了此参数需要用服务商密钥进行加签
mchNo	是	string	通企付商户号，示例：E249974037860
appId	是	string	默认为企业appId，若为服务商模式，需传入服务商appId
reqTime	是	string	请求时间，13位时间戳
version	是	string	版本（默认为1.0）
sign	是	string	签名
signType	是	string	签名类型（MD5/RSA/SM2）
mchOrderNo	是	string	商户订单号
amount	是	string	金额（单位：分）
body	是	string	商品描述
goodsInfo	否	string	商品备注，JSONArray格式，例如：goodsInfo=[{"goodsnm":"TEST_PAY", "goodsnum":"1", "goodsamt":"2"}]，使用B2B订单支付、微企付、新网银行转账时必填
notifyUrl	否	string	通知地址
expiredTime	否	int	订单失效时间,单位秒,默认1小时.订单在(创建时间+失效时间)后失效
extParam	否	string	备注，商户扩展参数，支付结果通知原样返回
channelExtra	否	string	渠道参数，JSON字符串，特定渠道的额外参数，如: 1、收银宝子商户号cusid,集团商户号orgid。示例：channelExtra={"orgid":"66045xxxxx","cusid":"66046xxxxxxx"}； 2、云闪付国补必填字段有： truename：付款人姓名 idno：付款人证件号 extendparams：渠道活动参数,云闪付营销活动字段名为discountCode：场景数据，示例：channelExtra={"truename":"张三", "idno": "310xxxx3625", "extendparams":{"discountCode":"SXEJDS"}； 3、使用转账汇款时，merUserId：商户用户标识，选填，转账时的收款账号与该字段一一对应
payTypeInfo	否	string	收银台展示的付款方式，多个以英文逗号(,)隔开； WX_PAY：微信 ALI_PAY：支付宝 YSF_PAY：云闪付 C_PAY：个人银行卡 B_PAY：企业网银 JD_PAY：白条分期 ALI_CREDIT_PAY：花呗分期 FME_PAY：富民e贷 ZZHK_PAY：转账汇款 SHARE_PAY:找好友付款
directPayType	否	string	直接支付的支付方式，仅支持上送一种支付方式，填入该参数则自动使用该支付方式下单并拉起支付，当前支持： WX_LITE：微信小程序支付 XW_HRJ：新网汇入金 ALI_QR：支付宝支付（访问通企付微信小程序收银台可用） ALI_JSAPI：支付宝JS支付（访问通企付支付宝小程序收银台可用） ALI_CREDIT：花呗分期

goodsInfo参数名	必选	类型	说明
goodsnm	是	string	商品简称
goodsamt	否	string	商品金额（单位：元）
goodsnum	否	string	商品数量

响应参数

参数名	类型	说明
code	string	success：支付成功；pending：支付中 cancel：取消支付；fail：支付失败
msg	string	响应内容（当code为cancel、fail有值）
mchOrderNo	string	商户订单号
amount	string	金额
mchNo	string	商户号
mchName	string	商户名称

注意：调用示例，示例仅展示部分字段，具体字段自行根据业务需求填写

通企付微信小程序收银台跳转

小程序收银台原始 ID：gh_4fa331e708fb 小程序收银台 appId：wxe48aedff31caaf2d

客户小程序调起通企付小程序收银台

wx.openEmbeddedMiniProgram({
          appId: "wxe48aedff31caaf2d",
		  path:"pages/index/index",
          extraData:{
            // 拼写请求参数,示例如下：
			"orgId":"V1711446800"
			"appId":"66384647e4b0148f4bb07829",
			"mchNo":"E249974037860",
			"reqTime":"1715400619147",
			"version":"1.0",
			"signType":"MD5"
          },
          success: function (res) {
            console.log("成功回调返回的res：" + JSON.stringify(res))
          },
          fail: function (res) {
            console.log("失败回调返回的res：" + JSON.stringify(res))
          },
          complete: function () {
            console.log("完成调用")
          }
        })

通过上述方法会调起收银台半屏小程序，在收银台中完成支付后，会回调支付结果，具体结果可以在小程序生命周期Page.onShow中通过以下方式获取：

onShow: function () {
let options = wx.getEnterOptionsSync();
if (options.scene == '1038' &&
options.referrerInfo.appId=='wxe48aedff31caaf2d') {
// 代表从收银台小程序返回
let extraData = options.referrerInfo.extraData;
if (!extraData) {
// "当前通过物理按键返回，未接收到返参，建议自行查询交易结果";
} else {
if (extraData.code == 'success') {
// "支付成功";
} else if (extraData.code == 'cancel') {
// "支付已取消";
} else {
// "支付失败：" + extraData.errmsg;
}
}
}
}

客户APP调起通企付小程序收银台

Android开发示例：

https://developers.weixin.qq.com/doc/oplatform/Mobile_App/Launching_a_Mini_Program/Android_Development_example.html

iOS开发示例：

https://developers.weixin.qq.com/doc/oplatform/Mobile_App/Launching_a_Mini_Program/iOS_Development_example.html

调起方式如上文档，这里展示部分字段，具体字段自行根据业务需求填写

path=pages/index/index?mchNo=平台分配的商户号&appId=平台分配的应用ID&reqTime=请求时间&version=1.0&sign=签名&signType=MD5&mchOrderNo=商户唯一订单号&amount=金额&expiredTime=失效时间&body=描述

客户微信环境H5调起通企付小程序收银台

微信环境前端h5拉起小程序的能力可以参考微信官方文档: https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_Open_Tag.html JS-SDK引入的初始化步骤详见上诉文档，具体下单业务字段根据业务需求填写在path后面

<wx-open-launch-weapp
  appId: "wxe48aedff31caaf2d"
  path="pages/index/index?key1=value1&key2=value2&key3=value3"   
>
  <script type="text/wxtag-template">
    <style>.btn { padding: 12px }</style>
    <button class="btn">打开小程序</button>
  </script>
</wx-open-launch-weapp>

通企付支付宝小程序收银台跳转

小程序收银台appId: 2021004162658199

客户小程序调起通企付小程序收银台

my.navigateToMiniProgram({
		appId: '2021004162658199',
		path: 'pages/index/index',
		extraData: {
			mchNo: "平台分配的商户号",
			appId: "平台分配的应用ID",
			reqTime: "请求时间",
			version: "1.0",
			sign: "签名",
			signType:"MD5",
			mchOrderNo: "商户唯一订单号",
			notifyUrl: "服务器异步通知页面路径",
			expiredTime: "失效时间",
			body: "描述",
		}
	})

通过上述方法会调起收银台小程序，在收银台中完成支付后，会回调支付结果，具体结果可以在小程序生命周期Page.onShow中通过以下方式获取：

onShow: function () {
	let options = my.getEnterOptionsSync();
	if (options.scene == '1038' &&
	options.referrerInfo.appId=='2021004162658199') {
		// 代表从收银台小程序返回
		let extraData = options.referrerInfo.extraData;
		if (extraData.code == 'success') {
			// "支付成功";
		} else if (extraData.code == 'cancel') {
			// "支付已取消";
		} else {
			// "支付失败：" + extraData.errmsg;
		}
	}
}

特殊说明：一般情况下my.getEnterOptionsSync()中获取的extraData为收银台小程序返回的支付结果，但是当通过物理返回键返回（即未通过收银台小程序内按钮返回），extraData内容会为空，调用方小程序会无法获得支付结果，该情况为支付宝小程序特性，小程序代码无法处理。如遇到该情况，需要自行添加标记位判断是否跳到收银台返回，再自行查询订单支付结果

客户APP调起通企付小程序收银台 先将下单参数转换成json字符串，json转换方式可自行选择将下单参数json组装成query参数格式，并进行urlencode后拼接进跳转schemeurl 示例代码如下，此处仅展示部分字段：

String json = "{
	\"mchNo\": \"平台分配的商户号\",
	\"appId\": \"平台分配的应用ID\",
	\"reqTime\": \"请求时间\",
	\"version\": \"1.0\",
	\"sign\": \"签名\",
	\"signType\": \"MD5\",
	\"mchOrderNo\": \"商户唯一订单号\",
	\"notifyUrl\": \"服务器异步通知页面路径\",
	\"expiredTime\": \"失效时间\",
	\"body\": \"描述\"
}";

String query = URLEncoder.encode("payinfo=" + URLEncoder.encode(json, "UTF-8"), "UTF-8");
String url =
"alipays://platformapi/startapp?appId=2021004162658199&page=pages/index/index&thirdPartSchema="
+  URLEncoder.encode("APP接收跳转的schemeurl", "UTF-8")
+ "&query=" + query;

其中thirdPartSchema是app接收跳转的scheme，该字段需要urlencode，其中下单参数按照上述方式组装，共需要两次urlencode

特殊说明：

小程序回调APP结果说明：小程序回调是支付宝通过thirdPartSchema带参跳转APP，APP再通过协议获取具体字段参数，其中支付宝进行跳转时是直接在thirdPartSchema后拼接backfromalipay? errmsg=结果信息&code=结果码，如thirdPartSchema为 “allinpaysdk://sdk/”，则app接收的schemeurl为“allinpaysdk://sdk/backfromalipay?errmsg=结果信息&code=结果码”。

故建议：

1、 thirdPartSchema定义中不要自带参数，如要自带参数，则需要自行通过支付宝返回的schemeurl分割处理获取所需字段，以免报错或者获取不到字段；

2、 thirdPartSchema字段值以“/”结尾，如“allinpaysdk://sdk/”，而不是“allinpaysdk://sdk”

3、 thirdPartSchema字段如果未指定路径，则需要带上“://”，如“allinpaysdk://”

小程序回调app是通过schemeurl跳回app的，会带上code、errmsg参数，但是该回调仅限于在小程序内点击按钮返回APP时有效，但是当通过物理返回键返回APP、任务列表切换回APP即未通过收银台小程序内按钮退出，该回调并不会触发，该情况为支付宝小程序特性，小程序代码无法处理。

如遇到该情况，建议在APP跳转小程序时新建变量保存跳转标识，在APP内监听到重新打开APP且标志存在，则需要自行查询订单支付结果

客户H5调起通企付小程序收银台

第一步：先将下单参数转换成json字符串，json转换方式可自行选择

第二步：MD5加签可以省略此步骤,RSA及SM2加签模式下需要进行下面步骤：

1、将json字符串中的sign值转换为URL安全格式，转换方式：String SafeSign = sign.replace('+','-')

2、对转换后的安全格式的sign值进行URLencode操作：String urlSign = URLEncoder.encode(SafeSign)

第三步：将下单参数json整体加在payinfo=的后面进行urlencode：alipays://platformapi/startApp?appId=2021004162658199&page=pages/index/index&query=payinfo=+json字符串

第四步：把第三步urlencode的参数加在https://ds.alipay.com/?scheme=的后面组成打开支付宝的支付链接拼装完成的示例：https://ds.alipay.com/?scheme=alipays%3A%2F%2Fplatformapi%2FstartApp%3FappId%3D2021004162658199%26page%3Dpages%2Findex%2Findex%26query%3Dpayinfo%3D%7B%22amount%22%3A%221%22%2C%22mchOrderNo%22%3A%222672f8361b1f4caa8a5f9f756edc8aa7%22%2C%22appId%22%3A%2266e13fb04bb6abfc8dfaf14b%22%2C%22sign%22%3A%22F492FEB46D2245E218D17F1F06029D57%22%2C%22signType%22%3A%22MD5%22%2C%22reqTime%22%3A%221730448570058%22%2C%22directPayType%22%3A%22ALI_JSAPI%22%2C%22body%22%3A%22%E6%8F%8F%E8%BF%B0%22%2C%22mchNo%22%3A%22E243596727039%22%2C%22version%22%3A%221.0%22%7D

String json = "{
	\"mchNo\": \"平台分配的商户号\",
	\"appId\": \"平台分配的应用ID\",
	\"reqTime\": \"请求时间\",
	\"version\": \"1.0\",
	\"sign\": \"签名\",
	\"signType\": \"MD5\",
	\"mchOrderNo\": \"商户唯一订单号\",
	\"notifyUrl\": \"服务器异步通知页面路径\",
	\"expiredTime\": \"失效时间\",
	\"body\": \"描述\"
}";

String query = URLEncoder.encode("alipays://platformapi/startApp?appId=2021004162658199&page=pages/index/index&query=payinfo=" + json.toString);
String url ="https://ds.alipay.com/?scheme=" + query;

2.统一下单（API）

使用场景：

业务系统无需使用通企付小程序收银台，通过此接口指定支付方式，直接向通企付请求下单并完成支付

请求URL：

/pay/unifiedOrder

请求方式：

POST

请求类型：

application/json

请求参数：

参数名	必填	类型	描述	示例值
mchNo	是	String(30)	商户号
appId	是	String(24)	应用ID
orgId	否	String(24)	服务商号
reqTime	是	String	请求接口时间,13位时间戳
version	是	String(3)	接口版本号，固定：1.0
sign	是	String(32)	签名值，详见签名算法
signType	是	String(32)	签名类型	MD5/RSA/SM2
mchOrderNo	是	String(30)	商户订单号，商户系统唯一
wayCode	是	String(30)	支付方式	参考[附录1.支付方式说明](https://www.showdoc.com.cn/tppay/11558416485859331 "附录1.支付方式说明")
amount	是	String	支付金额，单位分
currency	是	String(3)	三位货币代码，人民币:cny	cny
clientIp	否	String(32)	客户端IPV4地址	wayCode为JDBT_PAY、YT_PAY必传
body	是	String(100)	商品描述
notifyUrl	否	String(128)	异步通知地址，支付结果异步回调URL
returnUrl	否	String(128)	支付结果同步跳转通知URL	不允许带参数
expiredTime	否	int	订单失效时间,单位秒,默认1小时.订单在(创建时间+失效时间)后失效	3600
channelExtra	否	String(512)	渠道参数，特定渠道发起的额外参数(json字符串)	openid:用户标识 subAppid:微信公众号/小程序appid
extParam	否	String(512)	备注，商户扩展参数,回调时会原样返回

响应参数：

参数名	必填	类型	描述	示例值
code	是	String	返回码	0：处理成功 9999：自定义业务异常 4000：用户名/密码错误 10：系统异常
msg	否	String(128)	返回信息，具体错误原因，例如：签名失败、参数格式校验错误
sign	否	String(32)	签名信息，对data内数据签名,如data为空则不返回
data	否	Json	返回下单数据,json格式数据

data数据格式

参数名	必填	类型	描述	示例值
payOrderId	是	String(30)	通企付订单号
mchOrderNo	是	String(30)	商户订单号
orderState	是	int	支付订单状态 · 0-订单生成 · 1-进行中 · 2-支付成功 · 3-支付失败 · 4-已撤销 · 5-已退款 · 6-订单关闭 · 7-预消费支付成功
payDataType	否	String	支付数据类型
wayCode	否	String	支付方式
payData	否	String	发起支付用到的支付参数
errCode	否	String	上游渠道返回的错误码
errMsg	否	String	上游渠道返回的错误描述

3.获取小程序链接

使用场景：

业务系统在外部浏览器生成订单参数，获取访问通企付小程序的链接，用户通过对应链接打开通企付小程序收银台，通企付收银台小程序负责渠道下单支付，并返回交易结果。

请求URL：

applet/getAppletUrl

请求方式：

POST

请求类型：

application/json

请求参数：

参数名	必选	类型	说明
orgId	否	String	服务商id，用于服务商模式，传了此参数需要用服务商秘钥进行验签
mchNo	是	String	商户号
appId	是	String	应用ID，默认为商户appId，若为服务商模式，需传入服务商appId
reqTime	是	String	请求时间，13位时间戳
version	是	String	接口版本，固定：1.0
sign	是	String	签名
signType	是	String	签名类型，MD5/RSA/SM2
mchOrderNo	是	String	商户订单号
amount	是	String	金额（单位：分）
body	是	String	描述
goodsInfo	否	String	商品备注，JSONArray格式，例如：goodsInfo=[{“goodsnm”:”TEST_PAY”,”goodsnum”:”1”,”goodsamt”:”2”}]，使用B2B订单支付、微企付、新网银行转账时必填
notifyUrl	否	String	通知地址
validTime	否	int	链接有效期，单位秒，不传默认120秒，最小120秒，最大支持72小时
expiredTime	否	int	订单有效期,单位秒,默认1小时
extParam	否	String	备注，商户扩展参数，回调时原样返回
channelExtra	否	String	渠道参数，JSON字符串，特定渠道发起的额外参数，如：1、收银宝子商户号cusid,集团商户号orgid,微信appid即subAppid。示例： channelExtra={"orgid":"66045xxxxx", "cusid":"66046xxxxxxx", "subAppid":"xxxxx"}； 2、云闪付国补必填字段有：truename：付款人姓名 idno：付款人证件号 extendparams：渠道活动参数，云闪付营销活动字段名为discountCode：场景数据，示例：channelExtra={"truename":"张三", "idno":"310xxxx3625", "extendparams":{"discountCode":"SXEJDS"}；3、使用转账汇款时，merUserId：商户用户标识，选填，转账时的收款账号与该字段一一对应
payTypeInfo	否	String	收银台展示的付款方式，多个以英文逗号(,)隔开；WX_PAY（微信）, ALI_PAY（支付宝）,YSF_PAY（云闪付）,C_PAY（个人银行卡）,B_PAY（企业网银）,JD_PAY（白条分期）,ALI_CREDIT_PAY（花呗分期）,SHARE_PAY(找好友付款)
directPayType	否	String	直接支付的支付方式，仅支持上送一种支付方式，填入该参数则自动使用该支付方式下单并拉起支付，当前支持： WX_LITE：微信小程序支付； XW_HRJ：新网汇入金； ALI_QR：支付宝支付（访问通企付微信小程序收银台可用）； ALI_JSAPI：支付宝JS支付（访问通企付支付宝小程序收银台可用）； ALI_CREDIT：花呗分期
urlType	是	String	生成链接方式，URL_Common（返回appletUrl字段值需要业务系统转化为二维码后，由用户使用微信或支付宝扫码完成支付。此生成链接方式，适用于用户在PC端下单、手机扫码完成支付的场景）

goodsInfo参数名	必选	类型	说明
goodsnm	是	string	商品简称
goodsamt	否	string	商品金额（单位：元）
goodsnum	否	string	商品数量

返回参数

参数名	必选	类型	说明
code	是	String	返回状态：0-处理成功，9999-异常，具体错误详见msg字段
msg	否	String	返回信息：具体错误原因，例如：签名失败、参数格式校验错误
sign	否	String	签名信息：对data内数据签名，如data为空则不返回
data	否	String	返回数据：json格式数据

data数据格式

参数名	必选	类型	说明
appletUrl	是	String	访问路径，该字段值需要业务系统转化为二维码后，由用户使用微信或支付宝扫码完成支付。
urlType	是	String	生成链接方式，URL_Common（该链接支持访问微信、支付宝小程序）

返回示例：

{ "code": 0, "data": { "appletUrl": "https://wxaurl.cn/xxxxx";, "urlType": "URL_Common" }, "msg": "SUCCESS", "sign": "713B50182CAFC8B7B71CEE94D1D0A1B7" }

4.统一订单查询

简要描述：

支持查询支付订单、提现订单的状态

请求URL：

/pay/query

请求方式：

POST

请求类型：

application/json

参数：

参数名	必选	类型	说明
orgId	否	string	服务商id，用于服务商代发起交易，传了此参数需要用服务商秘钥进行加签
mchNo	是	String(30)	商户号
appId	是	String(24)	应用ID，默认为商户appId，若为服务商模式，需传入服务商appId
reqTime	是	String(13)	请求时间，13位时间戳
version	是	String(3)	接口版本，固定：1.0
sign	是	String(32)	签名
signType	是	String(32)	签名类型，MD5/RSA/SM2
mchOrderNo	是	String(30)	商户订单号，与payOrderId二者传一即可，针对采用统一下单接口且支付方式为微信预消费和微信B2B门店助手的订单，建议使用商户订单号发起查询
payOrderId	是	String(30)	支付订单号，与mchOrderNo二者传一即可
busiType	否	String(30)	业务类型，不传默认为1： 1-支付订单查询 4-提现订单查询 5-转账订单查询

返回参数

参数名	必选	类型	说明
code	是	String	返回状态：0-处理成功，9999-异常，具体错误详见msg字段
msg	否	String(128)	返回信息：具体错误原因，例如：签名失败、参数格式校验错误
sign	否	String(32)	签名信息：对data内数据签名，如data为空则不返回
data	否	Json	返回数据：json格式数据

data数据格式

参数名	必选	类型	说明
mchNo	是	String(30)	商户号
appId	是	String(24)	应用ID
payOrderId	是	String(30)	支付订单号
mchOrderNo	是	String(30)	商户订单号
ifCode	是	String(30)	支付接口
wayCode	是	String(30)	支付方式: WX_LITE：微信小程序支付; SFT_HRJ：通联汇入金； ALI_JSAPI：支付宝JS支付； ALI_QR：支付宝主扫； GOV_B2BC_TRADE：转账汇款； B2B_ORDER：收银宝B2B订单； GATEWAY_PC：PC网关； ALI_CREDIT：花呗分期； WX_TRANS：微信预消费； WX_B2B：微信B2B门店助手； SYB_B2C_WECHAT：微信小程序收银台支付
amount	是	int	支付金额，单位分
currency	是	String(3)	货币代码，人民币:cny
state	是	int	订单状态： 0-订单生成 1-支付中 2-支付成功 3-支付失败 4-已撤销 5-已退款 6-订单关闭 7-预消费支付成功
clientIp	否	String(32)	客户端IP
body	是	String(256)	商品描述
channelOrderNo	否	String	外部渠道订单号，如：微信、支付宝的交易单号
payInterfaceOrderId	否	String	渠道订单号，如：收银宝的交易号
errCode	否	String	渠道错误码
errMsg	否	String	渠道错误描述
extParam	否	String(512)	扩展参数，回调时会原样返回
createdAt	是	long	订单创建时间，13位时间戳
successTime	否	long	订单支付成功时间，13位时间戳
rSuccessTime	否	long	订单退款成功时间,13位时间戳
channelFeeAmount	否	long	渠道返回的手续费，单位：分
channelUser	否	String	付款人账号
channelUserName	否	String	付款人户名
channelAcctType	否	String	账户类型 00-借记卡 02-信用卡 99-其他（花呗/余额等）
channelCusid	否	String	渠道商户号，格式：集团商户号-子商户号
channelBankCode	否	String	发卡行

5.关闭支付订单

请求URL：

/pay/close

请求方式：

POST

请求类型：

application/json

参数：

参数名	必选	类型	说明
orgId	否	string	服务商id，用于服务商代发起交易，传了此参数需要用服务商秘钥进行加签
mchNo	是	String(30)	商户号
appId	是	String(24)	应用ID，默认为商户appId，若为服务商模式，需传入服务商appId
reqTime	是	String(13)	请求时间，13位时间戳
version	是	String(3)	接口版本，固定：1.0
sign	是	String(32)	签名
signType	是	String(32)	签名类型，MD5/RSA/SM2
mchOrderNo	是	String(30)	商户订单号，与payOrderId二者传一即可
payOrderId	是	String(30)	支付订单号，与mchOrderNo二者传一即可

返回参数

参数名	必选	类型	说明
code	是	String	返回状态：0-处理成功，9999-异常，具体错误详见msg字段
msg	否	String(128)	返回信息：具体错误原因，例如：签名失败、参数格式校验错误
sign	否	String(32)	签名信息：对data内数据签名，如data为空则不返回
data	否	Json	返回数据：json格式数据

data数据格式

参数名	必选	类型	说明
errCode	否	String	渠道错误码
errMsg	否	String	渠道错误描述

6.统一退款

使用场景：

业务系统通过此接口完成订单退款，退款资金原路返回，支持部分退款。

请求URL：

/refund/refundOrder

请求方式：

POST

请求类型：

application/json

参数：

参数名	必选	类型	说明
orgId	否	string	服务商号，用于服务商代发起交易，传了此参数需要用服务商密钥进行加签
mchNo	是	String(30)	商户号
appId	是	String(24)	应用ID，默认为商户appId，若为服务商模式，需传入服务商appId
reqTime	是	String(13)	请求时间，13位时间戳
version	是	String(3)	接口版本，固定：1.0
sign	是	String(32)	签名
signType	是	String(32)	签名类型，MD5/RSA/SM2
mchRefundNo	是	String(30)	商户退款订单号，商户平台唯一
mchOrderNo	是	String(30)	商户订单号，与payOrderId二者传一即可，针对采用统一下单接口且支付方式为微信预消费和微信B2B门店助手的订单，建议使用商户订单号发起退款
payOrderId	是	String(30)	支付订单号，与mchOrderNo二者传一即可
refundAmount	是	int	渠道退款金额，单位分
currency	是	String(3)	货币代码，人民币:cny
refundReason	是	String(64)	退款原因
clientIp	否	String(32)	客户端IP
notifyUrl	否	String(128)	异步通知地址
channelExtra	否	String(256)	渠道参数，特定渠道发起的额外参数（进行分账退款时，必须上送分账退款信息，示例：{“divisionRefundInfo”:{“refundAmount”:0,“divisionBizMemNo”:“BF999xxxx0011”,“refundCouponAmount”:0,“refundInfoList”:[{“refundAmount”:0,“divisionBizMemNo”:“BF999xxxx0012”}]}}
extParam	否	String(512)	商户扩展参数，回调时会原样返回

divisionRefundInfo参数：

参数名	必选	类型	说明
divisionBizMemNo	是	String(30)	收款方商户会员编号
refundAmount	否	int	分账退款总金额，单位：分，非必填，客户上送了则以上送金额处理，客户未上送则通企付自行根据渠道退款金额进行计算处理。这个金额要大于等于抽佣退款金额与分账方退款金额的总和，超出部分为收款方退款金额。补充说明： 1、交易手续费为日结轧差的，此金额=本次渠道退款金额-退款退回手续费金额 2、交易手续费为月结后收或预收的，此金额=本次渠道退款金额
refundCouponAmount	否	int	抽佣退款金额，单位：分
refundInfoList	否	JSONArray	分账方退款金额列表
-divisionBizMemNo	是	String(30)	分账方商户会员编号
-refundAmount	是	int	分账方退款金额，单位：分

返回参数

参数名	必选	类型	说明
code	是	String	返回状态：0-处理成功，9999-异常，具体错误详见msg字段
msg	否	String(128)	返回信息：具体错误原因，例如：签名失败、参数格式校验错误
sign	否	String(32)	签名信息：对data内数据签名，如data为空则不返回
data	否	Json	返回数据：json格式数据

data数据格式

参数名	必选	类型	说明
refundOrderId	是	String(30)	退款订单号
mchRefundNo	是	String(30)	商户退款单号
payAmount	是	int	支付金额，单位分
refundAmount	是	int	退款金额，单位分
state	是	int	订单状态：0-订单生成 1-退款中 2-退款成功 3-退款失败 4-退款关闭 6-预消费退款
channelOrderNo	否	String	渠道退款单号
errCode	否	String	渠道错误码
errMsg	否	String	渠道错误描述

7.支付通知

简要描述：

支付结果异步通知接口，只有支付成功才会通知。注意：考虑到以后可能会增加通知参数，对接时请获取全量变量，然后遍历获取非空变量，而不能用文档中的字段名来一个个获取，否则后续通企付增加了通知字段，就无法兼容了。

请求URL：

该链接是通过下单接口提交的参数notifyUrl设置

请求方式：

POST

请求类型：

application/x-www-form-urlencoded

通知参数：

参数名	必选	类型	说明
orgId	否	string	服务商号
mchNo	是	String(30)	商户号
appId	是	String(24)	应用ID，默认为商户appId，若为服务商模式，需传入服务商appId
sign	是	String(32)	签名值
signType	否	String(32)	签名类型
payOrderId	是	String(30)	支付订单号
mchOrderNo	是	String(30)	商户订单号
ifCode	是	String(30)	支付接口
wayCode	是	String(30)	支付方式: WX_LITE：微信小程序支付; SFT_HRJ：通联汇入金； XW_HRJ：新网汇入金； ALI_JSAPI：支付宝JS支付； ALI_QR：支付宝主扫； B2B_ORDER：收银宝B2B订单； GATEWAY_PC：PC网关； ALI_CREDIT：花呗分期； JDBT_PAY：白条分期； SYB_B2C_WECHAT：微信小程序收银台支付; WX_TRANS：微信预消费； WX_B2B：微信B2B门店助手； FME_CPAY：富民e贷； QUICK_PAY：快捷支付； YW_PAY：云微支付； YT_PAY：云梯支付； H5_CASHIER：H5收银台
amount	是	int	实际支付成功金额，单位分
currency	是	String(3)	货币代码，人民币:cny
state	是	int	订单状态： 0-订单生成 1-支付中 2-支付成功 3-支付失败 4-已撤销 5-已退款 6-订单关闭 7-预消费支付成功只有支付成功才会发起异步通知
clientIp	否	String(32)	客户端IP
body	是	String(256)	商品描述
mchName	是	String(100)	商户名称
channelUser	否	String	付款人渠道用户标识,如微信openId, 支付宝账号，银行卡号
channelUserName	否	String	付款人户名
channelAcctType	否	String	账户类型 00-借记卡 02-信用卡 99-其他（花呗/余额等）
channelOrderNo	否	String	外部渠道订单号，如：微信或支付宝的交易单号
payInterfaceOrderId	否	String	渠道订单号，如：收银宝的交易号
channelFeeAmount	否	long	渠道返回的手续费，单位：分
channelCusid	否	String	渠道商户号，格式：集团商户号-子商户号
errCode	否	String	渠道错误码
errMsg	否	String	渠道错误描述
extParam	否	String(512)	商户扩展参数，原样返回
createdAt	是	long	订单创建时间，13位时间戳
successTime	否	long	订单支付成功时间，13位时间戳
reqTime	是	long	通知请求时间，13位时间戳
channelBankCode	否	String	发卡行

返回结果：

业务系统处理后同步返回给支付系统，返回字符串success 则表示成功，返回非success则表示处理失败。通知失败后，通企付会重新发起通知，最多重发5次，分别在第30s、90s、180s、300s、450s重新发起通知。

注意：返回的字符串必须是小写，且前后不能有空格和换行符。

8.查询退款订单

请求URL：

/refund/query

请求方式：

POST

请求类型：

application/json

参数：

参数名	必选	类型	说明
orgId	否	string	服务商号，用于服务商查询，传了此参数需要用服务商密钥进行加签
mchNo	是	String(30)	商户号
appId	是	String(24)	应用ID，默认为商户appId，若为服务商模式，需传入服务商appId
reqTime	是	String(13)	请求时间，13位时间戳
version	是	String(3)	接口版本，固定：1.0
sign	是	String(32)	签名
signType	是	String(32)	签名类型，MD5/RSA/SM2
refundOrderId	是	String(30)	退款订单号，与mchRefundNo二者传一即可
mchRefundNo	是	String(30)	商户退款单号，与refundOrderId二者传一即可

返回参数

参数名	必选	类型	说明
code	是	String	返回状态：0-处理成功，9999-异常，具体错误详见msg字段
msg	否	String(128)	返回信息：具体错误原因，例如：签名失败、参数格式校验错误
sign	否	String(32)	签名信息：对data内数据签名，如data为空则不返回
data	否	Json	返回数据：json格式数据

data数据格式

参数名	必选	类型	说明
mchNo	是	String(30)	商户号
appId	是	String(24)	应用ID
refundOrderId	是	String(30)	退款订单号
payOrderId	是	String(30)	支付订单号
mchRefundNo	是	String(30)	商户退款单号
payAmount	是	int	支付金额，单位分
refundAmount	是	int	退款金额，单位分
currency	是	String(3)	货币代码，人民币:cny
state	是	int	退款状态：0-订单生成 1-退款中 2-退款成功 3-退款失败 4-退款关闭 6-预消费退款
channelOrderNo	否	String	渠道订单号
errCode	否	String	渠道错误码
errMsg	否	String	渠道错误描述
extParam	否	String(512)	扩展参数，回调时会原样返回
createdAt	是	long	订单创建时间，13位时间戳
successTime	否	long	订单支付成功时间，13位时间戳
channelFeeAmount	否	long	渠道返回的手续费，单位：分

9.退款通知

请求URL：

该链接是通过统一退款接口提交的参数notifyUrl设置

请求方式：

POST

请求类型：

application/x-www-form-urlencoded

通知参数：

参数名	必选	类型	说明
orgId	否	string	服务商号
mchNo	是	String(30)	商户号
appId	是	String(24)	应用ID，默认为商户appId，若为服务商模式，需传入服务商appId
sign	是	String(32)	签名值
signType	否	String(32)	签名类型
refundOrderId	是	String(30)	退款订单号
payOrderId	是	String(30)	支付订单号
mchRefundNo	是	String(30)	商户退款单号
payAmount	是	int	支付金额，单位分
refundAmount	是	int	退款金额，单位分
currency	是	String(3)	货币代码，人民币:cny
state	是	int	退款状态： 0-订单生成 1-退款中 2-退款成功 3-退款失败 4-退款关闭 6-预消费退款只有2/3/6三种状态会发起退款异步通知
channelOrderNo	否	String	渠道订单号
channelFeeAmount	否	long	渠道返回的手续费，单位：分
errCode	否	String	渠道错误码
errMsg	否	String	渠道错误描述
extParam	否	String(512)	扩展参数，回调时会原样返回
createdAt	是	long	订单创建时间，13位时间戳
successTime	否	long	订单支付成功时间，13位时间戳
reqTime	是	long	通知请求时间，13位时间戳

返回结果：

业务系统处理后同步返回给支付系统，返回字符串success 则表示成功，返回非success则表示处理失败，支付系统会再次通知。

注意：返回的字符串必须是小写，且前后不能有空格和换行符。

10.账单导入

使用场景：

通过接口导入账单，员工可通过通企付企业服务助手查询账单并分享账单码牌用于收款

请求URL：

pay/billImport

请求方式：

POST

请求类型：

application/json

请求参数：

参数名	必选	类型	说明
orgId	否	string(30)	服务商id，用于服务商模式，传了此参数需要用服务商秘钥进行验签
mchNo	是	String(30)	商户号
appId	是	String(24)	应用ID，默认为商户appId，若为服务商模式，需传入服务商appId
reqTime	是	String(13)	请求时间，13位时间戳
version	是	String(3)	接口版本，固定：1.0
sign	是	String(32)	签名
signType	是	String(10)	签名类型，MD5/RSA/SM2
termNo	是	String(64)	收款模板编号
billsInfo	是	String	账单信息（最大1000笔），为JSONArray字符串

billsInfo参数名	必选	类型	说明
amount	是	String(20)	账单金额（单位：元）
billEffTime	是	String(20)	账单生效时间 yyyy-mm-dd HH:mm:ss
billExpTime	是	String(20)	账单失效时间 yyyy-mm-dd HH:mm:ss
payeePhone	否	String(11)	业务员手机号
field1	否	String(255)	模板自定义字段1
field2	否	String(255)	模板自定义字段2
field3	否	String(255)	模板自定义字段3
field4	否	String(255)	模板自定义字段4
field5	否	String(255)	模板自定义字段5

返回参数

参数名	必选	类型	说明
code	是	String	返回状态：0-处理成功，9999-异常，具体错误详见msg字段
msg	否	String	返回信息：具体错误原因，例如：签名失败、参数格式校验错误
sign	否	String	签名信息：对data内数据签名，如data为空则不返回
data	否	Json	返回数据：json格式数据

data数据格式

参数名	必选	类型	说明
importBatch	否	String(30)	导入批次号
billsInfo	否	String	账单信息（账单校验异常时返回）

billsInfo参数名	必选	类型	说明
amount	是	String(20)	账单金额（单位：元）
billEffTime	是	String(20)	账单生效时间 yyyy-mm-dd HH:mm:ss
billExpTime	是	String(20)	账单失效时间 yyyy-mm-dd HH:mm:ss
payeePhone	否	String(11)	业务员手机号
field1	否	String(255)	模板自定义字段1
field2	否	String(255)	模板自定义字段2
field3	否	String(255)	模板自定义字段3
field4	否	String(255)	模板自定义字段4
field5	否	String(255)	模板自定义字段5
failMsg	否	String(255)	账单校验异常原因

11.对账文件下载

简要描述：

支持核心企业按天下载对账文件，D+1日11点之后可下载D日的支付交易对账文件，支付交易对账文件内仅包含成功交易，含退款。
服务商模式下既支持服务商下载单个核心企业的支付交易对账文件，也支持服务商一次性下载其下所有核心企业的支付交易对账单，合并在一个CSV文件中。
支持核心企业按天下载分账交易对账单文件，D+1日11点之后可下载D日的分账交易对账文件。
针对开通了微信预消费的核心企业，支持按天下载指定日期的全部微信预消费交易对账单文件，D+1日11点之后可下载D日的预消费交易对账文件。

请求URL：

/accountstatement/getOrderFile

请求方式：

POST

请求类型：

application/json

请求参数：

参数名	必选	类型	说明
orgId	否	string	服务商id，用于服务商代发起交易，传了此参数需要用服务商秘钥进行加签
mchNo	是	String(30)	商户号，支持传入服务商id，当传入服务商id的时候获取的为服务商对账单，需要后台配置生成服务商对账单后才能使用
appId	是	String(24)	默认为企业appId，若为服务商模式，需传入服务商appId
reqTime	是	String(13)	请求时间，13位时间戳
version	是	String(3)	接口版本，固定：1.0
sign	是	String(32)	签名
signType	是	String(32)	签名类型，MD5/RSA/SM2
day	是	String(30)	交易日期，yyyy-MM-dd
fileType	否	String(30)	文件类型：CSV/EXCEL（不传默认CSV）
billType	否	int(30)	账单类型： 1-支付交易对账单 2-分账交易对账单（不传默认获取支付交易对账单） 3-预消费交易对账单（不传默认获取支付交易对账单，仅有预消费交易的才有该对账单）
day	是	String(30)	交易日期，yyyy-MM-dd

返回参数

参数名	必选	类型	说明
code	是	String	返回状态：0-处理成功，9999-异常，具体错误详见msg字段
msg	否	String(128)	返回信息：具体错误原因，例如：签名失败、参数格式校验错误
sign	否	String(32)	签名信息：对data内数据签名，如data为空则不返回
data	否	Json	返回数据：json格式数据

data数据格式

字段名	变量名	必填	类型	描述
对账文件	fileUrl	是	String	对账文件链接，下载文件格式为csv，具体字段参见[附录4对账文件示例](https://www.showdoc.com.cn/2511081072137898/11558663415869454 "附录4对账文件示例")

12.统一余额查询

请求URL：

/balance/query

请求方式：

POST

请求类型：

application/json

参数：

参数名	必选	类型	说明
orgId	否	string	服务商id，用于服务商代发起交易，传了此参数需要用服务商秘钥进行加签
mchNo	是	String(30)	商户号
appId	是	String(24)	应用ID，默认为商户appId，若为服务商模式，需传入服务商appId
reqTime	是	String(13)	请求时间，13位时间戳
version	是	String(3)	接口版本，固定：1.0
sign	是	String(32)	签名
signType	是	String(32)	签名类型，MD5/RSA/SM2
chanNo	是	String(30)	渠道: allinpay：收银宝 yunst2isv：云商通特色结算 yunst2yhzh：云商通银行账户
channelExtra	是	String	渠道参数，JSON字符串，(1)allinpay渠道需要指定商户号，如：收银宝子商户号cusid,集团商户号orgid例如：channelExtra={“orgid”:”66045xxxxxxx”,”cusid”:”66046xxxxxxxxx”} (2)yunst2isv渠道需要指定会员及账户类型，channelExtra={“bizUserId”:”BS1738808XXX”,”acctType”:”08”} acctType取值： 08：待结算户； (3)yunst2yhzh渠道需指定会员及账户类型，示例为：channelExtra={“bizUserId”:“xxxxx”,“acctType”:“PENDING_SETTLE”}， acctType取值： NO_PWD：免密余额户 PENDING_SETTLE：待结算户

返回参数

参数名	必选	类型	说明
code	是	String	返回状态：0-处理成功，9999-异常，具体错误详见msg字段
msg	否	String(128)	返回信息：具体错误原因，例如：签名失败、参数格式校验错误
sign	否	String(32)	签名信息：对data内数据签名，如data为空则不返回
data	否	Json	返回数据：json格式数据

data数据格式

参数名	必选	类型	说明
amount	是	String(30)	总余额，单位：分 yunst2isv渠道情况下，该余额等于：可用+在途
cusid	否	String(24)	子商户号 allinpay渠道必返
availableAmt	否	String(24)	可用余额，单位：分 yunst2isv渠道必返
transitAmt	否	String(24)	在途余额，单位：分 yunst2isv渠道必返

13.提现

请求URL：

/pay/withdrawApply

请求方式：

POST

请求类型：

application/json

参数：

参数名	必选	类型	说明
orgId	否	String(30)	服务商id，用于服务商代发起交易，传了此参数需要用服务商秘钥进行加签
mchNo	是	String(30)	通企付商户号，示例：E249974037860
appId	是	String(24)	默认为企业appId，若为服务商模式，需传入服务商appId
reqTime	是	String(13)	请求时间，13位时间戳
version	是	String(3)	接口版本，固定：1.0
sign	是	String(32)	签名
signType	是	String(32)	签名类型，MD5/RSA/SM2
chanNo	是	String(30)	渠道 : allinpay：收银宝渠道 yunst2isv：特色结算渠道 yunst：云商通渠道 yunst2yhzh:银行账户渠道
channelExtra	否	String	渠道参数，JSON字符串，allinpay渠道需要指定提现商户号，如：收银宝子商户号cusid,集团商户号orgid例如：channelExtra={“orgid”:”66045xxxxxxx”,”cusid”:”66046xxxxxxxxx”}
mchOrderNo	是	String(30)	商户提现订单号
amount	是	String(30)	提现金额（单位：分）
fee	否	String(20)	平台抽佣金额（单位：分），仅yunst2isv、yunst渠道可使用
bizUserId	否	String(30)	商户会员编号（yunst2isv、yunst、yunst2yhzh渠道必传，若是平台，上送固定值：#yunBizUserId_B2C#）
bankCardNo	否	String(10)	提现银行卡号，yunst2isv、yunst渠道必传
bankCardPro	否	int(2)	银行卡账户属性 0:个人银行卡 1:企业对公账户
notifyUrl	否	String(100)	异步通知地址，allinpay渠道不可用
summary	否	String(100)	摘要
withdrawType	否	String(100)	提现方式: allinpay渠道支持：D0：D+0到账；T1：T+1到账，默认为T1 yunst渠道支持：D0：D+0到账; D1：D+1到账;T1：T+1到账，默认为D0， yunst2isv渠道支持：D0：D+0到账 yunst2yhzh渠道支持：D0：D+0到账
extParam	否	String(100)	备注

返回参数

参数名	必选	类型	说明
code	是	String	返回状态：0-处理成功，9999-异常，具体错误详见msg字段
msg	否	String(128)	返回信息：具体错误原因，例如：签名失败、参数格式校验错误
sign	否	String(32)	签名信息：对data内数据签名，如data为空则不返回
data	否	Json	返回数据：json格式数据

data数据格式

参数名	必选	类型	说明
channelOrderNo	是	String(30)	渠道提现订单号
amount	是	String(24)	提现金额
withdrawOrderId	是	String(30)	通企付提现订单号
mchOrderNo	是	String(30)	商户提现订单号
state	是	String(30)	订单状态： 0：订单生成 1：提现中 2：提现成功 3：提现失败 6：订单关闭
errCode	否	String	渠道错误码
errMsg	否	String	渠道错误描述

14.提现结果通知

简要描述：

提现结果异步通知接口，提现成功或提现失败均会发起通知，allinpay渠道不发异步通知，请通过统一订单查询接口查询提现结果。

请求URL：

该链接是通过提现接口提交的参数notifyUrl设置

请求方式：

POST

请求类型：

application/x-www-form-urlencoded

通知参数：

参数名	必选	类型	说明
orgId	否	String(30)	服务商id
mchNo	是	String(30)	商户号
appId	是	String(24)	appid
sign	是	String(32)	签名值
signType	否	String(32)	签名类型
mchOrderNo	是	String(30)	商户提现订单号
withdrawOrderId	是	String(30)	通企付提现订单号
amount	是	int	提现金额，单位分
bizUserId	是	String	商户会员编号
successTime	否	long	提现完成时间，13位时间戳
state	是	int	提现状态： 2-提现成功 3-提现失败
channelOrderNo	是	String	渠道提现订单号
reqTime	是	long	通知请求时间，13位时间戳
errCode	否	String	渠道错误码
errMsg	否	String	渠道错误描述
extParam	否	String(512)	扩展参数，回调时会原样返回

返回结果：

业务系统处理后同步返回给通企付，返回字符串success 则表示成功，返回非success则表示处理失败。通知失败后，通企付会重新发起通知，最多重发5次，分别在第30s、90s、180s、300s、450s重新发起通知。。

注意：返回的字符串必须是小写，且前后不能有空格和换行符。

15.批量分账

使用场景：

用于对收款订单发起分账。yunst2isv渠道分账处理完成后会通过分账结果通知接口逐笔进行通知，业务系统需以异步通知中的分账结果为准；allinpay渠道需要通过查询分账订单接口主动查询分账结果；yunst2yhzh渠道实时响应分账结果。

请求URL：

/batchDivision/division

请求方式：

POST

请求类型：

application/json

请求参数：

参数名	必填	类型	描述	示例值
orgId	否	string	服务商号，用于服务商代发起交易，传了此参数需要用服务商密钥进行加签
mchNo	是	String	商户号
appId	是	String	应用ID，默认为商户应用ID，若为服务商模式，需传入服务商appId
reqTime	是	long	请求接口时间,13位时间戳
version	是	String	接口版本号，固定：1.0
sign	是	String	签名值，详见签名算法
signType	是	String	签名类型	MD5/RSA/SM2
notifyUrl	否	String	分账结果异步回调URL
chanNo	是	String	分账渠道支持: allinpay，收银宝渠道 yunst2isv，特色结算渠道 yunst2yhzh,银行账户渠道
batchDivisionInfos	是	String	待分账列表，为JSONArray字符串，最多支持50条。详细见下方batchDivisionInfos，当渠道为allinpay和yunst2yhzh时，仅支持上送一条数据

batchDivisionInfos 待分账列表详情

参数名	必选	类型	说明
mchAssureOrderNo	是	String	商户分账订单号
mchOrderNo	否	String	原收款订单的商户订单号（与通企付支付订单号二选一，yunst2yhzh不需要传递），针对采用统一下单接口且支付方式为微信预消费和微信B2B门店助手的订单，建议使用商户订单号发起分账
payOrderId	否	String	原收款订单的通企付支付订单号（与商户订单号二选一，yunst2yhzh不需要传递）
orderAmount	否	String	本次解冻订单金额，单位为分，该金额减去抽佣和分账金额总和之后，剩余的金额则分给收款方， 1.allinpay渠道不可用； 2.yunst2isv渠道，单次分账时不需要上送，多次分账时该字段必需上送，解冻总金额必须小于等于订单剩余未分账金额； 3.yunst2yhzh渠道需要上送。
couponAmount	否	String	平台抽佣金额,单位为分，不抽佣不填（如果选了分账模板编号此字段无效），仅yunst2isv渠道可用
receiverGroupId	否	long	分账模板编号（如果选了分账模板编号，平台抽佣金额和分账信息字段无效），allinpay渠道不可用
sendMemNo	否	String	分账出金方商户会员编号(仅yunst2yhzh可填写，不填默认为平台收款方）
divisionDetails	否	JSONArray	分账信息， 1.allinpay渠道则必填，且仅允许一组信息; 2.yunst2isv和yunst2yhzh渠道如果不分账则不填（如果选了分账模板编号此字段无效），详细见下方divisionDetails; 3.若couponAmount、receiverGroupId和divisionDetails都为空时，则表示将字段“本次解冻订单金额”的全部金额确认给收款方
extParam	否	String	最多100个字符，商户拓展参数，用于透传给商户，不可包含竖线特殊字符

divisionDetails分账信息详情

参数名	必选	类型	说明
divisionBizMemNo	是	string	yunst2isv和yunst2yhzh渠道上送分账方的商户会员编号，allinpay渠道上送分账入金的收银宝商户号
amount	是	string	分账金额，单位为分
remark	否	string	备注，最多100个字符

响应参数：

参数名	必填	类型	描述
code	是	String	返回状态， 0-处理成功，其他-处理有误，详见错误码
msg	否	String(128)	返回信息，具体错误原因，例如：签名失败、参数格式校验错误
sign	否	String(32)	签名信息，对data内数据签名,如data为空则不返回
data	否	Json	返回下单数据,json格式数据

data数据格式

参数名	必填	类型	描述
batchNo	是	String(30)	分账批次号，返回系统分账批次号
state	是	int	分账状态： · 1-进行中 · 2-分账成功 · 3-分账失败
errCode	否	String	上游渠道返回的错误码
errMsg	否	String	上游渠道返回的错误描述

16.分账结果通知

请求URL：

该地址是通过批量分账接口提交的参数notifyUrl设置

请求方式：

POST

请求类型：

application/x-www-form-urlencoded

通知参数：

参数名	必选	类型	说明
orgId	否	String	服务商号
mchNo	是	String	商户号
appId	是	String	应用ID，默认为商户应用ID，若为服务商模式，需传入服务商appId
sign	是	String	签名值
signType	否	String	签名类型
batchNo	是	String	分账批次号
assureOrderId	是	String	通企付分账订单号
mchAssureOrderNo	是	String	商户分账订单号
payOrderId	否	String	原收款订单的通企付支付订单号
mchOrderNo	否	String	原收款订单的商户订单号
orderAmount	否	String	本次解冻的订单金额
totalOrderAmount	否	String	累计解冻的订单金额
state	是	String	分账结果。0-订单生成, 1-进行中, 2-分账成功, 3-分账失败，一般有终态时才会主动通知
successTime	是	long	订单分账成功时间，13位时间戳
extParam	否	String	商户拓展参数
errMsg	否	String	上游渠道返回的错误描述

返回结果：

业务系统处理后同步返回给通企付系统，返回字符串success 则表示成功，返回非success则表示处理失败，通企付系统会再次通知。

注意：返回的字符串必须是小写，且前后不能有空格和换行符。

17.查询分账订单

简要描述：

用于查询批量分账请求中单笔订单的分账结果

请求URL：

/division/query

请求方式：

POST

请求类型：

application/json

参数：

参数名	必选	类型	说明
orgId	否	string	服务商号，用于服务商代发起交易，传了此参数需要用服务商密钥进行加签
mchNo	是	String(30)	商户号
appId	是	String(24)	应用ID，默认为商户应用ID，若为服务商模式，需传入服务商appId
reqTime	是	String(13)	请求时间，13位时间戳
version	是	String(3)	接口版本，固定：1.0
sign	是	String(32)	签名
signType	是	String(32)	签名类型，MD5/RSA/SM2
mchAssureOrderNo	是	String(30)	商户分账订单号，与assureOrderId二者传一即可
assureOrderId	是	String(30)	通企付分账订单号，与mchAssureOrderNo二者传一即可

返回参数

参数名	必选	类型	说明
code	是	String	返回状态：0-处理成功，9999-异常，具体错误详见msg字段
msg	否	String	返回信息：具体错误原因，例如：签名失败、参数格式校验错误
sign	否	String(32)	签名信息：对data内数据签名，如data为空则不返回
data	否	Json	返回数据：json格式数据

data数据格式

参数名	必选	类型	说明
payOrderId	是	String	原收款订单的通企付支付订单号
mchOrderNo	是	String	原收款订单的商户订单号
mchAssureOrderNo	是	String	商户系统分账订单号
assureOrderId	是	String	通企付分账订单号
batchNo	否	String	分账批次号
state	是	int	分账订单状态：:0-订单生成, 1-进行中, 2-分账成功, 3-分账失败
orderAmount	否	String	本次解冻的订单金额
totalOrderAmount	是	String	累计解冻的订单金额
couponAmount	否	long	抽佣金额，单位分
extParam	否	String	商户扩展参数
createdAt	是	long	订单创建时间，13位时间戳
successTime	否	long	订单分账成功时间，13位时间戳
errMsg	否	String	渠道错误描述
divisionDetails	否	List	分账明细，如果不存在分账则没有。详细见下方batchDivisionInfo

batchDivisionInfo参数名	必选	类型	说明
divisionBizMemNo	是	string	分账方的商户会员编号
amount	是	string	分账金额，单位分
remark	否	string	备注

18.分账撤销接口

使用场景：

订单发起批量分账后，使用此接口可将已分账的资金从原分账订单的入金方退回到出金方，即分账交易撤销，用于错误分账后的分账撤销。分账后退款，yunst2isv和yunst2yhzh渠道请直接使用统一退款接口，allinpay渠道使用分账撤销接口撤销分账后，再使用统一退款接口。

请求URL：

/refund/refundAssureOrder

请求方式：

POST

请求类型：

application/json

参数：

参数名	必选	类型	说明
orgId	否	string	服务商id，用于服务商代发起交易，传了此参数需要用服务商密钥进行加签
mchNo	是	String	商户号
appId	是	String	应用ID
reqTime	是	long	请求接口时间,13位时间戳
version	是	String	接口版本号，固定：1.0
sign	是	String	签名值，详见签名算法
signType	是	String	签名类型， MD5/RSA/SM2
chanNo	是	String	渠道编号，与原分账订单相同 allinpay：收银宝 yunst2isv：特色结算 yunst2yhzh：银行账户
notifyUrl	否	String(128)	支付结果异步回调URL,只有传了该值才会发起回调，yunst2isv有效，其他渠道无通知
refundMchOrderNo	是	String	商户订单号
mchOrderNo	否	int	原商户分账订单号
assureOrderId	否	int	原通企付分账订单号，与原商户分账订单号二选一传入
refundAmount	是	String	撤销金额，单位分
channelExtra	否	String(256)	渠道参数，divisionRefundInfo特定渠道发起的额外参数 allinpay渠道无需上送，yunst2isv如不上送默认从收款人撤销，yunst2yhzh必须上送

divisionRefundInfo 分账撤销列表详情

参数名	必选	类型	说明
refundAmount	是	String	撤销金额，单位分，与最外层的撤销金额相等
divisionBizMemNo	否	String	原订单收款方，yunst2isv渠道必须上送，其他渠道不用上送
refundCouponAmount	否	String	平台抽佣分账退回金额，只对yunst2isv渠道生效
refundInfoList	否	String	分账撤销明细，yunst2yhzh只允许上送一条

refundInfoList分账回退详情

参数名	必选	类型	说明
divisionBizMemNo	是	string	yunst2isv和yunst2yhzh渠道上送分账方的商户会员编号
refundAmount	是	string	撤销金额，单位为分

返回参数

参数名	必选	类型	说明
code	是	int	返回状态：0-处理成功，9999-异常，具体错误详见msg字段
msg	否	String(128)	返回信息：具体错误原因，例如：签名失败、参数格式校验错误
sign	否	String(32)	签名信息：对data内数据签名，如data为空则不返回
data	否	Json	返回数据：json格式数据

data数据格式

参数名	必选	类型	说明
refundAssureOrderId	是	String(30)	分账撤销订单号
state	是	int	订单状态：0-订单生成 1-撤销中 2-撤销成功 3-撤销失败
assureAmount	是	int	分账总金额
refundAmount	是	int	本次撤销成功金额
errCode	否	String	渠道错误码
errMsg	否	String	渠道信息

19.分期利息计算

使用场景： 用于分期交易的每期还款和利息的计算，目前仅支持京东白条分期

请求URL：

/instalment/calFee

请求方式：

POST

请求类型：

application/json

参数：

参数名	必选	类型	说明
orgId	否	string	服务商号，用于服务商代发起交易，传了此参数需要用服务商密钥进行加签
mchNo	是	String	商户号
appId	是	String	应用ID，默认为商户应用ID，若为服务商模式，需传入服务商appId
reqTime	是	String(13)	请求时间，13位时间戳
version	是	String(3)	接口版本，固定：1.0
sign	是	String(32)	签名
signType	是	String(32)	签名类型，MD5/RSA/SM2
amount	是	String	支付金额，单位分
wayCode	是	String(30)	支付方式白条分期：JDBT_PAY

返回参数

参数名	必选	类型	说明
code	是	int	返回状态：0-处理成功，9999-异常，具体错误详见msg字段
msg	否	String(128)	返回信息：具体错误原因，例如：签名失败、参数格式校验错误
sign	否	String(32)	签名信息：对data内数据签名，如data为空则不返回
data	否	Json	返回数据：json格式数据

data数据格式

参数名	必选	类型	说明
instalmentList	否	JSONArray	分期明细

instalmentList参数名	必选	类型	说明
instalmentNum	是	int	期数
instalmentRepAmt	是	String(12)	每期还款金额
instalmentRepInt	是	String(12)	每期利息

20.转账接口

简要描述

用于商户之间余额转账，同步返回转账结果，若未返回终态，请通过统一订单查询接口查询转账结果。

请求URL：

/transferOrder

请求方式：

POST

请求类型：

application/json

参数：

参数名	必选	类型	说明
mchNo	是	String(30)	商户号
appId	是	String(24)	应用ID
reqTime	是	String(13)	请求时间，13位时间戳
version	是	String(3)	接口版本，固定：1.0
sign	是	String(32)	签名
signType	是	String(32)	签名类型，MD5/RSA/SM2
mchOrderNo	是	String(30)	商户转账订单号
ifCode	是	String(30)	支付接口代码： allinpay
entryType	是	String(30)	入账方式，仅支持收银宝余额： SYB_CASH
amount	是	String(30)	转账金额（单位：分）
currency	是	String(10)	货币代码（CNY)
sendAccountNo	是	String(100)	转账账户，收银宝出金商户号
accountNo	是	String(100)	收款账户，收银宝入金商户号
transferDesc	是	String(100)	转账备注
accountName	否	String(100)	收款人姓名
bankName	否	String(100)	收款人开户行名称

返回参数

参数名	必选	类型	说明
code	是	int	返回状态：0-处理成功，9999-异常，具体错误详见msg字段
msg	否	String(128)	返回信息：具体错误原因，例如：签名失败、参数格式校验错误
sign	否	String(32)	签名信息：对data内数据签名，如data为空则不返回
data	否	Json	返回数据：json格式数据

data数据格式

参数名	必选	类型	说明
transferId	是	String(30)	通企付转账订单号
channelOrderNo	是	String(30)	渠道转账订单号
accountNo	是	String(100)	收款账户，收银宝入金商户号
amount	是	String(24)	转账金额，单位：分
mchOrderNo	是	String(30)	商户转账订单号
state	是	String(30)	状态: 0-订单生成 1-转账中 2-转账成功 3-转账失败
accountName	否	String(100)	收款人姓名,原样返回
bankName	否	String(100)	收款人开户行名称，原样返回
errCode	否	String	渠道错误码
errMsg	否	String	渠道错误描述

21.关闭小程序链接

请求URL：

/applet/commonurl/colse

请求方式：

POST

请求类型：

application/json

参数：

参数名	必选	类型	说明
orgId	是	String(30)	服务商id，用于服务商代发起交易，传了此参数需要用服务商密钥进行加签
mchNo	是	String(30)	商户号
appId	是	String(24)	默认为企业appId，若为服务商模式，需传入服务商appId
reqTime	是	String(13)	请求时间，13位时间戳
version	是	String(3)	接口版本，固定：1.0
sign	是	String(32)	签名
signType	是	String(32)	签名类型，MD5/RSA/SM2
mchOrderNo	是	String(30)	商户订单号

返回参数

参数名	必选	类型	说明
code	是	int	返回状态：0-处理成功，9999-异常，具体错误详见msg字段
msg	否	String(128)	返回信息：具体错误原因，例如：签名失败、参数格式校验错误
sign	否	String(32)	签名信息：对data内数据签名，如data为空则不返回
data	否	Json	返回数据：json格式数据

data数据格式

参数名	必选	类型	说明
closeState	是	int	0:链接关闭失败 1:链接关闭成功

22.快捷支付绑卡签约

使用场景：

客户发起签约申请，获取银行签约短信
签约绑卡短信确认

请求URL：

/quickpay/agree

请求方式：

POST

请求类型：

application/json

请求参数：

参数名	必选	类型	说明
orgId	否	string	服务商id，用于服务商代发起交易，传了此参数需要用服务商密钥进行加签
mchNo	是	string	通企付商户号，示例：E249974037860
appId	是	string	默认为企业appId，若为服务商模式，需传入服务商appId
reqTime	是	string	请求时间，13位时间戳
version	是	string	版本（默认为1.0）
sign	是	string	签名
signType	是	string	签名类型（MD5/RSA/SM2）
chanNo	是	string	渠道。allinpay：收银宝渠道
agreeType	是	string	操作类型，1-签约申请 2-签约确认
merUserId	是	string	商户自定义用户号
acctType	是	string	卡类型不能为空：00:借记卡，02:准贷记卡/贷记卡
acctNo	是	string	银行卡号
acctName	是	string	户名
identityType	是	string	证件类型：0:身份证，2:护照，5:港澳通行证，6:台湾通行证
idNo	是	string	证件号，如末位是X，必须大写
phone	是	string	银行预留手机号码
validDate	否	string	有效期，格式：MMYY
cvv2	否	string	CVV2
channelExtra	否	string	渠道参数，JSON字符串，特定渠道发起的额外参数，如： 1、收银宝子商户号cusid,集团商户号orgid。示例：channelExtra={"orgid":"66045xxxxxxx","cusid":"66046xxxxxxxxx"}
verifyCode	否	string	短信验证码签约确认时必填
thpInfo	否	string	签约申请时返回,如果不为空,则确认签约时原样带上

返回参数

参数名	必选	类型	说明
code	是	int	返回状态：0-处理成功，9999-异常，具体错误详见msg字段
msg	否	String(128)	返回信息：具体错误原因，例如：签名失败、参数格式校验错误
sign	否	String(32)	签名信息：对data内数据签名，如data为空则不返回
data	否	Json	返回数据：json格式数据

data数据格式

参数名	类型	说明
merUserId	string	商户自定义用户号
thpInfo	string	签约申请时返回,如果不为空,则确认签约时原样带上
agreeId	string	签约确认返回参数协议编号,交易时需要传入
bankCode	string	签约确认返回参数银行代码
bankName	string	签约确认返回参数银行名称

23.短信支付确认

使用场景：

统一下单时支付方式选快捷支付，调用成功后会发送短信。此时需要用户调用该接口确认支付
如果下单接口返回了payData，则需要将payData原样上传
短信有效期为2分钟，如果超过时间用户还没短信确认，则需要调用重新获取支付确认短信接口

请求URL：

/pay/smsconfirm

请求方式：

POST

请求类型：

application/json

请求参数：

参数名	必选	类型	说明
orgId	否	string	服务商id，用于服务商代发起交易，传了此参数需要用服务商密钥进行加签
mchNo	是	string	通企付商户号，示例：E249974037860
appId	是	string	默认为企业appId，若为服务商模式，需传入服务商appId
reqTime	是	string	请求时间，13位时间戳
version	是	string	版本（默认为1.0）
sign	是	string	签名
signType	是	string	签名类型（MD5/RSA/SM2）
mchOrderNo	是	String(30)	商户订单号，与payOrderId二者传一即可
payOrderId	是	String(30)	支付订单号，与mchOrderNo二者传一即可,建议使用支付订单号
agreeId	是	string	协议编号
verifyCode	是	string	短信验证码
payData	否	string	如果下单返回了payData，需要原样上传

返回参数

参数名	必选	类型	说明
code	是	int	返回状态：0-处理成功，9999-异常，具体错误详见msg字段
msg	否	String(128)	返回信息：具体错误原因，例如：签名失败、参数格式校验错误
sign	否	String(32)	签名信息：对data内数据签名，如data为空则不返回
data	否	Json	返回数据：json格式数据

data数据格式

参数名	类型	说明
payOrderId	string	支付订单号
mchOrderNo	string	商户订单号
state	int	订单状态：0-订单生成 1-支付中 2-支付成功 3-支付失败 4-已撤销 5-已退款 6-订单关闭 7-预消费支付成功
errCode	string	渠道返回错误代码
errMsg	string	渠道返回错误信息

24.重新获取支付确认短信

使用场景：

获取快捷支付请求的短信验证码

请求URL：

/pay/smsresent

请求方式：

POST

请求类型：

application/json

请求参数：

参数名	必选	类型	说明
orgId	否	string	服务商id，用于服务商代发起交易，传了此参数需要用服务商密钥进行加签
mchNo	是	string	通企付商户号，示例：E249974037860
appId	是	string	默认为企业appId，若为服务商模式，需传入服务商appId
reqTime	是	string	请求时间，13位时间戳
version	是	string	版本（默认为1.0）
sign	是	string	签名
signType	是	string	签名类型（MD5/RSA/SM2）
mchOrderNo	是	String(30)	商户订单号，与payOrderId二者传一即可
payOrderId	是	String(30)	支付订单号，与mchOrderNo二者传一即可,建议使用支付订单号
agreeId	是	string	协议编号
payData	否	string	透传下单接口返回的payData

返回参数

参数名	必选	类型	说明
code	是	int	返回状态：0-处理成功，9999-异常，具体错误详见msg字段
msg	否	String(128)	返回信息：具体错误原因，例如：签名失败、参数格式校验错误
sign	否	String(32)	签名信息：对data内数据签名，如data为空则不返回
data	否	Json	返回数据：json格式数据

data数据格式

参数名	类型	说明
payOrderId	string	支付订单号
payData	string	如果存在，下一步确认原样带上

25.快捷解绑

使用场景：

解绑用户绑定的某一个银行卡

请求URL：

/quickpay/unbind

请求方式：

POST

请求类型：

application/json

请求参数：

参数名	必选	类型	说明
orgId	否	string	服务商id，用于服务商代发起交易，传了此参数需要用服务商密钥进行加签
mchNo	是	string	通企付商户号，示例：E249974037860
appId	是	string	默认为企业appId，若为服务商模式，需传入服务商appId
reqTime	是	string	请求时间，13位时间戳
version	是	string	版本（默认为1.0）
sign	是	string	签名
signType	是	string	签名类型（MD5/RSA/SM2）
chanNo	是	string	渠道。allinpay：收银宝渠道
agreeId	是	string	协议编号

返回参数

参数名	必选	类型	说明
code	是	int	返回状态：0-处理成功，9999-异常，具体错误详见msg字段
msg	否	String(128)	返回信息：具体错误原因，例如：签名失败、参数格式校验错误
sign	否	String(32)	签名信息：对data内数据签名，如data为空则不返回
data	否	Json	返回数据：json格式数据

data数据格式

参数名	类型	说明
merUserId	string	商户用户号

26.分账撤销结果通知

请求URL：

该地址是通过分账撤销接口提交的参数notifyUrl设置

请求方式：

POST

请求类型：

application/x-www-form-urlencoded

通知参数：

参数名	必选	类型	说明
orgId	否	String	服务商号
mchNo	是	String	商户号
appId	是	String	应用ID，默认为商户应用ID，若为服务商模式，需传入服务商appId
sign	是	String	签名值
signType	否	String	签名类型
payOrderId	否	String	原收款订单的通企付支付订单号
mchOrderNo	否	String	原收款订单的商户订单号
assureOrderId	是	String	通企付分账订单号
refundAssureMchOrderNo	是	String	商户分账撤销订单号
refundAssureOrderId	是	String	分账撤销订单号
assureRefundAmount	否	String	本次撤销订单金额
state	是	String	分账撤销结果。2-分账撤销成功, 3-分账撤销失败，成功失败都通知
successTime	否	long	订单分账撤销成功时间，13位时间戳
errMsg	否	String	上游渠道返回的错误描述

返回结果：

业务系统处理后同步返回给通企付系统，返回字符串success 则表示成功，返回非success则表示处理失败，通企付系统会再次通知。

注意：返回的字符串必须是小写，且前后不能有空格和换行符。

27.H5收银台下单

使用场景：

获取访问通企付H5收银台的链接，用户通过对应链接打开通企付H5收银台，通企付H5收银台负责渠道下单支付，并返回交易结果。

请求URL：

/h5Cash/getH5Url

请求参数：

参数名	必选	类型	说明
orgId	否	string	服务商id，用于服务商模式，传了此参数需要用服务商秘钥进行验签
mchNo	是	string	商户号
appId	是	string	应用ID
reqTime	是	string	请求时间，13位时间戳
version	是	string	版本（默认为1.0）
sign	是	string	签名
signType	是	string	签名类型（MD5/RSA/SM2）
mchOrderNo	是	string	商户订单号
amount	是	string	金额（单位：分）
body	是	string	描述
notifyUrl	否	string	通知地址
frontUrl	否	string	微信点金计划跳转地址，仅微信浏览器内打开有效，点金计划改造参照页面下方链接说明
jumpUrl	否	string	前端跳转地址，支付完成后会带参跳转到该地址，微信内打开的时候此跳转地址无效
validTime	否	int	链接有效期，单位秒，不传默认120秒，最小120秒，最大支持720小时
expiredTime	否	int	订单失效时间,单位秒,默认1小时.订单在(创建时间+失效时间)后失效
extParam	否	string	备注，商户扩展参数，回调时原样返回
goodsInfo	否	string	商品备注,JSONArray格式，例如： goodsInfo=[{“goodsnm”:”TEST_PAY”,”goodsnum”:”1”,”goodsamt”:”2”}]，使用转账汇款时必填
channelExtra	否	string	渠道参数，JSON字符串，特定渠道发起的额外参数，例如： 1、指定收银宝的交易商户号，收银宝集团商户号orgid，子商户号cusid； 2、merUserId：商户用户标识，使用转账汇款时，必填； 3、unpid：银联unpid，选填，云闪付的付款方式支持传入银联unpid，参与银联针对B2B供应链场景的促销活动。
payTypeInfo	否	string	收银台展示的付款方式，多个以英文逗号(,)隔开； WX_PAY：微信 ALI_PAY：支付宝 YSF_PAY：云闪付 JD_PAY：白条分期 ALI_CREDIT_PAY：花呗分期 BANK_PAY：银行卡支付 ALI_CARD_CREDIT_PAY：信用卡分期 ZZHK_PAY：转账汇款
directPayType	否	string	直接支付的支付方式，仅支持上送一种支付方式，填入该参数则自动使用该支付方式下单并拉起支付，当前支持： WX_JSAPI：微信公众号支付 ALI_QR：支付宝支付（微信环境内支付宝支付为吱口令） QUICK_PAY：快捷支付 XW_HRJ：新网汇入金

goodsInfo参数名	必选	类型	说明
goodsnm	是	string	商品简称
goodsamt	否	string	商品金额（单位：元）
goodsnum	否	string	商品数量

响应参数

参数名	必选	类型	说明
code	是	String	返回状态：0-处理成功，9999-异常，具体错误详见msg字段
msg	否	String	返回信息：具体错误原因，例如：签名失败、参数格式校验错误
sign	否	String	签名信息：对data内数据签名，如data为空则不返回
data	否	String	返回数据：json格式数据

data数据格式

参数名	必选	类型	说明
H5Url	是	String	访问路径，该字段值支持直接访问，也支持转化为二维码后，由用户使用微信或支付宝扫码完成支付。

返回示例 { “code”: 0, “data”: { “H5Url”: “https://xxxx?cashCdoe=xxxx“, }, “msg”: “SUCCESS”, “sign”: “713B50182CAFC8B7B71CEE94D1D0A1B7” }

jumpUrl返回参数

参数名	必选	类型	说明
orgId	否	String	服务商id，用于服务商模式，传了此参数需要用服务商秘钥进行验签
mchNo	是	string	商户号
appId	是	string	应用ID
reqTime	是	string	请求时间，13位时间戳
sign	是	string	签名
signType	是	string	签名类型（MD5/RSA/SM2）
mchOrderNo	是	string	商户订单号
payOrderId	是	string	通企付支付订单号
amount	是	string	订单金额
state	是	string	订单状态 2-支付成功

frontUrl参数说明 微信参考资料：https://doc.weixin.qq.com/doc/w3_AEQALQY-AEkevAiG0OvRI0Os06P5s?scode=AJEAIQdfAAopFJmXniAEQALQY-AEk

2.1交易

目录

1.小程序下单

通企付微信小程序收银台跳转

通企付支付宝小程序收银台跳转

2.统一下单（API）

3.获取小程序链接

4.统一订单查询

5.关闭支付订单

6.统一退款

7.支付通知

8.查询退款订单

9.退款通知

10.账单导入

11.对账文件下载

12.统一余额查询

13.提现

14.提现结果通知

15.批量分账

16.分账结果通知

17.查询分账订单

18.分账撤销接口

19.分期利息计算

20.转账接口

21.关闭小程序链接

22.快捷支付绑卡签约

23.短信支付确认

24.重新获取支付确认短信

25.快捷解绑

26.分账撤销结果通知

27.H5收银台下单