The scope of this documentation is to provide towards different POS partners the specifications of 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 team.

On this page



interface


General terminal requests

The parameters listed here generally apply to all requests from a terminal to the .

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:

 posPayment.aspx

For the Integration test system, please use: https://dev.computop.de/Paygate/posPayment.aspx.


Key

Format

CND

Description

MessageTypean2MMessage type of request. Returned in response. For authorized values, see explanations in the appendix under Message Types.

Key

Format

CND

Description

Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the , 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

POSTerminalIDan..20MTerminalID of the card reader

Device

an16MSerial number of the card reader
Manufactureran..30MManufacturer of the card reader (associated with the serial number)
TerminalModel..60OModel or type of card reader
CCNrn8.19CPAN of the card
CCBrandan..22MCard brand or name of another payment method
EMVDataan..2048C

Block for additional data. If there are no additional data, e.g. with MSR, then completely omit this parameter.

OrderDescans..200ODescription of purchased goods, unit prices etc.
LocalDaten4C

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.

LocalTimen6C

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.

ReceiptNrn4C

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)

ExtraCapabilitiesan4O

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) 
0001 : Single Tap capable

DMACKSNan..20C

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC). Mandatory for all devices except PhonePOS.

DMACan16C

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.

General parameters for terminal payments with POS Payment


Key

Format

CND

Description

MessageTypean2M

Message type transmitted in the request

Key

Format

CND

Description

POSTerminalIDan..20MTerminalID of the card reader
EMVDataan..2048C

Block for additional data

ConfigUpdatea3O

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.

DMACKSNan..20M

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC)

DMACan16M

DUKPT Message Authentication Code for the entire response

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:

 posPayment.aspx

For the Integration test system, please use: https://dev.computop.de/Paygate/posPayment.aspx.


Key

Format

CND

Description

MessageTypean2M

Message type of request. Returned in response. Allowed values:
01 for payment booking and
05 for reservation / authorization

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

Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the , 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

CashbackAmountn..10OCashback Amount in case such transaction type is submitted. Given in the smallest currency unit (e.g. EUR Cent).

Key

Format

CND

Description

POSTerminalIDan..20MTerminalID of the card reader

Device

an16MSerial number of the card reader
Manufactureran..30MManufacturer of the card reader (associated with the serial number)
TerminalModel..60OModel or type of card reader
CCNrn8.19CMandatory if the credit card number is not passed in the DataEncrypted parameter
CCBrandan..22MCard brand: VISA, MasterCard, Maestro, AMEX, DINERS, JCB, CUP. Please note the spelling! 
Always specify SEPAELV at ELV!
CCCVCn4OCard check number: The last 3 digits on the credit card sub-type, at AMEX 4 digits.
CCExpiryn6MExpiration date of credit card (YYYYMM), e.g. 202507
CCSeqNon3OCard sequence number
Track2an..224CMandatory with Magnetic Stripe Read (MSR). Data of the track2 for MSR or Track2EquivalentData (Tag 57) (in Hex formatting).
EMVDataan..2048C

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.

EntryModen3M

POS entry mode

OfflineSaleboolC

If set to "true", the transaction is processed as an offline/merchant risk sale. No online authorization takes place the merchant bears the risk. 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.

PINDataan..128C

Mandatory for online PIN. Encrypted PIN in ISO-0 format.

PINKSNan..20C

Mandatory for online PIN. DUKPT Key Serial Number of the PIN.

DataEncryptedan..2048O

PAN + Track2 equivalent data (in TLV format) as encrypted value. If this field is present, the CCNr parameter is not required.

DataKSNan..20C

KSN is generated by the terminal. Needed to decrypt the data from the DataEncrypted parameter.

OrderDescans..200ODescription of purchased goods, unit prices etc.
ChDescan..25OText shown on the customer's credit card statement next to the payee
LocalDaten4C

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.

LocalTimen6C

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.

ReceiptNrn4C

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)

dccStatusa1C

Mandatory for DCC; status of foreign currency settlement. Possible values: U foreign currency was used. E foreign currency was offered but not used.

dccRateValueans13C

Mandatory at DCC and dccStatus U; Exchange rate with decimal point

baseAmountn..10C

Mandatory at DCC and dccStatus U; Amount in the smallest currency unit in Terminal currency

baseCurrencya3C

