Global

Methods

(async) appPay() → {*}

APP支付 支付宝原生APP支付，返回APP端拉起支付宝所需的参数
Parameters:
Name Type Description
params.out_trade_no * 商户订单号
params.total_fee * 支付金额 单位:元
params.mch_id * 支付宝商户号 登录yungouos.com-》支付宝-》商户管理 支付宝商户号 获取
params.body * 商品描述
params.app_id * 在YunGouOS平台报备的app_id，不传则按照商户号开户时的场景发起。
params.attach * 附加数据，回调时候原路返回
params.notify_url * 异步回调地址，用户支付成功后系统将会把支付结果发送到该地址，不填则无回调
params.hbfq_num * 花呗分期期数。只支持3、6、12（仅限渠道商户使用）
params.hbfq_percent * 花呗分期商户承担手续费比例。只支持0、100（仅限渠道商户使用）
params.payKey * 支付密钥 登录yungouos.com-》支付宝-》商户管理 支付密钥 获取
params.biz_params * 附加业务参数。json对象，具体参考API文档
Source:
See:
Returns:
返回APP端拉起支付宝所需的参数
Type
*

(async) appPay() → {*}

APP支付 微信APP支付接口，返回APP拉起微信支付的参数，用户只需在APP端做拉起支付的动作即可。
Parameters:
Name Type Description
params.app_id * 微信开放平台申请的APPID
params.out_trade_no * 商户订单号
params.total_fee * 支付金额 单位:元
params.mch_id * 微信支付商户号 登录yungouos.com-》微信支付-》商户管理 微信支付商户号 获取
params.body * 商品描述
params.attach * 附加数据，回调时候原路返回
params.notify_url * 异步回调地址，用户支付成功后系统将会把支付结果发送到该地址，不填则无回调
params.auto * 分账模式。【0：不分账 1：自动分账 2：手动分账】 默认 0
params.auto_node * 执行自动分账动作的节点，枚举值【pay、callback】分别表示【付款成功后分账、回调成功后分账】
params.config_no * 分账配置单号。支持多个分账，使用,号分割
params.biz_params * 附加业务参数。json对象，具体参考API文档
Source:
See:
Returns:
参考文档：https://open.pay.yungouos.com/#/api/api/pay/wxpay/appPay
Type
*

(async) cashierPay() → {*}

收银台支付 收银台支付是进一步对支付接口的封装，商户无需关注调用什么接口，收银台自动识别用户设备完成发起支付并提供相关支付页面。尤其是公众号支付需要获取openid，使用收银台支付商户无需关注该流程，收银台自动完成该操作。用户在页面完成支付后返回商户自己网站，收银台将携带参数重定向到商户传递的return_url上。重定向携带参数与异步回调参数一致，通过url拼接方式
Parameters:
Name Type Description
params.out_trade_no * 商户订单号
params.total_fee * 支付金额 单位:元
params.mch_id * 微信支付商户号 登录yungouos.com-》微信支付-》商户管理 微信支付商户号 获取
params.body * 商品描述
params.app_id * 在YunGouOS平台报备的app_id，不传则按照商户号开户时的场景发起。
params.attach * 附加数据，回调时候原路返回
params.notify_url * 异步回调地址，用户支付成功后系统将会把支付结果发送到该地址，不填则无回调
params.return_url * 同步回调地址，不传支付后关闭页面
params.auto * 分账模式。【0：不分账 1：自动分账 2：手动分账】 默认 0
params.auto_node * 执行自动分账动作的节点，枚举值【pay、callback】分别表示【付款成功后分账、回调成功后分账】
params.config_no * 分账配置单号。支持多个分账，使用,号分割
params.biz_params * 附加业务参数。json对象，具体参考API文档
Source:
See:
Returns:
收银台支付链接地址
Type
*

(async) closeOrder() → {*}

