Antom, leading provider of tailored payment solutions

antom.createElement()

antom.createElement() 是一个工厂方法。在成功调用 loadAntom() 加载 SDK 并获取 antom 实例后,您可以通过此方法传入指定的 elementType 来动态创建相应的支付或绑卡元素实例。

方法签名

调用此方法时,请使用以下标准方法签名格式:
antom.createElement(elementType, options);
antom.createElement(elementType: ElementType, options?: AppConfig): Element

参数

此方法接收两个参数,分别用于指定要创建的元素类型及其配置。
参数
类型
是否必需
描述
elementType
String
是
Element 类型,有效值为:
  • CVV:用于创建 CVVElement 实例以收集买家输入的 CVV(Card Verification Value)安全码。
  • vaulting:用于创建 VaultingElement 实例以收集买家的信用卡/借记卡信息,完成绑卡流程。
  • express:用于创建 ExpressElement 实例以渲染商户页面的快捷支付按钮。
Object
是
配置对象,用于设置组件的外观主题和多语言环境。

options

请根据所使用的 Element 类型及具体业务场景,传入对应的 options 参数。
当 elementType 为 CVV 或 vaulting 时,传入以下 options 配置对象。
参数
类型
是否必需
描述
appearance
Object
否
用于自定义外观配置,更多信息请参阅自定义外观样式。其包含以下参数:
  • theme:主题颜色。
  • variables:通过 CSS 设计 Token(如 color-primary)覆盖底层 CSS 自定义属性,实现主题定制。
sessiondata
String
是
会话数据。
locale
String
否
多语言配置。
注意:
  • 若同时在 loadAntom() 方法中设置了 locale 参数,则以antom.createElement()参数中的 locale 值为优先。
  • 如果不传或传入的语言值不在以下列出的范围内,系统将默认使用英语。
有效值为:
  • en_US:默认值。英语
  • pt_BR:葡萄牙语(巴西)
  • pt_PT:葡萄牙语
  • es_ES:西班牙语
  • ko_KR:韩语
  • zh_CN:简体中文
  • zh_HK:繁体中文
  • ms_MY:马来西亚语
  • in_ID:印度尼西亚语
  • th_TH:泰语
  • vi_VN:越南语
  • tl_PH:菲律宾语
  • it_IT:意大利语
  • de_DE:德语
  • fr_FR:法语
  • nl_NL:荷兰语
  • ja_JP:日语
  • ro:罗马尼亚语
  • pl_PL:波兰语
  • ar_SA:阿拉伯语
  • tr_TR:土耳其语
  • hi_IN:印度语
当 elementType 为 express 时,传入以下 options 配置对象。
参数
类型
是否必需
描述
sessionData
String
否
支付会话数据。
注意:当支付方式为 Apple Pay、Google Pay、Alipay 时必填,PayPal 由 createOrder() 在服务端返回。

Object
否
支付金额。
注意:当支付方式为 PayPal 时必填。
paymentMethods
Object
否
启用的支付方式列表,同时决定按钮渲染顺序。有效值为:
  • alipay:Alipay
  • applePay:Apple Pay
  • googlePay:Google Pay
  • paypal:PayPal
注意:该参数为非必填,如果不传则不会出现快捷支付按钮。如需渲染快捷支付按钮,请至少传入一个支付方式的值。
Object
否
PayPal 配置参数,集成 PayPal 时必填。
Object
否
各支付方式的按钮类型。
注意:Alipay 不支持该参数。
Object
否
各支付方式的按钮颜色。
注意:Alipay 不支持该参数。
buttonHeight
Number
否
统一按钮高度,单位为 px。

amount

参数
类型
是否必需
描述
currency
String
是
值为遵循 ISO 4217 标准的三位币种代码。
注意:需与创建 sessionData 时的币种保持一致。
value
String
是
以最小币种单位的正整数形式表示的金额值。

paypal

参数
类型
是否必需
描述
businessDivision
String
是
业务分区(国家/地区)标识。
channelMerchantAccountId
String
是
PayPal 商户 ID。
createOrder()
Function
是
传入订单信息以调用 createPaymentSession(单笔支付) 接口来创建支付会话,获取 createOrder() 所需要的 paymentSessionData。
Object
否
按钮形状。
Function
否
配送地址变更回调,data 为 PayPal 返回的原始数据。
Function
否
配送方式变更回调,data 为 PayPal 返回的原始数据。
style
参数
类型
是否必需
描述
shape
String
否
按钮形状:
  • rect:直角形状
  • pill:胶囊形状
  • sharp:方角形状

buttonType

参数
类型
是否必需
描述
applePay
String
否
Apple Pay 支付方式按钮支持的文案包括:
  • buy
  • pay
  • plain
  • check-out
  • book
  • donate
  • subscribe
googlePay
String
否
Google Pay 支付方式按钮支持的文案包括:
  • pay
  • book
  • buy
  • checkout
  • donate
  • order
  • plain
  • subscribe
paypal
String
否
PayPal 支付方式按钮支持的文案包括:
  • paypal
  • checkout
  • buynow
  • pay

buttonTheme

参数
类型
是否必需
描述
applePay
String
否
Apple Pay 支付方式按钮支持的颜色包括:
  • black
  • white
  • white-outline
googlePay
String
否
Google Pay 支付方式按钮支持的颜色包括:
  • black
  • white
paypal
String
否
PayPal 支付方式按钮支持的颜色包括:
  • gold
  • blue
  • silver
  • white
  • black

返回值

此方法返回一个 element 实例对象,提供挂载、卸载、销毁及配置更新等方法,用于灵活管理页面中的组件生命周期。
方法名
描述
为 Element 实例注册事件监听器。
用于将元素挂载到指定的页面节点,可传入一个具体的 HTMLElement。
卸载当前 Element(可再次挂载)。
销毁当前 Element(不可再次挂载)。
更新配置。

错误码

调用 element.on() 方法监听 antom.createElement() 方法相关的错误码。具体错误码列表请参见错误码。