adyencreditcardcomponentoptions.md

@bigcommerce/checkout-sdk › AdyenCreditCardComponentOptions

Interface: AdyenCreditCardComponentOptions

Hierarchy

• AdyenBaseCardComponentOptions

• AdyenComponentEvents

  ↳ AdyenCreditCardComponentOptions

Index

Properties

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

Methods

• onChange
• onError

Properties

Optional brands

• brands? : string[]

Inherited from AdyenBaseCardComponentOptions.brands

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

---

Optional data

• data? : AdyenPlaceholderData

Information to prefill fields.

---

Optional details

• details? : InputDetail[]

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

---

Optional enableStoreDetails

• enableStoreDetails? : undefined | false | true

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

---

Optional groupTypes

• 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.

---

Optional hasHolderName

• hasHolderName? : undefined | false | true

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

---

Optional holderNameRequired

• holderNameRequired? : undefined | false | true

Set to true to require the card holder name.

---

Optional placeholders

• placeholders? : CreditCardPlaceHolder | SepaPlaceHolder

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

---

Optional styles

• styles? : StyleOptions

Inherited from AdyenBaseCardComponentOptions.styles

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

Methods

Optional onChange

▸ onChange(state: AdyenComponentState, component: AdyenComponent): void

Inherited from AdyenComponentEvents.onChange

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

---

Optional onError

▸ onError(state: AdyenComponentState, component: AdyenComponent): void

Inherited from AdyenComponentEvents.onError

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

Parameters:

Name	Type
state	AdyenComponentState
component	AdyenComponent

Returns: void