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.
Scheme Names → values for CCBrand |
|---|
AirPlus |
AMEX |
ARGENCARD |
Aura |
Bancontact |
CABAL |
Cartes Bancaires |
Maestro |
CBN |
CENCOSUD |
ComfortCard |
CUP |
Dankort |
DINERS |
Discover |
Elo |
Hipercard |
JCB |
Maestro |
MasterCard |
NARANJA |
RuPay |
SHOPPING |
TOTAL |
VISA |
Process of payment
To make payments via the Hosted Payment Page you send a request to following URL with HTTPS GET or HTTPS POST:
https://www.computop-paygate.com/paymentPage.aspx |
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 Paygate 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 Paygate 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 Paygate 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 Paygate 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 Computop Helpdesk.
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:
<a href=https://www.computop-paygate.com/paymentPage.aspx?MerchantID=Test&Len=162&Data=E98D40FFFD622C5FE7414F73539A1852C2CE7C8B09D34DF217E27FA2E194B9968DE9ABAE3B1F44B5485EFE3EF2597C7395BADBAD4340CDFD000DD57129EEFAA0BE904A7E2339DCF9363DA6ACDBE5EF98E169FC3092B160252A037135421FD0CE092C174A7D1D63517BD45099AC2B682F5E3CD2C942A6F0E741A833C0&Language=en&URLBack=https://www.shop.com/canceled”> |
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.
Paygate interface
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) 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.Definitions
Data formats
Abbreviations
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
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:
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
| Key | Format | CND | Description |
|---|---|---|---|
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
Key | Format | CND | Description | |
|---|---|---|---|---|
RefNr | ns..30 | O | Unique reference number. The exact format depends on the available paymethods for your MerchantId. Please choose your format in that way that all paymethods are covered. | |
OrderDesc | ans..384 | M | 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 Computop Analytics. | |
| Key | Format | CND | Description |
|---|---|---|---|
| UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. |
| Key | Format | CND | Description |
|---|---|---|---|
| URLSuccess | ans..256 | M | Complete URL which calls up Paygate 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 Paygate and shop, please use the parameter UserData.
|
| Key | Format | CND | Description |
|---|---|---|---|
| URLFailure | ans..256 | M | Complete URL which calls up Paygate 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 Paygate and shop, please use the parameter UserData.
|
| Key | Format | CND | Description |
|---|---|---|---|
| Response | a7 | O | Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter. |
| Key | Format | CND | Description |
|---|---|---|---|
| URLNotify | ans..256 | M | Complete URL which Paygate 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.
|
Key | Format | CND | Description | |
|---|---|---|---|---|
ExpirationDate | ans..19 | O | Timestamp for the end time of the transaction processing, specified in local european time (CET/DST). Will be changed to UTC soon. Format: YYYY-MM-ddTHH:mm:ss | |
Following parameters are optional and can be submitted unencrypted to the Hosted Payment Page:
Key | Format | CND | Description |
|---|---|---|---|
| Template | ans..20 | O | Name of XSLT-file with your own layout for the HPP pay form. |
CCTemplate | ans..20 | O | Name of XSLT-file with your own layout for the pay form. If you want to use the redesigned and downwards compatible Computop template, please transfer the template name “ct_compatible”. If you want to use the responsive Computop template for mobile devices, please transfer the template name “ct_responsive”. The payment method "Bancontact" can also be called via payssl.aspx. Therefore "template=ct_bcmc" has to be submitted mandatory, in order to the special Bancontact template will be used. It should be noted that Bancontact must already be selectable as a payment method in the checkout process. The template cannot be modified and must be used in exactly the same way, as it is based on strict Bancontact guidelines. This is only valid for integration with Omnipay: EMS payment solutions. |
SDDTemplate | ans..20 | O | 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 Computop direct debit form template is displayed. |
ECTemplate | ans..20 | O | Name of a XSLT template to get an individual layout for your EasyCollect form which matches with your shop layout. This is used only if the customer selects EasyCollect as payment method and clicks on „Next“ button. If you don't submit a value the standard EasyCollect form template is displayed. |
Language | a2 (enum) | O | 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.
|
| Key | Format | CND | Description |
|---|---|---|---|
| URLBack | ans..256 | O | Complete URL which Paygate calls in case that Cancel is clicked by the customer. The parameter "URLBack" can be sent
In order to exchange values between Paygate and shop you may use something like this:
When user cancels payment this URL is called exactly like this and you may use URL Decode to extract parameter and values. |
Key | Format | CND | Description | Beschreibung | |
|---|---|---|---|---|---|
PayTypes | ans..256 | O | 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. Example: …&PayTypes=CC|EDD|Alipay | Mit diesem Parameter können Sie die anzuzeigenden Zahlarten übersteuern, d.h. sie können in diesem Parameter Pipe-getrennt entscheiden, welche der zur Verfügung stehenden Zahlarten angezeigt werden. De möglichen Werte entnehmen Sie aus der Spalte PayType in der obigen Tabelle der Zahlarten. Beispiel: …&PayTypes=CC|EDD|Alipay | |
General response parameters of the Hosted Payment Page
These parameters are equally for all payment methods. With the parameter pt you can see which payment method the customer used. Please take all further parameters specifically for a payment method from the manual of that respective payment method.
The following table gives the result parameters which Computop Paygate transmits to URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system: pls. be prepared to receive additional parameters at any time and do not check the order of parameters
the key (e.g. mid, RefNr) should not be checked case-sentive
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
Key | Format | CND | Description |
|---|---|---|---|
| pt | ans..256 | O | Information about the used paytype according to the table of payment types above |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK or AUTHORIZE_REQUEST (URLSuccess) as well as FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
| Key | Format | CND | Description |
|---|---|---|---|
| UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop. |
| Key | Format | CND | Description |
|---|---|---|---|
| Plain | ans..50 | O | A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. "Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. |
| Key | Format | CND | Description |
|---|---|---|---|
| Custom | ans..1024 | O | "Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose. |
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). Computop Helpdesk copies this XSLT-template to our Paygate Server. If you enter the name of your XSLT-file in the Template parameter, the Paygate 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:
File names
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.
| Purpose | Naming |
|---|---|
| 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:
https://www.computop-paygate.com/paymentPage.aspx?MerchantID=IhreMID&Len=123&Data=AGSDJ…ASDF&template=IhreMerchantID
Hidden Fields
The following hidden fields must be implemented so that the values can be passed on when sending the form:
| Value of | Name of hidden field |
|---|---|
| MerchantID | "MerchantID" |
| Request length | "Len" |
| Request data | "Data" |
| Template | "Template" |
| Language | "Language" |
| URL for back button | "URLBack" |
| Payment method | "PaymentMethod" |
| Credit card brand | "CreditCardBrand" |
Language selection
The language selection on the Hosted Payment Page form occurs automatically depending on the parameter Language. Other language areas are filtered out. If you wish to access the field of another language area e.g. with JavaScript, you can do so via the following path: paygate/language/@name.
XML structure
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"?>
</languages>
<language name="de">
<title>Zahlung</title>
...
</language>
<language name="en">
<title>Payment</title>
...
</language>
</languages>
‘UTF-8’ is also possible for the encoding.
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'?>" & _
<paygate>
<merchantID>...</merchantID>
<len>257</len>
<data>E98D4...F7065</data>
<template>
<urlBack><![CDATA[http://www.google.de]]></urlBack>
<paymentMethods>
<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"/>
<EDD lowercase="edd">
<PayPal lowercase=="paypal">
<iDEAL lowercase=="ideal">
</paymentMethods>
<language name="de">
<title>Zahlung</title>
...
</language>
</paygate>
JavaScript
You can find individual JavaScript methods either in the HEAD section of your XSL file or within the file main.js that can be found in the images folder at Templates/imagesMerchantID_PaymentPage/js.
Notice: Please do not use any external links to your JavaScript!