PaymentRequestOptions.md

@bigcommerce/checkout-sdk / PaymentRequestOptions

Interface: PaymentRequestOptions

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

Hierarchy

• RequestOptions

  ↳ PaymentRequestOptions

  ↳↳ BasePaymentInitializeOptions

Table of contents

Properties

• gatewayId
• methodId
• params
• timeout

Properties

gatewayId

• Optional gatewayId: 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.

---

params

• Optional params: Object

The parameters of the request, if required.

Inherited from

RequestOptions.params

---

timeout

• Optional timeout: default

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.

Inherited from

RequestOptions.timeout