The scope of this documentation is to provide towards different POS partners the specifications of Computop Paygate POS API so that they can integrate and process POS payments towards different acquirer connections.
IMPORTANT: Based on the connection type desired i.e P2PE, VNP or SSL certain parameters will become mandatory and vice versa. The same also applies when specific payment methods are implemented such as SEPA ELV, CLV+ or Girocard or MTT ATB systems where additional data would be required from the standard request call.
For more detailed recommendation on the data requirement for specific products or integration types please get in touch with Computop team.
On this page
Paygate interface
Format Description a alphabetical as alphabetical with special characters n numeric an alphanumeric ans alphanumeric with special characters ns numeric with special characters bool boolean expression (true or false) 3 fixed length with 3 digits/characters ..3 variable length with maximum 3 digits/characters enum enumeration of allowed values dttm ISODateTime (YYYY-MM-DDThh:mm:ss) Abbreviation Description CND condition M mandatory O optional C conditional Notice: Please note that the names of parameters can be returned in upper or lower case.Definitions
Data formats
Abbreviations
Comment If a parameter is mandatory, then it must be present If a parameter is optional, then it can be present, but it is not required If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional
General terminal requests
The parameters listed here generally apply to all requests from a terminal to the Paygate.
With the special payment method, you will find all parameters that apply to the respective payment method. Therefore, please note the description of the required payment method.
Some parameters are valid only for requests from certain areas: DCC: Dynamic Currency Conversion, MTT: Mass Transit Transaction.
In order to make a payment with POS Payment, please use the following URL:
https://www.computop-paygate.com/posPayment.aspx |
For the Integration test system, please use: https://dev.computop.de/Paygate/posPayment.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:
General parameters for terminal payments with POS Payment
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. mid, RefNr) should not be checked case-sentive
General response parameters for terminal payments with POS Payment
Payments by credit card: reservation / booking
Some parameters are valid only for requests from certain areas: DCC: Dynamic Currency Conversion, MTT: Mass Transit Transaction.
In order to make a POS payment with credit card, please use the following URL:
https://www.computop-paygate.com/posPayment.aspx |
For the Integration test system, please use: https://dev.computop.de/Paygate/posPayment.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:
Parameters for POS payments with credit card
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. mid, RefNr) should not be checked case-sentive
Response parameters for POS payments with credit card
Booking notification (Capture)
Some parameters are valid only for requests from certain areas: DCC: Dynamic Currency Conversion, MTT: Mass Transit Transaction.
In order to capture a POS payment, please use the following URL:
https://www.computop-paygate.com/posPayment.aspx |
For the Integration test system, please use: https://dev.computop.de/Paygate/posPayment.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:
Parameters for captures of POS 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. mid, RefNr) should not be checked case-sentive
Response parameters for captures of POS payments
Payments as SEPA-ELV
For parameters see section Credit card payment.
Important: The parameter CCBrand must be assigned the value SEPAELV.
Payments by girocard
Some parameters are valid only for requests from certain areas: DCC: Dynamic Currency Conversion, MTT: Mass Transit Transaction.
In order to make a POS payment with girocard, please use the following URL:
https://www.computop-paygate.com/posPayment.aspx |
For the Integration test system, please use: https://dev.computop.de/Paygate/posPayment.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:
Parameters for POS payments with girocard
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. mid, RefNr) should not be checked case-sentive
Response parameters for POS payments with girocard
Payments with Alipay / Wechat
Payments can be made at the terminal via Alipay and Wechat. Some parameters are valid only for requests from certain areas: DCC: Dynamic Currency Conversion, MTT: Mass Transit Transaction.
In order to make a POS payment with Alipay or Wechat, please use the following URL:
https://www.computop-paygate.com/posPayment.aspx |
For the Integration test system, please use: https://dev.computop.de/Paygate/posPayment.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:
Parameters for POS payments with Alipay or Wechat
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. mid, RefNr) should not be checked case-sentive
Response parameters for POS payments with Alipay or Wechat
Status checking by the terminal
Repeatedly calling the pospayment.aspx (Polling, MessageType F1) determines whether the operation has been approved in Alipay / Wechat. For this purpose, it is necessary to check whether the response parameter LastStatus has assumed the value OK or FAILED. The process is considered successfully approved if LastStatus displays the value OK and the AmountAuth parameter the payment amount. The process is considered rejected when LastStatus returns the value FAILED. As long as Alipay / Wechat has not approved the process, LastStatus contains the value AUTHORIZE-REQUEST.
The parameters from the Inquire section apply to call the status check.
Instalment purchase with easyCredit
Performing an instalment purchase transaction with a terminal. Some parameters are valid only for requests from certain areas: DCC: Dynamic Currency Conversion, MTT: Mass Transit Transaction.
In order to make a POS payment with easyCredit, please use the following URL:
https://www.computop-paygate.com/posPayment.aspx |
For the Integration test system, please use: https://dev.computop.de/Paygate/posPayment.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:
Parameters for POS payments with easyCredit
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. mid, RefNr) should not be checked case-sentive
Response parameters for POS payments with easyCredit
Inquire
With the help of the Inquire Request, you will receive information about a transaction from which you only know your own TransID. Some parameters are valid only for requests from certain areas: DCC: Dynamic Currency Conversion, MTT: Mass Transit Transaction.
In order to inquire information about a POS payment, please use the following URL:
https://www.computop-paygate.com/posPayment.aspx |
For the Integration test system, please use: https://dev.computop.de/Paygate/posPayment.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:
Parameters for inquiring information about POS 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. mid, RefNr) should not be checked case-sentive
Response parameters for inquiring information about POS payments
Card Reversal / Automatic Reversal
Reversal initiated by the map or triggered automatically by the terminal after a timeout. Some parameters are valid only for requests from certain areas: DCC: Dynamic Currency Conversion, MTT: Mass Transit Transaction.
In order to automatically reverse a POS payment, please use the following URL:
https://www.computop-paygate.com/posPayment.aspx |
For the Integration test system, please use: https://dev.computop.de/Paygate/posPayment.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:
Parameters for reversals of POS 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. mid, RefNr) should not be checked case-sentive
Response parameters for reversals of POS payments
Manual Reversal
This reversal is triggered by the terminal operator. Some parameters are valid only for requests from certain areas: DCC: Dynamic Currency Conversion, MTT: Mass Transit Transaction.
In order to reverse a POS payment manually, please use the following URL:
https://www.computop-paygate.com/posPayment.aspx |
For the Integration test system, please use: https://dev.computop.de/Paygate/posPayment.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:
Parameters for manual reversals of POS 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. mid, RefNr) should not be checked case-sentive
Response parameters for manual reversals of POS payments
Credit without reference
Triggering a credit via the terminal. Some parameters are valid only for requests from certain areas: DCC: Dynamic Currency Conversion, MTT: Mass Transit Transaction.
In order to credit a POS payment, please use the following URL:
https://www.computop-paygate.com/posPayment.aspx |
For the Integration test system, please use: https://dev.computop.de/Paygate/posPayment.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:
Parameters for credits of POS 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. mid, RefNr) should not be checked case-sentive
Response parameters for credits of POS payments
POS Increment
Not yet available for all acquirers. Some parameters are valid only for requests from certain areas: DCC: Dynamic Currency Conversion, MTT: Mass Transit Transaction.
In order to increment a POS payment, please use the following URL:
https://www.computop-paygate.com/posPayment.aspx |
For the Integration test system, please use: https://dev.computop.de/Paygate/posPayment.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:
Parameters for increments of POS 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. mid, RefNr) should not be checked case-sentive
Response parameters for increments of POS payments
DCC transactions via VPN
In order to make a DCC request, please use the following URL:
https://www.computop-paygate.com/posdcc.aspx |
For the Integration test system, please use: https://dev.computop.de/Paygate/posdcc.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:
Parameters for DCC requests
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. mid, RefNr) should not be checked case-sentive
Response parameters for DCC requests
Terminal configuration
Retrieve the terminal configuration data from the Paygate.
In order to retrieve the POS terminal configuration data, please use the following URL:
https://www.computop-paygate.com/posConfig.aspx |
For the Integration test system, please use: https://dev.computop.de/Paygate/posConfig.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:
Parameters for retrieving POS terminal configuration data
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. mid, RefNr) should not be checked case-sentive
Response parameters for retrieving POS terminal configuration data
Terminal configuration v2 (Special interface with no Merchant ID in request)
Retrieve the terminal configuration data from the Paygate.
In order to retrieve the POS terminal configuration data, please use the following URL:
https://www.computop-paygate.com/posConfigExt.aspx |
For the Integration test system, please use: https://dev.computop.de/Paygate/posConfigExt.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:
Parameters for retrieving POS terminal configuration data
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. mid, RefNr) should not be checked case-sentive
Response parameters for retrieving POS terminal configuration data
Payment facilitator
To use the functionality of the Payment Facilitator, you need to add the following parameters to your request.
The following table describes the request parameters:
Additional parameters for using the Payment Facilitator
CUT-OFF
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:
Parameters for Cut-Off
Example value of parameter: cutoff
{
"receiptNr": {
"from": <receiptNrFrom>,
"to": <receiptNrTo>
},
"numberOfTx": [
{
"brand":"VISA",
"numberOfTx": <numberOfTx>,
"checkSum": <checkSum>
},
{
"brand":"MastereCard",
"numberOfTx": <numberOfTx>,
"checkSum": <checkSum>
},
{
"brand":"Maestro",
"numberOfTx": <numberOfTx>,
"checkSum": <checkSum>
},
{
"brand":"AMEX",
"numberOfTx": <numberOfTx>,
"checkSum": <checkSum>
},
{
"brand":"DINERS",
"numberOfTx": <numberOfTx>,
"checkSum": <checkSum>
},
{
"brand":"Discover",
"numberOfTx": <numberOfTx>,
"checkSum": <checkSum>
},
{
"brand":"JCB",
"numberOfTx": <numberOfTx>,
"checkSum": <checkSum>
},
{
"brand":"CUP",
"numberOfTx": <numberOfTx>,
"checkSum": <checkSum>
},
{
"brand":"GIROCARD",
"numberOfTx": <numberOfTx>,
"checkSum": <checkSum>
},
{
"brand":"SEPAELV",
"numberOfTx": <numberOfTx>,
"checkSum": <checkSum>
}
]
}
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. mid, RefNr) should not be checked case-sentive
Response parameters for Cut-Off
EMV data elements
The EMV data block is sent as hex string. The data is TLV coded. A detailed description of TLV and the EMV tags can be found in the EMV Specification "EMV v4.3 Book 3 Application Specification", which can be downloaded here: https://www.emvco.com/specifications.aspx?id=223
See Annex A for a tag list.
The following tags are required for a credit card payment when they are provided by the terminal or the card:
Tag | Description |
|---|---|
9F06 | Application Identifier (AID) |
9F26 | Application Cryptogram |
9F27 | Cryptogram Information Data |
9F10 | Issuer Application Data (IAD) |
9F37 | Unpredictable Number |
9F36 | Application Trx. Counter (ATC) |
95 | Terminal Verification Results |
9A | Transaction Date |
9C | Transaction Type |
9F02 | Transaction Amount |
5F2A | Transaction Currency Code |
82 | Application Interchange Profile |
9F1A | Terminal Country Code |
9F03 | Amount, Other (Cashback Amount if applicable) |
9F33 | Terminal Capabilities |
9F34 | CVM Results |
9F35 | Terminal Type |
9F1E | Interface Device (IFD) Serial No |
9F53 | Transaction Category Code |
84 | Dedicated File Name |
9F09 | Terminal Application Version No. |
9F41 | Transaction Sequence Counter |
DF01 | Issuer Script Results |
DF02 | Error Detection |
9F7C | Customer Exclusive Data |
9F6E | Form Factor Indicator |
The following tags are optional for a credit card payment:
Tag | Description |
|---|---|
57 | Track2 Equivalent Data |
5F20 | Cardholder Name |
The following tag is for a CLV+ payment:
Tag | Description |
|---|---|
DF64 | Mandate ID, it will be returned when signature from customer first time obtained and Mandate ID is created for future frictionless payment |
Response tags at SEPA-ELV
For SEPA ELV, the answer can optionally contain the following tags:
- 5F53 (IBAN)
- DF65 (creditor ID)
Note: If the fields are present, they must also be printed on the document.
5F53 (IBAN)
Length: 34 bytes, Format: on
The IBAN may be optionally included in the BMP55 of the reply message (210,1410). It is a maximum of 34 digits long and must not contain special characters and lowercase letters. In Germany, a 22-digit IBAN is used.
If the IBAN is included in the BMP55, it is printed completely or masked by the terminal from the BMP55 taken on the handler and customer receipt below the map data using masking rule (Tag DF25)
Example of masking:
IBAN DE8553-0002
5F53 16 44 45 35 35 33 32 39 32 33 34 30 32 34 30 30 30 30 30 32
"DE85532912340123600002"
DF65 (creditor ID)
Length: 8 - 35 bytes, Format: ans
In the case of online transactions, the operator computer can optionally include a creditor ID in the reply message (BMP55, day DF65-). If a creditor ID (DF65) is included in the BMP55 of the reply message, it will be included on the trader or instead of the configured (conecrater "Gl") Customer document printed.
Example:
DF65 12 444539385A5A5A3039393939393939393939393939393939393939
Formation of the DUKPTMAC
To perform messaging authentication, a MAC (Message Authentication Code) is added to the message by the sender and verified by the recipient.
- The input block for calculating the MAC is structured as follows: Calculate an SHA-256 via the message; including the MessageType field + the MerchantID field up to the DUKPTMAC field (DMAC, excluded).
- This result is an input block of 32 bytes, which is used to calculate the MAC.
The MAC is generated using a work key derived from the 3-DES DUKPT security scheme. The output of the MAC calculation is an 8-byte message authentication block (MAB) consisting of a MAC (highest quality 4 bytes) and a MAC remain (lowest 4 bytes). The MAC field of the message is set to the MAB. MAC generation and verification is done according to ANSI X9.19.
Message Types
Overview types
01 Purchase (Sale)
02 Reversal
03 Refund
05 Authorization (Reservation)
06 Incremental Auth
0B Capture
CF Cut Off
E0 HSM as a Service
F0 Automatic reversal
F1 Inquire
F2 Terminal Configuration
Explanations
Tag | Description |
|---|---|
01 Purchase (CT: Sale) | Authorization and Capture in one transaction is called Sale |
02 Reversal | Reversal of Authorization; |
03 Refund (CT: Credit) | Refund at POS without previous Sale |
05 (Pre-)Authorize | Increment possible (CT: Reservation) |
06 Pre-Authorization | Increment possible (CT: Reservation) |
0B Capture | Capture an Authorization |