Documentation
Documentation
Payment Terminal
Close API 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
  • 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
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • 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 linked space id holds the ID of the space to which the entity 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 planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.
  • State
  • Type
  • Version
    The version number indicates the version of the entity. The version is incremented whenever the entity is changed.