指定支付方式

您可以通过在 createPaymentSession(单笔支付) 接口传入参数,指定在 Payment ElementCheckout Page (CKP) 上展示的支付方式、支付方式列表的排序,以及极速支付方式的展示。

注意:集成 Checkout Page (CKP) 时,您可以在 Antom Dashboard支付 > 收银台设置 > 支付方式 中配置指定支付方式。如果您通过接口传入参数来指定支付方式,则优先取接口传值。

此功能为您带来以下优势:

  • 根据您的业务地区过滤当地的支付方式
  • 按照您的偏好对支付方式进行排序
  • 可以将主流的支付方式如 AlipayApple PayGoogle Pay 以极速支付的形式展示(仅支持 App 端)

欲指定支付方式,请在 createPaymentSession(单笔支付) 接口的 availablePaymentMethod 参数中,传入以下参数:

参数名称

是否必需

描述

paymentMethodTypeList

买家可用的支付方式列表。其包含以下参数:

  • paymentMethodType:支付方式选项中包含的支付方式类型。参见支付方式枚举值以查看有效值。
  • paymentMethodOrder:您设置的支付方式优先级顺序,以序号表示,序号越小,优先级越高。如果未进行设置,将使用 Antom 默认的排序方式。
  • expressCheckout设置是否使用支付方式的极速支付形式,目前仅 ALIPAY_CNAPPLEPAY 和 GOOGLEPAY 可以被设置为极速支付。有效值为:
    • true:表示设置该支付方式为极速支付。
    • false:表示不将该支付方式设置为极速支付。

注意:集成 Payment Element 时,expressCheckout 参数目前仅支持在 Android 及 iOS 端使用。

以下是指定支付方式的示例代码:

copy
{ ...
  "availablePaymentMethod": {
    "paymentMethodTypeList": [
      {
        "paymentMethodType": "ALIPAY_CN",
        "expressCheckout": true,
        "paymentMethodOrder": "0"
      },
      {
        "paymentMethodType": "TNG",
        "expressCheckout": false,
        "paymentMethodOrder": "1"
      }
    ]
  }
}