Post on 25-Sep-2020
Payment Page V2
Template Builder
Payment Page Template Builder Manual – V1.5 – 4th
September 2014 2
Revision History
The following table summarises the main changes made to this document:
Ver. Author Date Comments
2.0 JS August 2014 - Hide details information included - Exporting and Importing templates sections added - Updated in-line with solution re-branding
New screenshots and document rebrand - Reviewed wording to template changes section - Added new Template Titles section - Information on Default Accessible Template added - Added domain ending information
1.4 ND Jan 2012 - Note added on PayPage V2 overnight process - Updated document with new format
1.3 ML Jun 2011 - PayPage Template Builder URL updated
Payment Page Template Builder Manual – V1.5 – 4th
September 2014 3
Table of Contents
Revision History ......................................................................................................................... 2
Introduction ................................................................................................................................ 5
Template Builder Overview ........................................................................................................ 6
Initial Setup Requirements ......................................................................................................... 7
Login .......................................................................................................................................... 8
URLs .......................................................................................................................................... 8
New User ................................................................................................................................... 8
Login ........................................................................................................................................ 10
Forgotten Password ................................................................................................................. 10
Password Refresh .................................................................................................................... 11
Logout ...................................................................................................................................... 12
Payment Page Account............................................................................................................ 13
Creating an Account ................................................................................................................ 13
Editing a Payment Page Account ............................................................................................. 17
Deleting a Payment Page Account ........................................................................................... 17
Payer Authentication Decisions ................................................................................................ 18
PayPal ..................................................................................................................................... 20
SVS ......................................................................................................................................... 20
Templates ................................................................................................................................ 21
Template Migration .................................................................................................................. 21
Creating a new template .......................................................................................................... 21
Making and Reviewing Changes .............................................................................................. 23
Restore Defaults ................................................................................................................... 23
Preview ................................................................................................................................ 23
Discard Changes .................................................................................................................. 23
Save Changes ...................................................................................................................... 23
Change Application Timescales ........................................................................................... 24
Template Pages ....................................................................................................................... 25
Template Elements .................................................................................................................. 26
Payment Page Template Builder Manual – V1.5 – 4th
September 2014 4
Template Content .................................................................................................................... 27
Changing Page Content ....................................................................................................... 27
Payment Pages .................................................................................................................... 29
Result Pages ........................................................................................................................ 32
PayerAuth ............................................................................................................................ 33
Template Images ..................................................................................................................... 34
Changing Page Images ........................................................................................................ 34
Template CSS ......................................................................................................................... 36
Basic CSS vs. Advanced CSS .............................................................................................. 36
Controls ................................................................................................................................... 37
Text field and drop down box ................................................................................................ 37
Multiple Text fields ................................................................................................................ 37
Colour Pickers ...................................................................................................................... 38
Changing CSS Values .......................................................................................................... 40
‘Not Set’................................................................................................................................ 42
Template Information ............................................................................................................... 43
Merchant Template ID .......................................................................................................... 43
Creating a New Template ..................................................................................................... 43
Editing Template Information ................................................................................................ 43
Deleting Templates .............................................................................................................. 44
Exporting Templates ............................................................................................................ 45
Template Import ....................................................................................................................... 45
Template Emails ...................................................................................................................... 47
Template Titles ........................................................................................................................ 50
Integration Keys ....................................................................................................................... 52
Creating a key ...................................................................................................................... 53
Editing a key ......................................................................................................................... 55
Disabling a key ..................................................................................................................... 56
Restrictions .............................................................................................................................. 57
Add a Restricted User Group ................................................................................................ 57
Add a Restricted User Account ............................................................................................. 59
Edit a Restricted User Account ............................................................................................. 60
Edit a Restricted User Group ................................................................................................ 61
Payment Page Template Builder Manual – V1.5 – 4th
September 2014 5
Contact Details ....................................................................................................................... 62
Introduction
This document is designed to provide full details on how to use Payment Page Template
Builder.
The template builder has been created to provide merchants integrating to Payment Page V2
with a tool to customise and configure the solution.
For details on integration to Payment Page V2, please consult the latest version of the Payment
Page V2 Integration Guide or contact your VeriFone Sales Account Manager.
Payment Page Template Builder Manual – V1.5 – 4th
September 2014 6
Template Builder Overview
Payment Page Template Builder has been created to act as a support tool for the second
version of Payment Page.
It is a browser-based tool, accessible from any desktop computer or laptop with an internet
connection and using Internet Explorer versions 8 to 11. It has not been optimised for mobile or
tablet use.
The tool enables the user to create page templates to use with Payment Page and customise
not only the visual appearance for a customer but also the messages displayed. A combination
of custom CSS (Cascading Style Sheets), images (e.g. branding, button graphics) and content
(headings, transaction response message text) can be amended to create an entirely custom
look and feel.
The security of the data and system configuration is protected by a secure login process. The
‘New User’ process also ensures that account specific details are validated before allowing the
user to create new login credentials.
Should any further information be required which is not supplied within this document, please
refer to the contact details at the back of the manual.
Please note: The Payment Page Template Builder support tool is not compatible with the first
version of Payment Page.
Payment Page Template Builder Manual – V1.5 – 4th
September 2014 7
Initial Setup Requirements
In order to process a transaction using Payment Page V2, please see the below steps which
outline the minimum requirements:
1. Create a login to Payment Page V2 Template Builder
2. Log into the Payment Page V2 Template Builder using the login credentials created
3. Select ‘Payment Page Account’ from the list of available sections
4. Use the ‘Add New Payment Page Account’ to create an account
5. Configure the following sections of Payment Page V2 account as required:
a. Merchant details, enabling notifications and Payer Authentication if required
b. Use one of the default templates available (It is possible to create a customised template. See page 19)
c. Payment methods required, such as PayPal & SVS (merchant information will be requested as part of the account setup to correctly configure some methods)
d. Post code, address and CVC decisions, enabling the conditions under which a transaction should be accepted by Payment Page
6. Click ‘Create’ to build the account
Following the steps above will create a Payment Page V2 account which can be used to
process transactions without the need to design custom templates, should this be required.
Please note: It is not possible to process any transactions using Payment Page V2
prior to creating and configuring the Payment Page V2 Account.
Payment Page Template Builder Manual – V1.5 – 4th
September 2014 8
Login
URLs
In order to access the Payment Page Template Builder please use the below URLs:
Test URL: https://paypage2-test.cxmlpg.com/paypage2templatebuilder/
Live URL: https://pp2.cxmlpg.com/paypage2templatebuilder/
New User
If using the Payment Page Template Builder for the first time, it will be necessary to provide the
test account details supplied by VeriFone. Should a copy of these details be required, please
consult Ocius.techservices@VeriFone.com.
In order to create a new user, please follow the process below:
1. Navigate to the required version of the template builder (live/test) using the URLs above
2. Click the ‘New User’ link and the screen below will appear.
Payment Page Template Builder Manual – V1.5 – 4th
September 2014 9
3. Enter the System ID, Passcode and GUID (Globally Unique Identifier) provided by VeriFone. Click ‘Validate’ to continue. The system will then validate the details and check if a user exists for the system currently. There is a maximum of one user per system; additional users to cater for scenarios such as resellers can be created once the main user has logged in.
4. Create the user by supplying the details requested, and click ‘Create’ to complete. The ‘UserName’ must be a valid email address; this will be used for confirmation of changes to passwords.
Please note: Passwords must be a minimum of 8 characters in length and must contain at
least 1 digit, 1 lower case letter, 1 upper case letter, 1 non-character (such as *!,#,%,@). Must
not contain the words 'pass', 'word' or 'god' and must not contain a whitespace.
Payment Page Template Builder Manual – V1.5 – 4th
September 2014 10
Login To log into the Payment Page Template Builder, navigate to the test or live version as required.
Enter the User Name and Password and click ‘Log In’.
The details will be verified and the user logged into the correct merchant system.
Forgotten Password
In the event that an incorrect username or password is entered, the message below will appear:
It is possible to have the details reset by using the ‘Forgotten Password’ link below the VeriFone
logo on the login screen. The following dialog box will be displayed:
Enter the username provided during user creation and click ‘Send Email’. A new password will
be issued and sent to the email address connected to the account.
After logging back in, the password issued via email should be changed using the ‘Change
Password’ link in the top right of the screen. For instructions on changing the password, see the
next section.
Payment Page Template Builder Manual – V1.5 – 4th
September 2014 11
Password Refresh
Payment card industry (PCI DSS) requirements state that passwords should be changed at a
minimum interval of every 90 days.
The Payment Page Template Builder password can be changed at any time using the ‘Manage
User Account’ link. After logging in, this can be found in the top right of the screen (circled in red
below).
In order to change the password, follow the instructions below:
1. Click on the ‘Manage User Account’ link, the below dialog box will be displayed (the username will be pre-populated).
2. Enter the current password, new password and then confirm the new password by entering a second time. Press ‘Update’ to apply the change
3. The change will be confirmed on screen.
Please note: The ‘Username’ can be edited by modifying the text in this field, whereby the
current password will be required to update this.
Payment Page Template Builder Manual – V1.5 – 4th
September 2014 12
Logout
When the current user wishes to end their session, the logout menu option (circled in red below)
can be used to exit.
Once clicked, this will return the user to the login page.
Payment Page Template Builder Manual – V1.5 – 4th
September 2014 13
Payment Page Account
The ‘Payment Page Account’ page allows users to create, configure and delete Payment Page
accounts. These are associated with an EFT account and a default template, as well as holding
all the configuration details for Payment Page.
Creating an Account
When using Template Builder for the first time, there will be no Payment Page Account
available for use, and creating one will be required before beginning to process transactions.
In order to create a new Payment Page Account:
1. Navigate to ‘Payment Page Account’ with Payment Page Template Builder, after logging in
2. Click on the ‘Add New Payment Page Account’ link to initiate the creation of a new account
3. The above screen will be displayed, requiring completion of each of the fields according
to how the account should be configured.
Payment Page Template Builder Manual – V1.5 – 4th
September 2014 14
Section Item Description
Merchant Details Email Merchant email address to which transaction confirmation emails should be sent.
Transaction retries The number of retries a customer can attempt if a transaction fails. By default this will be set to 2 (meaning 2 transaction retries can be carried out after the 1
st failed attempt).
Capture Method Select default transaction capture method from the below options; - Keyed Cardholder Not Present Mail Order - Keyed Cardholder Not Present Telephone Order - Keyed Cardholder Not Present E-Commerce Order
Account ID The Account ID (Merchant ID) is the merchant account used to process transactions
Completion URL The URL to redirect the customer to upon completion of the transaction using Payment Page (known as ‘Return URL’ with Payment Page V1) Please note: Merchants can only use URLs with the following
domain endings: com, edu, gov, mil, net, org, biz, info, name, museum, us, ca, uk, dev
Append Result to Completion URL
Option to include the transaction result and transaction reference within the completion URL which the customer is redirected to after the transaction has been processed. E.g. RETURN URL HERE?ref=YOUR REFERENCE&result=RESULT TEXT
Merchant Name Name of the merchant
Merchant Country Country of the merchant (This field will be automatically populated with the merchant’s country)
Receive Notifications This Boolean defines if the merchant wishes to utilise notifications (responses from Payment Page reporting transaction history). Tick to enable and reveal the two Notification fields below
Notification URL (Optional, but recommended)
Used to provide the URL to which Payment Page should send notification messages, at the location of which a script on the merchant web server will receive the notification messages. The notification URL must use SSL encryption Please note: Merchants can only use URLs with the following
domain endings: com, edu, gov, mil, net, org, biz, info, name, museum, us, ca, uk, dev
Notification IP Address (Optional, but recommended)
IP address of the notification target where Payment Page will send a data stream response to, containing information on the transaction
Error URL Enter URL to manage the errors occurred by the customer. The page will contain a merchant reference, an error type and an error code. The URL must be in the following format: https:// Please note: Merchants can only use URLs with the following
domain endings: com, edu, gov, mil, net, org, biz, info, name, museum, us, ca, uk, dev
PayerAuth Use PayerAuth This field defines if the merchant wishes to use Payer Authentication when processing transactions. Tick to enable and reveal the below Payer Authentication fields
Merchant URL Merchant’s website URL (mandatory field)
Visa Bank ID Payer Auth details used for enrolment checks. These details will be provided by the merchant’s acquirer as part of the merchant agreement
Visa Number
Visa Password
MasterCard Bank ID
MasterCard Number
PayerAuth Decisions Select which Payer Authentication results should be accepted when
Payment Page Template Builder Manual – V1.5 – 4th
September 2014 15
processing transactions.
Please see the PayerAuth Decisions section for more
information. Please note at least one option must be selected.
Each option is described below:
Option Description
BIN Range Enrolled / Successful Cardholder Authentication
Participating Issuer, participating cardholder. Cardholder enrolment verified, authentication successful
BIN Range Enrolled / Cardholder Not Participating
Participating Issuer, participating cardholder. Cardholder enrolment verified. Visa have an Attempts ACS to act on behalf of non-participating Issuers / or non-enrolled cardholders.
BIN Range Enrolled / Failed Cardholder Authentication
Participating Issuer, participating cardholder. Cardholder enrolment verified; Issuer declines authentication cardholder. I.e. cardholder unable to provide correct password.
BIN Range Enrolled / Unable to Verify Cardholder Authentication
Participating Issuer, participating cardholder. Cardholder enrolment verified. Authentication could not be completed due to technical or other reasons.
BIN Range Enrolled / Technical Error In Authentication Process
No Payer Authentication response is received
BIN Range Not Enrolled / Cardholder Not Participating
Non-Participating Issuer. Cardholder enrolment not supported by Issuer
Technical Error – Unable To Verify BIN Range Support / Cardholder Participation
Non-participating Issuer
Participating Issuer, card range of cardholder not registered in directory
Participating Issuer, cardholder not enrolled in ACS
Options Email Defines which email notifications should be generated by Payment Page to confirm transactions: Merchant – create and send merchant email Customer – create and send customer email
Default Template ID The Template to be set as the default for transactions processed using this Payment Page account
Payment Methods Options to enable acceptance of other payment methods. Card is always enabled to allow EFT transaction processing
Post Code decisions Post Code AVS responses which if returned should be accepted and the transaction progressed. Decisions not enabled will result in a declined transaction
Address decisions Address AVS responses which if returned should be accepted and the transaction progressed. Decisions not enabled will result in a declined transaction
CVC decisions CVC responses which if returned should be accepted and the transaction progressed. Decisions not enabled will result in a declined transaction
PayPal Details User PayPal API details, issued by PayPal These options are only available if PayPal is enabled as a payment method
Password
Signature
SVS Details Account Select the account from those available
Store Select the store from those configured
Division Number Select the division number from those available
Payment Page Template Builder Manual – V1.5 – 4th
September 2014 16
4. Click ‘Create’ to save the configurations and build the Payment Page Account.
Please note: Live Payment Page V2 accounts are built as part of an overnight process and
therefore will not be available immediately once the account is created.
Please note: If processing an Auth Only transaction, the decision matrices listed do not apply
as Payment Page will not automatically reject payments based on CV2/AVS.
Payment Page Template Builder Manual – V1.5 – 4th
September 2014 17
Editing a Payment Page Account
To edit a Payment Page Account:
1. Open the ‘Payment Page Account’ section within Template Builder
2. Click the green crayon ‘Edit’ icon for the account which requires changes
3. The Payment Page Account Edit screen will be displayed, which displays all the settings configured when the account was initially configured
4. Amend the settings required and then use the ‘Update’ button in the bottom right hand corner to save
Deleting a Payment Page Account
In order to delete an existing Payment Page account which has been created, use the ‘Delete’
button and confirm removal of the account.
Please note: Should the notification details change, a new request will be raised with
VeriFone to update the firewall. This will take 5 days to action.
Payment Page Template Builder Manual – V1.5 – 28th
February 2014 18
Payer Authentication Decisions
In order to decide upon which situations to accept or decline transaction, the below table is included and covers both Visa VbV
Transactions and MasterCard SecureCode Transactions. This matrix provides a description of the Authentication Results and Merchant
to Acquirer values presented during each scenario.
Case Number
MPI Authentication APACS Authorisation Streamline Settlement RAG Status
Card Type VERes PARes CAVV/AVV ECI ECI CAVV/AVV Trans ID ATSD Trans source Liability Shift
1 Visa 3D Y Y Yes 05 05 Yes Yes D0C100 12 Yes
2 Visa 3D Y A Yes 06 06 Yes Yes D0C200 13 Yes
3 Visa 3D N None None None None None None D0C200 13 Yes
4 Mcard 3D Y Y Yes 02 02 Yes Yes D09100 12 Yes
5 Mcard 3D Y A Yes 01 01 Yes Yes D09200 13 Yes
6 Mcard 3D N None None None None None None D09200 13 Yes
7 None 3D None None None None None None None 808000 14 No
8 Visa 3D U None None None None None None D0C400 14/13 No
9 Visa 3D Y U None None None None None D0C400 14/13 No
10 Mcard 3D U None None None None None None D09400 13 Yes
11 Mcard 3D Y U None None None None None D09400 13 Yes
12 Visa 3D Y N None None None None None None None None
13 Mcard 3D Y N None None None None None None None None
Key to VERes & PARes Codes:
Y (VERes) Perform a PARes
N (VERes) Issuer/BIN not participating
U (VERes) Authentication process did not complete correctly
Y (PARes) Cardholder enrolled and authenticated
A (PARes) Cardholder not enrolled
N (PARes) Cardholder enrolled, transaction not authenticated
U (PARes) Authentication process did not complete correctly
Payment Page Template Builder Manual – V1.5 – 28th
February 2014 19
Key to RAG Status:
Indicates a BAU (business as usual) transaction Indicates a system failure at some point Indicates attempted fraud or cardholder error
VbV
EMV Terminal Type 30 (Visa ECI 5) = Merchant & Cardholder are registered
31 (Visa ECI 6) = Merchant is registered, but Cardholder isn't.
32 (Visa ECI 7) = Standard E-Commerce message
APACS 70-2
Section B.4.2 (page 85) Electronic Commerce Data Record Sub-type 01
APACS 70-3 G = Merchant & Cardholder registered
Section A.4 (page 93) H = Merchant is registered, but Cardholder isn't.
Customer Instruction J = Standard E-Commerce message
Tests 5a & 5b Please put a line through the scenario not being used
Tests 6a & 6b Please put a line through the scenario not being used
Secure
Code
EMV Terminal Type 30 (M'Card PDS 2) = Merchant & Cardholder are registered
31 (M'Card PDS 1) = Merchant is registered, but Cardholder isn't.
32 (M'Card PDS 0) = Standard E-Commerce message
APACS 70-2
Section B.4.2 (page 85) Electronic Commerce Data Record Sub-type 01
APACS 70-3 G = Merchant & Cardholder registered
Section A.4 (page 93) H = Merchant is registered, but Cardholder isn't.
Customer Instruction J = Standard E-Commerce message
Tests 12a & 12b Please put a line through the scenario not being used
Tests 13a & 13b Please put a line through the scenario not being used
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 20
PayPal
Payments can be made using PayPal, providing the customer with the option to use their PayPal
account should they prefer to do so.
In order to enable PayPal as a payment method, when creating the Payment Page Account, the
PayPal API credentials will be required.
During a transaction, the PayPal logo will be displayed on screen, providing the customer with a
choice of methods to complete the payment.
SVS
Stored Value Solutions branded gift cards can be processed utilising Payment Page V2. This
provides the merchant with the ability to offer the option to the customer to pay with an SVS card
as well as a credit or debit card.
If there are insufficient funds available on the SVS card then an ‘SVSBalanceResult’ page will be
displayed to the cardholder, informing them that the balance on the card was not sufficient to
complete the purchase and to proceed to select another payment method.
Please note: This option will only be available for selection should PayPal have been
enabled on the merchant account. Please speak to Technical Services for help with
configuration of this option, or with the VeriFone Sales Account Manager to order PayPal.
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 21
Templates
The main feature of the Payment Page Template Builder is the ability to create templates for use
by Payment Page. This allows the merchant to provide a seamless experience when redirecting
customers from the merchant website to the hosted payment page, by enabling customisation of
the look and feel of each page within the payment process.
Template Migration
Merchants should be aware that Payment Page Templates created within the test environment
cannot be migrated to the live environment prior to going live. As a result, VeriFone recommends
that merchants only use the test environment to a create an initial template during integration.
After integration testing is carried out, it is recommended that merchants apply any future template
branding changes to the live environment as part of the roll-to-live deployment plan. UAT testing
should then be performed prior to go-live.
Creating a new template
Default templates are available and supplied by VeriFone, but to enable changes to be made to
them, each merchant is required to create a new template based upon the defaults available:
1. Log into the Payment Page Template Builder
2. Select ‘Template Information’ under the Payment Page component ‘Templates’
3. Tick the ‘Create a New Template’ box and the ‘New Template Details’ section will appear on the screen
Please note: Multiple templates can be created and stored, allowing for a merchant to have a
merchant system with multiple accounts (different Merchant IDs) and assign a different
template to each.
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 22
4. Under the ‘New Template Details’ the user can chose to select an existing template or the default. The available templates include the Default Standard Template and the Default Accessible Template.
5. After selecting a template, enter either text or numbers in the Template Description white box as a reference to the template.
6. Enter suitable text into the ‘Confirm Cancel Message’ box. This message displayed to the customer to request confirmation before cancelling a transaction. This field is optional and can be left blank but it would be useful to include a Confirm Cancel Message as a warning to the customer.
7. When the mandatory fields have been completed, click ‘Create’ in the bottom corner of the
screen. The template will be created and displayed on the screen. If more than one template is created, the user will have the option to delete one.
Please note: The Default Accessible Template has been designed to be more accessible for
screen readers. As a result, the content and CSS is better suited to these applications. The
screen focus will start at the top of the page rather than on the ‘Proceed’ button at the bottom,
enabling the user to scroll or tab down through each control in a logical order.
If this template is selected, any validation error messages will be list at the top of the page.
Please note: The ‘Hide card details’ box enables the user to alter which card details fields
appear on the payment page template. If selected, only the PAN field box will appear initially.
Once this box has been populated, additional fields will appear. Depending on the card type,
these will include the issue number, CSC/CV2, card start date and card expiry date.
Please note: The ‘Template Language’ field will be populated with ‘English’. This cannot be altered at present.
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 23
Making and Reviewing Changes
Before editing the various template features, it is important that users fully understand the ‘Restore
Defaults’, ‘Preview’, ‘Discard Changes’ and ‘Save Changes’ options displayed at the bottom of
each template page editing section.
Restore Defaults
This option can be used to restore all elements on the current template editing page (e.g. all fields
from ‘Template Content’ if currently in use) back to the original default template values (either
standard or accessible, depending on which was selected originally).
Preview
After editing the template, it is recommended that the user previews any changes before setting
them to live (using the ‘Save Changes’ button). This can be achieved using the ‘Preview’ button,
and will display an updated sample version of the template page with the new changes. Depending
on browser configuration, the page will be opened within either a new tab or new browser window.
Discard Changes
This option provides the user with the ability to erase all changes which have been made to the
selected page within the current editing session but not saved.
Save Changes
The ‘Save Changes’ option enables the user to save and permanently apply changes that have
been made to the template during editing.
Once changes have been made and previewed, pressing ‘Save Changes’ will upload the changes
to the live template.
Please note: Any changes which are made, saved using the ‘Upload & Save’ option during
editing, but not committed to the template using the ‘Save Changes’ functionality will be lost
once the user logs out or the session times out.
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 24
Change Application Timescales
After saving changes, these will be reflected within the current environment (i.e. test or live) when
the overnight replication tasks are completed on the Payment Page servers. No changes will
appear on the templates prior to this process being completed.
Should the user need to make any additional changes prior to replication being complete, then the
updated changes will be applied during the next replication.
Please note: The same applies for the Integration Keys and Payment Page Accounts, which
are also updated as part of the overnight replication process.
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 25
Template Pages
After creating a template, several different pages will be available for selection. Each page caters
for a different stage of various transaction types supported by Payment Page.
The table below describes what each of the pages is used for:
Page Purpose
OrderConfirmation Contains summary of order details and initiates the payment process (Optional page)
PaymentPage Prompts for payment, including card details
PaymentResult Displays result of EFT transaction
PayerAuth Card Schemes 3D Secure
PaymentPage3 Secondary page of EFT transaction process (Non JavaScript only)
PayPalResponse Confirm PayPal transaction
PayPalResult Displays result of transaction using PayPal
RegisterToken Card details entry screen for token transaction
RegisterToken3 Secondary page of register token process (Non JavaScript only)
RegisterTokenResult Displays result of register token process
EPaymentResult [Reserved for future reference]
SVSPaymentPage Payment page when utilising an SVS card
SVSPaymentResult SVS Payment result page, informing the cardholder if the transaction was successful or not
SVSBalanceResult Balance result, only displayed in the scenario whereby there are insufficient funds or there is a problem processing the payment
TokenPayment Enables token details to be updated during payment
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 26
Template Elements
Each template consists of five elements which can be amended within the Payment Page
Template Builder for each page:
Template Content Allows for amendment of the content of the page, i.e. the text displayed for the customer in each of the pre-defined elements within the template; such as the page instructions
Template Images Enables editing of each of the pre-defined images displayed on each of the pages, e.g. Proceed Button Image
Template CSS The cascading style sheet for each page can be customised, e.g. changing the margin width of the page layout, the background colour of the grid
Template Information Provides the ability to change the description and confirm cancel message assigned during template creation originally
Template Titles Allows users to edit the title of each template page (listed in the table above).
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 27
Template Content
The template content section allows for amendments to be made to each of the pre-defined text
elements assigned to the template.
Changing Page Content
In order to make changes to an existing template:
1. Click the ‘Template Content’ link
2. Choose a template and page combination and press ‘Select’
3. All page content associated with the template and page combination selected will be displayed on screen. On the right of the table; there is an option to enable or disable certain contents of the page as illustrated in the image below:
4. To familiarise the user with the location of each content item on the page, it is recommended that ‘Preview’ is used to display the page with the existing settings before amendments are made.
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 28
This screenshot shows where each page content item is located on the default template:
The below table describes each of the numbered elements (in red) on the image above:
Page Content Number Page Content Item Default Content
1 Page Main Heading Order Confirmation
2 Page Instructions Header My Basket
3 Page Instructions Please find below the contents...
4 Grid Description Text Description
5 Grid Quantity Text Quantity
6 Grid Item Price Text Item Price
7 Grid Total Text Total
8 Grid Shipping Text Shipping
9 Grid VAT Text VAT
10 Total Text Total
11 Secure Payment Header A Secure Payment Zone
12 Secure Payment Information This checkout is secure and...
5. Make changes to the content item required within the ‘Template Content’ screen and click
preview to view the changes prior to saving
6. Once satisfied with the changes put in place, click ‘Save Changes’ to save
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 29
Payment Pages
The ‘PaymentPage’ will display the customer’s details and delivery address details generated
automatically from their merchant system. This page allows merchants to edit the following fields
on this page:
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 30
The below table describes each of the numbered elements (in red) on the image above:
Page Content Number Page Content Item Default Content
1 Page Main Heading Payment Page
2 Page Main Heading in Case of Error Errors with Payment Page
3 Page Instructions Header Enter your details
4 Payment Instructions Your Details and Delivery Address..
5 Mandatory Field Instructions Please complete all fields marked with an *
6 Payment Information Please enter your payment details below
7 Card Details Fieldset Header Cardholder Details
8 Secure Payment Information This checkout is secure and...
9 Secure Payment Header A Secure Payment Zone
Another optional item is the Token Details Fieldset Header item which will display as shown below:
Please note: The Token Details Fieldset Header item is only available for configuration if
tokens are enabled on the merchant’s account.
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 31
The PaymentPage3 is used to display information such as further card details, i.e. ‘CSC’ etc:
In this section the merchant is able to edit the following fields:
Page Content Number Page Content Item Default Content
1 Page Main Heading Payment Page
2 Page Main Heading in Case of Error Errors with Payment Page
3 Page Instructions Header Your Payment Details
4 Page Instructions Please enter your card details below:
5 Mandatory Field Instructions Please complete all fields marked with an *.
6 Payment Details Fieldset Header Payment Details
7 Secure Payment Header A Secure Payment Zone
8 Secure Payment Information This checkout is secure…
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 32
Result Pages The ‘Result’ pages are used to confirm the outcome of the transaction to the user. The merchant is able to edit the response message displayed on the page for the resulted outcomes; ‘Success’, ‘Failed’ and ‘Error’. The page will be displayed with the respective response message relevant to the transaction
result. To preview all the individual message types; please select from the options available at the
bottom of the page and select ‘Preview’.
The below image illustrates the screen when previewing a successful transaction:
Please note: The ‘Show Content’ tool is pre-configured to ensure message response fields
are always displayed as they are mandatory.
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 33
The below table describes each of the numbered elements (in red) on the image above:
Page Content Number
Page Content Item Default Content
1 Payment Result Payment Result
2 Back Button Message Text Do NOT hit the back…
3 Success, Failed or Error Response Message
This area will display with the relevant message response; ‘Success’, ‘Failed’ or ‘Error’
4 Secure Payment Header A Secure Payment Zone
5 Secure Payment Information This checkout is secure and...
PayerAuth
The Payer Authentication page displays the automated 3DSecure page regulated by VBV (Verified
by Visa) and MSC (MasterCard) SecureCode to help prevent online fraud and chargebacks. The
merchant is only able to edit the footer of the page containing the secure payment text as shown
below:
The below image illustrates the changes when previewed:
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 34
Template Images
The Template Images section allows users to view and change the images displayed within each
of the pages of Payment Page. Each image is listed as an item, and can be updated to customise
the appearance of Payment Page.
Changing Page Images
To make changes to the images within an existing template, please follow the below instructions:
1. Click the ‘Template Images’ component
2. Choose a template and page combination and press ‘Select’
3. All images associated with the template and page combination selected will be displayed on screen:
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 35
4. To make changes to an image, click the green crayon ‘Edit’ icon
5. An ‘Edit Image’ dialog box will appear as shown below
6. Amend the Alternative Text (alternative/substitute text displayed if the image cannot be rendered) to describe the image
7. Use ‘Browse’ to locate the image (please note that only images of 100kb or under in size and with a file extension of either ‘.jpeg’, ‘.png’, or ‘.gif’ can be used) The error message displayed below will appear if the image is larger than 100kb.
8. Click ‘Upload & Save’ to store the changes. A message will be displayed on screen confirming the image was successfully uploaded (see image below), before displaying the changes within the ‘Preview Alt Text’ and ‘Preview Image’ columns.
9. Use the ‘Preview’ button to view the changes prior to promoting them to live. Note: it is recommended that changes are reviewed to ensure the image is fit for purpose
10. Click the ‘Save Changes’ button to saves the changes to the template
Once promoted to live, the changes previously shown within the preview columns now form part of
the default template settings.
Please note: Using the ‘Restore Defaults’ option after promoting changes to live will reverse
changes to the original default template settings (for Template Images only).
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 36
Template CSS
The ‘Template CSS’ section allows customisation of the design of the template by directly editing
the CSS. For more information on CSS (Cascading Style Sheets), please see the following link:
http://www.w3schools.com/css/css_intro.asp
Basic CSS vs. Advanced CSS
The ability to amend both the Basic CSS and Advanced CSS is provided via the radio button below
the ‘Select a Template’ option:
The Basic CSS section contains the basic elements of each template page, such as:
Page margins
Background colour, width and style
Font face, style, size and colour
Labels
Header
Footer
Main page layout options
The Advanced CSS section provides further options such as:
Image widths
Image heights
Container elements
Container margins
Text alignment
Position
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 37
Controls
There are various different options available:
Text field and drop down box
Enter the amount within the text field and select the unit from the associated drop down list, e.g. as
below with the width field:
The user will be presented with a range of controls consisting of various units of measurements
that are available for editing, i.e. “EM”, “Percentage” or “Pixels”. Modifications made using these
settings can be previewed by selecting the “Preview” button.
Multiple Text fields
Often used for specifying margins and padding settings; the order follows that of the standard CSS
approach of Top, Right, Bottom, Left – as shown below:
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 38
Colour Pickers
Whenever a colour choice is available, a colour picker will be displayed as shown in the example
screenshot below (circled in red):
After clicking on the arrow, the user will be provided with several options for selecting the required
colour. These include the Web Palette, RGB Sliders, HSB and HSV:
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 39
If the colour code required is known then this can be entered, otherwise the four tabs provide
various means of creating it. Once the desired colour has been created, click ‘Apply’ to select that
colour.
Alternatively, if the user does not want a colour for that section of the page, the ‘No Colour’ icon
can be selected.
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 40
Changing CSS Values
Changing CSS values is possible using the controls described previously. The Basic and
Advanced CSS sections are designed to ensure that it is possible to switch between these two
modes without losing changes. For example, by styling an element such as a label and then
switching to Advanced CSS to style the container element.
For step-by-step guidance on how to make changes to the cascading style sheet of an existing
template, please follow the below instructions:
1. Click the ‘Template CSS’ link
2. Choose a template and page combination and press ‘Select’
3. A list of all the available elements for the template page selected will be displayed
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 41
4. To make a change to the CSS, expand the required element to expose the settings available:
5. After any changes have been made, it is recommended that the page is previewed before using ‘Save Changes’ to save any changes permanently.
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 42
‘Not Set’
In order to not set a value for a specific property then the following options are available:
Drop down box – select ‘Not Set’ option
Colour Picker – select the ‘No Colour’ option, this is available in all of the tabs within the control
Text field and Drop down box – leave the text field blank and select the ‘Not Set’ option from the drop down box
Text fields and multiple text fields – leave blank
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 43
Template Information
The Template Information page is the central location for creating new templates, and viewing and
editing existing template details. This page can be accessed via the “Template Information”
component within the “Templates” link on the main Template Builder page.
Merchant Template ID
Within the Payment Page V2 Integration Manual the elements which form part of the Payment
Page messaging exchanged between merchant web server and Payment Page web server is
detailed. One of these elements is ‘merchanttemplateid’, which provides the ability to override the
template configured within the Payment Page Template Builder for the account (see Payment
Page Account section for more information). The ‘Template ID’ shows the value(s) which should be
populated within this field should the ability to override the template setting be required.
Creating a New Template
This section provides the ability to create a new template based on one of the default templates or
one of your existing templates. The default template is selected by the Payment Page Account
when initially configured.
For full details on creating a template, see the previous ‘Creating a New Template’ section under
Template Migration.
Editing Template Information
Should the need arise to edit the information provided when the template was first created, the
template information can be amended using the ‘Edit’ button associated with the template record.
1. Click the ‘Edit’ button
2. Amend the ‘Template Description’ and/or ‘Confirm Cancel Message’ text as required
3. Click ‘Update’ to save the amendment(s)
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 44
Deleting Templates
Templates can be deleted if they are no longer required; however, if the template is associated
with a Payment Page Account then any Payment Page Accounts utilising the template will be
updated to use the primary template ID. This is to ensure that the template is not deleted whilst still
in use by an account.
To delete a template follow the steps below:
1. Press the ‘Delete’ recycle bin icon in the column on the right hand side of the screen
2. A Confirm prompt box will appear (as displayed below)
3. Press ‘OK’ to continue or ‘Cancel’ to return to the Template Information screen
4. Afterwards the message box below will appear to confirm the template has been deleted.
If there is only one template available then it will not be possible to delete the template if it is linked
to a Payment Page Account.
In order to disassociate a template with a Payment Page Account, navigate to the ‘Payment Page
Account’ section of the Template Builder, edit the account which utilises the template and changed
the “Default Template ID” field to a different template.
Alternatively, delete the Payment Page Account completely and recreate; however, ensure that all
the required settings have been recorded before deletion.
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 45
Exporting Templates
Payment Page Template Builder provides the ability to export templates from the test environment in order to be imported to the live environment.
1. To export a specific template, go to the Template Information page and select the ‘Export Template’ disc icon displayed in the screenshot above
2. The message below will appear. To go back to the previous screen select ‘Cancel’ or to continue, select ‘Ok’
3. At the next stage, the merchant is able to either ‘Open’ or ‘Save’ the template. Select the
required option to proceed.
4. The template will be exported as a .zip file containing both .ppgt and .css files.
Template Import
The Template Import section enables newly created templates to be imported into the live environment.
1. Select ‘Template Import’ under the Templates section
2. When the Template Import page has opened, select ‘Browse’ to locate the required
template .zip file
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 46
3. A green circle indicator will appear next to the name of the file when it is ready to be
uploaded.
4. If the template file has been manipulated or the file is not a recognised template in a .zip
file, Template Builder will be unable to import it and display the message below:
5. If the template is the correct .zip file format and is imported successfully, Template Builder
will display the confirmation message displayed below:
6. The imported template will appear under the ‘Your Templates’ list of templates which can
be found within the Template Information section
Please note: The template ID will differ between the customer test and live environment
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 47
Template Emails
The Template Emails section provides merchants with the ability to customise specific sections of
an email confirmation. The merchant is able to edit the text in the available sections for both
merchant and customer email confirmations within each template and preview the format of the
email. Available options include templates for a successful EFT transaction, an SVS transaction
and a token registration.
The emails are set out in a predefined format, each consisting of the following sections:
Email Subject
Email Header
Email Content 1
Email Body
Email Content 2
Email Footer
To make changes to the email templates within an existing template, please follow the below
instructions:
1. Click the ‘Template Emails’ link
2. Choose a template and an email template and click on ‘Select’
Please note: The user is only able to edit the text for the available sections. Text containing
transaction details is not editable.
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 48
3. The content page will be displayed, listing the items on the left with the editable text boxes next to each item. Each item will be populated with the default text, as illustrated below. The ‘Email Subject’ and ‘Email Header’ fields usually populate with the result of the transaction:
4. To edit the text of an item, simply click in the text box under ‘Value’. To preview the changes, select ‘Preview’ on the bottom right of the page (illustrated below):
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 49
The below table describes each of the numbered elements (in red) on the image above:
Page Content Number Page Content Item Description
1 Email Subject “(Type of transaction)” successful
2 Email Header “(Type of transaction)” successful
3 Email Content 1 Merchant (The registration have been successfully..) Customer (Please keep this as receipt…)
4 Email Body Left blank
5 Email Content 2 Merchant (Registration/Transaction details), Customer (Thank you…)
6 Email Footer This email is confirmation… (includes merchant contact details)
5. Once satisfied with the changes put in place, click ‘Save Changes’. A confirmation
message (pictured below) will appear. Select ‘Ok’ to continue
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 50
Template Titles
The Template Titles section allows users to change the default page titles for any chosen template.
This functionality enables merchants to customise the template to meet their specific requirements.
To edit the Template Page Titles, please follow the instructions below:
1. Select ‘Template Titles’ -> ‘Templates’
2. Find the required Template using the drop down box and click ‘Select’
3. Once selected, the user is able to amend the template page titles by changing the default text in
the text boxes.
4. To save the changes made to the template page titles, select the ‘Save Changes’ and a
message will appear to confirm the changes have been saved successfully
5. To delete the changes and restore the default template page titles select ‘Restore Defaults’ in
the bottom left hand corner of the screen
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 51
6. The message box below will appear. To confirm restoring the default titles select ‘OK’
7. If the action is successful, a message box will appear to confirm that the title changes have
been reverted to default. Select ‘Ok’ to continue
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 52
Integration Keys
256-bit AES encryption is in place with Payment Page, ensuring that the post data which is sent
from the merchant web server cannot be edited prior to onward transmission to the Payment Page
web server.
To allow VeriFone to decrypt the post data once it reaches the Payment Page web server, the
Template Builder requires the merchant to upload their encryption keys. VeriFone then stores
these keys, and uses a field within the Payment Page message (‘keyname’) which tells the web
server which encryption key was utilised.
The integration keys page can be opened by selecting the option ‘Integration Keys’ in the Template
Builder toolbar. This option allows the users to create, edit and disable keys.
Due to the nature of this secure functionality, extra authentication will be required when performing
any task after an initial key has been created. Therefore upon the addition, manipulation or
deletion/disabling of a new or existing key, the first keys data will need to be supplied in the same
Base64 format originally provided.
Please note: A maximum of three merchant keys are permitted, and must be 32bytes in
length and ‘Base64’ encoded. These keys can be changed at any time. It is recommended
that more than one key is configured to provide the ability to switch to a secondary key should
the primary key be compromised.
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 53
Creating a key
1. To create a new merchant key, click ‘Add New Merchant Key’
2. If a key has already been created previously, the Template Builder will request validation by asking for confirmation of the first key created:
3. Enter both the key name and base64 encoded version of the key and click ‘Validate’ to continue
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 54
4. After validation has been performed (if it was necessary), the ‘Add Key’ screen will be displayed:
5. Add a key name of no more than 8 characters and the Base64 encoded key which must be 256 bits or 32 bytes in length. Please note that the key name must be unique, therefore even if a previous key is disabled, it is not possible to create an additional key with the same name This key name will need to be provided via integration when processing a transaction, to enable VeriFone to decrypt the data once it reaches the Payment Page web server.
Please note: Any attempts to add a new key utilising the same key name as any previously
disabled keys will fail, as the key name must be unique.
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 55
Editing a key
To edit an existing key:
1. Click ‘Change Key’ within the key record required
2. Validate the first key which was created by entering the key name and key value into the fields provided
3. Click ‘Validate’ to continue
4. The existing key name and key value will be displayed (“[Key Removed]” is displayed above for documentation purposes), giving the operator the chance to make changes to either value
5. After making the required changes, use ‘Update Key’ to revise the key details Once changes have been made to the Integration Keys, Payment Page will use the updated details once replication of the changes has been applied to the Payment Page Servers. Once this replication has been completed at around midnight, Payment Page will utilise the updated key when it attempts to decrypt the data it receives. Therefore, it is vital that changes made to these keys are reflected with the merchant system when encrypting the data leaving the merchant web server. VeriFone would recommend using one of the other two keys available whilst the replication process is being carried out for key updates. This allows the merchant to ensure that the changes have been applied before encrypting using the updated version of the key.
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 56
Disabling a key
Should the need arise to disable a key, follow the below steps:
1. Use the ‘Disable Key’ button to deactivate the desired key
2. Validate the first key when requested, by entering the key name and value of the first key provided
3. Click ‘Validate’
4. The key will be disabled, resulting in its permanent removal from the system It is recommended that after disabling an existing key that the merchant makes use of a secondary
key previously configured on the system, and immediately switches to encrypting using this key.
Please note: Once a key has been disabled, Payment Page will no longer be able to
utilise the key to decrypt data received from the merchant. This change will need to be
reflected within the integration by utilising a different key for encryption.
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 57
Restrictions
The restrictions section has been implemented to provide the ability to cater for the requirement of
additional users, and to provide a level of control over their access rights.
Add a Restricted User Group
To add a new user group:
1. Select ‘Restrictions’ -> ‘User Groups’
2. Click ‘Add New User Group’ from the top left of the section
3. The above screen will be presented. Enter a User Group Description, and click ‘Create’
4. The User Group will be created and displayed on screen
Please note: User accounts cannot be created until a user group has been made available.
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 58
5. Press the ‘Edit’ icon to configure the permissions of the group
6. From the list of available ‘System Accounts’, select the account(s) which should be made available to users and use the ‘>>’ button to move the accounts to the ‘UserGroup Accounts’ section of the screen
7. If no User Accounts have been created at this stage, then the ‘System Users’ box will be empty. As users are created and linked to User Groups their permissions will be propagated
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 59
Add a Restricted User Account
To add a new user account:
1. Select ‘Restrictions’ -> ‘User Accounts’
2. Click ‘Add New User’ from the top left of the section
3. Enter the email address and password for the user, before selecting which User Group to
assign the user to with the drop down box at the bottom. Please note ‘New Password’ and ‘Confirm New Password’ fields should be identical.
4. Click ‘Create’ to save the restricted user
Please note: If there are no user groups then user creation is not possible
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 60
Edit a Restricted User Account
In order to make changes to an existing restricted user:
1. Select ‘Restrictions’ -> ‘User Accounts’
2. Click ‘Edit’ on the user which is to be amended
3. Change the details as required
4. Click ‘Update’ to save the changes.
Please note: If no password change is required then all password fields can be left blank.
Payment Page Template Builder Manual – V2.0 – 4th
September 2014 61
Edit a Restricted User Group
User Groups can be updated to remove access to accounts previously enabled, or to remove the
access rights of a restricted user. Follow the below instructions to make changes:
1. Select ‘Restrictions’ -> ‘User Groups’
2. Use the ‘Edit’ button the amend the required User Group
3. The current settings of the User Group will be displayed. Select between System Accounts or System Users and move them as required using the arrow keys (“>>” / “<<”)
4. To amend the User Group Description, change the text field at the top of the screen
5. Click ‘Update’ to save the change.
© 2014 VeriFone. All rights reserved. VeriFone, the VeriFone logo, VX are either
trademarks or registered trademarks of VeriFone. No part of the contents of this document
may be reproduced or transmitted in any form without the written permission of VeriFone.
All content information is subject to change without notice.
Contact Details
VeriFone Services UK & Ireland 100 Eureka Park
Ashford Kent
TN25 4AZ
PAYware Ocius Merchant Helpdesk
Ocius.helpdesk@verifone.com
08444 828 222
VeriFone Technical Services
Ocius.techservices@verifone.com
08444 828 273
Sales Enquiries
Ocius.enquiries@verifone.com
08444 828 200
Customer Services
08444 828 223
Website: www.verifone.co.uk