paymentrequestoptions.md

@bigcommerce/checkout-sdk › PaymentRequestOptions

Interface: PaymentRequestOptions ‹TParams›

The set of options for configuring any requests related to the payment step of the current checkout flow.

Type parameters

▪ TParams

Hierarchy

• RequestOptions

  ↳ PaymentRequestOptions

  ↳ PaymentInitializeOptions

Index

Properties

• gatewayId
• methodId
• params
• timeout

Properties

Optional gatewayId

• gatewayId? : undefined | string

The identifier of the payment provider providing the payment method. This option is only required if the provider offers multiple payment options. i.e.: Adyen and Klarna.

---

methodId

• methodId: string

The identifier of the payment method.

---

Optional params

• params? : TParams

Inherited from CheckoutButtonInitializeOptions.params

The parameters of the request, if required.

---

Optional timeout

• timeout? : Timeout

Inherited from CheckoutButtonInitializeOptions.timeout

Provide this option if you want to cancel or time out the request. If the timeout object completes before the request, the request will be cancelled.