• 1 Intended Audience
• 2 Introduction
• 3 Appearance
• 4 Configuration
• 4.1 Payment Page: General Settings
• 4.2 Payment Page: Payment Types Settings
• 4.3 Payment Page: Pay Now/Donate Now Settings
• 4.4 Payment Page: Receipt Page Settings
• 4.5 Payment Page: Receipt Emails Settings
• 4.6 Payment Page: Recurring Settings
• 4.7 Payment Page: Customize Form Settings
• 4.8 Payment Page: Appearance Settings
• 4.9 Payment Page: Security Settings
• 4.10 Payment Page: Hash Calculator
• 5 Character Encoding
• 6 Payment Form Fields
• 6.1 Essential Fields
• 6.2 Transaction and Display Fields
• 6.3 Order and Customer Detail Fields
• 6.4 Soft Descriptor Fields
• 6.5 Unsupported Fields and Unsupported SIM Emulation Functionalities
• 6.6 Dynamic Currency Conversion (DCC)
• 6.7 Dynamic Pricing (DP)
• 6.8 Fees
• 6.9 Visa Checkout
• 6.10 Special Payment
• 6.11 Google Analytics
• 7 Relay Response
• 8 Silent Post
• 9 Transaction Result Fields
• 9.1 Basic Relay Response and Silent Post Fields
• 9.2 Basic Relay Response and Silent Post Fields (Credit Card Only)
• 9.3 Payeezy Gateway Additional Fields
• 9.4 Payeezy Gateway API Response Fields
• 9.5 Payeezy Gateway API Response Fields (Credit Card Only)
• 9.6 Response Reason Codes and Text
• 9.7 Common Bank Response Codes
• 9.8 Address Verification Result Codes
• 9.9 CVV2 Verification Indicator Codes
• 9.10 CVV2 Result Codes
• 10 Example Payment Forms
• 10.1 Basic Example
• 10.2 Example Including Relay Response
• 10.3 Resulting Payment Form
• 10.4 Example with Order Details
• 11 Implementation and Testing Guide
• 11.1 Generation of the Checkout Form
• 11.1.1 Calculating the x_fp_hash value
• 11.1.2 Testing the x_fp_hash calculation
• 11.1.3 Tying the Payment to a Particular Order
• 11.2 Relay Response Implementation
• 11.2.1 Generated HTML
• 11.2.2 Customer Cookies
• 11.2.3 Relay Response Signature
• 11.2.4 Sample Relay Response POST
• 11.2.5 Relay Response Sample Code

1 Intended Audience

This document is intended for

• Merchants who want to understand the payment processing features of the First Data Payeezy Gateway Payment Pages service.
• Web developers who integrate a merchant's website with Payment Pages for payment processing.

This document covers the configuration of the merchant's account at Payeezy Gateway, the payment request parameters that should be sent by the merchant and how they are processed, and includes request examples.

2 Introduction

A Payeezy Gateway Payment Page is a securely hosted web payment form designed to accept Internet-based E-commerce transactions.

With Payment Pages in place a merchant is no longer exposed to the sensitive payment details required to process a payment, because Payment Page redirects the customer from merchant website to a payment form hosted by Payeezy Gateway. Such solution minimizes PCI scope for the merchant and hence only requires completion of the PCI DSS SAQ-A (Self-Assessment Questionnaire A and Attestation of Compliance). Additionally, by using Payment Pages the merchant has access to an expanding toolkit of payment options and other features without the need for additional code development. If for some reason the visual redirect to another website does not fit well with the merchant checkout flow, there is an option to use an iFrame functionality that allows to run the Payeezy Gateway Payment Page within the merchant user interface. 

Payeezy Gateway Payment Pages redirect the customer from merchant website to a payment form hosted by Payeezy Gateway. To accomplish this the merchant displays a "Checkout" button within an HTML form on their website that will submit a POST request to the following URL:
https://checkout.globalgatewaye4.firstdata.com/payment

Please note that Demo accounts should submit transactions to this URL: https://demo.globalgatewaye4.firstdata.com/payment

Within the parameters of this HTML form the merchant specifies the location of the Payeezy Gateway Payment Page along with payment details and authentication information. These are usually implemented as hidden input in the HTML form.

At the end of the payment process all parameters that define the status of the transaction can be returned to the merchant in real-time.

The appearance and payment options displayed on the payment form are configured through an online management interface available to all Payeezy Gateway merchants.

3 Appearance

The merchant can customize the appearance of their Payeezy Gateway Payment Page as follows:

1. All pages can be styled to match the merchant's website design by configuring a color scheme and specifying the logo to be displayed.
2. The merchant’s server can be set to render entirely the last page (customer receipt display) through Relay Response - see Section 7 for more information on this topic.

4 Configuration

The Payeezy Gateway Payment Pages configuration determines how each payment is processed. This configuration covers payment processing presentation and functionality such as Relay Response and email notification.

The redirect to Payeezy Gateway Payment Pages's payment form requires the configuration of at least one Payeezy Gateway Payment Page, each identified by a unique "Payment Page ID". This ID is passed in as the x_login parameter when the merchant redirects to the Payment Page to process a transaction. See Section 6.1, "Essential Fields", for more information.

Payeezy Gateway Payment Pages are administered through the "Payment Pages" tab in the Payeezy Gateway Real-time Payment Manager (RPM), accessible only to administrators.

Merchants can add as many Payeezy Gateway Payment Pages as required. This allows the support of:

• Multiple shopping carts
• Multiple languages
• Various processing options
• A dedicated demo Payeezy Gateway Payment Page

To add a new Payeezy Gateway Payment Page, click the “Create a New Payment Page” link.

