一、支付产品介绍
1.1 产品概述
云商通2.0【当面付】是通联支付面向平台型商户提供的一款聚合扫码支付产品。用户扫码支付时、订单金额带出、支付结果异步通知等全流程被一并带出。商户交易的清结算由收银宝统一结算至商户银行账户。
该产品支持两种支付模式:
模式1:当面付码牌支付——商家创建订单后,消费者使用微信/支付宝/云闪付等App扫描商户当面付二维码,在H5页面输入通联订单号即可带出支付金额并完成支付。

模式2:自带参数的当面付订单支付H5——商家完成订单创建后,调用H5接口传入订单号和二维码ID等信息,页面直接跳转至收银宝当面付支付页面完成付款。
1.2 适用场景
当面付产品同时覆盖线上及线下收款场景:
|
业务场景 |
场景特点 |
典型应用案例 |
|
线下面对面收款 |
商户摆放收款二维码,消费者现场扫码 |
便利店、商超综合体、餐饮门店、医院缴费、学校收费、电影院、旅游景区等 |
|
线上商城支付 |
商户商城内点击支付,系统自动携带订单号跳转当面付页面完成支付 |
电商平台下单后跳转支付、小程序内发起支付 |
|
自助设备收款 |
自助终端生成动态订单码,用户扫码完成支付 |
自助售卖机、共享充电宝、无人值守场景 |
|
外卡受理 |
支持境外卡支付 |
入境游客消费场景、跨境旅游消费 |
1.3 商户入网
商户可联系通联分公司人员签署协议提交入网材料,审核通过入网成功后,即可进行支付产品开通。
二、技术开发准备
第一步:密钥获取(云梯)
设置商户公私钥、加密key


第二步:公共参数获取(云梯)
下载通联公钥

第三步:对接规范
调用通联接口,统一使用POST形式提交,数据格式统一为JOSN,相关SDK及签名方法如下:SDK示例:https://prodoc.allinpay.com/doc/1360/
三、接口说明
3.1 API列表
|
功能 |
接口名称 |
描述 |
|
订单创建 |
【2085-消费申请】【担保消费申请】【充值申请】 |
支付模式上送【FACETOFACEPAY_VSP】,创建预支付订单 |
|
支付结果通知 |
【订单结果通知】 |
收银宝异步通知支付结果,失败最多重试5次 |
|
订单查询 |
【3001-订单状态查询】、【3002-订单结果查询】 |
查询订单支付状态,支持轮询机制 |
|
订单关闭 |
【2295-订单关闭】 |
关闭未付款成功的订单 |
|
退款 |
【2294-退款申请】 |
支持部分退款、全额退款,隔天交易亦可退款 |
|
对账 |
【4002-对账单文件下载】 |
下载对账文件进行交易对账 |
3.2 消费流程
模式1:当面付码牌支付
商户调用【消费申请】/【担保消费申请】/【充值申请】,支付模式上送FACETOFACEPAY_VSP,创建订单;
消费者使用微信/支付宝/云闪付等App扫描商户当面付二维码,进入H5支付页面;
消费者输入通联订单号系统自动带出支付金额;
消费者确认金额并完成支付;
云商通系统根据订单号更新订单状态并进行账务处理。

模式2:自带参数的当面付订单支付H5
商户调用【消费申请】/【担保消费申请】/【充值申请】,支付模式上送FACETOFACEPAY_VSP,创建订单;
商户调用【自带参数的当面付订单支付H5】接口,上送通联订单号、二维码ID等参数,跳转至收银宝当面付支付页面;
当面付系统根据订单号查询订单信息并展示给消费者确认;
消费者完成支付;
收银宝异步通知云商通支付结果;
云商通更新订单状态并进行账务处理。

