ExternalHppGooglePayPayload

Payment Method Identifier: EXTERNAL_HPP_GOOGLE_PAY

This method enables Google Pay payments through an external Hosted Checkout Page (HPP). The payment page collects the Google Pay token and securely processes it. This is ideal for simplifying frontend handling while maintaining PCI compliance.

Required Request Fields

Top-Level Fields

Field	Type	Description
`callbackUrl`	String	The server endpoint that receives transaction status updates (webhooks) after payment processing.
`successRedirectUrl`	String	The URL to which the customer is redirected after completing the payment.
`failureRedirectUrl`	String	The URL to which the customer is redirected if the payment fails or is declined.

Billing DetailsApmBillingDetails

Field	Type	Description
`firstName`	String	The customer's given name as it appears on billing records.
`lastName`	String	The surname of the customer for identification and billing purposes.
`address1`	String	The first line of the customer’s billing address (e.g., street name).
`city`	String	The city is associated with the customer’s billing address.
`country`	String	The two-letter ISO Alpha-2 country code of the billing address.
`postalCode`	String	The postal or ZIP code for the customer’s billing location.
`phone`	String	The customer’s contact phone number, including country code if available.
`email`	String	The customer’s email address is used for communication and receipt purposes.

Device InformationDevice

Field	Type	Description
`ip`	String	The IP address of the customer’s device, captured during the payment request.

Payload Structure

{
  "paymentMethod": "EXTERNAL_HPP_GOOGLE_PAY",
  "paymentType": "E_WALLET"
}

Fields

Field	Type	Required	Description
`paymentMethod`	Enum	Yes	Specifies the payment method. Must be set to `"EXTERNAL_HPP_GOOGLE_PAY"` for Google Pay transactions.
`paymentType`	Enum	Yes	Defines the payment type. Must always be `"E_WALLET"` when using Google Pay.

All interactions with Google Pay (token collection, user authentication, etc.) are managed by the Hosted Checkout Page.

Expected `apmResponseData` (ExternalHppGooglePayResponseData)

{
  "paymentMethod": "EXTERNAL_HPP_GOOGLE_PAY",
  "paymentType": "E_WALLET",
  "redirectUrl": "https://checkout.example.com/redirect/googlepay/xyz789",
  "iframeUrl": "https://checkout.example.com/iframe/googlepay/xyz789",
  "providerTransactionId": "txn_google_001",
  "extra": {
    "receipt": "GooglePayTransactionReference"
  }
}

Response Fields

Field	Type	Description
`paymentMethod`	Enum	Indicates the payment method used. For Google Pay, this is always `EXTERNAL_HPP_GOOGLE_PAY`.
`paymentType`	Enum	Specifies the type of payment. For Google Pay transactions, it is always `E_WALLET`.
`redirectUrl`	String (nullable)	URL to which the customer is redirected to complete the Google Pay checkout process.
`iframeUrl`	String (nullable)	URL that can be used to embed the Google Pay checkout flow in an iframe (if supported).
`providerTransactionId`	String (nullable)	A unique transaction identifier returned by the payment provider for tracking and reconciliation.
`extra`	Map<String, String>	Optional metadata that may include details such as payment receipt information, device-specific data, or additional context provided by the provider.

Required Request Fields

Payload Structure

Expected apmResponseData (ExternalHppGooglePayResponseData)

Expected `apmResponseData` (ExternalHppGooglePayResponseData)