Skip to content

Latest commit

 

History

History
112 lines (62 loc) · 2.54 KB

squarepaymentinitializeoptions.md

File metadata and controls

112 lines (62 loc) · 2.54 KB

@bigcommerce/checkout-sdkSquarePaymentInitializeOptions

Interface: 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.

Hierarchy

  • SquarePaymentInitializeOptions

Index

Properties

Methods

Properties

cardNumber

cardNumber: SquareFormElement

The location to insert the credit card number form field.


cvv

cvv: SquareFormElement

The location to insert the CVV form field.


expirationDate

expirationDate: SquareFormElement

The location to insert the expiration date form field.


Optional inputClass

inputClass? : undefined | string

The CSS class to apply to all form fields.


Optional inputStyles

inputStyles? : Array‹object›

The set of CSS styles to apply to all form fields.


Optional masterpass

masterpass? : SquareFormElement

Initialize Masterpass placeholder ID


postalCode

postalCode: SquareFormElement

The location to insert the postal code form field.

Methods

Optional onError

onError(errors?: NonceGenerationError[]): void

A callback that gets called when an error occurs in the card nonce generation

Parameters:

Name Type
errors? NonceGenerationError[]

Returns: void


Optional onPaymentSelect

onPaymentSelect(): void

A callback that gets called when the customer selects a payment option.

Returns: void