Capture / Credit / Reversal

Capture

Captures are possible via a Server-to-Server connection. To perform a capture via a Server-to-Server connection please use the following URL:


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.

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:


KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Cockpit for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Cockpit vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

Key

Format

CND

Description

Beschreibung

TransID

ans..64

M

TransactionID which should be unique for each payment

Please note for some connections the different formats that are given within the specific parameters.

TransaktionsID, die für jede Zahlung eindeutig sein muss

Bitte beachten Sie bei einigen Anbindungen die abweichenden Formate, die bei den spezifischen Parametern angegeben sind.

RefNrns..30C

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Pay-Jet settlement file (CTSF) we cannot add the additional payment data.

(not with EVO Payments, for CardComplete in the format an..25, for Cofidis in the format n..15, for Omnipay in the format ns..15, for RBI in the format ns..20)

The page DE:Reuse API was not found  -- Please check/update the page name used in the MultiExcerpt-Include macro

(nicht bei EVO Payments, bei CardComplete im Format an..25, bei Cofidis im Format n..15, bei Omnipay im Format ns..15, bei RBI im Format ns..20)

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / action is submitted again with the same ReqID, Pay-Jet Cockpit will not carry out the payment or new action, but will just return the status of the original transaction / action. Please note that the Pay-Jet Cockpit must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion / Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder auch jede Aktion mit derselben ReqID erneut eingereicht wird, führt das Pay-Jet Cockpit keine Zahlung / weitere Aktion aus sondern gibt nur den Status der ursprünglichen Transaktion / Aktion zurück. Bitte beachten Sie, dass das Pay-Jet Cockpit für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Key

Format

CND

Description

Beschreibung

FinishAuth

a1

C

Only with ETM: Transmit value <Y> in order to stop the renewal of guaranteed authorisations and rest amounts after partial captures. Please use this parameter only if you are using the additional function ETM (Extended Transactions Managament). (not with Clearhaus)

Nur bei ETM: Übergeben Sie den Wert <Y>, um bei Teilbuchungen die Autorisierungserneuerung oder die Reservierung des Restbetrages zu stoppen. Bitte nutzen Sie den Parameter nur, wenn Sie die Zusatzfunktion ETM (Erweitertes Transaktions-Managament) nutzen. (Nicht bei Clearhaus)

Textfeld1

ans..30

O

Card holder information: Name (not with Clearhaus)

Karteninhaber-Information: Name (Nicht bei Clearhaus)

Textfeld2

ans..30

O

Card holder information: City (not with Clearhaus)

Karteninhaber-Information: Ort (Nicht bei Clearhaus)

CHDesc

ans..22

OC

Only with Clearhaus: Text printed on the customer’s credit card bill. Only printable ASCII characters from 0x20 to 0x7E

Nur bei Clearhaus: Text, der auf der Kreditkartenabrechnung angezeigt wird. Nur ASCII druckbare Zeichen von 0x20 bis 0x7E

Parameters for captures of credit card payments


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

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
PayID

an32

M

ID assigned by Cockpit for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Cockpit vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Cockpit

Vom Cockpit vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

Error code according to Cockpit Response Codes (A4 Error codes)

Fehlercode gemäß Cockpit Antwort-Codes (A4 Fehlercodes)

KeyFormatCNDDescriptionBeschreibung
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

Key

Format

CND

Description

Beschreibung

TransID

ans..64

M

Merchant’s transaction number.

Please note for some connections the different formats that are given within the specific parameters.

Transaktionsnummer des Händlers.

Bitte beachten Sie bei einigen Anbindungen die abweichenden Formate, die bei den spezifischen Parametern angegeben sind.

Status

a..50

M

OK or FAILED

OK oder FAILED

RefNr

ns..30

C

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Pay-Jet settlement file (CTSF) we cannot add the additional payment data.

(not with EVO Payments, for Card Complete in the format an..25, for Omnipay in the format ns..15, for RBI in the format ns..20)

The page DE:Reuse API was not found  -- Please check/update the page name used in the MultiExcerpt-Include macro

(nicht bei EVO Payments, bei Card Complete im Format an..25, bei Omnipay im Format ns..15, bei RBI im Format ns..20)

Aid

n6

OC

Only in the case of Card Complete: Authorisation ID returned by Card Complete

Nur bei Card Complete: von Card Complete zurückgegebene Autorisierungs-ID

Amount

n..10

OC

Only with Clearhaus: Amount in the smallest currency unit (e.g. EUR Cent)

If the actual amount differs from the requested amount this will be returned.

Only with MasaPay: The amount has to be equal to the originally authorised amount.

Nur bei Clearhaus: Betrag in der kleinsten Währungseinheit (z.B. EUR Cent)

Sollte der tatsächliche Betrag vom angefragten Betrag abweichen, wird dieser zurückgegeben.

Nur bei MasaPay: Betrag muss gleich dem ursprünglich autorisierten Betrag sein.

CodeExt

n5

OC

Only with Clearhaus: Only if configured: External error code (downstream system).

Only with MasaPay: Format ans..10, error code from MasaPay.

Nur bei Clearhaus: Nur wenn konfiguriert: externer Fehlercode (nachgelagertes System).

Nur bei MasaPay: Format ans..10, Fehlercode von MasaPay.

ErrorText

ans.128

OC

Only with Clearhaus: Detailed Clearhaus error message.

Only with MasaPay: Format ans..128, detailed MasaPay error message.

Is returned only if Status=FAILED. Use is possible only in agreement with Pay-Jet Support

Nur bei Clearhaus: Detaillierte Clearhaus Fehlermeldung.

Nur bei MasaPay: Format ans..128, Detaillierte MasaPay Fehlermeldung.

Wird nur bei Status=FAILED zurückgegeben. Nutzung nur in Abstimmung mit  Pay-Jet Support möglich.

TransactionID

ans36

OC

Only with Clearhaus: Transaction number from Clearhaus

Nur bei Clearhaus: Transaktionsnummer von Clearhaus

GuWID

ans..22

O

Only with Wirecard: TransactionID of the Acquiring Bank

Nur bei Wirecard: TransaktionsID des Acquirers

TIDn..15MOnly with Cofidis: If RefNr was submitted, it's value will be returned. Otherwise the first 15 digits of TransactionID will be returned.Nur bei Cofidis: Wenn RefNr übergeben wurde, wird dieser Wert zurückgegeben. Anderenfalls werden die ersten 15 Stellen der TransactionID zurückgegeben.

Response parameters for captures of credit card payments



Credit with reference

Credits (refunds) are possible via a Server-to-Server connection. Cockpit permits credits which relate to a capture previously activated by Cockpit and allows merchants to carry out credits without a reference transaction. This section describes the processing of credits with reference transactions. If you refer to a capture for a Credit, the amount of the Credit is limited to the amount of the previous capture.

To carry out a credit with a reference transaction, please use the following URL:


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.

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:


KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Cockpit for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Cockpit vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

Key

Format

CND

Description

Beschreibung

TransID

ans..64

M

TransactionID which should be unique for each payment

Please note for some connections the different formats that are given within the specific parameters.

TransaktionsID, die für jede Zahlung eindeutig sein muss

Bitte beachten Sie bei einigen Anbindungen die abweichenden Formate, die bei den spezifischen Parametern angegeben sind.

RefNrns..30C

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Pay-Jet settlement file (CTSF) we cannot add the additional payment data.

(not with EVO Payments, Only for CardComplete, for Clearhaus (ns..30, optional, only printable ASCII characters from 0x20 to 0x7E), for RBI (ns..20, optional), for MasaPay (ns..30, optional), for Cofidis (n..15, optional).)

The page DE:Reuse API was not found  -- Please check/update the page name used in the MultiExcerpt-Include macro

