Introduction and Prerequisites

Use your web-based ERP or shop system to accept card payments in stationery businesses. The communication of your terminals at the point of sale occurs via the Internet directly through and makes traditional interfaces such as OPI or ZVT superfluous.

Process diagram




interface


Calling the interface for POS – Cloud POS Interface

In order to use the Cloud POS Interface, please use the following URL:

catpos.aspx


Key

Format

CND

Description

Beschreibung

MessageType

an2

M

Defines the type of payment:

Supported values are:

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

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
  • A1 - Terminal Startup

CardReadMode

ans..10

C

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

  • msr
    Required for MessageType=0C (CardRead)

Definiert die Technologie, die zum Lesen der Karte verwendet werden soll. Gültige Werte sind

  • msr
    Erforderlich für MessageType=0C (CardRead)

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

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.
Possible values: I or E

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

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 – Cloud POS Interface


(Note: List of parameters in response may differ based on the Cloud POS Interface function called and the final POS transaction result.)

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 device

Code 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 transactions

Maskierte Kontonummer für EC-Transaktionen

additionalresponsedataan..128OAdditional 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 number

Kartenfolgenummer

Brandan..22OBrand: VISA, MasterCard, Maestro, AMEX, DINERS, JCB, CUP

Marke: 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, Capture

Der 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 processed

Vertrags-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 Number

Quittungsnummer

schemeReferenceID / TransactionIDan..22OUnique 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

dccForeignAmountn..10OOnly when DCC was performed

Nur wenn DCC durchgeführt wurde

dccCommissionans..7OOnly when DCC was performed

Nur wenn DCC durchgeführt wurde

dccForeignCurrencyCoden..4OOnly when DCC was performed

Nur wenn DCC durchgeführt wurde

dccDisclaimer (new Param)ans..1024OOnly when DCC was performed

Nur wenn DCC durchgeführt wurde

dccMarginans..5OOnly when DCC was performed

Nur wenn DCC durchgeführt wurde

dccRateValuen..13OOnly when DCC was performed

Nur wenn DCC durchgeführt wurde

dccSourceans..32OOnly when DCC was performed

Nur wenn DCC durchgeführt wurde

dccTimestampans..20OOnly when DCC was performed

Nur wenn DCC durchgeführt wurde

ExpiryDaten..6OYYYYMM. Only when DCC was performed

JJJJMM. Nur wenn DCC durchgeführt wurde

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

PayID of the respective payment completed and linked with this CPI command

PayID der jeweiligen Zahlung, die abgeschlossenen und mit diesem CPI-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

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 – Cloud POS Interface


JSON Object (Receipt)

Please note that the data within this JSON object is encoded using ISO-8859-1 in contrast to the standard encoding of JSON objects with UTF-8 and then must be also Base64 encoded. This applies in particular to special characters such as "Umlaute" and diactrics.

"receipt"

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
}