Documentation
Documentation
    • English (United States)
Processor Configuration
Close API Documentation
Processor Configuration

The processor configuration allows you to setup the settings for a particular processor.

It is possible to configure the same processor multiple times for different accounts. For example you may want to use one processor configuration to process transactions in USD and another for EUR.

States
  • Create
    The create state indicates that the Processor Configuration is in creation.
  • Active
    The active state indicates that the Processor Configuration is active and may be used.
  • Inactive
    The inactive state indicates that the Processor Configuration is inactive and may not be used.
  • Deleting
    The deleting state indicates that the Processor Configuration is in the process to be deleted.
  • Deleted
    The deleted state marks the entity for purging from the database.
Properties
  • Application-Managed
    Whether the processor configuration is managed by the application and therefore cannot be changed.
  • 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 payment method configuration.
  • Payment Contract ID
    The ID of the payment contract the processor configuration is linked 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.
  • Processor
    The payment processor that the configuration is for.
  • State
    The object's current state.

    A payment processor configuration can have the following states:

    Active

    When the state is set to Active the processor configuration can be chosen for setting up a connector configuration and will be used accordingly for the transaction.

    Inactive

    When the state is set to Inactive all the corresponding settings in the configuration are ignored. Hence, this will disable also the connector (or connectors) configurations where the processor was chosen which can not be used for any transaction. However, all the information is not deleted and you can reactivate the configuration at any moment.

    Deleting

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

    Deleted

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

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