Mandatory at DCC and dccStatus U; Currency set up at the terminal as standard

dccMarginans..5O

DCC margin/markup percentage

dccCommissionans..12O

DCC commission percentage

dccSourceans..32O

Exchange rate source (e.g., "REUTERS WHOLESALE INTERBANK")

dccTimestampans..20O

Timestamp of exchange rate

dccRequestIdan..32O

PayID of the DCC request (enables linking DCC and POS payment records)

ContractIDn..8O

Additional contract number of the merchant with the acquirer, with which the default VU number can be overridden

AccVerifya..3O

Allowed value: yes
If this parameter is transmitted, an account verification (Zero Value Account Verification) is executed. In this case, the parameters amount and currency are optional. The amount can be zero.

RTFan1O

For recurring payments. Allowed values: I (initial payment of a new subscription) or E (agreement that COF is used for further payments).

PACFormatn2O

Defines the ISO PIN format present in PINData parameter. Valid values:

10: ISO-0

11: ISO-1

14: ISO-4

If this value is not set than ISO-0 is taken as the default one.

ExtraCapabilitiesan4O

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) 
0001 : Single Tap capable

DuplicateATCa3CMandatory 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
DMACKSNan..20C

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC). Mandatory for all devices except PhonePOS.

DMACan16C

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.

dccRateIDans..20O

Fiserv IPG-Rate. Only required in case of a DCC service via Fiserv.

TraceNran..6C

A number assigned by a terminal to identify uniquely a transaction. Mandatory for SEPAELV and girocard transactions, optional for others.

ConditionCodean..2C

Additional information for transaction, to be communicated with CLV+ end. Mandatory for SEPAELV and girocard transactions, optional for others.

Parameters for POS payments with credit card


Key

Format

CND

Description

MessageTypean2M

Message type transmitted in the request

Key

Format

CND

Description

POSTerminalIDan..20MTerminalID of the card reader
CodeExtan2MResponse code of the acquirer
ApprovalCoden..6CApproval code of the acquirer (also known as the authCode or authorization . called Response). Configured at the merchant.
EMVDataan..2048C

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).

VUNrans..20O

Contract number of the merchant with the acquirer. Configured at the merchant.

TerminalIDans..20O

TerminalID, which exchanges with the acquirer. Configured at the merchant.

AQans..30O

Abbreviation of the acquirers. Configured at the merchant.

TrxTimeans21O

Time of execution of the transaction in format: dd.MM.yyyy HH:mm:ssff. Configured at the merchant.

AdditionalResponseDataans..99O

Additional Response Data (at GICC BMP 44), which the acquirer sends in the response. Configured at the merchant.

PCNrn..16O

Pseudo card number:  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.

TransactionIDan..56C

Value returned in response to an initial recurring payment (RTF-I or E)

ConfigUpdatea3O

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.

Last4CardholderPANn..4O

MTT only: The last 4 digits of the printed PAN at VISA if the tokenized DPAN was used in the request

PARans..999O

Only MTT: Payment Account Reference, which VISA/MasterCard makes available to the merchant to identify a customer in their back office system

EmbossedPANPCNrn..19O

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.

EmbossedPANExpiryDaten..4O

MTT and MasterCard/Maestro only: The expiration date belonging to the Embossed PAN parameter, which is included in the Acquirer response. Format: YYMM.

OriginalCodeans..3O

MTT only: Contains the original Response Code (OmniPay BM 60 SF68: Scheme Response Code) from the authorization platforms for payment systems

schemeReferenceIDans..64O

MTT only: Cardmark-specific transaction ID required for subsequent card on file payments, delayed authorizations and resubmission.

DMACKSNan..20M

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC)

DMACan16M

DUKPT Message Authentication Code for the entire response

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:

 posPayment.aspx

For the Integration test system, please use: https://dev.computop.de/Paygate/posPayment.aspx.


Key

Format

CND

Description

MessageTypean2MMessage type of request. Returned in response. Allowed values:
0B for Booking Notification
(Explanations in the appendix under Message Types)

Key

Format

CND

Description

Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the , 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

POSTerminalIDan...20MTerminalID of the card reader

Device

an16MSerial number of the card reader
Manufactureran..30MManufacturer of the card reader (associated with the serial number)
TerminalModel..60OModel or type of card reader
LocalDaten4M

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.