To change an existing Payeezy Gateway Payment Page, click on its Payment Page ID.

Additionally, existing Payeezy Gateway Payment Pages can be previewed or deleted on this tab.

4.1 Payment Page: General Settings

The General section contains settings that are mandatory to First Data Payeezy Gateway Payment Page setup. The remaining sections determine things such as appearance, information and receipt handling, etc. but do not need to be filled in immediately for the Payeezy Gateway Payment Page to be created.

Settings:

1. Payment Page Title: this is the label used for the individual payment page.
2. "Return to Your Site" URL: after the transaction is completed, the user can be redirected or offered a link to the URL specified here.
3. Maximum Number of Payment Attempts: this is a security measure aimed at stopping malicious activity. Customers will have this number of tries (1, 2, or 3) to complete their transaction after which they will be blocked for a period of time.
4. Notification Email: the email address specified in this field will receive copies of the payment confirmation emails sent to each customer (if this feature is enabled) as well as alert messages indicating errors returned from the payment page.

Hit "Next" to proceed to the next step, "Save Changes" to return at a later time or "Cancel" if editing an existing page.

4.2 Payment Page: Payment Types Settings

4.3 Payment Page: Pay Now/Donate Now Settings

The "Pay Now"/"Donate Now" page allows merchants to create customizable one-click checkout buttons that can be embedded on web pages, allowing customers to make a payment quickly and easily.

Notes on the use of this feature:
- For additional recommendations, see Fraud Best Practices.
- This form only generates the code required to create buttons and does not allow these settings to be saved
- After making changes to the button settings, the "Refresh" button should be clicked to regenerate the code and appearance preview
- The code generated to create the button is presented in the "Button HTML" area; it is this code that should be copied and added to a web page to show the button
- If it is necessary to only allow a set of specific dollar amounts for payment (eg. $5, $10, $20), a merchant can create multiple buttons and present the appropriate one to the user after the selection has been made by the customer


Amount: By entering an amount here, the generated button will direct to a payment page that specifies this dollar amount and customers will not be given the option to change it. If this box is left empty, customers will instead be presented with the option to input a dollar amount of their choice.

Donation Prompt: In the case where a customer is prompted for a donation, the text entered here will be presented to the customer before they proceed.

Use Relay Response: Enabling this option turns on Relay Response for this button. See this page for more information.

Tracking ID: The text entered here will appear in the transaction details screen in the User ID field in RPM in order to identify the button that was used.

Display Text: The text entered here will be displayed for the button.

Button Width: The number entered here controls the width of the button.

Style: The options here allow the presentment of a normal rectangle shape, or one with rounded edges.

Background Color: The color value entered here will be used in the main body of the button. A color picker tool is available by clicking on the color block itself.

Border Color: The color value entered here will be used for the border of the button. A color picker tool is available by clicking on the color block itself.

Font Color: The color value entered here will be used for the text color of the button. A color picker tool is available by clicking on the color block itself.

Font Size: The size of the button's text can be adjusted here by entering a number measured in pixels.

Font Family/Weight/Style: Font names can be manually entered in this box, and a customer's computer will use them if the font is present on their computer. Fonts can also be selected from a pre-defined list of commonly available fonts. The text can also be given bold weight or be italicized.

Soft Descriptor Settings: The settings here control what soft descriptors will be used by the button. Available options are DBA Name, Merchant Contact Info, Street, City, Region, Postal Code, Country, MID, and MCC Override. For more comprehensive information about soft descriptor usage, please see this page.

4.4 Payment Page: Receipt Page Settings

These settings determine the transaction receipting options. For more information on Relay Response, Silent Post, and Receipt Link click here.

Receipt Page Settings

1. Select a Return Link Method:
   • AUTO POST
   • POST
   • AUTO GET
   • GET
   • LINK
   • REDI
2. Receipt Link text. This is the hyper-linked text that will display to the customer as the link to return them to the merchant's site. For example, "Return to Mystore".
3. Receipt Link URL. This is the URL the customer will click to return to the merchant's website.
4. Reference Number Title. If you are using the x_invoice_num value this setting will determine how it is labeled on the First Data Payeezy Gateway Payment Page. For example, "Invoice Number", or "Order ID", etc.
5. Customer Reference Title. See Reference Number Title above.

Relay Response Settings

1. Allow Relay Response. Check this box if Relay Response is the receipting method chosen.
2. Relay Response URL. If Relay Response is allowed, this is URL that Payeezy Gateway Payment Pages will relay transaction results to AND receive HTML back from.
3. Allow HTTP Redirect to the Merchant Website. When this option is selected, any HTTP redirect requests Payeezy Gateway Payment Pages receives in the relay response back from the merchant will pass the customer back to the merchant's website - instead of displaying the receipt page on the Payeezy Gateway Payment Pages domain.
4. Validate Relay Response HTML. This option will allow Payeezy Gateway Payment Pages to validate the HTML the merchant's servers relay back for the receipt page.

Silent Post Settings

1. Silent Post URL. If Silent Post is desired, this is URL that Payment Pages will relay transaction results to. Payeezy Gateway Payment Pages will not "listen" for a response back from this URL.

Hit "Next" to proceed to the next step, "Previous" to return to the preceding screen, "Save Changes" to return at a later time or "Cancel" if editing an existing page.

4.5 Payment Page: Receipt Email Settings

Email Enabled: check this box to send payment confirmation email to customers so they will automatically receive a receipt of their transaction.

"From:" Email: customers receiving payment confirmation emails will get them from this email address.

Receipt Email Header/Footer: use these fields to customize the payment confirmation email. For example, a header may look like: "This is an official receipt" and a footer: "Thank you for your business".

