Google Pay - Hpp

ExternalHppGooglePayPayload

Payment Method Identifier

EXTERNAL_HPP_GOOGLE_PAY

Description

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	URL to receive transaction status updates
`successRedirectUrl`	String	URL to redirect the customer after successful payment
`failureRedirectUrl`	String	URL to redirect the customer after failed payment

Billing Details (ApmBillingDetails)

Field	Type	Description
`firstName`	String	Customer’s first name
`lastName`	String	Customer’s last name
`address1`	String	First line of the billing address
`city`	String	City of the billing address
`country`	String	Country code in ISO Alpha-2 format
`postalCode`	String	Postal/ZIP code
`phone`	String	Customer’s phone number
`email`	String	Customer’s email address

Device Information (Device)

Field	Type	Description
`ip`	String	Customer’s IP address

Payload Structure

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

Fields

Field	Type	Required	Description
paymentMethod	Enum	Yes	Must be `"EXTERNAL_HPP_GOOGLE_PAY"`
paymentType	Enum	Yes	Must be `"E_WALLET"`

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",
  "actionType":"REDIRECTION",
  "redirectUrl": "https://checkout.example.com/redirect/googlepay/xyz789",
  "iframeUrl": "https://checkout.example.com/iframe/googlepay/xyz789",
  "qrData":null,
  "qrDeepLink":null,
  "providerTransactionId": "txn_google_001",
  "extra": null
}

Response Fields

Field	Type	Description
paymentMethod	Enum	`"EXTERNAL_HPP_GOOGLE_PAY"`
paymentType	Enum	`"E_WALLET"`
actionType	Enum	Always `REDIRECTION`
redirectUrl	String (nullable)	URL for redirect-based payment completion
iframeUrl	String (nullable)	URL for iframe-based payment completion
qrData	String (nullable)	Always Null
qrDeepLink	String (nullable	Always Null
providerTransactionId	String (nullable)	Unique identifier from the payment provider
extra	Map<String, String>	Optional metadata, such as receipt information or device data