支付模式字段说明
支付模式为FACETOFACEPAY_VSP-当面付时,【消费申请】/【担保消费申请】/【充值申请】接口需注意以下必填字段:
|
字段 |
字段类型 |
是否必填 |
字段名称 |
说明 |
|
payMode |
JSONObject |
是 |
支付模式 |
FACETOFACEPAY_VSP(当面付) |
|
vspCusid |
String |
是 |
收银宝子商户号 |
集团模式下必填 |
|
trxReserve |
String |
否 |
业务备注信息 |
订单详情标签个性化说明 |
|
orderValidTime |
String |
否 |
订单过期时间 |
yyyy-MM-dd HH:mm:ss,默认60分钟 |
|
extendParams |
String |
否 |
渠道拓展参数 |
最长1000字符 |
【消费申请】响应字段关注以下内容:
|
字段 |
字段类型 |
是否必填 |
字段名称 |
说明 |
|
respTraceNum |
String |
是 |
通联订单号 |
用于后续订单状态查询及支付 |
|
respCode |
String |
是 |
业务返回码 |
SUCCESS表示成功,其他表示处理中或失败 |
|
respMsg |
String |
是 |
业务返回说明 |
失败时返回失败原因 |
|
result |
String |
否 |
订单状态 |
交易处理中/成功/失败 |
订单创建成功后注意事项:
|
字段 |
字段类型 |
说明 |
|
payAmount |
Long |
支付金额(单位:分) |
|
orderAmount |
Long |
订单金额(单位:分) |
|
chnlFrontParamInfo |
JSON |
渠道参数信息 |
若长时间未收到支付结果通知,可调用【订单状态查询】及【订单详情查询】接口查询交易状态。
3.3 退款流程
当面付支付模式的交易支持接口退款和终端退款两种模式。
3.3.1 接口退款
商户调用【退款申请】接口发起退款,云商通调用收银宝【4.5交易退款API】进行处理,支持部分金额退款,隔天交易亦可退款。交易完成后建议间隔几分钟(最短5分钟)再调用退款接口,避免订单状态同步不及时导致退款失败。注意:云闪付(银联扫码)含单品优惠的交易仅支持整单退款,不支持部分退款。
退款接口关键参数:
|
字段 |
字段类型 |
是否必填 |
字段名称 |
说明 |
|
orgRespTraceNum |
String |
否 |
原通联订单号 |
与“orgReqTraceNum+orgTransDate”二选一必填 |
|
orgReqTraceNum |
String |
否 |
商户订单号 |
与原订单创建时上送的一致 |
|
orgTransDate |
String |
否 |
订单时间 |
yyyy-MM-dd |
|
orderAmount |
Long |
是 |
退款总金额 |
单位:分,支持部分退款和多次退款,累计不超过支付金额 |
|
respUrl |
String |
否 |
后台通知地址 |
用于接收退款结果异步通知 |
3.3.2 终端退款
当用户在收银宝侧直接发起终端退款时,云商通收到“当面付终端退款”通知后进行如下处理:
根据业务流水号bizseq定位原订单;
校验通知金额是否与原订单支付金额一致——不一致则不处理,记录“非全额退款不支持终端退款”;
校验原订单是否已发生过退款——已退款过则不处理,记录“原订单已发生退款不允许终端退款”;
校验通过后生成退款订单,对原订单所有金额进行原路退回。
退款交易需记录在【日志管理-POS及当面付订单查询及通知日志】菜单。

3.4 订单管理
|
订单类型 |
订单状态 |
场景说明 |
|
消费/充值/担保消费 |
0进行中 |
订单创建成功,等待用户扫码支付;或用户已扫码支付、通道处理中 |
|
1交易成功 |
支付成功,资金已扣款 |
|
|
2交易失败 |
用户取消支付、密码错误、余额不足、风控拦截等;或订单超过有效期自动关闭 |
|
|
退款 |
0:进行中 |
退款中:商户已调用退款接口,通联受理退款请求,微信 / 银行正在处理退款。 |
|
1:交易成功 |
退款成功:资金已原路退回用户账户,退款流程完结。 |
|
|
2:交易失败 |
退款失败:超过退款有效期、通道拒绝、账户异常等原因导致退款无法完成。 |
3.5 订单对账
为满足财务对账需求,通联支持商户下载对账文件。具体方式如下:
- 门户下载对账文件:可在商户门户【对账单下载】菜单下载对账文件


- 调用API接口获取对账文件
商户可调用【下载商户对账文件】接口下载对账文件,支持日度、月度对账文件获取,文件格式支持 CSV/Excel,包含订单号、交易金额、退款金额、手续费、交易时间、支付方式等核心字段。