Interface Request

Used to initialize a Google Pay payment flow.

Represents the parameters that are needed to use the Google Pay API.

interface Request {
    allowPrepaidCards?: boolean;
    allowedPaymentMethod?: AllowedPaymentMethod[];
    billingAddressFormat?: BillingAddressFormat;
    billingAddressRequired?: boolean;
    countryCode?: string;
    emailRequired?: boolean;
    environment?: string;
    googleMerchantId?: string;
    googleMerchantName?: string;
    payPalEnabled?: boolean;
    phoneNumberRequired?: boolean;
    shippingAddressRequired?: boolean;
    shippingAddressRequirements?: ShippingAddressRequirements;
    transactionInfo?: TransactionInfo;
}

Properties

allowPrepaidCards? allowedPaymentMethod? billingAddressFormat? billingAddressRequired? countryCode? emailRequired? environment? googleMerchantId? googleMerchantName? payPalEnabled? phoneNumberRequired? shippingAddressRequired? shippingAddressRequirements? transactionInfo?

Properties

Optional allowPrepaidCards

allowPrepaidCards?: boolean

Set to false if you don't support prepaid cards. Default: The prepaid card class is supported.

Optional allowedPaymentMethod

allowedPaymentMethod?: AllowedPaymentMethod[]

The payment method(s) that are allowed to be used.

Optional billingAddressFormat

billingAddressFormat?: BillingAddressFormat

Optional billingAddressRequired

billingAddressRequired?: boolean

If set to true, the user must provide a billing address.

Optional countryCode

countryCode?: string

ISO 3166-1 alpha-2 country code where the transaction is processed.

This is required for merchants based in European Economic Area (EEA) countries.

NOTE: to support Elo cards, country code must be set to "BR"

Optional emailRequired

emailRequired?: boolean

Optional environment

environment?: string

A string that represents the environment in which the Google Pay API will be used (e.g. "TEST" or "PRODUCTION").

Optional googleMerchantId

googleMerchantId?: string

Google Merchant ID is no longer required and will be removed.

Deprecated

Google Merchant ID is no longer required and will be removed.

Optional googleMerchantName

googleMerchantName?: string

The merchant name that will be presented in Google Pay

Optional payPalEnabled

payPalEnabled?: boolean

Defines if PayPal should be an available payment method in Google Pay.

{@code true} by default

Optional phoneNumberRequired

phoneNumberRequired?: boolean

Optional shippingAddressRequired

shippingAddressRequired?: boolean

If set to true, the user must provide a shipping address.

Optional shippingAddressRequirements

shippingAddressRequirements?: ShippingAddressRequirements

Optional shipping address requirements for the returned shipping address.

Optional transactionInfo

transactionInfo?: TransactionInfo

Details and the price of the transaction.

Automatically filled by the plugin from the PaymentRequest.

Settings

Member Visibility

Theme

On This Page

allowPrepaidCardsallowedPaymentMethodbillingAddressFormatbillingAddressRequiredcountryCodeemailRequiredenvironmentgoogleMerchantIdgoogleMerchantNamepayPalEnabledphoneNumberRequiredshippingAddressRequiredshippingAddressRequirementstransactionInfo