Skip to main content

Using Payeezy with Aeon

Credit card payments made using Payeezy are made on a secure page hosted by this provider. When a researcher chooses transactions to pay for and clicks the Pay Online/Pay Now button on the Aeon Order Billing form (ViewOrderApproval.html), they are taken to the Payeezy-specific CreditCardPayment form. Clicking the Pay Online/Pay Now button on this form takes them to a secure page outside of Aeon to perform the credit card transaction.

After the payment is submitted and the transaction is complete, the researcher is redirected back to the Order Billing page in the Aeon web interface. The form shows an updated balance due and the status line at the top of the form notifies the researcher that the payment was successful and displays the payment confirmation code.

Aeon integrates with Payeezy using the Hosted Checkout method.

Configuring Customization Keys for Payeezy​

The payment provider keys used to set up Payeezy are located in the Aeon Customization Manager under System > Billing. You will need to set the following key values:

KeyDescription
PaymentProviderMerchantIdEnter the Payment Page Id provided to you by Payeezy, which can be obtained from the Payment Pages section of the Payeezy website.
PaymentProviderResponseTokenThis is the Response Key used to authenticate responses sent from Payeezy to the Aeon system. This value is the response key that displays on the security tab of the payment page within the Payeezy merchant interface.
PaymentProviderTokenThis is the Transaction Key used for encryption when sending the initial request from Aeon to Payeezy. This value is the transaction key that displays on the security tab of the payment page within the Payeezy merchant interface.
CreditCardTransactionsDescriptionThis value is used as a product description on the Payeezy website to describe the researcher's purchase. Payeezy does not display this value to the customer. The default value of this key includes the transaction numbers of the included requests: Aeon Photoduplication charges for transaction(s) <#PARAM name='TransactionNumbers'>. This key is located under System > General.

Editing the Web Forms for Payeezy​

Below are the steps necessary to set up the web forms to work with Payeezy. Specialized ViewOrderApproval and CreditCardPayment forms have been created to work with Payeezy. Your Implementation Coordinator or Customer Service Agent will supply these to you when you are setting up your payment provider information. They are also available as a zip file at Aeon Downloads.

ViewOrderApprovals Form​

Replace the default ViewOrderApprovals form in the Web folder with the ViewOrderApprovals form designed to work with credit card payments. This form contains the Pay Now button that takes the researcher to the CreditCardPayment.html form.

CreditCardPayment Form​

For Aeon v5.0.73 web pages or later:

You will need to modify the default CreditCardPayment.html web page to reference include_payment_form_payeezy.html. These files can be downloaded from the Aeon Downloads page as part of the Aeon Default Web Pages. See the instructions below for the required changes:

  1. Open the default directory in File Explorer where your CreditCardPayment.html page is located. If you already have a complete set of 5.0.73 or later web pages, skip to step 4.
  2. If you have just downloaded new web pages, overwrite the CreditCardPayment.html web page with the updated file.
  3. Open the "templates" folder in the new web pages download, and add the "payment" subfolder to your web directory in the "templates" folder.
  4. Open CreditCardPayment.html and make the following changes:
Change this (default line 42):To this:
<#INCLUDE filename="templates/payment/include_payment_form_none.html"><#INCLUDE filename="templates/payment/include_payment_form_payeezy.html">

Prior to Aeon v5.0.73 web pages:

  1. Replace the default CreditCardPayment form in the Web folder with the Payeezy CreditCardPayment.html form.

After updating your web pages with the new files, make the following changes to these hidden fields on CreditCardPayment.html if you are on web pages prior to Aeon v5.0.73. If you are using Aeon v5.0.73 or later web pages, you should make these edits on include_payment_form_payeezy.html:

  • x_relay_url. By default, this field is set to the value of the WebDLL customization key, but in some instances, it may be necessary to change this value to use a specific URL. The most common case is if you have both a protected and unprotected Aeon directory. For instance, if you are Shibboleth, you will want to set the x_relay_url to the unprotected directory.
  • transactionNumbers. This field provides the value that will be used on the Payeezy website to describe the researcher's purchase. The default setting simply pulls the value from the CreditCardTransactionsDescription customization key but can be changed if you wish to differentiate the product's description, and additional values can be added.

Note that the javascript of this page has been changed from previous versions. If a user cancels the page the account is returned to the Main Menu:

