Integrates the eWay payment gateway as a purchasable payment option, supporting one-off card purchases and recurring subscription billing. Registered as eWayPaymentApp, it exposes an admin settings panel for the eWay API key, API key password, client-side encryption key, sandbox toggle and invoice number/description expressions, configurable per organisation or per website. It renders the card payment form shown at checkout, reports the card schemes eWay accepts, and delegates the actual charge, token-customer and recurring-billing calls to EwayService.

Implements: Application, MenuApplication, ChildPageApplication, ReportingApplication, SettingsApplication, PaymentProviderApplication, DependentApplication, TemplatingApplication


Properties

PropertyReturnsDescription
encryptionKeyStringThe eWay client-side encryption key for the current website, falling back to the current organisation's key if the website has none set. Used by the payment form to encrypt card details in the browser before they are submitted to the server.
instanceIdStringFixed identifier this application is registered under with the application manager.
memberPaymentFormStringRenders the eWay card payment form shown to a logged in member during checkout.
paymentEnabledbooleanWhether this payment provider is currently enabled.
paymentFormStringRenders the eWay card payment form shown to a guest purchaser during checkout.
paymentOptionsList<PaymentOptionBean>The card schemes eWay accepts, each with its display name and logo path, for display beside the payment form.
rolesList<Role>Custom roles this application contributes to the role registry.
serviceEwayServiceThe service used to talk to the eWay Direct Payment API for purchases, token customers and recurring billing.

Methods

getInstanceId()

Returns: String

Fixed identifier this application is registered under with the application manager.

getService()

Returns: EwayService

The service used to talk to the eWay Direct Payment API for purchases, token customers and recurring billing.

getRoles()

Returns: List<Role>

Custom roles this application contributes to the role registry.

getPaymentForm()

Returns: String

Renders the eWay card payment form shown to a guest purchaser during checkout.

getMemberPaymentForm()

Returns: String

Renders the eWay card payment form shown to a logged in member during checkout.

getPaymentOptions()

Returns: List<PaymentOptionBean>

The card schemes eWay accepts, each with its display name and logo path, for display beside the payment form.

getEncryptionKey()

Returns: String

The eWay client-side encryption key for the current website, falling back to the current organisation's key if the website has none set. Used by the payment form to encrypt card details in the browser before they are submitted to the server.

isPaymentEnabled()

Returns: boolean

Whether this payment provider is currently enabled.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.