ExternalHPPApplePay

ExternalHppApplePayPayload

Payment Method Identifier

EXTERNAL_HPP_APPLE_PAY

Description

This method allows you to accept Apple Pay payments via an external Hosted Checkout Page (HPP). The checkout page collects the Apple Pay token securely and handles the interaction with the payment provider. This approach offloads PCI compliance and simplifies integration.

✅ 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_APPLE_PAY",
  "paymentType": "E_WALLET"
}

Fields

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

No additional fields are required. All necessary user interaction and Apple Pay token collection are handled through the Hosted Checkout interface.

Expected `apmResponseData` (ExternalHppApplePayResponseData)

{
  "paymentMethod": "EXTERNAL_HPP_APPLE_PAY",
  "paymentType": "E_WALLET",
  "redirectUrl": "https://checkout.example.com/redirect/applepay/abc123",
  "iframeUrl": "https://checkout.example.com/iframe/applepay/abc123",
  "providerTransactionId": "txn_apple_001",
  "extra": {
    "receipt": "ApplePayTransactionReference"
  }
}

Response Fields

Field	Type	Description
paymentMethod	Enum	`"EXTERNAL_HPP_APPLE_PAY"`
paymentType	Enum	`"E_WALLET"`
redirectUrl	String (nullable)	URL to redirect the customer to the Apple Pay checkout
iframeUrl	String (nullable)	URL for embedding the Apple Pay checkout via iframe
providerTransactionId	String (nullable)	Transaction ID from the payment provider
extra	Map<String, String>	Optional metadata, may contain receipt or other details