Appearance
Express Docs / GooglePayOptions
Interface: GooglePayOptions
Defined in: src/types.ts:778
SDK-level options for the Google Pay provider.
Remarks
These values configure the Google Pay JS API request. See Google Pay API docs.
Example
ts
const googlePayButton: ProviderButtonConfig<'Computop:GooglePay'> = {
providerProtocolType: 'Computop',
paymentMethodType: 'GooglePay',
container: '#googlepay-container',
style: { buttonColor: 'black', buttonType: 'buy' },
options: {
totalAmount: 19300,
currencyCode: 'USD',
countryCode: 'US',
gateway: 'example',
gatewayMerchantId: 'exampleMerchantId',
merchantName: 'Example Merchant',
},
};Extends
CheckoutFlowFlags
Properties
allowedCardNetworks?
optionalallowedCardNetworks?: ("AMEX"|"DISCOVER"|"INTERAC"|"JCB"|"MASTERCARD"|"VISA")[]
Defined in: src/types.ts:813
Card networks accepted by the merchant and gateway.
Default Value
['AMEX', 'DISCOVER', 'INTERAC', 'JCB', 'MASTERCARD', 'VISA']
countryCode
countryCode:
string
Defined in: src/types.ts:790
ISO 3166-1 alpha-2 country code (e.g. 'US', 'DE').
currencyCode
currencyCode:
string
Defined in: src/types.ts:788
ISO 4217 currency code (e.g. 'USD', 'EUR').
displayItems?
optionaldisplayItems?:GooglePayDisplayItem[]
Defined in: src/types.ts:829
Line items displayed in the Google Pay payment sheet below the total.
Remarks
Use this to show a breakdown of costs (subtotal, tax, fees, etc.).
See
https://developers.google.com/pay/api/web/reference/request-objects#DisplayItem
gateway
gateway:
string
Defined in: src/types.ts:798
Payment gateway identifier passed to the Google Pay tokenization spec.
Remarks
Must match a gateway supported by Google Pay (e.g. 'computop', 'stripe'). See supported gateways.
gatewayMerchantId
gatewayMerchantId:
string
Defined in: src/types.ts:805
Merchant ID issued by the payment gateway for tokenization.
Remarks
This is the gateway-specific merchant account ID, not a Google Pay merchant ID.
isBillingCustomerDataRequired?
optionalisBillingCustomerDataRequired?:boolean
Defined in: src/types.ts:856
When true, the integrator's backend already supplies the customer's billing address and Google Pay should not request it from the payer. When false or unset (default), Google Pay collects the billing address.
Maps (inverted) to the Google Pay billingAddressRequired request flag (both at the top level and inside the card payment method's parameters.billingAddressRequired).
Default Value
false — Google Pay collects billing address
Overrides
CheckoutFlowFlags.isBillingCustomerDataRequired
isShippingCustomerDataRequired?
optionalisShippingCustomerDataRequired?:boolean
Defined in: src/types.ts:844
When true, the integrator's backend already supplies the customer's shipping address and Google Pay should not request it from the payer. When false or unset (default), Google Pay collects the shipping address and payer contact (name, email, phone).
Maps (inverted) to the Google Pay shippingAddressRequired request flag, and gates payer contact fields:
shippingAddressRequired = !isShippingCustomerDataRequiredemailRequired = !isShippingCustomerDataRequiredphoneNumberRequired = !isShippingCustomerDataRequired
Default Value
false — Google Pay collects shipping address and payer contact
Overrides
CheckoutFlowFlags.isShippingCustomerDataRequired
merchantName
merchantName:
string
Defined in: src/types.ts:807
Merchant name displayed in the Google Pay payment sheet.
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?
optionalsupportedShippingCountries?:string[]
Defined in: src/types.ts:867
List of ISO 3166-1 alpha-2 country codes to which the merchant ships. When set and non-empty, the Google Pay sheet validates the selected shipping address country in onPaymentDataChanged and surfaces a SHIPPING_ADDRESS_UNSERVICEABLE error when it is not included. When omitted or set to an empty array, all countries are accepted.
Example
ts
`['DE', 'AT', 'CH']` — restrict to DACH regionDefault Value
undefined — all countries accepted
totalAmount
totalAmount:
number
Defined in: src/types.ts:786
Transaction amount in minor units (e.g. 19300 = $193.00).
Remarks
Divided by 100 and formatted to two decimal places for the Google Pay TransactionInfo.totalPrice field.
totalPriceLabel?
optionaltotalPriceLabel?:string
Defined in: src/types.ts:820
Custom label for the total price row in the payment sheet (e.g. 'Total').
Remarks
If omitted, Google Pay uses its default label.
