API-Direktanbindung

Eine Anbindung über die paydirekt-API bietet Ihnen maximale Flexibilität sowie volle Kontrolle über alle paydirekt Features. Der große Vorteil, neben der Transparenz des Systems, sind somit die flexible und vollständige Nutzungsmöglichkeit der paydirekt Features unabhängig von Drittanbietern und deren Implementierungsstand.

Entscheiden Sie sich für API-Direktanbindung, liefert Ihnen die paydirekt-API die nötigen Informationen, um die Implementierung vollständig durchzuführen. Dank etablierter Standards (REST/JSON) sowie diverser SDK ist dies einfach und schnell durchführbar.

Um eine Zahlung mit paydirekt durchzuführen sind nur wenige Schritte notwendig:
1. Token erstellen
2. Checkout Anlage
3. Umleitung auf die paydirekt-Bezahlseite (Login)
4. Checkout Abfrage

checkout-flow

Abbildung: Vereinfachte Darstellung eines paydirekt-Standardcheckouts

Erläuterungen im Detail

1. Token erstellen

Für alle Requests gegen die paydirekt-API ist ein OAuth2 Access Token [RFC 6749 1.4] erforderlich. In diesem sind die Authentifizierungsinformationen des Aufrufers gespeichert. Ein Access Token wird durch Aufruf des Token Obtain-Endpoints durch Angabe des Grant Type api_key erzeugt und wird bei allen folgenden Requests im Request Header Authorization als Bearer angegeben.

Der Access Token hat eine begrenzte Gültigkeitsdauer von derzeit 60 Minuten. Nach Ablauf der Gültigkeit kann einfach ein neuer Access Token bezogen werden. Die Gültigkeitsdauer wird im Response des Access Token zurückgeliefert.

Bei Bedarf kann das aufrufende System mehrere Access Tokens gleichzeitig verwenden. Besteht das aufrufende System aus mehreren Knoten, so kann jeder Knoten für seine Anfragen einen eigenen Access Token verwenden. Es ist aus Performance-Gründen jedoch nicht gestattet, für jeden einzelnen Request einen neuen Access Token anzufordern.

2. Checkout Anlage

Um eine paydirekt-Zahlung durchzuführen legen Sie im paydirekt System einen neuen Checkout an. Dies erfolgt durch einen HTTP POST-Request (Checkout Anlage) mit den Bestell- und Transaktionsdaten (JSON). Nach erfolgreicher Datenübertragung wurde nun der gewünschte Checkout im paydirekt-System angelegt. Dieser ist über die nun vergebene checkoutId jederzeit identifizierbar.

Checkout-Konfigurator
Um ein korrektes JSON-Objekt zu erzeugen empfehlen wir die Nutzung unseres Checkout-Konfigurator. checkout-konfigurator

3. Umleitung auf die paydirekt-Bezahlseite (Login)

Wenn die soeben durchgeführte Checkout Anlage erfolgreich war, wird eine Checkout-Ressource angelegt, die einen approve-Link enthält. Dieser befindet sich innerhalb des JSON-Keys "_links". Auf diesen Link muss der Händler den Kunden per HTTP Redirect weiterleiten. Der Kunde kann sich dort in paydirekt einloggen und die Zahlung bestätigen.

Genauere Informationen finden Sie im Bereich - Approve-Link.

4. Checkout Abfrage

Ein zuvor angelegter Checkout kann und sollte über die GET-Methode aufgerufen werden, um den Status der Zahlung und andere Eigenschaften abzufragen, sowie um die Links zu weiteren Ressourcen, z. B. Captures und Refunds, zu ermitteln. Die Abfrage des Checkout kann zu jedem Zeitpunkt stattfinden.