The Header/Footer can be a maximum of 255 characters long and contain plain text.

Hit "Next" to proceed to the next step, "Previous" to return to the preceding screen, "Save Changes" to return at a later time or "Cancel" if editing an existing page.

4.6 Payment Page: Recurring Settings

The Recurring section presents settings for configuring Recurring payments with a First Data Payeezy Gateway Payment Page. Recurring functionality for a Payeezy Gateway Payment Page can be enabled or disabled here, and the customer agreement text presented to customers can be set. The agreement text can be formatted using Markdown.

4.7 Payment Page: Customize Form Settings

4.8 Payment Page: Appearance Settings

4.9 Payment Page: Security Settings

In this section, the encryption keys for First Data Payeezy Gateway Payment Pages are generated. Note that if the Payeezy Gateway Payment Page is currently in use in either Demo or Production modes, generating new keys will break the existing page links.

Do not regenerate the merchant key unless absolutely certain.

HMAC Calculation

Two types of encryption are offered: HMAC-SHA-1 and HMAC-MD5. New Payment Pages instances will use HMAC-SHA-1. 

HMAC-MD5 option is only advised for legacy solutions.

Transaction Key

This key is one of the values used to calculate the value, "x_fp_hash". This x_fp_hash validates that the merchant’s server generated the redirect parameters correctly and serves as verification to Payeezy Gateway Payment Pages that the form was generated by the merchant's server, and not by the customer or a third party.

1. Press the "Generate New Transaction Key" button to produce a new value.

Response Key

This value is specific to the Relay Response method and is one of the values used to calculate the value, "x_SHA1_Hash" ("x_MD5_Hash" if MD5 was selected in Payment Page Settings). This "x_SHA1_Hash" is how the Payment Pages system cryptographically signs transaction results returned to the merchant's server. Merchants can calculate and use the x_SHA1_Hash to verify that these results are being returned from Payment Pages and not an unknown third party.

1. Press the "Generate New Response Key" button to produce a new value.

Hit "Next" to proceed to the next step, "Previous" to return to the preceding screen, "Save Changes" to return at a later time or "Cancel" if editing an existing page.

Prevent Payment Page from loading in other websites

When "Prevent Clickjacking" is checked, iFrame Busting is enabled. The feature prevents the Payment Page from loading inside of an iFrame, preventing it form being used on other sites. Please keep in mind that only one of "3DS" or "Prevent Clickjacking" can be enabled at a time.
Note: Clickjacking is enabled by default; if you plan to use an iFrame, please uncheck the option. Not all browsers respond in the same way when the “Prevent Clickjacking” option is active. Some browsers display a blank page, while others do not.

4.10 Payment Page: Hash Calculator

This section contains the hash calculation tool which can be used by developers to compare their figuring of the x_fp_hash value with First Data Payeezy Gateway Payment Pages' derivation.

Note that the values, "x_login", and "Transaction Key" are automatically pre-populated.

1. Enter the following values:

"x_fp_sequence"

"x_fp_timestamp"

"x_amount"

"x_currency_code" (optional)

2. Press the "Generate Hash" button.

The result will appear in the text box beside "Hash (x_fp_hash)".

Compare this result value with that calculated by the merchant's Payment Pages code.

Hit "Previous" to return to the preceding screen.

5 Character Encoding

Incoming parameters should be encoded in UTF-8, except where noted as ASCII, to ensure correct text display and processing.

6 Payment Form Fields

The merchant interfaces with Payeezy Gateway Payment Pages by displaying an HTML form on a website page that submits a POST request to Payment Pages at https://checkout.globalgatewaye4.firstdata.com/payment. Hidden form fields specify the particulars about the payment. The fields supported by Payeezy Gateway Payment Pages are described in this section. When using a demo account, a POST request should be sent to https://demo.globalgatewaye4.firstdata.com/payment.

6.1 Essential Fields

The following parameters are required, and validated with each request. If one is missing or the validation fails the customer will see an error page. The merchant will also receive an email explaining the problem.

Notes:

• The x_fp_hash parameter serves solely as verification that the form was generated by the merchant's server, and not by the customer or a third party. Its calculation depends on the merchant’s private Transaction Key. The Transaction Key is discussed in Section 4.7.

6.2 Transaction and Display Fields

These parameters are validated as indicated below. If invalid, one of the following two scenarios will occur:

• The customer's browser will display an error page and the merchant will be notified by email
• A default value will be substituted

The parameters are passed on as received by Payeezy Gateway Payment Pages in:

• Notifications to the merchant about errors
• Relay Response / Silent Post / Receipt Link

6.3 Order and Customer Detail Fields

The parameters below describe details about the order and the customer and all are optional. They are passed as received by Payeezy Gateway Payment Pages via:

• Notification emails to the merchant about errors
• Relay Response / Silent Post / Receipt Link

Important Note: To enable Level 3 field support, you must enable the "Level 3 Processing" option on the General tab of your Payeezy Gateway Payment Page or pass this parameter in your request:. You must also enable it on the General Setting tabs during the Payment Pages configuration.

<input name="enable_level3_processing" type="hidden" value="TRUE" />

NOTE: Just enabling Level 3 check box does not automatically allow you to submit Level 3 data. By not having these processing abilities on your account, this will prevent your transcations from settling. You should contact your First Data saleperson to learn more about adding Level 3 processing abilities to your account.

Notes on Additional Amount Fields: the x_tax, x_freight, x_duty amounts are for display within the order information and order confirmation emails only. Payeezy Gateway Payment Pages perform no calculations with these numbers. They are passed back to the merchant with Relay Response, Silent Post, and Receipt Links.

6.4 Soft Descriptor Fields