LocalTimen6M

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.

DMACKSNan..20C

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC). Mandatory for all devices except PhonePOS.

DMACan16C

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.

Parameters for captures of POS payments


Key

Format

CND

Description

MessageTypean2MMessage type transmitted in the request

Key

Format

CND

Description

POSTerminalIDan...20MTerminalID of the card reader
ConfigUpdatea3O

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.

DMACKSNan..20M

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC)

DMACan16M

DUKPT Message Authentication Code for the entire response

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:

 posPayment.aspx

For the Integration test system, please use: https://dev.computop.de/Paygate/posPayment.aspx.


Key

Format

CND

Description

MessageTypean2MMessage type of request. Returned in response. Allowed values:
01 for authorization and automated booking
(Explanations in the appendix under Message Types)
ProcessModean2MPossible values:
00: Offline
01: Online
0E: Emergency Offline (terminal is not connected to accept server) 
EC: Emergengy in EC network operation

Key

Format

CND

Description

Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the , 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

POSTerminalIDan...20MTerminalID of the card reader

Device

an16MSerial number of the card reader
Manufactureran..30MManufacturer of the card reader (associated with the serial number)
TerminalModel..60OModel or type of card reader
CCNrn8.19MPAN of the girocard
CCBrandan...22MFixed value: girocard
CCExpiryn6MExpiration date of girocard (YYYYMM), e.g. 202507
CCSeqNrn3OCard sequence number
Track2an..224MObligation to authorise or emergency operation. Data of the track2 for MSR or Track2EquivalentData (Tag 57) (in Hex formatting).
EMVDataan..2048C

EMC data as required for the continuation to the headend (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.

EntryModen3M

POS entry mode

PINDataan..128C

Mandatory for online PIN. Encrypted PIN in ISO-1 format.

PINKSNan..20C

Mandatory for online PIN. DUKPT Key Serial Number of the PIN.

OrderDescans..200ODescription of purchased goods, unit prices etc.
LocalDaten4M

Date of the transaction. Format: MMTT

LocalTimen6M

Time of the transaction. Format: hhmmss

ReceiptNrn4M

Number for the document. Will be continuously increased. Overflow to 9999.

TerminalDataan...99M

Terminal data includes: online time, POS data and approval number of the terminal. Format: Hex, TLV-coded (see also TA BMP 61).

ConditionCoden2C

Condition code. Values from 00 to 99 as described in TA under BMP 25.

TraceNrn6M

Continuous 6-digit decimal. Is incremented for each transaction as described in TA.

PACFormatn2O

Defines the PIN ISO format used. 10: ISO-0 11: ISO-1

At girocard, the PIN ISO 1 format is allowed.

ExtraCapabilitiesan4O

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) 
0001 : Single Tap capable

DMACKSNan...20C

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC). Mandatory for all devices except PhonePOS.

DMACan16C

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.

Parameters for POS payments with girocard


Key

Format

CND

Description

MessageTypean2M

Message type transmitted in the request

Key

Format

CND

Description

POSTerminalIDan...20MTerminalID of the card reader
CodeExtan2MResponse code of the acquirer
ApprovalCoden..6CApproval code from the acquirer (also known as AuthCode or Authorisation ID. called Response). Configured at the merchant.
EMVDataan..2048C

Response headroom (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)

ConfigUpdatea3O

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.

DMACKSNan..20M

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC)

DMACan16M

DUKPT Message Authentication Code for the entire response

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:

 posPayment.aspx

For the Integration test system, please use: https://dev.computop.de/Paygate/posPayment.aspx.


Key

Format

CND

Description

MessageTypean2MMessage type of request. Returned in response. Allowed values:
01 
(Explanations in the appendix under Message Types)

Key

Format

CND

Description

Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the , 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

POSTerminalIDan..20MTerminalID of the card reader

Device

an16MSerial number of the card reader
Manufactureran..30MManufacturer of the card reader (associated with the serial number)
TerminalModel..60OModel or type of card reader
CCNrn8.19MNot required for Alipay / Wechat. Please pass 0000000000000000 (16 x 0), because mandatory.
CCBrandan..22MAt Alipay please always include, at Wechat always show Wechat!
OrderDescans..200ODescription of purchased goods, unit prices etc.
ContractIDn..8O

Additional contract number of the merchant with the acquirer, with which the default VU number can be overridden

