Express Docs v0.1.0

---

Express Docs / StripeGooglePayOptions

Interface: StripeGooglePayOptions

Defined in: src/types.ts:1177

SDK-level options for the Stripe Google Pay provider.

Remarks

Uses the Stripe.js Express Checkout Element which handles Google Pay internally. The PaymentIntent is created on the server via the onClick callback when the shopper clicks the Google Pay button (deferred-intent pattern).

Authentication modes

Exactly one of publishableKey or stripeAccount must be provided.

Direct integration — supply your own Stripe publishable key:

options: { publishableKey: 'pk_test_...', totalAmount: 19300, currencyCode: 'eur' }

CollanaPay onboarding — supply the Stripe connected account ID; CollanaPay provides its own publishable key (VITE_STRIPE_PUBLISHABLE_KEY) baked into the SDK build:

options: { stripeAccount: 'acct_...', totalAmount: 19300, currencyCode: 'eur' }

Extends

• CheckoutFlowFlags

Properties

currencyCode

currencyCode: string

Defined in: src/types.ts:1197

ISO 4217 currency code in lowercase (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:1205

Locale for the Stripe checkout UI.

Remarks

Accepts any common format (de-DE, de_DE, or de). The SDK normalizes to the short code expected by Stripe (e.g. de).

---

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

---

publishableKey?

optional publishableKey?: string

Defined in: src/types.ts:1183

Stripe publishable API key (e.g. pk_test_... or pk_live_...).

Required for direct integration. Mutually exclusive with stripeAccount.

---

shippingOptionLabel?

optional shippingOptionLabel?: string

Defined in: src/types.ts:1236

Display-name override for the single shipping rate returned by the backend in the onClick result.

Remarks

The backend returns exactly one shipping rate. Its displayName is derived from the name of the ShippingCost cart item supplied by the collana pay API. If no ShippingCost item exists, the backend falls back to "No shipping cost". Use this option to localise or rename that label on the client side without changing the backend:

shippingOptionLabel: 'Versandkostenfrei'

When omitted, the displayName from the backend is used as-is.

Default Value

undefined — display name from the backend is used as-is

---

stripeAccount?

optional stripeAccount?: string

Defined in: src/types.ts:1191

Stripe connected account ID (e.g. 'acct_...').

Required for CollanaPay onboarding. The SDK build provides its own platform publishable key (VITE_STRIPE_PUBLISHABLE_KEY). Mutually exclusive with publishableKey.

---

supportedShippingCountries?

optional supportedShippingCountries?: string[]

Defined in: src/types.ts:1216

List of ISO 3166-1 alpha-2 country codes to which the merchant ships. When set and non-empty, the Stripe Express Checkout Element restricts the shipping address picker to these countries natively — no shippingaddresschange event fires for unsupported countries. 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:1195

Total payment amount in minor units (e.g. 19300 = €193.00).