Documentation
Documentation
    • English (United States)
Payment Connector Configuration
Close API Documentation
Payment Connector Configuration
States
  • Create
    The create state indicates that the Payment Connector Configuration is in creation.
  • Active
    The active state indicates that the Payment Connector Configuration is active and may be used.
  • Inactive
    The inactive state indicates that the Payment Connector Configuration is inactive and may not be used.
  • Deleting
    The deleting state indicates that the Payment Connector Configuration is in the process to be deleted.
  • Deleted
    The deleted state marks the entity for purging from the database.
Properties
  • Applicable For Transaction Processing
    Whether this connector configuration is enabled for processing payments, taking into account the state of the processor and payment method configurations.
  • Conditions
    Conditions allow to define criteria that a transaction must fulfill in order for the connector configuration to be considered for processing the payment.
  • Connector
    The connector that the configuration is for.
  • Enabled Sales Channels
    The sales channels for which the connector configuration is enabled. If empty, it is enabled for all sales channels.
  • Enabled Space Views
    The space views for which the connector configuration is enabled. If empty, it is enabled for all space views.
  • ID
    A unique identifier for the object.
  • Image Path
    The URL to the connector's image.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Name
    The name used to identify the connector configuration.
  • Payment Method Configuration
    The payment method configuration that the connector configuration belongs to.
  • 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.
  • Priority
    The priority that determines the order in which connector configurations are taken into account when processing a payment. Low values are considered first.
  • Processor Configuration
    The processor configuration that the connector configuration belongs to.
  • State
    The object's current state.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.