(nicht bei EVO Payments, Nur bei CardComplete, bei Clearhaus (ns..30, optional, nur ASCII druckbare Zeichen von 0x20 bis 0x7E), bei RBI (ns..20, optional), bei MasaPay (ns..30, optional), bei Cofidis (n..15, optional))

OrderDescans..768ODescription of refunded goods, unit prices, merchant’s comment etc. (not with Clearhaus)Beschreibung der gutgeschriebenen Artikel, Einzelpreise, Händlerkommentar etc. (Nicht bei Clearhaus)

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / action is submitted again with the same ReqID, Pay-Jet Cockpit will not carry out the payment or new action, but will just return the status of the original transaction / action. Please note that the Pay-Jet Cockpit must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion / Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder auch jede Aktion mit derselben ReqID erneut eingereicht wird, führt das Pay-Jet Cockpit keine Zahlung / weitere Aktion aus sondern gibt nur den Status der ursprünglichen Transaktion / Aktion zurück. Bitte beachten Sie, dass das Pay-Jet Cockpit für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Key

Format

CND

Description

Beschreibung

Textfeld1

ans..30

O

Card holder information: Name (not with Clearhaus)

Karteninhaber-Information: Name (Nicht bei Clearhaus)

Textfeld2

ans..30

O

Card holder information: City (not with Clearhaus)

Karteninhaber-Information: Ort (Nicht bei Clearhaus)

CHDesc

ans..22

OC

Only with Clearhaus: Text printed on the customer’s credit card bill. Only printable ASCII characters from 0x20 to 0x7E

Nur bei Clearhaus: Text, der auf der Kreditkartenabrechnung angezeigt wird. Nur ASCII druckbare Zeichen von 0x20 bis 0x7E
TIDans..30OCOnly with SafeCharge: TransaktioncID of the capture to be credited, if the merchants wants to credit a specifc capture. If the parameter is nut submitted the last capture will be credited.Nur bei SafeCharge: TransaktionsID der gutzuschreibenden Buchung, falls der Händler eine bestimmte Buchung gutschreiben möchte. Wenn der Parameter nicht angegeben ist, wird die letzte Buchung gutgeschrieben.



Additional parameters for Wirecard connection (for Visa Direct)Zusätzliche Parameter bei Anbindung Wirecard (für Visa Direct)
refundTypeenumCType of refund. Possible values: “p2p”, “md”, “acc2acc”. “ccBill”, “fd”Art der Gutschrift. Mögliche Werte: “p2p”, “md”, “acc2acc”. “ccBill”, “fd”
receiverFirstNamean..12CFirst name of the receiver. Mandatory for cross-border transactions.Vorname des Empfängers. Pflicht bei grenzüberschreitenden Transaktionen.
receiverLastNamean..12CLast name of the receiver. Mandatory for cross-border transactions.Nachname des Empfängers. Pflicht bei grenzüberschreitenden Transaktionen.
senderAccountNumbern..12C

Account number of the sender.

Mastercard: Mandatory. Visa: Mandatory, if RefNr is empty.

Kontonnummer des Senders.

Mastercard: Pflicht. Visa: Pflicht, wenn die RefNr leer ist.

senderFirstNamean..12C

First name of the sender.

Mastercard: Mandatory. Visa: Mandatory for US domestic transactions and cross-border money transfers.

Vorname des Senders.

Mastercard: Pflicht. Visa: Pflicht für US-Inlandstransaktionen und grenzüberschreitende Zahlungen.

senderLastNamean..12C

Last name of the sender.

Mastercard: Mandatory. Visa: Optional.

Nachname des Senders.

Mastercard: Pflicht. Visa: Optional.

senderAddrStreetan..25C

Street name of the sender.

Mastercard: Optional. Visa: Mandatory for US domestic transactions and cross-border money transfers.

Straßenname des Senders.

Mastercard: Optional. Visa: Pflicht für US-Inlandstransaktionen und grenzüberschreitende Zahlungen.

senderAddrStreetNran..25C

Street number of the sender.

Mastercard: Optional. Visa: Mandatory for US domestic transactions and cross-border money transfers.

Haunsummer des Senders.

Mastercard: Optional. Visa: Pflicht für US-Inlandstransaktionen und grenzüberschreitende Zahlungen.

senderAddrCityan..32C

Town/city of the sender.

Mastercard: Optional. Visa: Mandatory for US domestic transactions and cross-border money transfers.

Ort des Senders.

Mastercard: Optional. Visa: Pflicht für US-Inlandstransaktionen und grenzüberschreitende Zahlungen.

senderAddrStatea2C

State of the sender.

Mastercard: Mandatory, if senderAddrCountry=US or Canada. Visa: Mandatory for US domestic transactions and cross-border money transfers.

Bundesland des Senders.

Mastercard: Pflicht, wenn senderAddrCountry=US oder Canada. Visa: Pflicht für US-Inlandstransaktionen und grenzüberschreitende Zahlungen.

senderAddrCountrya2C

Country of the sender.

Mastercard: Optional. Visa: Mandatory if country is US and for cross-border money transfers.

Land des Senders.

Mastercard: Optional. Visa: Pflicht, wenn das Land US ist, und bei grenzüberschreitende Zahlungen.

Parameters for credits of credit card payments


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

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
PayID

an32

M

ID assigned by Cockpit for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Cockpit vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Cockpit

Vom Cockpit vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

Error code according to Cockpit Response Codes (A4 Error codes)

Fehlercode gemäß Cockpit Antwort-Codes (A4 Fehlercodes)

KeyFormatCNDDescriptionBeschreibung
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

Key

Format

CND

Description

Beschreibung

TransID

ans..64

M

Merchant’s transaction number.

Please note for some connections the different formats that are given within the specific parameters.

Transaktionsnummer des Händlers.

Bitte beachten Sie bei einigen Anbindungen die abweichenden Formate, die bei den spezifischen Parametern angegeben sind.

Status

a..50

M

OK or FAILED

OK oder FAILED

Aid

n6

OC

Only in the case of Card Complete: Authorisation ID returned by Card Complete

Nur bei Card Complete: von Card Complete zurückgegebene Autorisierungs-ID

RefNr

an..25

OC

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Pay-Jet settlement file (CTSF) we cannot add the additional payment data.

Only for Card Complete, for Clearhaus (ans..30, optional, only printable ASCII characters from 0x20 to 0x7E), for RBI (ns..20, optional), for MasaPay (ns..30, optional), for Cofidis (n..15, optional).

The page DE:Reuse API was not found  -- Please check/update the page name used in the MultiExcerpt-Include macro

Nur bei Card Complete, bei Clearhaus (ans..30, nur ASCII druckbare Zeichen von 0x20 bis 0x7E), bei RBI (ns..20, optional), bei MasaPay (ns..30, optional), bei Cofidis (n..15, optional).

Amount

n..10

OC

Only with Clearhaus: Amount in the smallest currency unit (e.g. EUR Cent)

If the actual amount differs from the requested amount this will be returned.

Only with MasaPay: The amount has to be equal to the originally authorised amount.

Nur bei Clearhaus: Betrag in der kleinsten Währungseinheit (z.B. EUR Cent)

Sollte der tatsächliche Betrag vom angefragten Betrag abweichen, wird dieser zurückgegeben.

Nur bei MasaPay: Betrag muss gleich dem ursprünglich autorisierten Betrag sein.

CodeExt

n5

OC

Only with Clearhaus: Only if configured: External error code (downstream system).

Only with MasaPay: Format ans..10, error code from MasaPay.

Nur bei Clearhaus: Nur wenn konfiguriert: externer Fehlercode (nachgelagertes System).

Nur bei MasaPay: Format ans..10, Fehlercode von MasaPay.

ErrorText

ans.128

OC

Only with Clearhaus: Detailed Clearhaus error message.

