Skip to content

Latest commit

 

History

History
220 lines (126 loc) · 5.23 KB

AdyenCreditCardComponentOptions.md

File metadata and controls

220 lines (126 loc) · 5.23 KB

@bigcommerce/checkout-sdk / AdyenCreditCardComponentOptions

Interface: AdyenCreditCardComponentOptions

Hierarchy

Table of contents

Properties

Methods

Properties

brands

Optional brands: string[]

Array of card brands that will be recognized by the component.

Inherited from

AdyenBaseCardComponentOptions.brands


data

Optional data: AdyenPlaceholderData

Information to prefill fields.


details

Optional details: InputDetail[]

Set an object containing the details array for type: scheme from the /paymentMethods response.


enableStoreDetails

Optional enableStoreDetails: boolean

Set to true to show the checkbox to save card details for the next payment.


groupTypes

Optional groupTypes: string[]

Defaults to ['mc','visa','amex']. Configure supported card types to facilitate brand recognition used in the Secured Fields onBrand callback. See list of available card types. If a shopper enters a card type not specified in the GroupTypes configuration, the onBrand callback will not be invoked.


hasHolderName

Optional hasHolderName: boolean

Set to true to request the name of the card holder.


holderNameRequired

Optional holderNameRequired: boolean

Set to true to require the card holder name.


placeholders

Optional placeholders: CreditCardPlaceHolder | SepaPlaceHolder

Specify the sample values you want to appear for card detail input fields.


showBrandsUnderCardNumber

Optional showBrandsUnderCardNumber: boolean

Inherited from

AdyenBaseCardComponentOptions.showBrandsUnderCardNumber


styles

Optional styles: StyleOptions

Set a style object to customize the input fields. See Styling Secured Fields for a list of supported properties.

Inherited from

AdyenBaseCardComponentOptions.styles

Methods

onChange

Optional onChange(state, component): void

Called when the shopper enters data in the card input fields. Here you have the option to override your main Adyen Checkout configuration.

Parameters

Name Type
state AdyenComponentState
component AdyenComponent

Returns

void

Inherited from

AdyenComponentEvents.onChange


onError

Optional onError(state, component): void

Called in case of an invalid card number, invalid expiry date, or incomplete field. Called again when errors are cleared.

Parameters

Name Type
state AdyenValidationState
component AdyenComponent

Returns

void

Inherited from

AdyenComponentEvents.onError


onFieldValid

Optional onFieldValid(state, component): void

Parameters

Name Type
state AdyenValidationState
component AdyenComponent

Returns

void

Inherited from

AdyenComponentEvents.onFieldValid


onSubmit

Optional onSubmit(state, component): void

Called when the shopper selects the Pay button and payment details are valid.

Parameters

Name Type
state AdyenComponentState
component AdyenComponent

Returns

void

Inherited from

AdyenComponentEvents.onSubmit