Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.Terminal_Reader

Contains the types generated from the schema Terminal_Reader

6 types
2 values

Packagestripeapi-3.0.0.0
Exports8
LanguageHaskell2010
LicenceMIT
SourceTerminal_Reader.hs

datadata 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
- terminal'readerAction :: Maybe (Nullable Terminal'readerAction'NonNullable)
  action: The most recent action performed by the reader.
- terminal'readerDeviceSwVersion :: Maybe (Nullable 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_wisepad3`, `stripe_m2`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, or `simulated_wisepos_e`.
- terminal'readerId :: Text
  id: Unique identifier for the object.
  Constraints:
  - Maximum length of 5000
- terminal'readerIpAddress :: Maybe (Nullable 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 (Nullable Terminal'readerLocation'NonNullableVariants)
  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 (Nullable Text)
  status: The networking status of the reader.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq Terminal'readerDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Terminal_Reader
Show Terminal'readerDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Terminal_Reader
FromJSON Terminal'readerDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Terminal_Reader
ToJSON Terminal'readerDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Terminal_Reader

valuemkTerminal'reader

:: 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.

datadata Terminal'readerAction'NonNullable

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

The most recent action performed by the reader.

Constructors

Terminal'readerAction'NonNullable
- terminal'readerAction'NonNullableFailureCode :: Maybe (Nullable Text)
  failure_code: Failure code, only set if status is `failed`.
  Constraints:
  - Maximum length of 5000
- terminal'readerAction'NonNullableFailureMessage :: Maybe (Nullable Text)
  failure_message: Detailed failure message, only set if status is `failed`.
  Constraints:
  - Maximum length of 5000
- terminal'readerAction'NonNullableProcessPaymentIntent :: Maybe TerminalReaderReaderResourceProcessPaymentIntentAction
  process_payment_intent: Represents a reader action to process a payment intent
- terminal'readerAction'NonNullableProcessSetupIntent :: Maybe TerminalReaderReaderResourceProcessSetupIntentAction
  process_setup_intent: Represents a reader action to process a setup intent
- terminal'readerAction'NonNullableSetReaderDisplay :: Maybe TerminalReaderReaderResourceSetReaderDisplayAction
  set_reader_display: Represents a reader action to set the reader display
- terminal'readerAction'NonNullableStatus :: Maybe Terminal'readerAction'NonNullableStatus'
  status: Status of the action performed by the reader.
- terminal'readerAction'NonNullableType :: Maybe Terminal'readerAction'NonNullableType'
  type: Type of action performed by the reader.

Instances4Eq, Show, FromJSON, ToJSON

Eq Terminal'readerAction'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Terminal_Reader
Show Terminal'readerAction'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Terminal_Reader
FromJSON Terminal'readerAction'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Terminal_Reader
ToJSON Terminal'readerAction'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Terminal_Reader

valuemkTerminal'readerAction'NonNullable :: Terminal'readerAction'NonNullable

Create a new Terminal'readerAction'NonNullable with all required fields.

datadata Terminal'readerAction'NonNullableStatus'

Defines the enum schema located at components.schemas.terminal.reader.properties.action.anyOf.properties.status in the specification.

Status of the action performed by the reader.

Constructors

Terminal'readerAction'NonNullableStatus'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
Terminal'readerAction'NonNullableStatus'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
Terminal'readerAction'NonNullableStatus'EnumFailed
Represents the JSON value "failed"
Terminal'readerAction'NonNullableStatus'EnumInProgress
Represents the JSON value "in_progress"
Terminal'readerAction'NonNullableStatus'EnumSucceeded
Represents the JSON value "succeeded"

Instances4Eq, Show, FromJSON, ToJSON

Eq Terminal'readerAction'NonNullableStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Terminal_Reader
Show Terminal'readerAction'NonNullableStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Terminal_Reader
FromJSON Terminal'readerAction'NonNullableStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Terminal_Reader
ToJSON Terminal'readerAction'NonNullableStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Terminal_Reader

datadata Terminal'readerAction'NonNullableType'

Defines the enum schema located at components.schemas.terminal.reader.properties.action.anyOf.properties.type in the specification.

Type of action performed by the reader.

Constructors

Terminal'readerAction'NonNullableType'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
Terminal'readerAction'NonNullableType'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
Terminal'readerAction'NonNullableType'EnumProcessPaymentIntent
Represents the JSON value "process_payment_intent"
Terminal'readerAction'NonNullableType'EnumProcessSetupIntent
Represents the JSON value "process_setup_intent"
Terminal'readerAction'NonNullableType'EnumSetReaderDisplay
Represents the JSON value "set_reader_display"

Instances4Eq, Show, FromJSON, ToJSON

Eq Terminal'readerAction'NonNullableType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Terminal_Reader
Show Terminal'readerAction'NonNullableType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Terminal_Reader
FromJSON Terminal'readerAction'NonNullableType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Terminal_Reader
ToJSON Terminal'readerAction'NonNullableType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Terminal_Reader

datadata Terminal'readerDeviceType'

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

Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, or `simulated_wisepos_e`.

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'EnumBbposWisepad3
Represents the JSON value "bbpos_wisepad3"
Terminal'readerDeviceType'EnumBbposWiseposE
Represents the JSON value "bbpos_wisepos_e"
Terminal'readerDeviceType'EnumSimulatedWiseposE
Represents the JSON value "simulated_wisepos_e"
Terminal'readerDeviceType'EnumStripeM2
Represents the JSON value "stripe_m2"
Terminal'readerDeviceType'EnumVerifoneP400
Represents the JSON value "verifone_P400"

Instances4Eq, Show, FromJSON, ToJSON

Eq Terminal'readerDeviceType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Terminal_Reader
Show Terminal'readerDeviceType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Terminal_Reader
FromJSON Terminal'readerDeviceType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Terminal_Reader
ToJSON Terminal'readerDeviceType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Terminal_Reader

datadata Terminal'readerLocation'NonNullableVariants

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'NonNullableText Text
Terminal'readerLocation'NonNullableTerminal'location Terminal'location

Instances4Eq, Show, FromJSON, ToJSON

Eq Terminal'readerLocation'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Terminal_Reader
Show Terminal'readerLocation'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Terminal_Reader
FromJSON Terminal'readerLocation'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Terminal_Reader
ToJSON Terminal'readerLocation'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Terminal_Reader