Only with MasaPay: Format ans..128, detailed MasaPay error message.

Is returned only if Status=FAILED. Use is possible only in agreement with Pay-Jet Support

Nur bei Clearhaus: Detaillierte Clearhaus Fehlermeldung.

Nur bei MasaPay: Format ans..128, Detaillierte MasaPay Fehlermeldung.

Wird nur bei Status=FAILED zurückgegeben. Nutzung nur in Abstimmung mit  Pay-Jet Support möglich.

TransactionID

ans36

OC

Only with Clearhaus: Transaction number from Clearhaus

Nur bei Clearhaus: Transaktionsnummer von Clearhaus

Response parameters for credits of credit card payments



Credit without reference

Cockpit can carry out Credits which do not relate to a previous capture. In this case the credit must be transferred to Cockpit as a completely new payment transaction. Please contact the Pay-Jet Support for help in using the described additional functions.

Notice: Please note that credits without reference to a previous capture generate higher costs with your Acquiring Bank. If you are frequently unable to make reference to the capture you should agree this with your Acquiring Bank.

To carry out a Credit without a reference transaction via a Server-to-Server connection, please use the following URL:


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.

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:


Key

Format

CND

Description

Beschreibung

TransID

ans..64

M

TransactionID which should be unique for each payment

Please note for some connections the different formats that are given within the specific parameters.

TransaktionsID, die für jede Zahlung eindeutig sein muss

Bitte beachten Sie bei einigen Anbindungen die abweichenden Formate, die bei den spezifischen Parametern angegeben sind.

RefNrns..30C

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Pay-Jet settlement file (CTSF) we cannot add the additional payment data.

(not with EVO Payments, Only for CardComplete, for Clearhaus (ns..30, optional, only printable ASCII characters from 0x20 to 0x7E), for RBI (ns..20, optional), for MasaPay (ns..30, optional), for Cofidis (n..15, optional).)

The page DE:Reuse API was not found  -- Please check/update the page name used in the MultiExcerpt-Include macro

(nicht bei EVO Payments, Nur bei CardComplete, bei Clearhaus (ns..30, optional, nur ASCII druckbare Zeichen von 0x20 bis 0x7E), bei RBI (ns..20, optional), bei MasaPay (ns..30, optional), bei Cofidis (n..15, optional))

OrderDescans..768ODescription of refunded goods, unit prices, merchant’s comment etc. (not with Clearhaus)Beschreibung der gutgeschriebenen Artikel, Einzelpreise, Händlerkommentar etc. (Nicht bei Clearhaus)

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / action is submitted again with the same ReqID, Pay-Jet Cockpit will not carry out the payment or new action, but will just return the status of the original transaction / action. Please note that the Pay-Jet Cockpit must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion / Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder auch jede Aktion mit derselben ReqID erneut eingereicht wird, führt das Pay-Jet Cockpit keine Zahlung / weitere Aktion aus sondern gibt nur den Status der ursprünglichen Transaktion / Aktion zurück. Bitte beachten Sie, dass das Pay-Jet Cockpit für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

KeyFormatCNDDescriptionBeschreibung
CCNr

n..19

M

Credit card number for credit card payments. 

It can be filled:

  • either with the real credit card number (PAN)
  • or with the pseudo card number that you have received previously in a Cockpit response in parameter PCNr.

(info) With 3-D Secure 2.x the CCNr (PAN or PCNr) is sent as card.JSON.

(info) We recommend to use "Hosted Payment Page" or Credit Card Form (paySSL) for simplified PCI DSS certification and usage of PCNr.

Kreditkartennummer für Kreditkarten-Zahlungen.

Es kann wahlweise übergeben werden: 

  • entweder die richtige Kreditkartennummer (PAN)
  • oder die Pseudokartennummer, welche Sie zuvor in einer Cockpit-Antwort als PCNr erhalten haben. 

(info) Mit 3-D Secure 2.x wird die CCNr (PAN oder PCNr) im card-JSON gesendet.

(info) Wir empfehlen die Verwendung der "Hosted Payment Page" oder des Kreditkartenformular (PaySSL) sowie Übergabe der PCNr zur vereinfachten PCI DSS Zertifizierung.

Key

Format

CND

Description

Beschreibung

CCCVC

n..4

O



CCExpiry

n6

M

Expiry date of the credit card in the format YYYYMM, e.g. 202507.

Ablaufdatum der Kreditkarte im Format YYYYMM, z.B. 202507

CCBrand

a..22

M

Credit card brand.

Please note the spelling! According to table of credit card brands!

Kreditkartenmarke.

Bitte beachten Sie die Schreibweise gemäß Tabelle der Kreditkartenmarken!

OrderDesc

ans..768

MC

Not with Clearhaus: Description of refunded goods, unit prices, merchant’s comment etc.

Nicht bei Clearhaus: Beschreibung der gutgeschriebenen Artikel, Einzelpreise, Händlerkommentar etc.

UserData

ans..1024

OC

Only with Clearhaus: If specified at request, Cockpit forwards the parameter with the payment result to the shop.

Nur bei Clearhaus: Wenn beim Aufruf angegeben, übergibt das Cockpit die Parameter mit dem Zahlungsergebnis an den Shop

Textfeld1

ans..30

O

Not with Clearhaus: Card holder information: Name

Nicht bei Clearhaus: Karteninhaber-Information: Name

Textfeld2

ans..30

O

Not with Clearhaus: Card holder information: City

Nicht bei Clearhaus: Karteninhaber-Information: Ort

CHDesc

ans..34

OC

Only with Clearhaus, format ans..22: Text printed on the customer’s credit card bill. Only printable ASCII characters from 0x20 to 0x7E

Only for Credorax: Text printed on the customer’s credit card bill.

This function must be enabled by Credorax and have the following structure.

1) merchant DBA name (up to 20 characters)

2) asterisk

3) additional text (up to 13 characters).

e.g. Pay-Jet*Test

This value can be alternatively permanently defined by Pay-Jet Support

Nur bei Clearhaus, Format ans..22: Text, der auf der Kreditkartenabrechnung angezeigt wird. Nur ASCII druckbare Zeichen von 0x20 bis 0x7E

Nur bei Credorax: Text, der auf der Kreditkartenabrechnung angezeigt wird.

Diese Funktion muss von Credorax freigeschalten werden und folgenden Aufbau haben.

1) merchant DBA Name (bis zu 20 Zeichen)

2) Stern

3) zusätzlicher Text (bis zu 13 Zeichen).

z.B. Pay-Jet *Test

Dieser Wert kann alternativ vom  Pay-Jet Support fest hinterlegt werden.

CreditCardHolder

an..255

MC

Only with Credorax, ECPCC: Name of the card holder  

Nur bei Credorax, ECPCC: Name des Karteninhabers   

Email

ans..64

MC

Only with Credorax, ECPCC: Email address of the customer

Nur bei Credorax, ECPCC: E-Mail-Adresse des Kunden

IPAddr

ans..15

OC

Only with Credorax, ECPCC: Customer´s IP address

Nur bei Credorax, ECPCC: IP-Adresse des Kunden

PaymentOfWinnings

ans..4

OC

In the case of the acquirer EMS (Omnipay) the merchant can control CFT credit notes in this way.
Transfer PaymentOfWinnings=True to credit a win rather than simply repaying a paid amount.

Beim Acquirer EMS (Omnipay) kann der Händler hiermit CFT-Gutschriften steuern.
Übergeben Sie PaymentOfWinnings=True, um einen Gewinn gutzuschreiben, anstatt nur einen eingezahlten Betrag zurückzuerstatten.

PaymentAddDataJSONCOnly with Omnipay: Additional data if PaymentOfWinnings=TrueNur bei OmniPay: Zusätzliche Daten, wenn PaymentOfWinnings=True