DMACKSNan..20C

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC). Mandatory for all devices except PhonePOS.

DMACan16C

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.

Parameters for POS payments with Alipay or Wechat


Key

Format

CND

Description

MessageTypean2M

Message type transmitted in the request

Key

Format

CND

Description

POSTerminalIDan..20MTerminalID of the card reader
Statusa..50MAUTHORIZE-REQUEST or FAILED
Descriptionans..1024MPENDING, 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!
Coden8M

If a valid QR code can be submitted, then 21190985 or 23030985 for PENDING otherwise error code according to  Response Codes (A4 Error codes)

EMVDataan..2048C

Value for the QR code in JSON format additionally base64-viren. Examples:
a) Alipay
ew0KCSJxCNvZSPiOiAHR0cHM6Ly9xci5hbGlwYXkuY29tL28JheDAwMTNo25tbW5XNiMDBlNiINCn0

b) Wechat eyJxCMNvZGUiOiJ3Zl4AW46Ly93eHHeS9iaXpwYXl1cmw/cHI9U0pwclkwWSJ9

base64-decoded:
a) Ã "qrcode":"https://qr.alipay.com/bax009917nmmndisb00e6", "tradeÃ3no:"1234567890123456"

b) Ã "qrcode":"weixin://wxpay/bizpayurl? pr-SJprY0Y"

ConfigUpdatea3O

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.

VUNrans..20M

PartnerID of the merchant

DMACKSNan..20M

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC)

DMACan16M

DUKPT Message Authentication Code for the entire response

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:

 posPayment.aspx

For the Integration test system, please use: https://dev.computop.de/Paygate/posPayment.aspx.


Key

Format

CND

Description

MessageTypean2MMessage type of request. Returned in response. Allowed values:
01 
(Explanations in the appendix under Message Types)

Key

Format

CND

Description

Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the , 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

POSTerminalIDan..20MTerminalID of the card reader

Device

an16MSerial number of the card reader
Manufactureran..30MManufacturer of the card reader (associated with the serial number)
TerminalModel..60OModel or type of card reader
CCNrn8.19MPAN of the card. With easyCredit the PAN consisting of country prefix, short bank code, account number and check digit.
CCBrandan..22MPlease always include easyCredit with easyCredit!
CCExpiryn6CMandatory for credit cards. Expiration date of credit card (YYYDMM), e.g. 202507.
OrderDescans..200ODescription of purchased goods, unit prices etc.
ContractIDn..8O

Additional contract number of the merchant with the acquirer, with which the default VU number can be overridden

DMACKSNan..20C

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC). Mandatory for all devices except PhonePOS.

DMACan16C

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.

Parameters for POS payments with easyCredit


Key

Format

CND

Description

MessageTypean2M

Message type transmitted in the request

Key

Format

CND

Description

Beschreibung

POSTerminalIDan...20MTerminalID of the card reader

TerminalID des Kartenlesers

CodeExtan2MResponse code from easyCredit posData.status code

Antwortcode von easyCredit posData.status code

ApprovalCoden..6CWith easyCredit the approval number

Bei easyCredit die Genehmigungsnummer

EMVDataan..2048C

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).

VUNrans..20O

With easyCredit the sales office number of the store

Bei easyCredit die Verkaufsstellennummer des Geschäfts

ConfigUpdatea3O

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.

DMACKSNan..20M

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

DMACan16M

DUKPT Message Authentication Code for the entire response

DUKPT-Nachrichtenauthentifizierungscode für die gesamte Antwort

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:

 posPayment.aspx

For the Integration test system, please use: https://dev.computop.de/Paygate/posPayment.aspx.


Key

Format

CND

Description

MessageTypean2MMessage 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

POSTerminalIDan..20MTerminalID of the card reader

Device

an16MSerial number of the card reader
Manufactureran..30C

Manufacturer of the card reader (associated with the serial number)

Mandatory for SEPAELV and Girocard, optional for others.

TerminalModel..60OModel or type of card reader
DMACKSNan..20C

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC). Mandatory for all devices except PhonePOS.

DMACan16C

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.

Parameters for inquiring information about POS payments


Key

Format

CND

Description

MessageTypean2M

Message type transmitted in the request

Key

Format

CND

Description

TransIDans..64C

