Über Sofort
Allgemeines zur Sofort
Sofort zählt zu den Online-Direktüberweisungsverfahren und funktioniert auf Basis des bewährten Online-Banking. Ein großer Vorteil ist: Der Käufer muss sich nicht erst registrieren oder ein virtuelles Konto, ein sogenanntes Wallet, anlegen. Wie der Name schon sagt, handelt es sich um eine sofortige Überweisung, also eine Direktüberweisung. Dazu wählt der Käufer bei seinem Online-Einkauf Sofort als Zahlungsmöglichkeit aus und wird dann auf das gesicherte Zahlformular weitergeleitet. Die Überweisungsdaten werden automatisch übernommen und der Käufer muss nur noch seine Bank wählen sowie seine gewohnten Zugangsdaten für das Online-Banking eingeben. Abschließend gibt er die Überweisung mit einem Bestätigungscode frei. Die Daten werden verschlüsselt an das Online-Banking Konto übermittelt. Der Onlinehändler erhält eine Echtzeitbestätigung über die Eingabe der Überweisung im Online-Banking des Käufers. Daher kann der Händler die Bestellung sofort bearbeiten, versenden und die Waren/Dienstleistungen schneller liefern. Somit entfällt eine Wartezeit bis zum Versand der Waren, wie etwa bei der Vorkasse per Banküberweisung.
Wie beim Online-Banking üblich, sind auch bei Sofort die übermittelten Daten mit SSL (Secure Sockets Layer) verschlüsselt.
Weitere Informationen finden Sie auch auf der Webseite der Sofort unter https://www.sofort.com/ger-DE/verkaeufer/su/e-payment-sofort-ueberweisung.
Diagramm zum Prozessablauf
Prozessablauf für Sofort im Paygate
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
Aufruf der Schnittstelle
Um eine Online-Überweisung mit Sofort über PPRO abzuwickeln, rufen Sie folgende URL auf:
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 | |
RefNr | ans..40 | O | Eindeutige Referenznummer. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt. | |
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent) Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge < 100 (kleinste Währungseinheit) buchen möchten. | |
Currency | a3 | M | Drei Zeichen DIN / ISO 4217. Nur EUR zulässig. | |
OrderDesc | ans..384 | M | Verwendungstext auf dem Kontoauszug des Kunden. Hinweis: Nur die ersten 27 Zeichen erscheinen auf dem Kontoauszug des Kunden. In Computop Analytics können Sie die Daten komplett einsehen. | |
AccOwner | as..50 | M | Name des Kontoinhabers | |
IBAN | an..34 | O | IBAN des Nutzers, die voreingestellt im Überweisungsfenster erscheint (nur für DE möglich) | |
BIC | an..11 | O | BIC des Nutzers, die voreingestellt im Überweisungsfenster erscheint | |
AddrCountryCode | a2 | M | Ländercode zweistellig gemäß ISO 3166. Derzeit DE, AT, BE, NL, ES, CH, PL, IT zulässig. | |
Language | a2 | O | Sprache: de - deutsch, en – Englisch, fr- Französisch, nl - Niederländisch, pl - Polnisch | |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus | |
URLSuccess | ans..256 | M | Vollständige URL, die das Paygate aufruft, wenn die Zahlung erfolgreich war. Die URL darf nur über Port 443 aufgerufen werden. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen, nutzen Sie stattdessen den Parameter UserData. | |
URLFailure | ans..256 | M | Vollständige URL, die das Paygate aufruft, wenn die Zahlung gescheitert ist. Die URL darf nur über Port 443 aufgerufen werden. Diese URL darf keine Parameter enthalten: Um Parameter durchzureichen, nutzen Sie stattdessen den Parameter UserData. | |
Response | a7 | O | Die Status-Rückmeldung, die das Paygate an URLSuccess und URLFailure sendet, sollte verschlüsselt werden. Dazu übergeben Sie den Parameter Response=encrypt. | |
URLNotify | ans..256 | M | Vollständige URL, die das Paygate aufruft, um den Shop zu benachrichtigen. Die URL darf nur über Port 443 aufgerufen werden. Sie darf keine Parameter enthalten: Nutzen Sie stattdessen den Parameter UserData. | |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate die Parameter mit dem Zahlungsergebnis an den Shop | |
ReqID | ans..32 | O | Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion mit derselben ReqID erneut eingereicht wird, führt das Paygate keine Zahlung aus sondern gibt nur den Status der ursprünglichen Transaktion zurück. Bitte beachten Sie, dass das Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. | |
SellingPoint | ans..50 | O | Verkaufsstelle | |
Service | ans..50 | O | verkaufte Produkte oder Dienstleistung | |
Channel | ans..64 | O | Konfigurationskanal des PPRO-Vertrags (Account und ContractID sind im System hinterlegt). Wenn vorhanden, überschreibt er eventuell im System hinterlegten Channel. | |
Language | a2 | O | 2-stelliger Sprachcode (z.B. de), der für die Zahlungsseiten für den Kunden bevorzugt werden soll | |
Plain | ans..50 | O | Ein von Händler zu setzender Wert, um Informationen wieder unverschlüsselt zurückzugeben, z.B. die MID | |
Custom | ans..1024 | O | Der Händler kann mehrere Werte durch | getrennt übergeben, die unverschlüsselt durch & getrennt zurückgegeben werden. Custom=session=123|id=456 wird in der Antwort zu Session=123&id=456 |
Parameter für Sofort über PPRO
Die folgende Tabelle beschreibt die Ergebnis-Parameter, die das Paygate an Ihre URLSuccess, URLFailure und URLNotify übergibt. Wenn Sie den Parameter Response=encrypt angegeben haben, werden die folgenden Parameter mit Blowfish verschlüsselt an Ihr System übergeben:
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 AUTHORIZED (URLSuccess) sowie FAILED oder AUTHORIZE_REQUEST (URLFailure) | |
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! | |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) | |
RefNr | ans..40 | O | Eindeutige Referenznummer. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt. | |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus | |
UserData | ans..1024 | O | Wenn beim Aufruf angegeben, übergibt das Paygate den Parameter mit dem Zahlungsergebnis an den Shop | |
PaymentPurpose | ans..26 | M | Zahlungszweck | |
PaymentGuarantee | a..12 | C | NONE = keine Zahlungsgarantie, VALIDATED = Kundenkonto valide, aber keine Zahlungsgarantie, FULL = Zahlungsgarantie Hinweis: Dieser Parameter wird nur zurückgegeben, falls der Status=OK ist. | |
ErrorText | ans..256 | C | Detaillierte PPRO Fehlermeldung. Hinweis: Wird nur bei Status=FAILED zurückgegeben. Nutzung nur in Abstimmung mit dem Computop Support möglich. | |
TransactionID | an..20 | O | Eindeutige Transaktionsnummer bei PPRO | |
AccOwner | as..50 | O | Name des Kontoinhabers | |
AccBank | ans..50 | O | Bezeichnung der Bank des Kontoinhabers | |
IBAN | an..34 | O | International Bank Account Number | |
BIC | an..11 | O | Bank Identifier Code | |
Plain | ans..50 | O | Ein von Händler zu setzender Wert, um Informationen wieder unverschlüsselt zurückzugeben, z.B. die MID | |
Custom | ans..1024 | O | Der Händler kann mehrere Werte durch | getrennt übergeben, die unverschlüsselt durch & getrennt zurückgegeben werden. Custom=session=123|id=456 wird in der Antwort zu Session=123&id=456 |
Ergebnis-Parameter für URLNotify, URLSuccess und URLFailure bei Sofort über PPRO
Gutschrift zu Sofort
Gutschriften sind über eine Server-zu-Server-Kommunikation möglich. Bei einer Gutschrift mit Bezug auf eine Buchung ist die Höhe der Gutschrift auf die Höhe der vorherigen Buchung beschränkt.
Um eine Gutschrift mit Referenztransaktion auszuführen, 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 | ID des Paygate zur Identifizierung einer Zahlung |
TransID | ans..64 | M | Vom Händler initial vergebene ID für den gutzuschreibenden Zahlungsvorgang |
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent) Bitte wenden Sie sich an den Helpdesk, wenn Sie Beträge <100 (kleinste Währungseinheit) buchen möchten. |
Currency | a3 | M | Drei Zeichen DIN / ISO 4217. |
MAC | an64 | M | Hash Message Authentication Code (HMAC) mit SHA-256-Algorithmus |
ReqID | ans..32 | O | Um Doppelzahlungen zu vermeiden, übergeben Sie einen alphanumerischen Wert, der Ihre Transaktion identifiziert und nur einmal vergeben werden darf. Falls die Transaktion mit derselben ReqID erneut eingereicht wird, führt das Paygate keine Zahlung aus sondern gibt nur den Status der ursprünglichen Transaktion zurück. Bitte beachten Sie, dass das Paygate für die erste initiale Aktion einen abgeschlossenen Transaktionsstatus haben muss. Einreichungen mit identischer ReqID auf einen offenen Status werden regulär verarbeitet. |
Parameter für Gutschriften über Socket-Verbindungen
Die folgende Tabelle beschreibt die 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. Wichtig für spätere Referenzierung. |
XID | an32 | M | Vom Paygate vergebene ID für die Transaktion der Zahlung |
TransID | ans..64 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
Status | a..50 | MC | OK oder FAILED |
Description | a..1024 | M | Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description sondern Code zur Auswertung des Transaktionsstatus! |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
Antwort-Parameter bei Gutschriften für Sofort über Socket-Verbindungen
Batch-Nutzung der Schnittstelle
Grundsätzliche Informationen zur Arbeit mit Batch-Dateien sowie zu deren Aufbau erfahren Sie im separaten Handbuch zum Batchmanager. Im Batch-Verfahren sind nicht alle Funktionen verfügbar, die für die Online-Schnittstelle verfügbar sind.
Dieses Kapitel beschreibt die Parameter, die Sie im Datensatz (Record) für die Ausführung einer Gutschrift für Sofort übergeben müssen und welche Informationen Sie der Antwort-Datei über den Status des Zahlungsvorgangs entnehmen können.
Folgende Tabelle gibt eine Übersicht der pro Aktion jeweils möglichen Batch-Versionen und ihrer Besonderheiten:
Aktion | Version | Beschreibung |
---|---|---|
Credit | 1.0 / 2.0 | Standardversion ohne Rückgabe von Code |
| 1.x / 2.x | mit RefNr (gilt für alle Versionen außer 1.0) |
Beschreibung der möglichen Batch-Versionen
Der Aufbau für Sofort in einer einzureichenden Batch-Datei sieht folgendermaßen aus:
HEAD,<MerchantID>,<Date>,<Version> FOOT,<CountRecords>,<SumAmount> |
Beispiel für Master MID Funktion:
HEAD,[Master]MerchantID,Date,2.x Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action) FOOT,CountRecords,SumAmount |
Die folgende Tabelle beschreibt die einzelnen Felder und Werte, die im Datensatz (Record) innerhalb der Batch-Datei verwendet werden:
Parameter | Format | CND | Beschreibung |
---|---|---|---|
Type | a..11 | M | HEAD für Header, FOOT für Footer, SOFORT für Sofort |
Action | a..20 | M | Der Action-Parameter definiert die Art der Transaktion: Credit (Gutschrift) |
Amount | n..10 | M | Betrag in der kleinsten Währungseinheit (z.B. EUR Cent) |
Currency | a3 | M | Drei Zeichen DIN / ISO 4217 |
TransID | ans..64 | M | TransaktionsID, die für jede Zahlung eindeutig sein muss |
RefNr | ans..40 | O | Eindeutige Referenznummer. Nur die Zeichen a-zA-Z0-9,-_ sind erlaubt. |
PayID | an32 | M | Vom Paygate vergebene ID für diese Transaktion |
Beschreibung der Felder im Datensatz von Batch-Dateien
Der Record-Bereich in der Antwort-Datei zu Batch-Transaktionen sieht folgendermaßen aus:
SOFORT,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> |
Die folgende Tabelle beschreibt die Antwort-Parameter, die der Batch-Manager im Record-Bereich zu jeder Transaktion speichert (hier nicht erklärte Standardparameter wie etwa <TransID> oder <RefNR> entsprechen dem Aufruf wie vorstehend angegeben):
Parameter | Format | CND | Beschreibung |
---|---|---|---|
Action | a..20 | M | Der Action-Parameter definiert die Art der Transaktion: Credit (Gutschrift). |
PayID | an32 | M | Vom Paygate vergebene ID für diese Transaktion |
Status | a..50 | M | OK oder FAILED |
Code | n8 | M | Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes) |
Beschreibung der Ergebnis-Parameter im Datensatz von Batch-Dateien