TransactionID

an..150

M

Additional reference number

Zusätzliche Referenznummer




Further address parameters in case of ECPCC connectionWeitere Adressparameter bei der Anbindung ECPCC

DateOfBirth

n8

O

Date of birth of the customer in format YYYYMMDD

Geburtsdatum des Kunden im Format YYYYYMMDD

Phone

n..32

O

Customer’s phone number

Telefonnummer des Kunden

FirstName

ans..255

M

First name of the customer

Vorname des Kunden

LastName

ans..255

M

Last name of the customer

Nachname des Kunden

AddrStreet

ans..255

O

Street name

Straßenname

AddressAddition

ans..255

O

Address c/o

Adresszusatz

AddrZip

an..9

O

Postcode

Postleitzahl

AddrCity

ans..255

O

City

Ort

AddrState

a2

O

Code of the customer’s Federal State

Code des Bundeslandes des Kunden

AddrCountryCode

a2

M

Country code according to ISO-3166-1, alphanumeric 2 chars

Ländercode im Format ISO-3166-1, alphanumerisch 2-stellig

sdFirstName

ans..255

O

First name in the delivery address

Vorname in der Lieferanschrift

sdLastName

ans..255

O

Surname in the delivery address

Nachname in der Lieferanschrift

sdStreet

ans..255

O

Street name in the delivery address

Straßenname der Lieferanschrift

sdAddressAddition

ans..255

O

Address addition in the delivery address

Adresszusatz der Lieferanschrift

sdZIPCode

an..9

O

Postcode in the delivery address

Postleitzahl der Lieferanschrift

sdCity

ans..255

O

Town/city in the delivery address

Ort der Lieferanschrift

sdState

a2

O

Code of Federal State in the delivery address

Code des Bundeslandes der Lieferanschrift

sdCountryCode

a2

O

Country code of delivery address according to ISO-3166-1, alphanumeric 2 chars

Ländercode der Lieferanschrift  im Format ISO-3166-1, alphanumerisch 2-stellig




Further address parameters in case of Kalixa connectionWeitere Adressparameter bei der Anbindung Kalixa

IPAddr

ans..15

M

Customer´s IP address

IP-Adresse des Kunden

BrowserSessionID

ans..64

M

Customer´s Session ID

SessionID des Kunden

CreditCardHolder

ans..100

M

Name of the card holder

Name des Karteninhabers

CustomerID

an..20

M

Customer number: Number to identify the customer

Kundennummer: Nummer zur Identifizierung des Kunden

Name

ans..100

C

User name of the customer

Benutzername des Kunden

FirstName

ans..100

C

First name of the customer

Vorname des Kunden

LastName

ans..100

C

Last name of the customer

Nachname des Kunden

Email

ans..64

C

Email address of the customer

E-Mail-Adresse des Kunden

Language

a2

C

Language of the customer according to ISO, alphanumeric 2-digits

Sprache des Kunden gemäß ISO, alphanumerisch 2-stellig

sdFirstName

ans..100

C

First name in the delivery address

Vorname in der Lieferanschrift

sdLastName

ans..100

C

Surname in the delivery address

Nachname in der Lieferanschrift

sdStreet

ans..200

C

Street name in the delivery address

Straßenname der Lieferanschrift

sdStreetNr

ans..5

C

Street number in the delivery address

Hausnummer der Lieferanschrift

sdZIPCode

an..20

C

Postcode in the delivery address

Postleitzahl der Lieferanschrift

sdCity

ans..40

C

Town/city in the delivery address

Ort der Lieferanschrift

sdState

a2

C

Code of Federal State in the delivery address

Code des Bundeslandes der Lieferanschrift

sdCountryCode

a2

C

Country code of delivery address according to ISO-3166-1, alphanumeric 2 chars

Ländercode der Lieferanschrift  im Format ISO-3166-1, alphanumerisch 2-stellig




Further address parameters in case of Vantiv connectionWeitere Adressparameter bei der Anbindung Vantiv

bdFirstName

ans..25

O

First name in the invoicing address

Vorname in der Rechnungsadresse

bdLastName

ans..25

O

Last name in the invoicing address

Nachname in der Rechnungsadresse

bdStreet

ans..35

O

Street name in the invoicing address

Please note that bdStreet and bdStreetNr together may have 34 characters maximum.

bdStreet and bdStreetNr are combined with a space character between and forwarded together. The total content is truncated after 35 characters.

Straßenname in der Rechnungsadresse

Bitte beachten Sie, dass bdStreet und bdStreetNr zusammen maximal 34 Zeichen haben dürfen.

bdStreet und bdStreetNr werden mit einem Leerzeichen getrennt zusammengefügt und gemeinsam weitergeleitet. Der Gesamtinhalt wird nach 35 Zeichen abgeschnitten.

bdStreetNr

ans..35

O

Street number in the invoicing address

Please note that bdStreet and bdStreetNr together may have 34 characters maximum.

bdStreet and bdStreetNr are combined with a space character between and forwarded together. The total content is truncated after 35 characters.

Hausnummer in der Rechnungsadresse

Bitte beachten Sie, dass bdStreet und bdStreetNr zusammen maximal 34 Zeichen haben dürfen.

bdStreet und bdStreetNr werden mit einem Leerzeichen getrennt zusammengefügt und gemeinsam weitergeleitet. Der Gesamtinhalt wird nach 35 Zeichen abgeschnitten.

bdStreet2

ans..35

O

Address addition in the billing address

Adresszusatz in der Rechnungsadresse

bdZIPCode

ans..20

O

Postcode in the invoicing address

Postleitzahl in der Rechnungsadresse

bdCity

ans..35

O

Town/city in the invoicing address

Ort in der Rechnungsadresse

bdState

ans..30

O

State/country in the invoicing address

Staat/Land in der Rechnungsadresse

bdCountryCode

a2

O

Country code of invoicing address according to ISO-3166-1, alphanumeric 2 chars

Ländercode der Rechnungsadresse im Format ISO-3166-1, alphanumerisch 2-stellig

bdMail

ans..100

O

Email address in the invoicing address

E-Mail in der Rechnungsadresse

bdPhone

ans..20

O

Phone number in the invoicing address

Telefonnummer in der Rechnungsanschrift

Parameters for credits of credit card payments without reference


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

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
PayID

an32

M

ID assigned by Cockpit for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Cockpit vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Cockpit

Vom Cockpit vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

Error code according to Cockpit Response Codes (A4 Error codes)

Fehlercode gemäß Cockpit Antwort-Codes (A4 Fehlercodes)

KeyFormatCNDDescriptionBeschreibung
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

Key

Format

CND

Description

Beschreibung

TransID

ans..64

M

Merchant’s transaction number.

Please note for some connections the different formats that are given within the specific parameters.

Transaktionsnummer des Händlers.

Bitte beachten Sie bei einigen Anbindungen die abweichenden Formate, die bei den spezifischen Parametern angegeben sind.

Status

a..50

M

OK or FAILED

OK oder FAILED

AID

n6

OC

Only in the case of Card Complete: Authorisation ID returned by Card Complete

Nur bei Card Complete: von Card Complete zurückgegebene Autorisierungs-ID

RefNr

an..25

OC

Only for Card Complete: If a RefNr has been transmitted, it is returned.

Nur bei Card Complete: Falls eine RefNr übermittelt wurde, wird sie wieder zurückgegeben.

Amount

n..10

OC

Only with Clearhaus: Amount in the smallest currency unit (e.g. EUR Cent)

If the actual amount differs from the requested amount this will be returned.

Nur bei Clearhaus: Betrag in der kleinsten Währungseinheit (z.B. EUR Cent)

Sollte der tatsächliche Betrag vom angefragten Betrag abweichen, wird dieser zurückgegeben.

CodeExt

n5

OC

