Skip to end of metadata
Go to start of metadata


Paygate-Schnittstelle

Definitionen

Datenformate:

FormatBeschreibung

a

alphabetisch

as

alphabetisch mit Sonderzeichen

n

numerisch

an

alphanumerisch

ans

alphanumerisch mit Sonderzeichen

ns

numerisch mit Sonderzeichen

bool

Bool’scher Ausdruck (true oder false)

3

feste Länge mit 3 Stellen/Zeichen

..3

variable Länge mit maximal 3 Stellen/Zeichen

enum

Aufzählung erlaubter Werte

dttm

ISODateTime (JJJJ-MM-TTThh:mm:ss)


Abkürzungen:

AbkürzungBeschreibungKommentar

CND

Bedingung (condition)


M

Pflicht (mandatory)

Wenn ein Parameter Pflicht ist, dann muss er vorhanden sein

O

optional

Wenn ein Parameter optional ist, dann kann er vorhanden sein, ist aber nicht erforderlich

C

bedingt (conditional)

Wenn ein Parameter bedingt ist, dann gibt es eine Bedingungsregel, die angibt, ob er Pflicht oder optional ist


Hinweis: Bitte beachten Sie, dass die Bezeichnungen der Parameter in Groß- oder Kleinbuchstaben zurückgegeben werden können.


Statusabfragen über Socket-Verbindungen

Statusabfragen per PayID

Statusabfragen im Paygate liefern genaue Informationen, welche Beträge tatsächlich autorisiert, gebucht oder gutgeschrieben worden sind. Vor allem vor der Ausführung von Stornos über die Schnittstelle reverse.aspx empfiehlt es sich, den Transaktionsstatus mit der inquire.aspx prüfen, denn die Reverse.aspx macht nicht nur Autorisierungen, sondern IMMER DEN LETZTEN TRANSAKTIONSSCHRITT rückgängig.

Abfragen des Transaktionsstatus basierend auf der PayID sind über eine Server-zu-Server-Kommunikation möglich. Um den Status einer Transaktion über eine Server-zu-Server-Verbindung abzufragen (englisch: inquire), verwenden Sie bitte folgende URL:


Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

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 Computop. Additionally this parameter has to be passed in plain language too.

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

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

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

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

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

Parameter für Statusabfragen über Socket-Verbindungen


Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt:

(info) es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

(info) die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

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 Computop

HändlerID, die von Computop vergeben wird

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

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

Vom Paygate 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 Paygate

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

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

Status

a..50

M

OK or FAILED as status of inquiry and not of the requested transaction

OK oder FAILED als Status der Abfrage, nicht der angefragten Transaktion
Descriptiona,s..1024MFurther details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! It relates to the inquiry and not to the requested transaction.Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus! Bezieht sich auf die Abfrage und nicht auf die angefragte Transaktion.
Coden8MError code according to Paygate Response Codes (A4 Error codes). It relates to the inquiry and not to the requested transaction.
Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes). Bezieht sich auf die Abfrage und nicht auf die angefragte Transaktion.

Key

Format

CND

Description

Beschreibung

AmountAuth

n..10

O

Approved amount

Genehmigter Betrag

AmountCap

n..10

O

Captured amount

Gebuchter Betrag

AmountCred

n..10

O

Credited amount

Gutgeschriebener Betrag
Currencya3OCurrency code, three digits DIN / ISO 4217. For payment types that don´t have the "Currency" parameter nothing will be returned.Währungskürzel, drei Zeichen DIN / ISO 4217. Für Zahlungsarten ohne Parameter "Currency" wird nichts zurückgegeben.

LastStatus

a..50

O

Status of last transaction (Authorisation, Capture or Credit)

Status der letzten Transaktion (Autorisierung, Buchung oder Gutschrift)

Antwort-Parameter für Statusabfragen über Socket-Verbindungen


