Documentation
Payment Terminal
States
  • Create
    The terminal is being created.
  • Preparing
    The terminal is prepared. It is currently not ready to be used.
  • Active
    The terminal is active and it can be used to process payments.
  • Inactive
    The terminal is inactive and it cannot be used to process payments.
  • Decommissioning
    The terminal is taken out of operation and cannot be used to process payments.
  • Decommissioned
    The terminal is decommissioned and cannot be used for any further payments.
Properties
  • Configuration Version
  • Default Currency
  • Device Serial Number
  • External ID
    A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
  • ID
    A unique identifier for the object.
  • Identifier
    The identifier uniquely identifies the terminal. Normally it is visible on the device or in the display of the device.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Location Version
  • Name
    The terminal name is used internally to identify the terminal in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.
  • 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.
  • Type
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.