View Source ExOAPI.Stripe.Schemas.Terminal_reader (exoapi_stripe v0.1.4)

description: A Reader represents a physical device for accepting payment details.

Related guide: Connecting to a Reader.

:action :: ExOAPI.Stripe.Schemas.TerminalReaderReaderResourceReaderAction

The most recent action performed by the reader.

:device_sw_version :: :string

The current software version of the reader.

:device_type :: :string

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

:id :: :string

Unique identifier for the object.

:ip_address :: :string

The local IP address of the reader.

:label :: :string

Custom label given to the reader for easier identification.

:livemode :: :boolean

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

:location :: ExOAPI.Stripe.Schemas.Terminal_location | :string

The location identifier of the reader.

:metadata :: :map

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.

:object :: :string

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

:serial_number :: :string

Serial number of the reader.

:status :: :string

The networking status of the reader.

Link to this section Summary

Link to this section Types

@type params() :: map()
@type t() :: %ExOAPI.Stripe.Schemas.Terminal_reader{
  action: ExOAPI.EctoTypes.AnyOf.t() | nil,
  device_sw_version: String.t() | nil,
  device_type:
    (:verifone_P400
     | :stripe_m2
     | :bbpos_wisepos_e
     | :bbpos_wisepad3
     | :bbpos_chipper2x)
    | nil,
  id: String.t() | nil,
  ip_address: String.t() | nil,
  label: String.t() | nil,
  livemode: boolean() | nil,
  location: ExOAPI.EctoTypes.AnyOf.t() | nil,
  metadata: map() | nil,
  object: :"terminal.reader" | nil,
  serial_number: String.t() | nil,
  status: String.t() | nil
}

Link to this section Functions

Link to this function

changeset(struct \\ %__MODULE__{}, params)

View Source
@spec changeset(t(), params()) :: Ecto.Changeset.t()