Produktbereich
CMPro / CPWeb
Problem
Sie möchten Zahlungen, die bisher außerhalb von CMPro / CPWeb laufen, zum Beispiel Auszahlungen aus Ihrer eigenen Plattform, direkt über eine Schnittstelle übergeben, damit alle Zahlungen dieselbe Freigabelogik durchlaufen.
Dafür steht die REST API von Alevate Payments zur Verfügung. Sie überträgt Zahlungsdateien an das System und liefert Kontoauszugsinformationen zurück.
Zahlungsdateien senden: wahlweise als vertraulich gekennzeichnet
Kontoauszugsinformationen abrufen: zu einer angegebenen Bankkontokennung
Kontoauszugsposten abrufen: zu einer angegebenen Kontoauszugskennung
Ohne Lizenzeintrag ist die Kommunikation über die REST API nicht möglich. Die Endpunkte sind zudem nur für ein authentifiziertes Benutzerkonto erreichbar.
Lösungsschritte
Lassen Sie prüfen, ob für Ihr System ein Lizenzeintrag für die REST-API-Kommunikation vorhanden ist. Fehlt er, wenden Sie sich an Ihren Serrala-Ansprechpartner; die Lizenzkosten werden dort geklärt.
Verwenden Sie ein Benutzerkonto, das über das Recht zur API-Kommunikation verfügt. Jede Anfrage an die Endpunkte setzt ein solches Konto voraus.
Rufen Sie Systemdaten – Pfadüberwachung auf und legen Sie eine neue Pfadüberwachung vom Typ API Monitoring an. Der Benutzer benötigt dafür das Recht, Pfadüberwachungen anzulegen und zu bearbeiten.
Legen Sie im Register API Monitoring je Zahlungsformat einen eigenen Eintrag an.
Setzen Sie den Parameter SystemId als Kennung des Quellsystems. Zusammen mit dem Parameter format ordnet das System eingehende Zahlungsdateien der konfigurierten Einstellung zu.
Führen Sie die Kommunikation über HTTPS. Die REST API unterstützt https-Verschlüsselung vollständig.
Setzen Sie beim Senden vertraulicher Zahlungsdateien das Kennzeichen confidential. Diesen Zahlungsaufträgen wird ein Standard-Berechtigungsprofil zugeordnet, sodass nur Benutzer mit den entsprechenden Rechten damit arbeiten können.
Ergebnis:
Zahlungen aus dem Quellsystem werden über die REST API übergeben und durchlaufen dieselbe Freigabelogik wie die übrigen Zahlungen.
Zu jeder erfolgreich angenommenen Zahlung wird eine eindeutige Tracking-Kennung zurückgegeben; sie lässt sich im System anzeigen und erlaubt die Nachverfolgung in beiden Systemen.
Der Verarbeitungsstatus lässt sich über die Statusverfolgung der Transferaufträge verfolgen.
Bekannte Einschränkungen
Ein Benutzerkonto mit dem Recht zur API-Kommunikation kann Daten aller Konten lesen. Berücksichtigen Sie das bei der Vergabe des Rechts.
Fällt der Dienst der Pfadüberwachung vorübergehend aus, werden die im Eingang aufgelaufenen Dateien nach dem Neustart in der Reihenfolge ihres Eingangs verarbeitet.
Die technische Beschreibung der Endpunkte einschließlich Request- und Response-Format gehört zur API-Dokumentation. Sie erhalten sie beim Serrala-Produktsupport.