ExternalHppGooglePayPayload

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

FieldTypeDescription
callbackUrlStringURL to receive transaction status updates
successRedirectUrlStringURL to redirect the customer after successful payment
failureRedirectUrlStringURL to redirect the customer after failed payment

Billing Details (ApmBillingDetails)

FieldTypeDescription
firstNameStringCustomer’s first name
lastNameStringCustomer’s last name
address1StringFirst line of the billing address
cityStringCity of the billing address
countryStringCountry code in ISO Alpha-2 format
postalCodeStringPostal/ZIP code
phoneStringCustomer’s phone number
emailStringCustomer’s email address

Device Information (Device)

FieldTypeDescription
ipStringCustomer’s IP address

Payload Structure

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

Fields

FieldTypeRequiredDescription
paymentMethodEnumYesMust be "EXTERNAL_HPP_GOOGLE_PAY"
paymentTypeEnumYesMust 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",
  "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

FieldTypeDescription
paymentMethodEnum"EXTERNAL_HPP_GOOGLE_PAY"
paymentTypeEnum"E_WALLET"
redirectUrlString (nullable)URL for redirect-based payment completion
iframeUrlString (nullable)URL for iframe-based payment completion
providerTransactionIdString (nullable)Unique identifier from the payment provider
extraMap<String, String>Optional metadata, such as receipt information or device data