EXTERNAL_HPP

Payment Method Identifier: EXTERNAL_HPP_BLIK

This method enables BLIK payments through an external Hosted Checkout Page (HPP). The payment page handles the BLIK flow securely, offloading PCI compliance concerns and simplifying frontend integration.

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 Details (ApmBillingDetails)

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 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 and receipt purposes.

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_BLIK",
  "paymentType": "BANK_TRANSFER"
}

Fields

Field	Type	Required	Description
`paymentMethod`	Enum	Yes	Specifies the payment method. Must be set to `"EXTERNAL_HPP_BLIK"` for BLIK transactions.
`paymentType`	Enum	Yes	Defines the payment type. Must always be `"BANK_TRANSFER"` when using BLIK.

All interactions with BLIK (code entry, user authentication, etc.) are managed by the Hosted Checkout Page.

Expected `apmResponseData` (ExternalHppBlikResponseData)

{
  "paymentMethod": "EXTERNAL_HPP_BLIK",
  "paymentType": "BANK_TRANSFER",
  "actionType": "REDIRECTION",
  "redirectUrl": "https://checkout.example.com/redirect/blik/xyz789",
  "iframeUrl": null,
  "qrData": null,
  "qrDeepLink": null,
  "providerTransactionId": "txn_blik_001"
}

Response Fields

Field	Type	Description
`paymentMethod`	Enum	Indicates the payment method used. For BLIK, this is always `EXTERNAL_HPP_BLIK`.
`paymentType`	Enum	Specifies the type of payment. For BLIK transactions, it is always `BANK_TRANSFER`.
`actionType`	Enum	Always `REDIRECTION`.
`redirectUrl`	String (nullable)	URL to which the customer is redirected to complete the BLIK checkout process.
`iframeUrl`	String (nullable)	Always Null.
`qrData`	String (nullable)	Always Null.
`qrDeepLink`	String (nullable)	Always Null.
`providerTransactionId`	String (nullable)	A unique transaction identifier returned by the payment provider for tracking and reconciliation.

Required Request Fields

Payload Structure

Expected apmResponseData (ExternalHppBlikResponseData)

Expected `apmResponseData` (ExternalHppBlikResponseData)