Only with Clearhaus: Only if configured: External error code (downstream system)

Nur bei Clearhaus: Nur wenn konfiguriert: externer Fehlercode (nachgelagertes System)

ErrorText

ans..128

OC

Only with Clearhaus: Detailed Clearhaus error message.

Is returned only if Status=FAILED. Use is possible only in agreement with Pay-Jet Support

Nur bei Clearhaus: Detaillierte Clearhaus Fehlermeldung.

Wird nur bei Status=FAILED zurückgegeben. Nutzung nur in Abstimmung mit dem  Pay-Jet Support möglich.

UserData

ans..1024

OC

Only with Clearhaus: If specified at request, Cockpit forwards the parameter with the payment result to the shop.

Nur bei Clearhaus: Wenn beim Aufruf angegeben, übergibt das Cockpit die Parameter mit dem Zahlungsergebnis an den Shop

TransactionID

ans36

OC

Only with Clearhaus: Transaction number from Clearhaus

Nur bei Clearhaus: Transaktionsnummer von Clearhaus

PaymentSenderReferencean..19COnly with Omnipay: Reference number generated by the Acquirer that will be used to identify the payment transaction. It can be returned for MasterCard Payment of winnings transactions when the required additional parameters are submitted in the request.Nur bei Omnipay: Referenznummer des Acquirers, die zur Identifikation der Zahlungstransaktion verwendet wird. Sie kann für MasterCard Payment of winnings Transaktionen zurückgegeben werden, wenn die erforderlichen zusätzlichen Parameter übergeben worden sind.

Response parameters for credits of credit card payments without reference



Reversal

A credit card authorisation lowers the customer's credit line. Cockpit can reverse an authorisation so that it no longer block the limit any more. Use the following URL:


Notice: Reverse.aspx does not only reverse authorisations, but any LAST TRANSACTION STAGE!! If the last transaction was a capture, Reverse.aspx initiates the reverse, e.g. a credit. Therefore, the utmost caution is urged. Use is at your own risk. We recommend checking the transaction status with Inquire.aspx before using Reverse.aspx.

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.

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:


KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Cockpit for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Cockpit vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

Key

Format

CND

Description

Beschreibung

TransID

ans..64

M

Merchant ID for the identification of the payment process to be reversed.

Please note for some connections the different formats that are given within the specific parameters.

ID des Händlers zur Identifizierung des zu stornierenden Zahlungsvorgangs.

Bitte beachten Sie bei einigen Anbindungen die abweichenden Formate, die bei den spezifischen Parametern angegeben sind.

RefNr

ans..30

OC

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Pay-Jet settlement file (CTSF) we cannot add the additional payment data.

Only for Clearhaus (only printable ASCII characters from 0x20 to 0x7E), for MasaPay.

The page DE:Reuse API was not found  -- Please check/update the page name used in the MultiExcerpt-Include macro

Nur bei Clearhaus (nur ASCII druckbare Zeichen von 0x20 bis 0x7E), bei MasaPay.

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / action is submitted again with the same ReqID, Pay-Jet Cockpit will not carry out the payment or new action, but will just return the status of the original transaction / action. Please note that the Pay-Jet Cockpit must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion / Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder auch jede Aktion mit derselben ReqID erneut eingereicht wird, führt das Pay-Jet Cockpit keine Zahlung / weitere Aktion aus sondern gibt nur den Status der ursprünglichen Transaktion / Aktion zurück. Bitte beachten Sie, dass das Pay-Jet Cockpit für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Parameters for reversals of credit card payments


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

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
PayID

an32

M

ID assigned by Cockpit for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Cockpit vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Cockpit

Vom Cockpit vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

Error code according to Cockpit Response Codes (A4 Error codes)

Fehlercode gemäß Cockpit Antwort-Codes (A4 Fehlercodes)

KeyFormatCNDDescriptionBeschreibung
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

Key

Format

CND

Description

Beschreibung

TransID

ans..64

M

Merchant’s transaction number.

Please note for some connections the different formats that are given within the specific parameters.

Transaktionsnummer des Händlers.

Bitte beachten Sie bei einigen Anbindungen die abweichenden Formate, die bei den spezifischen Parametern angegeben sind.

Status

a..50

M

OK or FAILED

OK oder FAILED

RefNr

an..25

OC

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Pay-Jet settlement file (CTSF) we cannot add the additional payment data.

Only for Card Complete, for Clearhaus (ans..30, only printable ASCII characters from 0x20 to 0x7E), for MasaPay (ns..30).

The page DE:Reuse API was not found  -- Please check/update the page name used in the MultiExcerpt-Include macro

Nur bei Card Complete, bei Clearhaus (ans..30, nur ASCII druckbare Zeichen von 0x20 bis 0x7E), bei MasaPay (ns..30)

AID

n6

OC

Only in the case of Card Complete: Authorisation ID returned by Card Complete

Nur bei Card Complete: von Card Complete zurückgegebene Autorisierungs-ID

CodeExt

n5

OC

Only with Clearhaus: Only if configured: External error code (downstream system)

Only with MasaPay: Format ans..10, error code from MasaPay

Nur bei Clearhaus: Nur wenn konfiguriert: externer Fehlercode (nachgelagertes System)

Nur bei MasaPay: Format ans..10, Fehlercode von MasaPay

ErrorText

ans.128

OC

Only with Clearhaus: Detailed Clearhaus error message.

Only with MasaPay: Format ans..128, detailed MasaPay error message.

Is returned only if Status=FAILED. Use is possible only in agreement with Pay-Jet Support

Nur bei Clearhaus: Detaillierte Clearhaus Fehlermeldung.

Nur bei MasaPay: Format ans..128, Detaillierte MasaPay Fehlermeldung.

Wird nur bei Status=FAILED zurückgegeben. Nutzung nur in Abstimmung mit dem  Pay-Jet Support möglich.

TransactionID

ans36

OC

Only with Clearhaus: Transaction number from Clearhaus

Nur bei Clearhaus: Transaktionsnummer von Clearhaus

Response parameters for reversals of credit card payments



Reversal of an authorisation extension

A credit card authorisation is valid for only 7 to 30 days. In order to maintain your payment claim in the case of longer delivery times, Cockpit enables the automatic renewal of the authorisation. Renewal of the authorisation is also important for instalments or partial deliveries because the outstanding amount is invalid in the case of partial captures.

If you use authorisation renewal, Cockpit renews your authorisations until the payment has been captured fully. Amongst other things the customer's card limit is reduced by the authorised amount. In order to restore the card limit again, for example because the order cannot be fully delivered, you need to specifically cancel the authorisation renewal with the following URL:


Notice: CancelAuth cancels only the recurrence of the authorisation. If you wish to unblock the customer's card limit, please reverse the authorisation in accordance with the section above.

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.

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Cockpit for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Cockpit vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

Key

Format

CND

Description

Beschreibung

TransID

ans..64

M

TransID for the identification of the payment process to be reversed

ID des Händlers zur Identifizierung des zu stornierenden Zahlungsvorgangs

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Parameters for reversal of an authorisation extension


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

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
PayID

an32

M

ID assigned by Cockpit for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Cockpit vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

Key

Format

CND

Description

Beschreibung

TransID

ans..64

M

Merchant’s transaction number.

Transaktionsnummer des Händlers.

Status

a..50

M

OK or FAILED

OK oder FAILED

KeyFormatCNDDescriptionBeschreibung
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

Error code according to Cockpit Response Codes (A4 Error codes)

Fehlercode gemäß Cockpit Antwort-Codes (A4 Fehlercodes)

Result parameters for reversals of an authorisation extension



Credit card payment via POS terminals

To make a credit card payment via a POS terminal (POS: Point of Sale), send the payment request to the following URL:


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.

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

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:


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

RefNr

