Skip to content

collana pay JS Docs v0.1.0


collana pay JS Docs / AdyenGooglePayOptions

Interface: AdyenGooglePayOptions

Defined in: types.ts:399

Options for the Adyen Drop-in Google Pay provider (Adyen:GooglePay).

Remarks

Passed to the Adyen Drop-in Google Pay configuration. amount is required. Fields like gatewayMerchantId and transactionInfo map directly to corresponding Google Pay API parameters.

Example

ts
const adyenGooglePay: ProviderButtonConfig<'Adyen:GooglePay'> = {
  providerProtocolType: 'Adyen',
  paymentMethodType: 'GooglePay',
  container: '#adyen-googlepay-container',
  options: {
    totalAmount: 1000,
    currencyCode: 'USD',
    countryCode: 'US',
    gatewayMerchantId: 'YOUR_ADYEN_MERCHANT_ID',
    emailRequired: true,
  },
};

Properties

billingAddressParameters?

optional billingAddressParameters?: object

Defined in: types.ts:441

Billing address format parameters. 'FULL' requests all address fields.

format?

optional format?: "FULL" | "MIN"


billingAddressRequired?

optional billingAddressRequired?: boolean

Defined in: types.ts:439

Whether a billing address is required from the payer.


callbackIntents?

optional callbackIntents?: string[]

Defined in: types.ts:431

Google Pay callback intents (e.g. ['SHIPPING_ADDRESS', 'SHIPPING_OPTION']).

Remarks

See the Google Pay API docs for valid callback intent strings.


clientKey

clientKey: string

Defined in: types.ts:406

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:417

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


currencyCode

currencyCode: string

Defined in: types.ts:415

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


emailRequired?

optional emailRequired?: boolean

Defined in: types.ts:437

Whether the payer's email address is required.


gatewayMerchantId?

optional gatewayMerchantId?: string

Defined in: types.ts:448

The Adyen merchant account ID used as the Google Pay gateway merchant ID.

Remarks

Must match the merchant account configured in your Adyen dashboard.


isExpress?

optional isExpress?: boolean

Defined in: types.ts:424

Whether this is an express-checkout flow.

Default Value

true


locale?

optional locale?: string

Defined in: types.ts:419

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


merchantId?

optional merchantId?: string

Defined in: types.ts:453

GooglePay Merchant ID


merchantName?

optional merchantName?: string

Defined in: types.ts:450

Merchant name displayed in the Google Pay payment sheet.


shippingAddressRequired?

optional shippingAddressRequired?: boolean

Defined in: types.ts:433

Whether a shipping address is required from the payer.


shippingOptionRequired?

optional shippingOptionRequired?: boolean

Defined in: types.ts:435

Whether a shipping option selection is required from the payer.


totalAmount

totalAmount: number

Defined in: types.ts:413

Transaction amount in minor units (e.g. 1000 = $10.00).

Remarks

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


transactionInfo?

optional transactionInfo?: Record<string, unknown>

Defined in: types.ts:461

Google Pay TransactionInfo object for line items, total price, etc.

Remarks

Passed directly to the Google Pay API. See TransactionInfo.

CollanaPay SDK Documentation