关闭订单 对已经发起的订单进行关闭，订单如果已支付不能关闭。已支付订单需要关闭请使用撤销订单接口
Parameters:
Name Type Description
params.out_trade_no * 商户单号
params.mch_id * 支付宝商户号 登录yungouos.com-》支付宝-》商户管理 支付宝 获取
Source:
See:
Returns:
参考文档：https://open.pay.yungouos.com/#/api/api/pay/alipay/closeOrder
Type
*

(async) closeOrder() → {*}

关闭订单 对已经发起的订单进行关闭，订单如果已支付不能关闭。已支付订单需要关闭请使用撤销订单接口
Parameters:
Name Type Description
params.out_trade_no * 商户单号
params.mch_id * 微信支付商户号 登录yungouos.com-》微信支付-》商户管理 微信支付商户号 获取
Source:
See:
Returns:
参考文档：https://open.pay.yungouos.com/#/api/api/pay/wxpay/closeOrder
Type
*

(async) codePay() → {*}

条码支付 用户打开支付宝出示付款码，商家通过扫码枪、扫码盒子等设备主动扫描用户付款码完成扣款。
Parameters:
Name Type Description
params.out_trade_no * 商户订单号
params.total_fee * 支付金额 单位:元
params.mch_id * 支付宝商户号 登录yungouos.com-》支付宝-》商户管理 支付宝商户号 获取
params.body * 商品描述
params.auth_code * 扫码支付授权码，设备读取用户支付宝中的条码或者二维码信息
params.app_id * 在YunGouOS平台报备的app_id，不传则按照商户号开户时的场景发起。
params.attach * 附加数据，回调时候原路返回
params.notify_url * 异步回调地址，用户支付成功后系统将会把支付结果发送到该地址，不填则无回调
params.hbfq_num * 花呗分期期数。只支持3、6、12（仅限渠道商户使用）
params.hbfq_percent * 花呗分期商户承担手续费比例。只支持0、100（仅限渠道商户使用）
params.biz_params * 附加业务参数。json对象，具体参考API文档
Source:
See:
Returns:
返回二维码支付链接地址或原生支付链接
Type
*

(async) codePay() → {*}

条码支付 线下付款码被扫支付，用于扫码枪、扫码盒子、刷脸支付等场景
Parameters:
Name Type Description
params.out_trade_no * 商户订单号
params.total_fee * 支付金额 单位:元
params.mch_id * 微信支付商户号 登录yungouos.com-》微信支付-》商户管理 微信支付商户号 获取
params.body * 商品描述
params.auth_code * 返回类型（1、返回微信原生的支付连接需要自行生成二维码；2、直接返回付款二维码地址，页面上展示即可。不填默认1 ）
params.app_id * 在YunGouOS平台报备的app_id，不传则按照商户号开户时的场景发起。
params.attach * 附加数据，回调时候原路返回
params.receipt * 是否开具电子发票 0：否 1：是 默认0
params.notify_url * 异步回调地址，用户支付成功后系统将会把支付结果发送到该地址，不填则无回调
params.auto * 分账模式。【0：不分账 1：自动分账 2：手动分账】 默认 0
params.auto_node * 执行自动分账动作的节点，枚举值【pay、callback】分别表示【付款成功后分账、回调成功后分账】
params.config_no * 分账配置单号。支持多个分账，使用,号分割
params.biz_params * 附加业务参数。json对象，具体参考API文档
Source:
See:
Returns:
参考文档：https://open.pay.yungouos.com/#/api/api/pay/wxpay/codePay
Type
*

config()

商户信息配置 登录yungouos.com-》支付宝-》商户管理 支付宝商户号 获取
Parameters:
Name Type Description
params.mid * 商户号
params.secret * 商户密钥
Source:

config()

商户信息配置 登录yungouos.com-》微信支付-》商户管理 微信支付商户号 获取
Parameters:
Name Type Description
params.mid * 商户号
params.secret * 商户密钥
Source:

(async) downloadBill() → {*}

