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:
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type of request. Returned in response. For authorized values, see explanations in the appendix under Message Types. |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| refnr | ans..30 | O | Merchant’s unique reference number |
Key | Format | CND | Description |
|---|---|---|---|
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). For DCC: Amount in foreign currency For Cashback transactions this should contain the sum of payment amount and cashback amount. |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Key | Format | CND | Description |
|---|---|---|---|
| POSTerminalID | an..20 | M | TerminalID of the card reader |
Device | an16 | M | Serial number of the card reader |
| Manufacturer | an..30 | M | Manufacturer of the card reader (associated with the serial number) |
| TerminalModel | ..60 | O | Model or type of card reader |
| CCNr | n8.19 | C | PAN of the card |
| CCBrand | an..22 | M | Card brand or name of another payment method |
| EMVData | an..2048 | C | Block for additional data. If there are no additional data, e.g. with MSR, then completely omit this parameter. |
| OrderDesc | ans..200 | O | Description of purchased goods, unit prices etc. |
| LocalDate | n4 | C | The local month and day that the transaction takes place at the card acceptor location. The format is MMDD. Mandatory for SEPAELV, optional for others. |
| LocalTime | n6 | C | The local time at which the transaction takes place at the point of card acceptor location. The format is hhmmss. Mandatory for SEPAELV, optional for others. |
| ReceiptNr | n4 | C | Mandatory for SEPAELV, Girocard transactions, optional for others. The value which terminals send the following format for ELV in BMP 3 (according to ZVTH): 38bbbb (bbbb = receipt number) |
| ExtraCapabilities | an4 | O | If a terminal supports additional skills such as Single Tap, each transaction must be marked with the appropriate terminal capability. Additional terminal capabilities (Terminal Capabilities) |
| DMACKSN | an..20 | C | DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC). Mandatory for all devices except PhonePOS. |
| DMAC | an16 | C | DUKPT Message Authentication Code, which is formed over the entire message (all parameters except DMAC). See chapter "Formation of the DUKPTMAC". Mandatory for all devices except PhonePOS. |
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
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type transmitted in the request |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| refnr | ans..30 | O | Merchant’s unique reference number |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
Key | Format | CND | Description |
|---|---|---|---|
| POSTerminalID | an..20 | M | TerminalID of the card reader |
| EMVData | an..2048 | C | Block for additional data |
| ConfigUpdate | a3 | O | If this parameter occurs in the response and has the value "yes", then there is an update of the terminal configuration. The update can then be retrieved via the posconfig.aspx. |
| DMACKSN | an..20 | M | DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC) |
| DMAC | an16 | M | DUKPT Message Authentication Code for the entire response |
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:
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type of request. Returned in response. Allowed values: When OfflineSale=true is passed with MessageType 01, the transaction is processed as an offline merchant risk sale (no online authorization). See OfflineSale parameter for details. (Explanations in the appendix under Message Types) |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| refnr | ans..30 | O | Merchant’s unique reference number |
Key | Format | CND | Description |
|---|---|---|---|
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). For DCC: Amount in foreign currency For Cashback transactions this should contain the sum of payment amount and cashback amount. |
Key | Format | CND | Description |
|---|---|---|---|
| CashbackAmount | n..10 | O | Cashback Amount in case such transaction type is submitted. Given in the smallest currency unit (e.g. EUR Cent). |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Key | Format | CND | Description |
|---|---|---|---|
| POSTerminalID | an..20 | M | TerminalID of the card reader |
Device | an16 | M | Serial number of the card reader |
| Manufacturer | an..30 | M | Manufacturer of the card reader (associated with the serial number) |
| TerminalModel | ..60 | O | Model or type of card reader |
| CCNr | n8.19 | C | Mandatory if the credit card number is not passed in the DataEncrypted parameter |
| CCBrand | an..22 | M | Card brand: VISA, MasterCard, Maestro, AMEX, DINERS, JCB, CUP. Please note the spelling! Always specify SEPAELV at ELV! |
| CCCVC | n4 | O | Card check number: The last 3 digits on the credit card sub-type, at AMEX 4 digits. |
| CCExpiry | n6 | M | Expiration date of credit card (YYYYMM), e.g. 202507 |
| CCSeqNo | n3 | O | Card sequence number |
| Track2 | an..224 | C | Mandatory with Magnetic Stripe Read (MSR). Data of the track2 for MSR or Track2EquivalentData (Tag 57) (in Hex formatting). |
| EMVData | an..2048 | C | EMC data as required for the passing on to the acquirer (in hex formatting). The exact structure is defined by the protocol used, which is stored in the master files of the terminal. If there are no EMC data, such as MSR, then completely omit this parameter. |
| EntryMode | n3 | M | POS entry mode |
| OfflineSale | bool | C | If set to "true", the transaction is processed as an offline/merchant risk sale. No online authorization takes place – the merchant bears the risk. Paygate creates a combined Sale (authorization + capture) and forwards it to the acquirer as a capture notification. Only valid with MessageType=01. Must not be used with MessageType=05 or any other message type. Currently supported only for credit card transactions via the NDS (Nexi Germany) acquirer connection. If the OfflineSale feature is not enabled for the given MerchantID, the request will be rejected. Any value other than "true" will be rejected – to process a standard online transaction, omit this parameter entirely. |
| PINData | an..128 | C | Mandatory for online PIN. Encrypted PIN in ISO-0 format. |
| PINKSN | an..20 | C | Mandatory for online PIN. DUKPT Key Serial Number of the PIN. |
| DataEncrypted | an..2048 | O | PAN + Track2 equivalent data (in TLV format) as encrypted value. If this field is present, the CCNr parameter is not required. |
| DataKSN | an..20 | C | KSN is generated by the terminal. Needed to decrypt the data from the DataEncrypted parameter. |
| OrderDesc | ans..200 | O | Description of purchased goods, unit prices etc. |
| ChDesc | an..25 | O | Text shown on the customer's credit card statement next to the payee |
| LocalDate | n4 | C | The local month and day that the transaction takes place at the card acceptor location. The format is MMDD. Mandatory for SEPAELV, optional for others. |
| LocalTime | n6 | C | The local time at which the transaction takes place at the point of card acceptor location. The format is hhmmss. Mandatory for SEPAELV, optional for others. |
| ReceiptNr | n4 | C | Mandatory for SEPAELV, Girocard transactions, optional for others. The value which terminals send the following format for ELV in BMP 3 (according to ZVTH): 38bbbb (bbbb = receipt number) |
| dccStatus | a1 | C | Mandatory for DCC; status of foreign currency settlement. Possible values: U foreign currency was used. E foreign currency was offered but not used. |
| dccRateValue | ans13 | C | Mandatory at DCC and dccStatus U; Exchange rate with decimal point |
| baseAmount | n..10 | C | Mandatory at DCC and dccStatus U; Amount in the smallest currency unit in Terminal currency |
| baseCurrency | a3 | C | Mandatory at DCC and dccStatus U; Currency set up at the terminal as standard |
| dccMargin | ans..5 | O | DCC margin/markup percentage |
| dccCommission | ans..12 | O | DCC commission percentage |
| dccSource | ans..32 | O | Exchange rate source (e.g., "REUTERS WHOLESALE INTERBANK") |
| dccTimestamp | ans..20 | O | Timestamp of exchange rate |
| dccRequestId | an..32 | O | Computop PayID of the DCC request (enables linking DCC and POS payment records) |
| ContractID | n..8 | O | Additional contract number of the merchant with the acquirer, with which the default VU number can be overridden |
| AccVerify | a..3 | O | Allowed value: yes |
| RTF | an1 | O | For recurring payments. Allowed values: I (initial payment of a new subscription) or E (agreement that COF is used for further payments). |
| PACFormat | n2 | O | Defines the ISO PIN format present in PINData parameter. Valid values: 10: ISO-0 11: ISO-1 14: ISO-4 |
| ExtraCapabilities | an4 | O | If a terminal supports additional skills such as Single Tap, each transaction must be marked with the appropriate terminal capability. Additional terminal capabilities (Terminal Capabilities) |
| DuplicateATC | a3 | C | Mandatory if the same ATC is used for a second request during a payment process. This procedure is described for the single-tap process. As a rule, any further request with the same ATC is rejected by the acquirer or issuer. However, the single-tap process intended to repeat the ATC and must therefore be marked with this parameter. yes : The same ATC was sent intended |
| DMACKSN | an..20 | C | DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC). Mandatory for all devices except PhonePOS. |
| DMAC | an16 | C | DUKPT Message Authentication Code, which is formed over the entire message (all parameters except DMAC). See chapter "Formation of the DUKPTMAC". Mandatory for all devices except PhonePOS. |
| dccRateID | ans..20 | O | Fiserv IPG-Rate. Only required in case of a DCC service via Fiserv. |
| TraceNr | an..6 | C | A number assigned by a terminal to identify uniquely a transaction. Mandatory for SEPAELV and girocard transactions, optional for others. |
| ConditionCode | an..2 | C | Additional information for transaction, to be communicated with CLV+ end. Mandatory for SEPAELV and girocard transactions, optional for others. |
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
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type transmitted in the request |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| refnr | ans..30 | O | Merchant’s unique reference number |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
Key | Format | CND | Description |
|---|---|---|---|
| POSTerminalID | an..20 | M | TerminalID of the card reader |
| CodeExt | an2 | M | Response code of the acquirer |
| ApprovalCode | n..6 | C | Approval code of the acquirer (also known as the authCode or authorization . called Response). Configured at the merchant. |
| EMVData | an..2048 | C | Acquirer Response (in hex formatting). Includes, among other things, the Issuer Authorization Response Code (Tag 8A), the Issuer Scripts (Tag 71, 72) and Issuer Authentication Data (Tag 91). |
| VUNr | ans..20 | O | Contract number of the merchant with the acquirer. Configured at the merchant. |
| TerminalID | ans..20 | O | TerminalID, which Computop exchanges with the acquirer. Configured at the merchant. |
| AQ | ans..30 | O | Abbreviation of the acquirers. Configured at the merchant. |
| TrxTime | ans21 | O | Time of execution of the transaction in format: dd.MM.yyyy HH:mm:ssff. Configured at the merchant. |
| AdditionalResponseData | ans..99 | O | Additional Response Data (at GICC BMP 44), which the acquirer sends in the response. Configured at the merchant. |
| PCNr | n..16 | O | Pseudo card number: Paygate generated random number, which represents a real credit card number. The pseudocard number (PKN) starts with 0, and the last 3 digits correspond to those of the real card number. PKN can be used as a real card number for authorization, booking and credits. |
| TransactionID | an..56 | C | Value returned in response to an initial recurring payment (RTF-I or E) |
| ConfigUpdate | a3 | O | If this parameter occurs in the response and has the value "yes", then there is an update of the terminal configuration. The update can then be retrieved via the posconfig.aspx. |
| Last4CardholderPAN | n..4 | O | MTT only: The last 4 digits of the printed PAN at VISA if the tokenized DPAN was used in the request |
| PAR | ans..999 | O | Only MTT: Payment Account Reference, which VISA/MasterCard makes available to the merchant to identify a customer in their back office system |
| EmbossedPANPCNr | n..19 | O | MTT and MasterCard/Maestro only: Another Pseudo Card Number (s. Parameter PCNr), which refers to the printed PAN of the physical card. Included in the Acquirer response if a tokenized PAN was used in the request. |
| EmbossedPANExpiryDate | n..4 | O | MTT and MasterCard/Maestro only: The expiration date belonging to the Embossed PAN parameter, which is included in the Acquirer response. Format: YYMM. |
| OriginalCode | ans..3 | O | MTT only: Contains the original Response Code (OmniPay BM 60 SF68: Scheme Response Code) from the authorization platforms for payment systems |
| schemeReferenceID | ans..64 | O | MTT only: Cardmark-specific transaction ID required for subsequent card on file payments, delayed authorizations and resubmission. |
| DMACKSN | an..20 | M | DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC) |
| DMAC | an16 | M | DUKPT Message Authentication Code for the entire response |
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:
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type of request. Returned in response. Allowed values: 0B for Booking Notification (Explanations in the appendix under Message Types) |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| refnr | ans..30 | O | Merchant’s unique reference number |
Key | Format | CND | Description |
|---|---|---|---|
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). For DCC: Amount in foreign currency For Cashback transactions this should contain the sum of payment amount and cashback amount. |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Key | Format | CND | Description |
|---|---|---|---|
| POSTerminalID | an...20 | M | TerminalID of the card reader |
Device | an16 | M | Serial number of the card reader |
| Manufacturer | an..30 | M | Manufacturer of the card reader (associated with the serial number) |
| TerminalModel | ..60 | O | Model or type of card reader |
| LocalDate | n4 | M | The local month and day that the transaction takes place at the card acceptor location. The format is MMDD. Mandatory for SEPAELV, optional for others. |
| LocalTime | n6 | M | The local time at which the transaction takes place at the point of card acceptor location. The format is hhmmss. Mandatory for SEPAELV, optional for others. |
| DMACKSN | an..20 | C | DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC). Mandatory for all devices except PhonePOS. |
| DMAC | an16 | C | DUKPT Message Authentication Code, which is formed over the entire message (all parameters except DMAC). See chapter "Formation of the DUKPTMAC". Mandatory for all devices except PhonePOS. |
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:
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type of request. Returned in response. Allowed values: 01 (Explanations in the appendix under Message Types) |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| refnr | ans..30 | O | Merchant’s unique reference number |
Key | Format | CND | Description |
|---|---|---|---|
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). For DCC: Amount in foreign currency For Cashback transactions this should contain the sum of payment amount and cashback amount. |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table |
Key | Format | CND | Description |
|---|---|---|---|
| POSTerminalID | an..20 | M | TerminalID of the card reader |
Device | an16 | M | Serial number of the card reader |
| Manufacturer | an..30 | M | Manufacturer of the card reader (associated with the serial number) |
| TerminalModel | ..60 | O | Model or type of card reader |
| CCNr | n8.19 | M | Not required for Alipay / Wechat. Please pass 0000000000000000 (16 x 0), because mandatory. |
| CCBrand | an..22 | M | At Alipay please always include, at Wechat always show Wechat! |
| OrderDesc | ans..200 | O | Description of purchased goods, unit prices etc. |
| ContractID | n..8 | O | Additional contract number of the merchant with the acquirer, with which the default VU number can be overridden |
| DMACKSN | an..20 | C | DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC). Mandatory for all devices except PhonePOS. |
| DMAC | an16 | C | DUKPT Message Authentication Code, which is formed over the entire message (all parameters except DMAC). See chapter "Formation of the DUKPTMAC". Mandatory for all devices except PhonePOS. |
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
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type transmitted in the request |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| refnr | ans..30 | O | Merchant’s unique reference number |
Key | Format | CND | Description |
|---|---|---|---|
| POSTerminalID | an..20 | M | TerminalID of the card reader |
| Status | a..50 | M | AUTHORIZE-REQUEST or FAILED |
| Description | ans..1024 | M | PENDING, because the approval of Alipay / Wechat is still waiting. Further description if the payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Code | n8 | M | If a valid QR code can be submitted, then 21190985 or 23030985 for PENDING otherwise error code according to Paygate Response Codes (A4 Error codes) |
| EMVData | an..2048 | C | Value for the QR code in JSON format additionally base64-viren. Examples: |
| ConfigUpdate | a3 | O | If this parameter occurs in the response and has the value "yes", then there is an update of the terminal configuration. The update can then be retrieved via the posconfig.aspx. |
| VUNr | ans..20 | M | PartnerID of the merchant |
| DMACKSN | an..20 | M | DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC) |
| DMAC | an16 | M | DUKPT Message Authentication Code for the entire response |
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:
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type of request. Returned in response. Allowed values: 01 (Explanations in the appendix under Message Types) |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| refnr | ans..30 | O | Merchant’s unique reference number |
Key | Format | CND | Description |
|---|---|---|---|
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). For DCC: Amount in foreign currency For Cashback transactions this should contain the sum of payment amount and cashback amount. |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Key | Format | CND | Description |
|---|---|---|---|
| POSTerminalID | an..20 | M | TerminalID of the card reader |
Device | an16 | M | Serial number of the card reader |
| Manufacturer | an..30 | M | Manufacturer of the card reader (associated with the serial number) |
| TerminalModel | ..60 | O | Model or type of card reader |
| CCNr | n8.19 | M | PAN of the card. With easyCredit the PAN consisting of country prefix, short bank code, account number and check digit. |
| CCBrand | an..22 | M | Please always include easyCredit with easyCredit! |
| CCExpiry | n6 | C | Mandatory for credit cards. Expiration date of credit card (YYYDMM), e.g. 202507. |
| OrderDesc | ans..200 | O | Description of purchased goods, unit prices etc. |
| ContractID | n..8 | O | Additional contract number of the merchant with the acquirer, with which the default VU number can be overridden |
| DMACKSN | an..20 | C | DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC). Mandatory for all devices except PhonePOS. |
| DMAC | an16 | C | DUKPT Message Authentication Code, which is formed over the entire message (all parameters except DMAC). See chapter "Formation of the DUKPTMAC". Mandatory for all devices except PhonePOS. |
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
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type transmitted in the request |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| refnr | ans..30 | O | Merchant’s unique reference number |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
Key | Format | CND | Description | Beschreibung |
|---|---|---|---|---|
| POSTerminalID | an...20 | M | TerminalID of the card reader | TerminalID des Kartenlesers |
| CodeExt | an2 | M | Response code from easyCredit posData.status code | Antwortcode von easyCredit posData.status code |
| ApprovalCode | n..6 | C | With easyCredit the approval number | Bei easyCredit die Genehmigungsnummer |
| EMVData | an..2048 | C | With easyCredit all elements from the JSON object posData. This contains the attributes for the document print. Format: JSON (packaged in base64). | Bei easyCredit alle Elemente aus dem JSON-Objekt posData. Dieses enthält die Attribute für den Belegdruck. Format: JSON (verpackt in Base64). |
| VUNr | ans..20 | O | With easyCredit the sales office number of the store | Bei easyCredit die Verkaufsstellennummer des Geschäfts |
| ConfigUpdate | a3 | O | If this parameter occurs in the response and has the value "yes", then there is an update of the terminal configuration. The update can then be retrieved via the posconfig.aspx. | Wenn dieser Parameter in der Antwort vorkommt und den Wert "yes" hat, dann liegt ein Update der Terminalkonfiguration vor. Das Update kann dann über die posconfig.aspx abgerufen werden. |
| DMACKSN | an..20 | M | DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC) | DUKPT-Schlüsselseriennummer, die zum Generieren des DUKPT-MAC (Parameter DMAC) verwendet wird |
| DMAC | an16 | M | DUKPT Message Authentication Code for the entire response | DUKPT-Nachrichtenauthentifizierungscode für die gesamte Antwort |
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:
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type of request. Returned in response. Allowed values in the attachment under Message Types. Here always: F1 (Explanations in the appendix under Message Types) |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Key | Format | CND | Description |
|---|---|---|---|
| POSTerminalID | an..20 | M | TerminalID of the card reader |
Device | an16 | M | Serial number of the card reader |
| Manufacturer | an..30 | C | Manufacturer of the card reader (associated with the serial number) Mandatory for SEPAELV and Girocard, optional for others. |
| TerminalModel | ..60 | O | Model or type of card reader |
| DMACKSN | an..20 | C | DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC). Mandatory for all devices except PhonePOS. |
| DMAC | an16 | C | DUKPT Message Authentication Code, which is formed over the entire message (all parameters except DMAC). See chapter "Formation of the DUKPTMAC". Mandatory for all devices except PhonePOS. |
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
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type transmitted in the request |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | C | Transaction number of the merchant. In the event of an error, not included in the answer. |
| Status | a..50 | M | OK or FAILED. Refers to the Inquire request itself. |
| Key | Format | CND | Description |
|---|---|---|---|
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
Key | Format | CND | Description |
|---|---|---|---|
| POSTerminalID | an...20 | M | TerminalID of the card reader |
| AmountAuth | n..10 | O | Authorized amount of the requested operation |
| AmountCap | n..10 | O | Captured amount of the requested process |
| AmountCred | n..10 | O | Credited amount of the requested process |
| LastStatus | n..10 | O | Status of the requested process |
| ConfigUpdate | a3 | O | If this parameter occurs in the response and has the value "yes", then there is an update of the terminal configuration. The update can then be retrieved via the posconfig.aspx. |
| DMACKSN | an..20 | M | DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC) |
| DMAC | an16 | M | DUKPT Message Authentication Code for the entire response |
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:
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type of request. Returned in response. Allowed value: F0 (Explanations in the appendix under Message Types) |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| refnr | ans..30 | O | Merchant’s unique reference number |
Key | Format | CND | Description |
|---|---|---|---|
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). For DCC: Amount in foreign currency For Cashback transactions this should contain the sum of payment amount and cashback amount. |
Key | Format | CND | Description |
|---|---|---|---|
| CashbackAmount | n..10 | O | Cashback Amount in case such transaction type is submitted. Given in the smallest currency unit (e.g. EUR Cent). |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Key | Format | CND | Description |
|---|---|---|---|
| POSTerminalID | an..20 | M | TerminalID of the card reader |
Device | an16 | M | Serial number of the card reader |
| Manufacturer | an..30 | C | Manufacturer of the card reader (associated with the serial number) Mandatory for SEPAELV and Girocard, optional for others. |
| TerminalModel | ..60 | O | Model or type of card reader |
| EMVData | an..2048 | C | Data of the original transaction incl. AAC at Card Reversal (in Hex formatting). If there are no EMC data, such as MSR, then completely omit this parameter. |
| CCSeqNo | n3 | O | Card sequence number |
| OrderDesc | ans..200 | O | Description of purchased goods, unit prices etc. |
| LocalDate | n4 | C | The local month and day that the transaction takes place at the card acceptor location. The format is MMDD. Mandatory for SEPAELV, optional for others. |
| LocalTime | n6 | C | The local time at which the transaction takes place at the point of card acceptor location. The format is hhmmss. Mandatory for SEPAELV, optional for others. |
| ReceiptNr | n4 | C | Mandatory for SEPAELV, Girocard transactions, optional for others. The value which terminals send the following format for ELV in BMP 3 (according to ZVTH): 38bbbb (bbbb = receipt number) |
| dccStatus | a1 | C | Mandatory for DCC; status of foreign currency settlement. Possible values: U foreign currency was used. E foreign currency was offered but not used. |
| TraceNr | n6 | O | Continuous 6-digit decimal. Is incremented for each transaction as described in TA. |
| ConditionCode | n2 | C | Mandatory only for girocard. Condition code. Values from 00 to 99 as described in TA under BMP 25. |
| TerminalData | an..99 | C | Mandatory only for girocard. Terminal data includes: online time, POS data and approval number of the terminal. Format: Hex, TLV-coded (see also TA BMP 61). |
| DMACKSN | an..20 | C | DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC). Mandatory for all devices except PhonePOS. |
| DMAC | an16 | C | DUKPT Message Authentication Code, which is formed over the entire message (all parameters except DMAC). See chapter "Formation of the DUKPTMAC". Mandatory for all devices except PhonePOS. |
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
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type transmitted in the request |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
Key | Format | CND | Description |
|---|---|---|---|
| CodeExt | an2 | M | Response code of the acquirer |
| EMVData | an..2048 | C | Acquirer Response (in hex formatting). Includes, among other things, the Issuer Authorization Response Code (Tag 8A), the Issuer Scripts (Tag 71, 72) and Issuer Authentication Data (Tag 91) |
| POSTerminalID | an...20 | M | TerminalID of the card reader |
| ConfigUpdate | a3 | O | If this parameter occurs in the response and has the value "yes", then there is an update of the terminal configuration. The update can then be retrieved via the posconfig.aspx. |
| VUNr | ans..20 | O | Only by credit card: contract number of the merchant with the acquirer. Configured at the merchant. |
| TerminalID | ans..20 | O | Only with credit card: TerminalID that Computop exchanges with the acquirer. Configured at the merchant. |
| AQ | ans..30 | O | Abbreviation of the Acquirers. Configured at the merchant. |
| TrxTime | ans21 | O | Time of execution of the transaction in format: dd.MM.yyyy HH:mm:ssff. Configured at the merchant. |
| DMACKSN | an..20 | M | DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC) |
| DMAC | an16 | M | DUKPT Message Authentication Code for the entire response |
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:
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type of request. Returned in response. Allowed value: 02 (Explanations in the appendix under Message Types) |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| refnr | ans..30 | O | Merchant’s unique reference number |
Key | Format | CND | Description |
|---|---|---|---|
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). For DCC: Amount in foreign currency For Cashback transactions this should contain the sum of payment amount and cashback amount. |
Key | Format | CND | Description |
|---|---|---|---|
| CashbackAmount | n..10 | O | Cashback Amount in case such transaction type is submitted. Given in the smallest currency unit (e.g. EUR Cent). |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Key | Format | CND | Description |
|---|---|---|---|
| POSTerminalID | an..20 | M | TerminalID of the card reader |
Device | an16 | M | Serial number of the card reader |
| Manufacturer | an..30 | M | Manufacturer of the card reader (associated with the serial number) |
| TerminalModel | ..60 | O | Model or type of card reader |
| LocalDate | n4 | M | Date of the transaction. Format: MMTT |
| LocalTime | n6 | M | Time of the transaction. Format: hhmmss |
| ReceiptNr | n4 | M | Number for the document. Will be continuously increased. Overflow to 9999. |
| TraceNr | n6 | M | Continuous 6-digit decimal. Is incremented for each transaction as described in TA. |
| ConditionCode | n2 | C | Additional information for transaction, to be communicated with CLV+ end. Mandatory for SEPAELV and girocard transactions, optional for others. Values from 00 to 99 as described in TA under BMP 25. |
| TerminalData | an..99 | C | Mandatory only for girocard. Terminal data includes: online time, POS data and approval number of the terminal. Format: Hex, TLV-coded (see also TA BMP 61). |
| CCExpiry | n6 | C | Mandatory for credit cards. Expiry date of the card (YYYYMM), e.g. 202507. Must be sent for SEPAELV transactions. |
| CCSeqNr | n3 | O | Card sequence number. Must be sent for SEPAELV transactions. |
| EntryMode | n3 | C | Mandatory for credit cards. POS Entry Mode (Tag 9F39). Must be sent for SEPAELV transactions. |
| DMACKSN | an..20 | C | DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC). Mandatory for all devices except PhonePOS. |
| DMAC | an16 | C | DUKPT Message Authentication Code, which is formed over the entire message (all parameters except DMAC). See chapter "Formation of the DUKPTMAC". Mandatory for all devices except PhonePOS. |
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
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type transmitted in the request |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
Key | Format | CND | Description |
|---|---|---|---|
| CodeExt | an2 | O | Response code of the acquirer |
| POSTerminalID | an...20 | M | TerminalID of the card reader |
| VUNr | ans..20 | O | Only by credit card: contract number of the merchant with the acquirer. Configured at the merchant. |
| TerminalID | ans..20 | O | Only with credit card: TerminalID that Computop exchanges with the acquirer. Configured at the merchant. |
| AQ | ans..30 | O | Abbreviation of the Acquirers. Configured at the merchant. |
| TrxTime | ans21 | O | Time of execution of the transaction in format: dd.MM.yyyy HH:mm:ssff. Configured at the merchant. |
| ConfigUpdate | a3 | O | If this parameter occurs in the response and has the value "yes", then there is an update of the terminal configuration. The update can then be retrieved via the posconfig.aspx. |
| OriginalCode | ans..3 | O | MTT only: Contains the original Response Code (OmniPay BM 60 SF68: Scheme Response Code) from the authorization platforms for payment systems |
| DMACKSN | an..20 | M | DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC) |
| DMAC | an16 | M | DUKPT Message Authentication Code for the entire response |
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:
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type of request. Returned in response. Allowed value: 03 (Explanations in the appendix under Message Types) |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Key | Format | CND | Description |
|---|---|---|---|
| RefNr | ans..30 | O | Unique reference number. For DCC: dccReferenceData (reference of the DCC request). |
| 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). For DCC: Amount in foreign currency For Cashback transactions this should contain the sum of payment amount and cashback amount. | |
| Currency | a3 | M | Currency, three characters DIN / ISO 4217. At DCC: The foreign currency. |
| dccStatus | a1 | C | Mandatory for DCC; status of foreign currency settlement. Possible values: U foreign currency was used. E foreign currency was offered but not used. |
| dccRateValue | ans13 | C | Mandatory at DCC and dccStatus U ; Exchange rate with decimal point |
| dccRateID | ans..20 | C | Fiserv IPG-Rate. Only present in case of a DCC service via Fiserv. |
| baseAmount | n..10 | C | Mandatory at DCC and dccStatus U ; Amount in the smallest currency unit in Terminal currency |
| baseCurrency | a3 | C | Mandatory at DCC and dccStatus U ; Currency set up at the terminal as standard |
| dccMargin | ans..5 | O | DCC margin/markup percentage |
| dccCommission | ans..12 | O | DCC commission percentage |
| dccSource | ans..32 | O | Exchange rate source (e.g., "REUTERS WHOLESALE INTERBANK") |
| dccTimestamp | ans..20 | O | Timestamp of exchange rate |
| dccRequestId | an..32 | O | Computop PayID of the DCC request (enables linking DCC and POS payment records) |
| POSTerminalID | an..20 | M | TerminalID of the card reader |
Device | an16 | M | Serial number of the card reader |
| Manufacturer | an..30 | C | Manufacturer of the card reader (associated with the serial number) Mandatory for SEPAELV and Girocard, optional for others. |
| TerminalModel | ..60 | O | Model or type of card reader |
| CCNr | n8..19 | M | Card number |
| CCBrand | an..22 | M | Card brand: VISA, MasterCard, Maestro, AMEX, DINERS, JCB, CUP. Please note the spelling! Always specify SEPAELV at ELV! |
| CCExpiry | n6 | M | Expiration date of the card (YYYYMM), e.g. 202507 |
| CCSeqNr | n3 | O | Card sequence number |
| Track2 | an..224 | C | Data of the track2 for MSR or Track2EquivalentData (Tag 57) (in Hex formatting). At MSR Track2 or Track2Enc is mandatory. |
| DataEncrypted | an..2048 | O | Pan + Track2 Equivalent Data (in TLV format) as an encrypted value. If this field is present, the parameter CCNr is not required. PKSC#7 padding is recommended for the TLV string. |
| DataKSN | an..20 | C | KSN is generated by the terminal. Is required to decrypt the data from the parameter DataEncrypted. |
| EntryMode | n3 | C | Mandatory for credit cards. POS Entry Mode. |
| OrderDesc | ans..200 | O | Description of purchased goods, unit prices etc. |
| DMACKSN | an..20 | C | DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC). Mandatory for all devices except PhonePOS. |
| DMAC | an16 | C | DUKPT Message Authentication Code, which is formed over the entire message (all parameters except DMAC). See chapter "Formation of the DUKPTMAC". Mandatory for all devices except PhonePOS. |
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
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type transmitted in the request |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
Key | Format | CND | Description |
|---|---|---|---|
| POSTerminalID | an...20 | M | TerminalID of the card reader |
| CodeExt | an2 | M | Response code of the acquirer |
| VUNr | ans..20 | O | Only at credit card. Contract number of the merchant with the acquirer. Configured at the merchant. |
| TerminalID | ans..20 | O | Only at credit card. TerminalID, which Computop exchanges with the acquirer. Configured at the merchant. |
| AQ | ans..30 | O | Abbreviation of the acquirers. Configured at the merchant. |
| TrxTime | ans21 | O | Time of execution of the transaction in format: dd.MM.yyyy HH:mm:ssff. Configured at the merchant. |
| ConfigUpdate | a3 | O | If this parameter occurs in the response and has the value "yes", then there is an update of the terminal configuration. The update can then be retrieved via the posconfig.aspx. |
| DMACKSN | an..20 | M | DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC) |
| DMAC | an16 | M | DUKPT Message Authentication Code for the entire response |
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:
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type of request. Returned in response. Allowed value: 06 (Explanations in the appendix under Message Types) |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| refnr | ans..30 | O | Merchant’s unique reference number |
Key | Format | CND | Description |
|---|---|---|---|
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). For DCC: Amount in foreign currency For Cashback transactions this should contain the sum of payment amount and cashback amount. |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table |
| Key | Format | CND | Description |
|---|---|---|---|
an64 | M | Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here: |
Key | Format | CND | Description |
|---|---|---|---|
| POSTerminalID | an..20 | M | TerminalID of the card reader |
Device | an16 | M | Serial number of the card reader |
| Manufacturer | an..30 | M | Manufacturer of the card reader (associated with the serial number) |
| TerminalModel | ..60 | O | Model or type of card reader |
| CCSeqNr | n3 | O | Card sequence number |
| Track2 | an..224 | C | Mandatory with Magnetic Stripe Read (MSR). Data of the track2 for MSR or Track2EquivalentData (Tag 57) (in Hex formatting). |
| EMVData | an..2048 | C | EMC data as required for the passing on to the acquirer (in hex formatting). The exact structure is defined by the protocol used, which is stored in the master files of the terminal. If there are no EMC data, such as MSR, then completely omit this parameter. |
| EntryMode | n3 | M | POS Entry Mode |
| DataEncrypted | an..2048 | O | PAN + Track2 Equivalent Data (in TLV format) as encrypted value. If this field is present, the CCNr parameter is not required. |
| DataKSN | an..20 | C | KSN is generated by the terminal. Is required to decrypt the data from the parameter DataEncrypted. |
| LocalDate | n4 | M | Date of the transaction. Format: MMTT |
| LocalTime | n6 | M | Time of the transaction. Format: hhmmss |
| ReceiptNr | n4 | M | Number for the document. Will be continuously increased. Overflow to 9999. |
| DMACKSN | an..20 | C | DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC). Mandatory for all devices except PhonePOS. |
| DMAC | an16 | C | DUKPT Message Authentication Code, which is formed over the entire message (all parameters except DMAC). See chapter "Formation of the DUKPTMAC". Mandatory for all devices except PhonePOS. |
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
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type transmitted in the request |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| refnr | ans..30 | O | Merchant’s unique reference number |
| Key | Format | CND | Description |
|---|---|---|---|
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
Key | Format | CND | Description |
|---|---|---|---|
| CodeExt | an2 | O | Response code of the acquirer |
| POSTerminalID | an...20 | M | TerminalID of the card reader |
| OriginalCode | ans..3 | O | MTT only: Contains the original Response Code (OmniPay BM 60 SF68: Scheme Response Code) from the authorization platforms for payment systems |
| VUNr | ans..20 | O | Contract number of the merchant with the acquirer. Configured at the merchant. |
| TerminalID | ans..20 | O | TerminalID that Computop exchanges with the acquirer. Configured at the merchant. |
| AQ | ans..30 | O | Abbreviation of the Acquirers. Configured at the merchant. |
| TrxTime | ans21 | O | Time of execution of the transaction in format: dd.MM.yyyy HH:mm:ssff. Configured at the merchant. |
| EMVData | an..2048 | C | Block for additional data |
| ConfigUpdate | a3 | O | If this parameter occurs in the response and has the value "yes", then there is an update of the terminal configuration. The update can then be retrieved via the posconfig.aspx. |
| DMACKSN | an..20 | M | DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC) |
| DMAC | an16 | M | DUKPT Message Authentication Code for the entire response |
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:
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type of request. Returned in response. Allowed value: FC (Explanations in the appendix under Message Types) |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| refnr | ans..30 | O | Merchant’s unique reference number |
Key | Format | CND | Description |
|---|---|---|---|
| Amount | n..10 | M | Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit). For DCC: Amount in foreign currency For Cashback transactions this should contain the sum of payment amount and cashback amount. |
| Key | Format | CND | Description |
|---|---|---|---|
| Currency | a3 | M | Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table |
Key | Format | CND | Description |
|---|---|---|---|
| POSTerminalID | an...20 | M | TerminalID of the card reader |
| Device | an16 | M | Serial number of the card reader |
| CCBIN | n10 | M | The first 10 digits of the card number |
| CCExpiry | n6 | M | Expiration date of credit card (YYYDMM), e.g. 202507 |
| CCBrand | a..22 | M | Card brand |
| ContractID | n..8 | O | Additional contract number of the merchant |
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
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type transmitted in the request |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
| Key | Format | CND | Description |
|---|---|---|---|
| XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
| Key | Format | CND | Description |
|---|---|---|---|
| refnr | ans..30 | O | Merchant’s unique reference number |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
Key | Format | CND | Description |
|---|---|---|---|
| POSTerminalID | an...20 | M | TerminalID of the card reader |
| CodeExt | n..10 | O | The status of the DCC request if the merchant is activated and inquiry fails |
| ErrorText | an..256 | O | Error text when registered at the merchant fails |
| dccRateID | ans..20 | O | Fiserv IPG-Rate. Only present in case of a DCC service via Fiserv. |
| Following parameters are returned only if there is a successful query | |||
| dccRateValue | ans..13 | C | Exchange rate with decimal separator |
| dccForeignCurrencyCode | a3 | C | Foreign currency, three characters DIN / ISO 4217 |
| expirationTime | ans..19 | C | Time stamp indicating how long exchange rate is valid. Specification in UTC. Format: YYYY-MM-ddTHH:mm:ss |
| dccForeignAmount | n..10 | C | Foreign currency amount in the smallest currency unit |
| dccMargin | ans..5 | C | Exchange rate fee in percent. This value is the markup applied to foreign exchange rate for the transaction. This markup is also referred to as the rate margin which corresponds to the margin that is applied to the wholesale foreign exchange rate used in the DCC transaction. The rate margin is supplied for receipt printing purposes and to meet regulatory requirements where applicable. Examples 3 3.4 3,75 |
| dccCommission | ans7 | C | Reserved, Fixed "00.0000" - dd.dddd |
| dccSource | ans...32 | C | Exchange rate provider: "REUTERS WHOLESALE INTERBANK" |
| dccTimestamp | ans19 | C | Time stamp when the shift course was requested. Specification in UTC. Format: YYYY-MM-ddTHH:mm:ss |
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:
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type of request. Returned in response. Here always: |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
Key | Format | CND | Description |
|---|---|---|---|
| POSTerminalID | an..20 | M | TerminalID of the card reader |
Device | an16 | M | Serial number of the card reader |
| Manufacturer | an..30 | M | Manufacturer of the card reader (associated with the serial number) |
| TerminalModel | ..60 | O | Model or type of card reader |
| DMACKSN | an..20 | M | DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC). |
| DMAC | an16 | M | DUKPT Message Authentication Code, which is formed over the entire message (all parameters except DMAC). See chapter "Formation of the DUKPTMAC". |
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
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type transmitted in the request |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
Key | Format | CND | Description |
|---|---|---|---|
| ConfigData | ans..8192 | M | Configuration data in the agreed format |
| POSTerminalID | an...20 | M | TerminalID of the card reader |
| DMACKSN | an..20 | M | DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC) |
| DMAC | an16 | M | DUKPT Message Authentication Code for the entire response |
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:
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type of request. Returned in response. Here always: F2 (Explanations in the appendix under Message Types) |
Key | Format | CND | Description |
|---|---|---|---|
| POSTerminalID | an..20 | M | TerminalID of the card reader |
Device | an16 | M | Serial number of the card reader |
| Manufacturer | an..30 | M | Manufacturer of the card reader (associated with the serial number) |
| TerminalModel | ..60 | O | Model or type of card reader |
| DMACKSN | an..20 | M | DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC). |
| DMAC | an16 | M | DUKPT Message Authentication Code, which is formed over the entire message (all parameters except DMAC). See chapter "Formation of the DUKPTMAC". |
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
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type transmitted in the request |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) |
| Key | Format | CND | Description |
|---|---|---|---|
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
Key | Format | CND | Description |
|---|---|---|---|
| ConfigData | ans..8192 | M | Configuration data in the agreed format |
| POSTerminalID | an...20 | M | TerminalID of the card reader |
| DMACKSN | an..20 | M | DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC) |
| DMAC | an16 | M | DUKPT Message Authentication Code for the entire response |
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:
Key | Format | CND | Description |
|---|---|---|---|
subMID | ans..15 | C | SubMerchantID, which is assigned by the Payment Facilitator and transmitted in the call to identify submerchants in the transaction process. |
subMIDName | ans..22 | C | Name of the SubMerchantID |
subMIDAddrCity | ans..13 | C | City of SubMerchantID |
subMIDAddrCountryCode | a2 | C | Country code of the SubMerchantID in the format ISO-3166-1, alphanumerical 2-digit |
subMIDAddrStreet | ans..38 | C | Road of SubMerchantID |
subMIDAddrZip | ans..10 | C | Postal code of SubMerchantID |
subMIDAddrState | ans3 | C | Federal state of SubMerchantID |
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:
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type of request. Returned in response. Allowed value: |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. |
| Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment |
Key | Format | CND | Description |
|---|---|---|---|
| POSTerminalID | an..20 | M | TerminalID of the card reader |
Device | an16 | M | Serial number of the card reader |
cutoff | JSON | O | Base64 encoded JSON object |
| DMACKSN | an..20 | M | DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC). |
| DMAC | an16 | M | DUKPT Message Authentication Code, which is formed over the entire message (all parameters except DMAC). See chapter "Formation of the DUKPTMAC". |
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
Key | Format | CND | Description |
|---|---|---|---|
| MessageType | an2 | M | Message type transmitted in the request |
| Key | Format | CND | Description |
|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop |
| Key | Format | CND | Description |
|---|---|---|---|
| PayID | an32 | M | ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request. |
Key | Format | CND | Description |
|---|---|---|---|
| TransID | ans..64 | C | Only on success: Merchant's transaction number. |
| POSTerminalID | an..20 | M | TerminalID of the card reader |
| Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure). Refers to the inquire request itself. |
| Key | Format | CND | Description |
|---|---|---|---|
| Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
| Key | Format | CND | Description |
|---|---|---|---|
| Code | an8 | M | Error code according to Paygate Response Codes (A4 Error codes) |
Key | Format | CND | Description |
|---|---|---|---|
| DMACKSN | an..20 | M | DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC). |
| DMAC | an16 | M | DUKPT Message Authentication Code, which is formed over the entire message (all parameters except DMAC). See chapter "Formation of the DUKPTMAC". |
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. When OfflineSale=true, the sale is processed as an offline/merchant risk transaction without prior online authorization. |
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 |