ns..30

O

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Pay-Jet settlement file (CTSF) we cannot add the additional payment data.

Format must be mutually agreed beforehand with Pay-Jet Support !

The page DE:Reuse API was not found  -- Please check/update the page name used in the MultiExcerpt-Include macro

Das Format muss vorher mit Pay-Jet Support abgestimmt werden!

CCNr

n..16

M

Credit card number at least 12-digit, numerical without spaces

Kreditkartennummer mind. 12stellig numerisch ohne Leerzeichen

CCCVC

n..4

O

Card verification number: The last 3 digits on the signature strip of the credit card. 4 numbers in the case of American Express.

Kartenprüfnummer: Die letzten 3 Ziffern auf dem Unterschriftsfeld der Kreditkarte. Bei American Express 4 Ziffern.

CCExpiry

n6

M

Expiry date of the credit card in the format YYYYMM, e.g. 201707.

Ablaufdatum der Kreditkarte im Format YYYYMM, z.B. 201707

CCBrand

a..22

M

Credit card brand.

Please note the spelling! According to table of credit card brands!

Kreditkartenmarke.

Bitte beachten Sie die Schreibweise gemäß Tabelle der Kreditkartenmarken!

Track2

ans..80

M

Hexadecimal data on track 2 of the credit card

Hexadezimale Daten auf Spur 2 der Kreditkarte

Track3

ans..80

M

Hexadecimal data on track 3 of the credit card

Hexadezimale Daten auf Spur 3 der Kreditkarte

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

Beschreibung der gekauften Waren, Einzelpreise etc.

KeyFormatCNDDescriptionBeschreibung
Capture

an..6

OM

Determines the type and time of capture.

Capture ModeDescription
AUTOCapturing immediately after authorisation (default value).
MANUALCapturing made by the merchant. Capture is normally initiated at time of delivery.
<Number>Delay in hours until the capture (whole number; 1 to 696).

Bestimmt Art und Zeitpunkt der Buchung (engl. Capture).

BuchungsartBeschreibung
AUTOBuchung sofort nach Autorisierung (Standardwert).
MANUALBuchung erfolgt durch den Händler - in der Regel die Buchung zum Zeitpunkt der Warenauslieferung bzw. Leistungserbringung.
<Zahl>Verzögerung in Stunden bis zur Buchung (ganze Zahl; 1 bis 696).

KeyFormatCNDDescriptionBeschreibung
ReqId

ans..32

O

To avoid double payments / actions, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction / action is submitted again with the same ReqID, Pay-Jet Cockpit will not carry out the payment or new action, but will just return the status of the original transaction / action. Please note that the Pay-Jet Cockpit must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion / Aktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion oder auch jede Aktion mit derselben ReqID erneut eingereicht wird, führt das Pay-Jet Cockpit keine Zahlung / weitere Aktion aus sondern gibt nur den Status der ursprünglichen Transaktion / Aktion zurück. Bitte beachten Sie, dass das Pay-Jet Cockpit für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet.

Parameters for credit card payments via POS terminals


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

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
PayID

an32

M

ID assigned by Cockpit for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Cockpit vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Cockpit

Vom Cockpit vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

Error code according to Cockpit Response Codes (A4 Error codes)

Fehlercode gemäß Cockpit Antwort-Codes (A4 Fehlercodes)

KeyFormatCNDDescriptionBeschreibung
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

Key

Format

CND

Description

Beschreibung

TransID

ans..64

M

Merchant’s transaction number

Transaktionsnummer des Händlers

TID

n..20

M

Usually a nine-digit terminal number

In der Regel neunstellige Terminalnummer

AuthCode

ans..6

M

Acquiring Bank's authorisation code

Autorisierungscode des Acquirers

Status

a..50

M

AUTHORIZED or FAILED. OK status applies only to Sale transactions.

AUTHORIZED oder FAILED. Nur bei Sale-Transaktionen lautet der Status OK.

Response parameters for credit card payments via POS terminals



Reversal of POS credit card payments

To reverse the capture of a credit card payment via a stationary terminal, please use the following URL:

https://www.payjet-cockpit.de/ stationary_rev.aspx


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.

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Cockpit for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Cockpit vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

KeyFormatCNDDescriptionBeschreibung
XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Cockpit

Vom Cockpit vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

Key

Format

CND

Description

Beschreibung

TransID

ans..64

M

ID of merchant for the identification of the payment process to be reversed

ID des Händlers zur Identifizierung des zu stornierenden Zahlungsvorgangs

KeyFormatCNDDescriptionBeschreibung

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:
Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus. Details finden Sie hier:

Parameters for reversal of credit card payments via POS terminals


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

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
PayID

an32

M

ID assigned by Cockpit for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Cockpit vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

Key

Format

CND

Description

Beschreibung

TransID

ans..64

M

Merchant’s transaction number.

Transaktionsnummer des Händlers.

Status

a..50

M

OK or FAILED

OK oder FAILED

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

Error code according to Cockpit Response Codes (A4 Error codes)

Fehlercode gemäß Cockpit Antwort-Codes (A4 Fehlercodes)

Response parameters for reversal of credit card payments via POS terminals



PayNow

Silent Mode for credit cards with SSL and 3-D Secure method

PayNow links the benefits of Cockpit forms and Server-to-Server connections: As opposed to the Cockpit form, where the form is loaded from the Cockpit server by calling payssl.aspx, the PayNow form has to be provided by the merchant’s system. The form uses the same parameters as described here below.

In contrast to the Cockpit form, the parameters are not forwarded as URL parameters as is the case when calling the payssl.aspx, but as form input parameters. By the way for calling the PayNow.aspx the same parameters can be used as for PaySSL.aspx.

Please notice that in case of Fallback to 3-D Secure 1.0 the URLSuccess or URLFailure is called with GET. Therefore your systems should be able to receive parameters both via GET and via POST.

Cockpit-Formular

PayNow

payssl.aspx?MerchantID=[mid]&Len=[len]&Data=[data]

<form action=paynow.aspx>
<input type="hidden" name="MerchantID" value=[mid]>
<input type="hidden" name="Len"        value=[len]>
<input type="hidden" name="Data"       value=[data]>
:
</form>

The credit card data must be transmitted to paynow.aspx with the following 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
CCNr

n..19

M

Credit card number for credit card payments. 

It can be filled:

  • either with the real credit card number (PAN)
  • or with the pseudo card number that you have received previously in a Cockpit response in parameter PCNr.

(info) With 3-D Secure 2.x the CCNr (PAN or PCNr) is sent as card.JSON.

(info) We recommend to use "Hosted Payment Page" or Credit Card Form (paySSL) for simplified PCI DSS certification and usage of PCNr.

Kreditkartennummer für Kreditkarten-Zahlungen.

Es kann wahlweise übergeben werden: 

  • entweder die richtige Kreditkartennummer (PAN)
  • oder die Pseudokartennummer, welche Sie zuvor in einer Cockpit-Antwort als PCNr erhalten haben. 

(info) Mit 3-D Secure 2.x wird die CCNr (PAN oder PCNr) im card-JSON gesendet.

(info) Wir empfehlen die Verwendung der "Hosted Payment Page" oder des Kreditkartenformular (PaySSL) sowie Übergabe der PCNr zur vereinfachten PCI DSS Zertifizierung.

Key

Format

CND

Description

Beschreibung

CCCVC

n3

O

Card verification number: The last 3 digits on the signature strip of the credit card

Kartenprüfnummer: Die letzten 3 Ziffern auf dem Unterschriftsfeld der Kreditkarte

CCExpiry

n6

M

Expiry date of the credit card in the format YYYYMM, e.g. 201807.

Ablaufdatum der Kreditkarte im Format YYYYMM, z.B. 201807

CCBrand

a..22

M

Credit card brand.

