@bigcommerce/checkout-sdk / SquarePaymentInitializeOptions
A set of options that are required to initialize the Square payment method.
Once Square payment is initialized, credit card form fields, provided by the payment provider as iframes, will be inserted into the current page. These options provide a location and styling for each of the form fields.
<!-- These containers are where the hosted (iframed) credit card fields will be inserted -->
<div id="card-number"></div>
<div id="card-name"></div>
<div id="card-expiry"></div>
<div id="card-code"></div>service.initializePayment({
methodId: 'squarev2',
square: {
cardNumber: {
elementId: 'card-number',
},
cvv: {
elementId: 'card-code',
},
expirationDate: {
elementId: 'card-expiry',
},
postalCode: {
elementId: 'card-code',
},
},
});• cardNumber: SquareFormElement
The location to insert the credit card number form field.
• cvv: SquareFormElement
The location to insert the CVV form field.
• expirationDate: SquareFormElement
The location to insert the expiration date form field.
• Optional inputClass: string
The CSS class to apply to all form fields.
• Optional inputStyles: { [key: string]: string; }[]
The set of CSS styles to apply to all form fields.
• postalCode: SquareFormElement
The location to insert the postal code form field.
▸ Optional onError(errors?): void
A callback that gets called when an error occurs in the card nonce generation
| Name | Type |
|---|---|
errors? |
NonceGenerationError[] |
void
▸ Optional onPaymentSelect(): void
A callback that gets called when the customer selects a payment option.
void