About card payments
General information about card payments
Computop Paygate processes all major cards and currencies worldwide. Card data is protected against unauthorised access by TLS encryption. Additional security functions are integrated fraud prevention and risk management. Our standardized settlement files guarantee a straightforward reconciliation processes in your accounting.
Verified by Visa and MasterCard SecureCode secure your payment claim by password validation if a customer disputes the payment later. American Express SafeKey also uses the 3-D Secure technology, which means that the card holder must confirm their identity with a password.
Transaction processing can be made via Paygate standard form, via customized forms, via server-to-server-connection or via batch transfer. Likewise Paygate can process transactions from stationary terminals.
Using the card form provides several advantages:
- Merchants can bypass the costly PCI-security authorisation
- The programming of 3-D Secure with forms is much easier and quicker than via Server-to-Server connection
Process of 3-D Secure payments
MasterCard SecureCode (UCAF), Verified by Visa (VbV), Diners ProtectBuy, JCB J/Secure and American Express SafeKey are authentication methods which verify the identity of the card holder before making the payment. The name 3-D Secure used by technicians describes only the protocol. The correct brand names are Verified by Visa, MasterCard SecureCode, SafeKey, ProtectBuy and J/Secure.
Merchants benefit from authentication with 3-D Secure because the card schemes provide a liability shift: If you are using Verified by Visa, MasterCard SecureCode, Diners ProtectBuy, JCB-Card J/Secure or American Express SafeKey, the burdon of proof and thereby generally the liability is shifted from the merchant to the card issuing bank, should the customer dispute the payment. Irrespective of whether the card holder actually uses the authentication you obtain a very high protection against payment defaults / chargebacks in case the customer states they have not authorised the card payment. Your Acquirer will be able to discuss the details of 3-D Secure and the cover that it provides.
From a technical perspective 3-D Secure is not a payment method but an authentication process which precedes the payment: Once the credit card data has been entered, Paygate checks the identity of the card holder and does not process the payment until after the authentication.
For further steps it is crucial if the credit card connection is made via form interface or via Server-to-Server-connection. In the first case the Computop Paygate form assumes the further authentication process, with Server-to-Server-connection the merchant has to manage the authentication through a separate interface.
Notice: Please make sure to review our EMV 3D Secure Specification to integrate according to the newest standards.
Process of a transaction with 3-D Secure via form interface
The customer selects the Credit card payment method in the Internet shop and enters the card number and expiry date. Computop Paygate receives the card number and checks, via a connection to Visa, MasterCard, Diners, JCB or American Express, whether this credit card is registered for Verified, SecureCode, Diners ProtectBuy, JCB-Card J/Secure or SafeKey. If the credit card is not registered a credit card payment is carried out with TLS. With that the transaction gets a flag which identifies payments with 3-D Secure. This marking tells the Acquiring Bank that you use the authentication and a secured payment claim is obtained based on the Liability Shift in case the card holder disputes the payment.
Communication for credit card payments with 3-D Secure with Computop Paygate forms
If the customer's credit card has been registered by the issuing bank for Verified by Visa, MasterCard SecureCode, Diners ProtectBuy, JCB-Card J/Secure or American Express SafeKey the authentication process now starts: Computop Paygate opens a new browser window which connects the customer to its bank. In this window the customer enters the password received by its bank.
Example of a password request for 3-D Secure with form connection
If the password is correct Computop Paygate obtains confirmation in the form of a signature. Only after confirmation does Paygate start the payment and send the transaction with the signature to the Acquiring Bank.
Process of a transaction with 3-D Secure via Server-to-Server-connection
To carry out authentication, Paygate connects the card holder to his bank, which confirms the identity. A payment process with Verified by Visa or MasterCard SecureCode, Diners ProtectBuy, JCB-Card J/Secure or American Express SafeKey comprises two steps: authentication and payment.
Following scheme illustrates the processes of a Server-to-Server-payment with 3-D Secure.
Communication for credit card payments with 3-D Secure via socket connection
In the next phases there are three different cases in which Computop Paygate responses differ. The individual connection parameters can be found in the credit card payments section of the handbook.
Case 1: Credit card not registered for 3-D Secure
Computop Paygate initially contacts Visa or MasterCard, Diners, JCB or American Express Directory Server to determine whether the purchaser’s credit card is registered for Verified or SecureCode or SafeKey.
Case 2 with Popup: Credit card registered for a 3-D Secure system
IMPORTANT NOTICE: We strongly recommend the use of the iFrame solution since MasterCard has revised the regulations. MasterCard prohibits the use of a popup. For this an excerpt from the regulations (Excerpt from: MasterCard® SecureCode™ Merchant Implementation):
“Inline window implementations, which have proven to virtually eliminate the issues caused by pop-up authentication windows, are required for all new merchant implementations and existing pop-up implementations must convert to inline windows.”
If the credit card is registered for Verified or SecureCode, ProtectBuy, J/Secure or SafeKey, Computop Paygate returns the socket-connection HTML source code with a JavaScript function. This JavaScript function creates the connection to the bank with which the customer is authenticated by entering its password into a popup-window. The HTML source code with the JavaScript function Initiate3DSec() which Computop Paygate sends to the shop must be embedded in the response page which the shop displays in the customer's browser.
Notice: Please note that the use of a popup window can lead to problems with popup blockers in the customer's browser. Therefore case 3 describes an alternative in the form of an Inframe variant.
The following listing shows a response page in which the HTML code is embedded:
<HTML> <HEAD> <META http-equiv=Content-Type content="text/html; charset=unicode"> <SCRIPT language="javascript"> <!-- <Response excerpt from request: HTML with JavaScript> //--> </script> </HEAD>"); <BODY onload="javascript:Initiate3DSec();"> <table><tr> <td align="center"><font face="Verdana" size="-1"><b>Please identify yourself with 3-D Secure!</b></font></td> </tr></table>"); </BODY> </HTML> |
Notice: You can also use this code if you only want to verify the identity of the card holder without making a credit card payment. Our Support team can set your account in a way that Computop Paygate can carry out just the authentication with Verified or SecureCode, ProtectBuy, J/Secure or SafeKey without payment (Authentication Hosting).
After the customer has been authenticated with its bank, the bank's Access Control Server (ACS) requests the TermURL in the shop. In the case of this Request the ACS transfers the following parameters via GET (QueryString) to the TermURL of the shop: MID, PayID and TransID. The PARes parameter is transferred via POST.
Notice: The PAResponse parameter must be URL encoded but not Blowfish-encrypted since the content can include special characters.
The parameter must be transferred in whole via POST to the following URL:
https://www.computop-paygate.com/direct3d.aspx |
Notice: If you forward the PARes and MID of the ACS parameters please use the specified parameter name MerchantID, PAResponse for the direct3d.aspx page.
Case 3 without Popup: Credit card registered for a 3-D Secure system
Alternatively to the popup window the card holder can also carry out authentication with the bank in an iFrame variant; this avoids difficulties with popup blockers in the customer's browser. Provided the card is registered on the Directory Server, Computop Paygate returns the following parameters via the socket connection.
Parameter | Format | CND | Description |
---|---|---|---|
ACSURL | ans.. | C | Only in the case of registered credit cards: URL of the Access Control Server of the card issuer with attached request parameters (not URL-encoded!). It is possible to use ACS server ampersand and question mark as value within the URL; everything before parameter PAReq is part of ACSURL. |
PaReq | ans.. | M | Payer Authentication Request, which must be URL-encoded. |
MD | M | Merchant Data is an empty value, which must be transferred for compatibility reasons | |
TermURL | ans.. | M | Shop return address. Computop Paygate adds the parameters PayID, TransID and MID as request parameters to the initial TermURL seperated with a question mark. |
Response parameters of Socket-connection for the Authentication Request
Example for correct processing of ACSURL and TermURL:
acsurl=a?b=c&d=e&pareq=f&termurl=g?PayID=h&TransID=i&MID=j
ACSURL: a?b=c&d=e
TermURL: g?PayID=h&TransID=i&MID=j
Notice: Please note in this process that data must sometimes be transferred directly from the bank network. Therefore e.g. the ACSURL parameter is not URL-encoded, although Computop Paygate uses other URL-encoded data.
These parameters should be included as HIDDEN fields in an HTML page which posts itself to the ACS-URL. The following listing shows one such HTML page, in which the return parameters are embedded:
<HTML> <HEAD> <META http-equiv=Content-Type content="text/html; charset=unicode"> <A content="MSHTML 6.00.2800.1106" name=GENERATOR> </HEAD> <BODY onload="sendpareq.submit();"> <FORM action="[ACSURL]" method="POST" name="sendpareq"> <input type="hidden" name="MD" value=""> <input type="hidden" name="PaReq" value="[PaReq]"> <input type="hidden" name="TermUrl" value="[TermUrl]"> </FORM> </BODY> </HTML> |
Notice: You can also use this code if you only want to verify the identity of the card holder without immediately making a credit card payment (Authentication Hosting). Computop Helpdesk can configure your checkout so that Computop Paygate can carry out Verified by Visa or SecureCode without payment.
After the customer has been authenticated with its bank, the bank's Access Control Server (ACS) requests the TermURL in the shop. In the case of this Request the ACS transfers the following parameters via GET (QueryString) to the TermURL of the shop: MID, PayID and TransID (unencrypted). The PARes parameter is transferred unencrypted via POST.
Notice: The PAResponse parameter must be URL encoded but not Blowfish-encrypted since the content can include special characters.
The parameter must be transferred in whole via POST to the following URL:
https://www.computop-paygate.com/direct3d.aspx |
Notice: If you forward the PARes and MID of the ACS parameters please use the specified parameter name MerchantID, PAResponse for the direct3d.aspx page.
Credit card brands
Credit card brand, correct spelling for CCBrand |
MasterCard |
VISA |
AMEX |
DINERS |
CBN |
JCB |
Dankort |
Maestro |
Cartes Bancaires |
Discover |
Bancontact |
Hipercard |
Elo |
Aura |
Carte 4Etoiles |
AirPlus |
CUP |
NARANJA |
SHOPPING |
CABAL |
ARGENCARD |
CENCOSUD |
KOOKMIN |
KEB |
BC |
SHINHAN |
SAMSUNG |
HYUNDAI |
LOTTE |
1euro |
echequevacances |
cofidis3xcb |
cofidis4xcb |
facilypay-3x |
facilypay-3xsansfrais |
facilypay-4x |
facilypay-4xsansfrais |
RuPay |
Definitions
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.
Computop Paygateinterface: via form
Chart of process flow via form interface
Process flow of Credit card payment via form interface
Corporate PayPage
Paygate forms are framed as standard in white and grey. Merchants can customise the layout of the forms with the help of layout parameters. The simplest way to change the layout is to set the parameters for the background colour (BGColor), background image (BGImage) and the font (FFace). You can use XSL-templates to change the layout further:
In the case of credit card payments you can change the parameter Template to create an individual layout for your PaySSL 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 Computop Paygate Server. If you enter the name of your XSLT-file in the Template parameter, the Computop Paygate form will appear in your layout.
For general information about XSLT see www.w3.org.
Please note, that the Corporate Paypage is a fee-based additional service. Please ask Computop Sales thereun.
Computop provides a programming example for creating a responsive credit card form online at https://www.computop.com//de/xslt. The template files to be created – XSL and XML – afterwards are transformed automatically for the various browsers. Please ensure before sending to Computop that both files can be loaded into the browser correctly. The complete code must be able to be displayed and no error message are allowed. If an error message occurs the code and used tags have to be revised. Please note that new versions must be available not later then 3:30 pm in order to to be processed on the same day.
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.
XSL template: MerchantID_PaySSL.xsl
XML text file: MerchantID_PaySSL.xml
Sub-folder for images: Templates/imagesMerchantID
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 Computop payment page, for example: https://www.computop-paygate.com/payssl.aspx?MerchantID=IhreMID&Len=123&Data=AGSDJ…ASDF&template=IhreMerchantID
Field names of the form
When implementing the text field for the credit card number, use the following values for the parameters ‘name’ and ‘id’:
Year of expiry: „cardExpirationYear“
Expiry date month: „cardExpirationMonth“
Credit card number: „cardNumber“
Card verification number: „cccvc“
Card brand: „ccBrand“
A text field for the input of the credit card number is then implemented as follows:
<input type="text" name="cardNumber" id= "cardNumber" value=""></input> |
Hidden Fields
The following hidden fields must be implemented so that the values can be passed on when sending the form:
MerchantID: „MerchantID“
Request length: „Len“
Request data: „Data“
Template: „Template“
Repeat attempts: „Counter“
Language: „Language“
Notify: ‘Notify’ (optional in the case of repeat attempts)
Address choice ‘AddrChoice’ (only for American Express address verification service)
Language selection
The language selection in form PaySSL.aspx is automatically based on the parameterLanguage. 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="windows-1252"?> </languages> <language name="de"> </language> <language name="en"> </language> </languages> |
‘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 additionally rendered by the PaySSL, please examine the following structure (XSL file is rendered against the following XML string):
strXML = "<?xml version='1.0' encoding='windows-1252'?>" & _ "<paygate pay='ssl'>" & _ "<merchantID>"..."</merchantID>" & _ "<len>"..."</len>" & _ "<data>"..."</data>" & _ "<Background>"..."</Background>" & _ "<BGImage>"..."</BGImage>" & _ "<BGColor>"..."</BGColor>" & _ "<FFace>"..."</FFace>" & _ "<FSize>"..."</FSize>" & _ "<FColor>"..."</FColor>" & _ "<center>"..."</center>" & _ "<CCard>"..."</CCard>" & _ "<Year>"..."</Year>" & _ "<URLBack>"..."</URLBack>" & _ "<twidth>"..."</twidth>" & _ "<theight>"..."</theight>" & _ “<brands><brand>”…”</brand></brands>” &_ “<cvc>”…”</cvc>” &_ "<ccexpiryyear>" … "</ccexpiryyear>" & _ "<ccbrand>" … "</ccbrand>" & _ "<template>"..."</template>" & _ "<counter>"… "</counter>" & _ "<notify>"… "</notify>" & _ "<errorcode>"..."</errorcode>" & _ "<PCNr>"..."</PCNr>" & _ "<PCNrBrand>"... "</PCNrBrand>" & _ "<PCNrMonth>"… "</PCNrMonth>" & _ "<PCNrYear>"… "</PCNrYear>" & _ “<creditcardholder>” … “</creditcardholder>” "<Autostart>"…"</Autostart>" & _ <language/@name ... (Area for selected language-Node) (content of MerchantId_PaySSL.xml in the respective language)> "</paygate>" |
Since merchants use its own layout for the form, you do not require the layout parameter. However, it is possible after prior consultation with Computop to use the parameters for the transfer, e.g. the SessionID.
Error mapping
In the case of the error codes listed below Computop returns the form in order to enable the credit card data to be entered again. You only have to evaluate the ‘error code’ parameter and display the desired text from your XML file.
At this point the ‘error code’ template is called:
<xsl:apply-templates select=“/paygate/errorcode” /> |
The called-up ‘error code’ template may look like this. It can alternatively be implemented with ‘if’.
<xsl:template match="errorcode"> <tr> <td> <xsl:choose> <xsl:when test=".='0015'"> <xsl:value-of select="/paygate/language/ErrorCodeDescription/Description1"/> <!--The input of the credit card number was not correct--> </xsl:when> ... </xsl:choose> </td> </tr> </xsl:template> |
It is also possible to integrate the error messages directly into the (main) template:
<xsl:if test="paygate/errorcode != ''"> <xsl:choose> <xsl:when test="paygate/errorcode='0015'"> <xsl:value-of select="/paygate/language/ErrorCodeDescription/Description1"/> <!--The input of the credit card number was not correct--> </xsl:when> </xsl:choose> </xsl:if> |
JavaScript
If JavaScript functions are desired, you must implement them in your template.
<script id=“clientEventHandlersJS“ language=“JavaScript“> if (document.SSLForm.cardNumber.value.length> 19) { alert(„<xsl:value-of select=“/paygate/language/strJavaScript1“/>“); document.SSLForm.cardNumber.focus(); } ... </script> |
Please do not use any external link to your JavaScript.
Link to Computop logo
Computop is obliged to provide the cardholder at all times with information on which server they are on. Please implement a Computop logo like it is implemented on the standard form or display a small imprint link. Logos are part of the programming examples.
Both items of information must refer to the Computop page impressum.aspx. This expects the ‘Data’ parameter, which is appended to the URL as in the following example.
impressum.aspx?data=<xsl:value-of select="/paygate/language/@name"/>|<xsl:value-of select="paygate/merchantID"/> |
Link to Visa Secure and MasterCard Secure Code
Visa and MasterCard regulations require that your pay page displays the Visa Secure and SecureCode logo. Please link the Verified logo to vbv.aspx and the SecureCode logo to https://brand.mastercard.com/brandcenter/mastercard-brand-mark/downloads.html.
Programming and testing the form
First design a HTML page with the layout for your payment page and initially save it for testing with the file extension .htm or .html. Open this file in the browser. Next, save this as an xsl file.
<?xml version="1.0" encoding="windows-1252"?> <xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> <xsl:output method="html" encoding="UTF-8"/> <xsl:template match="/"> <html> <head> <title>PaySSL Template</title> <script>Your JavaScript</script> </head> <body> <form action="https://www.computop-paygate.com/payinterim.aspx" method="POST"> </form> </body> </html> </xsl:template> |
In order to read the texts from the XML file, first of all create your tags in the desired language sections with the texts:
<language name="de"> <strCCNumber>credit card number</strCCNumber> </language> |
Subsequently, replace the text in the HTML by a reference to the respective section in the XML file:
<xsl:value-of select="/paygate/language/strCCNumber"/> |
In order to test your template, we request that you integrate the following lines in your XML file only for the test (before sending it to Computop ) and afterwards to call up the XML file in a browser. If no error is displayed you can send your template and the image folder in a Zip file to Computop Helpdesk with a request to check and install it.
<?xml version="1.0" encoding="windows-1252"?> <?xml-stylesheet type="text/xsl" href="templatename.xsl"?> <paygate> <languages>please omit for your layout tests <language name="de"> </language> <language name="en"> </language> <languages>please omit for your layout tests </paygate> |
In order to get an overview of the versions, please include the date and version number in the name of your Zip file.
As with the credit card form, it is now also possible to design your own XSLT templates for the SEPA direct debit form. In exactly the same way as with the credit card form, this is controlled via the ‘Template’ parameter. This can be called via the following URL:
https://www.computop-paygate.com/paySDD.aspx?MerchantID=IhreMID&Len=123&Data=AGSDJ…ASDF&template=YourMerchantID |
The files must use the following naming convention:
XSL template: MerchantID_PaySDD.xsl
XML text file: MerchantID_PaySDD.xml
Sub-folder for images: Templates/imagesMerchantID
Notice: A Corporate Paypage offers you much more extended functions like for example a preconfiguration of card data which are not explained in detail here. For questions about extended functions please consult the Computop Helpdesk.
General parameters of the interface
The interface of the Computop Paygate form is consistently payssl.aspx for all connections. In order to make a credit card payment via Computop Paygate form, go to the following URL:
https://www.computop-paygate.com/payssl.aspx |
This section explains the parameters which are the same for each connection. These values are always required, along with the special parameters explained in the following sections for each individual connection, e.g. GICC. The second table explains all response parameters which are also the same for all credit card connections. There are separate handbooks for credit card transactions via PagBrasil, PayU CEE and PayU LatAm connections.
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by Computop . |
TransID | ans..64 | M | TransactionID which should be unique for each payment Please note for some connections the different formats that are given within the specific parameters. |
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). |
Amount3D | n..10 | OC | Only for 3DSecure: Amount for authentication with Verified, SecureCode and SafeKey if Amount deviates. E.g. Customer confirms flight costs of 120 Euros with 'Verified' but the travel agent captures only the booking fee of 20 Euros: Amount3D=12000; Amount=2000. 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). |
Currency | a3 | M | Currency, three digits DIN / ISO 4217 |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
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. |
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. |
Response | a7 | O | Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter. |
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. |
UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop |
Capture | ans..6 | O | Determines the type and time of capture. AUTO: capturing immediately after authorisation (default value). MANUAL: capturing made by the merchant. <Number>: Delay in hours until the capture (whole number; 1 to 696). |
ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
Plain | ans..50 | O | A value to be set by the merchant to return some information unencrypted, e.g. the MID |
Custom | ans..1024 | O | The merchant can submit several values separated by | which are returned unencrypted and separated by &. Custom=session=123|id=456 will change in the answer to Session=123&id=456 |
expirationTime | ans..19 | O | timestamp for the end time of the transaction processing, specified in UTC. Format: YYYY-MM-ddTHH:mm:ss |
General parameters for credit card payments via form
To adapt the layout of the SSL-page to your shop you can use the following unencrypted parameters to configure colours, fonts and images:
Parameter | Format | CND | Description | |
---|---|---|---|---|
Template | 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. | |
Background | ans..256 | O | Background ambiance of form: URL for a background image - HTML-colour value for background colour as HEX value or - HTML-colour name | |
BGColor | ans..7 | O | Form background colour: - HTML-colour value for background colour as HEX value or - HTML-colour name | |
BGImage | ans..256 | O | Form background image: URL for a background image Please note that this value supersedes “BGColor”. | |
FColor | ans..6 | O | Text colour: - HTML-colour value as HEX value or - HTML-colour name | |
FFace | a..10 | O | HTML-name for the font | |
FSize | n2 | O | Number for font size | |
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. | |
CCSelect | a..16 | O | Determines preselected card type in the form | |
URLBack | ans..256 | O | Complete URL which Paygate calls in case that Cancel is clicked by the customer. The parameter "URLBack" can be sent
| |
Center | n1 | O | By default the form is centered vertically and horizontally. The value <1> centres the form at the top. | |
tWidth | ans..4 | O | Width of table for input of the credit card data as percent- (50%) or pixel values (320). | |
tHeight | ans..4 | O | Height of table for input of the credit card data as percent- (70%) or pixel values (480). | |
CustomField[n] | ans..50 | O | Field that can be used individually by the merchant. Presently 14 fields from CustomField1 to CustomField14 are supported. |
Layout parameters for Paygate forms for credit card payments
The following table describes the result parameters that Paygate transmits to your URLNotify, URLSuccess or URLFailure. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description | |
---|---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by Computop | |
PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files | |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | |
TransID | ans..64 | M | Merchant’s transaction number Please note for some connections the different formats that are given within the specific parameters. | |
Status | a..50 | M | OK or AUTHORIZED (URLSuccess) as well as FAILED (URLFailure) | |
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! | |
Code | n8 | M | Error code according to Paygate Response Codes (A4 Error codes) | |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm | |
UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop | |
PCNr | n16 | O | Pseudo Card Number: Random number generated by Paygate which represents a genuine credit card number. The pseudo card number (PCN) starts with 0 and the last 3 digits correspond to those of the real card number. You can use the PCN like a genuine card number for authorisation, capture and credits. | |
CCBrand | a..22 | OC | In combination with PCNr: Designation of credit card brand Please note the spelling! According to table of credit card brands! | |
CCExpiry | n6 | OC | In combination with PCNr: Expiry date of the credit card in the format YYYYMM (201706). | |
MaskedPan | an..19 | OC | Masked card number 6X4. If you want to receive the parameter MaskedPan, please contact Computop Helpdesk, which can activate the return. | |
CAVV | ans..40 | OC | In the case of 3-D Secure with Authentication Hosting (only 3D request without authorisation): Cardholder Authentication Validation Value: Contains the digital signature for authentication with the ACS of the card issuing bank. | |
ECI | n2 | OC | For 3-D Secure: ACS E-Commerce indicator: defines the security level of a credit card payment via different communication paths: MOTO, SSL, Verified by Visa etc. | |
DDD | a1 | C | for 3-D Secure Authentication Hosting: Y - fully authenticated (complete authentication done) N - not enrolled (checked, but Issuer does not participate) U - uneledgeble (technical error) A – attempt (card does not participate) B – bypass (bypass, only for Cardinal Commerce) | |
Type | ans..20 | C | For 3-D Secure in the response to URLSuccess and URLNotify: Abbreviation of payment type, e.g. SSL | |
Plain | ans..50 | O | A value to be set by the merchant to return some information unencrypted, e.g. the MID | |
Custom | ans..1024 | O | The merchant can submit several values separated by | which are returned unencrypted and separated by &. Custom=session=123|id=456 will change in the answer to Session=123&id=456 | |
CustomField[n] | ans..50 | O | Field that can be used individually by the merchant. Presently 14 fields from CustomField1 to CustomField14 are supported. |
General results parameters for URLNotify, URLSuccess and URLFailure
APACS: AIBMS, Barclaycard, Worldpay
Besides the general parameters described above for the credit card connection, APACS requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
TransID | an..12 | M | TransactionID which should be unique for each payment |
RefNr | an..12 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
AddrStreet | ans..30 | O | Street name of the customer (for AVS) |
AddrStreetNr | ans..30 | O | Street number of the customer (for AVS) |
AddrZip | ans..10 | O | Postcode of the customer (for AVS) |
AddrCity | ans..20 | O | Town/city of the customer (for AVS) |
AddrCountryCode | n3 | O | Customer's country code according to ISO-3166-1 numeric (3-digits) (for AVS) |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription If RTF then there is no AVS |
AccVerify | a3 | C | AccVerify is available for Barclays only. Allowed value: yes |
channel | a4 | O | Transaction type (MOTO, ECOM) which supersedes the configured default value. |
ContractID | n..8 | O | Further contract number between merchant and acquirer, which can be used to override the default VUNr |
Conditional additional parameters for Worldpay, MCC 6012 The merchant must have Merchant Category Code MCC 6012 and it must be a VISA transaction inside UK | |||
DateOfBirth | n8 | C | Customer’s date of birth |
LastName | ans..50 | C | Last name of the customer |
AccNr | an..22 | C | Account number of the customer |
AddrZip | ans..10 | C | Postcode of the customer |
Additional parameters for the credit card connection APACS via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the APACS connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
TransID | an..12 | M | TransactionID which should be unique for each payment |
RefNr | an..12 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
ApprovalCode | an6 | O | Authorising code of transaction |
CodeExt | an2 | O | extended response code from Barclaycard |
ErrorText | ans..80 | O | error text from Barclaycard |
cvcmatch | a1 | M | Result of CVC check (M = exact match, N = no match, U = card not checken) |
match | a1 | O | Result of address check, see separate manual Match parameters |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of APACS connection
BankSys: Worldline
Besides the general parameters described above for the credit card connection, BankSys requires the following additional parameters. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns10..99 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
Additional parameters for the credit card connection BankSys via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the BankSys connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns10..99 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
CodeExt | an2 | OC | only if configured: Error code from BankSys, if agreed with Computop Helpdesk |
ApprovalCode | an6 | OC | only if configured: Authorisation code form the authorisation response |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of BankSys connection
CAPN: American Express
Besides the general parameters described above for the credit card connection, CAPN requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
OrderDesc | ans..768 | M | Description of purchased goods, unit prices etc. |
AmountAuth | n..10 | M | Prepaid card: Actually authorised amount in the smallest currency unit. |
ContractID | n..8 | O | Further reference which can be used to retrieve the combination TerminalID/Contract partner number |
Contact data/Address verification (AVS) | |||
FirstName | ans..15 | O | First name of the customer (for AVS) |
LastName | ans..30 | O | Last name of the customer (for AVS) |
AddrStreet | ans..20 | O | Street name and street number, e.g. 18850~N~56~ST~#301 (for AVS) |
AddrZip | n..9 | O | Postcode (for AVS) |
ans..60 | O | Email address of the customer (for AVS) | |
Phone | n..10 | O | Phone number of the customer: for countries which do not use this system, please send the last 10 digits (for AVS) |
sdFirstName | ans..15 | O | First name in the delivery address (for AVS) |
sdLastName | ans..30 | O | Last name in the delivery address (for AVS) |
sdStreet | ans..50 | O | Street name and street number in th delivery address, e.g. 4102~N~289~ST~#301 (for AVS) |
sdZip | n..9 | O | Postcode in the delivery address (for AVS) |
sdCountryCode | n3 | O | Country code of the delivery address according to ISO-3166-1 numeric (3-digits) (for AVS) |
sdPhone | ans..10 | O | Phone number in the delivery address: for countries which do not use this system, please send the last 10 digits (for AVS) |
Additional parameters for the credit card connection CAPN via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the CAPN connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. It is returned only for EVO partners. |
CodeExt | n..10 | O | Error code from CAPN, if agreed with Computop Helpdesk |
ApprovalCode | n..6 | O | Approval code of the transaction |
TransactionID | ans..48 | O | Transaction ID from CAPN |
AmountAuth | n..10 | M | Prepaid card: Actually authorised amount in the smallest currency unit. |
Match | a1 | O | Total result of address check (American Express via CAPN): For possible values see manual Match parameters |
cvcmatch | a1 | C | Result of CVC check. Possible values: M = Match, N = No match, U = Issuer unable to process request |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of CAPN connection
Card Complete
Besides the general parameters described above for the credit card connection, Card Complete requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
TransID | an..25 | M | TransactionID which should be unique for each payment |
RefNr | an..25 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
ArticleList | ans..1024 | O | Article list, describes the individual items of the purchase goods. Structure: <Product name>;<Article number>;<Gross individual price>;<Quantity> <;> separates the fields of an article data set Data type (size): Product name = ans..10 Example: Product1;11111;100;11+Product2;22222;150;12 |
CustomerId | ans..30 | O | Customer information or email address of the customer |
Additional parameters for the credit card connection Card Complete via Paygate form
The following table gives the result parameters which the Computop Paygate transmits especially for the Card Complete connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
TransID | an..25 | M | TransactionID which should be unique for each payment |
RefNr | an..25 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
Amount | n..10 | O | Amount in the smallest currency unit (e.g. EUR Cent) If the actually authorised amount differs from the requested amount this will be returned. |
RequestID | an..64 | O | Unique ID assigned to the transaction. Must be saved because it is the reference for subsequent transactions. |
AID | n6 | O | AuthorisationID returned by Card Complete |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of Card Complete connection
CB2A: BNP Crossborder and BNP French Domestic
Credit card still must be valid at time of capture / refund. Therefore Paygate accepts credit cards when the card is at least 1 week valid before expire (e.g.: CC expire: 2020-03 authorizations possible until 2020-03-24, 23:59:59).
For credit card connection CB2A: BNP, besides the general parameters described above the following additional parameters are required. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | an12 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. Notes:
|
AccVerify | a3 | O | If AccVerify=Yes the card will be checked at the acquirer according to the acquirer’s interface description. The merchant has to submit only this parameter, the parameter "Amount" is optional. If "Amount" is used we replace the amount according to acquirer’s interface description. At payment always Amount=0 is stored. Allowed value: yes |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
ContractID | n..8 | O | Further reference in order to retrieve to combination TerminalID / Contract partner number |
Additional parameters for credit card connection CB2A: BNP via form
The following table gives the additional result parameters which Paygate transmits especially for the connection SIA: BNL to your URLSuccess, URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | an12 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
CodeExt | an2 | O | Error code of acquirer, if agreed with Computop Helpdesk |
Approvalcode | an..6 | O | Approval code / authorization code of acquirer, if agreed with Computop Helpdesk |
TerminalID | n..7 | O | TerminalId used for processing, if agreed with Computop Helpdesk |
VUNr | n..7 | O | Acquirer contract number of acquirer, if agreed with Computop Helpdesk |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of connection CB2A: BNP
Chase Paymentech
Besides the general parameters described above for the credit card connection, Chase Paymentech requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
TransID | ans..11 | O | TransactionID which should be unique for each payment |
RefNr | ns..22 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
ChDesc | an..21 | O | Text printed on the customer’s credit card bill alongside the payee. Possible formats: AN3*AN18 e.g. ABC*QWERTZ1234YX123ERT AN7*AN14 e.g. ABC1234*QWERTZ1234YX12 AN12*AN9 e.g. ABC1234GFERT*QEW2Y3FGT |
AccVerify | a3 | O | AccVerify is available for SDK (Stratus) only, not for ISO8583 (Tandem). If AccVerify=Yes the card will be checked at the acquirer according to the acquirer’s interface description. The merchant has to submit only this parameter, the parameter "Amount" is optional. If "Amount" is used we replace the amount according to acquirer’s interface description. At payment always Amount=0 is stored. Allowed value: yes |
Lodging | an2 | O | Number of planned days of hotel accommodation |
Textfeld1 | ans..12 | O | Merchant's phone number. If Textfeld1 is not submitted the value MerchantServicePhone from Madmin will be forwarded for the transaction. Possible formats: N3-N3-N4 e.g. 123-456-7890 N3-AN6 e.g. 123-456789 |
Contact data/Address verification (AVS) | |||
FirstName | ans..28 | O | First name of the customer (for AVS) FirstName and LastName are combined in a field with the format „First name + „ *“ + Last name and forwarded together. The total content is truncated after 28 characters. |
LastName | ans..28 | O | Last name of the customer (for AVS) FirstName and LastName are combined in a field with the format „First name + „ *“ + Last name and forwarded together. The total content is truncated after 28 characters. |
AddrStreet | ans..30 | O | Street name of the customer (for AVS) Please note that AddrStreet and AddrStreetNr together may have 29 characters maximum. AddrStreet and AddrStreetNr are combined with a space character between and forwarded together. The total content is truncated after 30 characters. |
AddrStreetNr | ans..30 | O | Street number of the customer (for AVS) Please note that AddrStreet and AddrStreetNr together may have 29 characters maximum. AddrStreet and AddrStreetNr are combined with a space character between and forwarded together. The total content is truncated after 30 characters. |
AddrStreet2 | ans..28 | O | further street name (for AVS) |
AddrZip | ans..10 | O | Postcode (for AVS) |
AddrCity | ans..20 | O | Town/city (for AVS) |
AddrState | a2 | O | Code of the customer’s Federal State (for AVS) |
AddrCountryCode | n3 | O | Country code according to ISO-3166-1 numeric (3-digits) (for AVS) |
Phone | ans..14 | O | Customer telephone number in format AAAEEENNNNXXXX, wherein AAA=prefix, EEE=area code, NNNN=number, XXXX=direct line |
PhoneType | enum | C | Reachability: D=Day; H=Home; N=Night, W=Work Mandatory if Phone exists |
sdFirstName | ans..25 | O | First name in the delivery address sdFirstName and sdLastName are combined in a field with the format „First name + „ *“ + Last name and forwarded together. The total content is truncated after 25 characters. |
sdLastName | ans..25 | O | Last name in the delivery address sdFirstName and sdLastName are combined in a field with the format „First name + „ *“ + Last name and forwarded together. The total content is truncated after 25 characters. |
sdStreet | ans..30 | O | Street name in the delivery address Please note that sdrStreet and sdStreetNr together may have 29 characters maximum. sdStreet and sdStreetNr are combined with a space character between and forwarded together. The total content is truncated after 30 characters. |
sdStreetNr | ans..30 | O | Street number in the delivery address Please note that sdStreet and sdStreetNr together may have 29 characters maximum. sdStreet and sdStreetNr are combined with a space character between and forwarded together. The total content is truncated after 30 characters. |
sdStreet2 | ans..35 | O | Address addition in the delivery address |
sdZIPCode | ans..10 | O | Postcode in the delivery address |
sdCity | ans..20 | O | Town/city in the delivery address |
sdState | a2 | O | State/country in the delivery address |
sdCountryCode | n3 | O | Country code of the delivery address according to ISO-3166-1, numeric 3-digits |
sdPhone | an..14 | O | Telephone number in the delivery address in format AAAEEENNNNXXXX, wherein AAA=prefix, EEE=area code, NNNN=number, XXXX=direct line |
sdPhoneType | enum | C | Reachability in the delivery address: D=Day; H=Home; N=Night, W=Work |
Additional parameters for the credit card connection Chase via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the Chase connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
TransID | ans..11 | O | TransactionID which should be unique for each payment |
RefNr | ns..22 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
CodeExt | n..10 | O | Original error code from Chase (if an error occurs), if agreed with Computop Helpdesk |
Match | a1 | O | Total result of an address verification: For possible values see manual Match parameters |
AmexTID | n..15 | C | The TID value is assigned by the authorisation system of American Express. The American Express authorisation system assigns a unique tracking number with which the accuracy of the authorisation data in the calculation data record is determined. |
ApprovalCode | an6 | O | Approval code, if configured. Is issued by the bank or service facility. To be saved and supplied with the deposit business. |
CountryStatus | enum | O | Status identification of the card-issuing country. Valid values: A – acceptable; B – blocked; S - suspect |
RecurringPaymentAdviseCode | n2 | O | Payment recommendation code. Valid values: 01 – new account information available. Call up new account information. 02 – Try again later. Transaction will be reversed in 72 hours. 03 – Do not retry. Request another payment method from the customer. 21 – Do not retry. The issuer has blocked repeated payment transactions. " " - empty |
AuthDate | n6 | O | Date of originally approved transaction. Format: YYMMDD |
cvcMatch | a..1 | C | Result of CVC check. Possible values: M = Match |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of Chase connection
Clearhaus
In order to activate Clearhaus for credit card processing in Paygate, there must exist a merchant account with Clearhaus. The credentials (Clearhaus Merchant API Key) must be stored within Paygate. For merchant accounts which shall be used for paying out gambling winnings additionally extended credits must be activated within Paygate (CreditEx, OCT).
Besides the general parameters described above for the credit card connection, Clearhaus requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
TransID | ans..30 | M | TransactionID which should be unique for each payment (only printable ASCII characters from 0x20 to 0x7E) |
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. Only printable ASCII characters from 0x20 to 0x7E. |
CHDesc | ans..22 | O | Text printed on the customer’s credit card bill. Only printable ASCII characters from 0x20 to 0x7E. |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
Additional parameters for the credit card connection Clearhaus via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the Clearhaus connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
TransID | ans..30 | M | TransactionID which should be unique for each payment (only printable ASCII characters from 0x20 to 0x7E) |
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. Only printable ASCII characters from 0x20 to 0x7E. |
Amount | n..10 | O | Amount in the smallest currency unit (e.g. EUR Cent) If the actually authorised amount differs from the requested amount this will be returned. |
CodeExt | n5 | O | Only if configured: External error code (downstream system) |
ErrorText | ans..128 | O | Detailed Clearhaus error message. Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk |
TransactionID | ans36 | O | Transaction number from Clearhaus |
TokenExt | ans36 | O | For recurring payments (RTF=I) the Token is transmitted for referencing the credit card data. |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of Clearhaus connection
Credorax
Besides the general parameters described above for the credit card connection, Credorax requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
TransID | ans..40 | M | TransactionID which should be unique for each payment |
RefNr | ns..30 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
OrderDesc | ans..64 | M | Description of purchased goods, unit prices etc. |
CHDesc | ans..34 | O | Text printed on the customer’s credit card bill. This function must be enabled by Credorax and have the following structure. 1) merchant DBA name (up to 20 characters) e.g. Computop*Test This value can be alternatively permanently archived by Computop Helpdesk |
AccVerify | a3 | O | If AccVerify=Yes the card will be checked at the acquirer according to the acquirer’s interface description. The merchant has to submit only this parameter, the parameter "Amount" is optional. If "Amount" is used we replace the amount according to acquirer’s interface description. At payment always Amount=0 is stored. Allowed value: yes |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
InvoiceNr | an..15 | C | Invoice number. Mandatory for initial payment of a new subscription (RTF=I) or for generating a PCN |
TokenExt | an..32 | OC | In connection with RTF=R the Token must be transmitted for referencing the credit card data. |
Contact data/Address verification (AVS) | |||
CreditCardHolder | a..50 | O | Name of the card holder |
AddrStreet | ans..50 | O | Street name (for AVS) |
AddrStreetNr | n..16 | O | Street number (for AVS) |
AddrZip | ans..9 | C | Postcode. Mandatory for initial payment of a new subscription (RTF=I) or for generating a PCN/TokenExt. (for AVS) |
AddrCity | ans..30 | O | Town |
AddrState | a2 | O | Federal State, two-digit code according to ISO 3166 |
AddrCountryCode | a2/a3 | C | Country code according to ISO-3166-1, alphanumeric 2 or 3 chars Mandatory for initial payment of a new subscription (RTF=I) or for generating a PCN/TokenExt. |
Phone | ns..32 | O | Telephone number |
ans..64 | C | E-mail address. Mandatory for initial payment of a new subscription (RTF=I) or for generating a PCN/TokenExt and if CFT (Credit Funds Transfer) is used. | |
UK 6012 Merchant Mandatory for UK merchants with MCC 6012 | |||
DateOfBirth | n8 | M | Date of birth of the customer in format YYYYMMDD |
AccNr | n..10 | M | Masked PAN, account number or customer number |
AddrZip | ans..6 | M | Postcode of the customer |
LastName | ans..6 | M | The first six characters of the last name of the customer |
Additional parameters for the credit card connection Credorax via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the Card Complete connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
TransID | ans..40 | M | TransactionID which should be unique for each payment |
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
Amount | n..10 | O | Amount in the smallest currency unit (e.g. EUR Cent) If the actually authorised amount differs from the requested amount this will be returned. |
ErrorText | ans..128 | O | Detailed Credorax error message. Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk |
TokenExt | an..32 | O | For recurring payments (RTF=I) the Token is transmitted for referencing the credit card data. |
TransactionID | an..32 | O | Transaction number from Credorax |
Match | a1 | O | Result of address check, see separate manual Match parameters |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of Credorax connection
Ecom Processing (ECPCC)
In order to activate ECPCC for credit card processing in Paygate, there must exist a merchant account with Ecom. The credentials (Username, password, Terminaltoken) must be stored within Paygate. Besides there must be specified if this is a test or live system. Depending on the configuration within Paygate the integration or live environment from Ecom is activated. Furthermore the submission type ECOM or Moto must be selected. For merchant accounts which shall be used for paying out gambling winnings additionally extended credits must be activated within Paygate (CreditEx, OCT). Additionally the field Merchant Category Code (MCC) is read out, which must be configured with the merchant date (profile settings). If value 7995 is stored in this place all transactions are marked with the flag „Gaming“.
ECPCC requires following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
IPAddr | ans..15 | M | Customer´s IP address |
OrderDesc | ans..255 | O | Description of purchased goods, unit prices etc. |
CreditCardHolder | ans..255 | M | Name of the card holder |
DateOfBirth | n8 | O | Date of birth of the customer in format YYYYMMDD |
ans..64 | M | Email address of the customer | |
Phone | n..32 | O | Customer’s phone number |
FirstName | ans..255 | M | First name of the customer |
LastName | ans..255 | M | Last name of the customer |
AddrStreet | ans..255 | O | Street name |
AddressAddition | ans..255 | O | Address c/o |
AddrZip | an..9 | O | Postcode |
AddrCity | ans..255 | O | City |
AddrState | a2 | O | Code of the customer’s Federal State |
AddrCountryCode | a2 | M | Country code according to ISO-3166-1, alphanumeric 2 chars |
sdFirstName | ans..255 | O | First name in the delivery address |
sdLastName | ans..255 | O | Surname in the delivery address |
sdStreet | ans..255 | O | Street name in the delivery address |
sdAddressAddition | ans..255 | O | Address addition in the delivery address |
sdZIPCode | an..9 | O | Postcode in the delivery address |
sdCity | ans..255 | O | Town/city in the delivery address |
sdState | a2 | O | Code of Federal State in the delivery address |
sdCountryCode | a2 | O | Country code of delivery address according to ISO-3166-1, alphanumeric 2 chars |
CHDesc | an..39 | O | Text printed on the customer’s credit card bill alongside the payee. Format: merchant_name*merchant_city (AN..25*AN..13) |
RTF | a1 | O | for repeat payments (subscriptions): I = initial payment of a new subscription, R = recurring payment |
Additional parameters for the credit card connection ECPCC via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the ECPCC connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
CodeExt | n2 | O | Extended response code from Ecom Processing |
ErrorText | ans..255 | O | Detailed error message from Ecom Processing Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk |
Match | a1 | O | Result of address check, see separate manual Match parameters |
TokenExt | an..36 | O | For recurring payments (RTF=I) the Token is transmitted for referencing the credit card data. |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of ECPCC connection
EVOxml
Besides the general parameters described above for the credit card connection, EVOxml requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
CustomerID | an..20 | O | Customer number: Number to identify the customer |
RefNr | ans..20 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. (only capitals allowed) |
AccVerify | a3 | O | If AccVerify=Yes the card will be checked at the acquirer according to the acquirer’s interface description. The merchant has to submit only this parameter, the parameter "Amount" is optional. If "Amount" is used we replace the amount according to acquirer’s interface description. At payment always Amount=0 is stored. Allowed value: yes |
OrderDesc | an..30 | O | Description of purchased goods, unit prices etc. |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
ChDesc | an..30 | O | Dynamic text component of the posting text of credit card transactions |
Contact data | |||
FirstName | ans..30 | O | First name of the customer (for Fraud Screening optional) |
LastName | ans..30 | O | Last name of the customer (for Fraud Screening optional) |
AddrStreet | an..46 | O | Street name (for Fraud Screening mandatory) |
AddrStreetNr | an..35 | O | Street number (for Fraud Screening optional) |
AddressAddition | ans..6 | O | Address addition (for Fraud Screening optional) |
AddrPOBox | n..35 | O | Post office box (for Fraud Screening optional) |
AddrZip | an..9 | O | Postcode (for Fraud Screening mandatory) |
AddrCity | an..40 | O | Town/city (for Fraud Screening mandatory) |
AddrDistrict | ans..40 | O | County/region (for Fraud Screening optional) |
AddrState | a2 | O | Code of Federl State of the customer (for Fraud Screening optional) |
AddrCountryCode | a2 | M | Country code according to ISO-3166-1, alphanumeric 2 chars (for Fraud Screening optional) |
an..80 | O | Email address of the customer (for Fraud Screening mandatory) | |
Phone | ans..20 | O | Phone number of the customer (for Fraud Screening mandatory) |
MiddleName | ans..30 | O | Middle name |
Salutation | ans..10 | O | Salutation e.g. Mr or Mrs, compulsory field for fraud screening |
Title | ans..20 | O | Title, e.g. Dr. or Prof. |
CompanyOrPerson | a1 | O | F=Firm, P=Person, compulsory field for fraud screening |
DateOfBirth | n8 | O | Date of birth in the format YYYYMMDD |
Gender | a1 | O | Gender: <m> male or <f> female |
WorkPhone | ans..20 | O | Telephone number at the work place |
Fax | ans..20 | O | Fax number |
ans..80 | O | E-mail address | |
NewCustomer | ans..5 | O | New customer: Yes or no |
DateOfRegistration | ans8 | O | Registration date in the format YYYYMMDD |
SocialSecurityNumber | ans..9 | O | Social security number |
DrivingLicenceNumber | ans..37 | O | Driver's licence number |
Delivery data | |||
sdFirstName | an..30 | O | First name in the delivery address |
sdLastName | ans..25 | O | Last name in the delivery address |
sdMiddleName | ans..30 | O | Middle name in the delivery address |
sdStreet | an..46 | O | Street name in the delivery address |
sdStreet2 | an..46 | O | Address addition in the delivery address |
sdZip | an..9 | O | Postcode in the delivery address |
sdZIPCode | an..9 | O | Postcode in the delivery address |
sdCity | an..40 | O | Town/city in the delivery address |
sdState | a2 | O | State/country in the delivery address |
sdCountryCode | a2 | O | Country code of delivery address according to ISO-3166-1, alphanumeric 2 chars |
sdeMail | an..80 | O | E-mail address of the delivery address |
sdPhone | ans..20 | O | Telephone number in the delivery address |
sdWorkPhone | ans..20 | O | Second telephone number / telephone number at the work place in the delivery address |
Parameters for AVS (Address verification) | |||
CreditCardHolder | ans..60 | O | Name of the card holder (for AVS mandatory) |
chStreet | an..46 | C | Street name of the credit card holder (for AVS mandatory) |
chHouseNumber | an..35 | O | Street number of the credit card holder (for AVS optional) |
chPOBox | an..9 | O | Post office box of the credit card holder (for AVS mandatory) |
chCoField | an..40 | O | Bulk recipient name of the credit card holder (for AVS optional) |
chZipCode | an..9 | O | Postcode of the credit card holder (for AVS mandatory) |
chCity | an..40 | O | Town/city of the credit card holder (for AVS mandatory) |
chDistrict | an..40 | O | Urban district of the credit card holder (for AVS optional) |
chState | an2 | O | 2-digit code of the Federal State of the credit card holder (only for USA) (for AVS optional) |
chCountryCode | a2 | O | Country code of the credit card holder in the format ISO-3166-1, alphanumeric 2-digits (for AVS mandatory) |
All following parameters refers to the bought flight ticket | |||
TicketNr | an..15 | C | Reference to the bought flight ticket |
PassengerName | an..49 | C | Name of the flight passenger |
FlightDate | an..5 | C | Flight date. Format: DDMMM (e.g. 15MAY, 01NOV, 30JUN) |
Origin1 | an..5 | C | International code for the departure airport |
Origin2 | an..5 | C | International code for the departure airport |
Origin3 | an..5 | C | International code for the departure airport |
Origin4 | an..5 | C | International code for the departure airport |
Destination1 | an..5 | C | International code for the arrival airport |
Destination2 | an..5 | C | International code for the arrival airport |
Destination3 | an..5 | C | International code for the arrival airport |
Destination4 | an..5 | C | International code for the arrival airport |
Carrier1 | an..4 | C | International code for the airline company |
Carrier2 | an..4 | C | International code for the airline company |
Carrier3 | an..4 | C | International code for the airline company |
Carrier4 | an..4 | C | International code for the airline company |
fsSkip | an..4 | O | „YES“ = Skip the Fraud Screening. Overrides merchant configuration |
fsIgnore | an..6 | O | „YES“ = Ignore the Fraud Screening result. Overrides merchant configuration |
fsReject | a1 | O | Call up control of Fraud Screening C: Accept transaction in the event of CHALLENGE E: Accept transaction in the event of ERROR |
avsSkip | an..4 | C | „YES“ = Skip AVS |
avsIgnore | an..6 | C | „YES“ = Ignore AVS result |
avsReject | a..7 | C | List of result codes which reject the transaction NI: Decline only if postcode and street do not match ABNI: Decline: Street does not match or street and postcode do not match. WZPNI: Decline: Postcode does not match or street and postcode do not match. ABWZPNI: Decline: At least one of the elements AddrStreet and AddrZipCode does not match. |
Additional parameters for the credit card connection EVOxml via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the EVOxml connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ans..20 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. (only capitals allowed) |
ErrorText | ans..128 | O | Error text from EVOxml, if agreed with Computop Helpdesk |
FSMatch | an..9 | O | ACCEPT: Accept transaction, low risk DENY: Deny transaction, high risk CHALLENGE: Check transaction additionally, risk not clear ERROR: Internal error |
AVMatch | a1 | O | Result of address check, see separate manual Match parameters |
TrxTime | an21 | M | Time stamp of transaction in the format dd.MM.yyyy HH:mm:ssff |
AQ | an3 | M | Acquirer shortcode |
AuthCode | ans..6 | M | Acquiring Bank's authorisation code |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of EVOxml connection
GICC: Concardis, Payone, EVO Payments, American Express, Elavon, InterCard, SIX Payment Service, Paynetics
Besides the general parameters described above for the credit card connection, GICC requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ans..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. If RefNr is not submitted, the value of TransID will be used. For InterCard only alphanumeric characters are allowed, format an..30. |
OrderDesc | ans..768 | M | Description of purchased goods, unit prices etc. |
CreditCardHolder | ans..60 | O | Name of the card holder |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
ChDesc | an..30 | O | Text printed on the customer’s credit card bill alongside the payee |
AccVerify | a3 | O | AccVerify is available for AirPlus, American Express, Payone, Concardis, Diners, DZ Bank, EVO, Fiducia, Intercard, Paynetics, POS Transact, SIX and WGZ Bank only. If AccVerify=Yes the card will be checked at the acquirer according to the acquirer’s interface description. The merchant has to submit only this parameter, the parameter "Amount" is optional. If "Amount" is used we replace the amount according to acquirer’s interface description. At payment always Amount=0 is stored. Allowed value: yes |
CountryCode | a2 | O | Card holder information: Country |
Textfeld1 | ans..30 | O | Card holder information: Name |
Textfeld2 | ans..30 | O | Card holder information: City |
ContractID | n..8 | O | Further reference which can be used to retrieve the combination TerminalID/Contract partner number |
Cryptocurrency | a..3 | C | Used to flag a cryptocurrency purchase. Possible value "Yes". Notice: Possible only for credit card brands VISA, MasterCard, Maestro. |
Contact data/Address verification (AVS) | |||
AddrStreet | a..50 | O | Street name (for AVS) |
AddrStreetNr | ans..15 | O | Street number for verification by American Express (for AVS) |
AddrZip | n..10 | O | Postcode (for AVS) |
AddrCity | a..40 | O | Town/city (for AVS) |
AddrCountryCode | a2/a3 | M | Country code according to ISO-3166-1: it can be transmitted with two or three digits optionally – Format a2 / a3 (for AVS) |
AddrStreet2 | a..32 | O | Second street name (for AVS) |
AddrStreetNr2 | ans..5 | O | Second street number (for AVS) |
AddrZip2 | n..5 | O | Second postcode (for AVS) |
AddrCity2 | a..32 | O | Second town/city (for AVS) |
AddrChoice | n1 | O | If you transmit 2 street numbers and postcodes, the AddrChoice parameter will determine which address is checked. AddrChoice=1 checks the first address, AddrChoice=2 the second address. (for AVS) |
Additional parameters for the credit card connection GICC via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the GICC connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
Match | a1 | O | Total result of address check (American Express via GICC): For possible values see manual Match parameters |
TerminalID | an8 | O | ID of the terminal |
TransactionID | an..22 | C | If transaction is approved and value returned by the acquirer: Transaction identifier returned upon approval. It must be submitted unaltered when subsequent authorization requests are related to a previous original request where this value is returned. |
VUNr | n5..12 | C | Contract partner number |
TrxTime | an21 | C | Time stamp of transaction in the format dd.MM.yyyy HH:mm:ssff |
VU | n.. | C | Contract partner number. The length depens on the acquirer. If you want to have the acquirer contract partner number within the reponse, please contact Computop Helpdesk, which can activate this response function for you. |
AQ | an3 | C | Acquirer shortcode. If you want to have the acquirer name within the reponse, please contact Computop Helpdesk, which can activate this response function for you. Possible values: AMEX=AME, Elavon=CKS, Concardis=CON, Payone=BUS, Paynetics=PNS, Six Payment=SIX, EVO Payments=EVO, Intercard=INT |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of GICC connection
GMO-PG
Besides the general parameters described above for the credit card connection, GMO-PG requires the following additional parameters. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
TransID | an..27 | M | Transaction ID up to 27 characters. Must be unique for each payment. |
TaxAmount | n..10 | O | Tax amount of the order Important Note: During processing this amount will not be summed up with the field Amount. If you want to use partial captures or partical credits, please do not submit this parameter during authorisation. Please contact Computop Helpdesk for further information. |
PayType | n1 | C | Mandatory for transactions, not necessary for account verification. Possible values: 1: Single payment 2: Installment payment 3: Bonus single payment 4: Bonus installment payment 5: revolving |
PayTimes | n2 | C | Number of payments. Mandatory for installment payment and Bonus installment payment (PayType =2 or 4) |
Additional parameters for the credit card connection GMO-PG via Paygate form
Heartland
Besides the general parameters described above for the credit card connection, Heartland requires the following additional parameters. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
Contact data/Address verification (AVS) | |||
FirstName | ans..100 | O | First name of the customer |
LastName | ans..100 | O | Last name of the customer |
AddrStreet | ans..128 | O | Street name and house number |
AddrZip | ans..20 | O | Postcode |
AddrCity | ans..50 | O | City |
AddrState | a2 | O | Code of the customer’s Federal State |
AddrCountryCode | a2/a3 | M | Country code according to ISO-3166-1, alphanumeric 2 or 3 chars |
Additional parameters for the credit card connection Heartland via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the Heartland connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
ErrorText | ans..128 | O | Error text from the downstream system, only when its response is discussed with Computop Helpdesk (configured in MAT). |
CodeExt | ans..10 | O | Only if configured: External error code (downstream system) |
ApprovalCode | an6 | O | External approval code (downstream system). Exists only if authorisation was successful. |
HpsTransactionID | n10 | O | TransaktionsID issued by Heartland: returned if authorisation is okay |
HpsReferenceNumber | n12 | O | ReferenceNumber issued by Heartland: returned if authorisation is okay |
Match | a1 | O | Result of address check: Parameter is returned depending on merchant configuration as simplified Match parameter or as returned by Heartland |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of Heartland connection
iCard
Besides the general parameters described above for the credit card connection, iCard requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
CustomerID | ans..255 | O | Customer access data on the merchant’s checkout page (email, ID, telephone number or name) |
OrderDesc | ans..768 | O | Description of purchased goods, unit prices etc. |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
Additional parameters for the credit card connection iCard via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the iCard connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
ErrorText | ans.. | OC | Error text from iCard, if agreed with Computop Helpdesk. Is returned only if ResponseExtended=Yes is configured for that merchant. |
CodeExt | n..3 | OC | Error code from iCard, if agreed with Computop Helpdesk. Is returned only if ResponseExtended=Yes is configured for that merchant. |
ApprovalCode | ans..6 | O | ApprovalCode or Authorisation code returned by card issuer |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of iCard connection
Kalixa
Besides the general parameters described above for the credit card connection, Kalixa requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
IPAddr | ans..15 | M | Customer´s IP address |
BrowserSessionID | ans..64 | M | Customer´s Session ID |
CreditCardHolder | ans..100 | M | Name of the card holder |
CustomerID | an..20 | M | Customer number: Number to identify the customer |
User data (if available all parameters need to be enclosed) | |||
Name | ans..100 | C | User name of the customer |
FirstName | ans..100 | C | First name of the customer |
LastName | ans..100 | C | Last name of the customer |
ans..64 | C | Email address of the customer | |
Language | a2 | C | Language of the customer according to ISO, alphanumeric 2-digits |
Delivery data (if available all parameters need to be enclosed) | |||
sdFirstName | ans..100 | C | First name in the delivery address |
sdLastName | ans..100 | C | Surname in the delivery address |
sdStreet | ans..200 | C | Street name in the delivery address |
sdStreetNr | ans..5 | C | Street number in the delivery address |
sdZIPCode | an..20 | C | Postcode in the delivery address |
sdCity | ans..40 | C | Town/city in the delivery address |
sdState | a2 | C | Code of Federal State in the delivery address |
sdCountryCode | a2 | C | Country code of delivery address according to ISO-3166-1, alphanumeric 2 chars |
Address verification (AVS) | |||
AddrStreet | ans..200 | O | Street name (for AVS) |
AddrZip | an..20 | O | Postcode (for AVS) |
AddrCountryCode | a2 | O | Country code according to ISO-3166-1 alphanumeric (2-digits) (for AVS) |
Additional parameters for the credit card connection Kalixa via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the Kalixa connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
CodeExt | n2 | O | Extended response code from Kalixa |
ErrorText | ans..255 | O | Detailed Kalixa error message. Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of Kalixa connection
MasaPay
Besides the general parameters described above for the credit card connection, MasaPay requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
Language | a2 | O | Accepted language code at MasaPay: "CN" Chinese, "EN" English, "FR" French, "DE" German, "ES" Spanish, "IT" Italian, "JA" Japanese, "RU" Russian, "KO” Korean, "TH" Thai, "SV" Swedish. No details means the language is EN. If the trasferred language is not supported by MasaPay, EN is forwarded. |
OrderDesc | ans..768 | M | Description of purchased goods, unit prices etc. The special characters “#”, “&”, “%” and “+” are not permitted here. |
ArticleList | ans..2000 | M | Article list, describes the individual items of the purchase goods. Structure: <Product name>;<Article number>;<Gross individual price>;<Quantity>;<Article web link> (<Article web link> is optional) <;> separates the fields of an article data set Data type (size): Product name = ans..10 Example: Produkt1;11111;100;11; https://www.books.com/book1.bok+Produkt2;22222;150;12; https://www.books.com/book2.bok |
User data | |||
CreditCardHolder | ans..100 | O | Name of the credit card holder |
bdFirstName | ans..50 | M | First name in the invoicing address |
bdLastName | ans..50 | M | Last name in the invoicing address |
bdStreet | ans..128 | M | Street name of the invoicing address |
bdStreetNr | ans..10 | M | Street number of the invoicing address |
bdStreet2 | ans..50 | O | Address addition in the invoicing address |
bdCompany | ans..200 | O | Company name in the invoicing address |
bdZip | ans..20 | M | Postcode of the invoicing address |
bdCity | ans..20 | M | City in invoicing address |
bdState | ans..20 | M | Code of Federal State in the invoicing address |
bdCountryCode | a2 | M | Country code of invoicing address according to ISO-3166-1, alphanumeric 2 chars |
bdEmail | ans..100 | M | Email address of the customer |
bdPhone | ans..20 | M | Customer’s phone number |
bdMobileNr | ans..20 | O | Customer’s mobile telephone number |
Delivery data: If delivery data are different than invoicing data the following parameters (at least all OC parameters) should be transferred because otherwise the invoicing data are used for delivery data | |||
sdFirstName | ans..50 | OC | First name in the delivery address |
sdLastName | ans..50 | OC | Surname in the delivery address |
sdStreet | ans..128 | OC | Street name in the delivery address |
sdStreetNr | ans..10 | OC | Street number in the delivery address |
sdStreet2 | ans..50 | O | Address addition in the delivery address |
sdCompany | ans..200 | O | Company name in the delivery address |
sdZIP | ans..20 | OC | Postcode in the delivery address |
sdCity | ans..20 | OC | Town/city in the delivery address |
sdState | ans..20 | OC | Code of Federal State in the delivery address |
sdCountryCode | a2 | OC | Country code of delivery address according to ISO-3166-1, alphanumeric 2 chars |
sdEmail | ans..100 | OC | Email address in the delivery address |
sdPhone | ans..20 | OC | Phone number in the delivery address |
Risk control: If customer is registered at the merchant, following registration parameters should be transferred | |||
ans..60 | O | Email address of the customer at merchant’s registration | |
CustomerID | ans..20 | O | Customer ID or customer number |
Channel | a4 | O | Terminal used at time of order (MOTO: Mobile phone, ECOM: PC), this overrides the configured default value. |
IPAddr | ns..15 | O | Fraud prevention: IP address at time of order |
RegistrationDate | ans19 | O | Date and time when the customer has created the account |
RegistrationIP | ns..15 | O | Registered customer´s IP address |
RegistrationDevice | a4 | O | Terminal used at registration (MOTO; Mobile phone, ECOM: PC); if not specified the value will be taken from parameter Channel. |
Additional parameters for the credit card connection MasaPay via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the MasaPay connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
CodeExt | ans..10 | O | Error code from MasaPay |
ErrorText | ans..128 | O | Detailed MasaPay error message. Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of MasaPay connection
Omnipay: EMS payment solutions, Global Payments, Paysquare, Payvision
Besides the general parameters described above for the credit card connection, Omnipay (Bancontact) requires the following additional parameters. An authorisation with 3-D Secure is possible.
Computop Paygate is the preferred PSP with EMS payment solutions. Paygate has now been opened for the transfer of “3D” parameters. For this the respective merchant first needs to configure to “External MPI” on Computop. Paygate then accepts the parameters and uses them in communication with downstream systems.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..15 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
OrderDesc | ans..768 | O | Description of purchased goods, unit prices etc. |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
ChDesc | an..30 | O | Text printed on the customer’s credit card bill alongside the payee |
AccVerify | a3 | O | If AccVerify=Yes the card will be checked at the acquirer according to the acquirer’s interface description. The merchant has to submit only this parameter, the parameter "Amount" is optional. If "Amount" is used we replace the amount according to acquirer’s interface description. At payment always Amount=0 is stored. Allowed value: yes |
FirstName | as..25 | OC | In combination with LastName: First name of the customer for OCT (CFT) transactions |
LastName | as..25 | OC | In combination with FirstName: Last name of the customer for OCT (CFT) transactions |
Cryptocurrency | a..3 | C | Used to flag a cryptocurrency purchase. Possible value "Yes". Notice: Possible only for credit card brands VISA, MasterCard, Maestro. |
Contact data/Address verification (AVS) | |||
AddrStreet | a..50 | O | Street name (for AVS) |
AddrStreetNr | ans..15 | O | Street number for verification by American Express (for AVS) |
AddrZip | n..10 | O | Postcode (for AVS) |
AddrCity | a..40 | O | Town/city (for AVS) |
AddrState | a2 | O | Code of the customer’s Federal State (for AVS) |
AddrStreet2 | a..32 | O | Second street name (for AVS) |
AddrStreetNr2 | ans..5 | O | Second street number (for AVS) |
AddrZip2 | n..5 | O | Second postcode (for AVS) |
AddrCity2 | a..32 | O | Second town/city (for AVS) |
AddrChoice | n1 | O | If you transmit 2 street numbers and postcodes, the AddrChoice parameter will determine which address is checked. AddrChoice=1 checks the first address, AddrChoice=2 the second address. (for AVS) |
Parameters for extension External MPI via EMS (only if configured with Computop Helpdesk) | |||
Authresult | a1 | M | Status from VERes or rather PARes Y = Fully Authenticated A = Attempt N = Not enrolled |
CAVV | ans..32 | C | BASE64 coded Cardholder Authentication Verification Value Permitted special characters are + / = |
ACSIDHEX | hex40 | C | VISA transactions with Authresult Y / A Bancontact transactions with Authresult Y CAUTION! Bancontact transactions are accepted only with Authresult Y! |
XID3DHEX | hex40 | C | Hexadecimal XID VISA transactions with Authresult Y / A |
ECI3D | n2 | M | 01 = Attempt MasterCard / Maestro 02 = Fully Authenticated MasterCard / Maestro / Bancontact 05 = Fully Authenticated VISA 06 = Attempt VISA |
Additional PayFac parameters for acquirer Payvision | |||
SubMID | ans..15 | O | SubMerchantID assigned from the Payment Facilitator and provided in the request to identify its sub-merchants during transaction flow |
SubMIDName | ans..22 | O | Name of the SubMerchantID |
SubMIDAddrStreet | ans..38 | O | Street of the SubMerchantID |
SubMIDAddrCity | ans..13 | O | Town/city of the SubMerchantID |
SubMIDAddrZip | ans..10 | O | Postcode of the SubMerchantID |
SubMIDAddrState | ans3 | O | Federal State of the SubMerchantID |
SubMIDAddrCountryCode | a2 | O | Country code of the SubMerchantID according to ISO-3166-1, alphanumeric 2 chars |
Additional parameters for the credit card connection Omnipay via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the Omnipay connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..15 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
Match | a1 | O | Total result of an address check (Global Payments): For possible values see manual Match parameters |
IBAN | ans..34 | C | International Bank Account Number: Mandatory for card brand Bancontact via Omnipay, otherwise not used |
BIC | ans..11 | C | Bank Identifier Code: Mandatory for card brand Bancontact via Omnipay, otherwise not used |
AppCodeTel | n6 | C | for 3-D Secure: Telephone authorisation code |
CAVV | ans..40 | C | for 3-D Secure Authentication Hosting: ACSVerificationID/ ACSVerificationIDHex |
ACSXID | ans..28 | C | for 3-D Secure Authentication Hosting: HexXID |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of Omnipay connection
PayPal
Besides the general parameters described above for the credit card connection, PayPalCC requires the following additional parameters. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
ChDesc | ans..256 | O | Text printed on the customer’s credit card bill alongside the payee |
ApprovalCode | an6 | O | External approval code (downstream system). Exists only if authorisation was successful. |
CodeExt | ans..10 | O | Only if configured: External error code (downstream system) |
Contact data | |||
sdFirstName | ans..100 | M | First name in the delivery address |
sdLastName | ans..100 | M | Last name in the delivery address |
sdMiddleName | ans..30 | O | Middle name in the delivery address |
sdStreet | ans..128 | M | Street name in the delivery address |
sdStreetNr | ans..10 | M | Street number in the delivery address |
sdStreet2 | ans..50 | O | Address addition in the delivery address |
sdZIPCode | ans..20 | M | Postcode in the delivery address |
sdCity | ans..50 | M | Town/city in the delivery address |
sdState | ans..50 | O | State/country in the delivery address |
sdCountryCode | a2 | M | Country code of delivery address according to ISO-3166-1, alphanumeric 2 chars |
sdeMail | ans..254 | M | E-mail address of the delivery address |
sdPhone | ans..40 | O | Telephone number in the delivery address |
sdWorkPhone | ans..40 | O | Second telephone number / telephone number at the work place in the delivery address |
bdFirstName | ans..100 | M | First name in the invoicing address |
bdLastName | ans..100 | M | Last name in the invoicing address |
bdMiddleName | ans..30 | O | Middle name in the invoicing address |
bdStreet | ans..128 | M | Street name in the invoicing address (for AVS) |
bdStreetNr | ans..10 | M | Street number in the invoicing address (for AVS) |
bdStreet2 | ans..50 | O | Address addition in the billing address |
bdZIPCode | ans..20 | M | Postcode in the invoicing address (for AVS) |
bdCity | ans..50 | M | Town/city in the invoicing address |
bdState | ans..50 | O | State/country in the invoicing address |
bdCountryCode | a2 | M | Country code of invoicing address according to ISO-3166-1, alphanumeric 2 chars |
bdeMail | ans..254 | M | Email address in the billing address |
bdPhone | ans..40 | O | Phone number in the invoicing address |
bdWorkPhone | ans..40 | O | Second telephone number / telephone number at the work place in the invoicing address |
bdFax | ans..20 | O | Telefax number of the invoicing address |
Additional parameters for the credit card connection PayPalCC via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the PayPalCC connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
ErrorText | ans..128 | O | Error text from the downstream system, only when its response is discussed with Computop Helpdesk (configured in MAT). |
Pnref | ans..12 | M | Unique transaction ID given by PayPal for identifying a PayPal transaction for invoicing and reporting purposes. |
Match | a1 | O | Total result of an address verification: For possible values see manual Match parameters |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of PayPalCC connection
PPRO
Besides the general parameters described above for the credit card connection, PPRO requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
OrderDesc | ans..768 | M | Description of purchased goods, unit prices etc. |
CreditCardHolder | ans..60 | O | Name of the card holder |
SellingPoint | ans..50 | O | Selling point |
Service | ans..50 | O | products or service sold |
Channel | ans..64 | O | configuration channel of the PPRO contract (account and ContractID are stored in the system). If it exists, it may overwrite channels stored in the system |
AddrCountryCode | a2 | M | Country code according to ISO-3166-1, alphanumeric 2 chars |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
ChDesc | ans..256 | O | Text printed on the customer’s credit card bill alongside the payee |
Additional parameters for the credit card connection PPRO via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the PPRO connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
PaymentPurpose | ans..26 | M | Purpose of payment |
PaymentGuarantee | a..12 | M | Payment guarantee NONE= no payment guarantee, VALIDATED= customer account valid, but no payment guarantee, FULL= payment guarantee Notice: This parameter is only returned if the Status=OK. |
ErrorText | ans..128 | M | Detailed PPRO error message. Notice: Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk |
Status | a..50 | M | OK or AUTHORIZED (URLSuccess) as well as FAILED (URLFailure) For PPRO there is also AUTHORIZE_REQUEST. |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of PPRO connection
RBI
Besides the general parameters described above for the credit card connection, RBI requires the following additional parameters. An authoriszation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
TransID | ans..20 | M | TransactionID which should be unique for each payment |
RefNr | ans..20 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. The format pattern is: [A-Za-z0-9.] |
OrderDesc | ans..512 | M | Description of purchased goods, unit prices etc. |
CountryCode | a3 | O | On the basis of CountryCode the respective account information like RBI MerchantID and TerminalID can be retrieved at Computop |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
Additional parameters for the credit card connection RBI via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the RBI connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
TransID | ans..20 | M | TransactionID which should be unique for each payment |
RefNr | ns..20 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
ErrorText | ans..128 | O | Detailed RBI error message. Notice: Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of RBI connection
RedCard: Barclays
Besides the general parameters described above for the credit card connection, RedCard requires the following additional parameters. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
TransID | ans..18 | M | TransactionID which has to be unique for each payment (less than 2147483648) |
RefNr | ns..30 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
OrderDesc | ans..512 | M | Description of purchased goods, unit prices etc. |
ChDesc | ans..256 | O | Text printed on the customer’s credit card bill alongside the payee |
Contact data/Address verification (AVS) | |||
AddrStreetNr | n..3 | O | Street number of the customer (for AVS) |
AddrZip | ans..8 | O | Postcode: only numbers are forwarded (for AVS) |
Additional parameters for the credit card connection RedCard via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the RedCard connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
TransID | ans..18 | M | TransactionID which has to be unique for each payment (less than 2147483648) |
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
ErrorText | ans..128 | O | Original error text from RedCard (if an error occurs), if agreed with Computop Helpdesk |
CodeExt | n..10 | O | Original error code from RedCard (if an error occurs), if agreed with Computop Helpdesk |
Match | a1 | O | Total result of an address verification: For possible values see manual Match parameters |
TransactionSeqNo | n.. | O | RedCard unique transaction number. Is forwarded only. |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of RedCard connection
RedSys: Caixa Catalunya, Sabadell
Besides the general parameters described above for the credit card connection, RedSys requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
OrderDesc | ans..768 | M | Description of purchased goods, unit prices etc. |
Language | a2 | O | Language for displaying the 3D-Secure form from Redsys. |
Additional parameters for the credit card connection RedSys via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the RedSys connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
CodeExt | n..10 | O | Error code from RedSys, if agreed with Computop Helpdesk |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of RedSys connection
SafeCharge
Besides the general parameters described above for the credit card connection, SafeCharge requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
CustomerID | an..20 | O | Login name of the customer |
ShopURL | an..128 | O | URL of wep page of the shop |
sdState | a2 | C | Code of Federal State in the delivery address. Mandatory only for card holders from USA and Canada |
bdFirstName | an..30 | O | First name of the customer |
bdLastName | an..30 | O | Last name of the customer |
bdStreet | an..100 | O | Customer’s address: Street name and house number |
bdCity | an..40 | O | Customer’s location |
bdZIPCode | an..10 | O | Postcode of the customer |
bdCountryCode | an2 | O | Country code of invoicing address according to ISO-3166-1, alphanumeric 2 chars |
bdPhone | an..20 | O | Customer’s phone number |
bdEmail | ans..64 | O | Email address of the customer |
IPAddr | ans..15 | O | Customer´s IP address for the transaction |
MultiSettleCount | n..2 | O | Relevant to VISA clearing message during authorisation. It represents the number of expected transactions in a multiple-settle Auth transaction. |
User data (if available all parameters need to be enclosed) | |||
Name | ans..100 | C | User name of the customer |
FirstName | ans..100 | C | First name of the customer |
LastName | ans..100 | C | Last name of the customer |
ans..64 | C | Email address of the customer | |
Language | a2 | C | Language of the customer according to ISO, alphanumeric 2-digits |
Delivery data (if available all parameters need to be enclosed) | |||
sdFirstName | ans..100 | C | First name in the delivery address |
sdLastName | ans..100 | C | Surname in the delivery address |
sdStreet | ans..200 | C | Street name in the delivery address |
sdStreetNr | ans..5 | C | Street number in the delivery address |
sdZIPCode | an..20 | C | Postcode in the delivery address |
sdCity | ans..40 | C | Town/city in the delivery address |
sdState | a2 | C | Code of Federal State in the delivery address |
sdCountryCode | a2 | C | Country code of delivery address according to ISO-3166-1, alphanumeric 2 chars |
Address verification (AVS) | |||
AddrStreet | ans..200 | O | Street name (for AVS) |
AddrZip | an..20 | O | Postcode (for AVS) |
AddrCountryCode | a2 | O | Country code according to ISO-3166-1 alphanumeric (2-digits) (for AVS) |
Additional parameters for credit card payments via socket connection for the SafeCharge connection
The following table gives the result parameters which the Paygate transmits especially for the SafeCharge connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
Additional response parameters for credit card payments via socket connection for the SafeCharge connection
SIA: BNL
For credit card connection SIA: BNL, besides the general parameters described above the following additional parameters are required. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ans..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
OrderDesc | ans..768 | M | Description of purchased goods, unit prices etc. |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
ChDesc | an..21 | O | Text printed on the customer’s credit card bill alongside the payee |
Additional parameters for credit card connection SIA: BNL via form
The following table gives the additional result parameters which Paygate transmits especially for the connection SIA: BNL to your URLSuccess, URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ans..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of SIA connection BNL
Snap: EVO Payments
Besides the general parameters described above for the credit card connection, Snap requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
CustomerID | ans..64 | O | CustomerID given by the merchant with the transaction request |
OrderDesc | ans..768 | M | Description of purchased goods, unit prices etc. |
CreditCardHolder | ans..60 | O | Name of card holder (for AVS US domestic optional) |
Contact data/Address verification (AVS) | |||
sdFirstName | ans..25 | O | First name in the delivery address |
sdLastName | ans..25 | O | Last name in the delivery address |
sdMiddleName | ans..30 | O | Middle name in the delivery address |
sdTitle | ans..10 | O | Title in the delivery address, e.g. Dr. or Prof. |
sdSuffix | ans..15 | O | Suffix to the name |
sdStreet | ans..35 | O | Street name in the delivery address |
sdHouseNumber | ans..8 | O | Street number in the delivery address |
sdStreet2 | ans..35 | O | Address addition in the delivery address |
sdPOBox | ans..35 | O | Post office box in the delivery address |
sdZIPCode | ans..20 | O | Postcode in the delivery address |
sdCity | ans..35 | O | Town/city in the delivery address |
sdState | ans..10 | O | State/country in the delivery address |
sdCountryCode | a2/a3 | O | Country code of the delivery address according to ISO-3166-1, alphanumeric 2-digits or 3-digits (preferred) |
bdFirstName | ans..30 | O | First name in the invoicing address |
bdLastName | ans..30 | O | Last name in the invoicing address |
bdMiddleName | ans..30 | O | Middle name in the invoicing address |
bdSuffix | ans..15 | O | Suffix to the name in the invoicing address |
bdCompany | ans..100 | O | Company name in the invoicing address |
bdStreet | ans..35 | O | Street name in the invoicing address |
bdHouseNumber | ans..15 | O | Street number in the invoicing address |
bdStreet2 | ans..35 | O | Address addition in the billing address |
bdPOBox | ans..35 | O | Post office box in the invoicing address |
bdZIPCode | ans..20 | O | Postcode in the invoicing address |
bdCity | ans..35 | O | Town/city in the invoicing address |
bdState | ans..30 | O | State/country in the invoicing address |
bdCountryCode | a3 | O | Country code of invoicing address according to ISO-3166-1, alphanumeric 3 chars |
EmployeeID | ans..25 | OC | ID of the employee/cashier. Required for the branches retail, restaurant and for MOTO. |
ShipDate | an8 | OC | Shipment date in the format "YYYYMMDD": mandatory for MOTO |
AddrStreet | ans..100 | OC | Street name: it must be distinguished between AVS-US-Domestic and AVS-International. (for AVS) US-Domestic: Street and street number together; optional International: Street name (without street number); mandatory for AVS |
AddrStreetNr | ans..15 | OC | Street number of the customer: mandatory for AVS International |
AddrPOBox | ans..35 | O | Post office box (for AVS International) |
AddrZip | ans..10 | OC | Postcode, mandatory for AVS (US domestic as well as International) |
AddrCity | ans..50 | OC | Town/city, mandatory for AVS International |
AddrState | a2 | O | Code of the customer’s Federal State (for AVS) |
AddrCountryCode | a2/a3 | M | Country code according to ISO-3166-1, alphanumeric 2 or 3 chars (preferred) (for AVS) |
ans..128 | O | Email address of the customer (for AVS US domestic) | |
Phone | ans..20 | O | Telephone number of the customer (for AVS US domestic) |
Additional parameters for the credit card connection Snap via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the Snap connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
ErrorText | ans..128 | O | Error text from Snap, if agreed with Computop Helpdesk. Is returned only if ResponseExtended=Yes is configured for that merchant. |
CodeExt | n..10 | O | Error code from Snap, if agreed with Computop Helpdesk. Is returned only if ResponseExtended=Yes is configured for that merchant. |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of Snap connection
UCS
Besides the general parameters described above for the credit card connection, UCS requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
OrderDesc | ans..768 | M | Description of purchased goods, unit prices etc. |
Additional parameters for the credit card connection UCS via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the UCS connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. It is returned only for EVO partners. |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of UCS connection
Vantiv
Besides the general parameters described above for the credit card connection, Vantiv requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..25 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
CustomerID | ans..50 | O | Customer number. Format must be mutually agreed beforehand with Computop Helpdesk! |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
ChDesc | ans..25 | O | Text printed on the customer’s credit card bill alongside the payee. |
TaxAmount | n..10 | O | Tax amount of the entire order in the smallest currency unit. |
TaxExempt | an..5 | O | Code which indicates whether the transaction is subject to Sales Tax: true or false. True=taxless. Default value=false. |
OrderID1 | ans..15 | O | Invoice reference number |
Contact data/Address verification (AVS) | |||
bdFirstName | ans..25 | O | First name in the invoicing address (for AVS) |
bdLastName | ans..25 | O | Last name in the invoicing address (for AVS) |
bdStreet | ans..35 | O | Street name in the invoicing address (for AVS) Please note that bdStreet and bdStreetNr together may have 34 characters maximum. bdStreet and bdStreetNr are combined with a space character between and forwarded together. The total content is truncated after 35 characters. |
bdStreetNr | ans..35 | O | Street number in the invoicing address (for AVS) Please note that bdStreet and bdStreetNr together may have 34 characters maximum. bdStreet and bdStreetNr are combined with a space character between and forwarded together. The total content is truncated after 35 characters. |
bdStreet2 | ans..35 | O | Address addition in the billing address |
bdZIPCode | ans..20 | O | Postcode in the invoicing address (for AVS) |
bdCity | ans..35 | O | Town/city in the invoicing address |
bdState | ans..30 | O | State/country in the invoicing address |
bdCountryCode | a2 | O | Country code of invoicing address according to ISO-3166-1, alphanumeric 2 chars |
bdMail | ans..100 | O | Email address in the invoicing address |
bdPhone | ans..20 | O | Phone number in the invoicing address |
sdFirstName | ans..25 | O | First name in the delivery address |
sdLastName | ans..25 | O | Last name in the delivery address |
sdStreet | ans..35 | O | Street name in the delivery address Please note that sdrStreet and sdStreetNr together may have 34 characters maximum. sdStreet and sdStreetNr are combined with a space character between and forwarded together. The total content is truncated after 35 characters. |
sdStreetNr | ans..35 | O | Street number in the delivery address Please note that sdStreet and sdStreetNr together may have 34 characters maximum. sdStreet and sdStreetNr are combined with a space character between and forwarded together. The total content is truncated after 35 characters. |
sdStreet2 | ans..35 | O | Address addition in the delivery address |
sdZIPCode | ans..20 | O | Postcode in the delivery address |
sdCity | ans..35 | O | Town/city in the delivery address |
sdState | ans..30 | O | State/country in the delivery address |
sdCountryCode | a2 | O | Country code of delivery address according to ISO-3166-1, alphanumeric 2 chars |
sdMail | ans..100 | O | Email address in the delivery address |
sdPhone | ans..20 | O | Telephone number in the delivery address |
Additional parameters for the credit card connection Vantiv via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the Vantiv connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..25 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
ErrorText | ans..128 | O | Original error text from Vantiv (if an error occurs), if agreed with Computop Helpdesk |
CodeExt | n..10 | O | Original error code from Vantiv (if an error occurs), if agreed with Computop Helpdesk |
Match | a1 | O | Total result of an address verification: For possible values see manual Match parameters |
ResponseTime | an19 | O | Time stamp of response in the format YYYY-MM-DDDHH:MM:SS |
LitleTxnID | an19 | M | Litle transaction ID |
ApprovalCode | ans..6 | O | Authorisation code of the Auth- or Sale-transaction |
ApprovedAmount | n8 | O | Approved amount |
PayfacFraudResult | enum | O | Result fraud prevention „“ Ecom, CAVV nonexistent „0“ CAVV data field formatted not correctly; check not possible. „1“ CAVV check failed „2“ CAVV check successful „3“ CAVV check successful „4“ CAVV check failed „5“ Presently not used „6“ CAVV not checked, because issuer does not require a check. VisaNet processed as if CAVV would be valid „7“ CAVV check failed „8“ CAVV check successful “9” CAVV test failed; Visa generated CAVV because issuer ACS was not available. “A” CAVV test successful; Visa generated CAVV because issuer Access Control Server (ACS) was not available. “B” CAVV test successful but no liability shift because a) ECI was not 5 or 6 or b) the card type is excluded (e.g. customer card) “C” issuer selected the return of a CAVV test result and the field 44.13 is empty. The value is set by VisaNet; means that CAVV result is valid “D” issuer selected the return of a CAVV test result and the field 44.13 is empty. The value is set by VisaNet; means that CAVV result is valid. |
CVVResult | enum an..2 | O | Check result: "M"=Correlation; |
FundingSourceType | enum a..7 | O | „UNKNOWN“ „PREPAID” „CREDIT” „DEBIT” „FSA“ (Flexible Spending Account, IRS approved healthcare) |
FundingSourceBalance | an..20 | O | Available amount or „Not Available“ |
FundingSourceReloadable | enum an..7 | O | „UNKNOWN“ „YES“ „NO“ |
FundingSourcePrepaidCardType | enum an..7 | OC | Only if FundingSourceType="PREPAID": Prepaid card type, e.g. „TEEN“, „GIFT“, „PAYROLL“ etc. |
IssuerCountry | an3 | O | Country code of issuing bank |
CardProductType | enum an..10 | O | „COMMERCIAL“ „CONSUMER“ „UNKNOWN“ |
Affluence | enum an..13 | O | Only parts from VISA and MasterCard „MASS AFFLUENT“ > 100K yearly income „AFFLUENT“ >100 K yearly income + > 40K revenue If below 100K the parameter is not returned to Computop |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of Vantiv connection
viaConex: Elavon
Besides the general parameters described above for the credit card connection, viaConex requires the following additional parameters. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
Contact data/Address verification (AVS) | |||
AddrStreet | ans..128 | O | Street name (for AVS) |
AddrStreetNr | ans..10 | O | Street number of the customer (for AVS) |
AddrZip | ans..20 | O | Postcode (for AVS) |
Additional parameters for the credit card connection viaConex via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the viaConex connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
ErrorText | ans..128 | O | Error text from downstream system: Is returned as additional information only in the case of certain errors |
Match | a1 | O | Total result of an address check (Elavon USA): For possible values see manual Match parameters |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of viaConex connection
Wirecard
Besides the general parameters described above for the credit card connection, WirecardCC requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
TransID | ans..30 | M | TransactionID which should be unique for each payment |
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
CreditCardHolder | ans..30 | O | Name of the card holder |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
ChDesc | ans..256 | O | Text printed on the customer’s credit card bill alongside the payee. Umlauts and „ß“ are not allowed. |
AccVerify | a3 | O | If AccVerify=Yes the card will be checked at the acquirer according to the acquirer’s interface description. The merchant has to submit only this parameter, the parameter "Amount" is optional. If "Amount" is used we replace the amount according to acquirer’s interface description. At payment always Amount=0 is stored. Allowed value: yes |
TIN | an..32 | O | TaxIdentificationNumber (Tax identification number) |
CountryCode | a2 | O | Country code in the card holder's address according to ISO-3166-1, alphanumeric 2-digits |
SubMID | ans..15 | O | SubMerchantID assigned from the Payment Facilitator and provided in the request to identify its sub-merchants during transaction flow. |
SubMIDName | ans..22 | O | Name of the SubMerchantID |
SubMIDAddrStreet | ans..38 | O | Street of the SubMerchantID |
SubMIDAddrCity | ans..13 | O | Town/city of the SubMerchantID |
SubMIDAddrZip | ans..10 | O | Postcode of the SubMerchantID |
SubMIDAddrState | ans3 | O | Federal State of the SubMerchantID |
SubMIDAddrCountryCode | a2 | O | Country code of the SubMerchantID according to ISO-3166-1, alphanumeric 2 chars |
Contact data/Address verification (AVS) | |||
FirstName | an..12 | M | First name of the customer (mandatory for AVS) |
LastName | an..12 | M | Last name of the customer (mandatory for AVS) |
AddrStreet | an..25 | M | Street name of the credit card holder (mandatory for AVS) |
AddrStreetNr | an..25 | O | Name of the card holder (mandatory for AVS) |
AddrZip | an..12 | O | Postcode (mandatory for AVS) |
AddrCity | an..32 | C | Town/city (mandatory for AVS) |
AddrState | a2 | C | Code of the customer’s Federal State (for AVS optional) |
AddrCountryCode | a2 | O | Country code according to ISO-3166-1, alphanumeric 2 chars |
ans..256 | C | Email address of the customer | |
Phone | an..32 | O | Telephone number of the card holder. (mandatory for AVS) It can be transmitted in the following formats: +xxx(yyy)zzz-zzzz-ppp where: xxx = country code yyy = national area code zzzzzzz = regional/local code and local number ppp = subsidiary direct access Delimiter like /, \ and – are allowed. Example: a typical international number would be “+44(0)555-5555-739” with the direct access line 739 for local telephone number 555- 5555 with the national area code 0 and country code 44. For countries without national area code the format must be configured with or without space characters. |
DateOfBirth | an10 | O | Date of birth in the format YYYY-MM-DD |
DrivingLicenceNumber | ans..37 | O | Driver's licence number |
Additional parameters for the credit card connection WirecardCC via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the WirecardCC connection to your URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:
Parameter | Format | CND | Description |
---|---|---|---|
TransID | ans..30 | M | TransactionID which should be unique for each payment |
GuWID | ans..22 | O | TransactionID of the Acquiring Bank |
Match | a1 | O | Total result of an address verification: For possible values see manual Match parameters (F,P,N,U,E) |
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of WirecardCC connection
Credit card payments with separate authorisation
For credit card payments the ORDER can be separated from the subsequent authorisation and the following steps. Therefore initially the SSL credit card payment is initiated via Paygate form or via Server-to-Server-connection like in the chapters above with an additional parameter. Later it is authorised using the interface authorize.aspx via server-to-server connection. For initialising visit the following URL:
https://www.computop-paygate.com/payssl.aspx |
For Server-to-Server-connection it is the following URL:
https://www.computop-paygate.com/direct.aspx |
The following table describes the encrypted payment request parameter:
Parameter | Format | CND | Description |
---|---|---|---|
TxType | ans..20 | O | Submit “Order” to initialize a payment which later will be authorised via interface authorize.aspx. Please note that in combination with the used 3-D Secure method a separate setting is necessary. Please contact directly Computop Helpdesk. |
Additional parameters for credit card payments with separate authorisation
In order to authorise a previously with TxType=Order initiated SSL credit card payment, please visit the following URL:
https://www.computop-paygate.com/authorize.aspx |
Notice: Please note, that for an initial order KPN/CVC/CVV-check is not possible. For the subsequent reservation request this ID also cannot be passed on.
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files. |
TransID | ans..64 | O | TransactionID which should be unique for each payment |
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). |
Currency | a3 | M | Currency, three digits DIN / ISO 4217 |
OrderDesc | ans..768 | O | Description of purchased goods, unit prices etc. |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
Capture | ans..6 | O | Determines the type and time of capture. AUTO: capturing immediately after authorisation (default value). MANUAL: capturing made by the merchant. <Number>: Delay in hours until the capture (whole number; 1 to 696). |
Parameters for credit card payments via authorize.aspx
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by Computop |
PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
TransID | ans..64 | M | Merchant’s transaction number |
Status | a..50 | M | OK or FAILED |
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! |
Code | n8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
RefNr | ans..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
Result parameters for credit card payments via authorize.aspx
Paygate interface: via Server-to-Server
Chart of process flow via Server-to-Server
For the server-to-server payment processes please refer to the programming basics manual.
Process flow of a payment via server-to-server interface
Call of interface: general parameters
Notice: For credit card payments with 3-D Secure, please note the different cases as explained separately in the chapter at the start of the handbook. If the credit card is registered for Verified or SecureCode or SafeKey, the next phase is divided into two steps of authentication and payment. However it always begins in the same way via the direct.aspx interface. The first response however is the receipt of Javascript code or other parameters in order to carry out a second call up of the direct3d.aspx interface. Only after that, do you receive the listed parameter as a response.
To carry out a TLS credit card payment via a Server-to-Server connection, call the following URL:
https://www.computop-paygate.com/direct.aspx |
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
TransID | ans..64 | M | TransactionID which should be unique for each payment Please note for some connections the different formats that are given within the specific parameters. |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact Computop Helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Amount3D | n..10 | C | Only for 3DSecure: Amount for authentication with Verified, SecureCode and SafeKey if Amount deviates. E.g. Customer confirms flight costs of 120 Euros with 'Verified' but the travel agent captures only the booking fee of 20 Euros: Amount3D=12000; Amount=2000. Amount in the smallest currency unit (e.g. EUR Cent) Please contact Computop Helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency, three digits DIN / ISO 4217 |
CCNr | n..19 | M | Credit card number at least 12-digit, numerical without spaces. You can optionally transmit also a pseudo card number (PCN) |
CCCVC | n..4 | O | Optional, not with ATOS: Card verification number: The last 3 digits on the signature strip of the credit card. 4 numbers in the case of American Express. Mandatory for Clearhaus |
CCExpiry | n6 | M | Expiry date of the credit card in the format YYYYMM, e.g. 201707. |
CCBrand | a..22 | M | Credit card brand. Please note the spelling! According to table of credit card brands! |
Capture | ans..6 | O | Determines the type and time of capture. AUTO: capturing immediately after authorisation (default value). MANUAL: capturing made by the merchant. <Number>: Delay in hours until the capture (whole number; 1 to 696). |
OrderDesc | ans..768 | M | Description of purchased goods, unit prices etc. |
TermURL | ans..256 | C | Only for 3DSecure: URL of the shop which has been selected by the Access Control Server (ACS) of the bank to transmit the result of the authentication. The bank transmits the parameters PayID, TransID and MerchantID via GET and the PAResponse parameter via POST to the TermURL. |
UserAgent | ans..128 | C | Only for 3DSecure: Browser type of the purchaser who requests the page. For example: IE Mozilla/4. 0 (compatible; MSIE 6.0; Windows NT 5.0; NET CLR 1.0.3705) |
HTTPAccept | ans..128 | C | Only for 3DSecure: MIME types that the customer's client accept. E.g. image/gif, image/x-xbitmap, image/jpeg, image/pjpeg, application/vnd. ms-powerpoint, application/vnd. ms-excel, application/msword, */* |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
General parameters for credit card payments via socket connection
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by Computop |
PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
TransID | ans..64 | M | Merchant’s transaction number Please note for some connections the different formats that are given within the specific parameters. |
Status | a..50 | M | OK or AUTHORIZED as well as FAILED |
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! |
Code | n8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
PCNr | n16 | O | Pseudo Card Number: Random number generated by Paygate which represents a genuine credit card number. The pseudo card number (PCN) starts with 0 and the last 3 digits correspond to those of the real card number. You can use the PCN like a genuine card number for authorisation, capture and credits. |
CCExpiry | n6 | OC | Optional in combination with PCNr: Expiry date of the credit card in the format YYYYMM (201706). |
CCBrand | a..22 | OC | Optional in combination with PCNr: Designation of credit card brand. Please note the spelling! According to table of credit card brands! |
MaskedPan | an..19 | OC | Masked card number 6X4. If you want to receive the parameter MaskedPan, please contact Computop Helpdeskwhich can activate the return. |
CAVV | ans..40 | O | In the case of authentication hosting: Cardholder Authentication Validation Value: Contains the digital signature for authentication with the ACS of the card issuing bank. |
ECI | n2 | O | For 3-D Secure: ACS E-Commerce indicator: defines the security level of a credit card payment via different communication paths: MOTO, SSL, Verified by Visa etc. |
DDD | a1 | C | for 3-D Secure Authentication Hosting: Y - fully authenticated (complete authentication done) N - not enrolled (checked, but Issuer does not participate) U - uneledgeble (technical error) A – attempt (card does not participate) B – bypass (bypass, only for Cardinal Commerce) |
ACSXID | ans..40 | O | Only in the case of 2 / 3, with Authentication Hosting: ID for transaction identification. The ACSXID is transferred with the authorisation to the Acquiring Bank. |
General response parameters for credit card payments via socket connection
APACS: AIBMS, Barclaycard, Worldpay
Besides the general parameters described above for the credit card connection, APACS requires the following additional parameters. An authorisation with 3-D Secure is possible.
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description | |
---|---|---|---|---|
TransID | an..12 | M | TransactionID which should be unique for each payment | |
RefNr | an..12 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. | |
AddrStreet | ans..30 | O | Street name of the customer (for AVS) | |
AddrStreetNr | ans..30 | O | Street number of the customer (for AVS) | |
AddrZip | ans..10 | O | Postcode of the customer (for AVS) | |
AddrCity | ans..20 | O | Town/city of the customer (for AVS) | |
AddrCountryCode | n3 | O | Customer's country code according to ISO-3166-1 numeric (3-digits) (for AVS) | |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription If RTF then there is no AVS | |
AccVerify | a3 | O | AccVerify is available for Barclays only. If AccVerify=Yes the card will be checked at the acquirer according to the acquirer’s interface description. The merchant has to submit only this parameter, the parameter "Amount" is optional. If "Amount" is used we replace the amount according to acquirer’s interface description. At payment always Amount=0 is stored. Allowed value: yes | |
channel | a4 | O | Transaction type (MOTO, ECOM) which supersedes the configured default value. | |
ContractID | n..8 | O | Further contract number between merchant and acquirer, which can be used to override the default VUNr | |
Conditional additional parameters for Worldpay, MCC 6012 The merchant must have Merchant Category Code MCC 6012 and it must be a VISA transaction inside UK | ||||
DateOfBirth | n8 | C | Customer’s date of birth | |
LastName | ans..50 | C | Last name of the customer | |
AccNr | an..22 | C | Account number of the customer | |
AddrZip | ans..10 | C | Postcode of the customer |
Additional parameters for credit card payments via socket connection for the APACS connection
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description | |
---|---|---|---|---|
TransID | an..12 | M | TransactionID which should be unique for each payment | |
RefNr | an..12 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. | |
ApprovalCode | an6 | O | Authorising code of transaction | |
CodeExt | an2 | O | extended response code from Barclaycard | |
ErrorText | ans..80 | O | error text from Barclaycard | |
cvcmatch | a1 | M | Result of CVC check (M = exact match, N = no match, U = card not checken) | |
match | a1 | O | Result of address check, see separate manual Match parameters |
Additional response parameters for credit card payments via socket connection for the APACS connection
BankSys: Worldline
Besides the general parameters described above for the credit card connection, BankSys requires the following additional parameters. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns10..99 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
Additional parameters for credit card payments via socket connection for the BankSys connection
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns10..99 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
CodeExt | an2 | OC | only if configured: Error code from BankSys, if agreed with Computop Helpdesk |
ApprovalCode | an6 | OC | only if configured: Authorization code form the authorisation response |
Additional response parameters for credit card payments via socket connection for the BankSys connection
CAPN: American Express
Besides the general parameters described above for the credit card connection, CAPN requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
OrderDesc | ans..768 | M | Description of purchased goods, unit prices etc. |
AmountAuth | n..10 | M | Prepaid card: Actually authorised amount in the smallest currency unit. |
ContractID | n..8 | O | Further reference which can be used to retrieve the combination TerminalID/Contract partner number |
Contact data/Address verification (AVS) | |||
FirstName | ans..15 | O | First name of the customer (for AVS) |
LastName | ans..30 | O | Last name of the customer (for AVS) |
AddrStreet | ans..20 | O | Street name and street number, e.g. 18850~N~56~ST~#301 (for AVS) |
AddrZip | n..9 | O | Postcode (for AVS) |
ans..60 | O | Email address of the customer (for AVS) | |
Phone | n..10 | O | Phone number of the customer: for countries which do not use this system, please send the last 10 digits (for AVS) |
sdFirstName | ans..15 | O | First name in the delivery address (for AVS) |
sdLastName | ans..30 | O | Last name in the delivery address (for AVS) |
sdStreet | ans..50 | O | Street name and street number in th delivery address, e.g. 4102~N~289~ST~#301 (for AVS) |
sdZip | n..9 | O | Postcode in the delivery address |
sdCountryCode | n3 | O | Country code of the delivery address according to ISO-3166-1 numeric (3-digits) (for AVS) |
sdPhone | ans..10 | O | Phone number in the delivery address: for countries which do not use this system, please send the last 10 digits (for AVS) |
Additional parameters for credit card payments via socket connection for the CAPN connection
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. It is returned only for EVO partners. |
CodeExt | n..10 | O | Error code from CAPN, if agreed with Computop Helpdesk |
ApprovalCode | n..6 | O | Approval code of the transaction |
TransactionID | ans..48 | O | Transaction ID from CAPN |
AmountAuth | n..10 | M | Authorised amount in the smallest currency unit. For prepaid cards this can be less than the initially requested amount. |
Match | a1 | O | Total result of address check (American Express via CAPN): For possible values see manual Match parameters |
cvcmatch | a1 | C | Result of CVC check. Possible values: M = Match, N = No match, U = Issuer unable to process request |
Additional response parameters for credit card payments via socket connection for the CAPN connection
Card Complete
Besides the general parameters described above for the credit card connection, Card Complete requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description | |
---|---|---|---|---|
TransID | an..25 | M | TransactionID which should be unique for each payment | |
RefNr | an..25 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. | |
ArticleList | ans..1024 | O | Article list, describes the individual items of the purchase goods. Structure: <Product name>;<Article number>;<Gross individual price>;<Quantity> <;> separates the fields of an article data set Data type (size): Product name = ans..10 Example: Product1;11111;100;11+Product2;22222;150;12 | |
CustomerID | ans..30 | O | Customer information or email address of the customer |
Additional parameters for the credit card connection Card Complete via socket connection
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description | |
---|---|---|---|---|
TransID | an..25 | M | TransactionID which should be unique for each payment | |
RefNr | an..25 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. | |
Amount | n..10 | O | Amount in the smallest currency unit (e.g. EUR Cent) If the actually authorised amount differs from the requested amount this will be returned. | |
RequestID | an..64 | O | Unique ID assigned to the transaction. Must be saved because it is the reference for subsequent transactions. | |
AID | n6 | O | AuthorisationID returned by Card Complete |
Additional response parameters for credit card payments via socket connection for the Card Complete connection
CB2A: BNP Crossborder and BNP French Domestic
Credit card still must be valid at time of capture / refund. Therefore Paygate accepts credit cards when the card is at least 1 week valid before expire (e.g.: CC expire: 2020-03 authorizations possible until 2020-03-24, 23:59:59).
For credit card connection CB2A: BNP besides the general parameters described above CB2A requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | an12 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. Notes:
|
AccVerify | a3 | O | If AccVerify=Yes the card will be checked at the acquirer according to the acquirer’s interface description. The merchant has to submit only this parameter, the parameter "Amount" is optional. If "Amount" is used we replace the amount according to acquirer’s interface description. At payment always Amount=0 is stored. Allowed value: yes |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
ContractID | n..8 | O | Further reference in order to retrieve to combination TerminalID / Contract partner number |
Additional parameters for credit card payments via socket connection for the connection CB2A: BNP
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | an12 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
CodeExt | an2 | O | Error code of acquirer, if agreed with Computop Helpdesk |
Approvalcode | an..6 | O | Approval code / authorization code of acquirer, if agreed with Computop Helpdesk |
TerminalID | n..7 | O | TerminalId used for processing, if agreed with Computop Helpdesk |
VUNr | n..7 | O | Acquirer contract number of acquirer, if agreed with Computop Helpdesk |
Additional response parameters for credit card payments via socket connection for the connection CB2A: BNP
Chase Paymentech
Besides the general parameters described above for the credit card connection, Chase Paymentech requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description | |
---|---|---|---|---|
TransID | ans..11 | O | TransactionID which should be unique for each payment | |
RefNr | ns..22 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. | |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription | |
ChDesc | an..21 | O | Text printed on the customer’s credit card bill alongside the payee. Possible formats: AN3*AN18 e.g. ABC*QWERTZ1234YX123ERT AN7*AN14 e.g. ABC1234*QWERTZ1234YX12 AN12*AN9 e.g. ABC1234GFERT*QEW2Y3FGT | |
AccVerify | a3 | O | AccVerify is available for SDK (Stratus) only, not for ISO8583 (Tandem). If AccVerify=Yes the card will be checked at the acquirer according to the acquirer’s interface description. The merchant has to submit only this parameter, the parameter "Amount" is optional. If "Amount" is used we replace the amount according to acquirer’s interface description. At payment always Amount=0 is stored. Allowed value: yes | |
Lodging | an2 | O | Number of planned days of hotel accommodation | |
Textfeld1 | as..12 | O | Merchant's phone number. If Textfeld1 is not submitted the value MerchantServicePhone from Madmin will be forwarded for the transaction. Possible formats: N3-N3-N4 e.g. 123-456-7890 N3-AN6 e.g. 123-456789 | |
Contact data/Address verification (AVS) | ||||
FirstName | ans..28 | O | First name of the customer (for AVS) FirstName and LastName are combined in a field with the format „First name + „ *“ + Last name and forwarded together. The total content is truncated after 28 characters. | |
LastName | ans..28 | O | Last name of the customer (for AVS) FirstName and LastName are combined in a field with the format „First name + „ *“ + Last name and forwarded together. The total content is truncated after 28 characters. | |
AddrStreet | ans..30 | O | Street name of the customer (for AVS) Please note that AddrStreet and AddrStreetNr together may have 29 characters maximum. AddrStreet and AddrStreetNr are combined with a space character between and forwarded together. The total content is truncated after 30 characters. | |
AddrStreetNr | ans..30 | O | Street number of the customer (for AVS) Please note that AddrStreet and AddrStreetNr together may have 29 characters maximum. AddrStreet and AddrStreetNr are combined with a space character between and forwarded together. The total content is truncated after 30 characters. | |
AddrStreet2 | ans..28 | O | further street name (for AVS) | |
AddrZip | ans..10 | O | Postcode of the customer (for AVS) | |
AddrCity | ans..20 | O | Town/city of the customer (for AVS) | |
AddrState | a2 | O | Code of the customer’s Federal State (for AVS) | |
AddrCountryCode | n3 | O | Country code according to ISO-3166-1 numeric (3-digits) (for AVS) | |
Phone | ans..14 | O | Customer telephone number in format AAAEEENNNNXXXX, wherein AAA=prefix, EEE=area code, NNNN=number, XXXX=direct line | |
PhoneType | enum | C | Reachability: D=Day; H=Home; N=Night, W=Work Mandatory if Phone exists | |
sdFirstName | ans..25 | O | First name in the delivery address sdFirstName and sdLastName are combined in a field with the format „First name + „ *“ + Last name and forwarded together. The total content is truncated after 25 characters. | |
sdLastName | ans..25 | O | Last name in the delivery address sdFirstName and sdLastName are combined in a field with the format „First name + „ *“ + Last name and forwarded together. The total content is truncated after 25 characters. | |
sdStreet | ans..30 | O | Street name in the delivery address Please note that sdrStreet and sdStreetNr together may have 29 characters maximum. sdStreet and sdStreetNr are combined with a space character between and forwarded together. The total content is truncated after 30 characters. | |
sdStreetNr | O | Street number in the delivery address Please note that sdStreet and sdStreetNr together may have 29 characters maximum. sdStreet and sdStreetNr are combined with a space character between and forwarded together. The total content is truncated after 30 characters. | ||
sdStreet2 | ans..35 | O | Address addition in the delivery address | |
sdZIPCode | ans..10 | O | Postcode in the delivery address | |
sdCity | ans..20 | O | Town/city in the delivery address | |
sdState | a2 | O | State/country in the delivery address | |
sdCountryCode | n3 | O | Country code of the delivery address according to ISO-3166-1, numeric 3-digits | |
sdPhone | an..14 | O | Telephone number in the delivery address in format AAAEEENNNNXXXX, wherein AAA=prefix, EEE=area code, NNNN=number, XXXX=direct line | |
sdPhoneType | enum | C | Reachability in the delivery address: D=Day; H=Home; N=Night, W=Work Mandatory if sdPhone exists |
Additional parameters for credit card payments via socket connection for the Chase connection
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description | |
---|---|---|---|---|
TransID | ans..11 | O | TransactionID which should be unique for each payment | |
RefNr | ns..22 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. | |
CodeExt | n..10 | O | Original error code from Chase (if an error occurs), if agreed with Computop Helpdesk | |
Match | a1 | O | Total result of an address verification: For possible values see manual Match parameters | |
AmexTID | n..15 | C | The TID value is assigned by the authorisation system of American Express. The American Express authorisation system assigns a unique tracking number with which the accuracy of the authorisation data in the calculation data record is determined. | |
ApprovalCode | an6 | O | Approval code, if configured. Is issued by the bank or service facility. To be saved and supplied with the deposit business. | |
CountryStatus | enum | O | Status identification of the card-issuing country. Valid values: A – acceptable; B – blocked; S - suspect | |
RecurringPaymentAdviseCode | n2 | O | Payment recommendation code. Valid values: 01 – new account information available. Call up new account information. 02 – Try again later. Transaction will be reversed in 72 hours. 03 – Do not retry. Request another payment method from the customer. 21 – Do not retry. The issuer has blocked repeated payment transactions. " " - empty | |
AuthDate | n6 | O | Date of originally approved transaction. Format: YYMMDD | |
cvcMatch | a..1 | C | Result of CVC check. Possible values: M = Match |
Additional response parameters for credit card payments via socket connection for the Chase connection
Clearhaus
In order to activate Clearhaus for credit card processing in Paygate, there must exist a merchant account with Clearhaus. The credentials (Clearhaus Merchant API Key) must be stored within Paygate. For merchant accounts which shall be used for paying out gambling winnings additionally extended credits must be activated within Paygate (CreditEx, OCT).
Besides the general parameters described above for the credit card connection, Clearhaus requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description | |
---|---|---|---|---|
TransID | ans..30 | M | TransactionID which should be unique for each payment (only printable ASCII characters from 0x20 to 0x7E) | |
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. Only printable ASCII characters from 0x20 to 0x7E. | |
UserData | ans..1024 | O | If specified upon call, Paygate forwards the parameter with the payment result to the shop | |
CHDesc | ans..22 | O | Text printed on the customer’s credit card bill. Only printable ASCII characters from 0x20 to 0x7E. | |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
Additional parameters for credit card payments via socket connection in the case of the Clearhaus interface
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description | |
---|---|---|---|---|
TransID | ans..30 | M | TransactionID which should be unique for each payment (only printable ASCII characters from 0x20 to 0x7E) | |
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. Only printable ASCII characters from 0x20 to 0x7E. | |
Amount | n..10 | O | Amount in the smallest currency unit (e.g. EUR Cent) If the actually authorised amount differs from the requested amount this will be returned. | |
UserData | ans..1024 | O | If specified upon call, Paygate forwards the parameter with the payment result to the shop | |
CodeExt | n5 | O | Only if configured: External error code (downstream system) | |
ErrorText | ans..128 | O | Detailed Clearhaus error message. Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk | |
TransactionID | ans36 | O | Transaction number from Clearhaus |
Additional response parameters for credit card payments via socket connection for the Clearhaus connection
Credorax
Besides the general parameters described above for the credit card connection, Credorax requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description | |
---|---|---|---|---|
TransID | ans..40 | M | TransactionID which should be unique for each payment | |
RefNr | ns..30 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. | |
OrderDesc | ans..64 | M | Description of purchased goods, unit prices etc. | |
UserData | ans..1024 | O | If specified upon call, Paygate forwards the parameter with the payment result to the shop | |
CHDesc | ans..34 | O | Text printed on the customer’s credit card bill. This function must be enabled by Credorax and have the following structure. 1) merchant DBA name (up to 20 characters) e.g. Computop*Test This value can be alternatively permanently archived by Computop Helpdesk | |
AccVerify | a3 | O | If AccVerify=Yes the card will be checked at the acquirer according to the acquirer’s interface description. The merchant has to submit only this parameter, the parameter "Amount" is optional. If "Amount" is used we replace the amount according to acquirer’s interface description. At payment always Amount=0 is stored. Allowed value: yes | |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription | |
InvoiceNr | an..15 | C | Invoice number. Mandatory for initial payment of a new subscription (RTF=I) or for generating a PCN | |
TokenExt | an..32 | OC | In connection with RTF=R the Token must be transmitted for referencing the credit card data. | |
Contact data/Address verification (AVS) | ||||
CreditCardHolder | a..50 | O | Name of the card holder | |
AddrStreet | ans..50 | O | Street name (for AVS) | |
AddrStreetNr | n..16 | O | Street number (for AVS) | |
AddrZip | ans..9 | C | Postcode. Mandatory for initial payment of a new subscription (RTF=I) or for generating a PCN/TokenExt. | |
AddrCity | ans..30 | O | Town | |
AddrState | a2 | O | Federal State, two-digit code according to ISO 3166 | |
AddrCountryCode | a2/a3 | C | Country code according to ISO-3166-1, alphanumeric 2 or 3 chars Mandatory for initial payment of a new subscription (RTF=I) or for generating a PCN/TokenExt. | |
Phone | ns..32 | O | Telephone number | |
ans..64 | C | E-mail address. Mandatory for initial payment of a new subscription (RTF=I) or for generating a PCN/TokenExt and if CFT (Credit Funds Transfer) is used. | ||
UK 6012 Merchant Mandatory for UK merchants with MCC 6012 | ||||
DateOfBirth | n8 | M | Date of birth of the customer in format YYYYMMDD | |
AccNr | n..10 | M | Masked PAN, account number or customer number | |
AddrZip | ans..6 | M | Postcode of the customer | |
LastName | ans..6 | M | The first six characters of the last name of the customer |
Additional parameters for credit card payments via socket connection for the Credorax connection
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description | |
---|---|---|---|---|
TransID | ans..40 | M | TransactionID which should be unique for each payment | |
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. | |
UserData | ans..1024 | O | If specified upon call, Paygate forwards the parameter with the payment result to the shop | |
Amount | n..10 | O | Amount in the smallest currency unit (e.g. EUR Cent) If the actually authorised amount differs from the requested amount this will be returned. | |
ErrorText | ans..128 | O | Detailed Credorax error message. Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk | |
TokenExt | an..32 | O | For recurring payments (RTF=I) the Token is transmitted for referencing the credit card data. | |
TransactionID | an..32 | O | Transaction number from Credorax | |
Match | a1 | O | Result of address check, see separate manual Match parameters |
Additional response parameters for credit card payments via socket connection for the Credorax connection
Ecom Processing (ECPCC)
In order to activate ECPCC for credit card processing in Paygate, there must exist a merchant account with Ecom. The credentials (Username, password, Terminaltoken) must be stored within Paygate. Besides there must be specified if this is a test or live system. Depending on the configuration within Paygate the integration or live environment from Ecom is activated. Furthermore the submission type ECOM or Moto must be selected. For merchant accounts which shall be used for paying out gambling winnings additionally extended credits must be activated within Paygate (CreditEx, OCT). Additionally the field Merchant Category Code (MCC) is read out, which must be configured with the merchant date (profile settings). If value 7995 is stored in this place all transactions are marked with the flag „Gaming“.
Besides the general parameters described above for the credit card connection, ECPCC requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
IPAddr | ans..15 | M | Customer´s IP address |
CreditCardHolder | ans..255 | M | Name of the card holder |
DateOfBirth | n8 | O | Date of birth of the customer in format YYYYMMDD |
ans..64 | M | Email address of the customer | |
Phone | n..32 | O | Customer’s phone number |
FirstName | ans..255 | M | First name of the customer |
LastName | ans..255 | M | Last name of the customer |
AddrStreet | ans..255 | O | Street name |
AddressAddition | ans..255 | O | Address c/o |
AddrZip | an..9 | O | Postcode |
AddrCity | ans..255 | O | City |
AddrState | a2 | O | Code of the customer’s Federal State |
AddrCountryCode | a2 | M | Country code according to ISO-3166-1, alphanumeric 2 chars |
sdFirstName | ans..255 | O | First name in the delivery address |
sdLastName | ans..255 | O | Surname in the delivery address |
sdStreet | ans..255 | O | Street name in the delivery address |
sdAddressAddition | ans..255 | O | Address addition in the delivery address |
sdZIPCode | an..9 | O | Postcode in the delivery address |
sdCity | ans..255 | O | Town/city in the delivery address |
sdState | a2 | O | Code of Federal State in the delivery address |
sdCountryCode | a2 | O | Country code of delivery address according to ISO-3166-1, alphanumeric 2 chars |
CHDesc | an..39 | O | Text printed on the customer’s credit card bill alongside the payee. Format: merchant_name*merchant_city (AN..25*AN..13) |
RTF | a1 | O | for repeat payments (subscriptions): I = initial payment of a new subscription, R = recurring payment |
Additional parameters for credit card payments via socket connection for the ECPCC connection
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
UserData | ans..1024 | O | If specified upon call, Paygate forwards the parameter with the payment result to the shop |
CodeExt | n2 | O | Extended response code from Ecom Processing |
ErrorText | ans..255 | O | Detailed error message from Ecom Processing Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk |
Match | a1 | O | Result of address check, see separate manual Match parameters |
TokenExt | an..36 | O | For recurring payments (RTF=I) the Token is transmitted for referencing the credit card data. |
Additional response parameters for credit card payments via socket connection for the ECPCC connection
EVOxml
Besides the general parameters described above for the credit card connection, EVOxml requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
MARP | a3 | O | Not with 3-D Secure: to activate MARP at EVO Payments International (Maestro Advance Registration Program™) <yes> or <no> |
CustomerID | an..20 | O | Customer number: Number to identify the customer |
RefNr | ans..20 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. (only capitals allowed) |
AccVerify | a3 | O | If AccVerify=Yes the card will be checked at the acquirer according to the acquirer’s interface description. The merchant has to submit only this parameter, the parameter "Amount" is optional. If "Amount" is used we replace the amount according to acquirer’s interface description. At payment always Amount=0 is stored. Allowed value: yes |
OrderDesc | an..30 | O | Description of purchased goods, unit prices etc. |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
ChDesc | an..30 | O | Dynamic text component of the posting text of credit card transactions |
Contact data | |||
FirstName | ans..30 | O | First name of the customer (for Fraud Screening optional) |
LastName | ans..30 | O | Last name of the customer (for Fraud Screening mandatory) |
AddrStreet | an..46 | O | Street name of the customer (for Fraud Screening mandatory) |
AddrStreetNr | an..35 | O | Street number of the customer (for Fraud Screening optional) |
AddressAddition | ans..6 | O | Address addition (for Fraud Screening optional) |
AddrPOBox | n..35 | O | Post office box (for Fraud Screening optional) |
AddrZip | an..9 | O | Postcode of the customer (for Fraud Screening mandatory) |
AddrCity | an..40 | O | Town/city of the customer (for Fraud Screening mandatory) |
AddrDistrict | ans..40 | O | County/region (for Fraud Screening optional) |
AddrState | a2 | O | Code of Federl State of the customer (for Fraud Screening optional) |
AddrCountryCode | a2 | M | Country code according to ISO-3166-1, alphanumeric 2 chars (for Fraud Screening optional) |
an..80 | O | Email address of the customer (for Fraud Screening mandatory) | |
Phone | ans..20 | O | Phone number of the customer (for Fraud Screening mandatory) |
MiddleName | ans..30 | O | Middle name |
Salutation | ans..10 | O | Salutation e.g. Mr or Mrs, compulsory field for fraud screening |
Title | ans..20 | O | Title, e.g. Dr. or Prof. |
CompanyOrPerson | a1 | O | F=Firm, P=Person, compulsory field for fraud screening |
DateOfBirth | n8 | O | Date of birth in the format YYYYMMDD |
Gender | a1 | O | Gender: <m> male or <f> female |
WorkPhone | ans..20 | O | Telephone number at the work place |
Fax | ans..20 | O | Fax number |
ans..80 | O | E-mail address | |
NewCustomer | ans..5 | O | New customer: Yes or no |
DateOfRegistration | ans8 | O | Date of registration (YYYYMMDD) |
SocialSecurityNumber | ans..9 | O | Social security number |
DrivingLicenceNumber | ans..37 | O | Driver's licence number |
Delivery data | |||
sdFirstName | an..30 | O | First name in the delivery address |
sdLastName | ans..25 | O | Last name in the delivery address |
sdMiddleName | ans..30 | O | Middle name in the delivery address |
sdStreet | an..46 | O | Street name in the delivery address |
sdStreet2 | an..46 | O | Address addition in the delivery address |
sdZip | an..9 | O | Postcode in the delivery address |
sdZIPCode | an..9 | O | Postcode in the delivery address |
sdCity | an..40 | O | Town/city in the delivery address |
sdState | a2 | O | State/country in the delivery address |
sdCountryCode | a2 | O | Country code of delivery address according to ISO-3166-1, alphanumeric 2 chars |
sdeMail | an..80 | O | E-mail address of the delivery address |
sdPhone | ans..20 | O | Telephone number in the delivery address |
sdWorkPhone | ans..20 | O | Second telephone number / telephone number at the work place in the delivery address |
Parameters for AVS (Address verification) | |||
CreditCardHolder | ans..60 | O | Name of the card holder (for AVS mandatory) |
chStreet | an..46 | C | Street name of the credit card holder (for AVS mandatory) |
chHouseNumber | an..35 | O | Street number of the credit card holder (for AVS optional) |
chPOBox | an..9 | O | Post office box of the credit card holder (for AVS mandatory) |
chCoField | an..40 | O | Bulk recipient name of the credit card holder (for AVS optional) |
chZipCode | an..9 | O | Postcode of the credit card holder (for AVS mandatory) |
chCity | an..40 | O | Town/city of the credit card holder (for AVS mandatory) |
chDistrict | an..40 | O | Urban district of the credit card holder (for AVS optional) |
chState | an2 | O | 2-digit code of the Federal State of the credit card holder (only for USA) (for AVS optional) |
chCountryCode | a2 | O | Country code of the credit card holder in the format ISO-3166-1, alphanumeric 2-digits (for AVS mandatory) |
All following parameters refers to the bought flight ticket | |||
TicketNr | an..15 | C | Reference to the bought flight ticket |
PassengerName | an..49 | C | Name of the flight passenger |
FlightDate | an..5 | C | Flight date. Format: DDMMM (e.g. 15MAY, 01NOV, 30JUN) |
Origin1 | an..5 | C | International code for the departure airport |
Origin2 | an..5 | C | International code for the departure airport |
Origin3 | an..5 | C | International code for the departure airport |
Origin4 | an..5 | C | International code for the departure airport |
Destination1 | an..5 | C | International code for the arrival airport |
Destination2 | an..5 | C | International code for the arrival airport |
Destination3 | an..5 | C | International code for the arrival airport |
Destination4 | an..5 | C | International code for the arrival airport |
Carrier1 | an..4 | C | International code for the airline company |
Carrier2 | an..4 | C | International code for the airline company |
Carrier3 | an..4 | C | International code for the airline company |
Carrier4 | an..4 | C | International code for the airline company |
fsSkip | an..4 | O | „YES“ = Skip the Fraud Screening. Overrides merchant configuration |
fsIgnore | an..6 | O | „YES“ = Ignore the Fraud Screening result. Overrides merchant configuration |
fsReject | a1 | O | Call up control of Fraud Screening C: Accept transaction in the event of CHALLENGE E: Accept transaction in the event of ERROR |
avsSkip | an..4 | C | „YES“ = Skip AVS |
avsIgnore | an..6 | C | „YES“ = Ignore AVS result |
avsReject | a..7 | C | List of result codes which reject the transaction NI: Decline only if postcode and street do not match ABNI: Decline: Street does not match or street and postcode do not match. WZPNI: Decline: Postcode does not match or street and postcode do not match. ABWZPNI: Decline: At least one of the elements AddrStreet and AddrZipCode does not match. |
Additional parameters for credit card payments via socket connection in the case of the EVOxml interface
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ans..20 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. (only capitals allowed) |
ErrorText | ans..128 | O | Error text from EVOxml, if agreed with Computop Helpdesk |
FSMatch | an..9 | O | ACCEPT: Accept transaction, low risk DENY: Deny transaction, high risk CHALLENGE: Check transaction additionally, risk not clear ERROR: Internal error |
AVMatch | a1 | O | Result of address check, see separate manual Match parameters |
TrxTime | an21 | M | Time stamp of transaction in the format dd.MM.yyyy HH:mm:ssff |
AQ | an3 | M | Acquirer shortcode |
AuthCode | ans..6 | M | Acquiring Bank's authorisation code |
Additional response parameters for credit card payments via socket connection for the EVOxml connection
GICC: Concardis, Payone, EVO Payments, American Express, Elavon, InterCard, SIX Payment Service, Paynetics
Besides the general parameters described above for the credit card connection, GICC requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ans..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. If RefNr is not submitted, the value of TransID will be used. For InterCard only alphanumeric characters are allowed, format an..30. |
OrderDesc | ans..768 | M | Description of purchased goods, unit prices etc. |
CreditCardHolder | ans..60 | O | Name of the card holder |
AddrCountryCode | a2/a3 | M | Country code according to ISO-3166-1: it can be transmitted with two or three digits optionally – Format a2 / a3 |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
ChDesc | an..30 | O | Text printed on the customer’s credit card bill alongside the payee |
AccVerify | a3 | O | AccVerify is available for AirPlus, American Express, B + S Card Service, Concardis, Diners, DZ Bank, EVO, Fiducia, Intercard, Paynetics, POS Transact, SIX and WGZ Bank only. If AccVerify=Yes the card will be checked at the acquirer according to the acquirer’s interface description. The merchant has to submit only this parameter, the parameter "Amount" is optional. If "Amount" is used we replace the amount according to acquirer’s interface description. At payment always Amount=0 is stored. Allowed value: yes |
CountryCode | a2 | O | Card holder information: Country |
Textfeld1 | ans..30 | O | Card holder information: Name |
Textfeld2 | ans..30 | O | Card holder information: City |
ContractID | n..8 | O | Further reference which can be used to retrieve the combination TerminalID/Contract partner number |
Cryptocurrency | a..3 | C | Used to flag a cryptocurrency purchase. Possible value "Yes". Notice: Possible only for credit card brands VISA, MasterCard, Maestro. |
Contact data/Address verification (AVS) | |||
AddrStreet | a..50 | O | Street name (for AVS) |
AddrStreetNr | ans..15 | O | Street number for verification by American Express (for AVS) |
AddrZip | n..10 | O | Postcode (for AVS) |
AddrCity | a..40 | O | Town/city (for AVS) |
AddrStreet2 | a..32 | O | Second street name (for AVS) |
AddrStreetNr2 | ans..5 | O | Second street number (for AVS) |
AddrZip2 | n..5 | O | Second postcode (for AVS) |
AddrCity2 | a..32 | O | Second town/city (for AVS) |
AddrChoice | n1 | O | If you transmit 2 street numbers and postcodes, the AddrChoice parameter will determine which address is checked. AddrChoice=1 checks the first address, AddrChoice=2 the second address. (for AVS) |
Additional parameters for the credit card connection GICC via Paygate form
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
Match | a1 | O | Total result of address check (American Express via GICC): For possible values see manual Match parameters |
TerminalID | an8 | O | ID of the terminal |
TransactionID | an..22 | C | If transaction is approved and value returned by the acquirer: Transaction identifier returned upon approval. It must be submitted unaltered when subsequent authorization requests are related to a previous original request where this value is returned. |
VUNr | n5..12 | C | Contract partner number |
TrxTime | an21 | C | Time stamp of transaction in the format dd.MM.yyyy HH:mm:ssff |
VU | n.. | C | Contract partner number. The length depens on the acquirer. If you want to have the acquirer contract partner number within the reponse, please contact Computop Helpdesk which can activate this response function for you. |
AQ | an3 | C | Acquirer shortcode. If you want to have the acquirer name within the reponse, please contact Computop Helpdesk which can activate this response function for you. Possible values: AMEX=AME, Elavon=CKS, Concardis=CON, Payone=BUS, Paynetics=PNS, Six Payment=SIX, EVO Payments=EVO, Intercard=INT |
Additional response parameters for credit card payments via socket connection for the GICC connection
GMO-PG
Besides the general parameters described above for the credit card connection, GMO-PG requires the following additional parameters via server-to-server connection. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
TransID | an..27 | M | Transaction ID up to 27 characters. Must be unique for each payment. |
TaxAmount | n..10 | O | Tax amount of the order Important Note: During processing this amount will not be summed up with the field Amount. If you want to use partial captures or partical credits, please do not submit this parameter during authorisation. Please contact Computop Helpdesk for further information. |
PayType | n1 | C | Mandatory for transactions, not necessary for account verification. Possible values: 1: Single payment 2: Installment payment 3: Bonus single payment 4: Bonus installment payment 5: revolving |
PayTimes | n2 | C | Number of payments. Mandatory for installment payment and Bonus installment payment (PayType =2 or 4) |
Additional parameters for credit card payments via socket connection for the connection GMO-PG
Heartland
Besides the general parameters described above for the credit card connection, Heartland requires the following additional parameters. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
Contact data/Address verification (AVS) | |||
FirstName | ans..100 | O | First name of the customer |
LastName | ans..100 | O | Last name of the customer |
AddrStreet | ans..128 | O | Street name and house number |
AddrZip | ans..20 | O | Postcode |
AddrCity | ans..50 | O | City |
AddrState | a2 | O | Code of the customer’s Federal State |
AddrCountryCode | a2/a3 | M | Country code according to ISO-3166-1, alphanumeric 2 or 3 chars |
Additional parameters for credit card payments via socket connection for the Heartland connection
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
ErrorText | ans..128 | O | Error text from the downstream system, only when its response is discussed with Computop Helpdesk (configured in MAT). |
CodeExt | ans..10 | O | Only if configured: External error code (downstream system) |
ApprovalCode | an6 | O | External approval code (downstream system). Exists only if authorisation was successful. |
HpsTransactionID | n10 | O | TransaktionsID issued by Heartland: returned if authorisation is okay |
HpsReferenceNumber | n12 | O | ReferenceNumber issued by Heartland: returned if authorisation is okay |
Match | a1 | O | Result of address check: Parameter is returned depending on merchant configuration as simplified Match parameter or as returned by Heartland |
Additional response parameters for credit card payments via socket connection for the Heartland connection
iCard
Besides the general parameters described above for the credit card connection, iCard requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
CustomerID | ans..255 | O | Customer access data on the merchant’s checkout page (email, ID, telephone number or name) |
OrderDesc | ans..768 | O | Description of purchased goods, unit prices etc. |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
Additional parameters for credit card payments via socket connection for the iCard connection
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
ErrorText | ans.. | OC | Error text from iCard, if agreed with Computop Helpdesk. Is returned only if ResponseExtended=Yes is configured for that merchant. |
CodeExt | n..3 | OC | Error code from iCard, if agreed with Computop Helpdesk. Is returned only if ResponseExtended=Yes is configured for that merchant. |
ApprovalCode | ans..6 | O | ApprovalCode or Authorisation code returned by card issuer |
Additional response parameters for credit card payments via socket connection for the iCard connection
Kalixa
Besides the general parameters described above for the credit card connection, Kalixa requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
UserData | ans..1024 | O | If specified upon call, Paygate forwards the parameter with the payment result to the shop |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
IPAddr | ans..15 | M | Customer´s IP address |
BrowserSessionID | ans..64 | M | Customer´s Session ID |
CreditCardHolder | ans..100 | M | Name of the card holder |
CustomerID | an..20 | M | Customer number: Number to identify the customer |
User data (if available all parameters need to be enclosed) | |||
Name | ans..100 | C | User name of the customer |
FirstName | ans..100 | C | First name of the customer |
LastName | ans..100 | C | Last name of the customer |
ans..64 | C | Email address of the customer | |
Language | a2 | C | Language of the customer according to ISO, alphanumeric 2-digits |
Delivery data (if available all parameters need to be enclosed) | |||
sdFirstName | ans..100 | C | First name in the delivery address |
sdLastName | ans..100 | C | Surname in the delivery address |
sdStreet | ans..200 | C | Street name in the delivery address |
sdStreetNr | ans..5 | C | Street number in the delivery address |
sdZIPCode | an..20 | C | Postcode in the delivery address |
sdCity | ans..40 | C | Town/city in the delivery address |
sdState | a2 | C | Code of Federal State in the delivery address |
sdCountryCode | a2 | C | Country code of delivery address according to ISO-3166-1, alphanumeric 2 chars |
Address verification (AVS) | |||
AddrStreet | ans..200 | O | Street name (for AVS) |
AddrZip | an..20 | O | Postcode (for AVS) |
AddrCountryCode | a2 | O | Country code according to ISO-3166-1 alphanumeric (2-digits) (for AVS) |
Additional parameters for credit card payments via socket connection for the Kalixa connection
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
UserData | ans..1024 | O | If specified upon call, Paygate forwards the parameter with the payment result to the shop |
CodeExt | n2 | O | Extended response code from Kalixa |
ErrorText | ans..255 | O | Detailed Kalixa error message. Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk. |
Additional response parameters for credit card payments via socket connection for the Kalixa connection
MasaPay
Besides the general parameters described above for the credit card connection, MasaPay requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
Language | a2 | O | Accepted language code at MasaPay: "CN" Chinese, "EN" English, "FR" French, "DE" German, "ES" Spanish, "IT" Italian, "JA" Japanese, "RU" Russian, "KO” Korean, "TH" Thai, "SV" Swedish. No details means the language is EN. If the trasferred language is not supported by MasaPay, EN is forwarded. |
OrderDesc | ans..768 | M | Description of purchased goods, unit prices etc. The special characters “#”, “&”, “%” and “+” are not permitted here. |
ArticleList | ans..2000 | M | Article list, describes the individual items of the purchase goods. Structure: <Product name>;<Article number>;<Gross individual price>;<Quantity>;<Article web link> (<Article web link> is optional) <;> separates the fields of an article data set Data type (size): Product name = ans..10 Example: Produkt1;11111;100;11; www.books.com/book1.bok+Produkt2;22222;150;12; www.books.com/book2.bok |
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. |
UserData | ans..256 | O | If specified upon call, Paygate forwards the parameter with the payment result to the shop |
expirationTime | ans19 | O | timestamp for the end time of the transaction processing, specified in UTC. Format: YYYY-MM-ddTHH:mm:ss |
User data | |||
CreditCardHolder | ans..100 | O | Name of the credit card holder |
bdFirstName | ans..50 | M | First name in the invoicing address |
bdLastName | ans..50 | M | Last name in the invoicing address |
bdStreet | ans..128 | M | Street name of the invoicing address |
bdStreetNr | ans..10 | M | Street number of the invoicing address |
bdStreet2 | ans..50 | O | Address addition in the invoicing address |
bdCompany | ans..200 | O | Company name in the invoicing address |
bdZip | ans..20 | M | Postcode of the invoicing address |
bdCity | ans..20 | M | City in invoicing address |
bdState | ans..20 | M | Code of Federal State in the invoicing address |
bdCountryCode | a2 | M | Country code of invoicing address according to ISO-3166-1, alphanumeric 2 chars |
bdEmail | ans..100 | M | Email address of the customer |
bdPhone | ans..20 | M | Customer’s phone number |
bdMobileNr | ans..20 | O | Customer’s mobile telephone number |
Delivery data: If delivery data are different than invoicing data the following parameters (at least all OC parameters) should be transferred because otherwise the invoicing data are used for delivery data | |||
sdFirstName | ans..50 | OC | First name in the delivery address |
sdLastName | ans..50 | OC | Surname in the delivery address |
sdStreet | ans..128 | OC | Street name in the delivery address |
sdStreetNr | ans..10 | OC | Street number in the delivery address |
sdStreet2 | ans..50 | O | Address addition in the delivery address |
sdCompany | ans..200 | O | Company name in the delivery address |
sdZIP | ans..20 | OC | Postcode in the delivery address |
sdCity | ans..20 | OC | Town/city in the delivery address |
sdState | ans..20 | OC | Code of Federal State in the delivery address |
sdCountryCode | a2 | OC | Country code of delivery address according to ISO-3166-1, alphanumeric 2 chars |
sdEmail | ans..100 | OC | Email address in the delivery address |
sdPhone | ans..20 | OC | Phone number in the delivery address |
Risk control: If customer is registered at the merchant, following registration parameters should be transferred | |||
ans..60 | O | Email address of the customer at merchant’s registration | |
CustomerID | ans..20 | O | Customer ID or customer number |
Channel | a4 | O | Terminal used at time of order (MOTO: Mobile phone, ECOM: PC), this overrides the configured default value. |
IPAddr | ns..15 | O | Fraud prevention: IP address at time of order |
RegistrationDate | ans19 | O | Date and time when the customer has created the account |
RegistrationIP | ns..15 | O | Registered customer´s IP address |
RegistrationDevice | a4 | O | Terminal used at registration (MOTO; Mobile phone, ECOM: PC); if not specified the value will be taken from parameter Channel. |
Additional parameters for credit card payments via socket connection for the MasaPay connection
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
UserData | ans..1024 | O | If specified upon call, Paygate forwards the parameter with the payment result to the shop |
CodeExt | ans..10 | O | Extended response code from Kalixa |
ErrorText | ans..128 | O | Detailed Kalixa error message. Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk |
Additional response parameters for credit card payments via socket connection for the MasaPay connection
Omnipay: EMS payment solutions, Global Payments, Paysquare, Payvision
Besides the general parameters described above for the credit card connection, Omnipay (Bancontact) requires the following additional parameters. An authorisation with 3-D Secure is possible.
Computop Paygate is the preferred PSP with EMS payment solutions. Paygate has now been opened for the transfer of “3D” parameters. For this the respective merchant first needs to configure to “External MPI” on Computop. Paygate then accepts the parameters and uses them in communication with downstream systems.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description | |
---|---|---|---|---|
RefNr | ns..15 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. | |
OrderDesc | ans..768 | O | Description of purchased goods, unit prices etc. | |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription | |
ChDesc | an..30 | O | Text printed on the customer’s credit card bill alongside the payee | |
AccVerify | a3 | O | If AccVerify=Yes the card will be checked at the acquirer according to the acquirer’s interface description. The merchant has to submit only this parameter, the parameter "Amount" is optional. If "Amount" is used we replace the amount according to acquirer’s interface description. At payment always Amount=0 is stored. Allowed value: yes | |
FirstName | as..25 | OC | In combination with LastName: First name of the customer for OCT (CFT) transactions | |
LastName | as..25 | OC | In combination with FirstName: Last name of the customer for OCT (CFT) transactions | |
Cryptocurrency | a..3 | C | Used to flag a cryptocurrency purchase. Possible value "Yes". Notice: Possible only for credit card brands VISA, MasterCard, Maestro. | |
Contact data/Address verification (AVS) | ||||
AddrStreet | a..50 | O | Street name (for AVS) | |
AddrStreetNr | ans..15 | O | Street number for verification by American Express (for AVS) | |
AddrZip | n..10 | O | Postcode (for AVS) | |
AddrCity | a..40 | O | Town/city (for AVS) | |
AddrState | a2 | O | Code of the customer’s Federal State (for AVS) | |
AddrStreet2 | a..32 | O | Second street name (for AVS) | |
AddrStreetNr2 | ans..5 | O | Second street number (for AVS) | |
AddrZip2 | n..5 | O | Second postcode (for AVS) | |
AddrCity2 | a..32 | O | Second town/city (for AVS) | |
AddrChoice | n1 | O | If you transmit 2 street numbers and postcodes, the AddrChoice parameter will determine which address is checked. AddrChoice=1 checks the first address, AddrChoice=2 the second address. (for AVS) | |
Parameters for extension External MPI via EMS (only if configured with Computop Helpdesk) | ||||
Authresult | a1 | M | Status from VERes or rather PARes Y = Fully Authenticated A = Attempt N = Not enrolled | |
CAVV | ans..32 | C | BASE64 coded Cardholder Authentication Verification Value Permitted special characters are + / = | |
ACSIDHEX | hex40 | C | VISA transactions with Authresult Y / A Bancontact transactions with Authresult Y CAUTION! Bancontact transactions are accepted only with Authresult Y! | |
XID3DHEX | hex40 | C | Hexadecimal XID VISA transactions with Authresult Y / A | |
ECI3D | n2 | M | 01 = Attempt MasterCard / Maestro 02 = Fully Authenticated MasterCard / Maestro / Bancontact 05 = Fully Authenticated VISA 06 = Attempt VISA | |
Additional PayFac parameters for acquirer Payvision | ||||
SubMID | ans..15 | O | SubMerchantID assigned from the Payment Facilitator and provided in the request to identify its sub-merchants during transaction flow | |
SubMIDName | ans..22 | O | Name of the SubMerchantID | |
SubMIDAddrStreet | ans..38 | O | Street of the SubMerchantID | |
SubMIDAddrCity | ans..13 | O | Town/city of the SubMerchantID | |
SubMIDAddrZip | ans..10 | O | Postcode of the SubMerchantID | |
SubMIDAddrState | ans3 | O | Federal State of the SubMerchantID | |
SubMIDAddrCountryCode | a2 | O | Country code of the SubMerchantID according to ISO-3166-1, alphanumeric 2 chars |
Additional parameters for credit card payments via socket connection for the Omnipay connection
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..15 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
Match | a1 | O | Total result of an address check (Global Payments): For possible values see manual Match parameters |
IBAN | ans..34 | MC | IBAN of account holder: Mandatory for card brand Bancontact via Omnipay, otherwise not used |
BIC | ans..11 | MC | BIC of account holder: Mandatory for card brand Bancontact via Omnipay, otherwise not used |
AppCodeTel | n6 | C | for 3-D Secure: Telephone authorisation code |
CAVV | ans..40 | C | for 3-D Secure Authentication Hosting: ACSVerificationID/ ACSVerificationIDHex |
ACSXID | ans..28 | C | for 3-D Secure Authentication Hosting: HexXID |
Additional response parameters for credit card payments via socket connection for the Omnipay connection
PayPal
Besides the general parameters described above for the credit card connection, PayPalCC requires the following additional parameters. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
ChDesc | ans..256 | O | Text printed on the customer’s credit card bill alongside the payee |
ApprovalCode | an6 | O | External approval code (downstream system). Exists only if authorisation was successful. |
CodeExt | ans..10 | O | Only if configured: External error code (downstream system) |
UserData | ans..1024 | OC | Not with 3-D Secure: If specified at request, Paygate forwards the parameter with the payment result to the shop. |
CreditCardHolder | ans..60 | MC | Not with 3-D Secure: Name of the card holder in the format: <First name><space character><Last name> |
Contact data/Address verification (AVS) | |||
sdFirstName | ans..100 | M | First name in the delivery address |
sdLastName | ans..100 | M | Last name in the delivery address |
sdMiddleName | ans..30 | O | Middle name in the delivery address |
sdStreet | ans..128 | M | Street name in the delivery address |
sdStreetNr | ans..10 | M | Street number in the delivery address |
sdStreet2 | ans..50 | O | Address addition in the delivery address |
sdZIPCode | ans..20 | M | Postcode in the delivery address |
sdCity | ans..50 | M | Town/city in the delivery address |
sdState | ans..50 | O | State/country in the delivery address |
sdCountryCode | a2 | M | Country code of delivery address according to ISO-3166-1, alphanumeric 2 chars |
sdeMail | ans..254 | M | E-mail address of the delivery address |
sdPhone | ans..40 | O | Telephone number in the delivery address |
sdWorkPhone | ans..40 | O | Second telephone number / telephone number at the work place in the delivery address |
bdFirstName | ans..100 | M | First name in the invoicing address |
bdLastName | ans..100 | M | Last name in the invoicing address |
bdMiddleName | ans..30 | O | Middle name in the invoicing address |
bdStreet | ans..128 | M | Street name in the invoicing address (for AVS) |
bdStreetNr | ans..10 | M | Street number in the invoicing address (for AVS) |
bdStreet2 | ans..50 | O | Address addition in the billing address |
bdZIPCode | ans..20 | M | Postcode in the invoicing address (for AVS) |
bdCity | ans..50 | M | Town/city in the invoicing address |
bdState | ans..50 | O | State/country in the invoicing address |
bdCountryCode | a2 | M | Country code of invoicing address according to ISO-3166-1, alphanumeric 2 chars |
bdeMail | ans..254 | M | Email address in the billing address |
bdPhone | ans..40 | O | Phone number in the invoicing address |
bdWorkPhone | ans..40 | O | Second telephone number / telephone number at the work place in the invoicing address |
bdFax | ans..20 | O | Telefax number of the invoicing address |
Additional parameters for credit card payments via socket connection for the PayPalCC connection
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
Status | ans..50 | M | OK or AUTHORIZED as well as AUTHORIZE_REQUEST or FAILED |
RefNr | ns..30 | OC | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
UserData | ans..1024 | OC | Not with 3-D Secure: If specified at request, Paygate forwards the parameter with the payment result to the shop. |
ErrorText | ans..128 | O | Error text from the downstream system, only when its response is discussed with Computop Helpdesk (configured in MAT). |
Pnref | ans..12 | M | Unique transaction ID given by PayPal for identifying a PayPal transaction for invoicing and reporting purposes. |
Match | a1 | O | Total result of an address verification: For possible values see manual Match parameters |
Additional response parameters for credit card payments via socket connection for the PayPalCC connection
PPRO
Besides the general parameters described above for the credit card connection, PPRO requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | M | Not with 3-D Secure: Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
OrderDesc | ans..768 | M | Description of purchased goods, unit prices etc. |
UserData | ans..1024 | OC | Not with 3-D Secure: If specified at request, Paygate forwards the parameter with the payment result to the shop. |
CreditCardHolder | ans..60 | MC | Not with 3-D Secure: Name of the card holder in the format: <First name><space character><Last name> |
CustomerID | ans..64 | O | Customer number. Format must be mutually agreed beforehand with Computop! |
SellingPoint | ans..50 | O | Selling point |
Service | ans..50 | O | Products or services sold |
Channel | ans..64 | O | configuration channel of the PPRO contract (account and ContractID are stored in the system). If it exists, it may overwrite channels stored in the system |
AddrCountryCode | a2 | M | Country code according to ISO-3166-1, alphanumeric 2 chars |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
ChDesc | ans..256 | O | Text printed on the customer’s credit card bill alongside the payee |
Additional parameters for credit card payments via socket connection for the PPRO connection
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | OC | Not with 3-D Secure: Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
UserData | ans..1024 | OC | Not with 3-D Secure: If specified at request, Paygate forwards the parameter with the payment result to the shop. |
PaymentPurpose | ans..26 | M | Purpose of payment |
PaymentGuarantee | a..12 | M | Payment guarantee NONE= no payment guarantee, VALIDATED= customer account valid, but no payment guarantee, FULL= payment guarantee Notice: This parameter is only returned if the Status=OK. |
ErrorText | ans..128 | M | Detailed PPRO error message. Notice: Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk |
CCBIN | n6 | O | first six digits of the credit card number |
Status | a..50 | M | OK or AUTHORIZED as well as FAILED. For PPRO there is also AUTHORIZE_REQUEST. |
Additional response parameters for credit card payments via socket connection for the PPRO connection
RBI
Besides the general parameters described above for the credit card connection, RBI requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
TransID | ans..20 | M | TransactionID which should be unique for each payment |
RefNr | ans..20 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. The format pattern is: [A-Za-z0-9.] |
OrderDesc | ans..512 | M | Description of purchased goods, unit prices etc. |
UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop |
CountryCode | a3 | O | On the basis of CountryCode the respective account information like RBI MerchantID and TerminalID can be retrieved at Computop |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
Additional parameters for credit card payments via socket connection for the RBI connection
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
TransID | ans..20 | M | TransactionID which should be unique for each payment |
RefNr | ns..20 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop |
ErrorText | ans..128 | O | Detailed RBI error message. Notice: Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk |
Additional response parameters for credit card payments via socket connection for the RBI connection
RedCard: Barclays
Besides the general parameters described above for the credit card connection, RedCard requires the following additional parameters. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
TransID | ans..18 | M | TransactionID which should be unique for each payment (less than 2147483648) |
RefNr | ns..30 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
OrderDesc | ans..512 | M | Description of purchased goods, unit prices etc. |
ChDesc | ans..256 | O | Text printed on the customer’s credit card bill alongside the payee |
Contact data/Address verification (AVS) | |||
AddrStreetNr | n..3 | O | Street number of the customer (for AVS) |
AddrZip | ans..8 | O | Postcode: only numbers are forwarded (for AVS) |
Additional parameters for credit card payments via socket connection for the RedCard connection
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description | |
---|---|---|---|---|
TransID | ans..18 | M | TransactionID which should be unique for each payment (less than 2147483648) | |
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. | |
ErrorText | ans..128 | O | Original error text from RedCard (if an error occurs), if agreed with Computop Helpdesk | |
CodeExt | n..10 | O | Original error code from RedCard (if an error occurs), if agreed with Computop Helpdesk | |
Match | a1 | O | Total result of an address verification: For possible values see manual Match parameters | |
TransactionSeqNo | n.. | O | RedCard unique transaction number. Is forwarded only. |
Additional response parameters for credit card payments via socket connection for the RedCard connection
RedSys: Caixa Catalunya, Sabadell
Besides the general parameters described above for the credit card connection, RedSys requires the following additional parameters. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. It is returned only for EVO partners. |
UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop |
Language | a2 | O | Language es – Spanish; en – English; ca – Catalan; fr – French; de – German; du – Dutch; it – Italian; se – Swedish; pt – Portuguese; pl – Polish; gl – Galician; eu – Basque |
CreditCardHolder | ans..60 | O | Name of the card holder in the format: <First name><space character><Last name> |
Additional parameters for credit card payments via socket connection for the RedSys connection
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
UserData | ans..1024 | O | If specified at request, Paygate forwards the parameter with the payment result to the shop |
Additional response parameters for credit card payments via socket connection for the RedSys connection
SafeCharge
Besides the general parameters described above for the credit card connection, SafeCharge requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
UserData | ans..1024 | O | If specified upon call, Paygate forwards the parameter with the payment result to the shop |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
CustomerID | an..20 | O | Login name of the customer |
ShopURL | an..128 | O | URL of wep page of the shop |
sdState | a2 | C | Code of Federal State in the delivery address. Mandatory only for card holders from USA and Canada |
bdFirstName | an..30 | O | First name of the customer |
bdLastName | an..30 | O | Last name of the customer |
bdStreet | an..100 | O | Customer’s address: Street name and house number |
bdCity | an..40 | O | Customer’s location |
bdZIPCode | an..10 | O | Postcode of the customer |
bdCountryCode | an2 | O | Country code of invoicing address according to ISO-3166-1, alphanumeric 2 chars |
bdPhone | an..20 | O | Customer’s phone number |
bdEmail | ans..64 | O | Email address of the customer |
IPAddr | ans..15 | O | Customer´s IP address for the transaction |
MultiSettleCount | n..2 | O | Relevant to VISA clearing message during authorisation. It represents the number of expected transactions in a multiple-settle Auth transaction. |
User data (if available all parameters need to be enclosed) | |||
Name | ans..100 | C | User name of the customer |
FirstName | ans..100 | C | First name of the customer |
LastName | ans..100 | C | Last name of the customer |
ans..64 | C | Email address of the customer | |
Language | a2 | C | Language of the customer according to ISO, alphanumeric 2-digits |
Delivery data (if available all parameters need to be enclosed) | |||
sdFirstName | ans..100 | C | First name in the delivery address |
sdLastName | ans..100 | C | Surname in the delivery address |
sdStreet | ans..200 | C | Street name in the delivery address |
sdStreetNr | ans..5 | C | Street number in the delivery address |
sdZIPCode | an..20 | C | Postcode in the delivery address |
sdCity | ans..40 | C | Town/city in the delivery address |
sdState | a2 | C | Code of Federal State in the delivery address |
sdCountryCode | a2 | C | Country code of delivery address according to ISO-3166-1, alphanumeric 2 chars |
Address verification (AVS) | |||
AddrStreet | ans..200 | O | Street name (for AVS) |
AddrZip | an..20 | O | Postcode (for AVS) |
AddrCountryCode | a2 | O | Country code according to ISO-3166-1 alphanumeric (2-digits) (for AVS) |
Additional parameters for credit card payments via socket connection for the SafeCharge connection
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
UserData | ans..1024 | O | If specified upon call, Paygate forwards the parameter with the payment result to the shop |
CodeExt | n2 | O | Extended response code from SafeCharge |
ErrorText | ans..255 | O | Detailed SafeCharge error message. Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk |
Additional response parameters for credit card payments via socket connection for the SafeCharge connection
SIA: BNL
For credit card connection SIA: BNP besides the general parameters described above CB2A requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ans..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
ChDesc | an..21 | O | Text printed on the customer’s credit card bill alongside the payee |
Additional parameters for credit card payments via socket connection for the SIA connection BNL
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ans..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
Additional response parameters for credit card payments via socket connection for the SIA connection BNL
Snap: EVO Payments
Besides the general parameters described above for the credit card connection, Snap requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
CustomerID | ans..64 | O | CustomerID given by the merchant with the transaction request |
OrderDesc | ans..768 | M | Description of purchased goods, unit prices etc. |
CreditCardHolder | ans..60 | O | Name of card holder (for AVS US domestic optional) |
Contact data/Address verification (AVS) | |||
sdFirstName | ans..25 | O | First name in the delivery address |
sdLastName | ans..25 | O | Last name in the delivery address |
sdMiddleName | ans..30 | O | Middle name in the delivery address |
sdTitle | ans..10 | O | Title in the delivery address, e.g. Dr. or Prof. |
sdSuffix | ans..15 | O | Suffix to the name |
sdStreet | ans..35 | O | Street name in the delivery address |
sdHouseNumber | ans..8 | O | Street number in the delivery address |
sdStreet2 | ans..35 | O | Address addition in the delivery address |
sdPOBox | ans..35 | O | Post office box in the delivery address |
sdZIPCode | ans..20 | O | Postcode in the delivery address |
sdCity | ans..35 | O | Town/city in the delivery address |
sdState | ans..10 | O | State/country in the delivery address |
sdCountryCode | a2/a3 | O | Country code of the delivery address according to ISO-3166-1, alphanumeric 2-digits or 3-digits (preferred) |
bdFirstName | ans..30 | O | First name in the invoicing address |
bdLastName | ans..30 | O | Last name in the invoicing address |
bdMiddleName | ans..30 | O | Middle name in the invoicing address |
bdSuffix | ans..15 | O | Suffix to the name in the invoicing address |
bdCompany | ans..100 | O | Company name in the invoicing address |
bdStreet | ans..35 | O | Street name in the invoicing address |
bdHouseNumber | ans..15 | O | Street number in the invoicing address |
bdStreet2 | ans..35 | O | Address addition in the billing address |
bdPOBox | ans..35 | O | Post office box in the invoicing address |
bdZIPCode | ans..20 | O | Postcode in the invoicing address |
bdCity | ans..35 | O | Town/city in the invoicing address |
bdState | ans..30 | O | State/country in the invoicing address |
bdCountryCode | a3 | O | Country code of invoicing address according to ISO-3166-1, alphanumeric 3 chars |
EmployeeID | ans..25 | OC | ID of the employee/cashier. Required for the branches retail, restaurant and for MOTO. |
ShipDate | an8 | OC | Shipment date in the format "YYYYMMDD": mandatory for MOTO |
AddrStreet | ans..100 | OC | Street name: it must be distinguished between AVS-US-Domestic and AVS-International. (for AVS) US-Domestic: Street and street number together; optional International: Street name (without street number); mandatory for AVS |
AddrStreetNr | ans..15 | OC | Street number of the customer: mandatory for AVS International |
AddrPOBox | ans..35 | O | Post office box (for AVS International) |
AddrZip | ans..10 | OC | Postcode, mandatory for AVS (US domestic as well as International) |
AddrCity | ans..50 | OC | Town/city, mandatory for AVS International |
AddrState | a2 | O | Code of the customer’s Federal State (for AVS) |
AddrCountryCode | a2/a3 | M | Country code according to ISO-3166-1, alphanumeric 2 or 3 chars (preferred) (for AVS) |
ans..128 | O | Email address of the customer (for AVS US domestic) | |
Phone | ans..20 | O | Telephone number of the customer (for AVS US domestic) |
Additional parameters for credit card payments via socket connection for the Snap connection
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
ErrorText | ans..128 | O | Error text from Snap, if agreed with Computop Helpdesk. Is returned only if ResponseExtended=Yes is configured for that merchant. |
CodeExt | n..10 | O | Error code from Snap, if agreed with Computop Helpdesk. Is returned only if ResponseExtended=Yes is configured for that merchant. |
Additional response parameters for credit card payments via socket connection for the Snap connection
UCS
Besides the general parameters described above for the credit card connection, UCS requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
OrderDesc | ans..768 | M | Description of purchased goods, unit prices etc. |
Additional parameters for credit card payments via socket connection for the UCS connection
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. It is returned only for EVO partners. |
Additional response parameters for credit card payments via socket connection for the UCS connection
Vantiv
Besides the general parameters described above for the credit card connection, Vantiv requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..25 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
CustomerID | ans..50 | O | Customer number. Format must be mutually agreed beforehand with Computop! |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
ChDesc | ans..25 | O | Text printed on the customer’s credit card bill alongside the payee. |
TaxAmount | n..10 | O | Tax amount of the entire order in the smallest currency unit. |
TaxExempt | an..5 | O | Code which indicates whether the transaction is subject to Sales Tax: true or false. True=taxless. Default value=false. |
OrderID1 | ans..15 | O | Invoice reference number |
Contact data/Address verification (AVS) | |||
bdFirstName | ans..25 | O | First name in the invoicing address (for AVS) |
bdLastName | ans..25 | O | Last name in the invoicing address (for AVS) |
bdStreet | ans..35 | O | Street name in the invoicing address (for AVS) Please note that bdStreet and bdStreetNr together may have 34 characters maximum. bdStreet and bdStreetNr are combined with a space character between and forwarded together. The total content is truncated after 35 characters. |
bdStreetNr | ans..35 | O | Street number in the invoicing address (for AVS) Please note that bdStreet and bdStreetNr together may have 34 characters maximum. bdStreet and bdStreetNr are combined with a space character between and forwarded together. The total content is truncated after 35 characters. |
bdStreet2 | ans..35 | O | Address addition in the billing address |
bdZIPCode | ans..20 | O | Postcode in the invoicing address (for AVS) |
bdCity | ans..35 | O | Town/city in the invoicing address |
bdState | ans..30 | O | State/country in the invoicing address |
bdCountryCode | a2 | O | Country code of invoicing address according to ISO-3166-1, alphanumeric 2 chars |
bdMail | ans..100 | O | Email address in the invoicing address |
bdPhone | ans..20 | O | Phone number in the invoicing address |
sdFirstName | ans..25 | O | First name in the delivery address |
sdLastName | ans..25 | O | Last name in the delivery address |
sdStreet | ans..35 | O | Street name in the delivery address Please note that sdrStreet and sdStreetNr together may have 34 characters maximum. sdStreet and sdStreetNr are combined with a space character between and forwarded together. The total content is truncated after 35 characters. |
sdStreetNr | ans..35 | O | Street number in the delivery address Please note that sdStreet and sdStreetNr together may have 34 characters maximum. sdStreet and sdStreetNr are combined with a space character between and forwarded together. The total content is truncated after 35 characters. |
sdStreet2 | ans..35 | O | Address addition in the delivery address |
sdZIPCode | ans..20 | O | Postcode in the delivery address |
sdCity | ans..35 | O | Town/city in the delivery address |
sdState | ans..30 | O | State/country in the delivery address |
sdCountryCode | a2 | O | Country code of delivery address according to ISO-3166-1, alphanumeric 2 chars |
sdMail | ans..100 | O | Email address in the delivery address |
sdPhone | ans..20 | O | Telephone number in the delivery address |
Additional parameters for credit card payments via socket connection for the Vantiv connection
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..25 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
ErrorText | ans..128 | O | Original error text from Vantiv (if an error occurs), if agreed with Computop Helpdesk |
CodeExt | n..10 | O | Original error code from Vantiv (if an error occurs), if agreed with Computop Helpdesk |
Match | a1 | O | Total result of an address verification: For possible values see manual Match parameters |
ResponseTime | an19 | O | Time stamp of response in the format YYYY-MM-DDDHH:MM:SS |
LitleTxnID | an19 | M | Litle transaction ID |
ApprovalCode | ans..6 | O | Authorisation code of the Auth- or Sale-transaction |
ApprovedAmount | n8 | O | Approved amount |
PayfacFraudResult | enum | O | Result fraud prevention „“ Ecom, CAVV nonexistent „0“ CAVV data field formatted not correctly; check not possible. „1“ CAVV check failed „2“ CAVV check successful „3“ CAVV check successful „4“ CAVV check failed „5“ Presently not used „6“ CAVV not checked, because issuer does not require a check. VisaNet processed as if CAVV would be valid „7“ CAVV check failed „8“ CAVV check successful “9” CAVV test failed; Visa generated CAVV because issuer ACS was not available. “A” CAVV test successful; Visa generated CAVV because issuer Access Control Server (ACS) was not available. “B” CAVV test successful but no liability shift because a) ECI was not 5 or 6 or b) the card type is excluded (e.g. customer card) “C” issuer selected the return of a CAVV test result and the field 44.13 is empty. The value is set by VisaNet; means that CAVV result is valid “D” issuer selected the return of a CAVV test result and the field 44.13 is empty. The value is set by VisaNet; means that CAVV result is valid. |
CVVResult | enum an..2 | O | Check result: "M"=Correlation; |
FundingSourceType | enum a..7 | O | „UNKNOWN“ „PREPAID” „CREDIT” „DEBIT” „FSA“ (Flexible Spending Account, IRS approved healthcare) |
FundingSourceBalance | an..20 | O | Available amount or „Not Available“ |
FundingSourceReloadable | enum an..7 | O | „UNKNOWN“ „YES“ „NO“ |
FundingSourcePrepaidCardType | enum an..7 | OC | Only if FundingSourceType="PREPAID": Prepaid card type, e.g. „TEEN“, „GIFT“, „PAYROLL“ etc. |
IssuerCountry | an3 | O | Country code of issuing bank |
CardProductType | enum an..10 | O | „COMMERCIAL“ „CONSUMER“ „UNKNOWN“ |
Affluence | enum an..13 | O | Only parts from VISA and MasterCard „MASS AFFLUENT“ > 100K yearly income „AFFLUENT“ >100 K yearly income + > 40K revenue If below 100K the parameter is not returned to Computop |
Additional response parameters for credit card payments via socket connection for the Vantiv connection
viaConex: Elavon
Besides the general parameters described above for the credit card connection, viaConex requires the following additional parameters. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
RefNr | ns..30 | M | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription |
Contact data/Address verification (AVS) | |||
AddrStreet | ans..128 | O | Street name (for AVS) |
AddrStreetNr | ans..10 | O | Street number of the customer (for AVS) |
AddrZip | ans..20 | O | Postcode (for AVS) |
Additional parameters for credit card payments via socket connection for the viaConex connection
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
ErrorText | ans..128 | O | Error text from downstream system: Is returned as additional information only in the case of certain errors |
Match | a1 | O | Total result of an address check (Elavon USA): For possible values see manual Match parameters |
Additional response parameters for credit card payments via socket connection for the viaConex connection
Wirecard
Besides the general parameters described above for the credit card connection, WirecardCC requires the following additional parameters. An authorisation with 3-D Secure is possible. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description | |
---|---|---|---|---|
TransID | ans..32 | M | TransactionID which should be unique for each payment | |
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. | |
CreditCardHolder | ans..30 | O | Name of the card holder | |
RTF | a1 | O | for repeat payments (subscriptions): I = Initial payment of a new subscription | |
ChDesc | ans..256 | O | Text printed on the customer’s credit card bill alongside the payee. Umlauts and „ß“ are not allowed. | |
AccVerify | a3 | O | If AccVerify=Yes the card will be checked at the acquirer according to the acquirer’s interface description. The merchant has to submit only this parameter, the parameter "Amount" is optional. If "Amount" is used we replace the amount according to acquirer’s interface description. At payment always Amount=0 is stored. Allowed value: yes | |
TIN | an..32 | O | TaxIdentificationNumber (Tax identification number) | |
CountryCode | a2 | O | Country code in the card holder's address according to ISO-3166-1, alphanumeric 2-digits | |
SubMID | ans..15 | O | SubMerchantID assigned from the Payment Facilitator and provided in the request to identify its sub-merchants during transaction flow. | |
SubMIDName | ans..22 | O | Name of the SubMerchantID | |
SubMIDAddrStreet | ans..38 | O | Street of the SubMerchantID | |
SubMIDAddrCity | ans..13 | O | Town/city of the SubMerchantID | |
SubMIDAddrZip | ans..10 | O | Postcode of the SubMerchantID | |
SubMIDAddrState | ans3 | O | Federal State of the SubMerchantID | |
SubMIDAddrCountryCode | a2 | O | Country code of the SubMerchantID according to ISO-3166-1, alphanumeric 2 chars | |
Contact data/Address verification (AVS) | ||||
FirstName | an..12 | M | First name of the customer (mandatory for AVS) | |
LastName | an..12 | M | Last name of the customer (mandatory for AVS) | |
AddrStreet | an..25 | M | Street name of the credit card holder (mandatory for AVS) | |
AddrStreetNr | an..25 | O | Name of the card holder (mandatory for AVS) | |
AddrZip | an..12 | O | Postcode (mandatory for AVS) | |
AddrCity | an..32 | C | Town/city (mandatory for AVS) | |
AddrState | a2 | C | Code of the customer’s Federal State (for AVS optional) | |
AddrCountryCode | a2 | O | Country code according to ISO-3166-1, alphanumeric 2 chars | |
ans..256 | C | Email address of the customer | ||
Phone | an..32 | O | Telephone number of the card holder. (mandatory for AVS) It can be transmitted in the following formats: +xxx(yyy)zzz-zzzz-ppp +xxx (yyy) zzz zzzz ppp +xxx(yyy)zzz/zzzz/ppp +xxx(yyy)zzzzzzzppp where: xxx = country code yyy = national area code zzzzzzz = regional/local code and local number ppp = subsidiary direct access Delimiter like /, \ and – are allowed. Example: a typical international number would be “+44(0)555-5555-739” with the direct access line 739 for local telephone number 555- 5555 with the national area code 0 and country code 44. For countries without national area code the format must be configured with or without space characters. | |
DateOfBirth | an10 | O | Date of birth in the format YYYY-MM-DD | |
DrivingLicenceNumber | ans..37 | O | Driver's licence number |
Additional parameters for credit card payments via socket connection for the Wirecard connection
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description | |
---|---|---|---|---|
TransID | ans..32 | M | TransactionID which should be unique for each payment | |
GuWID | ans..22 | O | TransactionID of the Acquiring Bank | |
Match | a1 | O | Total result of an address verification: For possible values see manual Match parameters (F,P,N,U,E) |
Additional response parameters for credit card payments via socket connection for the Wirecard connection
Capture / Credit / Reversal
Capture
Captures are possible via a Server-to-Server connection. To perform a capture via a Server-to-Server connection please use the following URL:
https://www.computop-paygate.com/capture.aspx |
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
PayID | an32 | M | ID assigned by Paygate for the payment to be captured |
TransID | ans..64 | M | ID assigned by Merchant for the payment process to be captured. Please note for some connections the different formats that are given within the specific parameters. |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact Computop Helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency code, three digits DIN / ISO 4217 |
RefNr | ns..30 | C | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. (not with EVO Payments, for CardComplete in the format an..25, for Cofidis in the format n..15, for Omnipay in the format ns..15, for RBI in the format ns..20) |
ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
FinishAuth | a1 | C | Only with ETM: Transmit value <Y> in order to stop the renewal of guaranteed authorisations and rest amounts after partial captures. Please use this parameter only if you are using the additional function ETM (Extended Transactions Managament). (not with Clearhaus) |
Textfeld1 | ans..30 | O | Card holder information: Name (not with Clearhaus) |
Textfeld2 | ans..30 | O | Card holder information: City (not with Clearhaus) |
CHDesc | ans..22 | OC | Only with Clearhaus: Text printed on the customer’s credit card bill. Only printable ASCII characters from 0x20 to 0x7E |
Parameters for captures of credit card payments
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description | |
---|---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by Computop | |
PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files. | |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | |
TransID | ans..64 | M | Merchant’s transaction number. Please note for some connections the different formats that are given within the specific parameters. | |
Status | a..50 | M | OK or FAILED | |
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! | |
Code | n8 | M | Error code according to Paygate Response Codes (A4 Error codes) | |
RefNr | ns..30 | C | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. (not with EVO Payments, for Card Complete in the format an..25, for Omnipay in the format ns..15, for RBI in the format ns..20) | |
AID | n6 | OC | Only in the case of Card Complete: Authorisation ID returned by Card Complete | |
Amount | n..10 | OC | Only with Clearhaus: Amount in the smallest currency unit (e.g. EUR Cent) If the actual amount differs from the requested amount this will be returned. Only with MasaPay: The amount has to be equal to the originally authorised amount. | |
CodeExt | n5 | OC | Only with Clearhaus: Only if configured: External error code (downstream system). Only with MasaPay: Format ans..10, error code from MasaPay. | |
ErrorText | ans.128 | OC | Only with Clearhaus: Detailed Clearhaus error message. Only with MasaPay: Format ans..128, detailed MasaPay error message. Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk | |
TransactionID | ans36 | OC | Only with Clearhaus: Transaction number from Clearhaus | |
GuWID | ans..22 | O | Only with Wirecard: TransactionID of the Acquiring Bank | |
TID | n..15 | M | Only with Cofidis: If RefNr was submitted, it's value will be returned. Otherwise the first 15 digits of TransactionID will be returned. |
Response parameters for captures of credit card payments
Credit with reference
Credits (refunds) are possible via a Server-to-Server connection. Paygate permits credits which relate to a capture previously activated by Paygate and allows merchants to carry out credits without a reference transaction. This section describes the processing of credits with reference transactions. If you refer to a capture for a Credit, the amount of the Credit is limited to the amount of the previous capture.
To carry out a credit with a reference transaction, please use the following URL:
https://www.computop-paygate.com/credit.aspx |
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
PayID | an32 | M | ID assigned by Paygate for the payment to be credited |
TransID | ans..64 | M | ID assigned by Merchant for the payment process to be credited. Please note for some connections the different formats that are given within the specific parameters. |
RefNr | an..25 | C | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. Only for CardComplete, for Clearhaus (ns..30, optional, only printable ASCII characters from 0x20 to 0x7E), for RBI (ns..20, optional), for MasaPay (ns..30, optional), for Cofidis (n..15, optional). |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact Computop Helpdeskif you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency code, three digits DIN / ISO 4217 |
OrderDesc | ans..768 | O | Description of refunded goods, unit prices, merchant’s comment etc. (not with Clearhaus) |
ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
Textfeld1 | ans..30 | O | Card holder information: Name (not with Clearhaus) |
Textfeld2 | ans..30 | O | Card holder information: City (not with Clearhaus) |
CHDesc | ans..22 | OC | Only with Clearhaus: Text printed on the customer’s credit card bill. Only printable ASCII characters from 0x20 to 0x7E |
TID | ans..30 | OC | Only with SafeCharge: TransaktioncID of the capture to be credited, if the merchants wants to credit a specifc capture. If the parameter is nut submitted the last capture will be credited. |
Additional parameters for Wirecard connection (for Visa Direct) | |||
refundType | enum | C | Type of refund. Possible values: “p2p”, “md”, “acc2acc”. “ccBill”, “fd” |
receiverFirstName | an..12 | C | First name of the receiver. Mandatory for cross-border transactions. |
receiverLastName | an..12 | C | Last name of the receiver. Mandatory for cross-border transactions. |
senderAccountNumber | n..12 | C | Account number of the sender. Mastercard: Mandatory. Visa: Mandatory, if RefNr is empty. |
senderFirstName | an..12 | C | First name of the sender. Mastercard: Mandatory. Visa: Mandatory for US domestic transactions and cross-border money transfers. |
senderLastName | an..12 | C | Last name of the sender. Mastercard: Mandatory. Visa: Optional. |
senderAddrStreet | an..25 | C | Street name of the sender. Mastercard: Optional. Visa: Mandatory for US domestic transactions and cross-border money transfers. |
senderAddrStreetNr | an..25 | C | Street number of the sender. Mastercard: Optional. Visa: Mandatory for US domestic transactions and cross-border money transfers. |
senderAddrCity | an..32 | C | Town/city of the sender. Mastercard: Optional. Visa: Mandatory for US domestic transactions and cross-border money transfers. |
senderAddrState | a2 | C | State of the sender. Mastercard: Mandatory, if senderAddrCountry=US or Canada. Visa: Mandatory for US domestic transactions and cross-border money transfers. |
senderAddrCountry | a2 | C | Country of the sender. Mastercard: Optional. Visa: Mandatory if country is US and for cross-border money transfers. |
Parameters for credits of credit card payments
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description | |
---|---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by Computop | |
PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files. | |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | |
TransID | ans..64 | M | Merchant’s transaction number. Please note for some connections the different formats that are given within the specific parameters. | |
Status | a..50 | M | OK or FAILED | |
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! | |
Code | n8 | M | Error code according to Paygate Response Codes (A4 Error codes) | |
AID | n6 | OC | Only in the case of Card Complete: Authorisation ID returned by Card Complete | |
RefNr | an..25 | OC | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. Only for Card Complete, for Clearhaus (ans..30, optional, only printable ASCII characters from 0x20 to 0x7E), for RBI (ns..20, optional), for MasaPay (ns..30, optional), for Cofidis (n..15, optional). | |
Amount | n..10 | OC | Only with Clearhaus: Amount in the smallest currency unit (e.g. EUR Cent) If the actual amount differs from the requested amount this will be returned. Only with MasaPay: The amount has to be equal to the originally authorised amount. | |
CodeExt | n5 | OC | Only with Clearhaus: Only if configured: External error code (downstream system). Only with MasaPay: Format ans..10, error code from MasaPay. | |
ErrorText | ans.128 | OC | Only with Clearhaus: Detailed Clearhaus error message. Only with MasaPay: Format ans..128, detailed MasaPay error message. Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk | |
TransactionID | ans36 | OC | Only with Clearhaus: Transaction number from Clearhaus |
Response parameters for credits of credit card payments
Credit without reference
Paygate can carry out Credits which do not relate to a previous capture. In this case the credit must be transferred to Paygate as a completely new payment transaction. Please contact the Computop Helpdesk for help in using the described additional functions.
Notice: Please note that credits without reference to a previous capture generate higher costs with your Acquiring Bank. If you are frequently unable to make reference to the capture you should agree this with your Acquiring Bank.
To carry out a Credit without a reference transaction via a Server-to-Server connection, please use the following URL:
https://www.computop-paygate.com/creditex.aspx |
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
TransID | ans..64 | M | TransactionID which should be unique for each payment. Please note for some connections the different formats that are given within the specific parameters. |
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. For CardComplete in the format an..25. |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact Computop Helpdesk if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency code, three digits DIN / ISO 4217 |
ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
CCNr | n..16 | M | Credit card number at least 12-digit, numerical without spaces |
CCCVC | n..4 | O | Card verification number: The last 3 digits on the signature strip of the credit card. 4 numbers in the case of American Express. |
CCExpiry | n6 | M | Expiry date of the credit card in the format YYYYMM, e.g. 201707. |
CCBrand | a..22 | M | Credit card brand. Please note the spelling! According to table of credit card brands! |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
OrderDesc | ans..768 | MC | Not with Clearhaus: Description of refunded goods, unit prices, merchant’s comment etc. |
UserData | ans..1024 | OC | Only with Clearhaus: If specified at request, Paygate forwards the parameter with the payment result to the shop. |
ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
Textfeld1 | ans..30 | O | Not with Clearhaus: Card holder information: Name |
Textfeld2 | ans..30 | O | Not with Clearhaus: Card holder information: City |
CHDesc | ans..34 | OC | Only with Clearhaus, format ans..22: Text printed on the customer’s credit card bill. Only printable ASCII characters from 0x20 to 0x7E Only for Credorax: Text printed on the customer’s credit card bill. This function must be enabled by Credorax and have the following structure. 1) merchant DBA name (up to 20 characters) 2) asterisk 3) additional text (up to 13 characters). e.g. Computop*Test This value can be alternatively permanently archived by Computop Helpdesk |
CreditCardHolder | an..255 | MC | Only with Credorax, ECPCC: Name of the card holder |
ans..64 | MC | Only with Credorax, ECPCC: Email address of the customer | |
IPAddr | ans..15 | OC | Only with Credorax, ECPCC: Customer´s IP address |
PaymentOfWinnings | ans..4 | OC | In the case of the acquirer EMS (Omnipay) the merchant can control CFT credit notes in this way. |
TransactionID | an..150 | M | Additional reference number |
Further address parameters in case of ECPCC connection | |||
DateOfBirth | n8 | O | Date of birth of the customer in format YYYYMMDD |
Phone | n..32 | O | Customer’s phone number |
FirstName | ans..255 | M | First name of the customer |
LastName | ans..255 | M | Last name of the customer |
AddrStreet | ans..255 | O | Street name |
AddressAddition | ans..255 | O | Address c/o |
AddrZip | an..9 | O | Postcode |
AddrCity | ans..255 | O | City |
AddrState | a2 | O | Code of the customer’s Federal State |
AddrCountryCode | a2 | M | Country code according to ISO-3166-1, alphanumeric 2 chars |
sdFirstName | ans..255 | O | First name in the delivery address |
sdLastName | ans..255 | O | Surname in the delivery address |
sdStreet | ans..255 | O | Street name in the delivery address |
sdAddressAddition | ans..255 | O | Address addition in the delivery address |
sdZIPCode | an..9 | O | Postcode in the delivery address |
sdCity | ans..255 | O | Town/city in the delivery address |
sdState | a2 | O | Code of Federal State in the delivery address |
sdCountryCode | a2 | O | Country code of delivery address according to ISO-3166-1, alphanumeric 2 chars |
Further address parameters in case of Kalixa connection | |||
IPAddr | ans..15 | M | Customer´s IP address |
BrowserSessionID | ans..64 | M | Customer´s Session ID |
CreditCardHolder | ans..100 | M | Name of the card holder |
CustomerID | an..20 | M | Customer number: Number to identify the customer |
Name | ans..100 | C | User name of the customer |
FirstName | ans..100 | C | First name of the customer |
LastName | ans..100 | C | Last name of the customer |
ans..64 | C | Email address of the customer | |
Language | a2 | C | Language of the customer according to ISO, alphanumeric 2-digits |
sdFirstName | ans..100 | C | First name in the delivery address |
sdLastName | ans..100 | C | Surname in the delivery address |
sdStreet | ans..200 | C | Street name in the delivery address |
sdStreetNr | ans..5 | C | Street number in the delivery address |
sdZIPCode | an..20 | C | Postcode in the delivery address |
sdCity | ans..40 | C | Town/city in the delivery address |
sdState | a2 | C | Code of Federal State in the delivery address |
sdCountryCode | a2 | C | Country code of delivery address according to ISO-3166-1, alphanumeric 2 chars |
Further address parameters in case of Vantiv connection | |||
bdFirstName | ans..25 | O | First name in the invoicing address |
bdLastName | ans..25 | O | Last name in the invoicing address |
bdStreet | ans..35 | O | Street name in the invoicing address Please note that bdStreet and bdStreetNr together may have 34 characters maximum. bdStreet and bdStreetNr are combined with a space character between and forwarded together. The total content is truncated after 35 characters. |
bdStreetNr | ans..35 | O | Street number in the invoicing address Please note that bdStreet and bdStreetNr together may have 34 characters maximum. bdStreet and bdStreetNr are combined with a space character between and forwarded together. The total content is truncated after 35 characters. |
bdStreet2 | ans..35 | O | Address addition in the billing address |
bdZIPCode | ans..20 | O | Postcode in the invoicing address |
bdCity | ans..35 | O | Town/city in the invoicing address |
bdState | ans..30 | O | State/country in the invoicing address |
bdCountryCode | a2 | O | Country code of invoicing address according to ISO-3166-1, alphanumeric 2 chars |
bdMail | ans..100 | O | Email address in the invoicing address |
bdPhone | ans..20 | O | Phone number in the invoicing address |
Parameters for credits of credit card payments without reference
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description | |
---|---|---|---|---|
MID | ans..30 | MC | MerchantID, assigned by Computop | |
PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files. | |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | |
TransID | ans..64 | M | Merchant’s transaction number. Please note for some connections the different formats that are given within the specific parameters. | |
Status | a..50 | M | OK or FAILED | |
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! | |
Code | n8 | M | Error code according to Paygate Response Codes (A4 Error codes) | |
AID | n6 | OC | Only in the case of Card Complete: Authorisation ID returned by Card Complete | |
RefNr | an..25 | OC | Only for Card Complete: If a RefNr has been transmitted, it is returned. | |
Amount | n..10 | OC | Only with Clearhaus: Amount in the smallest currency unit (e.g. EUR Cent) If the actual amount differs from the requested amount this will be returned. | |
CodeExt | n5 | OC | Only with Clearhaus: Only if configured: External error code (downstream system) | |
ErrorText | ans.128 | OC | Only with Clearhaus: Detailed Clearhaus error message. Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk | |
UserData | ans..1024 | OC | Only with Clearhaus: If specified at request, Paygate forwards the parameter with the payment result to the shop. | |
TransactionID | ans36 | OC | Only with Clearhaus: Transaction number from Clearhaus |
Response parameters for credits of credit card payments without reference
Reversal
A credit card authorisation lowers the customer's credit line. Paygate can reverse an authorisation so that it no longer block the limit any more. Use the following URL:
https://www.computop-paygate.com/reverse.aspx |
Notice: Reverse.aspx does not only reverse authorisations, but any LAST TRANSACTION STAGE!! If the last transaction was a capture, Reverse.aspx initiates the reverse, e.g. a credit. Therefore, the utmost caution is urged. Use is at your own risk. We recommend checking the transaction status with Inquire.aspx before using Reverse.aspx.
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter. The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
PayID | an32 | M | Paygate ID for the identification of a payment |
TransID | ans..64 | M | Merchant ID for the identification of the payment process to be reversed. Please note for some connections the different formats that are given within the specific parameters. |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact Computop Helpdesk if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency code, three digits DIN / ISO 4217 |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
RefNr | ans..30 | OC | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. Only for Clearhaus (only printable ASCII characters from 0x20 to 0x7E), for MasaPay. |
ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
Parameters for reversals of credit card payments
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description | |
---|---|---|---|---|
MID | ans..30 | MC | MerchantID, assigned by Computop | |
PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files. | |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate | |
TransID | ans..64 | M | Merchant’s transaction number. Please note for some connections the different formats that are given within the specific parameters. | |
Status | a..50 | M | OK or FAILED | |
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! | |
Code | n8 | M | Error code according to Paygate Response Codes (A4 Error codes) | |
RefNr | an..25 | OC | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. Only for Card Complete, for Clearhaus (ans..30, only printable ASCII characters from 0x20 to 0x7E), for MasaPay (ns..30). | |
AID | n6 | OC | Only in the case of Card Complete: Authorisation ID returned by Card Complete | |
CodeExt | n5 | OC | Only with Clearhaus: Only if configured: External error code (downstream system) Only with MasaPay: Format ans..10, error code from MasaPay | |
ErrorText | ans.128 | OC | Only with Clearhaus: Detailed Clearhaus error message. Only with MasaPay: Format ans..128, detailed MasaPay error message. Is returned only if Status=FAILED. Use is possible only in agreement with Computop Helpdesk | |
TransactionID | ans36 | OC | Only with Clearhaus: Transaction number from Clearhaus |
Response parameters for reversals of credit card payments
Reversal of an authorisation extension
A credit card authorisation is valid for only 7 to 30 days. In order to maintain your payment claim in the case of longer delivery times, Paygate enables the automatic renewal of the authorisation. Renewal of the authorisation is also important for instalments or partial deliveries because the outstanding amount is invalid in the case of partial captures.
If you use authorisation renewal, Paygate renews your authorisations until the payment has been captured fully. Amongst other things the customer's card limit is reduced by the authorised amount. In order to restore the card limit again, for example because the order cannot be fully delivered, you need to specifically cancel the authorisation renewal with the following URL:
https://www.computop-paygate.com/cancelAuth.aspx |
Notice: CancelAuth cancels only the recurrence of the authorisation. If you wish to unblock the customer's card limit, please reverse the authorisation in accordance with the section above.
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files. |
TransID | ans..64 | M | Merchant ID for the identification of the payment process to be reversed |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
Parameters for reversal of an authorisation extension
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by Computop |
PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files. |
TransID | ans..64 | M | Merchant’s transaction number |
Status | a..50 | M | OK or FAILED |
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! |
Code | n8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
Result parameters for reversals of an authorisation extension
Credit card payment via POS terminals
To make a credit card payment via a POS terminal (POS: Point of Sale), send the payment request to the following URL:
https://www.computop-paygate.com/stationary.aspx |
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
TransID | ans..64 | M | TransactionID which should be unique for each payment |
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. Format must be mutually agreed beforehand with Computop! |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact Computop Helpdesk if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency code, three digits DIN / ISO 4217 |
CCNr | n..16 | M | Credit card number at least 12-digit, numerical without spaces |
CCCVC | n..4 | O | Card verification number: The last 3 digits on the signature strip of the credit card. 4 numbers in the case of American Express. |
CCExpiry | n6 | M | Expiry date of the credit card in the format YYYYMM, e.g. 201707. |
CCBrand | a..22 | M | Credit card brand. Please note the spelling! According to table of credit card brands! |
Track2 | ans..80 | M | Hexadecimal data on track 2 of the credit card |
Track3 | ans..80 | M | Hexadecimal data on track 3 of the credit card |
Capture | ans..6 | O | Determines the type and time of capture. AUTO: capturing immediately after authorisation (default value). MANUAL: capturing made by the merchant. <Number>: Delay in hours until the capture (whole number; 1 to 696). |
OrderDesc | ans..768 | M | Description of purchased goods, unit prices etc. |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
ReqID | ans..32 | O | To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly. |
Parameters for credit card payments via POS terminals
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by Computop |
PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files. |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
TransID | ans..64 | M | Merchant’s transaction number |
TID | n..20 | M | Usually a nine-digit terminal number |
AuthCode | ans..6 | M | Acquiring Bank's authorisation code |
Status | a..50 | M | AUTHORIZED or FAILED. OK status applies only to Sale transactions. |
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! |
Code | n8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
Response parameters for credit card payments via POS terminals
Reversal of POS credit card payments
To reverse the capture of a credit card payment via a stationary terminal, please use the following URL:
https://www.computop-paygate.com/stationary_rev.aspx |
Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files. |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
TransID | ans..64 | M | Merchant ID for the identification of the payment process to be reversed |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
Parameters for reversal of credit card payments via POS terminals
The following table describes the result parameters with which the Computop Paygate responds 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. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by Computop |
PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files |
TransID | ans..64 | M | Merchant’s transaction number |
Status | a..50 | M | OK or FAILED |
Code | n8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
Response parameters for reversal of credit card payments via POS terminals
PayNow
Silent Mode for credit cards with SSL and 3-D Secure method
PayNow links the benefits of Paygate forms and Server-to-Server connections: AS opposed to the Paygate form, where the form is loaded from the Paygate server by calling payssl.aspx, the PayNow form has to be provided by the merchant’s system. The form uses the same parameters as described here below.
In contrast to the Paygate form, the parameters are not forwarded as URL parameters as is the case when calling the payssl.aspx, but as form input parameters. By the way for calling the PayNow.aspx the same parameters can be used as for PaySSL.aspx.
Paygate-Formular | PayNow |
---|---|
payssl.aspx?MerchantID=[mid]&Len=[len]&Data=[data] | <form action=paynow.aspx> <input type="hidden" name="MerchantID" value=[mid]> <input type="hidden" name="Len" value=[len]> <input type="hidden" name="Data" value=[data]> : </form> |
The credit card data must be transmitted to paynow.aspx with the following parameters:
Parameter | Format | CND | Description |
---|---|---|---|
CCNr | n..16 | M | Credit card number at least 12-digit, numerical without spaces |
CCCVC | n3 | O | Card verification number: The last 3 digits on the signature strip of the credit card |
CCExpiry | n6 | M | Expiry date of the credit card in the format YYYYMM, e.g. 201807. |
CCBrand | a..22 | M | Credit card brand. Please note the spelling! According to table of credit card brands! |
PayNow parameters for 3-D Secure method
After the customer has entered his credit card data, the payment data is forwarded to the PayNow page, where the further payment processing takes place via 3-D Secure. The form details must be directly forwarded to the PayNow page and may not be transmitted to the merchant’s system! Also, no PCI-relevant data may be transmitted to the PayNow page as additional input parameters!
Batch processing via the interface
Basic information about using Batch files and about their structure can be found in the Batch Manager manual. Within batch processing not alle functions are available which are usually available for the online interface.
Batch calls and answers
This section describes the parameters which must be transferred within the data set (Record) for executing a credit card payment and which information can be found within the response file about the payment status.
Notice: Within Batch process not all functions of online interface are available.
For Batch calls there must be considered batch versions, from which optional parameters depend. All version designations starting with „2.“ pertain calls for a group of enterprises. That means within a batch file for a particular MerchantID can be transferred transactions for other merchants with a separate Sub-MID.
For the connections ECPCC, GMO, Kalixa and SafeCharge the possible actions are limited to Capture, Credit and Reverse.
Following table gives an overview of all batch versions that are possible for a specific action and their specialities:
Action | Version | Description |
---|---|---|
Authorize | 1.2 / 2.2 | with textfeld1, textfeld2, RTF, cardholder, transactionID, schemeReferenceID |
| 1.21 / 2.21 | with textfeld1, textfeld2, RTF, approvalcode, cardholder, transactionID, schemeReferenceID |
| 1.3 / 2.3 | with CVC, transactionID, schemeReferenceID |
| 1.5 / 2.5 | with CVC, Zone |
Capture | 1.2 / 2.2 | with textfeld1, textfeld2 |
| 1.21 / 2.21 | with textfeld1, textfeld2, approvalcode |
| 1.4 / 2.4 | with stop of authorisation renewal (FinishAuth) |
CaptureEx | 1.3 / 2.3 | with CVC |
Credit | 1.2 / 2.2 | with textfeld1, textfeld2 |
| 1.21 / 2.21 | with textfeld1, textfeld2 |
| 1.4 / 2.4 | with stop of authorisation renewal (FinishAuth) |
CreditEx | 1.2 / 2.2 | with textfeld1, textfeld2 |
| 1.21 / 2.21 | with textfeld1, textfeld2 |
| 1.3 / 2.3 | with textfeld1, textfeld2 |
Sale | 1.2 / 2.2 | with textfeld1, textfeld2, RTF, cardholder, transactionID, schemeReferenceID |
| 1.21 / 2.21 | with textfeld1, textfeld2, RTF, approvalcode, cardholder, transactionID, schemeReferenceID |
| 1.3 / 2.3 | with CVC, textfeld1, textfeld2, transactionID, schemeReferenceID |
| 1.5 / 2.5 | with CVC, Zone |
Reverse | 1.x / 2.x | Standard version |
Description of the possible batch versions
The structure for a credit card payment within a Batch file to be submitted is the following:
HEAD,<MerchantID>,<Date>,<Version> CC,Authorize,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>, [<CCCVC>,]<CCExpiry>,<OrderDesc>[,<textfeld1>,<textfeld2>,<RTF>,<approvalcode>,<cardholder>,<Zone>,<transactionID>,<schemeReferenceID>] CC,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>),<PayID>,[<FinishAuth,<textfeld1>,<textfeld2>,<approvalcode>] CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>, [<CCCVC>,]<CCExpiry>,<OrderDesc>[,<textfeld1>,<textfeld2>,<RTF>,<approvalcode>,<cardholder>,<Zone>,<transactionID>,<schemeReferenceID>]] CC,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>),<PayID>[,<FinishAuth>,<textfeld1>,<textfeld2>] CC,CreditEx,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>, [<CCCVC>,]<CCExpiry>,<OrderDesc>[,<textfeld1>,<textfeld2>] CC,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>),<PayID> FOOT,<CountRecords>,<SumAmount> |
Example for batch versions:
Version 1.2: CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>,<CCExpiry>,<OrderDesc> CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>,<CCExpiry>,<OrderDesc>,<textfeld1>,<textfeld2>,<RTF>,<cardholder>,<transactionID>,<schemeReferenceID> Version 1.21: CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>,<CCExpiry>,<OrderDesc>,<textfeld1>,<textfeld2>,<RTF>,<approvalcode>,<cardholder>,<transactionID>,<schemeReferenceID> Version 1.3: CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>,<CCCVC>,<CCExpiry>,<OrderDesc>,<textfeld1>,<textfeld2>,<transactionID>,<schemeReferenceID> Version 1.5: CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>,<CCCVC>,<CCExpiry>,<OrderDesc>,<Zone> |
Example for Master MID Funktion:
HEAD,[Master]MerchantID,Date,2.x Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action) FOOT,CountRecords,SumAmount |
The following table describes the individual fields and values used within the data set (record) in the batch file:
Parameter | Format | CND | Description |
---|---|---|---|
Type | a..11 | M | HEAD for Header, FOOT for Footer, CC for credit card |
Action | a..20 | M | The parameter Action defines the type of transaction: Authorize (authorisation) Capture Sale Credit CreditEx (credit note without previous capture; please agree this with Computop Helpdesk beforehand) Reverse (cancellation) |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact Computop Helpdesk if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency code, three digits DIN / ISO 4217 |
TransID | ans..64 | M | TransactionID which should be unique for each payment. Please note for some connections the different formats that are given within the specific parameters. |
RefNr | ns..30 | O | Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data. |
PayID | an32 | M | ID for this transaction given by Paygate |
OrderDesc | ans..127 | O | Description of purchased goods, unit prices etc. |
CCBrand | a..22 | C | Credit card brand. Please note the spelling! According to table of credit card brands! |
CCNr | n..16 | C | Credit card number at least 12-digit, numerical without spaces. You can optionally transmit also a pseudo card number (PCN) |
PCNr | n..16 | O | You can optionally transmit also a pseudo card number (PCN) instead of the real credit card number |
CCCVC | n..4 | O | Card verification number in Version 1.3: In the case of Visa and MasterCard the last 3 numbers on the signature strip of the credit card. 4 numbers in the case of American Express. |
CCExpiry | n6 | O | Expiry date of the credit card in the format YYYYMM, e.g. 201707. |
FinishAuth | ans1 | O | Version=1.4: If using the authorisation renewal, cancel repeat with the value Y in the field FinishAuth in the case of Capture or Credit. Example: You capture a partial delivery. The rest of the order cannot be supplied. You therefore enter Y in the FinishAuth field for Part-capture so that the Paygate does not authorise the remaining amount. Please note for this also the following section about Cancel authorisation renewals. |
Description of fields within the record for Batch files
The record area within the response file for Batch transactions looks as follows:
HEAD,<MerchantID>,<Date>,<Version> CC,Authorize,<Amount>,<Currency>,<TransID>,(<RefNr>),<PayID>,<CCBrand>,<CCNr|PCNr>,[<CCCVC>,]<CCExpiry>,<OrderDesc>[,<textfeld1>,<textfeld2>,<RTF>,<approvalcode>,<cardholder>,<Zone>,<transactionID>,<schemeReferenceID>],<Status>,<Code> CC,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>),<PayID>[<textfeld1>,<textfeld2>,<approvalcode>],<Status>,<Code> CC,AuthSplit,<Amount>,<Currency>,<TransID>,(<RefNr>),<PayID>,FAILED,<Code>,<Description>,[<PCNr>] CC,Renewal,<Amount>,<Currency>,<TransID>,(<RefNr>),<PayID>,FAILED,<Code>,<Description>,[<PCNr>] CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>),<PayID>,<CCBrand>,<CCNr|PCNr>,[<CCCVC>,]<CCExpiry>,<OrderDesc>[,<textfeld1>,<textfeld2>,<RTF>,<approvalcode>,<cardholder>,<Zone>,<transactionID>,<schemeReferenceID>],<Status>,<Code> CC,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>),<PayID>[,<FinishAuth>,<textfeld1>,<textfeld2>],<Status>,<Code> CC,CreditEx,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>,[<CCCVC>,]<CCExpiry>,<OrderDesc>[,<textfeld1>,<textfeld2>],<Status>,<Code> CC,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>),<PayID>,<Status>,<Code> FOOT,<CountRecords>,<SumAmount> |
Example for batch versions:
Version 1.2: CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>,<CCExpiry>,<OrderDesc>,<Status>,<Code> CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>,<CCExpiry>,<OrderDesc>,<textfeld1>,<textfeld2>,<RTF>,<cardholder>,<transactionID>,<schemeReferenceID>,<Status>,<Code> Version 1.21: CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>,<CCExpiry>,<OrderDesc>,<textfeld1>,<textfeld2>,<RTF>,<approvalcode>,<cardholder>,<transactionID>,<schemeReferenceID>,<Status>,<Code> Version 1.3: CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>,<CCCVC>,<CCExpiry>,<OrderDesc>,<textfeld1>,<textfeld2>,<transactionID>,<schemeReferenceID>,<Status>,<Code> Version 1.5: CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>,<CCCVC>,<CCExpiry>,<OrderDesc>,<Zone>,<Status>,<Code> |
The following table describes the response parameters which the Batch Manager saves in the Record area for each transaction (standard parameters not explained here, such as <TransID> or <RefNR> and request parameters are returned unchanged and correspond to the call as specified before):
Parameter | Format | CND | Description |
---|---|---|---|
Action | a..20 | M | The parameter Action defines the type of transaction like capture or credit – see above. |
PayID | an32 | M | ID for this transaction given by Paygate |
Status | a..50 | M | OK or FAILED |
Code | n8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
PCNr | n..16 | C | The Pseudo Card Number is only returned in the case of transaction types Authorize or Sale & CreditEx. It starts with 0 and the last 3 digits correspond to those of the real card number. |
Description of result parameters within the record for Batch files
Cancel authorisation renewals
With a credit card authorisation you get the right to claim a payment. However an authorisation lasts only 30 days which is a problem if you capture a partial amount, for example as part payment for several partial shipments. In order to reproduce your payment request Paygate can repeat an expired authorisation automatically.
If an order cannot be delivered or has been cancelled by the customer, it is very important that the automatic authorisations stop. Your customer's card limit will be otherwise reduced permanently because the Paygate continues to charge your customer's card.
Under normal circumstances the Paygate stops the automatic authorisation renewal when the authorised amount has been captured in full. In Batch version 1.4 you can also stop the authorisation renewal manually by changing the payment status. To perform this you submit a capture in your batch file whose amount is under the admissible limit. Since Paygate refuses credit card captures below 1.00 euro, the payment status changes to FAILED in the case of lesser amounts. Paygate therefore renews this authorisation no further. A corresponding capture entry of 0.05 euro’s is shown for example as follows:
CC,Capture,5,EUR,BestNr.0815,Rg.Nr.5180,a86dga4310d24453acd6f8a3112a769,y |
Since the amount of 5 cents lies below the minimum amount of 1.00 euro, Paygate refuses the capture with the error message MinValue. The payment status changes to FAILED and the authorisation renewal is stopped.