ExternalHppApplePayPayload

Payment Method Identifier EXTERNAL_HPP_APPLE_PAY

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	The server endpoint where transaction status notifications (webhooks) will be sent after processing the payment.
`successRedirectUrl`	String	The URL to which the customer is redirected on successful completion of the payment process.
`failureRedirectUrl`	String	The URL to which the customer is redirected if the payment fails or is declined.

Billing Details (ApmBillingDetails)

Field	Type	Description
`firstName`	String	The given name of the customer 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 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 used for communication or receipts.

Device Information (Device)

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

Payload Structure

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

Fields

Field	Type	Required	Description
paymentMethod	Enum	Yes	Indicates the payment method used. Must be set to `EXTERNAL_HPP_APPLE_PAY` for Apple Pay transactions.
paymentType	Enum	Yes	Specifies the payment type. Must always be `E_WALLET` when using Apple Pay.

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	Indicates the payment method used. For Apple Pay, the value is `EXTERNAL_HPP_APPLE_PAY`.
`paymentType`	Enum	Specifies the payment type. For Apple Pay, it is always `E_WALLET`.
`redirectUrl`	String (nullable)	URL to which the customer should be redirected to complete the Apple Pay checkout process.
`iframeUrl`	String (nullable)	URL for embedding the Apple Pay checkout experience in an iframe (if supported).
`providerTransactionId`	String (nullable)	Unique transaction ID provided by the payment provider for reference.
`extra`	Map<String, String>	Optional metadata that may include additional details such as receipts or payment-specific information.

Required Request Fields

Payload Structure

Expected apmResponseData (ExternalHppApplePayResponseData)

Response Fields

Expected `apmResponseData` (ExternalHppApplePayResponseData)