StripeAPI.Types.Terminal_Reader

Contains the types generated from the schema Terminal_Reader

Documentation

data Terminal'reader

Defines the object schema located at components.schemas.terminal.reader in the specification.

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 Terminal'readerLocation'Variants

  location: The location identifier of the reader.

• terminal'readerMetadata :: Object

  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'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.Terminal_Reader

Methods

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

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

Show Terminal'reader

Defined in StripeAPI.Types.Terminal_Reader

Methods

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

show :: Terminal'reader -> String

showList :: [Terminal'reader] -> ShowS

ToJSON Terminal'reader

Defined in StripeAPI.Types.Terminal_Reader

Methods

toJSON :: Terminal'reader -> Value

toEncoding :: Terminal'reader -> Encoding

toJSONList :: [Terminal'reader] -> Value

toEncodingList :: [Terminal'reader] -> Encoding

FromJSON Terminal'reader

Defined in StripeAPI.Types.Terminal_Reader

Methods

parseJSON :: Value -> Parser Terminal'reader

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

mkTerminal'reader

Arguments

:: Terminal'readerDeviceType'

terminal'readerDeviceType

-> Text

terminal'readerId

-> Text

terminal'readerLabel

-> Bool

terminal'readerLivemode

-> Object

terminal'readerMetadata

-> Text

terminal'readerSerialNumber

-> Terminal'reader

Create a new Terminal'reader with all required fields.

data Terminal'readerDeviceType'

Defines the enum schema located at components.schemas.terminal.reader.properties.device_type in the specification.

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

Constructors

Terminal'readerDeviceType'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

Terminal'readerDeviceType'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

Terminal'readerDeviceType'EnumBbposChipper2x

Represents the JSON value "bbpos_chipper2x"

Terminal'readerDeviceType'EnumVerifoneP400

Represents the JSON value "verifone_P400"

Instances

Eq Terminal'readerDeviceType'

Defined in StripeAPI.Types.Terminal_Reader

Methods

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

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

Show Terminal'readerDeviceType'

Defined in StripeAPI.Types.Terminal_Reader

Methods

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

show :: Terminal'readerDeviceType' -> String

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

ToJSON Terminal'readerDeviceType'

Defined in StripeAPI.Types.Terminal_Reader

Methods

toJSON :: Terminal'readerDeviceType' -> Value

toEncoding :: Terminal'readerDeviceType' -> Encoding

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

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

FromJSON Terminal'readerDeviceType'

Defined in StripeAPI.Types.Terminal_Reader

Methods

parseJSON :: Value -> Parser Terminal'readerDeviceType'

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

data Terminal'readerLocation'Variants

Defines the oneOf schema located at components.schemas.terminal.reader.properties.location.anyOf in the specification.

The location identifier of the reader.

Constructors

Terminal'readerLocation'Text Text

Terminal'readerLocation'Terminal'location Terminal'location

Instances

Eq Terminal'readerLocation'Variants

Defined in StripeAPI.Types.Terminal_Reader

Methods

(==) :: Terminal'readerLocation'Variants -> Terminal'readerLocation'Variants -> Bool

(/=) :: Terminal'readerLocation'Variants -> Terminal'readerLocation'Variants -> Bool

Show Terminal'readerLocation'Variants

Defined in StripeAPI.Types.Terminal_Reader

Methods

showsPrec :: Int -> Terminal'readerLocation'Variants -> ShowS

show :: Terminal'readerLocation'Variants -> String

showList :: [Terminal'readerLocation'Variants] -> ShowS

ToJSON Terminal'readerLocation'Variants

Defined in StripeAPI.Types.Terminal_Reader

Methods

toJSON :: Terminal'readerLocation'Variants -> Value

toEncoding :: Terminal'readerLocation'Variants -> Encoding

toJSONList :: [Terminal'readerLocation'Variants] -> Value

toEncodingList :: [Terminal'readerLocation'Variants] -> Encoding

FromJSON Terminal'readerLocation'Variants

Defined in StripeAPI.Types.Terminal_Reader

Methods

parseJSON :: Value -> Parser Terminal'readerLocation'Variants

parseJSONList :: Value -> Parser [Terminal'readerLocation'Variants]