Custom Transition Templates

NOTE:

Merchants cannot upload their own template files directly inside the Administration. Template code must be reviewed by a member of PlugnPay staff. Merchants can either provide this template directly to a member of PlugnPay staff or submit a HelpDesk ticket request.

Feature Overview

The Transition Templates feature is an advanced way to customize the Smart Screens payment method’s success-link transition redirection pages, to accommodate merchant’s more advanced layout/presentation needs.

As a merchant, you can easily create & upload custom transition templates to replace the default ones used by our payment gateway. This lets you customize the look/feel of those pages to better suite your particular custom transition page redirection needs.

Features Include:

Total Control Of Layout - Allows merchants to easily adjust wording within the transition page &/or replace its HTML code entirely.

Multiple Templates- Allows merchant to manage multiple template & to easily select a specific template for the given transaction.

Fully Integrated - No special integration with your web site is required. Merchants provide their transition templates to a member of PlugnPay staff for review & then add 1 or 2 hidden parameters to the data they are already supplying us.

Free To Merchants - This transition template feature is part of the core payment gateway service & does not incur additional fees for its usage. (Normal authorization fees still apply to your transactions.)

How It Works

Merchant creates their custom transition templates and provides it to a member of PlugnPay staff for review. After review the transition template will be uploaded to the server and the merchant can utilize it by activating the ‘Use Transition Page’ option within their account.

In their order forms &/or shipping cart solution, merchant will be required to specify a success URL or response URL inside the request being made to the payment script.

Whenever a customer uses that order form or shipping cart solution to pay for an order & their authorization is approved, we will display the HTML of the transition page to the customer’s browser. And depending upon how the merchant configured their custom transition page, it may redirect to the customer to your noted success-link URL automatically.

Feature Setup

  1. Merchant would need to provide 1 or more transition web pages. (See further down for special substitution tags that can be inserted into your transition template’s HTML code.)

  2. Merchant must enable the “Use Transition Page” option within the “Account Settings” section of their merchant admin area. This option is found within the ‘Payment Script Config’ sub-section.

  3. Merchant would need to know the name they assigned the custom transition pages they uploaded. This can be provided to the merchant by PlugnPay staff if needed.

  4. When using Smart Screens &/or Direct Method, merchant needs need to tell us when to use a specific custom transition page for a given transition & what URL they would like the customer redirect to upon a successful authorization.

These are the fields you would need to include within the data you send:
Variable Required Max Size Value Notes
transitionpage (See Note 1) Mandatory n/a [enter name of the template] Set to the name of the transition template to use.i.e. This would tell to use custom transition page named ‘abc135’.
success-link Mandatory n/a [enter absolute URL to redirect to] Set absolute URL of your thank you response page/script, you would like customer redirected to when the authorization is approved.i.e.

Notes:

  1. When the ’transitionpage’ field is not provided, blank or when the template name does not exist, we will use our normal default transition page. Type of transition page method used (GET or POST), will be based on the ‘Transition Page Type’ setting within the “Account Settings” section of your merchant admin area.

Template Layout

The layout of transition template files are very straight forward.

The template files are complete HTML web pages, with a few substitution tags entered where necessary.

Naming Your Template File

You may name your transition template files anything you like, but they must follow these basic naming rules:

  • The file’s extension must be “.htm” or “.html”.

  • The file’s name on your PC can contain letters [a-z and A-Z], numbers [0-9], hyphen [’-’] or underscore [’_’] characters. (No spaces or other punctuation are permitted within the file’s name)

How To Format Template File

You will need to create a complete web page, which contains HEAD & BODY sections. (Please see further down in this document, for a complete list of all the special substitution tags that may be defined within your templates HTML code)

For example:

Please click here to see HTML code of a basic GET method Transition Template sample file.

Please click here to see HTML code of a basic POST method Transition Template sample file.

These files should give you a better idea on how they are structured.

Substitution Tags

The following are special substitution tags, which can be used within the custom transition page’s HTML code.
Variable Notes
[pnp_STRTURL] Inserts value of ‘success-link’, ‘badcard-link’ or ‘problem-link’ based on FinalStatus response
[pnp_ENDURL] Inserts “” tag.  (normally used in conjunction with above special tag)
[pnp_HIDDEN]  (See Note 1) Inserts response fields as a single block of HTML hidden input form tags.
[pnp_QUERYSTR] (See Note 2) Inserts response fields as a query string of name/value pairs.
[pnp_fieldname] (See Note 3) Inserts the value of a specific response ‘fieldname’.

Notes:

  1. For Example:

    This entire block of HTML code would be the value of the single [pnp_HIDDEN] tag, if the response data only had 5 fields.

  2. For Example:

    fieldname1=fieldvalue1&fieldname2=fieldvalu21&fieldname3=fieldvalue3&fieldname4=fieldvalue4&fieldname5=fieldvalue5

    This above query string would be the value of the single [pnp_QUERYSTR] tag, if the response data only had 5 fields.

  3. For Example:

    [pnp_FinalStatus] - would insert value of the “FinalStatus” field
    (i.e. success, badcard, problem or fraud)

    [pnp_orderID] - would inserts value of the “orderID” field
    (i.e. 200905081201304500000)

    This response field value substitution is the same usage as Email Management’s confirmation email templates.