Summary
The LogiSense Hosted Payment Page provides a way to utilize the EngageIP payment system in a web portal via an IFrame. The Hosted Payment Page application securely communicates with the EngageIP billing engine to permit payments to be made or payment information to be added to customer accounts. This solution is fully PCI compliant as payment information is never stored on the site where the embedded IFrame is implemented.
The Hosted Payment Page supports all Payment Methods and Payment Processors that can be configured in EngageIP. For information on supported processors see the KB article: Credit Card Payment Processing Using iBiz.
Requirements
EngageIP 8.5.26.4 or later version with a PCI key configured
Hosted Payment Page installer for the EngageIP version
Installation
This section describes how to install the Hosted Payment Page application. If the Hosted Payment Page is already installed you can skip this section.
Note: the installation process described below will be performed by a LogiSense support specialist
Run the HostedPaymentPage installer that matches the installed EngageIP version
Click Next on the welcome screen
Click I Agree on the License Agreement screen
Enter the PCI Data Encryption Key which has been configured for the EngageIP instance and click Next
Choose an installation location (for example C:\Program Files (x86)\EngageIP\HostedPaymentPage) and click Install
When the installation completes click Finish
In IIS, remove the X-Frame-Options key - this allows the IFrame to be used with one or more different URLs. If this is not removed, it will be constrained to the URL of the server and won't be accessible as IFrames in other websites with unknown Hostnames.
Developer Implementation
The Hosted Payment Frame consists of both a web and an embeddable web page.
In order to access the web page, a call must first be made to the web
If the Hosted Payment Frame is installed at https://example.com/HostedPaymentPage/ then the web is available at https://example.com/HostedPaymentPage/Services.svc
A SOAP call must be made to https://example.com/HostedPaymentPage/Services.svc with the parameters for the operation. The web will then return a URL with an access token embedded into the URL.
This returned URL may then be used as the source for an IFrame embedded in a page - that IFrame will then display the page for the requested operation.
Web Service
The web available at https://example.com/HostedPaymentPage/Services.svc has one operation: GetUrl().
GetUrl() must be called with a single Parameters object detailing the operation to be performed.
For additional configuration details contact LogiSense Support:
LogiSense Support | email: support@logisense.com | web: Live Support |
phone (Canada): 1-519-249-0508 • | phone (USA): 1-917-410-3584 |
Add Payment Method Interface
Below is the default (stock) interface which will appear when adding a Payment Method in the Hosted Payment Page iframe (in this example a Credit Card Token payment method). Required fields are in red.
The Make Default option will make the new payment method the default payment method to use on the account.
Once you supply valid credit card information and click Save the Payment Method details will be written to the account that your website specified (CustomerId specified in the XML request). You can verify this by loading the account in the EngageIP AdminPortal and checking Tools -> Payment Methods.
Make Payment Interface
Below is an example of adding a Payment Method in the Hosted Payment Page IFrame (in this example a Credit Card Token payment method). Required fields are in red.
Payments can be verified in EngageIP by checking the Reports > Payments report. This report will contain the payment gateway Approval Code and Transaction Number.
One-Off Payment Interface
Sample one-off payment interface.
Customizing the Portal Interface
The stock interfaces displayed above can be customized using CSS. Your CSS file needs to be added to the Content folder (for example: C:\Program Files (x86)\EngageIP\HostedPaymentPage\Web\Content).
To align the IFrame style with your web portal style consult with your web developer.
Troubleshooting
If the IFrame is not displayed:
Check the IIS config in step #7 above to confirm if the Frame Option key exists or not. If it exists, remove it or edit it as needed to display the IFrame
Credit card details are not viewable in the AdminPortal / the Event Log shows encryption errors:
Ensure that your web.config in the HPP folder has the same encryption key that is used by the AdminPortal