Paygate interface: via form
Chart of process flow via form interface
Process flow of direct debit 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 direct debit payments you can change the parameter Template to create an individual layout for your PaySDD-form which exactly matches your 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 Support copies this XSLT-template to our Paygate Server. If you enter the name of your XSLT-file in the Template parameter, the Paygate form will appear in your layout.
For general information about XSLT see www.w3.org.
The subsequent conventions apply for the use of the Corporate Pay Page 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_PaySDD.xsl
XML text file: MerchantID_PaySDD.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/paysdd.aspx?MerchantID=IhreMID&Len=123&Data=ABCFED…ACEF&template=IhreMerchantID
Field names of the form
When implementing the text field for the IBAN, use the following values for the parameters ‘name’ and ‘id’:
Account holder: „AccOwner“
IBAN: „IBAN“
BIC: „BIC“
Bank (optional): „AccBank“
A text field for the input of the IBAN is then implemented as follows:
<input type="text" name="IBAN" id= "IBAN" 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“
Language: „Language“
Language selection
The language selection in form PaySDD.aspx is automatically based on the parameter Language. Other language areas are filtered out. If you wish to access the field of another language area e.g. with JavaScript, you can do so via the following path: template/language/@name.
XML structure
The ‘language’ parameter controls which section of the XML text file is read out. German ‘de’ is always used as standard.
The XML file should have the following basic structure:
<?xml version="1.0" encoding="UTF-16"?> </languages> <language name="de"> </language> <language name="en"> </language> </languages> |
With <xsl:variablename=““ select=“template/language/@name”/> you can directly address an XML language section from the XSL file.
For an overview of which parameters are rendered by the PaySDD, please examine the following structure (XSL file is rendered against the following XML string):
Dim strXML As String = "<?xml version='1.0' encoding='UTF-16'?>" & _ "<template pay='elv'>" & _ "<merchantID>"..."</merchantID>" & _ "<PayID>"..."</PayID>" & _ "<len>"..."</len>" & _ "<data>"..."</data>" & _ "<language>"..."</language>" & _ "<Border>"..."</Border>" & _ "<Background>"..."</Background>" & _ "<BGImage>"..."</BGImage>" & _ "<BGColor>"..."</BGColor>" & _ "<FFace>"..."</FFace>" & _ "<FSize>"..."</FSize>" & _ "<FColor>"..."</FColor>" & _ "<twidth>"..."</twidth>" & _ "<theight>"..."</theight>" & _ strCustomFieldsXML & _ "<URLBack>"..."</URLBack>" & _ "<AccOwner>"..."</AccOwner>" & _ "<IBAN>"..."</IBAN>" & _ "<PBAN>"..."</PBAN>" & _ "<BIC>"..."</BIC>" & _ "<Bank>"..."</Bank>" & _ "<template>"..."</template>" & _ "</template>" |
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.
JavaScript
If JavaScript functions are desired, you must implement them in your template.
<script id=“clientEventHandlersJS“ language=“JavaScript“> if (document.SDDForm.IBAN.value.length > 34) { alert(„<xsl:value-of select=“/template/language/strJavaScript1“/>“); document.SDDForm.IBAN.focus(); } ... </script> |
Please do not use any external link to your JavaScript.
Link to Computop logo
Computop is obliged to provide the account holder information on which server he is on. Please implement a Computop logo like it is implemented on the standard form or display a small imprint link. You can download the Computop logo from www.computop.de/downloads.
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="/template/language/@name"/>|<xsl:value-of select="template/merchantID"/> |
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="UTF-16"?> <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>PaySDD Template</title> <script>Your JavaScript</script> </head> <body> <form action="https://www.computop-paygate.com/payinterim.aspx" methode="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"> <strIBAN>IBAN</strIBAN> </language> |
Subsequently, replace the text in the HTML by a reference to the respective section in the XML file:
<xsl:value-of select="/template/language/strIBAN"/> |
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's Support with a request to check and install it.
<?xml version="1.0" encoding="UTF-16"?> <?xml-stylesheet type="text/xsl" href="templatename.xsl"?> <template> <languages>please omit for your layout tests <language name="de"> </language> <language name="en"> </language> <languages>please omit for your layout tests </template> |
In order to get an overview of the versions, please include the date and version number in the name of your Zip file.
General parameters of the interface
The interface of the PaygatePaygate form is consistently paysdd.aspx for all connections. In order to make a direct debit payment via Paygate form, go to the following URL:
https://www.computop-paygate.com/paysdd.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. The second table explains all response parameters which are also the same for all direct debit 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:
General parameters for direct debit 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:
Layout parameters for Paygate forms for direct debit payments
The following table gives the result parameters which Computop Paygate transmits to URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system: pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
General results parameters for URLNotify, URLSuccess and URLFailure
Direct connection
In addition to the general parameters described above for the direct debit connection the following parameters need to be transmitted via form. The following table describes the encrypted payment request parameters:
The following table gives the result parameters which the Paygate transmits especially for the direct 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:
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of direct connection
b4payment
Besides general parameters for direct debit connection via b4payment additionally the following parameters need to be transmitted via form.
The following table describes the encrypted payment request parameters:
Additional parameters for the direct debit connection b4payment via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the b4payment 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:
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of b4payment connection
EVO Payments
Besides general parameters for direct debit connection via EVO Payments additionally the following parameters need to be transmitted via form.
The following table describes the encrypted payment request parameters:
Additional parameters for the direct debit connection EVO Payments via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the EVO Payments 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:
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of EVO Payments connection
InterCard
Besides general parameters for direct debit connection via InterCard additionally the following parameters need to be transmitted via form.
The following table describes the encrypted payment request parameters:
Additional parameters for the direct debit connection InterCard via Paygate form
The following table gives the result parameters which the Paygate transmits especially for the InterCard 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:
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of InterCard connection
PPRO
Besides general parameters for direct debit connection via PPRO additionally the following parameters need to be transmitted via form.
Notice: Please remind that the standard parameter OrderDesc will not be forwarded with PPRO.
The following table describes the encrypted payment request parameters:
Additional parameters for the direct debit 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:
Additional result parameters for URLNotify, URLSuccess and URLFailure in case of PPRO connection
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 direct debit payment via server-to-server interface
Call of interface: general parameters
The interface for direct debit payments is edddirect.aspx for all connections. To carry out an electronic direct debit via a Server-to-Server connection, call the following URL:
https://www.computop-paygate.com/edddirect.aspx |
Notice: For security reasons, 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:
General parameters for direct debit payments via socket connection
The following table gives the parameters with which Paygate responds:
General response parameters for direct debit payments via socket connection
Direct connection
Besides the general parameters described above for the direct debit connection, the following parameters are to be transmitted via server-to-server connection.
The following table describes the encrypted payment request parameters:
Additional parameters for direct debit payments via socket connection for the direct connection
The following table gives the parameters with which Paygate responds:
Additional response parameters for direct debit payments via socket connection for the direct connection
b4payment
Besides the general parameters described above for the connection b4payment to direct debit, the following parameters are to be transmitted via server-to-server connection.
The following table describes the encrypted payment request parameters:
Additional parameters for direct debit payments via socket connection for the connection b4payment
The following table gives the parameters with which Paygate responds:
Additional response tparameters for direct debit payments via socket connection for the connection b4payment
EVO Payments
Besides the general parameters described above for the connection EVO Payments to direct debit, the following parameters are to be transmitted via server-to-server connection.
The following table describes the encrypted payment request parameters:
The page Direct debit EN was not found -- Please check/update the page name used in the MultiExcerpt-Include macro
Additional parameters for direct debit payments via socket connection for the connection EVO Payments
The following table gives the parameters with which Paygate responds:
Additional response parameters for direct debit payments via socket connection for the connection EVO Payments
InterCard
Besides the general parameters described above for the connection InterCard to direct debit, the following parameters are to be transmitted via server-to-server connection.
The following table describes the encrypted payment request parameters:
The page Direct debit EN was not found -- Please check/update the page name used in the MultiExcerpt-Include macro
Additional parameters for direct debit payments via socket connection for the connection InterCard
The following table gives the parameters with which Paygate responds:
Additional response parameters for direct debit payments via socket connection for the InterCard connection
PPRO
Besides the general parameters described above for the connection PPRO to direct debit, the following parameters are to be transmitted via server-to-server connection.
Notice: Please remind that the standard parameter OrderDesc will not be forwarded with PPRO.
The following table describes the encrypted payment request parameters:
Additional parameters for direct debit payments via socket connection for the connection PPRO
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: Separate captures are not possible with the PPRO connection because all transactions are carried out directly as sale transactions.
Notice: For security reasons, 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:
Parameters for captures of direct debit payments
The following table describes the Paygate response parameters:
Response parameters for captures of direct debit 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, 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 | |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm | |
RefNr | ns..30 | C | not with EVO: Merchant’s unique reference number | |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). | |
Currency | 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. |
Parameters for credits of direct debit payments
The following table describes the Paygate response parameters:
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 | ns..30 | C | not with EVO: Merchant’s unique reference number |
Response parameters for credits of direct debit 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.
Notice: Credit without reference is only possible with a direct debit connection.
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/eddcreditex.aspx |
Notice: For security reasons, 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 |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency code, three digits DIN / ISO 4217 |
AccOwner | ans..50 | OC | Only in the case of PBAN creation: Account holder |
AccBank | ans..20 | OC | Only in the case of PBAN creation: Name of the bank |
IBAN | ans..34 | O | International Bank Account Number |
BIC | ans..11 | OC | Only in the case of PBAN creation: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number |
OrderDesc | ans..768 | M | Description of refunded goods, unit prices, merchant’s comment etc. |
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. |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
Parameters for credits of direct debit payments without reference
The following table describes the Paygate response parameters:
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 |
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) |
Response parameters for credits of direct debit payments without reference
Credit without reference for Intercard
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/eddcreditex.aspx |
Notice: For security reasons, 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 |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency code, three digits DIN / ISO 4217 |
AccOwner | ans..50 | OC | Only in the case of PBAN creation: Account holder |
AccBank | ans..20 | OC | Only in the case of PBAN creation: Name of the bank |
IBAN | ans..34 | O | International Bank Account Number |
BIC | ans..11 | OC | Only in the case of PBAN creation: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number |
OrderDesc | ans..768 | M | Description of refunded goods, unit prices, merchant’s comment etc. |
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. |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
CustomerID | ans..30 | M | Customer number at the merchant |
DateOfRegistration | dttm8 | O | Customer since in the format YYYYMMDD |
CustomerClassification | ans..20 | O | (business / private) |
ans..80 | O | E-mail address | |
DateOfBirth | dttm8 | O | Date of birth in the format YYYYMMDD |
bdSalutation | ans...4 | O | Salutation of the invoicing address |
bdFirstName | ans..30 | M | First name of the invoicing address |
bdLastName | ans..30 | M | Last name of the invoicing address |
bdStreet | a..50 | M | Street name of the invoicing address |
bdStreetNr | ans..5 | M | Street number of the invoicing address |
bdCountryCode | a2 | O | Country code in the invoicing address, 2 characters according to ISO 3166 |
bdZip | n..5 | M | Postcode of the invoicing address |
bdCity | a..32 | M | Town or city of the invoicing address |
bdPhone | ans..15 | O | Phone number in the invoicing address |
bdFax | ans..20 | O | Fax number of the invoicing address |
bdMaidenName | ans..30 | O | Maiden name of the invoicing address |
UseBillingData | a..3 | O | Is the invoicing address to be used as the delivery address? <Yes> or <No>. If <Yes> no parameters are transferred for the delivery address, if <No> they are obligatory. Standard=Yes |
sdSalutation | ans...4 | O | Salutation in the delivery address |
sdFirstName | ans..30 | O | First name in the delivery address |
sdLastName | ans..30 | O | Last name in the delivery address |
sdStreet | a..50 | O | Street in the delivery address |
sdStreetNr | ans..5 | O | Street number of the delivery address |
sdCountryCode | a2 | O | Country code for the delivery address, 2 characters according to ISO 3166 |
sdZip | n..5 | O | Postcode in the delivery address |
sdCity | a..50 | O | Town/city in the delivery address |
RegularCustomerIndicator | a..5 | O | Regular customer (true / false) |
Parameters for credits of direct debit payments without reference with Intercard
The following table describes the Paygate response parameters:
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 |
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) |
Response parameters for credits of direct debit payments without reference with Intercard
Credit without reference for b4payment
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/eddcreditex.aspx |
Notice: For security reasons, 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 |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency code, three digits DIN / ISO 4217 |
AccOwner | ans..50 | C | Account holder [Condition: either AccOwner or First-Name + Lastname must exist] |
FirstName | ans..70 | C | First name of account holder [Condition: either AccOwner or First-Name + Lastname must exist] |
LastName | ans..70 | C | Last name of account holder [Condition: either AccOwner or First-Name + Lastname must exist] |
IBAN | ans..34 | C | International Bank Account Number [Condition: either IBAN or BankAccount + BankCode must exist] |
BIC | ans..11 | C | Bank Identifier Code: |
BankAccount | n8 | C | BACS account number [Condition: either IBAN or BankAccount + BankCode must exist] |
BankCode | n6 | C | BACS sort code [Condition: either IBAN or BankAccount + BankCode must exist] |
OrderDesc | ans..768 | M | Description of refunded goods, unit prices, merchant’s comment etc. |
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. |
MAC | an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm |
Parameters for credits of direct debit payments without reference with b4payment
The following table describes the Paygate response parameters:
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 |
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) |
CodeExt | n3 | O | Error code from b4payment. Notice: Is returned only if Status=FAILED. Use is possible only in agreement with Computop support. |
ErrorText | ans..128 | O | Error text from b4payment. Notice: Is returned only if Status=FAILED. Use is possible only in agreement with Computop support. |
PBAN | ans..27 | O | For SEPA: PseudoBankNumber. The last three digits are identical to the last three digits of the IBAN number Use is possible only in agreement with Computop support. |
Response parameters for credits of direct debit payments without reference with b4payment
Reversal
Reversals are possible via a Server-to-Server connection. In order to cancel a direct debit payment via a server-to-server communication, go to 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, Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.
Notice: Cancellation is only possible with a direct debit connection.
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 |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency code, three digits DIN / ISO 4217 |
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 reversals of direct debit payments
The following table describes the Paygate response parameters:
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 transaction number, which must be unique |
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) |
Response parameters for reversals of direct debit payments
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 direct debit payment and which information can be found within the response file about the payment status.
The possible actions per batch depend on the respective connection. In the case of direct connections and via b4payment all transactions including credit without reference are possible while cancellation and credit without reference are not possible with EVO Payment, InterCard and PPRO connections. In the case of PPRO the transactions are also purely sales transactions and so only sales and credit is possible here. BACS payments with b4payment are not possible via Batch.
Following table gives an overview of all batch versions that are possible for a specific action and their specialities:
Action | Version | Description |
---|---|---|
Capture | 1.0 / 2.0 | Standard version without return of parameter Code |
| 1.x / 2.x | with RefNr (valid for all versions other than 1.0) |
Authorize | 1.0.1 / 2.0.1 | Standard version without return of parameter Code |
| 1.x.1 / 2.x.1 | with RefNr (valid for all versions other than 1.0) |
Sale | 1.0.1 / 2.0.1 | Standard version without return of parameter Code |
| 1.x.1 / 2.x.1 | with RefNr (valid for all versions other than 1.0) |
Credit | 1.0 / 2.0 | Standard version without return of parameter Code |
| 1.x / 2.x | with RefNr (valid for all versions other than 1.0) |
CreditEx | 1.0 / 2.0 | Standard version without return of parameter Code |
| 1.x / 2x. | with RefNr (valid for all versions other than 1.0) |
Description of the possible batch versions
The structure for a direct debit payment within a Batch file to be submitted is the following:
HEAD,<MerchantID>,<Date>,<Version> EDD,Authorize,<Amount>,<Currency>,<TransID>,(<RefNr>,)<AccOwner>,<IBAN>,<BIC>,<AccBankName>,<OrderDesc1>,<OrderDesc2>,(<MandateID>,<DtOfSgntr>,<MdtSeqType>) EDD,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>,)<AccOwner>,<IBAN>,<BIC>,<AccBankName>,<OrderDesc1>,<OrderDesc2>,(<MandateID>,<DtOfSgntr>,<MdtSeqType>) EDD,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,(<MandateID>,<DtOfSgntr>,<MdtSeqType>) EDD,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> EDD,CreditEx,<Amount>,<Currency>,<TransID>,(<RefNr>,)<AccOwner>,<IBAN>,<BIC>,<AccBankName>,<OrderDesc1>,<OrderDesc2> EDD,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> FOOT,<CountRecords>,<SumAmount> |
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, EDD for direct debit |
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 Support beforehand) Reverse (cancellation) |
Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent) Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit). |
Currency | a3 | M | Currency code, three digits DIN / ISO 4217 |
TransID | ans..64 | M | TransactionID which should be unique for each payment |
RefNr | ns..30 | O | Unique reference number |
PayID | an32 | M | ID for this transaction given by Paygate |
AccOwner | ans..50 | M | Account holder |
IBAN | ans..34 | M | International Bank Account Number |
BIC | ans..11 | O | Bank Identifier Code |
AccBankName | ans..20 | M | Name of the bank |
OrderDesc1 | ans..27 | M | Text explaining customer account withdrawal, max. 27 characters |
OrderDesc2 | ans..27 | M | Text explaining customer account withdrawal, max. 27 characters (2. line) |
MandateID | ans..35 | O | SEPA mandate number (compulsory in the case of SEPA) should be unique, is not case-sensitive Permissible characters: numbers 0-9, upper case letters A-Z, lower case letters a-z, apostrophe, colon, question mark, comma, full stop, plus sign, minus sign, forward slash, left and right bracket |
DtOfSgntr | ans..10 | O | Date of issuing the mandate in the format DD.MM.YYYY (obligatory when transferring the MandateID) |
MdtSeqType | a4 | O | Indicates whether the direct debit is a first, recurring, one-off or final direct debit. Permissible values: FRST, RCUR, OOFF, FNAL Standard: OOFF (single direct debit) |
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> EDD,Authorize,<Amount>,<Currency>,<TransID>,(<RefNr>,)<AccOwner>,<IBAN>,<BIC>,<AccBankName>,<OrderDesc1>,<OrderDesc2>,(<MandateID>,<DtOfSgntr>,<MdtSeqType>,)<Status>,<Code> EDD,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>,)<AccOwner>,<IBAN>,<BIC>,<AccBankName>,<OrderDesc1>,<OrderDesc2>,(<MandateID>,<DtOfSgntr>,<MdtSeqType>,)<Status>,<Code> EDD,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,(<MandateID>,<DtOfSgntr>,<MdtSeqType>,)<Status>,<Code> EDD,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> EDD,CreditEx,<Amount>,<Currency>,<TransID>,(<RefNr>,)<AccOwner>,<IBAN>,<BIC>,<AccBankName>,<OrderDesc1>,<OrderDesc2>,<Status>,<Code> EDD,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> FOOT,<CountRecords>,<SumAmount> |
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) |
Description of result parameters within the record for Batch files