Transaction number of the merchant. In the event of an error, not included in the answer.

Statusa..50M

OK or FAILED. Refers to the Inquire request itself.

Key

Format

CND

Description

POSTerminalIDan...20MTerminalID of the card reader
AmountAuthn..10OAuthorized amount of the requested operation
AmountCapn..10OCaptured amount of the requested process
AmountCredn..10OCredited amount of the requested process
LastStatusn..10OStatus of the requested process
ConfigUpdatea3O

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.

DMACKSNan..20M

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC)

DMACan16M

DUKPT Message Authentication Code for the entire response

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:

 posPayment.aspx

For the Integration test system, please use: https://dev.computop.de/Paygate/posPayment.aspx.


Key

Format

CND

Description

MessageTypean2MMessage type of request. Returned in response. Allowed value: 
F0
(Explanations in the appendix under Message Types)

Key

Format

CND

Description

Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the , 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

CashbackAmountn..10OCashback Amount in case such transaction type is submitted. Given in the smallest currency unit (e.g. EUR Cent).

Key

Format

CND

Description

POSTerminalIDan..20MTerminalID of the card reader

Device

an16MSerial number of the card reader
Manufactureran..30C

Manufacturer of the card reader (associated with the serial number)

Mandatory for SEPAELV and Girocard, optional for others.

TerminalModel..60OModel or type of card reader
EMVDataan..2048C

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.

CCSeqNon3OCard sequence number
OrderDescans..200ODescription of purchased goods, unit prices etc.
LocalDaten4C

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.

LocalTimen6C

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.

ReceiptNrn4C

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)

dccStatusa1C

Mandatory for DCC; status of foreign currency settlement. Possible values: U foreign currency was used. E foreign currency was offered but not used.

TraceNrn6O

Continuous 6-digit decimal. Is incremented for each transaction as described in TA.

ConditionCoden2C

Mandatory only for girocard. Condition code. Values from 00 to 99 as described in TA under BMP 25.

TerminalDataan..99C

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).

DMACKSNan..20C

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC). Mandatory for all devices except PhonePOS.

DMACan16C

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.

Parameters for reversals of POS payments


Key

Format

CND

Description

MessageTypean2M

Message type transmitted in the request

Key

Format

CND

Description

CodeExtan2MResponse code of the acquirer
EMVDataan..2048C

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)

POSTerminalIDan...20MTerminalID of the card reader
ConfigUpdatea3O

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.

VUNrans..20O

Only by credit card: contract number of the merchant with the acquirer. Configured at the merchant.

TerminalIDans..20O

Only with credit card: TerminalID that exchanges with the acquirer. Configured at the merchant.

AQans..30O

Abbreviation of the Acquirers. Configured at the merchant.

TrxTimeans21O

Time of execution of the transaction in format: dd.MM.yyyy HH:mm:ssff. Configured at the merchant.

DMACKSNan..20M

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC)

DMACan16M

DUKPT Message Authentication Code for the entire response

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:

 posPayment.aspx

For the Integration test system, please use: https://dev.computop.de/Paygate/posPayment.aspx.


Key

Format

CND

Description

MessageTypean2MMessage type of request. Returned in response. Allowed value: 
02
(Explanations in the appendix under Message Types)

Key

Format

CND

Description

Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the , 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

CashbackAmountn..10OCashback Amount in case such transaction type is submitted. Given in the smallest currency unit (e.g. EUR Cent).

Key

Format

CND

Description

POSTerminalIDan..20MTerminalID of the card reader

Device

an16MSerial number of the card reader
Manufactureran..30M

Manufacturer of the card reader (associated with the serial number)

TerminalModel..60OModel or type of card reader
LocalDaten4M

Date of the transaction. Format: MMTT

LocalTimen6M

Time of the transaction. Format: hhmmss

ReceiptNrn4M

Number for the document. Will be continuously increased. Overflow to 9999.

TraceNrn6M

Continuous 6-digit decimal. Is incremented for each transaction as described in TA.

ConditionCoden2C

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.

TerminalDataan..99C

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).

CCExpiryn6C

Mandatory for credit cards. Expiry date of the card (YYYYMM), e.g. 202507. Must be sent for SEPAELV transactions.

CCSeqNrn3O

Card sequence number. Must be sent for SEPAELV transactions.

EntryModen3C

