- Created by Admin, last modified on 02. Apr 2024
Introduction and Prerequisites
Process diagram
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
Calling the interface for POS – Computop Cloud POS Interface
In order to use the Cloud POS Interface, please use the following URL:
https://www.computop-paygate.com/catpos.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:
Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.
The table is being loaded. Please wait for a bit ...
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
MessageType | an2 | M | Defines the type of payment: Supported values are:
| Definiert die Art der Zahlung: Unterstützte Werte sind:
|
CardReadMode | ans..10 | C | Defines the technology to be used to read the card. Valid values are
| Definiert die Technologie, die zum Lesen der Karte verwendet werden soll. Gültige Werte sind
|
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment | Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
RefNr | ans..21 | O | Merchant reference number | Händler-Referenznummer |
POSTerminalID | an..20 | M | TerminalID of pin entry device | TerminalID des PIN-Eingabegeräts |
Printer | an1 | M | Possible values that the merchant POS application can send are: 1 - Printer is ready 0 - Printer is not ready Should be populated with 1 (further clarifications are in progress for usage of value 0) | Mögliche Werte, welche die POS-Anwendung des Händlers senden kann: 1 - Drucker ist bereit 0 - Drucker ist nicht bereit Sollte mit 1 ausgefüllt werden (Weitere Abklärungen zur Verwendung des Wertes 0 sind in Arbeit) |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
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). | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent). Bitte wenden Sie sich an den Computop Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
Currency | a3 | M | Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table | Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
localDate | n8 | M | Transaction date: YYYYMMDD | Transaktionsdatum: JJJJMMTT |
localTime | n6 | M | Transaction time: hhmmss | Transaktionszeit: hhmmss |
TraceNr | ans8 | C | Mandatory for subsequent functions Reversal or Capture (MessageType=02/08). It must be equal to the value TraceNr received from the original authorization response. Merchant POS system must provide this in the request. | Pflicht für Folgefunktionen Storno oder Buchung (MessageType=02/08). Muss gleich dem Wert TraceNr sein, der von der ursprünglichen Autorisierungsantwort empfangen wurde. Das POS-System des Händlers muss dies in der Anfrage übermitteln. |
AppCode | ans6 | C | Mandatory for subsequent function Capture (MessageType=08). It must be equal to the value Approvalcode received from the original authorization response. Merchant POS system must provide this in the request. | Pflicht für Folgefunktion Buchung (MessageType=08). Muss gleich dem Wert Approvalcode sein, der von der ursprünglichen Autorisierungsantwort empfangen wurde. Das POS-System des Händlers muss dies in der Anfrage übermitteln. |
RTF | a1 | O | Host protocol specific – COF: RTF parameter. | Host-Protokoll-spezifisch – COF: RTF-Parameter. |
ContractID | n..12 | O | Special merchant ID at the acquirer to overrule the default merchant ID | Spezielle Händler-ID beim Acquirer, um die Standard-Händler-ID außer Kraft zu setzen |
Parameters for payments with POS – Computop Cloud POS Interface
The following table describes the result parameters with which the Computop Paygate responds to your system pls. be prepared to receive additional parameters at any time and do not check the order of parameters the key (e.g. MerchantId, RefNr) should not be checked case-sentive
(Note: List of parameters in response may differ based on the Computop Cloud POS Interface function called and the final POS transaction result.)
Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.
The table is being loaded. Please wait for a bit ...
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
ans..30 | M | MerchantID, assigned by Computop | HändlerID, die von Computop vergeben wird |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
TransID | ans..64 | M | TransactionID provided by you which should be unique for each payment | Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
Status | a..50 | M | OK (URLSuccess) or FAILED (URLFailure) | OK (URLSuccess) oder FAILED (URLFailure) |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
RefNr | ans..21 | O | Merchant reference number | Händler-Referenznummer |
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the CATCode parameter for the transaction status analysis! | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern CATCode für die Auswertung des Transaktionsstatus! |
CATCode | ans3 | M | Code from the POS Server or POS device | Code vom POS-Server oder POS-Gerät |
MaskedPAN | an12..19 | C | Masked card number (6X4). Only in case of successful credit card transactions. | Maskierte Kartennummer (6X4). Nur bei erfolgreichen Kreditkarten-Transaktionen. |
BankAccount | an64 | C | Masked Bank account number for EC transactions | Maskierte Kontonummer für EC-Transaktionen |
additionalresponsedata | an..128 | O | Additional text which the operator’s processing system can send optionally in replies to payment/cutover requests. | Zusätzlicher Text, den das Verarbeitungssystem des Betreibers optional als Antwort auf Zahlungs-/Umstellungsanforderungen senden kann. |
Approvalcode | ans6 | C | Approval code from authorization host in the response message to the client. Only in case of successful credit card transactions. Merchant must save this value form the response and use it when referencing Capture subsequent action. | Genehmigungscode vom Autorisierungshost in der Antwortnachricht an den Client. Nur bei erfolgreichen Kreditkarten-Transaktionen. Der Händler muss diesen Wert aus der Antwort speichern und ihn verwenden, wenn er in der Folgeaktion Buchung darauf verweist. |
CCSeqNr | n3 | O | Card sequence number | Kartenfolgenummer |
Brand | an..22 | O | Brand: VISA, MasterCard, Maestro, AMEX, DINERS, JCB, CUP | Marke: VISA, MasterCard, Maestro, AMEX, DINERS, JCB, CUP |
CodeExt | n3 | C | Financial transaction Authorization Host response code (Payment). | Antwortcode vom Autorisierungs-Host der Finanztransaktion (Zahlung) |
TraceNr | ans8 | C | Merchant must save this value form the response and use it when referencing subsequent actions i.e Reverse, Capture | Der Händler muss diesen Wert aus der Antwort speichern und ihn verwenden, wenn er in Folgetransaktionen darauf verweist, z.B. Storno, Buchung |
VUNr | n8 | O | Acquirer Contract ID number on which the transaction was processed | Vertrags-ID-Nummer des Acquirers, bei dem die Transaktion verarbeitet wurde |
Receipt | object | C | Receipt content for the Merchant and the cardholder. The information should be than used from Merchant Printer system to print out the respective receipts. | Quittungsinhalt für den Händler und den Karteninhaber. Die Informationen sollten dann vom Drucksystem des Händlers verwendet werden, um die entsprechenden Quittungen auszudrucken. |
ReceiptNr | an..10 | O | Receipt Number | Quittungsnummer |
schemeReferenceID / TransactionID | an..22 | O | Unique transaction identifier provided by Schemes/Issuer to reference the transaction in MIT or COF scenarios | Eindeutige Transaktionskennung, die von Schemes/Issuern bereitgestellt wird, um die Transaktion in MIT- oder COF-Szenarien zu referenzieren |
dccForeignAmount | n..10 | O | Only when DCC was performed | Nur wenn DCC durchgeführt wurde |
dccCommission | ans..7 | O | Only when DCC was performed | Nur wenn DCC durchgeführt wurde |
dccForeignCurrencyCode | n..4 | O | Only when DCC was performed | Nur wenn DCC durchgeführt wurde |
dccDisclaimer (new Param) | ans..1024 | O | Only when DCC was performed | Nur wenn DCC durchgeführt wurde |
dccMargin | ans..5 | O | Only when DCC was performed | Nur wenn DCC durchgeführt wurde |
dccRateValue | n..13 | O | Only when DCC was performed | Nur wenn DCC durchgeführt wurde |
dccSource | ans..32 | O | Only when DCC was performed | Nur wenn DCC durchgeführt wurde |
dccTimestamp | ans..20 | O | Only when DCC was performed | Nur wenn DCC durchgeführt wurde |
ExpiryDate | n..6 | O | YYYYMM | JJJJMM |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
PCNr | n16 | O | Pseudo Card Number: Random number generated by Computop Paygate which represents a genuine credit card number. The pseudo card number (PCN) starts with 0 and the last 3 digits correspond to those of the real card number. The PCN can be used like a genuine card number for authorisation, capture and credits. PCNr is a response value from Computop Paygate and is sent as CCNr in Request or part of card-JSON | Pseudo Card Number: Vom Computop Paygate generierte Zufallszahl, die eine reale Kreditkartennummer repräsentiert. Die Pseudokartennummer (PKN) beginnt mit 0, und die letzten 3 Stellen entsprechen denen der realen Kartennummer. Die PKN kann wie eine Kreditkartennummer für Autorisierung, Buchung und Gutschriften verwendet werden. PCNr ist ein Antwortwert von Computop Paygate und kann ebenfalls als CCNr im Request oder als Teil von card-JSON verwendet werden. |
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
VerificationCode | an..40 | O | Used authentication mode. Possible values:
| Verwendeter Authentifizierungsmodus. Mögliche Werte:
|
PayID | an..32 | O | Computop PayID of the respective payment completed and linked with this cat command | Computop PayID der jeweiligen Zahlung, die abgeschlossenen und mit diesem Cat-Befehl verknüpft ist |
aidParameters | ans..1024 | O | Authorisation parameters: if these are present, the authorisation parameters must be printed out on the terminal receipt in unpacked form as 10 hexadecimal numbers. Aid-parameters can contain up to 130 characters for electronic cash payments. | Autorisierungsparameter: Sofern diese vorhanden sind, müssen die Autorisierungsparameter auf dem Kassenbon unverschlüsselt als 10 Hexadezimalzahlen ausgedruckt werden. Bei elektronischen Barzahlungen können die Hilfsparameter bis zu 130 Zeichen lang sein. |
localDate | n..8 | O | Transaction date: YYYYMMDD | Transaktionsdatum: JJJJMMTT |
localTime | n..6 | O | Transaction time: hhmmss | Transaktionszeit: hhmmss |
VuNr | n..12 | O | Acquirer MerchantID which is forwarded to the authorization host | Acquirer MerchantID, die an den Autorisierungshost weitergeleitet wird |
RTF | a1 | O | Echoed from the request parameter | Echo vom Aufrufparameter |
ContractID | n..12 | O | Echoed from the request parameter | Echo vom Aufrufparameter |
POSTerminalId | an..20 | O | Echoed from the request parameter | Echo vom Aufrufparameter |
TerminalID | an..12 | O | Terminal ID which is forwarded towards acquirer authorization host | Terminal-ID, die an den Acquirer-Autoriserungshost weitergeleitet wird |
Result parameters for payments with POS – Computop Cloud POS Interface
JSON Object (Receipt)
"receipt"
Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.
The table is being loaded. Please wait for a bit ...
Key | Format | CND | Description | Beschreibung |
---|---|---|---|---|
receiptCopies | integer | O | Number of receipt copies to be printed | Anzahl der zu druckenden Quittungskopien |
receiptCustomer | string | O | Customer receipt data | Kundenquittungsdaten |
receiptMerchant | string | O | Merchant receipt data | Händlerquittungsdaten |
receiptNumber | integer | O | Receipt number | Quittungsnummer |
JSON Schema
{ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "http://json-schema.org/draft-07/schema#", "title": "receipt", "description": "Data containing the receipt information which can be printed out by the merchant system", "type": "object", "properties": { "receiptMerchant": { "type": "string", "description": "Merchant Receipt data" }, "receiptCustomer": { "type": "string", "description": "Customer Receipt data" }, "receiptCopies": { "type": "integer", "description": "Number of receipt copies to be printed" }, "receiptNumber": { "type": "integer", "description": "Receipt Number " }, }, "additionalProperties": false }