Integrationsoptionen Direkter Aufruf an die API
Direkter Aufruf an die API | Novalnet-Dokumentation

 Direkter Aufruf an die API

Die direkte Einbindung der API ermöglicht eine nahtlose Kommunikation zwischen Ihrem Server und dem Server von Novalnet. Dieses Verfahren bietet ein hohes Maß an Kontrolle und Flexibilität, um Transaktionen zu verarbeiten und Zahlungsabläufe zu verwalten. Indem Sie die API direkt einsetzen, können Sie jeden Aspekt der Transaktionsverarbeitung und Datenübertragung kontrollieren. Dies ermöglicht Ihnen, an die Bedürfnisse Ihres Unternehmens angepasste Zahlungsarten und Funktionen anzubieten und das Zahlungserlebnis an Ihre Anforderungen anzupassen.

Falls Sie Zahlungen per Kredit- oder Debitkarte direkt über die API verarbeiten, kümmert sich Novalnet für Sie um die Einhaltung aller PCI-DSS Anforderungen. Falls Sie jedoch schon eine PCI-DSS Zertifizierung haben und Original-Kreditkartendaten übertragen müssen, kontaktieren Sie bitte technic@novalnet.de, um eine weitergehende Anleitung zu erhalten.

Wie funktioniert das?

Ein typischer Ablauf mit direkt eingebundener API:

  1. Aktivierte Zahlungsarten abfragen:
    • Verwenden Sie die API unter /merchant/detailsim Novalnet Admin-Portal, um eine Liste der für Ihren Account aktivierten Zahlungsarten zu erhalten. Beachten Sie, dass dies ein optionaler Schritt ist. Falls Sie sich schon sicher sind, was die Zahlungsbuttons oder die möglichen Zahlungsarten betrifft, die Sie anbieten wollen, können Sie mit Schritt 3 fortfahren.
  2. Zahlungsarten anzeigen:
    • Auf der Grundlage der Rückmeldung aus Schritt 1 zeigen Sie die verfügbaren Zahlungsarten auf Ihrer Checkout-Seite an.
  3. Holen Sie vorher die notwendigen Daten ein:
    • Stellen Sie sicher, dass Sie alle notwendigen Informationen sammeln, um die Transaktion erfolgreich durchzuführen, bevor Sie einen direkten Aufruf an die API ausführen. Zahlungsarten wie Kredit-/Debitkarten oder digitale Geldbörsen wie Apple Pay oder Google Pay, erfordern möglicherweise einen zusätzlichen Schritt vorher, um Kartendaten oder Sicherheitsinformationen vom Kunden einzuholen, bevor die Zahlung verarbeitet wird. Sehen Sie sich dazu bitte die Dokumentation zur Einbindung der gewünschten Zahlungsart an, um eine Anleitung zur Einrichtung dieser zusätzlichen Schritte zu erhalten.
  4. Holen Sie die notwendigen Informationen zum Kunden und zur Bestellung ein:
    • Für unterschiedliche Abläufe, was Zahlungen betrifft, stellen Sie bitte sicher, dass Sie die folgenden Daten bereit haben: Kundenname, Rechnungsadresse, Kundennummer, Bestellbetrag, Währung, und Bestellnummer. Beachten Sie, dass nicht alle Parameter Pflicht sind. Sehen Sie sich die Dokumentationmit einer vollständigen Liste der Parameter an und entscheiden Sie auf der Grundlage der Bedürfnisse Ihres Unternehmens, welche davon relevant sind.
  5. Stoßen Sie den Aufruf an die API an:
    • Sobald Sie die notwendigen Parameter vorbereitet haben, können Sie einen Zahlungsaufruf zur Verarbeitung an den Novalnet-Server anstoßen. Die direkten Aufrufe an die API unterstützen zwei Zahlungsabläufe abhängig von der jeweiligen Zahlungsart: direkte Zahlung oder Zahlung mit Umleitung.
      • Direkte Zahlungsarten: Methoden wie SEPA-Lastschrift oder Kauf auf Rechnung erfordern keine zusätzlichen Schritte zur Authentifizierung oder ein ausdrückliches Login. Diese Zahlungsarten werden direkt verarbeitet, ohne weitere Interaktion mit dem Kunden.
      • Zahlungsarten mit Umleitung: Verfahren wie Online-Überweisungen erfordern, dass sich Kunden in ihr Bankportal einloggen, um die Transaktion abzuschließen. Für diese Verfahren, müssen Sie zusätzliche Parameter mit übermitteln wie transaction.return_url und transaction.error_return_url, um anzugeben, wohin der Kunden nach dem Zahlungsablauf umgeleitet werden soll. Zur vollständigen Verarbeitung von Zahlungsarten mit Umleitung sehen Sie sich bitte diesen Link an, welche Ihnen mehr Informationen bietet.
    • Sie können außerdem zwischen den Endpunkten /payment oder /authorize wählen, abhängig davon, ob Sie die Beträge sofort oder später einziehen sollten. Der Endpunkt /payment verarbeitet die Zahlung sofort, während der Endpunkt /authorize die Beträge nur reserviert und einen Einzug zu einem späteren Zeitpunkt ermöglicht.
  6. Webhooks zur Verarbeitung von Nachrichten:
    • Verarbeiten Sie mit Webhooks Nachrichten und reagieren Sie auf diese, um die Transaktionen in Ihrem System auf dem neuesten Stand zu halten. Stellen Sie sicher, dass Ihr System die im Webhook übermittelten Informationen richtig interpretiert und reagiert, um genaue und aktuelle Transaktionsdatensätze zu behalten.