$("#cancel").click(function() {

                      window.location.replace("<#DLL>?action=10&form=10"

Aeon Relay Response URL​

The Relay Response URL will be necessary when configuring your Payeezy settings. This needs to be formatted very precisely in order for the successful integration of Aeon and Payeezy.

The default URL is the value of the WebURL customization key with “aeon.dll?action=11&type=110” appended to the end

In some systems, such as those using Remote Authentication, the Relay Response URL is the value hardcoded in the CreditCardPayment.html (prior to v5.0.73)/include_payment_form_payeezy.html (v5.0.73 and later) page in the following tag:

<input type="hidden" name="x_relay_url" value="<#CUSTOMIZATION>aeon.dll?action=11&type=110">
warning

Payeezy requires that the Relay Response URL use HTTPS. Your Aeon DLL must be secured with a certificate to successfully receive records of payment from Payeezy.

Editing Payeezy Settings

Log into your Payeezy account, navigate to Payment Pages.

Create a new payment page to be used for Aeon.

Complete all fields with your site-specific information. The "Return to Your Site" URL should be replaced with your Aeon URL.

The Payment Types page should be configured based on your institution's local needs. If your institution has a finance office they may provide guidelines on how this should be completed if they need to set up another merchant or terminal to be used for Aeon. Aeon does not support level 3 processing.

Aeon does not need the Pay Now/Donate Now button. That page can be skipped in the setup.

Receipt Page Configuration:

Aeon does not use the receipt page within Payeezy and instead redirects the user back to Aeon after payment is completed. Configure the following settings:

  • Return link method: Set to "Link" (since the receipt page is not used internally and uses the Authorize.Net Protocol)
  • Allow Relay Response: Check this checkbox and enter your Relay Response URL as indicated above
  • Allow HTTP Redirect to Merchant Website: Enable this setting to allow Payeezy to redirect to the Aeon web interface after the Relay Response is successfully validated
  • Retry Failed Relay Responses: Atlas Systems recommends enabling this setting so that if there are networking issues after payment completion, transactions can be successfully recorded from Payeezy to Aeon at a future time

Important Review Process:

warning

Payeezy support staff reviews all relay response URLs for both demo and production interfaces. Plan accordingly when testing or moving to production and allow time for their review.

  • The configuration does not need to be completed for Payeezy staff to review, but the Aeon DLL needs to be working
  • When you view the Payeezy relay response URL, you should see a blank white page - this is normal
  • Once Payeezy's review is complete, the URLs will show on the page with a green checkbox

Additional Configuration Options​

Receipt Emails, Customize Form, and Appearance:

  • Configure these settings based on your institution's local needs
  • Aeon does not require any specific configurations for these sections

Recurring Billing:

  • Disable the "Enable Recurring Payments" section
  • Aeon does not support recurring billing functionality

Security Settings Configuration​

  1. Navigate to the Security Settings page to configure encryption settings for Aeon integration
  2. Set the Encryption Type to MD5
  3. Configure your authentication keys:
    • Use existing transaction key & response key as configured, or
    • Click the generate buttons to create new keys as needed
  4. Record the following values for your Aeon Customization Manager:
    • Transaction Key → Enter as PaymentProviderToken customization key
    • Response Key → Enter as PaymentProviderResponseToken customization key

Complete Setup​

Click "Create" to finalize your Payeezy payment page configuration for Aeon.

User-defined Fields on the Web Pages​

User-defined fields allow you to add additional information to payment details beyond the default page content.

Available Fields:

  • x_user1
  • x_user2
  • x_user3

Implementation:

  • Information submitted in these fields will be included in the Payeezy report
  • Web pages prior to v5.0.73: Add these fields to CreditCardPayment.html
  • Web pages v5.0.73 or later: Add these fields to include_payment_form_payeezy.html

Example:

Payeezy.png

Workflow​

The user will navigate to the Order Billing page and should select the transactions they want to pay for and then click the "Pay Online" button.

The user is presented with a confirmation screen showing all transactions selected and a total amount. The user will then click the "Pay Now" button to be directed to the Payeezy payment form.

The user will enter their payment information.

After completing the payment the user is redirected back to Aeon and should see a status to indicate payment has been accepted. The transactions that were paid for will no longer appear when clicking the "order Billing" page.