StripeAPI.Types.TerminalReader

Contains the types generated from the schema TerminalReader

Documentation

data Terminal'reader

Defines the data type for the schema terminal.reader

A Reader represents a physical device for accepting payment details.

Related guide: Connecting to a Reader.

Constructors

Terminal'reader

Fields

• terminal'readerDeviceSwVersion :: Maybe Text

  device_sw_version: The current software version of the reader.

  Constraints:

  • Maximum length of 5000
• terminal'readerDeviceType :: Terminal'readerDeviceType'

  device_type: Type of reader, one of `bbpos_chipper2x` or `verifone_P400`.

• terminal'readerId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• terminal'readerIpAddress :: Maybe Text

  ip_address: The local IP address of the reader.

  Constraints:

  • Maximum length of 5000
• terminal'readerLabel :: Text

  label: Custom label given to the reader for easier identification.

  Constraints:

  • Maximum length of 5000
• terminal'readerLivemode :: Bool

  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

• terminal'readerLocation :: Maybe Text

  location: The location identifier of the reader.

  Constraints:

  • Maximum length of 5000
• terminal'readerMetadata :: Terminal'readerMetadata'

  metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

• terminal'readerObject :: Terminal'readerObject'

  object: String representing the object's type. Objects of the same type share the same value.

• terminal'readerSerialNumber :: Text

  serial_number: Serial number of the reader.

  Constraints:

  • Maximum length of 5000
• terminal'readerStatus :: Maybe Text

  status: The networking status of the reader.

  Constraints:

  • Maximum length of 5000

Instances

Eq Terminal'reader

Defined in StripeAPI.Types.TerminalReader

Methods

(==) :: Terminal'reader -> Terminal'reader -> Bool

(/=) :: Terminal'reader -> Terminal'reader -> Bool

Show Terminal'reader

Defined in StripeAPI.Types.TerminalReader

Methods

showsPrec :: Int -> Terminal'reader -> ShowS

show :: Terminal'reader -> String

showList :: [Terminal'reader] -> ShowS

ToJSON Terminal'reader

Defined in StripeAPI.Types.TerminalReader

Methods

toJSON :: Terminal'reader -> Value

toEncoding :: Terminal'reader -> Encoding

toJSONList :: [Terminal'reader] -> Value

toEncodingList :: [Terminal'reader] -> Encoding

FromJSON Terminal'reader

Defined in StripeAPI.Types.TerminalReader

Methods

parseJSON :: Value -> Parser Terminal'reader

parseJSONList :: Value -> Parser [Terminal'reader]

data Terminal'readerDeviceType'

Defines the enum schema terminal.readerDevice_type'

Type of reader, one of `bbpos_chipper2x` or `verifone_P400`.

Constructors

Terminal'readerDeviceType'EnumOther Value

Terminal'readerDeviceType'EnumTyped Text

Terminal'readerDeviceType'EnumStringBbposChipper2x

Terminal'readerDeviceType'EnumStringVerifoneP400

Instances

Eq Terminal'readerDeviceType'

Defined in StripeAPI.Types.TerminalReader

Methods

(==) :: Terminal'readerDeviceType' -> Terminal'readerDeviceType' -> Bool

(/=) :: Terminal'readerDeviceType' -> Terminal'readerDeviceType' -> Bool

Show Terminal'readerDeviceType'

Defined in StripeAPI.Types.TerminalReader

Methods

showsPrec :: Int -> Terminal'readerDeviceType' -> ShowS

show :: Terminal'readerDeviceType' -> String

showList :: [Terminal'readerDeviceType'] -> ShowS

ToJSON Terminal'readerDeviceType'

Defined in StripeAPI.Types.TerminalReader

Methods

toJSON :: Terminal'readerDeviceType' -> Value

toEncoding :: Terminal'readerDeviceType' -> Encoding

toJSONList :: [Terminal'readerDeviceType'] -> Value

toEncodingList :: [Terminal'readerDeviceType'] -> Encoding

FromJSON Terminal'readerDeviceType'

Defined in StripeAPI.Types.TerminalReader

Methods

parseJSON :: Value -> Parser Terminal'readerDeviceType'

parseJSONList :: Value -> Parser [Terminal'readerDeviceType']

data Terminal'readerMetadata'

Defines the data type for the schema terminal.readerMetadata'

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

Constructors

Terminal'readerMetadata'

Instances

Eq Terminal'readerMetadata'

Defined in StripeAPI.Types.TerminalReader

Methods

(==) :: Terminal'readerMetadata' -> Terminal'readerMetadata' -> Bool

(/=) :: Terminal'readerMetadata' -> Terminal'readerMetadata' -> Bool

Show Terminal'readerMetadata'

Defined in StripeAPI.Types.TerminalReader

Methods

showsPrec :: Int -> Terminal'readerMetadata' -> ShowS

show :: Terminal'readerMetadata' -> String

showList :: [Terminal'readerMetadata'] -> ShowS

ToJSON Terminal'readerMetadata'

Defined in StripeAPI.Types.TerminalReader

Methods

toJSON :: Terminal'readerMetadata' -> Value

toEncoding :: Terminal'readerMetadata' -> Encoding

toJSONList :: [Terminal'readerMetadata'] -> Value

toEncodingList :: [Terminal'readerMetadata'] -> Encoding

FromJSON Terminal'readerMetadata'

Defined in StripeAPI.Types.TerminalReader

Methods

parseJSON :: Value -> Parser Terminal'readerMetadata'

parseJSONList :: Value -> Parser [Terminal'readerMetadata']

data Terminal'readerObject'

Defines the enum schema terminal.readerObject'

String representing the object's type. Objects of the same type share the same value.

Constructors

Terminal'readerObject'EnumOther Value

Terminal'readerObject'EnumTyped Text

Terminal'readerObject'EnumStringTerminal'reader

Instances

Eq Terminal'readerObject'

Defined in StripeAPI.Types.TerminalReader

Methods

(==) :: Terminal'readerObject' -> Terminal'readerObject' -> Bool

(/=) :: Terminal'readerObject' -> Terminal'readerObject' -> Bool

Show Terminal'readerObject'

Defined in StripeAPI.Types.TerminalReader

Methods

showsPrec :: Int -> Terminal'readerObject' -> ShowS

show :: Terminal'readerObject' -> String

showList :: [Terminal'readerObject'] -> ShowS

ToJSON Terminal'readerObject'

Defined in StripeAPI.Types.TerminalReader

Methods

toJSON :: Terminal'readerObject' -> Value

toEncoding :: Terminal'readerObject' -> Encoding

toJSONList :: [Terminal'readerObject'] -> Value

toEncodingList :: [Terminal'readerObject'] -> Encoding

FromJSON Terminal'readerObject'

Defined in StripeAPI.Types.TerminalReader

Methods

parseJSON :: Value -> Parser Terminal'readerObject'

parseJSONList :: Value -> Parser [Terminal'readerObject']