Documentation
Payment Method Configuration

The payment method configuration builds the base to connect with different payment method connectors.

States
  • Create
    The create state indicates that the Payment Method Configuration is in creation.
  • Active
    The active state indicates that the Payment Method Configuration is active and may be used.
  • Inactive
    The inactive state indicates that the Payment Method Configuration is inactive and may not be used.
  • Deleting
    The deleting state indicates that the Payment Method Configuration is in the process to be deleted.
  • Deleted
    The deleted state marks the entity for purging from the database.
Properties
  • Configuration Name
    The payment method configuration name is used internally to identify the payment method configuration. For example the name is used within search fields and hence it should be distinct and descriptive.
  • Description
    The payment method configuration description can be used to show a text during the payment process. Choose an appropriate description as it will be displayed to your customer.
  • Id
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • Image Resource Path
    The image of the payment method configuration overrides the default image of the payment method.
  • Linked Space ID
    The linked space id holds the ID of the space to which the entity belongs to.
  • One-Click Payment Mode
    When the buyer is present on the payment page or within the iFrame the payment details can be stored automatically. The buyer will be able to use the stored payment details for subsequent transactions. When the transaction already contains a token one-click payments are disabled anyway
  • Payment Method
  • Payment data collection type
    The data collection type determines who is collecting the payment information. This can be done either by the processor (offsite) or by our application (onsite).
  • 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.
  • Resolved Description
    The resolved description uses the specified description or the default one when it is not overridden.
  • Resolved Image URL
    The resolved URL of the image to use with this payment method.
  • Resolved Title
    The resolved title uses the specified title or the default one when it is not overridden.
  • Sort Order
    The sort order of the payment method determines the ordering of the methods shown to the user during the payment process.
  • Space Id
  • State
  • Title
    The title of the payment method configuration is used within the payment process. The title is visible to the customer.
  • Version
    The version number indicates the version of the entity. The version is incremented whenever the entity is changed.