支付宝小程序Serverless 支付能力API·cloud.payment.common.close

cloud.payment.common.close 是通用接口的关闭交易接口。

入参说明

字段名	类型	必填	说明
outTradeNo	String	是	交易创建时传入的商户订单号
notify_url	String	否	支付宝服务器主动通知商户服务器里指定的页面http/https路径，也可以是云函数的http触发路径。
appAuthToken	String	否	三方代调用应用访问令牌，目前仅在云函数中调用支持。

调用示例

在云函数中调用

// 云函数中使用云调用无需引入其他依赖，只需要使用ctx.cloud调用
module.exports = async function (ctx) {
  const res = await ctx.cloud.payment.common.close({
    // 参数接收自云函数调用端传入的参数
    outTradeNo: ctx.args.outTradeNo
  });
  return res;
};

支持传入notifyUrl接收支付宝服务器交易通知

// 云函数中使用云调用无需引入其他依赖，只需要使用ctx.cloud调用
module.exports = async function (ctx) {
  const res = await ctx.cloud.payment.common.close({
    // 参数接收自云函数调用端传入的参数
    outTradeNo: ctx.args.outTradeNo
  }, {
    // 传入接收支付宝服务器交易通知的http/https路径，也可以是云函数的http触发路径
    notify: {
        url: 'http://api.test.alipay.net/atinterface/receive_notify.htm'
    }
  });
  return res;
};

支持传入appAuthToken进行三方代调用

// 云函数中使用云调用无需引入其他依赖，只需要使用ctx.cloud调用
module.exports = async function (ctx) {
  const res = await ctx.cloud.payment.common.close({
    // 参数接收自云函数调用端传入的参数
    outTradeNo: ctx.args.outTradeNo
  }, {
    // appAuthToken参数接收自云函数调用处传入的参数
    appAuthToken: ctx.args.appAuthToken
  });
  return res;
};

在小程序页面调用

alipay-serverless-sdk 版本&=1.0.0

const closeRes = await cloud.payment.common.close({
    outTradeNo: this.data.outTradeNo
  });

alipay-serverless-sdk 版本<1.0.0

const closeResult = await cloud.payment.common.close(this.data.outTradeNo);

返回数据示例

{
    "code":"10000",
    "msg":"Success",
    "trade_no":"2013112111001004500000675971",
    "out_trade_no":"YX_001"
}