Einleitung und Voraussetzungen


Prozessdiagramm



Paygate-Schnittstelle

Definitionen

Datenformate:

FormatBeschreibung

a

alphabetisch

as

alphabetisch mit Sonderzeichen

n

numerisch

an

alphanumerisch

ans

alphanumerisch mit Sonderzeichen

ns

numerisch mit Sonderzeichen

bool

Bool’scher Ausdruck (true oder false)

3

feste Länge mit 3 Stellen/Zeichen

..3

variable Länge mit maximal 3 Stellen/Zeichen

enum

Aufzählung erlaubter Werte

dttm

ISODateTime (JJJJ-MM-TTThh:mm:ss)


Abkürzungen:

AbkürzungBeschreibungKommentar

CND

Bedingung (condition)


M

Pflicht (mandatory)

Wenn ein Parameter Pflicht ist, dann muss er vorhanden sein

O

optional

Wenn ein Parameter optional ist, dann kann er vorhanden sein, ist aber nicht erforderlich

C

bedingt (conditional)

Wenn ein Parameter bedingt ist, dann gibt es eine Bedingungsregel, die angibt, ob er Pflicht oder optional ist


Hinweis: Bitte beachten Sie, dass die Bezeichnungen der Parameter in Groß- oder Kleinbuchstaben zurückgegeben werden können.


Aufruf der Schnittstelle für POS Computop Cloud POS Interface

Um das Cloud POS Interface zu nutzen, verwenden Sie bitte die folgende URL:


Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

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

KeyFormatCNDDescriptionBeschreibung

MerchantID

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

MessageTypean2M

Defines the type of payment:

Supported values are:

  • 01 - Sale
  • 02 - Reverse
  • 03 - Credit
  • 05 - Authorization/Reservation
  • 0B - Capture
  • 0C - Card Read
  • 0D - Diagnose

Definiert die Art der Zahlung:

Unterstützte Werte sind:

  • 01 - Verkauf (Sale)
  • 02 - Storno
  • 03 - Gutschrift
  • 05 - Autorisierung/Reservierung
  • 0B - Buchung
  • 0C - Karte lesen
  • 0D - Diagnose
CardReadModeans..10C

Defines the technology to be used to read the card. Valid values are

  • msr
  • icc
  • manual
  • ctl
    Required for MessageType=0C (CardRead)
Definiert die Technologie, die zum Lesen der Karte verwendet werden soll. Gültige Werte sind
  • msr
  • icc
  • manual
  • ctl
    Erforderlich für MessageType=0C (CardRead)

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Key

Format

CND

Description

Beschreibung

RefNrans..21OMerchant reference numberHändler-Referenznummer
POSTerminalIDan..20MTerminalID of pin entry deviceTerminalID des PIN-Eingabegeräts
Printeran1M

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)

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

KeyFormatCNDDescriptionBeschreibung
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

localDaten8MTransaction date: YYYYMMDDTransaktionsdatum: JJJJMMTT
localTimen6MTransaction time: hhmmss
Transaktionszeit: hhmmss
TraceNrans8C

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.

AppCodeans6C

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.

RTFa1O

Host protocol specific COF: RTF parameter.
Possible values: I or E

Host-Protokoll-spezifisch COF: RTF-Parameter.
Mögliche Werte: I oder E

ContractIDn..12O

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

Parameter für Zahlungen mit POS Computop Cloud POS Interface


Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt:

(info) es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

(info) die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

(Hinweis: Die Liste der Antwortparameter kann je nach aufgerufener Computop Cloud POS Interface und dem endgültigen POS-Transaktionsergebnis abweichen.)

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

KeyFormatCNDDescriptionBeschreibung

mid

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyFormatCNDDescriptionBeschreibung
TransID

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

KeyFormatCNDDescriptionBeschreibung
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!
CATCodeans3MCode from the POS Server or POS deviceCode vom POS-Server oder POS-Gerät
MaskedPANan12..19C

Masked card number (6X4).

Only in case of successful credit card transactions.

Maskierte Kartennummer (6X4).

Nur bei erfolgreichen Kreditkarten-Transaktionen.

BankAccountan64CMasked Bank account number for EC transactionsMaskierte Kontonummer für EC-Transaktionen
AdditionalResponseDataans..1024OAdditional 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.
Approvalcodeans6C

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.

CCSeqNrn3OCard sequence numberKartenfolgenummer
Brandan..22OBrand: VISA, MasterCard, Maestro, AMEX, DINERS, JCB, CUPMarke: VISA, MasterCard, Maestro, AMEX, DINERS, JCB, CUP
CodeExtn3CFinancial transaction Authorization Host response code (Payment).Antwortcode vom Autorisierungs-Host der Finanztransaktion (Zahlung)
TraceNrans8CMerchant must save this value form the response and use it when referencing subsequent actions i.e Reverse, CaptureDer Händler muss diesen Wert aus der Antwort speichern und ihn verwenden, wenn er in Folgetransaktionen darauf verweist, z.B. Storno, Buchung
VUNrn8OAcquirer Contract ID number on which the transaction was processedVertrags-ID-Nummer des Acquirers, bei dem die Transaktion verarbeitet wurde
ReceiptobjectCReceipt 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.
ReceiptNran..10OReceipt NumberQuittungsnummer
schemeReferenceID / TransactionIDan..22OUnique transaction identifier provided by Schemes/Issuer to reference the transaction in MIT or COF scenariosEindeutige Transaktionskennung, die von Schemes/Issuern bereitgestellt wird, um die Transaktion in MIT- oder COF-Szenarien zu referenzieren
dccForeignAmountn..10OOnly when DCC was performedNur wenn DCC durchgeführt wurde
dccCommissionans..7OOnly when DCC was performedNur wenn DCC durchgeführt wurde
dccForeignCurrencyCoden..4OOnly when DCC was performedNur wenn DCC durchgeführt wurde
dccDisclaimer (new Param)ans..1024OOnly when DCC was performedNur wenn DCC durchgeführt wurde
dccMarginans..5OOnly when DCC was performedNur wenn DCC durchgeführt wurde
dccRateValuen..13OOnly when DCC was performedNur wenn DCC durchgeführt wurde
dccSourceans..32OOnly when DCC was performedNur wenn DCC durchgeführt wurde
dccTimestampans..20OOnly when DCC was performedNur wenn DCC durchgeführt wurde
ExpiryDaten..6OYYYYMMJJJJMM

KeyFormatCNDDescriptionBeschreibung
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:
  • Signature
  • PIN
  • On consumer device
  • NoAuth
Verwendeter Authentifizierungsmodus. Mögliche Werte:
  • Signature
  • PIN
  • On consumer device
  • NoAuth
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

Ergebnisparameter für Zahlungen mit POS Computop Cloud POS Interface


JSON-Objekt (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
receiptCopiesintegerONumber of receipt copies to be printedAnzahl der zu druckenden Quittungskopien
receiptCustomerstringOCustomer receipt dataKundenquittungsdaten
receiptMerchantstringOMerchant receipt dataHändlerquittungsdaten
receiptNumberintegerOReceipt numberQuittungsnummer

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
}