setOption()

Note: Translation in progress.

setOption()方法用于设置配置选项。

方法签名

copy
public AMSBaseConfiguration setOption(String key, Object value)

参数

参数

类型

是否必需

描述

key

String

配置项的键。参见可用的 key

value

Object

配置项的值,类型因 key 不同而异。

可用的 key

Key

值类型

描述

sandbox

Boolean

是否启用沙箱环境。

  • true:沙箱环境。
  • false:默认值。生产环境。

showLoading

Boolean

是否在请求过程中显示加载动画。

  • true:默认值。使用默认加载模式。
  • false:不使用默认加载模式。设为 false 时,建议配合加载事件回调自行自定义。

notRedirectAfterComplete

Boolean

用于设置支付完成后是否跳转回您的页面。有效值为:

  • false:默认值。表示支付成功后自动跳回您的页面,支付失败或其他场景不会自动回跳,需要您自行处理。当值为空时同理。
  • true:表示支付完成后不跳转,您需要通过客户端事件码自行控制支付完成后续流程。

注意:

  • 支付成功或失败在回跳商户页面的最佳实践参见回跳商户页面
  • 客户端返回的支付结果事件码仅用于客户端页面的跳转操作参考,交易状态的更新请以服务端 notifyPaymentinquiryPayment 接口返回的结果为准。
  • 该参数仅针对 Payment Element 内完成支付的支付方式生效。

appearance

String(JSON)

用于自定义外观配置,更多信息请参阅自定义外观样式。其包含以下参数:

  • theme:String 类型,主题颜色。
  • layout:String 类型,布局配置。
  • variables:Object 类型,通过 CSS 设计 Token(如 content-primary)覆盖底层 CSS 自定义属性,实现主题定制。

返回值

返回 this() 方法,以支持链式调用。

最佳实践

回跳商户页面

回跳商户页面及返回支付结果有以下情况,请您按照指引进行处理:

notRedirectAfterComplete

支付结果

建议操作

true

成功/失败

若您在创建 Payment Element 实例时将 notRedirectAfterComplete 设置为true 且该支付方式支持在 SDK 内完成支付,将通过 onSubmitPayCallback() 方法返回支付结果,您需要根据对应场景下 onSubmitPayCallback() 方法返回的支付结果事件码自行处理跳转逻辑:

false

成功

支付完成后 Payment Element 会自动跳转至您在 createPaymentSession(单笔支付) 接口中传入的paymentRedirectUrl

false

失败

通过 onSubmitPayCallback() 方法返回支付结果,您需要根据对应场景下 onSubmitPayCallback() 方法返回的支付结果事件码自行处理跳转逻辑:

注意

  • 如果支付方式不支持在 SDK 内支付,支付结果不会通过 onSubmitPayCallback() 方法返回。跳转到外部支付方式页面完成支付后,由支付方式决策是否自动回跳到您传入的paymentRedirectUrl
  • onSubmitPayCallback() 方法返回的支付结果仅用于客户端页面流转以及状态展示,最终的订单状态请通步骤 4:获取支付结果获取。