Skip to content

Latest commit

 

History

History
90 lines (62 loc) · 2.12 KB

SquareV2PaymentInitializeOptions.md

File metadata and controls

90 lines (62 loc) · 2.12 KB
Raw

@bigcommerce/checkout-sdk / SquareV2PaymentInitializeOptions

Interface: SquareV2PaymentInitializeOptions

A set of options that are required to initialize the Square payment method.

Once Square payment is initialized, an iframed payment element will be inserted into the current page. These options provide a location, styling, and a callback function that advises when it's safe to pay.

example

<!-- These container is where the hosted (iframed) payment method element will be inserted -->
<div id="card-payment"></div>
service.initializePayment({
    methodId: 'squarev2',
    squarev2: {
        containerId: 'card-payment',
        style: {
            input: {
                backgroundColor: '#F7F8F9',
                color: '#373F4A',
                fontFamily: 'Helvetica Neue',
                fontSize: '16px',
                fontWeight: 'normal'
            }
        },
        onValidationChange: (isReadyToPay: boolean) => {
            if (isReadyToPay) {
                // Show or hide some component or message...
            }
        }
    },
});

Table of contents

Properties

Methods

Properties

containerId

• containerId: string

The ID of a container which the payment widget should insert into.

style

• Optional style: CardClassSelectors

A map of .css classes and values that customize the style of the input fields from the card element.

For more information about applying custom styles to the card form, see the available CardClassSelectors for styling.

Methods

onValidationChange

▸ Optional onValidationChange(isReadyToPay): void

A callback that gets called when the validity of the payment component changes.

Parameters

Name Type
isReadyToPay boolean

Returns

void