测试地址:http://116.228.64.55:28082/yst-service-api/tx/handle
生产地址:https://ibsapi.allinpay.com/yst-service-api/tx/handle
接口代码(transCode):2294
功能说明:
1.针对消费申请发起退款,支持1年内的订单发起退款。
2.支持全额退款、部分金额退款,退款金额不得超过原订单金额;
3.举例:订单收款人A收款100元,平台抽佣20元,分账40元。全额退款时,各字段上送如下:
orderAmount: 100 ,cnlRefundAmount: 100,
sepRefundInfo { orderAmount: 100,couponAmount: 20}
sepDetail {amount: 40}
4.当上送“渠道退款金额”时,即系统向收银宝发起退款。当收银宝侧当天正向交易资金不足的场景,系统自动向收银宝调拨资金,即从会员的云商通的“待结算”账户调拨至收银宝。“是否调拨”、“调拨金额”在【订单结果通知接口】中通知到商户。
5.“是否允许收款人垫资”字段,当上送“1:是”时,允许退款的资金全部从收款方出,不从分账方出;否则,退款的资金来源必须和原消费入金的资金来源保持一致。
6.支持收银宝微信预消费功能退款:
退款申请时,根据商户订单号,检查云商通本地的订单是否已完成(微信订单完成):
收银宝侧交易 |
云商通侧交易 |
处理说明 |
微信订单预消费 |
微信订单预消费 |
1. D日退款交易申请时: (1)仅允许全额退款 (2)不冻结退款资金,直接发送渠道退款(不动账) 2. D+1日收银宝对账单: 无该笔预消费交易、及退款交易的对账单 |
微信订单完成 |
微信订单完成 |
1. D日退款交易申请时: (1)支持部分退款 (2)常规退款:冻结退款资金,直接发送渠道退款(动账) 2. D+1日收银宝对账单: (1)D日退款的交易:将该笔订单与云商通退款订单核对。 |
业务请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
50 |
是 |
商户订单号-退款订单号 |
|
orgRespTraceNum |
String |
40 |
是 |
原通联订单号 |
原消费订单 |
orderAmount |
Long |
20 |
是 |
退款总金额 |
单位:分。 【消费申请】退款, 当上送“渠道退款金额”时,该字段与“渠道退款金额”+”营销退款金额“一致。 当不上送“渠道退款金额”时,该字段与“资金确认退款金额”或”营销退款金额“的最大值保持一致。 |
promotionAmount |
Long |
20 |
否 |
营销退款金额 |
单位:分 1、不能超过退款总金额 2、不能超过原订单营销金额 3、支持部分退款 |
isAdvancePay |
String |
1 |
否 |
是否允许收款人垫资 |
0:否 1:是 注:默认“0:否”; 当上送“1:是”时,允许退款的资金全部从收款方出,不从分账方出 |
sepRefundInfo |
JSONObject |
200 |
否 |
订单退款详情 json |
|
respUrl |
String |
256 |
否 |
后台通知地址 |
如果不填,则不通知。 退款成功、失败时,均发送通知 |
chnlDiscAmt |
JSONObject |
否 |
优惠信息 |
此字段只适用于银联云闪付单品优惠交易的退货,含单品优惠交易只能整单退款,不支持部分退款 |
|
extendParams |
String |
200 |
否 |
扩展信息 |
接口将原样返回,不可包含“|”及换行符+,空格,/,?,%,#,&,=等特殊字符,最多100个字符 |
订单退款详情 JSON(sepRefundInfo)
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
signNum |
String |
是 |
商户会员编号 |
原消费订单的收款人 |
cnlRefundAmount |
Long |
否 |
渠道退款金额 |
发送到收银宝的退款金额 |
orderAmount |
Long |
否 |
资金确认退款金额 |
单位:分 通过【批量分账】接口,将资金确认至收款人待结算户的可用余额的资金退回 |
couponAmount |
Long |
否 |
平台抽佣退款金额 |
填写分账退款金额时可填 |
sepDetail |
JSONArray |
否 |
分账退款列表 |
填写分账退款金额时可填 |
分账退款列表(sepDetail)
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
signNum |
String |
是 |
分账方商户会员编号 |
原【批量分账】中的分账收款人 |
amount |
Long |
是 |
分账方退款金额 |
单位:分 不大于原分账金额; |
remark |
String |
否 |
备注 |
业务响应参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
result |
String |
1 |
否 |
订单状态 |
订单成功时会发订单结果通知商户。 |
reqTraceNum |
String |
50 |
是 |
商户订单号 |
|
respTraceNum |
String |
40 |
是 |
通联订单号 |
|
extendParams |
String |
200 |
否 |
扩展信息 |
接口将原样返回,最多50个字符,不可包含“|”特殊字符 |
channelParamInfo |
JSONObject |
否 |
渠道参数信息 |
渠道返回时有值 |
|
respCode |
String |
5 |
是 |
业务返回码 |
00000:代表成功 66666、66667:处理中,即当前的请求已受理,需要继续调用关联的确认类接口,或通过发起订单查询、等待异步通知,来获取处理状态。 其他返回码:均代表失败 |
respMsg |
String |
200 |
是 |
业务返回说明 |