测试地址:https://ibstest.allinpay.com/yst/yst-service-api/tx/handle
生产地址:https://ibsapi.allinpay.com/yst-service-api/tx/handle
接口代码(transCode):4016
功能说明:接收收银宝【业务状态变更通知】、【服务开通/信用授权通知】后,(在收银宝侧预留通知地址,需研发提供,云商通写在运营流程的文档中),云商通通知到应用在【应用后台通知地址配置】菜单中预留的通知地址,地址类型为:支付宝先享后付服务通知。
云商通根据收银宝通知中的“orgid”,匹配【应用支付产品权限】中的“集团商户、代理商”;通知中“orgid”字段无值的,则取“cusid”匹配【应用支付产品权限】中的“单商户”;来定位应用。若根据“orgid/cusid匹配到多个应用的,则取【应用支付产品权限】中更新时间为最新的一条。
1【先享后付业务单变更通知】接口
|
字段 |
类型 |
必填 |
字段名称 |
说明 |
|
vspCusid |
String |
是 |
收银宝子商户号 |
|
|
eventType |
String |
是 |
通知类型 |
alipay.open.mini.order.changed——业务状态变更通知 zhima.credit.payafteruse.creditagreement.changed——服务开通/信用授权通知 |
|
bizParam |
JSONObject |
是 |
业务参数 |
各通知类型的业务参数见下方 |
1.1【业务状态变更通知】
|
云商通侧字段名 |
字段类型 |
必填 |
字段名称 |
说明 |
收银宝字段名 |
|
outOrderId |
String |
是 |
商户订单号 |
由商家自定义 64个字符以内 仅支持字母、数字、下划线且需保证在商户端不重复 |
out_order_id |
|
orderId |
String |
是 |
交易组件订单号 |
【描述】交易组件订单号 order_id和out_order_id二选一 【示例值】2015042321001004720200028594 |
order_id |
|
tradeNo |
String |
是 |
支付宝交易号 |
|
trade_no |
|
|
string |
是 |
交易状态 |
【描述】交易状态 【枚举值】 支付成功: PAID 售后退款: REFUND_CLOSED 已发货: DELIVERED 已使用: DELIVERED_USED 确认收货: RECEIVED_CONFIRM 待支付: WAIT_PAY 超时关闭: TIMEOUT_CLOSED 交易撤销: CANCEL_CLOSED |
status |
|
operateAppId |
string |
是 |
开发者应用ID |
|
operate_app_id |
|
authAppId |
string |
是 |
授权方应用ID |
|
auth_app_id |
|
totalAmount |
string |
是 |
订单金额 |
【描述】订单金额 单位:元 精确到小数点后两位 【示例值】12.12 |
total_amount |
|
receiptAmount |
string |
是 |
实收金额 |
【描述】实收金额 单位:元 精确到小数点后两位 该金额为本笔交易 商户账户能够实际收到的金额 【示例值】88.88 |
receipt_amount |
|
secureReason |
string |
是 |
安全处置原因 |
【描述】平台处置退款原因 【示例值】投诉退款 |
secure_reason |
|
groupBuyInfo |
object[group_buy_info] (对象) |
是 |
拼团信息 |
【描述】拼团信息 详见本接口下方 数组类字段说明: group_buy_info的明细字段 |
group_buy_info |
|
userId |
string |
是 |
买家支付宝用户ID |
|
user_id |
|
openId |
string |
是 |
用户openId |
|
open_id |
|
settleType |
string |
否 |
账期标识 |
【描述】账期标识 【枚举值】 即时到账: normal 账期结算: extended 【示例值】normal |
settle_type |
|
voucherDetailList |
object[voucher_detail_list] (对象数组) |
否 |
券明细 |
【描述】券明细 详见本接口下方 数组类字段说明: voucher_detail_list的明细字段 |
voucher_detail_list |
GroupBuyInfo的详细字段
|
云商通对外字段名 |
类型 |
必填 |
字段名称 |
说明 |
收银宝字段名 |
|
groupId |
string |
是 |
团ID |
|
group_id |
|
groupStatus |
string |
是 |
团状态 |
【描述】拼团状态 【枚举值】 拼团失败:0 拼团中:1 拼团成功:3 待成团:4 |
group_status |
voucherDetailList券明细的明细字段
|
云商通对外字段名 |
类型 |
必填 |
字段名称 |
说明 |
收银宝字段名 |
|
id |
string |
否 |
券id |
【描述】券id |
id |
|
name |
string |
否 |
券名称 |
【描述】券名称 |
name |
|
type |
string |
否 |
优惠券类 型 |
【描述】券类型 【枚举值】 全场代金券: ALIPAY_FIX_VOUCHER 折扣券: ALIPAY_DISCOUNT_VOUCHER 单品优惠券: ALIPAY_ITEM_VOUCHER 现金抵价券: ALIPAY_CASH_VOUCHER 商家全场券: ALIPAY_BIZ_VOUCHER |
type |
|
amount |
string |
否 |
优惠券金 额 |
【描述】优惠券金额 单位:元 精确到小数点后两位 【示例值】10.00 |
amount |
|
merchantContribute |
string |
否 |
商户出资 金额 |
【描述】商户出资 单位为元 精确到小数点后两位 【示例值】9.00 |
merchant_contribute |
|
otherContribute |
string |
否 |
其他出资 |
【描述】其他出资,非交易商家 单位为元 【示例值】88.88 |
other_contribute |
|
memo |
string |
否 |
备注信息 |
【描述】备注信息 |
memo |
|
templateId |
string |
否 |
券模板id |
【描述】券模板id |
template_id |
|
purchaseMerchantContribute |
string |
否 |
商户出资 |
【描述】 购买该张券的资金中商户出资的部分 单位:元 精确到小数点后两位 【示例值】1.03 |
purchase_merchant_contribute |
|
purchaseAntContribute |
string |
否 |
内部出资 |
【描述】 购买该张券时内部出资的部分 (包含支付宝/口碑出资的部分) 单位:元 精确到小数点后两位 【示例值】1.03 |
purchase_ant_contribute |
|
purchase_buyerContribute |
string |
否 |
买家出资 |
【描述】 购买该张券的资金中买家自己出资的部分 单位:元 精确到小数点后两位 【示例值】1.03 |
purchase_buyer_contribute |
|
otherContributeDetail |
object[other_contribute_detail] (对象) |
否 |
其他出资 方明细 |
【描述】其他出资方明细 |
other_contribute_detail |
OtherContributeDetail的明细字段
|
云商通对外字段名 |
类型 |
必填 |
字段名称 |
说明 |
收银宝字段名 |
|
contributeType |
string |
否 |
其它出资方类型 |
【描述】出资方类型 如品牌商出资、支付宝平台出资 【枚举值】 支付宝: PLATFORM 商户: MERCHANT 用户出资: USER 第三方机构: OTHER |
contribute_type |
|
contributeAmount |
string |
否 |
其它出资方金额 |
【描述】其它出资方金额 单位:元 精确到小数点后两位 【示例值】8.00 |
contribute_amount |
1.2【服务开通/信用授权通知】
请求参数(bizParam):
|
云商通侧参数名 |
字段类型 |
必填 |
字段名称 |
说明 |
收银宝字段 |
|
creditAgreementId |
string |
是 |
开通/授权协议号 |
|
credit_agreement_id |
|
agreementStatus |
string |
是 |
开通/授权状态 |
【描述】开通/授权状态 VALID:有效 INVALID:无效 |
agreement_status |
|
outAgreementNo |
string |
是 |
商户外部协议号 |
|
out_agreement_no |
|
bizTime |
string |
是 |
开通/授权状态变更的时间 |
【示例值】2021-01-19 00:00:00 |
biz_time |
|
openChannel |
string |
是 |
开通渠道 |
【描述】开通渠道 区分是商家侧推荐开通/支付后推荐开通 【示例值】ALIPAY_RECOMMEND |
open_channel |
|
alipayUserId |
string |
是 |
用户ID |
alipay_user_id和open_id任选其一传入 必传 |
alipay_user_id |
|
openId |
string |
是 |
开放ID |
|
open_id |
|
extInfo |
string |
否 |
扩展字段 |
【描述】该字段只在特殊业务场景下 根据业务方约定返回 一般业务场景下不需要消费该字段 【示例值】{"key":"value"}协议号获取: ext_info.deductAgreement.agreement_no |
ext_info |