Documentation
Documentation
Payment Method Configuration
Close API Documentation
Payment Method Configuration
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
  • Data Collection Type
    The data collection type specifies how the payment information is collected.
  • Description
    A customer-facing custom description for the payment method.
  • ID
    A unique identifier for the object.
  • Image Resource Path
    The resource path to a custom image for the payment method, displayed to the customer for visual identification.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Name
    The name used to identify the payment method configuration.
  • One-Click Payment Mode
    The one-click payment mode determines whether the customer can save their payment details for later payments.
  • Payment Method
    The payment method that the configuration is for.
  • 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.
  • Resolved Description
    The description of the payment method displayed to the customer. If a custom description is defined, it will be used; otherwise, the default description of the payment method will be shown.
  • Resolved Image URL
    The URL to the image of the payment method displayed to the customer. If a custom image is defined, it will be used; otherwise, the default image of the payment method will be shown.
  • Resolved Title
    The title of the payment method displayed to the customer. If a custom title is defined, it will be used; otherwise, the default title of the payment method will be shown.
  • Sort Order
    When listing payment methods, they can be sorted by this number.
  • Space ID
    The ID of the space this object belongs to.
  • State
    The object's current state.
  • Title
    A customer-facing custom title for the payment method.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.