The following properties are used to set soft descriptor information for a transaction on a case-by-case basis.

Important Note About Using Soft Descriptors: Dynamic soft descriptors are submitted only at settlement time and are NOT utilized during authorization. As a result, the dynamic nature of the descriptor will not show on a pending authorization statement, but will show on the statement once the transaction has settled. If you would like to use Soft Descriptors, please contact your First Data Relationship Manager or Sales Rep and have them set your "Foreign Indicator" in your "North Merchant Manager File" to "5".

6.5 Unsupported Fields and Unsupported SIM Emulation Functionalities

The following fields and their corresponding SIM Emulation functionality are not supported by Payeezy Gateway Payment Pages:

6.6 Dynamic Currency Conversion (DCC)

The standard DCC use case is a where a payment is entered through the HCO, and only through the credit card form. Card numbers are checked for DCC eligibility, if they are not found to be eligible, the transaction is processed as usual. The customer sees no difference.

If the card does qualify, the customer is presented with a "DCC-opt-in" form with two options "Cardholder chooses to pay in own currency" and "Cardholder chooses to pay in ABC," where ABC is the terminal's currency. The former constitutes an Opt-In, the latter constitutes an Opt-Out.

In the Opt-Out case, the transaction is processed as usual.

In the Opt-In case, the customer is presented with a confirmation page, and if they confirm, the transaction is processed as a DCC-Opt-In transaction.

This means that the receipt indicates the exchange rate, the amount in the terminal's currency, and the amount in the customer's local currency. The merchant can also see these fields in the DCC section of transaction details.

For the merchant there are only a few differences when using a payment page with a terminal that has DCC enabled.

1. Transaction details in the Transaction Search will have a DCC section at the bottom of the display. Only in the case where the DCC indicator has a value of '1' was a currency conversion actually performed. (A DCC indicator with a value of '2' indicates that the card number presented was not eligible and a DCC indicator value of '3' indicates that the customer has chosen to pay in the terminals or Client's base currency).
2. In the Closed Batch Report of the RPM (Real Time Payment Manager), all HCO - DCC transactions, where the customer has opted in, will be included in the DCC/DP Total amount for the terminal.
3. Under the Transaction Search option, when searching by Currency, DCC Opt-In transactions in that foreign currency are included.
4. The relay response/silent post (if configured and used) will include the extra fields when the payment was made with either a Visa or MasterCard.

• dcc_indicator: one of 1,2,3

If the dcc_indicator is a 1 or 3:

• dcc_foreign_amount
• dcc_foreign_currency_code
• dcc_exchange_rate
• dcc_margin_rate
• dcc_exchange_rate_source

If the HCO is used for Pre-Authorizations, and the merchant completes a DCC Opt-In payment through the Transaction Search or API, the current exchange rate will be automatically obtained and applied.

When refunding DCC-Opt-In transactions, through either the Transaction Search or the API, the customer will be refunded in their card's currency, the prevailing exchange rate will be automatically obtained.

To read more about how Dynamic Currency Conversion functions please click here to view the Payeezy Gateway Dynamic Currency Conversion and Dynamic Pricing Reference Guide.

Important: If the currency of the transaction request is different from the terminal's, any DCC data will be ignored.

6.7 Dynamic Pricing (DP)

The general DP use case is when the merchant obtains an exchange rate for a given currency (as chosen by the customer), then shows all prices in their shopping cart or Ecommerce site in that selected currency.

The merchant includes a reference to the exchange rate record in their redirect to the HCO, as well as the total amount in both the terminal's base currency and the foreign currency.

These total amounts and the foreign currency are verified against the exchange rate in the exchange rate record.

Note: Dynamic Pricing can only be conducted on Visa and MasterCard cards. To learn more about how this feature functions please view the DCC/DP Feature Guide by clicking here.

In order to use the HCO with DP (Dynamic Pricing), the merchant's web site will perform a Merchant Rate Request with the foreign currency that the customer has chosen.

The response for the rate request will include the exchange rate and the rate response identifier is to be used as shown below.

This merchant rate will have a field, valid_until, which indicates for how long the rate will remain valid.

When redirecting the customer to the HCO, the following 2 additional fields must be included:

* x_dp_rate_response_id
* x_dp_foreign_currency_amount

The x_fp_hash value is computed with a different string compared to non-DP HCO:

Note: The fields, "x_dp_foreign_currency_amount" and "x_dp_rate_response_id" are to be included in the Hash Calculation as well.

Example:

Then the hash will be computed on

These are the valid values for x_fp_hash

Important notes:

1. The x_currency_code parameter is required for DP / HCO.
2. The x_currency_code parameter must be equal the terminal's currency code.
3. The foreign currency amount will be validated against the amount multiplied by the exchange rate of the merchant rate obtained under 1.
4. The exchange rate response must be valid for at least 15 minutes from the time the customer is sent to HCO.

To read more about how Dynamic Pricing functions please click here to view the Payeezy Gateway Dynamic Currency Conversion and Dynamic Pricing Reference Guide.

6.8 Fees

A field indicating “Fee Tag” is an optional field in the HCO. The logic to determine Fee processing will follow the path shown below:

• If the optional Fee field is populated by the merchant, the associated Fee will be displayed upon the consumer facing HCO payment page as defined by the merchant. This is a Fee override.

• If the optional Fee field is absent or not populated by the merchant, the defined Fee structure will be applied to the transaction and displayed on the consumer facing HCO payment page. This is the standard Fee model.

Depending upon the transaction mode selected, the Fee will be treated as:

• Part of the Order Amount following the authorization/completion of the aggregated Order amount

• Separate from the Order Amount and following a separate and distinct authorization/completion path from the original Order amount.

If the Fee is defined and present, the total Order amount displayed will be determined as the original order amount + the Fee + any other related charges (tax, shipping).

The Fee will be displayed to the consumer via a merchant defined field tag. This tag could represent a “Service Fee”, “Processing Fee”, “Transaction Fee”, etc…. It is up to the merchant to define what the intent of this field is.

The sample below reflects the HCO page Preview, the same update applies to the Mobile page preview if fees are enabled on the Fees tab.

To read more about how Fees function in the Gateway please click here to view the Payeezy Gateway Fees article.

6.9 Visa Checkout

HCO Purchase

As discussed above, selecting the new Visa Checkout radio button and then clicking the Visa Checkout button will bring the cardholder to the Visa Checkout lightbox for authentication.

Clients can then log into the Payeezy Gateway Real-time Payment Manager to search for any transactions. Clicking on a particular transaction provides full detail (below) including whether the transaction was performed via Visa Checkout and the assigned Visa Checkout Call ID (transaction ID).

HCO Purchase (search/reports)

HCO Preauthorization (search/reports)

Transaction details indicate whether the transaction was a Purchase or a Pre-Authorization (which is followed by a Pre-Authorization Completion when the merchant fulfills the order).

HCO - Voiding a VCO transaction in the RPM

In “Actions” click on “Void” (marked in red on the screenshot)

The following screen with void transaction will be presented.

HCO - Refunding HCO transaction in the RPM

In “Actions” click on “Refund” (marked in red on the screenshot)

The following screen with refund transaction will be presented.

6.10 Special Payment

To learn about Special Payment, please refer to the feature article Special Payment.

To enable Special Payment in HCO, there is a need to pass an HCO flag x_special_payment. From a card-holder perspective, there is no visual difference between a regular card transaction and a Special Payment transaction. 

7 Relay Response

This method involves an HTTP request <-> response between Payeezy Gateway and merchant server, at the end of which Payeezy Gateway relays the response content to the customer. The steps are:

1. Payeezy Gateway makes an HTTP POST request containing the transaction results to the merchant server (see Section 9, "Transaction Result Fields" for details on the data that would be sent).
2. The merchant sever responds back with HTML content
3. Payeezy Gateway displays the response content to the customer

Step 1 allows the merchant to receive transaction results in real time, which can then be used to update databases, inventory, empty shopping carts, etc.

Step 2 lets the merchant return a customized receipt via the HTML response they return to Payeezy Gateway.

The merchant server response should be in HTML format, and is passed on to the customer's browser for final display. If the merchant server response is not received within 25 seconds in Step 2, in Step 3 Payeezy Gateway displays the standard transaction receipt to the customer. This is fallback behavior so it is important to note that Payeezy Gateway is expecting a response from the merchant.

No sensitive transaction related data is transmitted to the merchant server.

Usually the Relay Response step is only performed for successful transactions. However, if the customer's payment attempts fail three times a “Transaction Declined” message is posted to the merchant's server for Relay Response.

In order to trigger Relay Response, set the following parameters in the payment request:

8 Silent Post

This option is enabled by adding a “Silent Post URL” to the “Receipt Page” tab of the Payeezy Gateway Payment Pages interface.

Silent Post performs the same Step 1 as Relay Response, sending the same transaction result fields. But in Step 2, the HTML content (if any) in the merchant server's response is ignored by Payeezy Gateway, and the flow of action ends here.

Note: there is no guarantee of sequence - for example if both Silent Post and Relay Response are enabled, the merchant server cannot assume the data will always arrive first from Silent Post or vice versa.
If you are getting an error email regarding silent post failing, please check the following:
1) You are accepting and responding to the silent post with HTTP 200 (This is the only accepted HTTP response)
2) Ensure no redirect information/headers are being sent (this is a server to server request)

