Documentation
Documentation
Terminal
Close API Documentation
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
    The configuration that is assigned to the terminal and determines how it works.
  • Default Currency
    The default currency of the terminal.
  • Device Name
    The name of the device that is currently linked to the payment terminal.
  • Device Serial Number
    The serial number of the device that is currently linked to the payment terminal.
  • External ID
    A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
  • ID
    A unique identifier for the object.
  • Identifier
    The unique identifier of the terminal, that is displayed on the device.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Location Version
    The physical location where the terminal is used.
  • Name
    The name used to identify the payment terminal.
  • 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
    The type of the payment terminal.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.