View Source ExOAPI.Stripe.SDK.Terminal (exoapi_stripe v0.1.1)
Link to this section Summary
Functions
description: <p>Deletes a <code>Configuration</code> object.</p>
description: <p>Deletes a <code>Location</code> object.</p>
description: <p>Deletes a <code>Reader</code> object.</p>
description: <p>Returns a list of <code>Configuration</code> objects.</p>
description: <p>Retrieves a <code>Configuration</code> object.</p>
description: <p>Returns a list of <code>Location</code> objects.</p>
description: <p>Retrieves a <code>Location</code> object.</p>
description: <p>Returns a list of <code>Reader</code> objects.</p>
description: <p>Retrieves a <code>Reader</code> object.</p>
description: <p>Creates a new <code>Configuration</code> object.</p>
description: <p>Updates a new <code>Configuration</code> object.</p>
description: <p>To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.</p>
description: <p>Creates a new <code>Location</code> object. For further details, including which address fields are required in each country, see the <a href="/docs/terminal/fleet/locations">Manage locations</a> guide.</p>
description: <p>Updates a <code>Location</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>
description: <p>Creates a new <code>Reader</code> object.</p>
description: <p>Updates a <code>Reader</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>
description: <p>Cancels the current reader action.</p>
description: <p>Initiates a payment flow on a Reader.</p>
description: <p>Initiates a setup intent flow on a Reader.</p>
description: <p>Sets reader display to show cart details.</p>
Link to this section Types
Link to this section Functions
delete_terminal_configurations_configuration(client, body, configuration)
View Source@spec delete_terminal_configurations_configuration( client :: ExOAPI.Client.t(), body :: map(), configuration :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Deletes a <code>Configuration</code> object.</p>
@spec delete_terminal_locations_location( client :: ExOAPI.Client.t(), body :: map(), location :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Deletes a <code>Location</code> object.</p>
@spec delete_terminal_readers_reader( client :: ExOAPI.Client.t(), body :: map(), reader :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Deletes a <code>Reader</code> object.</p>
@spec get_terminal_configurations(client :: ExOAPI.Client.t(), [ get_terminal_configurations_opts() ]) :: {:ok, any()} | {:error, any()}
description: <p>Returns a list of <code>Configuration</code> objects.</p>
get_terminal_configurations_configuration(client, configuration, opts \\ [])
View Source@spec get_terminal_configurations_configuration( client :: ExOAPI.Client.t(), configuration :: String.t(), [get_terminal_configurations_configuration_opts()] ) :: {:ok, any()} | {:error, any()}
description: <p>Retrieves a <code>Configuration</code> object.</p>
@spec get_terminal_locations(client :: ExOAPI.Client.t(), [ get_terminal_locations_opts() ]) :: {:ok, any()} | {:error, any()}
description: <p>Returns a list of <code>Location</code> objects.</p>
@spec get_terminal_locations_location( client :: ExOAPI.Client.t(), location :: String.t(), [get_terminal_locations_location_opts()] ) :: {:ok, any()} | {:error, any()}
description: <p>Retrieves a <code>Location</code> object.</p>
@spec get_terminal_readers(client :: ExOAPI.Client.t(), [get_terminal_readers_opts()]) :: {:ok, any()} | {:error, any()}
description: <p>Returns a list of <code>Reader</code> objects.</p>
@spec get_terminal_readers_reader( client :: ExOAPI.Client.t(), reader :: String.t(), [get_terminal_readers_reader_opts()] ) :: {:ok, any()} | {:error, any()}
description: <p>Retrieves a <code>Reader</code> object.</p>
@spec post_terminal_configurations(client :: ExOAPI.Client.t(), body :: map()) :: {:ok, any()} | {:error, any()}
description: <p>Creates a new <code>Configuration</code> object.</p>
post_terminal_configurations_configuration(client, body, configuration)
View Source@spec post_terminal_configurations_configuration( client :: ExOAPI.Client.t(), body :: map(), configuration :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Updates a new <code>Configuration</code> object.</p>
@spec post_terminal_connection_tokens(client :: ExOAPI.Client.t(), body :: map()) :: {:ok, any()} | {:error, any()}
description: <p>To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.</p>
@spec post_terminal_locations(client :: ExOAPI.Client.t(), body :: map()) :: {:ok, any()} | {:error, any()}
description: <p>Creates a new <code>Location</code> object. For further details, including which address fields are required in each country, see the <a href="/docs/terminal/fleet/locations">Manage locations</a> guide.</p>
@spec post_terminal_locations_location( client :: ExOAPI.Client.t(), body :: map(), location :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Updates a <code>Location</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>
@spec post_terminal_readers(client :: ExOAPI.Client.t(), body :: map()) :: {:ok, any()} | {:error, any()}
description: <p>Creates a new <code>Reader</code> object.</p>
@spec post_terminal_readers_reader( client :: ExOAPI.Client.t(), body :: map(), reader :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Updates a <code>Reader</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>
@spec post_terminal_readers_reader_cancel_action( client :: ExOAPI.Client.t(), body :: map(), reader :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Cancels the current reader action.</p>
post_terminal_readers_reader_process_payment_intent(client, body, reader)
View Source@spec post_terminal_readers_reader_process_payment_intent( client :: ExOAPI.Client.t(), body :: map(), reader :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Initiates a payment flow on a Reader.</p>
post_terminal_readers_reader_process_setup_intent(client, body, reader)
View Source@spec post_terminal_readers_reader_process_setup_intent( client :: ExOAPI.Client.t(), body :: map(), reader :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Initiates a setup intent flow on a Reader.</p>
post_terminal_readers_reader_set_reader_display(client, body, reader)
View Source@spec post_terminal_readers_reader_set_reader_display( client :: ExOAPI.Client.t(), body :: map(), reader :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Sets reader display to show cart details.</p>