9 Transaction Result Fields

There are four different categories of fields of which the first three are covered in the following tables:

1. Basic Relay Response and Silent Post “x_” parameters.
2. Payeezy Gateway Payment Pages Relay Response fields.
3. Most of the response fields returned for the equivalent Payeezy Gateway web service API request.
4. Most of the POST parameters from the initial request from the merchant's website to the Payeezy Gateway Payment Pages payment form. This includes, x_login, x_amount etc.

9.1 Basic Relay Response and Silent Post Fields

9.2 Basic Relay Response and Silent Post Fields (Credit Card Only)

9.3 Payeezy Gateway Additional Fields

9.4 Payeezy Gateway API Response Fields

9.5 Payeezy Gateway API Response Fields (Credit Card Only)

9.6 Response Reason Codes and Text

The fields below are the Response Reason Codes supported by Payment Pages.

9.7 Common Bank Response Codes

The codes below appear in the field Bank_Resp_Code.

9.8 Address Verification Result Codes

The values below occur in the fields AVS and x_avs_response.

9.9 CVV2 Verification Indicator Codes

The values below occur in the field CVD_Presence_Ind. Note that if the value is not 0 the cardholder provides it.

9.10 CVV2 Result Codes

The values below occur in the fields CVV2 and x_cvv2_resp_code.

10 Example Payment Forms

Below are a few examples of the form placed on the merchant's website that will redirect the customer to the payment form.

10.1 Basic Example

This basic example only specifies the Payeezy Gateway Payment Page record to use, x_login, and the amount to charge, x_amount.

<form action="https://checkout.globalgatewaye4.firstdata.com/payment" method="post"> 

  <input name="x_login" value="WSP­EXA­001­01" type="hidden"> 

  <input name="x_amount" value="1.23" type="hidden"> 

  <input name="x_fp_sequence" value="123456" type="hidden"> 

  <input name="x_fp_timestamp" value="1191600622" type="hidden"> 

  <input name="x_fp_hash" value="4b04d15ccd9007658c2dadc679899ec4" type="hidden"> 

  <input name="x_show_form" value="PAYMENT_FORM" type="hidden"> 

  <input value="Checkout" type="submit"> 

