View Source Stripe.Terminal.Configuration (Striped v0.2.0)
A Configurations object represents how features should be configured for terminal readers.
Link to this section Summary
Types
An object containing device type specific settings for BBPOS WisePOS E readers
The terminal.configuration
type.
An object containing device type specific settings for Verifone P400 readers
Functions
Creates a new Configuration
object.
Deletes a Configuration
object.
Returns a list of Configuration
objects.
Retrieves a Configuration
object.
Updates a new Configuration
object.
Link to this section Types
@type aud() :: %{
optional(:fixed_amounts) => [:integer],
optional(:percentages) => [:integer],
optional(:smart_tip_threshold) => :integer
}
@type bbpos_wisepos_e() :: %{optional(:splashscreen) => :string | :string}
An object containing device type specific settings for BBPOS WisePOS E readers
@type cad() :: %{
optional(:fixed_amounts) => [:integer],
optional(:percentages) => [:integer],
optional(:smart_tip_threshold) => :integer
}
@type chf() :: %{
optional(:fixed_amounts) => [:integer],
optional(:percentages) => [:integer],
optional(:smart_tip_threshold) => :integer
}
@type czk() :: %{
optional(:fixed_amounts) => [:integer],
optional(:percentages) => [:integer],
optional(:smart_tip_threshold) => :integer
}
@type dkk() :: %{
optional(:fixed_amounts) => [:integer],
optional(:percentages) => [:integer],
optional(:smart_tip_threshold) => :integer
}
@type eur() :: %{
optional(:fixed_amounts) => [:integer],
optional(:percentages) => [:integer],
optional(:smart_tip_threshold) => :integer
}
@type gbp() :: %{
optional(:fixed_amounts) => [:integer],
optional(:percentages) => [:integer],
optional(:smart_tip_threshold) => :integer
}
@type hkd() :: %{
optional(:fixed_amounts) => [:integer],
optional(:percentages) => [:integer],
optional(:smart_tip_threshold) => :integer
}
@type myr() :: %{
optional(:fixed_amounts) => [:integer],
optional(:percentages) => [:integer],
optional(:smart_tip_threshold) => :integer
}
@type nok() :: %{
optional(:fixed_amounts) => [:integer],
optional(:percentages) => [:integer],
optional(:smart_tip_threshold) => :integer
}
@type nzd() :: %{
optional(:fixed_amounts) => [:integer],
optional(:percentages) => [:integer],
optional(:smart_tip_threshold) => :integer
}
@type sek() :: %{
optional(:fixed_amounts) => [:integer],
optional(:percentages) => [:integer],
optional(:smart_tip_threshold) => :integer
}
@type sgd() :: %{
optional(:fixed_amounts) => [:integer],
optional(:percentages) => [:integer],
optional(:smart_tip_threshold) => :integer
}
@type t() :: %Stripe.Terminal.Configuration{ bbpos_wisepos_e: term(), id: binary(), is_account_default: boolean() | nil, livemode: boolean(), object: binary(), tipping: term(), verifone_p400: term() }
The terminal.configuration
type.
bbpos_wisepos_e
id
Unique identifier for the object.is_account_default
Whether this Configuration is the default for your accountlivemode
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.object
String representing the object's type. Objects of the same type share the same value.tipping
verifone_p400
@type usd() :: %{
optional(:fixed_amounts) => [:integer],
optional(:percentages) => [:integer],
optional(:smart_tip_threshold) => :integer
}
@type verifone_p400() :: %{optional(:splashscreen) => :string | :string}
An object containing device type specific settings for Verifone P400 readers
Link to this section Functions
@spec create( client :: term(), params :: %{ optional(:bbpos_wisepos_e) => bbpos_wisepos_e(), optional(:expand) => [:string], optional(:tipping) => tipping() | :string, optional(:verifone_p400) => verifone_p400() } ) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Creates a new Configuration
object.
Details
- Method:
post
- Path:
/v1/terminal/configurations
@spec delete(client :: term(), configuration :: binary()) :: {:ok, Stripe.DeletedTerminal.Configuration.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Deletes a Configuration
object.
Details
- Method:
delete
- Path:
/v1/terminal/configurations/{configuration}
@spec list( client :: term(), params :: %{ optional(:ending_before) => :string, optional(:expand) => [:string], optional(:is_account_default) => :boolean, optional(:limit) => :integer, optional(:starting_after) => :string } ) :: {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Returns a list of Configuration
objects.
Details
- Method:
get
- Path:
/v1/terminal/configurations
@spec retrieve( client :: term(), configuration :: binary(), params :: %{optional(:expand) => [:string]} ) :: {:ok, t() | Stripe.DeletedTerminal.Configuration.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Retrieves a Configuration
object.
Details
- Method:
get
- Path:
/v1/terminal/configurations/{configuration}
@spec update( client :: term(), configuration :: binary(), params :: %{ optional(:bbpos_wisepos_e) => bbpos_wisepos_e() | :string, optional(:expand) => [:string], optional(:tipping) => tipping() | :string, optional(:verifone_p400) => verifone_p400() | :string } ) :: {:ok, t() | Stripe.DeletedTerminal.Configuration.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Updates a new Configuration
object.
Details
- Method:
post
- Path:
/v1/terminal/configurations/{configuration}