Documentation
Condition

A condition configuration controls under which condition a payment connector is applied to a transaction.

A condition allows to formulate a selection criteria on a transaction. This means a condition can initiate a decision based on a given transaction.

Such a condition can be used for selecting payment connector configurations or charge flow.

A condition can based on different properties of the transaction. For example the condition can select based on the transaction amount or the billing country. A complete list of all condition types can be found here.

States
  • Create
    The create state indicates that the Condition is in creation.
  • Active
    The active state indicates that the Condition is active and may be used.
  • Inactive
    The inactive state indicates that the Condition is inactive and may not be used.
  • Deleting
    The deleting state indicates that the Condition is in the process to be deleted.
  • Deleted
    The deleted state marks the entity for purging from the database.
Properties
  • Condition Name
    The condition name is used internally to identify the condition. For example the name is used within search fields and hence it should be distinct and descriptive.
  • Condition Type
    The selected condition type defines how the configuration is applied to the transactions.

    Once a condition type is set on the condition it cannot be changed anymore. If you want to change the condition type you need to delete the old one and create a new condition.

  • Id
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • Linked Space ID
    The linked space id holds the ID of the space to which the entity belongs to.
  • Planned Purge Date
    The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.
  • State

    A payment condition can have the following states:

    Active

    When the state is set to Active this condition will define the restrictions applied to the transaction

    Inactive

    When the state is set to Inactive the condition will be ignored during the selection of a transaction. E.g. any constraints defined by condition will be ignored.

    Deleting

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

    Deleted

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

  • Version
    The version number indicates the version of the entity. The version is incremented whenever the entity is changed.