</form>

Note:

• Replace the value for x_login with a Payment Page ID of the merchant's account, and x_amount with the dollar amount payable by the customer.
• The method used to generate the sequence number x_fp_sequence is chosen by the merchant.
• x_fp_timestamp is the timestamp created when the form is generated. It is equal to the number of seconds since January 1, 1970 in UTC (Coordinated Universal Time).
• x_fp_hash is calculated as the HMAC-SHA1 (or HMAC-MD5) from the Transaction Key of the Payeezy Gateway Payment Page with a given x_login and the string"x_login^x_fp_sequence^x_fp_timestamp^x_amount^" with the particular values replaced.
• x_show_form is always equal to “PAYMENT_FORM”.

10.2 Example Including Relay Response

This basic example enables relay response:

<form action="https://checkout.globalgatewaye4.firstdata.com/payment" method="post"> 

  <input name="x_login" value="WSP­EXA­001­01" type="hidden"> 

  <input name="x_amount" value="1.23" type="hidden"> 

  <input name="x_fp_sequence" value="123456" type="hidden"> 

  <input name="x_fp_timestamp" value="1191600622" type="hidden"> 

  <input name="x_fp_hash" value="4b04d15ccd9007658c2dadc679899ec4" type="hidden"> 

  <input name="x_show_form" value="PAYMENT_FORM" type="hidden"> 

  <input name="x_relay_response" value="TRUE" type="hidden"> 

  <input value="Checkout" type="submit"> 

</form>

Only one additional parameter is added, compared to the example in Section 11.1:

<input name="x_relay_response" value="TRUE" type="hidden">

Finally, the Payeezy Gateway Payment Page corresponding to the x_login value needs to have the "Allow Relay Response" checkbox enabled and the "Relay Response URL" field completed in the "Receipt Page" section when viewing an individual Payeezy Gateway Payment Page in the Payeezy Gateway Payment Pages interface.

10.3 Resulting Payment Form

For the two examples in Sections 10.1 and 10.2 the payment form presented to the customer will appear as below. Colors and title may be customized.

10.4 Example with Order Details

The merchant has the option of specifying additional details regarding the customer’s order:

• Order Items including quantity and unit price.
• Shipping and handling charges
• Taxes
• Duties

These values are communicated to Payeezy Gateway Payment Pages with the independent parameters x_line_item, x_freight, x_duty, and x_tax. For instance, the example below uses x_line_item, x_freight, and x_tax, but not x_duty:

<form action="https://checkout.globalgatewaye4.firstdata.com/payment" method="post"> 

  <input name="x_login" value="WSP­EXA­001­01" type="hidden"> 

  <input name="x_amount" value="558.49" type="hidden"> 

  <input name="x_fp_sequence" value="123456" type="hidden"> 

  <input name="x_fp_timestamp" value="1191600622" type="hidden"> 

  <input name="x_fp_hash" value="4b04d15ccd9007658c2dadc679899ec4" type="hidden"> 

  <input name="x_show_form" value="PAYMENT_FORM" type="hidden"> 

  <input value="Checkout" type="submit"> 

  <input name="x_tax" value="26.59" type="hidden"> 

  <input name="x_freight" value="45.0" type="hidden"> 

  <input name="x_line_item" value="10<|>1999 Cabernet Sauvignon, 0.7 l<|>1999 Cabernet Sauvignon, 0.7 l <|>10<|>19.95<|>YES" type="hidden">  

 <input name="x_line_item" value="12<|>2003 Merlot, 0.7 l<|>2003 Merlot, 0.7 l<|>12<|>23.95<|>YES" type="hidden"> 

</form>

Note:

• The x_line_item parameter may be repeated. Each occurrence corresponds to an item in the order. See Section 6.3, "Order and Customer Detail Fields" for the format.
• Adding order items is independent of triggering Relay Response.

For this example form, the resulting payment form will be presented as shown below:

11 Implementation and Testing Guide

This Section deals with resources provided by First Data that the merchant's web developer can utilize for implementation and testing.

11.1 Generation of the Checkout Form

The main Payment Pages interface, displayed after a Payeezy Gateway Payment Page is configured, is reached via a checkout form on the merchant's website which posts to the Payment Pages URL at https://checkout.globalgatewaye4.firstdata.com/payment. Section 11 lists some examples for the required HTML code. Note that demo accounts should use the URL https://demo.globalgatewaye4.firstdata.com/payment.

11.1.1 Calculating the x_fp_hash value

One of the input fields to be calculated for each checkout form separately is the x_fp_hash value. This is because one of the inputs that this value depends on is a time stamp: a payment request with a time stamp which is 15 minutes or older will be rejected by Payeezy Gateway Payment Pages.

The x_fp_hash calculation is performed using the HMAC-SHA1 key (the Transaction Key from the  Payment Page configuration) and the HMAC-SHA1 message, or payload, as the concatenation of x_login, x_fp_sequence, x_fp_timestamp, x_amount, and (if used) x_currency_code and x_fee_amount – all separated by the ^ character (see also Section 6.1, "Essential Fields"). The value of the Transaction Key can be found within the “Security” tab of the Payeezy Gateway Payment Page configuration as seen in the image below. (HMAC-MD5 is used for legacy implementations, if selected)

Note that even if the x_currency_code field is left empty, the payload for the hash calculation should end with the ^ character.

Example implementations of this calculation in many programming languages including C, C#, Python, Ocami, and Coldfusion are available here.

