View Source Stripe.Terminal.Configuration (stripity_stripe v3.2.0)

A Configurations object represents how features should be configured for terminal readers.

Summary

Types

aud()

Tipping configuration for AUD

bbpos_wisepos_e()

An object containing device type specific settings for BBPOS WisePOS E readers

cad()

Tipping configuration for CAD

chf()

Tipping configuration for CHF

czk()

Tipping configuration for CZK

dkk()

Tipping configuration for DKK

eur()

Tipping configuration for EUR

gbp()

Tipping configuration for GBP

hkd()

Tipping configuration for HKD

myr()

Tipping configuration for MYR

nok()

Tipping configuration for NOK

nzd()

Tipping configuration for NZD

offline()

sek()

Tipping configuration for SEK

sgd()

Tipping configuration for SGD

t()

The terminal.configuration type.

tipping()

usd()

Tipping configuration for USD

verifone_p400()

An object containing device type specific settings for Verifone P400 readers

Functions

create(params \\ %{}, opts \\ [])

Creates a new Configuration object.

delete(configuration, opts \\ [])

Deletes a Configuration object.

list(params \\ %{}, opts \\ [])

Returns a list of Configuration objects.

retrieve(configuration, params \\ %{}, opts \\ [])

Retrieves a Configuration object.

update(configuration, params \\ %{}, opts \\ [])

Updates a new Configuration object.

Types

aud()

@type aud() :: %{
  optional(:fixed_amounts) => [integer()],
  optional(:percentages) => [integer()],
  optional(:smart_tip_threshold) => integer()
}

Tipping configuration for AUD

bbpos_wisepos_e()

@type bbpos_wisepos_e() :: %{optional(:splashscreen) => binary() | binary()}

An object containing device type specific settings for BBPOS WisePOS E readers

cad()

@type cad() :: %{
  optional(:fixed_amounts) => [integer()],
  optional(:percentages) => [integer()],
  optional(:smart_tip_threshold) => integer()
}

Tipping configuration for CAD

chf()

@type chf() :: %{
  optional(:fixed_amounts) => [integer()],
  optional(:percentages) => [integer()],
  optional(:smart_tip_threshold) => integer()
}

Tipping configuration for CHF

czk()

@type czk() :: %{
  optional(:fixed_amounts) => [integer()],
  optional(:percentages) => [integer()],
  optional(:smart_tip_threshold) => integer()
}

Tipping configuration for CZK

dkk()

@type dkk() :: %{
  optional(:fixed_amounts) => [integer()],
  optional(:percentages) => [integer()],
  optional(:smart_tip_threshold) => integer()
}

Tipping configuration for DKK

eur()

@type eur() :: %{
  optional(:fixed_amounts) => [integer()],
  optional(:percentages) => [integer()],
  optional(:smart_tip_threshold) => integer()
}

Tipping configuration for EUR

gbp()

@type gbp() :: %{
  optional(:fixed_amounts) => [integer()],
  optional(:percentages) => [integer()],
  optional(:smart_tip_threshold) => integer()
}

Tipping configuration for GBP

hkd()

@type hkd() :: %{
  optional(:fixed_amounts) => [integer()],
  optional(:percentages) => [integer()],
  optional(:smart_tip_threshold) => integer()
}

Tipping configuration for HKD

myr()

@type myr() :: %{
  optional(:fixed_amounts) => [integer()],
  optional(:percentages) => [integer()],
  optional(:smart_tip_threshold) => integer()
}

Tipping configuration for MYR

nok()

@type nok() :: %{
  optional(:fixed_amounts) => [integer()],
  optional(:percentages) => [integer()],
  optional(:smart_tip_threshold) => integer()
}

Tipping configuration for NOK

nzd()

@type nzd() :: %{
  optional(:fixed_amounts) => [integer()],
  optional(:percentages) => [integer()],
  optional(:smart_tip_threshold) => integer()
}

Tipping configuration for NZD

offline()

@type offline() :: %{optional(:enabled) => boolean()}

sek()

@type sek() :: %{
  optional(:fixed_amounts) => [integer()],
  optional(:percentages) => [integer()],
  optional(:smart_tip_threshold) => integer()
}

Tipping configuration for SEK

sgd()

@type sgd() :: %{
  optional(:fixed_amounts) => [integer()],
  optional(:percentages) => [integer()],
  optional(:smart_tip_threshold) => integer()
}

Tipping configuration for SGD

t()

@type t() :: %Stripe.Terminal.Configuration{
  bbpos_wisepos_e: term(),
  id: binary(),
  is_account_default: boolean() | nil,
  livemode: boolean(),
  object: binary(),
  offline: term(),
  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 account
livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
object String representing the object's type. Objects of the same type share the same value.
offline
tipping
verifone_p400

tipping()

@type tipping() :: %{
  optional(:aud) => aud(),
  optional(:cad) => cad(),
  optional(:chf) => chf(),
  optional(:czk) => czk(),
  optional(:dkk) => dkk(),
  optional(:eur) => eur(),
  optional(:gbp) => gbp(),
  optional(:hkd) => hkd(),
  optional(:myr) => myr(),
  optional(:nok) => nok(),
  optional(:nzd) => nzd(),
  optional(:sek) => sek(),
  optional(:sgd) => sgd(),
  optional(:usd) => usd()
}

usd()

@type usd() :: %{
  optional(:fixed_amounts) => [integer()],
  optional(:percentages) => [integer()],
  optional(:smart_tip_threshold) => integer()
}

Tipping configuration for USD

verifone_p400()

@type verifone_p400() :: %{optional(:splashscreen) => binary() | binary()}

An object containing device type specific settings for Verifone P400 readers

Functions

create(params \\ %{}, opts \\ [])

@spec create(
  params :: %{
    optional(:bbpos_wisepos_e) => bbpos_wisepos_e(),
    optional(:expand) => [binary()],
    optional(:offline) => offline() | binary(),
    optional(:tipping) => tipping() | binary(),
    optional(:verifone_p400) => verifone_p400()
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Creates a new Configuration object.

Details

Method: post
Path: /v1/terminal/configurations

delete(configuration, opts \\ [])

@spec delete(configuration :: binary(), opts :: Keyword.t()) ::
  {:ok, Stripe.DeletedTerminal.Configuration.t()}
  | {:error, Stripe.ApiErrors.t()}
  | {:error, term()}

Deletes a Configuration object.

Details

Method: delete
Path: /v1/terminal/configurations/{configuration}

list(params \\ %{}, opts \\ [])

@spec list(
  params :: %{
    optional(:ending_before) => binary(),
    optional(:expand) => [binary()],
    optional(:is_account_default) => boolean(),
    optional(:limit) => integer(),
    optional(:starting_after) => binary()
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Returns a list of Configuration objects.

Details

Method: get
Path: /v1/terminal/configurations

retrieve(configuration, params \\ %{}, opts \\ [])

@spec retrieve(
  configuration :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) ::
  {:ok, t() | Stripe.DeletedTerminal.Configuration.t()}
  | {:error, Stripe.ApiErrors.t()}
  | {:error, term()}

Retrieves a Configuration object.

Details

Method: get
Path: /v1/terminal/configurations/{configuration}

update(configuration, params \\ %{}, opts \\ [])

@spec update(
  configuration :: binary(),
  params :: %{
    optional(:bbpos_wisepos_e) => bbpos_wisepos_e() | binary(),
    optional(:expand) => [binary()],
    optional(:offline) => offline() | binary(),
    optional(:tipping) => tipping() | binary(),
    optional(:verifone_p400) => verifone_p400() | binary()
  },
  opts :: Keyword.t()
) ::
  {: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}