Dokumentation
Dokumentation
Zahlungslink
Schliessen API Dokumentation
Zahlungslink

Der Zahlungslink definiert eine URL, welche automatisch Transaktionen erzeugt.

Payment links help to collect payments in cases where no backend is available for processing the payments on the merchant side. There is no need for any kind of server side programming by the merchant.

The payment is created by invoking a URL with specific parameters. The parameters are sent via a regular HTTP GET or POST request. For example, the billing address will be read from the parameters provided in the HTTP request to the payment link URL.

Zustände
  • Erstellen
    Der Status Create zeigt an dass der Typ Zahlungslink gerade erstellt wird.
  • Aktiv
    Der Status aktiv bedeutet, dass der Eintrag vom Typen 'Zahlungslink' aktiv ist und genutzt werden kann.
  • Inaktiv
    Der Status Inaktiv zeigt dass der Eintrag vom Typen Zahlungslink nicht genutzt wird.
  • Im Löschvorgang
    Der deleting Status bedeutet, dass der Eintrag vom Typen Zahlungslink gerade im Prozess der Löschung ist.
  • Gelöscht
    Der Gelöschte-Status markeiert den Eintrag für die Löschung aus der Datenbank.
Eigenschaften
  • Angewendeter Space View
    Der Zahlungslink kann an einen bestimmten Space View gebunden werden. Die Zahlung wird dann in diesem Space View ausgeführt. Der Space View kann ein anderes Design auf der Zahlungsseite erzwingen.
  • Artikel
    Die Belegpositionen des Zahlungslinks erlauben es, die Belegpositionen in der Zahlung vorzugeben. Wenn keine Belegpositionen angegeben werden, dann müssen diese via Zahlungslink übergeben werden.
  • Erlaubte Zahlungsmethodenkonfigurationen
    Die erlaubten Zahlungsmethodenkonfigurationen schränken die möglichen Zahlweisen für diesen Zahlungslink ein.
  • Externe ID
    Eine vom Client generierte eindeutige ID, welche die Entity identifiziert, die erzeugt werden soll. Nachfolgende Anfragen mit derselben externen ID werden keine neue Entity erzeugen sondern stattdessen die ursprünglich erzeugte zurück geben.
  • Geplantes Löschdatum
    Das Datum und die Uhrzeit, zu der das Objekt endgültig entfernt werden soll. Wenn der Wert leer ist, wird das Objekt nicht entfernt.
  • ID
    A unique identifier for the object.
  • Lieferadressbehandlung
    Die Lieferadressbehandlung steurt, ob die Rechnungsadresse angegeben werden muss.
  • Maximale Anzahl Transaktionen
    Die maximale Anzahl Transaktionen definiert, wie viele erfolgreiche Transaktionen mit diesem Zahlungslink maximal erzeugt werden können.
  • Name
    Der Zahlungslinkname wird intern für die Identifikation des Zahlungslinks verwendet. Er sollte daher eindeutig und beschreibend sein. Er wird zum Beispiel in Dropdowns usw. angezeigt.
  • Rechnungsadressbehandlung
    Die Rechnungsadressbehandlung steurt, ob die Rechnungsadresse angegeben werden muss.
  • Referenzierte Space ID
    Die ID des Raums, zu dem dieses Objekt gehört.
  • Schutzmodus
    Der Schutzmodus bestimmt, ob und wie der Zahlungslink vor Manipulationen geschützt ist.
  • Sprache
    Die Sprache des Zahlungslinks definiert, in welcher Sprache die Zahlungsseite angezeigt wird. Wenn keine Sprache definiert wird, dann kann diese über einen Request-Parameter definiert werden.
  • Status
    Der aktuelle Zustand des Objekts.
  • URL
    Die URL definiert die URL, auf welche der Käufer für die Zahlungsabwicklung weitergeleitet werden muss.
  • Verfügbar ab
    Das "Verfügbar ab"-Datum definiert den frühesten Zeitpunkt, ab welchem der Zahlungslink verwendet werden kann.
  • Verfügbar bis
    Das "Verfügbar bis"-Datum definiert das späteste Datum, bis zu welchem der Link verwendet werden kann.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.
  • Währung
    Die Währung definiert die Währung, in welcher die Zahlung ausgeführt wird. Wenn keine Währung definiert wird, dann muss diese als Parameter "Currency" übergeben werden.