For example, using the values in the table below:

the resulting HMAC-MD5 is calculated with the payload of

WSP-GOODS-70^123454321^1228953556^100.00^

and has this value

2dba76cedb7847547fd964fc903e9f2c

Note that if the x_fp_hash value in the merchant's form is invalid, an error email is sent to the notification email address set in the "General" tab of Payment Page configuration:

This is a notification that a request for payment failed for the online store Merchant's Store Title.
An error page was displayed to the customer.

The following error was found:
X fp hash Could not validate the integrity of the payment from the transaction key, x_fp_hash, x_fp_sequence, x_fp_timestamp, x_amount, and (optionally) x_currency_code values of the request.

The customer will see an error page and and be unable to complete the payment.

11.1.2 Testing the x_fp_hash calculation

The Payeezy Gateway Payment Pages interface has a tool to test the merchant's implementation in the "Hash Calculator" Section. It allows merchants to inspect the hash calculated by Payeezy Gateway Payment Pages with known inputs. This value can then be quickly and manually compared with the hash calculated on the merchant's side.

11.1.3 Tying the Payment to a Particular Order

The parameters x_invoice_num (Invoice Number) and x_po_num (Purchase Order Number) are optional fields designed to tie the payment to a particular order or invoice.

If, for example, the merchant offers a shopping cart on their website which the customer fills with items, the developer will find it convenient to derive a unique Invoice Number or Purchase Order Number from the shopping cart identifier in order to track payments for a customer's purchases.

The difference between the two fields is that x_invoice_num appears on the CTR whereas x_po_num does not.

Both are returned to the merchant's server with Relay Response and Silent Post.

Also, both fields are truncated to 20 characters. See details in Section 6.3, "Order and Customer Detail Fields".

11.2 Relay Response Implementation

When Relay Response is configured, an HTTP POST request is sent to the configured Relay Response URL. The applicable fields are documented underSection 8, "Relay Response".

11.2.1 Generated HTML

The response generated by the merchant's server to the Relay Response request is passed on to the customer's web browser without any changes. However as the page will still have an https://checkout.globalgatewaye4.firstdata.com URL it is important to make all links to pages or images on the merchant's website absolute.

11.2.2 Customer Cookies

The merchant's website may be tracking the customer with a cookie. This cookie will not be part of the request sent from the Payeezy Gateway servers to the merchant's server with the Relay Response request. However, the merchant may set a field in the initial request that has the same values as the merchant's cookies.

For example:

<form action="https://checkout.globalgatewaye4.firstdata.com/payment" method="post"> 

  <input name="x_login" value="WSP­EXA­001­01" type="hidden"> 

  <input name="x_amount" value="1.23" type="hidden"> 

  <input name="x_fp_sequence" value="123456" type="hidden"> 

  <input name="x_fp_timestamp" value="1191600622" type="hidden"> 

  <input name="x_fp_hash" value="4b04d15ccd9007658c2dadc679899ec4" type="hidden"> 

  <input name="x_show_form" value="PAYMENT_FORM" type="hidden"> 

  <input name="x_relay_response" value="TRUE" type="hidden"> 

  <input value="Checkout" type="submit"> 

  <input name="merchant_cookie_1" value="12345" type="hidden"> 

  <input name="merchant_cookie_2" value="67890" type="hidden"> 

</form>

Here, two extra parameters, merchant_cookie_1 and merchant_cookie_2, have been added to the comparable Relay Response example from Section 11.2, "Example Including Relay Response". These values will then be sent with the Relay Response request, so that the merchant's server can identify the customer making the payment.

Caution should be used when adding extra parameters as in the above example to avoid existing parameter names. The full list of parameter names in use can be taken from a test request, or looked up in Section 7.

11.2.3 Relay Response Signature

The request generated by the Payeezy Gateway servers is signed with a cryptographic hash. The name of the hashed field is x_SHA1_Hash (x_MD5_Hash for legacy implementation). It is calculated as the SHA1 Hash of the concatenation of the strings:

• Relay Response Key
• Value of x_login
• Transaction ID (value of x_trans_id)
• Amount, exactly two digits after the period ($100 is used as “100.00”)

Note: this calculation is not the same as for the x_fp_hash field.

For example, using the below values:

The SHA1 calculation is performed for the string:

abcdefgh12345WSP-EXAMPL-011234567891.00

Resulting in:

0ae500c0cb7d78f9c26598d6456180dd

The key is configured under the "Security" tab of the Payment Pages interface.

11.2.4 Sample Relay Response POST

This section shows in detail what is sent to the merchant's server with a relay response HTTP POST request.

Most merchants will use https so that the POST is encrypted (not shown).

The sample POST is based on a credit card payment, sent to the hypothetical relay response URL (see the x_relay_url value):

http://testmerchant.com/relay_response

POST /relay_response HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Date: Tue, 13 Jan 2009 16:01:41 GMT
Content-Length: 2585
Host: testmerchant.com

