Introduction and Prerequisites


Process diagram





Cockpit interface


Definitions

Data formats

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)


Abbreviations

Abbreviation

Description

Comment

CND

condition


M

mandatory

If a parameter is mandatory, then it must be present

O

optional

If a parameter is optional, then it can be present, but it is not required

C

conditional

If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional


Notice: Please note that the names of parameters can be returned in upper or lower case.




Calling the interface for POS - Pay-Jet Cloud POS Interface

Notice: For security reasons, Pay-Jet Cockpit 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 ...

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

MerchantID, assigned by Pay-Jet. Additionally this parameter has to be passed in plain language too.

HändlerID, die von Pay-Jet 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
  • 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

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..21OA merchant reference number. Max. length: 21 characters. Händler Referenznummern. Max. Länge: 21 Zeichen.
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 Pay-Jet Support, 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 Pay-Jet Support, 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 EN

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.

Parameters for payments with POS - Pay-Jet Cloud POS Interface




The following table describes the result parameters with which the Pay-Jet Cockpit responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

(Note: List of parameters in response may differ based on the Pay-Jet 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 ...

KeyFormatCNDDescriptionBeschreibung

MID

ans..30

M

MerchantID, assigned by Pay-Jet

HändlerID, die von Pay-Jet 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

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.

Result parameters for payments with POS - Pay-Jet 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
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
}