下载对账单 下载微信官方对账单。商户可以通过该接口下载历史交易清单。返回excel下载地址和原生数据
Parameters:
Name Type Description
params.mch_id * 微信支付商户号 登录yungouos.com-》微信支付-》商户管理 微信支付商户号 获取
params.date * 对账单日期 示例值：2020-01-23
params.end_date * 对账单结束日期 示例值：2020-01-25
params.device_info * 设备或门店信息，接口下单时候通过biz_params传递
Source:
See:
Returns:
参考文档：https://open.pay.yungouos.com/#/api/api/pay/wxpay/downloadBill
Type
*

(async) facePay() → {*}

刷脸支付 微信刷脸支付，通过微信刷脸SDK或青蛙APP调用摄像头获取到扫描人脸获取到人脸数据后，发起刷脸支付请求，进行支付扣款。
Parameters:
Name Type Description
params.out_trade_no * 商户订单号
params.total_fee * 支付金额 单位:元
params.mch_id * 微信支付商户号 登录yungouos.com-》微信支付-》商户管理 微信支付商户号 获取
params.body * 商品描述
params.openId * 用户openId（调用授权接口获取）
params.face_code * 人脸凭证，通过摄像头配合微信刷脸SDK获得
params.app_id * 在YunGouOS平台报备的app_id，不传则按照商户号开户时的场景发起。
params.attach * 附加数据，回调时候原路返回
params.notify_url * 异步回调地址，用户支付成功后系统将会把支付结果发送到该地址，不填则无回调
params.auto * 分账模式。【0：不分账 1：自动分账 2：手动分账】 默认 0
params.auto_node * 执行自动分账动作的节点，枚举值【pay、callback】分别表示【付款成功后分账、回调成功后分账】
params.config_no * 分账配置单号。支持多个分账，使用,号分割
params.biz_params * 附加业务参数。json对象，具体参考API文档
Source:
See:
Returns:
参考文档：https://open.pay.yungouos.com/#/api/api/pay/wxpay/facePay
Type
*

(async) getFacePayAuthInfo() → {*}

刷脸支付凭证 微信刷脸支付SDK模式，适用于自研安卓、windows应用在微信刷脸设备上使用微信刷脸SDK接入刷脸支付。等同于微信刷脸流程中的【获取调用凭证】步骤
Parameters:
Name Type Description
params.mch_id * 微信支付商户号 登录yungouos.com-》微信支付-》商户管理 微信支付商户号 获取
params.store_id * 门店编号，由商户定义，各门店唯一。
params.store_name * 门店名称，由商户定义。（可用于展示）
params.face_auth_info * 人脸数据。调用【get_wxpayface_authinfo】接口获取到的结果
params.device_id * 终端设备编号，由商户定义。
params.app_id * 在YunGouOS平台报备的app_id，不传则按照商户号开户时的场景发起。
params.attach * 附加数据，需要JSON字符串格式
params.biz_params * 附加业务参数。json对象，具体参考API文档
Source:
See:
Returns:
参考文档：https://open.pay.yungouos.com/#/api/api/pay/wxpay/getFacePayAuthInfo
Type
*

(async) getRefundResult() → {*}

查询退款结果 对已发起退款申请的订单查询支付宝的退款结果
Parameters:
Name Type Description
params.refund_no * 退款单号
params.mch_id * 支付宝商户号 登录yungouos.com-》支付宝-》商户管理 支付宝商户号 获取
Source:
See:
Returns:
参考文档：https://open.pay.yungouos.com/#/api/api/pay/alipay/getRefundResult
Type
*

(async) getRefundResult() → {*}

查询退款结果 对已发起退款申请的订单查询微信支付的退款结果
Parameters:
Name Type Description
params.refund_no * 退款单号
params.mch_id * 微信支付商户号 登录yungouos.com-》微信支付-》商户管理 微信支付商户号 获取
Source:
See:
Returns:
参考文档：https://open.pay.yungouos.com/#/api/api/pay/wxpay/getRefundResult
Type
*

(async) h5Pay() → {*}

