Paygate-Schnittstelle

Definitionen

Datenformate

Format	Beschreibung
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ürzung	Beschreibung	Kommentar
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:

https://www.computop-paygate.com/inquire.aspx

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:

Key	Format	CND	Beschreibung
MerchantID	ans..30	M	HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

Key	Format	CND	Beschreibung
PayID	an32	M	Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

Key	Format	CND	Beschreibung
TransID	ans..64	M	Ihre 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:

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

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

Key	Format	CND	Beschreibung
mid	ans..30	M	HändlerID, die von Computop vergeben wird

Key	Format	CND	Beschreibung
PayID	an32	M	Vom Paygate vergebene ID für die Zahlung; z.B. zur Referenzierung in Batch-Dateien sowie im Capture- oder Credit-Request.

Key	Format	CND	Beschreibung
XID	an32	M	Vom Paygate vergebene ID für alle einzelnen Transaktionen (Autorisierung, Buchung, Gutschrift), die für eine Zahlung durchgeführt werden

Key	Format	CND	Beschreibung
TransID	ans..64	M	Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Key	Format	CND	Beschreibung
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 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.
Code	n8	M	Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes). Bezieht sich auf die Abfrage und nicht auf die angefragte Transaktion.

Key	Format	CND	Beschreibung
CustomerId	an1..64	C	Vom Händler bei einer Zahlung übermittelte Kundenkennung
CustomerReferenceId	an32	C	Kundenkennung, die vom Paygate zugewiesen wird, sobald die Kundendaten im Paygate gespeichert werden. Gilt nur, wenn der Dienst „Kundendatenspeicherung“ aktiv ist.
AmountAuth	n..10	O	Genehmigter Betrag
AmountCap	n..10	O	Gebuchter Betrag
AmountCred	n..10	O	Gutgeschriebener Betrag
Currency	a3	O	Währungskürzel, drei Zeichen DIN / ISO 4217. Für Zahlungsarten ohne Parameter "Currency" wird nichts zurückgegeben.
LastStatus	a..50	O	Status der letzten Transaktion (Autorisierung, Buchung oder Gutschrift)
WalletID	ans..128	C	Bei Wero: Von EPI bereitgestellte Wallet-ID, die die während einer Wero-Zahlung verwendete Verbraucher-Wallet identifiziert
PayType	ans..128	C	Bei Wero: Beschreibt die Art der durchgeführten Zahlung, z. B. Einmalzahlung oder ereignisabhängige Zahlung usw.
WeroConsentId	ans..128	C	Bei Wero: Von EPI vergebene Consent-ID
WeroPaymentId	ans..128	C	Bei Wero: Von EPI vergebene Zahlungsanforderungs-ID
WeroCaptureId	ans..128	C	Bei Wero: Von EPI vergebene Capture-ID
WeroRefundId	ans..128	C	Bei Wero: Von EPI vergebene Refund-ID

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:

https://www.computop-paygate.com/inquire24.aspx