Hinweis: Der Parameter LastStatus reicht nicht aus, um den Status zu ermitteln, weil er nur den Status der letzten Transaktion liefert. Beispielsweise liefert LastStatus den Status Failed, wenn eine Gutschrift gescheitert ist, obwohl vorher Autorisierung und Buchung erfolgreich waren. Den genauen Status erfahren Sie über die Felder AmountAuth, AmountCap und AmountCred.



Statusabfragen per TransID

Abfragen des Transaktionsstatus basierend auf der TransID sind über eine Server-zu-Server-Kommunikation möglich. Um den Status einer Transaktion über eine Server-zu-Server-Verbindung abzufragen (englisch: inquire), verwenden Sie bitte folgende URL:


Hinweis: Aus Sicherheitsgründen lehnt das Paygate alle Zahlungsanfragen mit Formatfehlern ab. Bitte übergeben Sie deshalb bei jedem Parameter den korrekten Datentyp.

Die folgende Tabelle beschreibt die verschlüsselten Übergabeparameter:

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 Computop. Additionally this parameter has to be passed in plain language too.

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

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

Parameter für Statusabfragen über Socket-Verbindungen


Die folgende Tabelle beschreibt die Parameter, die das Paygate als Antwort zurückgibt:

(info) es können jederzeit neue Parameter hinzugefügt bzw. die Reihenfolge geändert werden

(info) die Parameter (z.B. MerchantId, RefNr) sollten nicht auf Groß-/Kleinschreibung geprüft werden

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 Computop

HändlerID, die von Computop vergeben wird

KeyFormatCNDDescriptionBeschreibung
PayID

an32

M

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

Vom Paygate 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 Paygate

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

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

Status

a..50

M

OK or FAILED as status of inquiry and not of the requested transaction

OK oder FAILED als Status der Abfrage, nicht der angefragten Transaktion
Descriptiona,s..1024MFurther details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! It relates to the inquiry and not to the requested transaction.Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus! Bezieht sich auf die Abfrage und nicht auf die angefragte Transaktion.
Coden8MError code according to Paygate Response Codes (A4 Error codes). It relates to the inquiry and not to the requested transaction.
Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes). Bezieht sich auf die Abfrage und nicht auf die angefragte Transaktion.

Key

Format

CND

Description

Beschreibung

AmountAuth

n..10

O

Approved amount

Genehmigter Betrag

AmountCap

n..10

O

Captured amount

Gebuchter Betrag

AmountCred

n..10

O

Credited amount

Gutgeschriebener Betrag
Currencya3OCurrency code, three digits DIN / ISO 4217. For payment types that don´t have the "Currency" parameter nothing will be returned.Währungskürzel, drei Zeichen DIN / ISO 4217. Für Zahlungsarten ohne Parameter "Currency" wird nichts zurückgegeben.

LastStatus

a..50

O

Status of last transaction (Authorisation, Capture or Credit)

Status der letzten Transaktion (Autorisierung, Buchung oder Gutschrift)
LastXCoden8O

Error code of last transaction according to Paygate Response Codes (A4 Error codes)

Fehlercode der letzten Transaktion gemäß Paygate Antwort-Codes (A4 Fehlercodes)

LastXAmountn..10OAmount in the smallest currency unit (e.g. EUR Cent)Betrag in der kleinsten Währungseinheit (z.B. EUR Cent)
CCBranda..22O

Credit card brand (e.g. Visa, MasterCard, Maestro etc.)

Returned only after configuration by Merchant Services (Computop Helpdesk).

Kreditkartenmarke (z.B. Visa, MasterCard, Maestro usw.)

Rückgabe nur nach Konfiguration durch Merchant Services (Computop Helpdesk).

Antwort-Parameter für Statusabfragen über Socket-Verbindungen


Hinweis: Der Parameter LastStatus reicht nicht aus, um den Status zu ermitteln, weil er nur den Status der letzten Transaktion liefert. Beispielsweise liefert LastStatus den Status Failed, wenn eine Gutschrift gescheitert ist, obwohl vorher Autorisierung und Buchung erfolgreich waren. Den genauen Status erfahren Sie über die Felder AmountAuth, AmountCap und AmountCred.