Dokumentation
Dokumentation
Charge Flow
Schliessen API Dokumentation
Charge Flow

A charge flow allows the charging of a customer without requiring direct contract with customer. The flow defines a sequence of levels. On each level we apply the following mechanisms to charge the costumer:

  • We try to use the token provided by the transaction to charge the costumer. If no token or a not initialized token is provided this step is skipped.

  • In case a payment method is configured which allows the charging without any user interaction (such as a bank transfer) we use this payment method for charging.

  • In case none of the mechanism above is working, a link is sent to the costumer. The email is asking the costumer to click on the link to complete the payment. The link is pointing to the payment page. There the customer can select any configured payment method and complete the transaction.

Since a charge flow consists of multiple charge flow level configurationsthe above process is repeated multiple times. The level configuration allows to specify the interval and the way those above steps are executed.

A space can contain multiple charge flows. The selection of the charge flow is done in the following way:

  • The flows are ordered by their priority

  • The flow which meets all conditions is selected

Once a flow is selected the flow is never changed for subsequent flow levels.

Zustände
  • Erstellen
    Der Status Create zeigt an dass der Typ Charge Flow gerade erstellt wird.
  • Aktiv
    Der Status aktiv bedeutet, dass der Eintrag vom Typen 'Charge Flow' aktiv ist und genutzt werden kann.
  • Inaktiv
    Der Status Inaktiv zeigt dass der Eintrag vom Typen Charge Flow nicht genutzt wird.
  • Im Löschvorgang
    Der deleting Status bedeutet, dass der Eintrag vom Typen Charge Flow 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
  • Bedingungen
    Falls alle Transaktionen die gewählten Bedingungen erfüllen, wird der Charge Flow für die Verarbeitung der Transaktionen verwendet. Falls die Bedingungen nicht erfüllt sind, wird der nächste Charge Flow ausgewählt. Die Sortierung erfolgt anhand der Priorität.
  • 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.
  • Name
    Der Name des Charge Flow wird intern zur Identifizierung der Konfiguration in administrativen Interfaces verwendet. Beispielsweise in Suchfeldern, weshalb er klar und deskriptiv sein sollte.
  • Priorität
    Die Priorität sortiert die Charge Flows. Die Priorität und die Bedingungen bestimmen zusammen die Selektion des Charge Flows. Ein Wechseln der Prioritäten wird sofort wirksam, auch für bereits gestartete Charge Flows.
  • Referenzierte Space ID
    Die ID des Raums, zu dem dieses Objekt gehört.
  • Status
    Der aktuelle Zustand des Objekts.

    A charge flow can have the following states:

    Active

    When the state is set to Active this charge flow will will be chosen for the transaction.

    Inactive

    When the state is set to Inactive this charge flow will not be chosen. However, all the information is kept and the charge flow can be reactivated at any moment.

    Deleting

    The charge flow is in the process of deletion. This may take some time until the charge flow is marked as Deleting before being marked as Deleted.

    Deleted

    The charge flow is deleted. Since the charge flow is linked with data which cannot be deleted immediately, we need to keep the charge flow until all the data can be removed.

  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.