目录
5.1.1 会员类
5.1.1.1【个人会员实名及绑卡（申请）】
仅当消费者使用“快捷支付/快捷协议”付款方式时，调用本接口。
- 业务场景及规则：
- 业务场景：
- “绑卡类型”上送“6-收银宝快捷/7-收付通协议”，进行银行卡签约，接口上送个人会员角色、实名和银行账户信息，渠道认证通过（签约成功），则完成会员注册+设置角色+实名+绑卡+绑定银行卡预留手机号（默认绑定银行预留手机号）；
- 会员实名成功，会员状态=有效；
- 业务规则：
- 会员角色管控：一个会员仅可以设置一个角色，且不可以修改，接口上送的会员角色名称（仅支持上送“消费者”）；
- 会员开户个数管控：同一应用下，同一手机号/证件号开户数小于等于3
- 流程说明：
- 调用【个人会员实名及绑卡（申请）】，银行向银行预留手机发送验证短信；
- 调用【个人会员实名及绑卡（确认）】，上送银行向银行预留手机发送验证短信，进行确认签约，签约成功后，可使用该绑定的银行卡进行支付；
5.1.2 交易类
5.1.2.1 消费申请
- 业务场景及规则：
- 业务场景：
- 用于消费者在平台消费，平台调用云商通【消费申请】接口发起消费申请；
- 若使用“快捷支付-QUICKPAY_VSP”支付模式，需要调用【确认支付（后台+短信验证码确认）】进行确认支付；
- 业务规则：
- 消费者和收款方无需注册；
- 针对“快捷支付”/“快捷协议”支付模式时，支付风控（单笔限额、单日笔数、单日累计限额、单月累计限额）：
- 默认为：按“行业版版产品+行业标签+会员类型+支付模式（收银宝快捷支付/收付通协议支付）”控制“单日笔数/单笔限额/日累计/月累计”。
- 支持按应用定制风控：按“应用+支付模式（快捷支付/快捷协议）+会员类型”，控制订单日笔数/单笔限额/日累计/月累计。
- 流程说明：
- 消费者发起消费，平台调用【消费申请】接口向云商通发起消费申请，云商通向支付渠道请求支付；
- 支付渠道响应支付信息，消费者进行支付；
- 消费者支付完成后，渠道异步通知云商通，云商通通知平台。
- 平台可调用【订单状态查询】接口查询消费订单状态；
- 平台可调用【订单详情查询】接口查询消费订单订单详情，含渠道支付信息；
- 各支付模式调用说明：
|
支付模式 |
支付模式说明 |
|
微信正扫/支付宝正扫/银联扫码支付 |
1.订单请求，不返回“订单状态”，返回“扫码支付信息”，供转化为二维码。 2.无需调用任何确认支付接口。 3.订单结果通知提供。 |
|
快捷协议 |
1.只支持“6-收付通协议支付”签约方式绑定的银行卡； 2. 通过“payStatus”渠道交易结果，渠道交易实时响应-成功、失败、处理中； 3.订单结果通知提供。 注： 测试金额需1万以内。 交易金额为10元模拟发卡行不支持该笔交易 交易金额为11元模拟交易失败 交易金额为12元或协议号长度不等于41位模拟为协议号不一致 交易金额为13元模拟协议号不一致 交易金额为14元模拟余额不足 交易金额为15元协议已解除，扣款失败 其余情况模拟成功。 退款金额为16元为原交易不存在，退款失败 退款金额为17元为退款金额超过原金额，退款失败 其余情况为成功 |
|
快捷支付 |
仅支付绑卡方式“7-收银宝快捷支付签约”绑定的银行卡 订单申请 A：不验证短信，响应返回订单状态，不返回验证方式，无需调用确认支付。 B：验证短信，响应不返回订单状态，返回验证方式值为“1”，需继续调用【确认支付（后台+短信验证码确认）】 注： （1）此支付模式连接渠道真实环境，请使用真实银行卡，且交易将从银行卡扣减金额建议小额支付；支持当天、隔天部分退款和全额退款； （2）生产支付短信验证码有效时间为2分钟 |
|
微信小程序支付 |
1.订单请求，云商通不验证，返回“支付信息”商户在小程序平台调起支付的JS函数完成支付。 2.无需调用任何确认支付接口。 3.订单结果通知提供。 附： （1）微信公众号获取openid官方文档 https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=4_4# https://developers.weixin.qq.com/miniprogram/dev/api/open-api/login/wx.login.html （2）商户在小程序平台调起支付的JS函数API接口详见：https://pay.weixin.qq.com/wiki/doc/api/wxa/wxa_api.php?chapter=7_7&index=5 注： （1）小程序支付，需在收银宝商服端配置支付目录，T+1才能支付。 （2）一个收银宝商户号，最多配置10个小程序或公众号，平台有多个小程序或公众号时，需通过接口上送指定微信subappid。 |
|
付款码支付 |
1.订单请求，渠道端不验证时，响应返回“payStatus”，成功或失败；渠道端验证，则返回“进行中” 2.无需调用任何确认支付接口。 3.订单结果通知提供。 |
|
微信JS支付 |
1.订单请求，不返回“payStatus”， 返回“payInfo支付串信息”，对应微信JS支付，json字符串。商户在微信APP：调用微信浏览器内通过JavaScript调用getBrandWCPayRequest发起支付 2.无需调用云商通确认支付接口。 3.订单结果通知通过【订单结果通知】提供。 附： （1）微信公众号获取openid官方文档 https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=4_4# https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_webpage_authorization.html （2）微信公众号JSAPI官方文档 https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=7_7&index=6 微信公众号支付请求云商通响应payinfo示例： {"appid":"00000006","cusid":"XXXXXXXX","payinfo":"{\"appId\":\"wxb3fa424b649563b5\",\"timeStamp\":\"1477356696\",\"signType\":\"MD5\",\"package\":\"prepay_id=wx201610250851362b67f0b6570252306441\",\"nonceStr\":\"38642\",\"paySign\":\"66FF000B739F459D093FE24AB3462170\"}","reqsn":"1610258923119024","retcode":"SUCCESS","sign":"9513D3ABF5983F3FACCD8161931DB1ED","trxid":"180681592","trxstatus":"0000"} 注： （1）公众号支付，需在收银宝商服端配置支付目录，T+1才能支付。 （2）一个收银宝商户号，最多配置10个小程序或公众号，平台有多个小程序或公众号时，需通过接口上送指定微信appid。 |
|
支付宝JS支付 |
1.订单请求，不返回“payStatus”， 返回“payInfo支付串信息（支付宝交易单号）”，将此字段上传至“支付宝服务窗JSAPI官方文档的alipay.trade.create (统一收单交易创建接口)+JSAPI唤起收银台支付” AlipayJSBridge方法的参数tradeNO。 2.无需调用云商通确认支付接口。 3.订单结果通知通过【订单结果通知】提供。 附： （1）支付宝获取user_id官方文档 https://doc.open.alipay.com/doc2/apiDetail.htm?spm=a219a.7629065.0.0.EoHbww&apiId=876&docType=4 （2）支付宝服务窗JSAPI官方文档 https://doc.open.alipay.com/docs/doc.htm?&docType=1&articleId=105591 支付宝服务窗支付请求云商通响应payinfo示例： {"appid":"00000006","cusid":"xxxx","payinfo":"2016102521001004455008259156","reqsn":"1610258923075829","retcode":"SUCCESS","sign":"EF87B13EB952C954482676CDFE331107","trxid":"180681552","trxstatus":"0000"} |
|
银联JS支付 |
1.订单请求，不返回“payStatus”， 返回“payInfo支付串信息”，对应银联JS支付，支付的链接,商户只需跳转到此链接即可触发支付。 2.无需调用云商通确认支付接口。 3.订单结果通知通过【订单结果通知】提供。 4.支付账户用户标识ACCT获取方式： （1）分公司向商服运营部门申请商户在银联报备域名和通知地址说明； （2）商户服务器与银联交互自行获取银联userAuth的code，银联地址https://qr.95516.com/qrcGtwWeb-web/api/userAuth?version=1.0.0&redirectUrl=redirectUrlA，redirectUrlA：商户接收userAuthCode的地址； （3）商户调用云商通【通过授权码(付款码)获取用户ID】接口用来获取acct-支付账户用户标示； 对接参考《对接收银宝银联JS支付接入指引》 |
|
收银宝POS |
POS端冲正：必须关闭 POS端撤销/退款：建议关闭； （1）订单申请，返回 “通联订单号orderNo”。终端POS或通联收银宝公众号订单页面输入orderNo订单号，完成支付。 （2）无需调用任何确认支付接口。 （3）订单结果通知提供。 对接参考《收银宝订单POS及当面付支付使用指南》 |
|
H5收银台 |
（1）订单申请，返回“H5收银台”支付地址（在“chnlFrontParamInfo”JSON中返回的chnlPayInfo字段值），在微信/支付宝端打开该地址，进行支付； （2）无需调用任何确认支付接口。 （3）订单结果通知提供。 |
|
微信小程序收银台支付/支付宝小程序收银台支付 |
（1）订单申请，响应“appletPayParams-收银宝小程序收银台支付参数”； （2）商户小程序内调起通联收银台小程序。调用方式：在小程序环境内，唤起小程序调起收银台小程序时（appId: 微信小程序的appId，固定为：wxef277996acc166c3），在extraData中将云商通返回的“appletPayParams-收银宝小程序收银台支付参数”中的字段名及字段值全部原样作为入参上送。 （3）小程序的回调；用户在收银台中完成支付后，会回调支付结果，具体结果可以在小程序生命周期Page.onShow中获取“code、errmsg”参数，详见收银宝接口文档说明 收银宝微信小程序收银台在线文档： 收银宝微信小程序收银台在线文档： |
5.1.2.2 退款申请
- 业务场景及规则：
- 业务场景：用于消费者在平台消费后，进行退款的场景，平台调用云商通【退款申请】接口发起消费订单退款申请；
- 业务规则：
- 仅支持1年内的消费订单发起退款。
- 支持全额退款、部分金额退款，退款金额不得超过原订单金额；
- 流程说明：
- 消费者发起消费退款，平台调用【退款申请】接口向云商通发起消费退款申请，云商通向支付渠道发起退款申请；
- 支付渠道响应退款信息；
- 退款成功，渠道异步通知云商通，云商通通知平台。
- 平台可调用【订单状态查询】接口查询消费订单状态；
- 平台可调用【订单详情查询】接口查询消费订单订单详情，含渠道退款信息；
5.1.2.3 订单关闭
- 业务场景及规则：
- 业务场景：用于消费者在平台消费取消，平台调用【订单关闭】进行关闭订单；
- 业务规则：
- 仅【消费申请】订单支持关闭；
- 支持关闭支付模式为“微信正扫、支付宝正扫、微信小程序（含小程序收银台）、微信公众号、支付宝JS”未付款成功的消费订单；
- 针对未支付订单，若订单上送过期时间，则按照订单过期时间关闭，若未上送过期时间，1小时后系统将自动关闭订单；
- 为避免进行中的订单过多引起风控限制，可以调用云商通【订单关闭】接口，提前释放风控笔数或金额。
- 订单生成后，建议5分钟之后调用关闭订单接口，时间间隔过短容易导致错账；
- 测试环境不支持订单关闭。
- 流程说明：
1）消费发起消费取消，平台调用【订单关闭】接口向云商通发起订单关闭，云商通向支付渠道发起订单关闭；
- 支付渠道响应订单关闭结果；
- 订单关闭成功，实时响应关闭结果，关闭成功，订单状态置为“交易失败”；
- 平台可调用【订单状态查询】接口查询消费订单状态；
- 不提供异步通知；
5.1.2.4 订单结果通知
- 业务场景及规则：
- 业务场景：用于订单终态时，云商通向商户发送异步通知；
- 业务规则：
- 支持消费订单、退款订单终态时发起异步通知；
- 通知地址为商户在创建订单时提供的“respUrl-后台通知地址”地址；
- 订单成功、订单失败都会发送异步通知
- 流程说明：商户调用【消费申请】、【退款申请】订单终态后，接收云商通异步通知；
5.1.3 交易查询类
5.1.3.1 订单状态查询
- 业务场景及规则：
- 业务场景：用于订单未终态时，商户调用【订单状态查询】接口，查询订单状态；
- 业务规则：仅支持查询云商通本地订单状态，支持调用此接口查询订单状态，作为未收到异步通知的保障机制；
- 流程说明：
- 商户调用【商户订单状态查询】接口，查询订单状态；
- 云商通响应客户本地云商通订单状态；
5.1.3.2 订单详情查询
- 业务场景及规则：
- 业务场景：用于商户调用【订单详情查询】查询订单详细信息，含渠道支付/退款信息；
- 业务规则：
- 商户通过【订单状态查询】获取订单终态后，需通过已完成订单的交易信息作下一步业务判断时，可调用此接口查询订单详细信息；
- 支持查询5年内的订单详情信息
- 流程说明：
- 商户调用【订单详情查询】接口，查询订单详情；
- 云商通响应商户本地订单详情信息，含渠道支付/退款信息（渠道手续费、支付信息等）；
5.1.4 对账文件下载类
5.1.4.1 对账文件下载
- 业务场景及规则：
- 业务场景：用于平台从云商通系统获取对账文件，供平台进行对账；
- 业务规则：对账文件内容仅包含交易成功的订单；
- 流程说明：
- 商户D日调用云商通接口发起交易，针对交易成功的交易，D+1日系统生成对账文件；
- D+1日，商户调用【对账文件下载】接口，下载对账文件（未确保一定能下载到对账文件，建议D+1日9:00后调用接口下载）；
5.1.5 终端管理类
5.1.5.1 终端信息管理
- 业务场景及规则：
- 业务场景：用于维护终端信息，在收银宝POS/付款码支付前需完成（收银宝付款码支付（CODEPAY_VSP/CODEPAY_VSP_ORG)维护；
- 业务规则：
- 通过“termno-终端号”字段，上送终端的自定义管理编号，保证商户号下唯一，且必须为8位数字；
- 若不维护终端信息，则收银宝付款码支付交易无法发起；
- 流程说明：
- 调用【终端信息管理】接口，上送“operation-操作类型”字段，上送“00：新增”进行终端信息新增；
- 调用【终端信息管理】接口，上送 “operation-操作类型”字段，上送“01：修改”进行终端信息修改；
- 调用【终端信息管理】接口，上送 “operation-操作类型”字段，上送“02：注销”进行终端信息注销，注销后，则收银宝付款码支付不可使用该终端信息；
- 调用【终端信息管理】接口，上送 “operation-操作类型”字段，上送“03：查询”可查询终端报备信息；