collana pay JS Docs v0.1.0

---

collana pay JS Docs / AdyenPayPalExpressOptions

Interface: AdyenPayPalExpressOptions

Defined in: types.ts:337

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',
    intent: 'authorize',
    isExpress: true,
    blockPayPalCreditButton: true,
  },
};

Properties

blockPayPalCreditButton?

optional blockPayPalCreditButton?: boolean

Defined in: types.ts:370

When true, hides the PayPal Credit button variant.

---

blockPayPalPayLaterButton?

optional blockPayPalPayLaterButton?: boolean

Defined in: types.ts:372

When true, hides the PayPal Pay Later button variant.

---

clientKey

clientKey: string

Defined in: types.ts:344

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: types.ts:355

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

---

currencyCode

currencyCode: string

Defined in: types.ts:353

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

---

intent?

optional intent?: "capture" | "authorize"

Defined in: types.ts:368

Payment intent — 'capture' settles immediately, 'authorize' holds funds.

---

isExpress?

optional isExpress?: boolean

Defined in: types.ts:362

Whether this is an express-checkout flow.

Default Value

true

---

locale?

optional locale?: string

Defined in: types.ts:357

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

---

showPayButton?

optional showPayButton?: boolean

Defined in: types.ts:364

Whether the Adyen component should render its own pay button.

---

totalAmount

totalAmount: number

Defined in: types.ts:351

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

Remarks

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

---

userAction?

optional userAction?: "pay" | "continue"

Defined in: types.ts:366

PayPal user action — 'pay' shows "Pay Now", 'continue' shows "Continue".