SequenceNo=435677&Language=1&Tax2Amount=&x_currency_code=CAD&x_ship_to_city=&x
_method=CC&EXact_Resp_Code=00&CardHoldersName=Susan+Testname&x_email=test
%40yahoo.com&Authorization_Num=ET141870&MerchantCountry=Canada&Reference_3=&x_
description=&x_amount=564.30&exact_ctr=%3D%3D%3D%3D%3D%3D%3D
%3D+TRANSACTION+RECORD+%3D%3D%3D%3D%3D%3D%3D%3D%0A%0AMerchant+Plug-
in+Test+Store%0A44+King+Street+West%0AVancouver%2C+BC+V6B+4X2%0ACanada
%0Awww.test.com%0ATYPE%3A+Purchase%0A%0AACCT%3A+Visa++%24564.30+CAD%0A
%0ACARD+HOLDER+%3A+Susan+Testname%0ACARD+NUMBER+%3A+%2A%2A%2A%2A%2A%2A%2A%2A
%2A%2A%2A%2A1111%0AEXPIRY+DATE+%3A+12%2F12%0ATRANS.+REF.+%3A+1234567%0ADATE
%2FTIME+++%3A+13+Jan+09+16%3A01%3A41%0AREFERENCE+%23+%3A+435677+305+M
%0AAUTHOR.%23++++%3A+ET141870%0A%0A++++Approved+-+Thank+You+000%0A%0A%0A%3D%3D
%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D%3D
%3D%3D%3D%3D%3D%3D%3D%3D
%0A&x_card_num=&Ecommerce_Flag=0&x_po_num=&x_city=Vancouver&x_response_reason_
text=Transaction+has+been+approved&MerchantName=Merchant+Plug-
in+Test+Store&Bank_Resp_Code_2=&Tax1Number=&x_ship_to_address=&x_type=AUTH_CAP
TURE&Transaction_Approved=YES&Card_Number=%2A%2A%2A%2A%2A%2A%2A%2A%2A%2A%2A
%2A1111&x_duty=&x_fax=&x_relay_response=TRUE&exact_wsp_version=1.7&Customer_Re
f=&x_invoice_num=1234567&x_relay_url=http%3A%2F%2Ftestmerchant.com
%2Frelay_response&x_cavv_response=&CAVV_Response=0&x_addre
ss=555+A+Street&x_response_reason_code=1&x_show_form=PAYMENT_FORM&x_ship_to_co
untry=&Bank_Message=Approved&Tax1Amount=&x_version=3.1&x_ship_to_company=&Tran
saction_Error=false&exact_issconf=TRUE&SurchargeAmount=0&x_tax
_exempt=&x_phone=&x_merchant_email=&MerchantProvince=BC&Reference_No=1234567&Z
ipCode=&x_trans_id=2150&x_last_name=Testname&x_cvv2_resp_code=&Retrieval_Ref_N
o=5669951&x_zip=The+Zip&x_response_subcode=S&x_ship_to_z
ip=&Bank_Resp_Code=000&CVD_Presence_Ind=0&x_ship_to_last_name=&x_exp_date=&Cli
ent_Email=&exact_issname=&x_fp_sequence=123456&Transaction_Type=00&x_tax=127.2
6&x_company=&MerchantCity=Vancouver&CAVV_Algorithm=0&x_country=Canada&x_avs_co
de=&x_first_name=Susan&CVV2=&AVS=&Tax2Number=&x_ship_to_state=&x_response_code
=1&DollarAmount=564.30&TransactionCardType=VISA&EXact_Message=Transaction+Norm
al&Expiry_Date=1212&x_login=WSP-RELAY-
80&x_card_code=&Transaction_Tag=2150&x_ship_to_first_name=&MerchantPostal=V6B+
2K4&Client_IP=&x_freight=15.0&x_cust_id=&commit=Checkout&MerchantAddress=44+Ki
ng+Street+West&XID=&x_MD5_Hash=abfaf1d1df004e3c27d5d2e05929b529&x_state=BC&x_r
eference_3=&x_auth_code=ET141870&x_fp_timestamp=1231877695

The values of the above HTTP POST are listed in the table below:

11.2.5 Relay Response Sample Code

To the merchant's server, the Relay Response POST looks just like an ordinary form post, where a user fills out a web form, and the web server processes the posted parameters then responds with HTML. Except with Relay Response, there is no form that was filled out.

There are also two other differences:

1. URLs occurring in the HTML that is returned should be absolute, since the page will be shown under a https://checkout.globalgatewaye4.firstdata.com URL and not the merchant's.
2. The merchant does not have normal access to the payer's cookies, since the Payeezy Gateway Payment Pages server does not have them either, and cannot send them along as cookies. However, Section 11.2.2, "Customer Cookies", shows how to handle this.

Here is a simple example in JSP that covers the scenario of a successful transaction:

<%@ page language="java" import="java.lang.*" %>

<!DOCTYPE html

  PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"

  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd" >

<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">

<head>

 <title>Receipt</title>

 <script type="text/javascript" src="http://merchant.com/javascript.js" ></script>

 <link rel="stylesheet" href="http://merchant.com/style.css" type="text/css" />

</head>

<html>



<body>

 <h1>Merchant.com Online Store</h1>



 <h2>Thanks for your order</h2>



 <p>

  Your order was processed successfully. Here is your receipt. 

  Your order will be shipped in two business days.

 </p>

 <pre>

  <%=request.getParameter("exact_ctr")%>

 </pre>



 <% if(request.getParameter("exact_issname") != null) { %>

 <p>

  Issuer:   <%=request.getParameter("exact_issname")%>

  Confirmation Number:   <%=request.getParameter("exact_issconf")%>

 </p>

 <% } %>



 <p>

  <% String track_url = "http://merchant.com/order_tracking/" + request.getParameter("x_invoice_num"); %>

  You can track it at <a href="<%= track_url%>"><%= track_url %></a>.

 </p>



 <p>

  Return to <a href="http://merchant.com/home">home</a>.

 </p>

</body>

</html>

Some more samples can be found in the Sample Code area which demonstrate:

• How the parameters related to the state of the transaction are evaluated:
  • x_response_code
  • x_response_reason_text
  • exact_ctr
• How to use parameters sent with the original redirect from the merchant's website to the Payeezy Gateway Payment Pages payment form.

(https://support.payeezy.com/hc/en-us/articles/203994459)