Skip to content

collana pay JS Docs v0.1.0


collana pay JS Docs / StripeGooglePayOptions

Interface: StripeGooglePayOptions

Defined in: types.ts:957

SDK-level options for the Stripe Google Pay provider.

Remarks

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

Example

ts
const stripeGooglePay: ProviderButtonConfig<'Stripe:GooglePay'> = {
  providerProtocolType: 'Stripe',
  paymentMethodType: 'GooglePay',
  container: '#stripe-googlepay',
  options: {
    publishableKey: 'pk_test_...',
    totalAmount: 19300,
    currencyCode: 'eur',
    countryCode: 'DE',
  },
};

Properties

billingAddressRequired?

optional billingAddressRequired?: boolean

Defined in: types.ts:982

Whether the Express Checkout Element should collect a billing address from the buyer.

Default Value

true


captureMethod

captureMethod: "automatic" | "automatic_async" | "manual"

Defined in: types.ts:999

Controls when Stripe captures the payment funds.

  • 'automatic' – captured immediately after authorization (default Stripe behaviour)
  • 'automatic_async' – captured asynchronously after authorization
  • 'manual' – authorization only; capture must be triggered separately

countryCode?

optional countryCode?: string

Defined in: types.ts:972

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

Default Value

'DE'


currencyCode

currencyCode: string

Defined in: types.ts:970

ISO 4217 currency code in lowercase (e.g. 'eur', 'usd').


emailRequired?

optional emailRequired?: boolean

Defined in: types.ts:987

Whether the Express Checkout Element should collect the buyer's email address.

Default Value

true


phoneNumberRequired?

optional phoneNumberRequired?: boolean

Defined in: types.ts:992

Whether the Express Checkout Element should collect the buyer's phone number.

Default Value

true


publishableKey

publishableKey: string

Defined in: types.ts:959

Stripe publishable API key. Use a test key in sandbox mode.


shippingAddressRequired?

optional shippingAddressRequired?: boolean

Defined in: types.ts:977

Whether the Express Checkout Element should collect a shipping address from the buyer.

Default Value

true


stripeAccount?

optional stripeAccount?: string

Defined in: types.ts:964

Stripe Connect connected account ID (e.g. 'acct_...'). Required when processing payments on behalf of a connected account.


totalAmount

totalAmount: number

Defined in: types.ts:968

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

CollanaPay SDK Documentation