H5支付 支付宝H5手机网站接口，可自动打开支付宝APP支付。和WAP接口不同的是，H5可以传递return_url也就是支付后或取消支付可以自动跳回网站
Parameters:
Name Type Description
params.out_trade_no * 商户订单号
params.total_fee * 支付金额 单位:元
params.mch_id * 支付宝商户号 登录yungouos.com-》支付宝-》商户管理 支付宝商户号 获取
params.body * 商品描述
params.app_id * 在YunGouOS平台报备的app_id，不传则按照商户号开户时的场景发起。
params.attach * 附加数据，回调时候原路返回
params.notify_url * 异步回调地址，用户支付成功后系统将会把支付结果发送到该地址，不填则无回调
params.return_url * 同步回调地址，用户支付成功后或取消支付都会跳转回到该地址
params.hbfq_num * 花呗分期期数。只支持3、6、12（仅限渠道商户使用）
params.hbfq_percent * 花呗分期商户承担手续费比例。只支持0、100（仅限渠道商户使用）
params.payKey * 支付密钥 登录yungouos.com-》支付宝-》商户管理 支付密钥 获取
params.biz_params * 附加业务参数。json对象，具体参考API文档
Source:
See:
Returns:
返回支付宝H5支付的form表单
Type
*

(async) jsPay() → {*}

JS支付 JS支付，适用于支付宝网页内打开的H5应用使用支付宝的JSSDK发起支付
Parameters:
Name Type Description
params.out_trade_no * 商户订单号
params.total_fee * 支付金额 单位:元
params.mch_id * 支付宝商户号 登录yungouos.com-》支付宝-》商户管理 支付宝商户号 获取
params.buyer_id * 买家的支付宝唯一用户号（2088开头的16位纯数字）
params.body * 商品描述
params.app_id * 在YunGouOS平台报备的app_id，不传则按照商户号开户时的场景发起。
params.attach * 附加数据，回调时候原路返回
params.notify_url * 异步回调地址，用户支付成功后系统将会把支付结果发送到该地址，不填则无回调
params.hbfq_num * 花呗分期期数。只支持3、6、12（仅限渠道商户使用）
params.hbfq_percent * 花呗分期商户承担手续费比例。只支持0、100（仅限渠道商户使用）
params.biz_params * 附加业务参数。json对象，具体参考API文档
Source:
See:
Returns:
返回支付宝的JSSDK所需的参数
Type
*

(async) jsPay() → {*}

公众号支付/JSAPI 用户在微信内的商户H5页面发起支付。
Parameters:
Name Type Description
params.out_trade_no * 商户订单号
params.total_fee * 支付金额 单位:元
params.mch_id * 微信支付商户号 登录yungouos.com-》微信支付-》商户管理 微信支付商户号 获取
params.body * 商品描述
params.openId * 用户openId 通过授权接口获得
params.app_id * 在YunGouOS平台报备的app_id，不传则按照商户号开户时的场景发起。
params.attach * 附加数据，回调时候原路返回
params.notify_url * 异步回调地址，用户支付成功后系统将会把支付结果发送到该地址，不填则无回调
params.return_url * 同步地址。支付完毕后用户浏览器返回到该地址
params.auto * 分账模式。【0：不分账 1：自动分账 2：手动分账】 默认 0
params.auto_node * 执行自动分账动作的节点，枚举值【pay、callback】分别表示【付款成功后分账、回调成功后分账】
params.config_no * 分账配置单号。支持多个分账，使用,号分割
params.biz_params * 附加业务参数。json对象，具体参考API文档
Source:
See:
Returns:
JSSDK支付需要的jspackage
Type
*

(async) minAppPay() → {*}

