CheckoutWebComponents
Last updated: April 16, 2025
Initializes a CheckoutWebComponent
instance.
Parameter | Type | Description |
---|---|---|
|
| Customizes the visual appearance of the |
|
| Customizes the options for the individual Flow components. |
|
| The list of accepted card schemes in Apple Pay payments. This value can be one of:
The values in this list are mapped into values supported by the Apple Pay JS SDK. This list overrides |
|
| The list of accepted card types in Apple Pay payments. This value can be one of:
The values in this list are mapped into values supported by the Apple Pay JS SDK. This list overrides |
|
| Customizes the Apple Pay wallet button appearance. This value must be supported by the Apple Pay JS SDK. |
|
| Customizes the Apple Pay wallet button type. This value must be supported by the Apple Pay JS SDK. |
|
| The list of accepted card schemes in card payments. This value can be one of:
This list overrides |
|
| The list of accepted card types that in card payments. This value can be one of:
This list overrides |
|
| The name to pre-populate the cardholder name input field for card payments with. |
|
| The position of the cardholder name input field for card payments. This value can be one of:
|
|
| The email address used to pre-populate the email input field in |
|
| The phone country code used to pre-populate the phone input fields in |
|
| The phone number used to pre-populate the email input field in |
|
| The list of accepted card schemes by Flow. This value can be one of:
This list applies to the For example, the list |
|
| The list of accepted card types by Flow. This value can be one of:
This list applies to the For example, the list |
|
| Sets whether to automatically expand the first payment method, if there are multiple payment methods. |
|
| The list of accepted card schemes in Google Pay payments. This value can be one of:
The values in this list are mapped into values supported by the Google Pay API. This list overrides |
|
| The list of accepted card types by Google Pay. This value can be one of:
The values in this list are mapped into values supported by the Google Pay API. This list overrides |
|
| Customizes the Google Pay wallet button appearance. This value must be accepted by the Google Pay API. |
|
| Customizes the Google Pay wallet button type. This value must be accepted by the Google Pay API. |
|
| The list of accepted card schemes in payments with Remember Me enabled. This value can be one of:
This list overrides |
|
| Sets the environment that the library should point and send requests to. |
|
| Sets the customer's locale. |
|
| The response from the |
|
| Your public API key. |
|
| Customizes text translations for natively supported languages, or adds custom text for locales and languages that are not natively supported. |
1const checkout = await CheckoutWebComponents({2appearance,3componentOptions: {4flow: {5expandFirstPaymentMethod: false,6},7card: {8displayCardholderName: 'bottom',9data: {10cardholderName: 'Jia Tsang',11},12},13}14environment: 'sandbox',15locale: 'en',16paymentSession,17publicKey: 'pk_01234',18translations,19});
Initializes a FlowComponent
instance.
Parameter | Type | Description |
---|---|---|
|
| The name of the
|
|
| The event callbacks for the |
|
| Specifies whether to display the payment button in the UI. If you want to handle payment button rendering and interactions outside of Flow, set this to |
1const flowComponent = checkout.create('flow', {2showPayButton: false,3});