Mandatory for credit cards. POS Entry Mode (Tag 9F39). Must be sent for SEPAELV transactions.

DMACKSNan..20C

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC). Mandatory for all devices except PhonePOS.

DMACan16C

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.

Parameters for manual reversals of POS payments


Key

Format

CND

Description

MessageTypean2M

Message type transmitted in the request

Key

Format

CND

Description

CodeExtan2OResponse code of the acquirer
POSTerminalIDan...20MTerminalID of the card reader
VUNrans..20O

Only by credit card: contract number of the merchant with the acquirer. Configured at the merchant.

TerminalIDans..20O

Only with credit card: TerminalID that exchanges with the acquirer. Configured at the merchant.

AQans..30O

Abbreviation of the Acquirers. Configured at the merchant.

TrxTimeans21O

Time of execution of the transaction in format: dd.MM.yyyy HH:mm:ssff. Configured at the merchant.

ConfigUpdatea3O

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.

OriginalCodeans..3O

MTT only: Contains the original Response Code (OmniPay BM 60 SF68: Scheme Response Code) from the authorization platforms for payment systems

DMACKSNan..20M

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC)

DMACan16M

DUKPT Message Authentication Code for the entire response

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:

 posPayment.aspx

For the Integration test system, please use: https://dev.computop.de/Paygate/posPayment.aspx.


Key

Format

CND

Description

MessageTypean2MMessage type of request. Returned in response. Allowed value: 
03
(Explanations in the appendix under Message Types)

Key

Format

CND

Description

RefNrans..30O

Unique reference number. For DCC: dccReferenceData (reference of the DCC request).

Amount

n..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the , 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.

Currencya3M

Currency, three characters DIN / ISO 4217. At DCC: The foreign currency.

dccStatusa1CMandatory for DCC; status of foreign currency settlement. Possible values: U foreign currency was used. E foreign currency was offered but not used.
dccRateValueans13CMandatory at DCC and dccStatus U ; Exchange rate with decimal point
dccRateIDans..20CFiserv IPG-Rate. Only present in case of a DCC service via Fiserv.
baseAmountn..10CMandatory at DCC and dccStatus U ; Amount in the smallest currency unit in Terminal currency
baseCurrencya3CMandatory at DCC and dccStatus U ; Currency set up at the terminal as standard
dccMarginans..5O

DCC margin/markup percentage

dccCommissionans..12O

DCC commission percentage

dccSourceans..32O

Exchange rate source (e.g., "REUTERS WHOLESALE INTERBANK")

dccTimestampans..20O

Timestamp of exchange rate

dccRequestIdan..32O

PayID of the DCC request (enables linking DCC and POS payment records)

POSTerminalIDan..20MTerminalID of the card reader

Device

an16MSerial number of the card reader
Manufactureran..30C

Manufacturer of the card reader (associated with the serial number)

Mandatory for SEPAELV and Girocard, optional for others.

TerminalModel..60OModel or type of card reader
CCNrn8..19MCard number
CCBrandan..22MCard brand: VISA, MasterCard, Maestro, AMEX, DINERS, JCB, CUP. Please note the spelling! Always specify SEPAELV at ELV!
CCExpiryn6MExpiration date of the card (YYYYMM), e.g. 202507
CCSeqNrn3OCard sequence number
Track2an..224CData of the track2 for MSR or Track2EquivalentData (Tag 57) (in Hex formatting). At MSR Track2 or Track2Enc is mandatory.
DataEncryptedan..2048O

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.

DataKSNan..20CKSN is generated by the terminal. Is required to decrypt the data from the parameter DataEncrypted.
EntryModen3CMandatory for credit cards. POS Entry Mode.
OrderDescans..200ODescription of purchased goods, unit prices etc.
DMACKSNan..20C

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC). Mandatory for all devices except PhonePOS.

DMACan16C

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.

Parameters for credits of POS payments


Key

Format

CND

Description

MessageTypean2M

Message type transmitted in the request

Key

Format

CND

Description

POSTerminalIDan...20MTerminalID of the card reader
CodeExtan2MResponse code of the acquirer
VUNrans..20OOnly at credit card. Contract number of the merchant with the acquirer. Configured at the merchant.
TerminalIDans..20O

Only at credit card. TerminalID, which exchanges with the acquirer. Configured at the merchant.

