测试地址:http://116.228.64.55:28082/yst-service-api/tx/handle
生产地址:https://ibsapi.allinpay.com/yst-service-api/tx/handle
接口代码(transCode):2089
适用于需要一段时间周期才能完成的交易,例如电商担保消费、快递、物流行业等。从平台的付款会员A处担保消费后,资金由平台方担保,满足付款条件后再将担保资金代付至各个收款会员及分账会员的簿记账户。
3.2.1 担保消费申请
功能说明:
- 会员消费时,交易资金进平台担保户并记录收款会员应收款。
- 支持上送多个收款人,收款方需满足角色及协议签订要求。
(1)收款会员仅支持簿记账户(会员状态=有效)收款;
(2)针对“POS及当面付、付款码支付”等线下支付模式,可以不上送付款方会员相关字段
(3)银行卡协议支付:付款会员需先注册;非银行卡协议支付:付款会员无需注册但接口需商户付款方会员相关信息。
(4)订单类型“担保消费”,对应订单子类型为“担保支付”;
若请求上送的支付模式为:“收银宝微信小程序支付-WECHATPAY_MINIPROGRAM”,则需根据收银宝“响应的交易类型处理:
收银宝响应的交易类型 |
云商通处理 |
VSP681:微信订单预消费
|
更新订单支付模式为:微信订单预消费-WECHAT_PRECONSUME 更新订单子类型为:微信订单预消费 订单不动账 |
其他 |
原流程,正常更新订单状态、动账 |
并在同步响应中增加响应字段:isPreConsume。
业务请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
50 |
是 |
商户订单号 |
全局唯一不可重复 |
signNum |
String |
60 |
是 |
商户会员编号-付款人 |
商户系统中会员唯一标识 |
receiverList |
JSONArray |
是 |
收款人列表 |
最多支持10个, |
|
goodsType |
String |
2 |
否 |
商品类型 |
|
bizGoodsNo |
String |
32 |
否 |
商户商品编号 |
商家录入的商户编码,可跟随交易上传 |
orderAmount |
Long |
20 |
是 |
订单金额 |
单位:分。 订单金额=支付金额+营销金额 |
payAmount |
Long |
20 |
否 |
支付金额 |
渠道实际需支付金额 不上送时,则“营销金额”必送,即:订单金额=营销金额; |
promotionAmount |
Long |
20 |
否 |
营销金额 |
平台承担的营销金额 |
reqsUrl |
String |
256 |
否 |
前台通知地址 |
前台交易时必传,支付后,跳转的前台页面; 1收银宝网关必传 2.收银宝h5收银台必传 3.收银宝h5网关必传 4.收银宝银联JS选填,若指定页面跳转上送该字段 5.收银宝微信JS选填,若指定页面跳转上送该字段 6.收银宝微信正扫选填,若指定页面跳转则上送该字段 注:必须为https协议地址,且不允许带参数 |
respUrl |
String |
256 |
是 |
后台通知地址 |
|
orderValidTime |
String |
20 |
否 |
订单过期时间 |
格式:yyyy-MM-dd HH:mm:ss |
payMode |
JSONObject |
256 |
是 |
支付模式 |
详见模式字典 注“payAmount-支付金额”为空或0时,可不送 |
goodsName |
String |
50 |
否 |
商品名称 |
如下支付模式必填: 1.快捷支付 2.H5收银台 3.微信小程序收银台 4.支付宝小程序收银台 |
summary |
String |
100 |
否 |
摘要(透传渠道) |
不可包含“|”及换行符+,空格,/,?,%,#,&,=等特殊字符,最多50个字符 |
extendParams |
String |
200 |
否 |
扩展参数 |
接口将原样返回,不可包含“|”及换行符+,空格,/,?,%,#,&,=等特殊字符,最多100个字符 |
txDistrictCode |
String |
2 |
否 |
交易所在省市 |
仅智能路由时需要上送, 上送2位的地区码,如:11为北京 |
goodsDesc |
String |
256 |
否 |
商品描述 使用云商通收银台时,可展示商品信息 |
按照:商品名称1#金额##商品名称2#金额 的格式上送,则收银台界面可展示商品(金额为元) |
担保消费申请收款列表(receiverList)
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
---|---|---|---|---|
signNum |
String |
是 |
商户会员编号 |
商户会员编号。已实名并签订收款协议 |
amount |
Long |
是 |
收款金额 |
金额,单位:分 |
业务响应参数
字段 |
字段类型 |
字段长度 |
必填 |
字段中文 |
说明 |
result |
String |
1 |
否 |
订单状态 |
仅交易验证方式为“0”时返回 订单成功时会发订单结果通知商户。 |
respTraceNum |
String |
40 |
否 |
通联订单号 |
|
reqTraceNum |
String |
50 |
否 |
商户订单号 |
|
extendParams |
String |
200 |
否 |
扩展参数 |
返回上送上送的“扩展参数” |
channelParamInfo |
JSONObject |
否 |
渠道参数信息(支付详情) |
渠道返回时有值 |
|
chnlFrontParamInfo |
JSONObject |
否 |
渠道参数信息(前端支付参数) |
渠道返回时有值 (1)扫码支付信息/ JS支付串信息(微信、支付宝、QQ钱包) 客户对接提醒:前端调用方法不要用取字段的方式,避免加字段后签名失败。 |
|
respCode |
String |
5 |
是 |
业务返回码 |
00000:代表成功 66666、66667:处理中,即当前的请求已受理,需要继续调用关联的确认类接口,或通过发起订单查询、等待异步通知,来获取处理状态。 其他返回码:均代表失败 |
respMsg |
String |
200 |
是 |
业务返回说明 |
|
isPreConsume |
String |
40 |
否 |
是否微信订单预消费 |
枚举值: 0:否 1:是 |
3.2.2 单订单担保确认
测试地址:http://116.228.64.55:28082/yst-service-api/tx/handle
生产地址:https://ibsapi.allinpay.com/yst-service-api/tx/handle
接口代码(transCode):2090
功能说明:
1.针对一笔担保消费申请订单,收款人为多人的情况下,支持一次性将资金担保确认至支,各收款会员的簿记账户。
2.支持全额确认和部分确认。
3.各收款会员仅支持一级分账,分账资金从收款人簿记账户分账到分账收款人簿记账户,注意:收款方和分账方需满足角色及协议签订要求。
4.订单类型及子类型说明:订单类型“担保消费”,对应订单子类型为“单笔担保消费确认”;
5.担保消费订单成功后,不能马上调用担保确认接口,最短调用时间间隔为5秒,时间间隔过短会导致担保确认失败。
6.不支持“担保消费-微信订单预消费”的订单发起担保确认。即:
- “orgReqTraceNum-担保消费申请订单商户单号”+“oriTransDate-担保消费申请订单创建日期”
- “orgRespTraceNum-担保消费申请通联订单号”
-
- 匹配到“担保消费-微信订单完成”的订单时,支持担保确认。担保确认的订单子类型不变,仍为单订单担保确认。
-
- 若匹配到“担保消费-微信订单预消费”订单,则报错:该订单子类型不支持担保确认。
业务请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
50 |
是 |
商户订单号 |
|
orgRespTraceNum |
String |
40 |
是 |
担保消费申请通联订单号 |
担保消费申请通联订单号 |
receiverList |
JSONArray |
是 |
收款人列表 |
单订单担保确认收款人列表 |
|
respUrl |
String |
256 |
是 |
后台通知地址 |
|
summary |
String |
100 |
否 |
摘要;最多50个字符 |
最多100个字符,商户拓展参数,用于透传给商户,不可包含“|”特殊字符 |
extendParams |
String |
200 |
否 |
扩展参数 |
最多100个字符,商户拓展参数,用于透传给商户,不可包含“|”特殊字符 |
单订单担保确认收款人列表(receiverList)
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
---|---|---|---|---|
signNum |
String |
是 |
商户会员编号 |
|
amount |
Long |
是 |
金额 |
金额,单位:分 |
couponAmount |
Long |
否 |
平台抽佣金额 |
平台抽佣金额,单位:分; 内扣,如金额=100,平台抽佣金额=2,实际到账金额为98 |
sepDetail |
JSONArray |
否 |
分账列表 |
内扣。 支持分账到会员账户。 |
分账规则列表JSON(sepDetail)
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
signNum |
String |
是 |
商户会员编号 |
商户系统用户标识,商户系统中唯一编号。 |
amount |
Long |
是 |
分账金额 |
金额,单位:分 |
remark |
String |
否 |
备注 |
备注,最长50个字符 |
业务响应参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
result |
String |
1 |
否 |
订单状态 |
仅交易验证方式为“0”时返回 订单成功时会发订单结果通知商户。 |
reqTraceNum |
String |
50 |
是 |
商户订单号 |
|
respTraceNum |
String |
40 |
是 |
通联订单号 |
|
respCode |
String |
5 |
是 |
业务返回码 |
00000:代表成功 66666、66667:处理中,即当前的请求已受理,需要继续调用关联的确认类接口,或通过发起订单查询、等待异步通知,来获取处理状态。 其他返回码:均代表失败 |
respMsg |
String |
200 |
是 |
业务返回说明 |
3.2.3 单会员担保确认
测试地址:http://116.228.64.55:28082/yst-service-api/tx/handle
生产地址:https://ibsapi.allinpay.com/yst-service-api/tx/handle
接口代码(transCode):2091
功能说明:
1.针对多笔担保消费申请含有相同的收款方的情况下,支持一次性将多笔(最多100笔)担保消费申请资金,确认给同一收款会员,资金从平台担保账户确认至收款会员的簿记账户。
2.支持全额确认和部分确认。
3.仅支持一级分账,分账资金从收款会员分账至分账收款人簿记账户。
4.订单类型及子类型说明:订单类型“担保消费”,对应订单子类型为“批量担保确认”。
5.担保消费订单成功后,不能马上调用担保确认接口,最短调用时间间隔为5秒,时间间隔过短会导致担保确认失败。
6.不支持“担保消费-微信订单预消费”的订单发起担保确认。即:
- “orgReqTraceNum-担保消费申请订单商户单号”+“oriTransDate-担保消费申请订单创建日期”
- “orgRespTraceNum-担保消费申请通联订单号”
-
- 匹配到“担保消费-微信订单完成”的订单时,支持担保确认。担保确认的订单子类型不变,仍为单订单担保确认。
-
- 若匹配到“担保消费-微信订单预消费”订单,则报错:该订单子类型不支持担保确认。
业务请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
batchNo |
String |
20 |
是 |
商户批次号 |
|
applyList |
JSONArray |
是 |
批量担保消费申请订单列表 |
目前仅支持1个列表集合,即多笔担保消费申请订单,确认到同一个收款会员 |
|
respUrl |
String |
256 |
是 |
后台通知地址 |
单会员担保确认列表(applyList)
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
是 |
商户订单号 |
不可包含“|”字符 |
applyInfo |
JSONArray |
是 |
源担保消费申请订单付款信息 |
最多支持100个;详情 |
signNum |
String |
是 |
商户会员编号-收款人 |
商户系统用户标识,商户系统中唯一编号;担保消费申请订单中指定的收款方。 |
amount |
Long |
是 |
确认金额 |
单位:分 |
summary |
String |
否 |
摘要 |
最多50个字符 |
extendParams |
String |
否 |
商户扩展参数 |
最多100个字符,用于透传给商户,不可包含“|”特殊字符 |
源担保消费申请订单付款信息JSON(applyInfo)
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
orgReqTraceNum |
String |
否 |
担保消费申请订商户单号 |
担保消费申请订单号 担保消费申商户订单号+担保消费申请订单创建日期 与 担保消费申请通联订单号 二选一,必填; |
orgTransDate |
String |
否 |
担保消费申请订单创建日期 |
|
orgRespTraceNum |
String |
否 |
担保消费申请通联订单号 |
|
orderAmount |
Long |
是 |
金额 |
单位:分; 部分担保确认时,可以少于或等于担保消费申请订单金额 |
couponAmount |
Long |
否 |
平台抽佣金额 |
平台抽佣金额,单位:分; 内扣,如金额=100,平台抽佣金额=2,实际到账金额为98 该抽佣金额仅用于说明每笔【担保消费申请】抽佣金额,会员抽佣金额为各“担保消费申请+收款人”抽佣金额之和 |
sepDetail |
JSONArray |
否 |
分账列表 |
内扣。 支持分账到会员或者平台账户。 该分账仅用于说明每笔【担保消费申请】抽佣金额,会员分账金额为“担保消费申请+收款人+分账人收款人”分账金额之和 |
业务响应参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
batchNo |
String |
20 |
是 |
商户批次号 |
|
respCode |
String |
5 |
是 |
业务返回码 |
00000:代表成功 66666、66667:处理中,即当前的请求已受理,需要继续调用关联的确认类接口,或通过发起订单查询、等待异步通知,来获取处理状态。 其他返回码:均代表失败 |
respMsg |
String |
200 |
是 |
业务返回说明 |