Interface GooglePayOneTimePaymentSession

Google Pay one-time payment session

Remarks

This session object manages the Google Pay payment flow. Unlike other payment methods, Google Pay does not use a start() callback pattern. Instead, merchants control the flow via Google's PaymentsClient and call confirmOrder() when payment data is received.

interface GooglePayOneTimePaymentSession {
    confirmOrder(
        options: GooglePayConfirmOrderOptions,
    ): Promise<GooglePayApprovePaymentResponse>;
    formatConfigForPaymentRequest(
        googlePayConfigFromFindEligibleMethods: GooglePayConfigFromFindEligibleMethods,
    ): GooglePayConfig;
    getGooglePayConfig(): Promise<GooglePayConfigResponse>;
}

Index

Methods

confirmOrder formatConfigForPaymentRequest getGooglePayConfig

Methods

confirmOrder

confirmOrder(
options: GooglePayConfirmOrderOptions,
): Promise<GooglePayApprovePaymentResponse>
Confirms a Google Pay payment with PayPal
Parameters
- options: GooglePayConfirmOrderOptions
  Payment confirmation options
Returns Promise<GooglePayApprovePaymentResponse>
Promise resolving to the approved payment response
Remarks
After the customer approves payment through Google Pay, call this method with the payment data from Google's onPaymentAuthorized callback. The response indicates whether 3DS authentication is required.
Example
```
const response = await session.confirmOrder({
  orderId: "ORDER-ID",
  paymentMethodData: paymentData.paymentMethodData,
});

if (response.status !== "PAYER_ACTION_REQUIRED") {
  // Capture the order
}
```
- Defined in packages/paypal-js/types/v6/components/googlepay-payments.d.ts:306

formatConfigForPaymentRequest

formatConfigForPaymentRequest(
googlePayConfigFromFindEligibleMethods: GooglePayConfigFromFindEligibleMethods,
): GooglePayConfig
Transforms Google Pay eligibility config into the format required by Google's PaymentsClient
Parameters
- googlePayConfigFromFindEligibleMethods: GooglePayConfigFromFindEligibleMethods
  Configuration from getDetails("googlepay").config
Returns GooglePayConfig
Formatted configuration ready for Google Pay SDK
Remarks
Performs field renames required by Google's API:
- supportedNetworks becomes allowedCardNetworks
- merchantCountry becomes countryCode
- Removes authJwt in sandbox environments
This must be called before passing config to isReadyToPay() or loadPaymentData().
Example
```
const details = paymentMethods.getDetails("googlepay");
const googlePayConfig = session.formatConfigForPaymentRequest(details.config);
const isReady = await paymentsClient.isReadyToPay({
  allowedPaymentMethods: googlePayConfig.allowedPaymentMethods,
  apiVersion: googlePayConfig.apiVersion,
  apiVersionMinor: googlePayConfig.apiVersionMinor,
});
```
- Defined in packages/paypal-js/types/v6/components/googlepay-payments.d.ts:262

getGooglePayConfig

getGooglePayConfig(): Promise<GooglePayConfigResponse>
Fetches Google Pay configuration from PayPal

Returns Promise<GooglePayConfigResponse>
Promise resolving to Google Pay configuration
Remarks
Makes an API request for fresh Google Pay configuration. This is an alternative code path that is rarely used in practice — the config bundled in findEligibleMethods() is the recommended approach.
Example
```
const config = await session.getGooglePayConfig();
```
- Defined in packages/paypal-js/types/v6/components/googlepay-payments.d.ts:281

Interface GooglePayOneTimePaymentSession

Remarks

Index

Methods

Methods

confirmOrder

Parameters

Returns Promise<GooglePayApprovePaymentResponse>

Remarks

Example

formatConfigForPaymentRequest

Parameters

Returns GooglePayConfig

Remarks

Example

getGooglePayConfig

Returns Promise<GooglePayConfigResponse>

Remarks

Example

Settings

On This Page