About Hosted Payment Page
General information about Hosted Payment Page
The Hosted Payment Page is a checkout that contains only the step of selecting the payment method. It is a HTML form with responsive design that is displayed properly on all devices.
In the case of payments via Hosted Payment Page, the shop redirects its customers to the HTML form where they selects their payment method. After confirming the selection depending on the payment method forwards the customer to a HTML form or to a form from an external service provider and notifies the shop after completion about the payment result.
Following table contains the payment methods which you can use via Hosted Payment Page:
Finland Online Bank Transfer
Following table lists all card brands that can be uses via the Hosted Payment Page. When submitting the value CC in parameter PayTypes all brands are displayed that are configured for a certain merchant. Selecting specific brands can be done by submitting a string of the desired brand names separated by pipe signs.
Kreditkartenmarke, korrekte Schreibweise für CCBrand
Process of payment
To make payments via the Hosted Payment Page you send a request to following URL with HTTPS GET or HTTPS POST:
All details required for payment processing are forwarded as parameters. The parameters are encrypted with Blowfish to ensure that neither the customer nor a third party can manipulate the data.
When calling the form decrypts the parameters and shows the HTML page with the payment methods. The customer selects the payment method and triggers the forwarding by clicking the button "Next".
After the payment has been made redirects the customers back to a shop page via HTTPS GET (URLSuccess, URLFailure) and transmits the result of the payment as a Blowfish-encrypted parameter string to these URLs. In addition transmits the result via HTTPS POST to the shop's Notify page (URLNotify). The shop accepts the payment result and decrypts the data in order to inform the customer about the status.
Calling the Hosted Payment Page
Calling the Hosted Payment Page starts with the correct composition of the parameters which consist of a key and a value and which are separated by an equals sign (=):
All parameters are assembled in a character string and separated by the character &:
Notice: Since the characters "=" and "&" are used as separating characters, these characters cannot be transmitted as values. All values which you transmit without BlowFish-encryption must be URL-Encoded.
A correct parameter character string for contains three basic parameters: MerchantID, Len and Data. The parameters MerchantID and Len are unencrypted. Only the Data parameter is Blowfish-encrypted:
The Data parameter contains the sensitive payment details such as amount and currency. The encrypted bytes are Hex-encoded and completed to two characters from the left with a zero. Encryption is via Blowfish ECB and is available to you as source-code and components.
The Len parameter is very important for encryption because it contains the length of the unencrypted(!) character string in the Data parameter. Since the data quantity to be encrypted is increased by a multiple of 8 in the case of the Blowfish encryption, the correct length of the character string must be known for decryption. Otherwise accidental characters emerge at the end of the character string.
The parameters are transmitted via HTTPS POST or HTTPS GET. The recommended transmit method is HTTPS POST because the parameter character string in the case of GET is attached to the URL, which is limited to 2048 bytes depending on the browser.
Notice: Please note that the maximum length of a payment request is limited to 5120 characters. If you require longer strings please contact .
The following listings show the development of a payment request. The first listing is the unencrypted parameter character string:
Notice: Please note that a value is to be assigned to each parameter. Do not transmit empty parameters, as this can cause the payment to fail.
This character string is encrypted and transmitted as the Data parameter. The HTTPS GET request for the Hosted Payment Page looks like this:
Notice: Please note that parameters like Language or URLBack are transmitted unencrypted. A table with all possible unencrypted parameters can be found also witihn this document.
Data formats: Format Description a alphabetical as alphabetical with special characters n numeric an alphanumeric ans alphanumeric with special characters ns numeric with special characters bool boolean expression (true or false) 3 fixed length with 3 digits/characters ..3 variable length with maximum 3 digits/characters enum enumeration of allowed values dttm ISODateTime (YYYY-MM-DDThh:mm:ss) Abbreviations: Abbreviation Description CND condition M mandatory O optional C conditional Notice: Please note that the names of parameters can be returned in upper or lower case.
Comment If a parameter is mandatory, then it must be present If a parameter is optional, then it can be present, but it is not required If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional
alphabetical with special characters
alphanumeric with special characters
numeric with special characters
boolean expression (true or false)
fixed length with 3 digits/characters
variable length with maximum 3 digits/characters
enumeration of allowed values
Notice: Please note that the names of parameters can be returned in upper or lower case.
Parameters of the Hosted Payment Page
These parameters are mandatory for all payment methods and has to be submitted Blowfish-encrypted within the Data parameter to the Hosted Payment Page.
Notice: Please take all further parameters specifically for a payment method from the manual of that respective payment method.
The following table describes the encrypted payment request parameters:
MerchantID, assigned by . Additionally this parameter has to be passed in plain language too.
TransactionID which should be unique for each payment
Unique reference number
Amount in the smallest currency unit (e.g. EUR Cent)
Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).
Currency, three digits DIN / ISO 4217
Description of purchased goods, unit prices etc.
Please note: The first 27 characters appear on the customer-account statement. You can view the full data in .
Hash Message Authentication Code (HMAC) with SHA-256 algorithm
If specified at request, forwards the parameter with the payment result to the shop
Complete URL which calls up if payment has been successful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between and shop, please use the parameter UserData.
Complete URL which calls up if payment has been unsuccessful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between and shop, please use the parameter UserData.
Status response sent by to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.
Complete URL which calls up in order to notify the shop about the payment result. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead.
Parameters for Hosted Payment Page
Following parameters are optional and can be submitted unencrypted to the Hosted Payment Page:
Name of XSLT-file with your own layout for the Hosted Payment Page.
If you don't submit a value the responsive template of the Hosted Payment Page is displayed.
Name of XSLT-file with your own layout for the credit card form. This is used only if the customer selects a credit card brand and then clicks on „Next“ button.
If you don't submit a value the responsive credit card form template is displayed.
Name of XSLT-file with your own layout for the direct debit form. This is used only if the customer selects direct debit as payment method and clicks on „Next“ button.
If you don't submit a value the responsive direct debit form template is displayed.
Language code: <de> German, <al> Albanian, <at> Austrian, <cz/cs> Czech, <dk> Danish, <en> English, <fi> Finish, <fr> French, <gr> Greek, <hu> Hungarian, <it> Italian, <jp> Japanese, <nl> Dutch, <no> Norwegian, <pl> Polish, <pt> Portuguese, <ro> Romanian, <ru> Russian, <es> Spanish, <se> Swedish, <sk> Slovakian, <sl> Slovenian, <tr> Turkey, <zh> Simplified Chinese.
No details means the language is German.
With this parameter you can override the payment methods to be displayed, i.e. you can decide within this parameter separated by pipe which of the available payment methods are displayed.
Take the possible values from the column PayType within the table of payment methods given above.
Optional parameters for Hosted Payment Page
Corporate PaymentPage: XSLT layout for forms
You can change the parameter Template to create an individual layout for your Hosted Payment Page form which exactly matches the shop layout To this end your graphic designer can design an HTML-template in the shop-design based on XSLT (Extensible Stylesheet Language Transformation). copies this XSLT-template to our Server. If you enter the name of your XSLT-file in the Template parameter, the form will appear in your layout.
The XSLT templates for the Hosted Payment Page form have several advantages:
- Merchants can bypass the costly PCI-security authorisation
- The Hosted Payment Page is responsive, i.e. it works on Smartphones, Tablets or on the Laptop
For general information about XSLT see www.w3.org.
The subsequent conventions apply for the use of the Corporate Paypage with XSLT:
A XSL file designed by you defines your individual layout. The associated XML file contains the texts that are to be displayed on the form. Hence, multilingualism is easy. Always use your MerchantID in the names of the files.
XSL template: MerchantID_PaymentPage.xsl
XML text file: MerchantID_PaymentPage.xml
Sub folder for pictures, CSS- and JS-files: Templates/imagesMerchantID_PaymentPage
In order not to receive safety notices, please ensure that external image sources are retrieved via SSL.
In order to call the individual layout, use the ‘Template’ parameter with your MerchantID and attach it unencrypted to the call of the form of Hosted Payment Page, for example:
The following hidden fields must be implemented so that the values can be passed on when sending the form:
Request length: „Len“
Request data: „Data“
URL for back button: „URLBack“
Payment method: „PaymentMethod“
Credit card brand: „CreditCardBrand“
The ‘Language’ parameter controls which section of the XML text file is read out. German ‘de’ is always used as standard.
The XML file should have the following basic structure:
<?xml version="1.0" encoding="utf-16"?>
‘UTF-8’ is also possible for the coding.
With <xsl:variablename=““ select=“paygate/language/@name”/> you can directly address an XML language section from the XSL file.
For an overview of which parameters are rendered by the Hosted Payment Page, please examine the following structure (XSL file is rendered against the following XML string):
strXML = "<?xml version='1.0' encoding='windows-1252'?>" & _
<VISA type="CC" displayName="Visa"/>
<MasterCard type="CC" displayName="MasterCard"/>
<AMEX type="CC" displayName="American Express"/>
<DINERS type="CC" displayName="Diners Club International"/>
<Discover type="CC" displayName="Discover"/>
<JCB type="CC" displayName="JCB"/>
In your XSL file you can access each single value within this XML structure which is rendered in the backend based on the XML language file and additional values.