@bigcommerce/checkout-sdk / BasePaymentInitializeOptions
A set of options that are required to initialize the payment step of the current checkout flow.
-
↳
BasePaymentInitializeOptions
- amazonpay
- bluesnapv2
- braintree
- braintreevisacheckout
- chasepay
- creditCard
- digitalriver
- gatewayId
- masterpass
- methodId
- moneris
- opy
- params
- paypalexpress
- square
- timeout
• Optional
amazonpay: AmazonPayV2PaymentInitializeOptions
The options that are required to initialize the AmazonPayV2 payment method. They can be omitted unless you need to support AmazonPayV2.
• Optional
bluesnapv2: BlueSnapV2PaymentInitializeOptions
The options that are required to initialize the BlueSnapV2 payment method. They can be omitted unless you need to support BlueSnapV2.
• Optional
braintree: BraintreePaymentInitializeOptions
The options that are required to initialize the Braintree payment method. They can be omitted unless you need to support Braintree.
• Optional
braintreevisacheckout: BraintreeVisaCheckoutPaymentInitializeOptions
The options that are required to initialize the Visa Checkout payment method provided by Braintree. They can be omitted unless you need to support Visa Checkout.
• Optional
chasepay: ChasePayInitializeOptions
The options that are required to initialize the Chasepay payment method. They can be omitted unless you need to support Chasepay.
• Optional
creditCard: CreditCardPaymentInitializeOptions
alpha
Please note that this option is currently in an early stage of
development. Therefore the API is unstable and not ready for public
consumption.
• Optional
digitalriver: DigitalRiverPaymentInitializeOptions
The options that are required to initialize the Digital River payment method. They can be omitted unless you need to support Digital River.
• 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.
PaymentRequestOptions.gatewayId
• Optional
masterpass: MasterpassPaymentInitializeOptions
The options that are required to initialize the Masterpass payment method. They can be omitted unless you need to support Masterpass.
• methodId: string
The identifier of the payment method.
PaymentRequestOptions.methodId
• Optional
moneris: MonerisPaymentInitializeOptions
The options that are required to initialize the Moneris payment method. They can be omitted unless you need to support Moneris.
• Optional
opy: OpyPaymentInitializeOptions
The options that are required to initialize the Opy payment method. They can be omitted unless you need to support Opy.
• Optional
params: Object
The parameters of the request, if required.
• Optional
paypalexpress: PaypalExpressPaymentInitializeOptions
The options that are required to initialize the PayPal Express payment method. They can be omitted unless you need to support PayPal Express.
• Optional
square: SquarePaymentInitializeOptions
The options that are required to initialize the Square payment method. They can be omitted unless you need to support Square.
• 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.