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

A Configurations object represents how features should be configured for terminal readers. For information about how to use it, see the Terminal configurations documentation.

Summary

Types

aed()

Tipping configuration for AED

aud()

Tipping configuration for AUD

bbpos_wisepad3()

An object containing device type specific settings for BBPOS WisePad 3 readers.

bbpos_wisepos_e()

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

bgn()

Tipping configuration for BGN

cad()

Tipping configuration for CAD

chf()

Tipping configuration for CHF

czk()

Tipping configuration for CZK

dkk()

Tipping configuration for DKK

enterprise_eap_peap()

Credentials for a WPA-Enterprise WiFi network using the EAP-PEAP authentication method.

enterprise_eap_tls()

Credentials for a WPA-Enterprise WiFi network using the EAP-TLS authentication method.

eur()

Tipping configuration for EUR

gbp()

Tipping configuration for GBP

gip()

Tipping configuration for GIP

hkd()

Tipping configuration for HKD

huf()

Tipping configuration for HUF

jpy()

Tipping configuration for JPY

mxn()

Tipping configuration for MXN

myr()

Tipping configuration for MYR

nok()

Tipping configuration for NOK

nzd()

Tipping configuration for NZD

offline()

personal_psk()

Credentials for a WPA-Personal WiFi network.

pln()

Tipping configuration for PLN

reboot_window()

Reboot time settings for readers. that support customized reboot time configuration.

ron()

Tipping configuration for RON

sek()

Tipping configuration for SEK

sgd()

Tipping configuration for SGD

stripe_s700()

An object containing device type specific settings for Stripe S700 readers.

t()

The terminal.configuration type.

tipping()

usd()

Tipping configuration for USD

verifone_p400()

An object containing device type specific settings for Verifone P400 readers.

wifi()

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

aed()

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

Tipping configuration for AED

aud()

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

Tipping configuration for AUD

bbpos_wisepad3()

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

An object containing device type specific settings for BBPOS WisePad 3 readers.

bbpos_wisepos_e()

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

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

bgn()

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

Tipping configuration for BGN

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

enterprise_eap_peap()

@type enterprise_eap_peap() :: %{
  optional(:ca_certificate_file) => binary(),
  optional(:password) => binary(),
  optional(:ssid) => binary(),
  optional(:username) => binary()
}

Credentials for a WPA-Enterprise WiFi network using the EAP-PEAP authentication method.

enterprise_eap_tls()

@type enterprise_eap_tls() :: %{
  optional(:ca_certificate_file) => binary(),
  optional(:client_certificate_file) => binary(),
  optional(:private_key_file) => binary(),
  optional(:private_key_file_password) => binary(),
  optional(:ssid) => binary()
}

Credentials for a WPA-Enterprise WiFi network using the EAP-TLS authentication method.

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

gip()

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

Tipping configuration for GIP

hkd()

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

Tipping configuration for HKD

huf()

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

Tipping configuration for HUF

jpy()

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

Tipping configuration for JPY

mxn()

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

Tipping configuration for MXN

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()}

personal_psk()

@type personal_psk() :: %{
  optional(:password) => binary(),
  optional(:ssid) => binary()
}

Credentials for a WPA-Personal WiFi network.

pln()

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

Tipping configuration for PLN

reboot_window()

@type reboot_window() :: %{
  optional(:end_hour) => integer(),
  optional(:start_hour) => integer()
}

Reboot time settings for readers. that support customized reboot time configuration.

ron()

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

Tipping configuration for RON

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

stripe_s700()

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

An object containing device type specific settings for Stripe S700 readers.

t()

@type t() :: %Stripe.Terminal.Configuration{
  bbpos_wisepad3: term(),
  bbpos_wisepos_e: term(),
  id: binary(),
  is_account_default: boolean() | nil,
  livemode: boolean(),
  name: binary() | nil,
  object: binary(),
  offline: term(),
  reboot_window: term(),
  stripe_s700: term(),
  tipping: term(),
  verifone_p400: term(),
  wifi: term()
}

The terminal.configuration type.

bbpos_wisepad3
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.
name String indicating the name of the Configuration object, set by the user
object String representing the object's type. Objects of the same type share the same value.
offline
reboot_window
stripe_s700
tipping
verifone_p400
wifi

tipping()

@type tipping() :: %{
  optional(:aed) => aed(),
  optional(:aud) => aud(),
  optional(:bgn) => bgn(),
  optional(:cad) => cad(),
  optional(:chf) => chf(),
  optional(:czk) => czk(),
  optional(:dkk) => dkk(),
  optional(:eur) => eur(),
  optional(:gbp) => gbp(),
  optional(:gip) => gip(),
  optional(:hkd) => hkd(),
  optional(:huf) => huf(),
  optional(:jpy) => jpy(),
  optional(:mxn) => mxn(),
  optional(:myr) => myr(),
  optional(:nok) => nok(),
  optional(:nzd) => nzd(),
  optional(:pln) => pln(),
  optional(:ron) => ron(),
  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.

wifi()

@type wifi() :: %{
  optional(:enterprise_eap_peap) => enterprise_eap_peap(),
  optional(:enterprise_eap_tls) => enterprise_eap_tls(),
  optional(:personal_psk) => personal_psk(),
  optional(:type) => :enterprise_eap_peap | :enterprise_eap_tls | :personal_psk
}

Functions

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

@spec create(
  params :: %{
    optional(:bbpos_wisepad3) => bbpos_wisepad3(),
    optional(:bbpos_wisepos_e) => bbpos_wisepos_e(),
    optional(:expand) => [binary()],
    optional(:name) => binary(),
    optional(:offline) => offline() | binary(),
    optional(:reboot_window) => reboot_window(),
    optional(:stripe_s700) => stripe_s700(),
    optional(:tipping) => tipping() | binary(),
    optional(:verifone_p400) => verifone_p400(),
    optional(:wifi) => wifi() | binary()
  },
  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_wisepad3) => bbpos_wisepad3() | binary(),
    optional(:bbpos_wisepos_e) => bbpos_wisepos_e() | binary(),
    optional(:expand) => [binary()],
    optional(:name) => binary(),
    optional(:offline) => offline() | binary(),
    optional(:reboot_window) => reboot_window() | binary(),
    optional(:stripe_s700) => stripe_s700() | binary(),
    optional(:tipping) => tipping() | binary(),
    optional(:verifone_p400) => verifone_p400() | binary(),
    optional(:wifi) => wifi() | 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}