Paygate-Schnittstelle
Datenformate: 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: CND Bedingung (condition) M Pflicht (mandatory) O optional C bedingt (conditional) Hinweis: Bitte beachten Sie, dass die Bezeichnungen der Parameter in Groß- oder Kleinbuchstaben zurückgegeben werden können.Definitionen
Format Beschreibung Abkürzung Beschreibung Kommentar Wenn ein Parameter Pflicht ist, dann muss er vorhanden sein Wenn ein Parameter optional ist, dann kann er vorhanden sein, ist aber nicht erforderlich Wenn ein Parameter bedingt ist, dann gibt es eine Bedingungsregel, die angibt, ob er Pflicht oder optional ist
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:
Parameter | Format | CND | Beschreibung |
|---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
PayID | an32 | M | Vom Paygate vergebene ID zur Identifizierung einer Transaktion |
TransID | ans..64 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
Parameter für Statusabfragen über Socket-Verbindungen
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort zurückgibt:
Parameter | Format | CND | Beschreibung | |
|---|---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird | |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien | |
XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden | |
TransID | ans..64 | M | Transaktionsnummer des Händlers | |
Status | a..50 | M | OK oder FAILED als Status der Abfrage, nicht der angefragten Transaktion | |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der der Abfrage, nicht der angefragten Transaktion. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! | |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) für die Abfrage, nicht die angefragte Transaktion | |
AmountAuth | n..10 | O | Genehmigter Betrag | |
AmountCap | n..10 | O | Gebuchter Betrag | |
AmountCred | n..10 | O | Gutgeschriebener Betrag | |
LastStatus | a..50 | O | 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:
Parameter | Format | CND | Beschreibung |
|---|---|---|---|
MerchantID | ans..30 | M | HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben. |
TransID | ans..64 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
Parameter für Statusabfragen über Socket-Verbindungen
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate als Antwort zurückgibt:
Parameter | Format | CND | Beschreibung |
|---|---|---|---|
MID | ans..30 | M | HändlerID, die von Computop vergeben wird |
PayID | an32 | M | Vom Paygate vergebene ID für die Zahlung, z.B. zur Referenzierung in Batch-Dateien |
XID | an32 | M | Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden |
TransID | ans..64 | M | Transaktionsnummer des Händlers |
Status | a..50 | M | OK oder FAILED als Status der Abfrage, nicht der angefragten Transaktion |
Description | ans..1024 | M | Nähere Beschreibung bei Ablehnung der Abfrage, nicht der angefragten Transaktion. Bitte nutzen Sie nicht den Parameter Description sondern Code für die Auswertung des Transaktionsstatus! |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) für die Abfrage, nicht die angefragte Transaktion |
AmountAuth | n..10 | O | Genehmigter Betrag |
AmountCap | n..10 | O | Gebuchter Betrag |
AmountCred | n..10 | O | Gutgeschriebener Betrag |
LastStatus | a..50 | O | Status der letzten Transaktion (Autorisierung, Buchung oder Gutschrift) |
LastXCode | n8 | O | Fehlercode der letzten Transaktion gemäß Excel-Datei Paygate Antwort Codes (Teil des Software Clients auf https://www.computop.com/de/downloads/) |
LastXAmount | n..10 | O | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent) |
| CCBrand | a..22 | O | Kreditkartenmarke (z.B. Visa, MasterCard, Maestro usw.) Rückgabe nur nach Konfiguration durch Merchant Services (helpdesk@computop.com). |
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.