Documentation
Documentation
Charge Flow
Fermer Documentation API
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.

États
  • Créer
    Le statut Create indique que le type Charge Flow est en cours de création.
  • Actif
    Le statut actif signifie que l’entrée du type «Charge Flow» est active et qu’elle peut être utilisée.
  • Inactif
    Le statut Inactif montre que l’entrée de type Charge Flow est inactive et qu’elle n’est peut-être pas utilisée.
  • En cours de suppression
    Le statut deleting indique que l’entrée du type Charge Flow est en cours de suppression.
  • Supprimé
    Le statut supprimé marque l’entrée pour la suppression de la base de données.
Propriétés
  • Conditions
    Si une transaction remplit toutes les conditions sélectionnées, le Charge Flow est utilisé pour traiter la transaction. Si les conditions ne sont pas remplies, le Charge Flow suivant sera sélectionné. La sélection se fait selon les priorités.
  • Date de suppression prévue
    La date et l'heure auxquelles il est prévu que l'objet soit définitivement supprimé. Si la valeur est vide, l'objet ne sera pas supprimé.
  • ID
    A unique identifier for the object.
  • ID du Space référencé
    L'ID de l'espace auquel appartient cet objet.
  • Nom
    Le nom du Charge Flow est utilisé en interne pour identifier la configuration dans les interfaces administratives. Ce nom est par exemple utilisé dans les champs de recherche. Il doit donc être clair et descriptif.
  • Priorité
    la priorité ordonne les Charge Flows. La priorité et les conditions définissent conjointement la sélection du Charge Flow. Une modification des priorités influe aussi immédiatement sur les Charge Flows déjà initiés.
  • Statut
    L'état actuel de l'objet.

    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.