微信小程序支付（个体户、企业） 微信小程序支付，获取小程序支付所需参数，需自行通过小程序wx.requestPayment拉起支付
Parameters:
Name Type Description
params.out_trade_no * 商户订单号
params.total_fee * 支付金额 单位:元
params.mch_id * 微信支付商户号 登录yungouos.com-》微信支付-》商户管理 微信支付商户号 获取
params.body * 商品描述
params.openId * 用户openId（调用小程序wx.login接口获取）
params.app_id * 在YunGouOS平台报备的app_id，不传则按照商户号开户时的场景发起。
params.attach * 附加数据，回调时候原路返回
params.notify_url * 异步回调地址，用户支付成功后系统将会把支付结果发送到该地址，不填则无回调
params.auto * 分账模式。【0：不分账 1：自动分账 2：手动分账】 默认 0
params.auto_node * 执行自动分账动作的节点，枚举值【pay、callback】分别表示【付款成功后分账、回调成功后分账】
params.config_no * 分账配置单号。支持多个分账，使用,号分割
params.biz_params * 附加业务参数。json对象，具体参考API文档
Source:
See:
Returns:
返回小程序API wx.requestPayment所需的支付参数
Type
*

(async) minAppPayParams() → {*}

微信小程序支付（个人） 微信小程序支付，获取小程序支付所需参数，需自行通过小程序跳转API发起支付
Parameters:
Name Type Description
params.out_trade_no * 商户订单号
params.total_fee * 支付金额 单位:元
params.mch_id * 微信支付商户号 登录yungouos.com-》微信支付-》商户管理 微信支付商户号 获取
params.body * 商品描述
params.app_id * 在YunGouOS平台报备的app_id，不传则按照商户号开户时的场景发起。
params.attach * 附加数据，回调时候原路返回
params.title * 支付收银小程序页面顶部的title 可自定义品牌名称 不传默认为 “收银台” 如传递参数 “海底捞” 页面则显示 “海底捞-收银台”
params.notify_url * 异步回调地址，用户支付成功后系统将会把支付结果发送到该地址，不填则无回调
params.auto * 分账模式。【0：不分账 1：自动分账 2：手动分账】 默认 0
params.auto_node * 执行自动分账动作的节点，枚举值【pay、callback】分别表示【付款成功后分账、回调成功后分账】
params.config_no * 分账配置单号。支持多个分账，使用,号分割
params.biz_params * 附加业务参数。json对象，具体参考API文档
Source:
See:
Returns:
返回跳转“支付收银”小程序所需的参数
Type
*

(async) minAppPayV3() → {*}

微信小程序支付(原生)（支持个人、个体户、企业） 微信小程序支付，获取小程序支付所需参数，需自行通过小程序wx.requestPayment拉起支付
Parameters:
Name Type Description
params.out_trade_no * 商户订单号
params.total_fee * 支付金额 单位:元
params.mch_id * 微信支付商户号 登录yungouos.com-》微信支付-》商户管理 微信支付商户号 获取
params.body * 商品描述
params.open_id * 用户open_id（调用小程序wx.login接口获取）
params.app_id * 在YunGouOS平台报备的app_id，不传则按照商户号开户时的场景发起。
params.attach * 附加数据，回调时候原路返回
params.notify_url * 异步回调地址，用户支付成功后系统将会把支付结果发送到该地址，不填则无回调
params.auto * 分账模式。【0：不分账 1：自动分账 2：手动分账】 默认 0
params.auto_node * 执行自动分账动作的节点，枚举值【pay、callback】分别表示【付款成功后分账、回调成功后分账】
params.config_no * 分账配置单号。支持多个分账，使用,号分割
params.biz_params * 附加业务参数。json对象，具体参考API文档
Source:
See:
Returns:
返回小程序API wx.requestPayment所需的支付参数
Type
*

(async) nativePay() → {*}

