Stripe.Terminal.Reader (stripity_stripe v2.17.2) View Source
A Reader represents a physical device for accepting payment details
You can:
Link to this section Summary
Functions
Create a new reader
Delete an reader.
List all readers.
Retrieve a reader with a specified id
.
Update a reader.
Link to this section Types
Specs
Link to this section Functions
Specs
create(params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()} when params: %{ :registration_code => String.t(), optional(:label) => String.t(), optional(:location) => Stripe.id(), optional(:metadata) => Stripe.Types.metadata() } | %{}
Create a new reader
Specs
delete(Stripe.id() | t(), Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
Delete an reader.
Specs
list(params, Stripe.options()) :: {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()} when params: %{ optional(:device_type) => String.t(), optional(:location) => t() | Stripe.id(), optional(:status) => String.t(), optional(:ending_before) => t() | Stripe.id(), optional(:limit) => 1..100, optional(:starting_after) => t() | Stripe.id() }
List all readers.
Specs
retrieve(Stripe.id() | t(), Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
Retrieve a reader with a specified id
.
Specs
update(Stripe.id() | t(), params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()} when params: %{ optional(:label) => String.t(), optional(:metadata) => Stripe.Types.metadata() }
Update a reader.
Takes the id
and a map of changes.