Express Docs v0.1.0

---

Express Docs / AdyenPayPalExpressOptions

Interface: AdyenPayPalExpressOptions

Defined in: src/types.ts:475

Options for the Adyen Drop-in PayPal Express provider (Adyen:PayPalExpress).

Remarks

Passed to the Adyen Drop-in PayPal configuration. amount is required — the Adyen SDK will reject the component without it.

Example

const adyenPayPal: ProviderButtonConfig<'Adyen:PayPalExpress'> = {
  providerProtocolType: 'Adyen',
  paymentMethodType: 'PayPalExpress',
  container: '#adyen-paypal-container',
  options: {
    totalAmount: 2500,
    currencyCode: 'EUR',
    pspAutoCaptureEnabled: false,
  },
};

Extends

• CheckoutFlowFlags

Properties

clientKey

clientKey: string

Defined in: src/types.ts:482

Adyen client key for the checkout environment (e.g. 'test_...' or 'live_...').

Remarks

Obtain this from the Adyen Customer Area under Developers → API credentials.

---

countryCode?

optional countryCode?: string

Defined in: src/types.ts:493

ISO 3166-1 alpha-2 country code (e.g. 'US', 'DE').

---

currencyCode

currencyCode: string

Defined in: src/types.ts:491

ISO 4217 currency code (e.g. 'EUR', 'USD').

---

isBillingCustomerDataRequired?

optional isBillingCustomerDataRequired?: boolean

Defined in: src/types.ts:252

When true, billing address data is required from the customer.

Inherited from

CheckoutFlowFlags.isBillingCustomerDataRequired

---

isShippingCustomerDataRequired?

optional isShippingCustomerDataRequired?: boolean

Defined in: src/types.ts:250

When true, shipping address data is required from the customer.

Inherited from

CheckoutFlowFlags.isShippingCustomerDataRequired

---

locale?

optional locale?: string

Defined in: src/types.ts:495

IETF locale tag for the Adyen component (e.g. 'en-US').

---

pspAutoCaptureEnabled

pspAutoCaptureEnabled: boolean

Defined in: src/types.ts:262

When true (default), the payment is captured immediately after authorization. When false, the payment is authorized only and must be captured separately.

Remarks

This flag is mapped to the provider-native concept:

• PayPal / Braintree / Adyen PayPal → intent: 'capture' (true) / 'authorize' (false)
• Stripe → captureMethod: 'automatic' (true) / 'manual' (false)

Inherited from

CheckoutFlowFlags.pspAutoCaptureEnabled

---

supportedShippingCountries?

optional supportedShippingCountries?: string[]

Defined in: src/types.ts:505

List of ISO 3166-1 alpha-2 country codes to which the merchant ships. When set and non-empty, the PayPal address sheet rejects shipping addresses from countries not in the list. Comparison is case-insensitive. When omitted or set to an empty array, all countries are accepted.

Example

`['DE', 'AT', 'CH']` — restrict to DACH region

Default Value

undefined — all countries accepted

---

totalAmount

totalAmount: number

Defined in: src/types.ts:489

Transaction amount in minor units (e.g. 2500 = €25.00).

Remarks

This field is required by the Adyen Drop-in component.