扫码支付 同步发起扫码支付 返回原生支付链接或二维码连接地址，根据type类型决定
Parameters:
Name Type Description
params.out_trade_no * 商户订单号
params.total_fee * 支付金额 单位:元
params.mch_id * 支付宝商户号 登录yungouos.com-》支付宝-》商户管理 支付宝商户号 获取
params.body * 商品描述
params.type * 返回类型（1、返回支付宝原生的支付连接需要自行生成二维码；2、直接返回付款二维码地址，页面上展示即可。不填默认1）
params.app_id * 在YunGouOS平台报备的app_id，不传则按照商户号开户时的场景发起。
params.attach * 附加数据，回调时候原路返回
params.notify_url * 异步回调地址，用户支付成功后系统将会把支付结果发送到该地址，不填则无回调
params.hbfq_num * 花呗分期期数。只支持3、6、12（仅限渠道商户使用）
params.hbfq_percent * 花呗分期商户承担手续费比例。只支持0、100（仅限渠道商户使用）
params.biz_params * 附加业务参数。json对象，具体参考API文档
Source:
See:
Returns:
返回Promise化结果，需要自行处理返回结果
Type
*

(async) nativePay() → {*}

扫码支付 同步发起扫码支付 返回原生支付链接或二维码连接地址，根据type类型决定
Parameters:
Name Type Description
params.out_trade_no * 商户订单号
params.total_fee * 支付金额 单位:元
params.mch_id * 微信支付商户号 登录yungouos.com-》微信支付-》商户管理 微信支付商户号 获取
params.body * 商品描述
params.type * 返回类型（1、返回微信原生的支付连接需要自行生成二维码；2、直接返回付款二维码地址，页面上展示即可。不填默认1 ）
params.app_id * 在YunGouOS平台报备的app_id，不传则按照商户号开户时的场景发起。
params.attach * 附加数据，回调时候原路返回
params.notify_url * 异步回调地址，用户支付成功后系统将会把支付结果发送到该地址，不填则无回调
params.auto * 分账模式。【0：不分账 1：自动分账 2：手动分账】 默认 0
params.auto_node * 执行自动分账动作的节点，枚举值【pay、callback】分别表示【付款成功后分账、回调成功后分账】
params.config_no * 分账配置单号。支持多个分账，使用,号分割
params.biz_params * 附加业务参数。json对象，具体参考API文档
Source:
See:
Returns:
返回Promise化结果，需要自行处理返回结果
Type
*

(async) notifyVerify(params) → {*}

回调通知签名校验 支持异步回调、同步回调签名校验 (未支持退款回调通知验签)
Parameters:
Name Type Description
params * form表单形式数据
Source:
See:
Returns:
返回验签通过后的JSON结构数据, 验签不通过则抛出错误
Type
*

(async) notifyVerify(params) → {*}

回调通知签名校验 支持异步回调、同步回调签名校验 (未支持退款回调通知验签)
Parameters:
Name Type Description
params * form表单形式数据
Source:
See:
Returns:
返回验签通过后的JSON结构数据, 验签不通过则抛出错误
Type
*

(async) qqPay() → {*}

QQ小程序支付 QQ小程序内使用微信支付进行付款，返回拉起微信支付的URL。
Parameters:
Name Type Description
params.app_id * QQ小程序APPID
params.access_token * QQ小程序的access_token
params.out_trade_no * 商户订单号
params.total_fee * 支付金额 单位:元
params.mch_id * 微信支付商户号 登录yungouos.com-》微信支付-》商户管理 微信支付商户号 获取
params.body * 商品描述
params.attach * 附加数据，回调时候原路返回
params.notify_url * 异步回调地址，用户支付成功后系统将会把支付结果发送到该地址，不填则无回调
params.return_url * 同步回调地址，用户支付成功后从微信APP跳转回该地址。调转不会携带任何参数，如需携带参数请自行拼接
params.auto * 分账模式。【0：不分账 1：自动分账 2：手动分账】 默认 0
params.auto_node * 执行自动分账动作的节点，枚举值【pay、callback】分别表示【付款成功后分账、回调成功后分账】
params.config_no * 分账配置单号。支持多个分账，使用,号分割
params.biz_params * 附加业务参数。json对象，具体参考API文档
Source:
See:
Returns:
返回拉起微信支付的URL。
Type
*

(async) qqPayParams() → {*}

