Skip to content

alipay ​

支付宝支付。

概述 ​

支付宝支付包含 App、网页表单和 H5 三种方式。使用前需要在站点 CMS 中配置支付宝应用信息。

API说明
k.payment.alipayApp支付宝 App 支付
k.payment.alipayForm支付宝网页支付,通常渲染 nextAction.renderHtml
k.payment.alipayH5支付宝 H5 支付

alipayApp.charge() ​

创建支付宝 App 支付请求。

ts
k.api.post(() => {
    const result = k.payment.alipayApp.charge({
        name: 'Test Alipay App',
        description: 'Order payment',
        totalAmount: 1.5,
        currency: 'CNY',
        order: 'order-id',
        callbackCodeName: 'PaymentCallback'
    })

    return { requestId: result.requestId, paid: result.paid }
})

参数: ChargeParams

参数类型必填说明
totalAmountnumber是订单金额
namestring是订单名称
descriptionstring是订单描述
currencystring是货币,如 CNY
orderstring否Commerce 订单 ID。提供后支付成功会更新订单支付状态
callbackCodeNamestring否支付完成后执行的回调代码名称

返回: ChargeResponse

alipayForm.charge() ​

创建支付宝网页支付请求。

ts
k.api.get(() => {
    const result = k.payment.alipayForm.charge({
        name: 'Test Alipay Form',
        description: 'Order payment',
        totalAmount: 1.5,
        currency: 'CNY',
        order: 'order-id',
        returnUrl: '/payment/success?orderId=order-id',
        callbackCodeName: 'PaymentCallback'
    })

    k.response.renderView(result.nextAction.renderHtml)
})

参数: AlipayFormParams

参数类型必填说明
returnUrlstring是支付完成后的跳转地址
totalAmountnumber是订单金额
namestring是订单名称
descriptionstring是订单描述
currencystring是货币,如 CNY
orderstring否Commerce 订单 ID。提供后支付成功会更新订单支付状态
callbackCodeNamestring否支付完成后执行的回调代码名称

返回: ChargeResponse

alipayH5.charge() ​

创建支付宝 H5 支付请求。

ts
k.api.get(() => {
    const result = k.payment.alipayH5.charge({
        name: 'Test Alipay H5',
        description: 'Order payment',
        totalAmount: 1.5,
        currency: 'CNY',
        order: 'order-id',
        returnUrl: '/payment/success?orderId=order-id'
    })

    k.response.renderView(result.nextAction.renderHtml)
})

参数: AlipayFormParams

参数类型必填说明
returnUrlstring是支付完成后的跳转地址
totalAmountnumber是订单金额
namestring是订单名称
descriptionstring是订单描述
currencystring是货币,如 CNY
orderstring否Commerce 订单 ID。提供后支付成功会更新订单支付状态
callbackCodeNamestring否支付完成后执行的回调代码名称

返回: ChargeResponse

checkStatus() ​

检查支付状态。

ts
k.api.get(() => {
    const status = k.payment.alipayForm.checkStatus('request-id')
    return { paid: status.paid, failed: status.failed, status: status.status }
})

参数:

参数类型必填说明
requestIdstring是charge() 返回的 requestId

返回: PaymentStatusResponse

updateOrder() ​

处理支付回调并更新订单。该方法仅 alipayForm 提供。

ts
k.api.post(() => {
    const callback = k.payment.alipayForm.updateOrder(k.payment.alipayForm.context)
    return { paid: callback.paid, status: callback.status }
})

参数:

参数类型必填说明
contextobject是当前支付回调上下文

返回: PaymentCallback

AlipaySetting ​

属性类型说明
useSandBoxboolean是否使用沙箱环境
appIdstring支付宝应用 ID
appPrivateKeystring应用私钥
alipayPublicKeystring支付宝公钥
signTypestring签名类型
charsetstring编码
serverUrlstring支付宝网关地址