POS - Computop Cloud POS Interface (CPI)

Format

Beschreibung

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ürzung

Beschreibung

Kommentar

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

MerchantID

ans..30

M

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

MessageType

an2

M

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

• 1A – Terminal Startup

• Startup is an initial operation command. The command performs an entire initial operation containing a sequence of authorization protocol specific messages. Function is usually used in the start-up phase of a terminal, but can be invoked at any time. Function is used for diagnosis and update terminals remotely.

CardReadMode

ans..10

C

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)

TransID

ans..64

M

Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

RefNr

ans..21

O

Händler-Referenznummer

POSTerminalID

an..20

M

TerminalID des PIN-Eingabegeräts

Printer

an1

M

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)

Amount

n..10

M

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.

Currency

a3

M

Währung, drei Zeichen DIN / ISO 4217, z.B. EUR, USD, GBP. Hier eine Übersicht: A1 Währungstabelle

ReqId

ans..32

O

Um Doppelzahlungen (z.B. durch ETM) zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion oder Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder Aktion mit derselben ReqID erneut eingereicht wird, führt das Computop Paygate keine Zahlung oder weitere Aktion aus, sondern gibt nur den Status der ursprünglichen Transaktion oder Aktion zurück.

Bitte beachten Sie, dass das Computop Paygate für die erste initiale Aktion (Authentifizierung/Autorisierung) einen abgeschlossenen Transaktionsstatus haben muss. Dies gilt nicht für 3-D Secure Authentifizierungen, die durch einem Timeout beendet werden. Der Status 3-D Secure Timeout gilt nicht als abgeschlossener Status, bei dem ReqID-Funktionalität am Paygate nicht greift. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Hinweis: Bitte beachten Sie, dass eine ReqID nur 12 Monate gültig ist, danach wird sie vom Paygate gelöscht.

localDate

n8

M

Transaktionsdatum: JJJJMMTT

localTime

n6

M

Transaktionszeit: hhmmss

TraceNr

ans8

C

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

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-Protokoll-spezifisch – COF: RTF-Parameter.Mögliche Werte: I oder E

ContractID

n..12

O

Spezielle Händler-ID beim Acquirer, um die Standard-Händler-ID außer Kraft zu setzen

mid

ans..30

M

HändlerID, die von Computop vergeben wird

TransID

ans..64

M

Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Status

a..50

M

OK (URLSuccess) oder FAILED (URLFailure)

RefNr

ans..21

O

Händler-Referenznummer

Description

ans..1024

M

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 vom POS-Server oder POS-Gerät

MaskedPAN

an12..19

C

Maskierte Kartennummer (6X4).

Nur bei erfolgreichen Kreditkarten-Transaktionen.

BankAccount

an64

C

Maskierte Kontonummer für EC-Transaktionen

additionalresponsedata

an..128

O

Zusätzlicher Text, den das Verarbeitungssystem des Betreibers optional als Antwort auf Zahlungs-/Umstellungsanforderungen senden kann.

Approvalcode

ans6

C

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

Kartenfolgenummer

Brand

an..22

O

Marke: VISA, MasterCard, Maestro, AMEX, DINERS, JCB, CUP

CodeExt

n3

C

Antwortcode vom Autorisierungs-Host der Finanztransaktion (Zahlung)

TraceNr

ans8

C

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

Vertrags-ID-Nummer des Acquirers, bei dem die Transaktion verarbeitet wurde

Receipt

object

C

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

Quittungsnummer

schemeReferenceID / TransactionID

an..22

O

Eindeutige Transaktionskennung, die von Schemes/Issuern bereitgestellt wird, um die Transaktion in MIT- oder COF-Szenarien zu referenzieren

dccForeignAmount

n..10

O

Nur wenn DCC durchgeführt wurde

dccCommission

ans..7

O

Nur wenn DCC durchgeführt wurde

dccForeignCurrencyCode

n..4

O

Nur wenn DCC durchgeführt wurde

dccDisclaimer (new Param)

ans..1024

O

Nur wenn DCC durchgeführt wurde

dccMargin

ans..5

O

Nur wenn DCC durchgeführt wurde

dccRateValue

n..13

O

Nur wenn DCC durchgeführt wurde

dccSource

ans..32

O

Nur wenn DCC durchgeführt wurde

dccTimestamp

ans..20

O

Nur wenn DCC durchgeführt wurde

ExpiryDate

n..6

O

JJJJMM

PCNr

n16

O

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 vom Computop Paygate und kann ebenfalls als CCNr im Request oder als Teil von card-JSON verwendet werden.

VerificationCode

an..40

O

Verwendeter Authentifizierungsmodus. Mögliche Werte:

• Signature

• PIN

• On consumer device

• NoAuth

PayID

an..32

O

Computop PayID der jeweiligen Zahlung, die abgeschlossenen und mit diesem Cat-Befehl verknüpft ist

aidParameters

ans..1024

O

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

Transaktionsdatum: JJJJMMTT

localTime

n..6

O

Transaktionszeit: hhmmss

RTF

a1

O

Echo vom Aufrufparameter

ContractID

n..12

O

Echo vom Aufrufparameter

POSTerminalId

an..20

O

Echo vom Aufrufparameter

TerminalID

an..12

O

Terminal-ID, die an den Acquirer-Autoriserungshost weitergeleitet wird

receiptCopies

integer

O

Anzahl der zu druckenden Quittungskopien

receiptCustomer

string

O

Kundenquittungsdaten

receiptMerchant

string

O

Händlerquittungsdaten

receiptNumber

integer

O

Quittungsnummer