Support for the TouchNet payment provider has been added in Aeon 4.0. This document will explain the settings and page customizations necessary to configure Aeon to use this feature.
TouchNet Settings
TouchNet should provide the following values to the customer, which will be referred to in the rest of this document.
- T-Link URL - You should receive a T-Link URL for both testing and production.
- uPay URL - You should receive a uPay URL for both testing and production.
- Site ID
- Authentication details
- T-Link Username
- T-Link Password
Customization Keys
The following customization keys should be set with the given values.
- PaymentProvider - "TouchNet"
- PaymentProviderMerchantId - **T-Link Username**
- PaymentProviderToken - **T-Link Password**
The following customization keys are not used in TouchNet integration.
- PaymentProviderResponseToken
- PaymentProviderTestModeEnabled
- When testing integration, you should use the test URLs for the T-Link and uPay endpoints on the web pages. When ready to go live, these should be replaced with their production versions.
- PaymentProviderPrefix - String prefix that will be added to the invoice number (external transaction identifier) to specify when the payment originated from.
Transaction Number
<input type="hidden" name="PaymentTNList" value="
<#PARAM name="PaymentTNList">">
Web Pages Customizations
Prior to the Aeon v5.0.73 web pages:
There are two feature-specific web pages for TouchNet integration: CreditCardPayment.html and CreditCardPaymentConfirmation.html. TouchNet differs slightly from other payment providers in that it does not complete payments on the TouchNet web page. Instead, it simply gathers payment details and returns the user to your CreditCardPaymentConfirmation page, where the user can confirm the transaction amount and complete the payment.
For Aeon v5.0.73 web pages and later:
Beginning in v5.0.73, the feature-specific CreditCardPayment.html and CreditCardPaymentConfirmation.html files were replaced with new default files and additional include_payment_form_touchnet.html and include_confirmation_form_touchnet.html files. You will need to modify the new default CreditCardPayment.html and CreditCardPaymentConfirmation.html web pages to reference the include files.
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:
- Open the default directory in File Explorer where your CreditCardPayment.html and CreditCardPaymentConfirmation.html pages are located. If you already have a complete set of 5.0.73 or later web pages, skip to step 4.
- If you have just downloaded new web pages, overwrite the CreditCardPayment.html and CreditCardPaymentConfirmation.html web pages with the updated files.
- Open the "templates" folder in the new web pages download, and add the "payment" subfolder to your web directory in the "templates" folder.
- Open CreditCardPayment.html and make the following changes:
Change this (default line 42):
<#INCLUDE filename=
"templates/payment/include_payment_form_none.html">To this:
<#INCLUDE filename=
"templates/payment/include_payment_form_touchnet.html"> - Open CreditCardPaymentConfirmation.html and make the following changes:
Change this (default line 13):
<#INCLUDE filename=
"templates/payment/include_confirmation_form_none.html">To this:
<#INCLUDE filename=
"templates/payment/include_confirmation_form_touchnet.html">
Credit Card Payment Form Web Edits
In the ajax call to generate a ticket to submit to uPay, there are some parameters that are configurable. You can find the section to modify by searching for the string "GenerateTouchNetTicket" and then looking for the "data" section a couple of lines below.
- tlinkUrl - This is the URL of the T-Link web service and should be set to your **T-Link URL**. The default page has a placeholder value of "https://your.tlink.url".
- transactionNumbers - This value passes the list of applicable requests back to Aeon and should not be modified from its default value of "<#PARAM name='TransactionNumbers'>".
- ticketName - The name of the ticket for reporting purposes, in order to distinguish Aeon payments from those submitted by other systems. This value must exactly match the ticket name in the form section of this page (see below). The value in the default page is "Aeon Reproductions".
- successLink - The Aeon URL that the user will be returned to after successfully filling out their payment details. The default value is "<#CUSTOMIZATION name='WebURL'>aeon.dll?action=30&type=112". This generally shouldn't need to be changed unless a site needs to ensure users are returned to a particular web directory that may differ from where the request was initiated.
- errorLink - The Aeon URL that the user will be returned to in the event an error occurs on the TouchNet payment page. The default value is "<#CUSTOMIZATION name='WebURL'>aeon.dll?action=30&type=113". This generally shouldn't need to be changed unless a site needs to ensure users are returned to a particular web directory that may differ from where the request was initiated.
- cancelLink - The Aeon URL that the user will be returned to if they choose to cancel the process on the TouchNet payment page. The default value is "<#CUSTOMIZATION name='WebURL'>aeon.dll?action=30&type=104". This generally shouldn't need to be changed unless a site needs to ensure users are returned to a particular web directory that may differ from where the request was initiated.
There are some configurations that need to be made to the form. You can find the form by looking for the <form> element that has an ID of "paymentform".
- action - The action attribute in the <form> element needs to be set your **uPay URL**. The default page has a placeholder value of "https://your.upay.url".
- TICKET - This input value should be left blank. It will be populated with the ticket that is retrieved by the ajax call to the T-Link URL that occurs when the user clicks the "Pay Now" button.
- TICKET_NAME - This input specifies the name of the ticket for reporting purposes. This value must exactly match the ticket name in the ajax section of this page (see above). The value in the default page is "Aeon Reproductions".
- UPAY_SITE_ID - This input should contain your **Site ID**. The default page has a placeholder value of "YourSiteID"
CreditCardPaymentConfirmation.html
The only form input that should be modified on this page is for TLinkURL, which should be set to your **T-Link URL** as on the previous page. The default page has a placeholder value of "https://your.tlink.url". The remaining inputs must be left with their default values.
- AeonForm - TouchNetPaymentConfirmation
- PaymentSessionID - <#PARAM name="PaymentSessionID">
- PaymentInvoiceID - <#PARAM name="PaymentInvoiceID">