Skip to content

square ​

Square 支付。

概述 ​

k.payment.square 用于创建 Square Checkout 支付请求。使用前需要在站点 CMS 中配置 Square 应用和 Location 信息。

square.charge() ​

创建 Square Checkout 支付请求。

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

    k.response.redirect(result.nextAction.redirectUrl)
})

参数: SquareCheckoutParams

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

返回: ChargeResponse

checkStatus() ​

检查支付状态。

参数:

参数类型必填说明
requestIdstring是charge() 返回的 requestId。
ts
k.api.get(() => {
    const status = k.payment.square.checkStatus('request-id')
    return { paid: status.paid, failed: status.failed, status: status.status }
})

返回: PaymentStatusResponse

notify() ​

处理 Square 通知回调。

参数:

参数类型必填说明
contextobject是当前支付通知上下文,通常传入 k.payment.square.context。
ts
k.api.post(() => {
    const callback = k.payment.square.notify(k.payment.square.context)
    return { paid: callback.paid, status: callback.status }
})

返回: PaymentCallback

updateOrder() ​

处理 Square 回调并更新订单。

参数:

参数类型必填说明
contextobject是当前支付回调上下文,通常传入 k.payment.square.context。
ts
k.api.post(() => {
    const callback = k.payment.square.updateOrder(k.payment.square.context)
    return { paid: callback.paid, status: callback.status }
})

返回: PaymentCallback

SquareSetting ​

属性类型说明
useSandBoxboolean是否使用沙箱
applicationIdstringSquare Application ID
accessTokenstringSquare Access Token
locationIdstringSquare Location ID
baseURLstringSquare API 地址