Introduction and Prerequisites

Calling the interface for POS - Cloud POS Interface

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
08 - Capture
0D - Diagnose

Definiert die Art der Zahlung:

Unterstützte Werte sind:

01 - Verkauf (Sale)
02 - Storno
03 - Gutschrift
05 - Autorisierung/Reservierung
08 - Buchung
0D - Diagnose

Key

Format

CND

Description

Beschreibung

RefNr

ans..21

O

A merchant reference number. Max. length: 21 characters.

Händler Referenznummern. Max. Länge: 21 Zeichen.

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.

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

Result parameters for payments with POS - Cloud POS Interface

JSON Object (Receipt)

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

Introduction and Prerequisites

Process diagram

interface

Calling the interface for POS - Cloud POS Interface

JSON Object (Receipt)

"receipt"

JSON Schema