QQ小程序支付（个人） QQ小程序支付，获取小程序支付所需参数，需自行通过小程序跳转API发起支付
Parameters:
Name Type Description
params. * out_trade_no 商户订单号
params.total_fee * 支付金额 单位:元
params.mch_id * 微信支付商户号 登录yungouos.com-》微信支付-》商户管理 微信支付商户号 获取
params.body * 商品描述
params.app_id * 在YunGouOS平台报备的app_id，不传则按照商户号开户时的场景发起。
params.attach * 附加数据，回调时候原路返回
params.title * 支付收银小程序页面顶部的title 可自定义品牌名称 不传默认为 “收银台” 如传递参数 “海底捞” 页面则显示 “海底捞-收银台”
params.notify_url * 异步回调地址，用户支付成功后系统将会把支付结果发送到该地址，不填则无回调
params.auto * 分账模式。【0：不分账 1：自动分账 2：手动分账】 默认 0
params.auto_node * 执行自动分账动作的节点，枚举值【pay、callback】分别表示【付款成功后分账、回调成功后分账】
params.config_no * 分账配置单号。支持多个分账，使用,号分割
params.biz_params * 附加业务参数。json对象，具体参考API文档
Source:
See:
Returns:
返回跳转“支付收银”小程序所需的参数
Type
*

(async) queryOrder() → {*}

订单查询 根据订单号查询支付订单 (该接口限流，规则为1qps/10s)
Parameters:
Name Type Description
params.out_trade_no * 商户单号
params.mch_id * 微信支付商户号 登录yungouos.com-》微信支付-》商户管理 微信支付商户号 获取
Source:
See:
Returns:
参考文档：https://open.pay.yungouos.com/#/api/api/system/order/getPayOrderInfo
Type
*

(async) queryOrder() → {*}

订单查询 根据订单号查询支付订单 (该接口限流，规则为1qps/10s)
Parameters:
Name Type Description
params.out_trade_no * 商户单号
params.mch_id * 微信支付商户号 登录yungouos.com-》微信支付-》商户管理 微信支付商户号 获取
Source:
See:
Returns:
参考文档：https://open.pay.yungouos.com/#/api/api/system/order/getPayOrderInfo
Type
*

(async) refundOrder() → {*}

发起退款 对已支付的订单发起退款
Parameters:
Name Type Description
params.out_trade_no * 商户订单号
params.mch_id * 支付宝商户号 登录yungouos.com-》支付宝-》商户管理 支付宝商户号 获取
params.money * 退款金额
params.out_trade_refund_no * 商户自定义退款单号
params.refund_desc * 退款描述
params.notify_url * 异步回调地址，退款成功后会把退款结果发送到该地址，不填则无回调
Source:
See:
Returns:
参考文档：https://open.pay.yungouos.com/#/api/api/pay/alipay/refundOrder
Type
*

(async) refundOrder() → {*}

发起退款 对已支付的订单发起退款
Parameters:
Name Type Description
params.out_trade_no * 商户订单号
params.mch_id * 微信支付商户号 登录yungouos.com-》微信支付-》商户管理 微信支付商户号 获取
params.money * 退款金额
params.out_trade_refund_no * 商户自定义退款单号
params.refund_desc * 退款描述
params.notify_url * 异步回调地址，退款成功后会把退款结果发送到该地址，不填则无回调
Source:
See:
Returns:
参考文档：https://open.pay.yungouos.com/#/api/api/pay/wxpay/refundOrder
Type
*

(async) reverseOrder() → {*}

撤销订单 支付交易返回失败或支付系统超时，调用该接口撤销交易。
Parameters:
Name Type Description
params.out_trade_no * 商户单号
params.mch_id * 支付宝商户号 登录yungouos.com-》支付宝-》商户管理 支付宝 获取
Source:
See:
Returns:
参考文档：https://open.pay.yungouos.com/#/api/api/pay/alipay/reverseOrder
Type
*

(async) reverseOrder() → {*}

