小程序
取消
开发
中文
EN
取消
  • 云服务

    • # Cloud.CloudPay

    云调用微信支付 API 对象，提供微信支付相关服务端接口能力，支持统一下单、订单查询与关闭、退款、对账单下载，以及分账（添加/删除接收方、单次/多次分账、分账查询/完结/回退）等操作。所有方法均在云函数端调用。

    # 方法

    方法 功能说明
    CloudPay.unifiedOrder() 统一下单。在微信支付服务后台生成预支付交易单，返回 payment 对象供小程序端调用 wx.requestPayment 调起支付。通过 envId 和 functionName 设置接收支付结果异步通知的回调云函数。
    CloudPay.queryOrder() 查询订单。通过微信订单号或商户订单号查询订单状态及交易详情，用于支付通知异常、系统错误等场景下主动确认订单状态。
    CloudPay.closeOrder() 关闭订单。对尚未支付的订单进行关闭，避免重复支付。注意：订单生成后不能马上调用，最短调用时间间隔为 5 分钟。
    CloudPay.refund() 申请退款。对已支付订单发起退款，资金按原路退回用户账户。支持单笔订单分多次部分退款，总退款金额不超过订单金额，交易时间超过一年的订单无法退款。
    CloudPay.queryRefund() 查询退款。通过微信订单号、商户订单号、商户退款单号或微信退款单号（四选一）查询退款状态及退款详情，支持分页查询。
    CloudPay.downloadBill() 下载对账单。获取指定日期的交易清单，用于商户侧与微信侧数据核对。支持下载全部订单、成功支付订单或退款订单，仅可下载三个月以内的账单。
    CloudPay.profitSharing() 请求单次分账。按传入的分账接收方进行分账，同时将订单剩余待分账金额全部解冻给特约商户。操作成功后，该订单不能再进行分账或分账完结。
    CloudPay.multiProfitSharing() 请求多次分账。按传入的分账接收方进行分账，不对剩余金额做任何操作，待分账金额不为零时订单仍可继续分账。同一笔订单最多发起 20 次多次分账。
    CloudPay.profitSharingAddReceiver() 添加分账接收方。服务商代子商户添加分账接收方，添加后方可对该接收方发起分账。
    CloudPay.profitSharingRemoveReceiver() 删除分账接收方。从分账关系中移除已添加的接收方，删除后不再支持对其分账。
    CloudPay.profitSharingQuery() 查询分账结果。通过微信订单号和商户分账单号查询分账执行状态及各接收方分账明细，也可查询分账完结的执行结果。
    CloudPay.profitSharingFinish() 完结分账。将订单剩余待分账金额全部解冻给特约商户。无需分账的订单也可直接调用此接口解冻全部金额，已调用单次分账的订单无需再调用。
    CloudPay.profitSharingReturn() 分账回退。对已分账的资金发起回退，将已分给商户类型接收方的金额退回给特约商户。以原分账请求为依据，支持多次回退，累计不超过该接收方分得的金额。需接收方在商户平台开启同意分账回退。
    CloudPay.profitSharingReturnQuery() 回退结果查询。通过商户回退单号查询分账回退的执行状态，用于回退接口返回处理中时核实最终结果。