Skip to content

paypal ​

PayPal 支付。

概述 ​

PayPal 支付包含 Checkout 和 Form 两种方式。使用前需要在站点 CMS 中配置 PayPal 账号或应用信息。

API说明
k.payment.paypalCheckoutPayPal Checkout
k.payment.paypalFormPayPal 表单支付

paypalCheckout.charge() ​

创建 PayPal Checkout 支付请求。

ts
k.api.get(() => {
    const result = k.payment.paypalCheckout.charge({
        name: 'T-shirt',
        description: 'Order payment',
        totalAmount: 1.5,
        currency: 'USD',
        order: 'order-id',
        returnUrl: '/payment/success?orderId=order-id',
        cancelUrl: '/payment/cancel?orderId=order-id',
        brandName: 'Kooboo Store',
        customer: 'customer@example.com',
        callbackCodeName: 'PaymentCallback'
    })

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

参数: PaypalCheckoutParams

参数类型必填说明
cancelUrlstring是取消支付时的返回地址
returnUrlstring是支付成功后的返回地址
brandNamestring否PayPal 支付页展示的品牌名
customerstring否客户标识
totalAmountnumber是订单金额
namestring是订单名称
descriptionstring是订单描述
currencystring是货币,如 USD
orderstring否Commerce 订单 ID。提供后支付成功会更新订单支付状态
callbackCodeNamestring否支付完成后执行的回调代码名称

返回: ChargeResponse

paypalForm.charge() ​

创建 PayPal 表单支付请求。

ts
k.api.get(() => {
    const result = k.payment.paypalForm.charge({
        name: 'T-shirt',
        description: 'Order payment',
        totalAmount: 1.5,
        currency: 'USD',
        order: 'order-id',
        returnUrl: '/payment/success?orderId=order-id',
        cancelUrl: '/payment/cancel?orderId=order-id'
    })

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

参数: PaypalFormParams

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

返回: ChargeResponse

checkStatus() ​

检查支付状态。

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

参数:

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

返回: PaymentStatusResponse

updateOrder() ​

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

参数:

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

返回: PaymentCallback

nofityUrl() ​

处理 PayPal Form 通知回调。方法名在当前类型定义中为 nofityUrl。

参数:

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

返回: PaymentCallback

配置结构 ​

PaypalSetting ​

属性类型说明
paypalUrlstringPayPal 接口地址
useSandBoxboolean是否使用沙箱
clientIdstringPayPal Client ID
secretstringPayPal Secret

PaypalFormSetting ​

属性类型说明
paypalUrlstringPayPal 接口地址
iPNUrlstringIPN 通知地址
emailAddressstring收款账号邮箱
logoImagestring支付页 Logo
useSandBoxboolean是否使用沙箱