支付宝小程序Serverless 支付能力API·cloud.payment.common.cancel
cloud.payment.common.cancel 是通用接口的撤销交易接口。
入参说明
字段名 | 类型 | 必填 | 说明 |
---|---|---|---|
outTradeNo | String | 是 | 交易创建时传入的商户订单号 |
appAuthToken | String | 否 | 三方代调用应用访问令牌,目前仅在云函数中调用支持。 |
调用示例
在云函数中调用
// 云函数中使用云调用无需引入其他依赖,只需要使用ctx.cloud调用
module.exports = async function (ctx) {
const res = await ctx.cloud.payment.common.cancel({
// 参数接收自云函数调用端传入的参数
outTradeNo: ctx.args.outTradeNo
});
return res;
};
支持传入appAuthToken进行三方代调用
// 云函数中使用云调用无需引入其他依赖,只需要使用ctx.cloud调用
module.exports = async function (ctx) {
const res = await ctx.cloud.payment.common.cancel({
// 参数接收自云函数调用端传入的参数
outTradeNo: ctx.args.outTradeNo
}, {
// appAuthToken参数接收自云函数调用处传入的参数
appAuthToken: ctx.args.appAuthToken
});
return res;
};
在小程序页面调用
alipay-serverless-sdk 版本&=1.0.0
const cancelResult = await cloud.payment.common.cancel({
outTradeNo: this.data.outTradeNo
});
alipay-serverless-sdk 版本<1.0.0
const cancelResult = await cloud.payment.common.cancel(this.data.outTradeNo);
返回数据示例
{
"code":"10000",
"msg":"Success",
"trade_no":"2013112011001004330000121536",
"out_trade_no":"6823789339978248",
"retry_flag":"N",
"action":"close",
"gmt_refund_pay":"2016-11-27 15:45:57",
"refund_settlement_id":"2018101610032004620239146945"
}