AdyenV3CreditCardComponentOptions.md

@bigcommerce/checkout-sdk / AdyenV3CreditCardComponentOptions

Interface: AdyenV3CreditCardComponentOptions

Hierarchy

• AdyenBaseCardComponentOptions_2

• AdyenComponentEvents_2

  ↳ AdyenV3CreditCardComponentOptions

Table of contents

Properties

• brands
• data
• details
• enableStoreDetails
• groupTypes
• hasHolderName
• holderNameRequired
• placeholders
• showBrandsUnderCardNumber
• styles

Methods

• onChange
• onError
• onFieldValid
• onSubmit

Properties

brands

• Optional brands: string[]

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

Inherited from

AdyenBaseCardComponentOptions_2.brands

---

data

• Optional data: AdyenPlaceholderData_2

Information to prefill fields.

---

details

• Optional details: InputDetail_2[]

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_2 | SepaPlaceHolder_2

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

---

showBrandsUnderCardNumber

• Optional showBrandsUnderCardNumber: boolean

Inherited from

AdyenBaseCardComponentOptions_2.showBrandsUnderCardNumber

---

styles

• Optional styles: StyleOptions_2

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

Inherited from

AdyenBaseCardComponentOptions_2.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	AdyenV3ComponentState
component	AdyenComponent_2

Returns

void

Inherited from

AdyenComponentEvents_2.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	AdyenV3ValidationState
component	AdyenComponent_2

Returns

void

Inherited from

AdyenComponentEvents_2.onError

---

onFieldValid

▸ Optional onFieldValid(state, component): void

Parameters

Name	Type
state	AdyenV3ValidationState
component	AdyenComponent_2

Returns

void

Inherited from

AdyenComponentEvents_2.onFieldValid

---

onSubmit

▸ Optional onSubmit(state, component): void

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

Parameters

Name	Type
state	AdyenV3ComponentState
component	AdyenComponent_2

Returns

void

Inherited from

AdyenComponentEvents_2.onSubmit