EFT - HPP

ExternalHPPEftPayload

Payment Method Identifier

EXTERNAL_HPP_EFT

Payment Type

BANK_TRANSFER

Transaction Type

PAYMENT

Description

Initiate an Instant EFT payment using an external hosted payment page (HPP) flow.

Currency and Country availability depends on the end provider commercial agreement.

This payload is metadata-aware:

apmMethod: EXTERNAL_HPP_EFT

apmFlowType: BANK_TRANSFER
apmTransactionType: PAYMENT

This payload does not introduce additional custom fields beyond the required method/type identifiers.

✅ Required Request Fields

APMPayload Structure (ExternalHPPEftPayload)

{
  "paymentMethod": "EXTERNAL_HPP_EFT",
  "paymentType": "BANK_TRANSFER"
}

Fields

Field	Type	Required	Description
`paymentMethod`	Enum	Yes	Must be `"EXTERNAL_HPP_EFT"`.
`paymentType`	Enum	Yes	Must be `"BANK_TRANSFER"`.

Expected `apmResponseData` (ExternalHPPEftResponseData)

{
  "paymentMethod": "EXTERNAL_HPP_EFT",
  "paymentType": "BANK_TRANSFER",
  "providerTransactionId": "PROVIDER-REF-123456",
  "actionType": "REDIRECTION",
  "redirectUrl": "https://hpp.example.com/instant-eft/?payment_key=...",
  "iframeUrl": null,
  "qrData": null,
  "qrDeepLink": null
}

Response Fields

apmResponseData

Field	Type	Description
`paymentMethod`	Enum	`"EXTERNAL_HPP_EFT"`.
`paymentType`	Enum	`"BANK_TRANSFER"`.
`providerTransactionId`	String (nullable)	Provider/PSP transaction reference (if available).
`actionType`	Enum	Action to perform on the client. Default: `REDIRECTION`.
`redirectUrl`	String (nullable)	URL to redirect the customer to the hosted payment page.
`iframeUrl`	String (nullable)	Optional URL if the provider supports rendering inside an iframe.
`qrData`	String (nullable)	Optional QR payload string (if QR-based flow is supported).
`qrDeepLink`	String (nullable)	Optional deep link for mobile banking apps (if supported).

Notes

When creating a payment with External HPP EFT, ensure to use the ExternalHPPEftPayload structure as shown above. Handle the response by redirecting the user to the provided redirectUrl (or using iframeUrl if applicable) to complete the payment.