Please note the spelling! According to table of credit card brands!

Kreditkartenmarke.

Bitte beachten Sie die Schreibweise gemäß Tabelle der Kreditkartenmarken!


PayNow parameters for 3-D Secure method


After the customer has entered his credit card data, the payment data is forwarded to the PayNow page, where the further payment processing takes place via 3-D Secure. The form details must be directly forwarded to the PayNow page and may not be transmitted to the merchant’s system! Also, no PCI-relevant data may be transmitted to the PayNow page as additional input parameters!



Batch processing via the interface

Basic information about using Batch files and about their structure can be found in the Batch Manager manual. Within batch processing not alle functions are available which are usually available for the online interface.

Batch calls and answers   

This section describes the parameters which must be transferred within the data set (Record) for executing a credit card payment and which information can be found within the response file about the payment status.

Notice: Within Batch process not all functions of online interface are available.

For Batch calls there must be considered batch versions, from which optional parameters depend. All version designations starting with „2.“ pertain calls for a group of enterprises. That means within a batch file for a particular MerchantID can be transferred transactions for other merchants with a separate Sub-MID.

For the connections ECPCC, GMO, Kalixa and SafeCharge the possible actions are limited to Capture, Credit and Reverse.

Following table gives an overview of all batch versions that are possible for a specific action and their specialities:

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

Action

Version

Description

Beschreibung

Authorize

1.2 / 2.2

with textfeld1, textfeld2, RTF, cardholder, transactionID, schemeReferenceID

mit textfeld1, textfeld2, RTF, cardholder, transactionID, schemeReferenceID

 

1.21 / 2.21

with textfeld1, textfeld2, RTF, approvalcode, cardholder, transactionID, schemeReferenceID

mit textfeld1, textfeld2, RTF, approvalcode, cardholder, transactionID, schemeReferenceID

 

1.3 / 2.3

with CVC, transactionID, schemeReferenceID

mit CVC, transactionID, schemeReferenceID

 

1.5 / 2.5

with CVC, Zone

mit CVC, Zone

Capture

1.2 / 2.2

with textfeld1, textfeld2

mit textfeld1, textfeld2

 

1.21 / 2.21

with textfeld1, textfeld2, approvalcode

mit textfeld1, textfeld2, approvalcode

 

1.4 / 2.4

with stop of authorisation renewal (FinishAuth)

mit Stopp der Autorisierungsverlängerung (FinishAuth)

CaptureEx

1.3 / 2.3

with CVC

mit CVC

Credit

1.2 / 2.2

with textfeld1, textfeld2

mit textfeld1, textfeld2

 

1.21 / 2.21

with textfeld1, textfeld2

mit textfeld1, textfeld2

 

1.4 / 2.4

with stop of authorisation renewal (FinishAuth)

mit Stopp der Autorisierungsverlängerung (FinishAuth)

CreditEx

1.2 / 2.2

with textfeld1, textfeld2

mit textfeld1, textfeld2

 

1.21 / 2.21

with textfeld1, textfeld2

mit textfeld1, textfeld2

 

1.3 / 2.3

with textfeld1, textfeld2

mit textfeld1, textfeld2

Sale

1.2 / 2.2

with textfeld1, textfeld2, RTF, cardholder, transactionID, schemeReferenceID

mit textfeld1, textfeld2, RTF, cardholder, transactionID, schemeReferenceID

 

1.21 / 2.21

with textfeld1, textfeld2, RTF, approvalcode, cardholder, transactionID, schemeReferenceID

mit textfeld1, textfeld2, RTF, approvalcode, cardholder, transactionID, schemeReferenceID

 

1.3 / 2.3

with CVC, textfeld1, textfeld2, transactionID, schemeReferenceID

mit CVC, textfeld1, textfeld2, transactionID, schemeReferenceID

 

1.5 / 2.5

with CVC, Zone

mit CVC, Zone

Reverse

1.x / 2.x

Standard version

Standardversion


Description of the possible batch versions


The structure for a credit card payment within a Batch file to be submitted is the following:

HEAD,<MerchantID>,<Date>,<Version>
CC,Authorize,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>, [<CCCVC>,]<CCExpiry>,<OrderDesc>[,<textfeld1>,<textfeld2>,<RTF>,<approvalcode>,<cardholder>,<Zone>,<transactionID>,<schemeReferenceID>]
CC,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>),<PayID>,[<FinishAuth,<textfeld1>,<textfeld2>,<approvalcode>]
CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>, [<CCCVC>,]<CCExpiry>,<OrderDesc>[,<textfeld1>,<textfeld2>,<RTF>,<approvalcode>,<cardholder>,<Zone>,<transactionID>,<schemeReferenceID>]]
CC,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>),<PayID>[,<FinishAuth>,<textfeld1>,<textfeld2>]
CC,CreditEx,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>, [<CCCVC>,]<CCExpiry>,<OrderDesc>[,<textfeld1>,<textfeld2>]
CC,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>),<PayID>
FOOT,<CountRecords>,<SumAmount>

Example for batch versions:

Version 1.2
CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>,<CCExpiry>,<OrderDesc>
CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>,<CCExpiry>,<OrderDesc>,<textfeld1>,<textfeld2>,<RTF>,<cardholder>,<transactionID>,<schemeReferenceID>
Version 1.21
CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>,<CCExpiry>,<OrderDesc>,<textfeld1>,<textfeld2>,<RTF>,<approvalcode>,<cardholder>,<transactionID>,<schemeReferenceID>
Version 1.3
CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>,<CCCVC>,<CCExpiry>,<OrderDesc>,<textfeld1>,<textfeld2>,<transactionID>,<schemeReferenceID>
Version 1.5
CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>,<CCCVC>,<CCExpiry>,<OrderDesc>,<Zone>

Example for Master MID function:

HEAD,[Master]MerchantID,Date,2.x
Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action)
FOOT,CountRecords,SumAmount


The following table describes the individual fields and values used within the data set (record) in the batch file:

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

Type

a..11

M

HEAD for Header, FOOT for Footer, CC for credit card

HEAD für Header, FOOT für Footer, CC für Kreditkarte

Action

a..20

M

The parameter Action defines the type of transaction:

Authorize (authorisation)

Capture

Sale

Credit

CreditEx (credit note without previous capture; please agree this with Pay-Jet Support beforehand)

Reverse (cancellation)

Der Action-Parameter definiert die Art der Transaktion:

Authorize (Autorisierung)

Capture (Buchung)

Sale (Verkauf)

Credit (Gutschrift)

CreditEx (Gutschrift ohne vorherige Buchung; bitte stimmen sie sich hierzu vorher mit dem Pay-Jet Support ab)

Reverse (Storno)

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

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Cockpit for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Cockpit vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

Key

Format

CND

Description

Beschreibung

TransID

ans..64

M

TransactionID which should be unique for each payment.

Please note for some connections the different formats that are given within the specific parameters.

TransaktionsID, die für jede Zahlung eindeutig sein muss.

Bitte beachten Sie bei einigen Anbindungen die abweichenden Formate, die bei den spezifischen Parametern angegeben sind.

RefNr

ns..30

O

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Pay-Jet settlement file (CTSF) we cannot add the additional payment data.

The page DE:Reuse API was not found  -- Please check/update the page name used in the MultiExcerpt-Include macro

OrderDesc

ans..127

O

Description of purchased goods, unit prices etc.

Beschreibung der gekauften Waren, Einzelpreise etc.

CCBrand

a..22

C

Credit card brand.

Please note the spelling! According to table of credit card brands!

Kreditkartenmarke.

Bitte beachten Sie die Schreibweise gemäß Tabelle der Kreditkartenmarken!

CCNr

n..16

C

Credit card number at least 12-digit, numerical without spaces. You can optionally transmit also a pseudo card number (PCN)