撤销订单 支付交易返回失败或支付系统超时，调用该接口撤销交易。如果此订单用户支付失败，微信支付系统会将此订单关闭；如果用户支付成功，微信支付系统会将此订单资金退还给用户。
Parameters:
Name Type Description
params.out_trade_no * 商户单号
params.mch_id * 微信支付商户号 登录yungouos.com-》微信支付-》商户管理 微信支付商户号 获取
Source:
See:
Returns:
参考文档：https://open.pay.yungouos.com/#/api/api/pay/wxpay/reverseOrder
Type
*

(async) wapPay(params) → {*}

WAP支付 返回支付宝WAP支付连接，重定向到该地址即可。安装了支付宝APP将自动唤起支付宝APP进行支付
Parameters:
Name Type Description
params * 请求参数
Properties
Name Type Description
out_trade_no * 商户订单号
total_fee * 支付金额 单位:元
mch_id * 支付宝商户号 登录yungouos.com-》支付宝-》商户管理 支付宝商户号 获取
body * 商品描述
app_id * 在YunGouOS平台报备的app_id，不传则按照商户号开户时的场景发起。
attach * 附加数据，回调时候原路返回
notify_url * 异步回调地址，用户支付成功后系统将会把支付结果发送到该地址，不填则无回调
hbfq_num * 花呗分期期数。只支持3、6、12（仅限渠道商户使用）
hbfq_percent * 花呗分期商户承担手续费比例。只支持0、100（仅限渠道商户使用）
biz_params * 附加业务参数。json对象，具体参考API文档
Source:
See:
Returns:
返回支付宝WAP支付连接
Type
*

(async) wapPay() → {*}

H5支付 微信H5支付接口，在非微信以外的第三方浏览器环境下拉起微信客户端进行付款。
Parameters:
Name Type Description
params.out_trade_no * 商户订单号
params.total_fee * 支付金额 单位:元
params.mch_id * 微信支付商户号 登录yungouos.com-》微信支付-》商户管理 微信支付商户号 获取
params.body * 商品描述
params.app_id * 在YunGouOS平台报备的app_id，不传则按照商户号开户时的场景发起。
params.attach * 附加数据，回调时候原路返回
params.notify_url * 异步回调地址，用户支付成功后系统将会把支付结果发送到该地址，不填则无回调
params.return_url * 同步回调地址，用户支付成功后从微信APP跳转回该地址。调转不会携带任何参数，如需携带参数请自行拼接
params.auto * 分账模式。【0：不分账 1：自动分账 2：手动分账】 默认 0
params.auto_node * 执行自动分账动作的节点，枚举值【pay、callback】分别表示【付款成功后分账、回调成功后分账】
params.config_no * 分账配置单号。支持多个分账，使用,号分割
params.biz_params * 附加业务参数。json对象，具体参考API文档
Source:
See:
Returns:
返回拉起微信支付的URL。
Type
*

(async) webPay() → {*}

电脑网站支付 支付宝电脑网站支付，适合PC端使用，返回PC端跳转表单字符串和跳转url
Parameters:
Name Type Description
params.out_trade_no * 商户订单号
params.total_fee * 支付金额 单位:元
params.mch_id * 支付宝商户号 登录yungouos.com-》支付宝-》商户管理 支付宝商户号 获取
params.body * 商品描述
params.app_id * 在YunGouOS平台报备的app_id，不传则按照商户号开户时的场景发起。
params.attach * 附加数据，回调时候原路返回
params.notify_url * 异步回调地址，用户支付成功后系统将会把支付结果发送到该地址，不填则无回调
params.return_url * 同步回调地址，用户支付成功后或取消支付都会跳转回到该地址
params.hbfq_num * 花呗分期期数。只支持3、6、12（仅限渠道商户使用）
params.hbfq_percent * 花呗分期商户承担手续费比例。只支持0、100（仅限渠道商户使用）
params.biz_params * 附加业务参数。json对象，具体参考API文档
Source:
See:
Returns:
返回PC端跳转表单字符串和跳转url
Type
*