Wie implementiert man das?

Eine Reihe von API-Zugriffspunkten, die Ihnen ermöglichen, die Zahlungsaufrufe auszuführen

Basis-URL: https://payport.novalnet.de/v2
Funktion Endpoint Beschreibung
Zahlung /payment Dieser Aufruf bucht sofort den gewünschten Betrag. Der Zahlungsaufruf an die API entspricht einer sofortigen Autorisierung mit Einzug.
Autorisierung /authorize Wie der Name andeutet, wird bei diesem Aufruf nur die grundlegende Autorisierung ausgeführt und nicht sofort der Betrag gebucht. Ein Zahlungsaufruf zum Einzug ist notwendig, um den autorisierten Betrag später einzuziehen.
Einzug der Transaktion /transaction/capture Dieser Aufruf zieht die Beträge aus den abgeschlossenen Autorisierungen ein.
Rückerstattung einer Transaktion /transaction/refund Dieser Aufruf gibt Beträge zurück, welche schon durch eine Zahlung oder den Einzug einer Transaktion eingezogen wurden.
Aktualisierung einer Transaktion /transaction/update Dieser Aufruf aktualisiert die Eigenschaften einer existierenden Transaktion wie Betrag, Fälligkeitsdatum, Bestellnummer, etc.
Stornierung der Transaktion /transaction/cancel Dieser Aufruf wird eingesetzt, um den Einzug von Beträgen aus vorher abgeschlossenen Autorisierungen zu vermeiden.
Details zur Transaktion /transaction/details Dieser Aufruf ermöglicht es Ihnen, das Resultat einer vorher übermittelten Transaktion einzuholen, indem Sie die TID von Novalnet verwenden.
Abonnement-Update /subscription/update Dieser Aufruf aktualisiert die Attribute eines existierenden Abonnements wie den Betrag oder das Datum der nächsten wiederkehrenden Zahlung.
Abonnement aussetzen /subscription/suspend Dieser Aufruf setzt ein existierendes Abonnement aus.
Abonnement reaktivieren /subscription/reactivate Dieser Aufruf reaktiviert ein existierendes Abonnement, welches vorher ausgesetzt wurde.
Abonnement kündigen /subscription/cancel Dieser Aufruf storniert ein existierendes Abonnement.
Händler-Details /merchant/details Dieser Aufruf gibt die bei Novalnet aktivierten Zahlungsarten zurück, zusammen mit den entsprechenden Händlerdaten.
Ratenzahlung Abbrechen /instalment/cancel Dieser Aufruf wird eine existierende Ratenzahlung stornieren
Rechnungsstellung an den Endkunden /transaction/invoice Dieser Aufruf wird eingesetzt, um eine Rechnung als PDF-Datei für den Kunden zu generieren.
Einrichten des Webhooks /webhook/configure Dieser Aufruf wird eingesetzt um den URL für einen Webhook zur Verarbeitung von Nachrichten einzurichten.
Partner anlegen /affiliate/create Wie der Name andeutet, legt dieser Aufruf den Affiliate-Händler für den entsprechenden Inhaber an.
Kunden-Update /customer/update Diese Aktion aktualisiert die Daten eines Kunden für all dessen existierende Transaktionen.
Modul /module Diese Aktion wird eingesetzt, wenn das Betrugsprüfungsmodul aktiviert ist, ohne dass eine Transaktion abläuft.
Transaktionsliste /transaction/list Rufen Sie alle mit der Transaktion verbundenen Informationen ab, indem Sie den eindeutigen Bezeichner aus Ihrem Shop / von Ihrer Schnittstelle verwenden - die Bestellnummer. Die Suche auf Grundlage der Bestellnummer wird innerhalb des Projektbereichs durchgeführt und alle Transaktionen, welche dieser Bestellnummer zugeordnet werden können, werden zurückgegeben. Die Suche anhand der Bestellnummer kann maximal 30 aktuelle Transaktionen zurückgeben, welche mit dieser Bestellung verbunden sind.
Aktualisierung von Paymentlink /payment_link/update Mit der API für die Aktualisierung von Zahlungsverbindungen können Sie den Verbindungsstatus, das Ablaufdatum und den zu buchenden Betrag ändern, bis die Zahlung erfolgt ist.
Zahlungstoken Löschen /token/delete Mit dieser Aktion wird das vorhandene Zahlungs-Token gelöscht.
BIN-Suchdienst /bin/lookup Diese Funktion ermittelt anhand der angegebenen Transaktions ID (TID) Details zur BIN (Identifikationsnummer der kartenausgebenden Bank).
Einstellen von Inkassoverfahren /collection/cancel Diese Funktion ermöglicht es Händlern, ein aktives Inkassoverfahren oder eine offene Forderung zu stornieren, welche mit einer bestimmten Transaktions-ID verbunden ist.