Kreditkartennummer mind. 12stellig numerisch ohne Leerzeichen. Optional können Sie auch eine Pseudokartennummer (PKN) übergeben

KeyFormatCNDDescriptionBeschreibung
PCNr

n16

O

Pseudo Card Number: Random number generated by Pay-Jet Cockpit 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. You can use the PCN like a genuine card number for authorisation, capture and credits.

PCNr is a response value from Pay-Jet Cockpit and is sent as CCNr in Request or part of card-JSON

Pseudo Card Number: Vom Pay-Jet Cockpit 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 können Sie wie eine reale Kartennummer für Autorisierung, Buchung und Gutschriften verwenden.

PCNr ist ein Antwortwert von Pay-Jet Cockpit und kann ebenfalls als CCNr im Request oder als Teil von card-JSON verwendet werden.

KeyFormatCNDDescriptionBeschreibung
CCExpiry

n6

OC

Optional in combination with PCNr: Expiry date of the credit card in the format YYYYMM (202207).

In Verbindung mit PCNr: Ablaufdatum der Kreditkarte im Format YYYYMM (202207).

Key

Format

CND

Description

Beschreibung

CCCVC

n..4

O

Card verification number in Version 1.3: In the case of Visa and MasterCard the last 3 numbers on the signature strip of the credit card. 4 numbers in the case of American Express.

Kartenprüfnummer in Version 1.3: Bei Visa und MasterCard die letzten 3 Ziffern auf dem Unterschriftsfeld der Kreditkarte. Bei American Express 4 Ziffern.

FinishAuth

ans1

O

Version=1.4: If using the authorisation renewal, cancel repeat with the value Y in the field FinishAuth in the case of Capture or Credit. Example: You capture a partial delivery. The rest of the order cannot be supplied. You therefore enter Y in the FinishAuth field for Part-capture so that the Cockpit does not authorise the remaining amount. Please note for this also the following section about Cancel authorisation renewals .

Version=1.4: Wenn Sie die Autorisierungsverlängerung nutzen, stoppen Sie die Wiederholung mit dem Wert Y im Feld FinishAuth bei Capture oder Credit. Beispiel: Sie buchen eine Teillieferung. Der Rest der Bestellung ist nicht lieferbar. Daher übergeben Sie beim Capture der Teilbuchung im Feld FinishAuth Y, damit das Cockpit den Restbetrag nicht wieder au-torisiert. Beachten Sie dazu auch den folgenden Abschnitt zum Stopp von Autorisierungsverlängerungen.

Description of fields within the record for Batch files


The record area within the response file for Batch transactions looks as follows:

HEAD,<MerchantID>,<Date>,<Version>
CC,Authorize,<Amount>,<Currency>,<TransID>,(<RefNr>),<PayID>,<CCBrand>,<CCNr|PCNr>,[<CCCVC>,]<CCExpiry>,<OrderDesc>[,<textfeld1>,<textfeld2>,<RTF>,<approvalcode>,<cardholder>,<Zone>,<transactionID>,<schemeReferenceID>],<Status>,<Code>
CC,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>),<PayID>[<textfeld1>,<textfeld2>,<approvalcode>],<Status>,<Code>
CC,AuthSplit,<Amount>,<Currency>,<TransID>,(<RefNr>),<PayID>,FAILED,<Code>,<Description>,[<PCNr>]
CC,Renewal,<Amount>,<Currency>,<TransID>,(<RefNr>),<PayID>,FAILED,<Code>,<Description>,[<PCNr>]
CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>),<PayID>,<CCBrand>,<CCNr|PCNr>,[<CCCVC>,]<CCExpiry>,<OrderDesc>[,<textfeld1>,<textfeld2>,<RTF>,<approvalcode>,<cardholder>,<Zone>,<transactionID>,<schemeReferenceID>],<Status>,<Code>
CC,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>),<PayID>[,<FinishAuth>,<textfeld1>,<textfeld2>],<Status>,<Code>
CC,CreditEx,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>,[<CCCVC>,]<CCExpiry>,<OrderDesc>[,<textfeld1>,<textfeld2>],<Status>,<Code>
CC,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>),<PayID>,<Status>,<Code>
FOOT,<CountRecords>,<SumAmount>
 

Example for batch versions:

Version 1.2
CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>,<CCExpiry>,<OrderDesc>,<Status>,<Code>
CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>,<CCExpiry>,<OrderDesc>,<textfeld1>,<textfeld2>,<RTF>,<cardholder>,<transactionID>,<schemeReferenceID>,<Status>,<Code>
Version 1.21
CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>,<CCExpiry>,<OrderDesc>,<textfeld1>,<textfeld2>,<RTF>,<approvalcode>,<cardholder>,<transactionID>,<schemeReferenceID>,<Status>,<Code>
Version 1.3
CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>,<CCCVC>,<CCExpiry>,<OrderDesc>,<textfeld1>,<textfeld2>,<transactionID>,<schemeReferenceID>,<Status>,<Code>
Version 1.5
CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>),<CCBrand>,<CCNr|PCNr>,<CCCVC>,<CCExpiry>,<OrderDesc>,<Zone>,<Status>,<Code>

The following table describes the response parameters which the Batch Manager saves in the Record area for each transaction (standard parameters not explained here, such as <TransID> or <RefNR> and request parameters are returned unchanged and correspond to the call as specified before):

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

Action

a..20

M

The parameter Action defines the type of transaction like capture or credit – see above.
Der Action-Parameter definiert die Art der Transaktion wie Capture (Buchung) oder Credit (Gutschrift) – siehe oben.

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

ID assigned by Cockpit for the payment, e.g. for referencing in batch files as well as for capture or credit request.

Vom Cockpit vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

Key

Format

CND

Description

Beschreibung

Status

a..50

M

OK or FAILED

OK oder FAILED

KeyFormatCNDDescriptionBeschreibung
Code

n8

M

Error code according to Cockpit Response Codes (A4 Error codes)

Fehlercode gemäß Cockpit Antwort-Codes (A4 Fehlercodes)

Key

Format

CND

Description

Beschreibung

PCNr

n..16

C

The Pseudo Card Number is only returned in the case of transaction types Authorize or Sale & CreditEx. It starts with 0 and the last 3 digits correspond to those of the real card number.

Die Pseudo Card Number wird nur bei den Transaktionstypen Authorize oder Sale & CreditEx zurückgegeben. Sie beginnt mit 0, und die letzten 3 Stellen entsprechen denen der realen Kartennummer.

Description of result parameters within the record for Batch files



Cancel authorisation renewals

With a credit card authorisation you get the right to claim a payment. However an authorisation lasts only 30 days which is a problem if you capture a partial amount, for example as part payment for several partial shipments. In order to reproduce your payment request Cockpit can repeat an expired authorisation automatically.

If an order cannot be delivered or has been cancelled by the customer, it is very important that the automatic authorisations stop. Your customer's card limit will be otherwise reduced permanently because the Cockpit continues to charge your customer's card.

Under normal circumstances the Cockpit stops the automatic authorisation renewal when the authorised amount has been captured in full. In Batch version 1.4 you can also stop the authorisation renewal manually by changing the payment status. To perform this you submit a capture in your batch file whose amount is under the admissible limit. Since Cockpit refuses credit card captures below 1.00 euro, the payment status changes to FAILED in the case of lesser amounts. Cockpit therefore renews this authorisation no further. A corresponding capture entry of 0.05 euro’s is shown for example as follows:

CC,Capture,5,EUR,BestNr.0815,Rg.Nr.5180,a86dga4310d24453acd6f8a3112a769,y


Since the amount of 5 cents lies below the minimum amount of 1.00 euro, Cockpit refuses the capture with the error message MinValue. The payment status changes to FAILED and the authorisation renewal is stopped.