AQans..30OAbbreviation of the acquirers. Configured at the merchant.
TrxTimeans21OTime of execution of the transaction in format: dd.MM.yyyy HH:mm:ssff. Configured at the merchant.
ConfigUpdatea3O

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.

DMACKSNan..20M

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC)

DMACan16M

DUKPT Message Authentication Code for the entire response

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:

 posPayment.aspx

For the Integration test system, please use: https://dev.computop.de/Paygate/posPayment.aspx.


Key

Format

CND

Description

MessageTypean2MMessage type of request. Returned in response. Allowed value: 
06
(Explanations in the appendix under Message Types)

Key

Format

CND

Description

Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the , 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

POSTerminalIDan..20MTerminalID of the card reader

Device

an16MSerial number of the card reader
Manufactureran..30M

Manufacturer of the card reader (associated with the serial number)

TerminalModel..60OModel or type of card reader
CCSeqNrn3OCard sequence number
Track2an..224CMandatory with Magnetic Stripe Read (MSR). Data of the track2 for MSR or Track2EquivalentData (Tag 57) (in Hex formatting).
EMVDataan..2048C

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.

EntryModen3MPOS Entry Mode
DataEncryptedan..2048OPAN + Track2 Equivalent Data (in TLV format) as encrypted value. If this field is present, the CCNr parameter is not required.
DataKSNan..20CKSN is generated by the terminal. Is required to decrypt the data from the parameter DataEncrypted.
LocalDaten4M

Date of the transaction. Format: MMTT

LocalTimen6M

Time of the transaction. Format: hhmmss

ReceiptNrn4M

Number for the document. Will be continuously increased. Overflow to 9999.

DMACKSNan..20C

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC). Mandatory for all devices except PhonePOS.

DMACan16C

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.

Parameters for increments of POS payments


Key

Format

CND

Description

MessageTypean2M

Message type transmitted in the request

Key

Format

CND

Description

CodeExtan2OResponse code of the acquirer
POSTerminalIDan...20MTerminalID of the card reader
OriginalCodeans..3OMTT only: Contains the original Response Code (OmniPay BM 60 SF68: Scheme Response Code) from the authorization platforms for payment systems
VUNrans..20O

Contract number of the merchant with the acquirer. Configured at the merchant.

TerminalIDans..20O

TerminalID that  exchanges with the acquirer. Configured at the merchant.

AQans..30O

Abbreviation of the Acquirers. Configured at the merchant.

TrxTimeans21O

Time of execution of the transaction in format: dd.MM.yyyy HH:mm:ssff. Configured at the merchant.

EMVDataan..2048C

Block for additional data

ConfigUpdatea3O

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.

DMACKSNan..20M

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC)

DMACan16M

DUKPT Message Authentication Code for the entire response

Response parameters for increments of POS payments


DCC transactions via VPN

In order to make a DCC request, please use the following URL:

 posdcc.aspx

For the Integration test system, please use: https://dev.computop.de/Paygate/posdcc.aspx.


Key

Format

CND

Description

MessageTypean2MMessage type of request. Returned in response. Allowed value: 
FC 
(Explanations in the appendix under Message Types)

Key

Format

CND

Description

Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the , 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

POSTerminalIDan...20MTerminalID of the card reader
Devicean16MSerial number of the card reader
CCBINn10MThe first 10 digits of the card number
CCExpiryn6MExpiration date of credit card (YYYDMM), e.g. 202507
CCBranda..22MCard brand
ContractIDn..8OAdditional contract number of the merchant

Parameters for DCC requests


Key

Format

CND

Description

MessageTypean2M

Message type transmitted in the request

Key

Format

CND

Description

POSTerminalIDan...20MTerminalID of the card reader
CodeExtn..10OThe status of the DCC request if the merchant is activated and inquiry fails
ErrorTextan..256OError text when registered at the merchant fails
dccRateIDans..20OFiserv IPG-Rate. Only present in case of a DCC service via Fiserv.



Following parameters are returned only if there is a successful query
dccRateValueans..13CExchange rate with decimal separator
dccForeignCurrencyCodea3CForeign currency, three characters DIN / ISO 4217
expirationTimeans..19C

Time stamp indicating how long exchange rate is valid. Specification in UTC.

Format: YYYY-MM-ddTHH:mm:ss

