Documentation
Documentation
    • English (United States)
Payment Connector Condition
Close API Documentation
Payment Connector Condition

A condition allows you to define a criteria that a transaction must fulfill in order for a connector configuration to be considered for processing the payment.

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 Payment Connector Condition is in creation.
  • Active
    The active state indicates that the Payment Connector Condition is active and may be used.
  • Inactive
    The inactive state indicates that the Payment Connector Condition is inactive and may not be used.
  • Deleting
    The deleting state indicates that the Payment Connector Condition is in the process to be deleted.
  • Deleted
    The deleted state marks the entity for purging from the database.
Properties
  • Condition Type
    The condition type determines the criteria that a transaction must fulfill in order for a connector configuration to be considered for processing the payment.

    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
    A unique identifier for the object.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Name
    The name used to identify the condition.
  • Planned Purge Date
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • State
    The object's current 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 is used for optimistic locking and incremented whenever the object is updated.