dccForeignAmountn..10CForeign currency amount in the smallest currency unit
dccMarginans..5C

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

dccCommissionans7CReserved, Fixed "00.0000" - dd.dddd
dccSourceans...32C

Exchange rate provider: "REUTERS WHOLESALE INTERBANK"

dccTimestampans19C

Time stamp when the shift course was requested. Specification in UTC.

Format: YYYY-MM-ddTHH:mm:ss

Response parameters for DCC requests


Terminal configuration

Retrieve the terminal configuration data from the

In order to retrieve the POS terminal configuration data, please use the following URL:

 posConfig.aspx

For the Integration test system, please use: https://dev.computop.de/Paygate/posConfig.aspx.


Key

Format

CND

Description

MessageTypean2M

Message type of request. Returned in response. Here always:
F2
(Explanations in the appendix under Message Types)

Key

Format

CND

Description

POSTerminalIDan..20MTerminalID of the card reader

Device

an16MSerial number of the card reader
Manufactureran..30M

Manufacturer of the card reader (associated with the serial number)

TerminalModel..60OModel or type of card reader
DMACKSNan..20M

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC).

DMACan16M

DUKPT Message Authentication Code, which is formed over the entire message (all parameters except DMAC). See chapter "Formation of the DUKPTMAC".

Parameters for retrieving POS terminal configuration data


Key

Format

CND

Description

MessageTypean2M

Message type transmitted in the request

Key

Format

CND

Description

ConfigDataans..8192MConfiguration data in the agreed format
POSTerminalIDan...20MTerminalID of the card reader
DMACKSNan..20M

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC)

DMACan16M

DUKPT Message Authentication Code for the entire response

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

In order to retrieve the POS terminal configuration data, please use the following URL:

 posConfigExt.aspx

For the Integration test system, please use: https://dev.computop.de/Paygate/posConfigExt.aspx.


Key

Format

CND

Description

MessageTypean2MMessage type of request. Returned in response. Here always:
F2
(Explanations in the appendix under Message Types)

Key

Format

CND

Description

POSTerminalIDan..20MTerminalID of the card reader

Device

an16MSerial number of the card reader
Manufactureran..30M

Manufacturer of the card reader (associated with the serial number)

TerminalModel..60OModel or type of card reader
DMACKSNan..20M

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC).

DMACan16M

DUKPT Message Authentication Code, which is formed over the entire message (all parameters except DMAC). See chapter "Formation of the DUKPTMAC".

Parameters for retrieving POS terminal configuration data


Key

Format

CND

Description

MessageTypean2M

Message type transmitted in the request

Key

Format

CND

Description

ConfigDataans..8192MConfiguration data in the agreed format
POSTerminalIDan...20MTerminalID of the card reader
DMACKSNan..20M

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC)

DMACan16M

DUKPT Message Authentication Code for the entire response

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:

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

Additional parameters for using the Payment Facilitator


CUT-OFF


Key

Format

CND

Description

MessageTypean2M

Message type of request. Returned in response. Allowed value: 
CF 
(Explanations in the appendix under Message Types)

Key

Format

CND

Description

POSTerminalIDan..20MTerminalID of the card reader

Device

an16MSerial number of the card reader

cutoff

JSONOBase64 encoded JSON object
DMACKSNan..20M

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC).

DMACan16M

DUKPT Message Authentication Code, which is formed over the entire message (all parameters except DMAC). See chapter "Formation of the DUKPTMAC".

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>
        }
    ]
}



Key

Format

CND

Description

MessageTypean2M

Message type transmitted in the request

Key

Format

CND

Description

TransIDans..64COnly on success: Merchant's transaction number.
POSTerminalIDan..20MTerminalID of the card reader
Statusa..50MOK (URLSuccess) or FAILED (URLFailure). Refers to the inquire request itself.

Key

Format

CND

Description

DMACKSNan..20M

DUKPT Key Serial Number used to generate the DUKPT MAC (parameter DMAC).

DMACan16M

DUKPT Message Authentication Code, which is formed over the entire message (all parameters except DMAC). See chapter "Formation of the DUKPTMAC".

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
Must be sent for SEPAELV transactions.

9F34

CVM Results
Must be sent for SEPAELV transactions.

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;
Reversal of Sales (only possible if settlement has not yet taken place at the acquirer. Otherwise only credit is possible)

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