View Source ExOAPI.Stripe.SDK.Terminal (exoapi_stripe v0.1.4)

description: 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.

post_terminal_locations(client, body)

description: 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.

post_terminal_locations_location(client, body, location)

description: Updates a <code>Location</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

post_terminal_readers(client, body)

description: Creates a new <code>Reader</code> object.

post_terminal_readers_reader(client, body, reader)

description: Updates a <code>Reader</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

post_terminal_readers_reader_cancel_action(client, body, reader)

description: Cancels the current reader action.

post_terminal_readers_reader_process_payment_intent(client, body, reader)

description: Initiates a payment flow on a Reader.

post_terminal_readers_reader_process_setup_intent(client, body, reader)

description: Initiates a setup intent flow on a Reader.

post_terminal_readers_reader_set_reader_display(client, body, reader)

description: Sets reader display to show cart details.

Link to this section Types

get_terminal_configurations_configuration_opts()

@type get_terminal_configurations_configuration_opts() :: {:expand, String.t()}

get_terminal_configurations_opts()

@type get_terminal_configurations_opts() ::
  {:starting_after, String.t()}
  | {:limit, String.t()}
  | {:is_account_default, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}

get_terminal_locations_location_opts()

@type get_terminal_locations_location_opts() :: {:expand, String.t()}

get_terminal_locations_opts()

@type get_terminal_locations_opts() ::
  {:starting_after, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}

get_terminal_readers_opts()

@type get_terminal_readers_opts() ::
  {:status, String.t()}
  | {:starting_after, String.t()}
  | {:location, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:device_type, String.t()}

get_terminal_readers_reader_opts()

@type get_terminal_readers_reader_opts() :: {:expand, String.t()}

Link to this section Functions

delete_terminal_configurations_configuration(client, body, configuration)

@spec delete_terminal_configurations_configuration(
  client :: ExOAPI.Client.t(),
  body :: %{} | map(),
  configuration :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.DeletedTerminal_configuration.t()
   | map()}
  | {:error, any()}

description: Deletes a <code>Configuration</code> object.

delete_terminal_locations_location(client, body, location)

@spec delete_terminal_locations_location(
  client :: ExOAPI.Client.t(),
  body :: %{} | map(),
  location :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.DeletedTerminal_location.t()
   | map()}
  | {:error, any()}

description: Deletes a <code>Location</code> object.

delete_terminal_readers_reader(client, body, reader)

@spec delete_terminal_readers_reader(
  client :: ExOAPI.Client.t(),
  body :: %{} | map(),
  reader :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.DeletedTerminal_reader.t()
   | map()}
  | {:error, any()}

description: Deletes a <code>Reader</code> object.

get_terminal_configurations(client, opts \\ [])

@spec get_terminal_configurations(client :: ExOAPI.Client.t(), [
  get_terminal_configurations_opts()
]) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | %{
       url: String.t(),
       object: String.t() | :list,
       has_more: boolean(),
       data: [ExOAPI.Stripe.Schemas.Terminal_configuration.t()]
     }
   | map()}
  | {:error, any()}

description: Returns a list of <code>Configuration</code> objects.

get_terminal_configurations_configuration(client, configuration, opts \\ [])

@spec get_terminal_configurations_configuration(
  client :: ExOAPI.Client.t(),
  configuration :: String.t(),
  [get_terminal_configurations_configuration_opts()]
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.DeletedTerminal_configuration.t()
   | ExOAPI.Stripe.Schemas.Terminal_configuration.t()
   | map()}
  | {:error, any()}

description: Retrieves a <code>Configuration</code> object.

get_terminal_locations(client, opts \\ [])

@spec get_terminal_locations(client :: ExOAPI.Client.t(), [
  get_terminal_locations_opts()
]) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | %{
       url: String.t(),
       object: String.t() | :list,
       has_more: boolean(),
       data: [ExOAPI.Stripe.Schemas.Terminal_location.t()]
     }
   | map()}
  | {:error, any()}

description: Returns a list of <code>Location</code> objects.

get_terminal_locations_location(client, location, opts \\ [])

@spec get_terminal_locations_location(
  client :: ExOAPI.Client.t(),
  location :: String.t(),
  [get_terminal_locations_location_opts()]
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.DeletedTerminal_location.t()
   | ExOAPI.Stripe.Schemas.Terminal_location.t()
   | map()}
  | {:error, any()}

description: Retrieves a <code>Location</code> object.

get_terminal_readers(client, opts \\ [])

@spec get_terminal_readers(client :: ExOAPI.Client.t(), [get_terminal_readers_opts()]) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | %{
       url: String.t(),
       object: String.t() | :list,
       has_more: boolean(),
       data: [ExOAPI.Stripe.Schemas.Terminal_reader.t()]
     }
   | map()}
  | {:error, any()}

description: Returns a list of <code>Reader</code> objects.

get_terminal_readers_reader(client, reader, opts \\ [])

@spec get_terminal_readers_reader(
  client :: ExOAPI.Client.t(),
  reader :: String.t(),
  [get_terminal_readers_reader_opts()]
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.DeletedTerminal_reader.t()
   | ExOAPI.Stripe.Schemas.Terminal_reader.t()
   | map()}
  | {:error, any()}

description: Retrieves a <code>Reader</code> object.

post_terminal_configurations(client, body)

@spec post_terminal_configurations(
  client :: ExOAPI.Client.t(),
  body ::
    %{
      verifone_P400: %{splashscreen: String.t()},
      tipping:
        String.t()
        | %{
            usd: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            },
            sgd: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            },
            sek: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            },
            nzd: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            },
            nok: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            },
            myr: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            },
            hkd: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            },
            gbp: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            },
            eur: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            },
            dkk: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            },
            chf: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            },
            cad: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            },
            aud: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            }
          },
      expand: [String.t()],
      bbpos_wisepos_e: %{splashscreen: String.t()}
    }
    | map()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.Terminal_configuration.t()
   | map()}
  | {:error, any()}

description: Creates a new <code>Configuration</code> object.

post_terminal_configurations_configuration(client, body, configuration)

@spec post_terminal_configurations_configuration(
  client :: ExOAPI.Client.t(),
  body ::
    %{
      verifone_P400: String.t() | %{splashscreen: String.t()},
      tipping:
        String.t()
        | %{
            usd: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            },
            sgd: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            },
            sek: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            },
            nzd: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            },
            nok: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            },
            myr: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            },
            hkd: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            },
            gbp: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            },
            eur: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            },
            dkk: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            },
            chf: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            },
            cad: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            },
            aud: %{
              smart_tip_threshold: integer(),
              percentages: [integer()],
              fixed_amounts: [integer()]
            }
          },
      expand: [String.t()],
      bbpos_wisepos_e: String.t() | %{splashscreen: String.t()}
    }
    | map(),
  configuration :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.Terminal_configuration.t()
   | map()}
  | {:error, any()}

description: Updates a new <code>Configuration</code> object.

post_terminal_connection_tokens(client, body)

@spec post_terminal_connection_tokens(
  client :: ExOAPI.Client.t(),
  body :: %{location: String.t(), expand: [String.t()]} | map()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.Terminal_connectionToken.t()
   | map()}
  | {:error, any()}

post_terminal_locations(client, body)

@spec post_terminal_locations(
  client :: ExOAPI.Client.t(),
  body ::
    %{
      metadata: String.t() | map(),
      expand: [String.t()],
      display_name: String.t(),
      configuration_overrides: String.t(),
      address: %{
        state: String.t(),
        postal_code: String.t(),
        line2: String.t(),
        line1: String.t(),
        country: String.t(),
        city: String.t()
      }
    }
    | map()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.Terminal_location.t()
   | map()}
  | {:error, any()}

post_terminal_locations_location(client, body, location)

@spec post_terminal_locations_location(
  client :: ExOAPI.Client.t(),
  body ::
    %{
      metadata: String.t() | map(),
      expand: [String.t()],
      display_name: String.t(),
      configuration_overrides: String.t(),
      address: %{
        state: String.t(),
        postal_code: String.t(),
        line2: String.t(),
        line1: String.t(),
        country: String.t(),
        city: String.t()
      }
    }
    | map(),
  location :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.DeletedTerminal_location.t()
   | ExOAPI.Stripe.Schemas.Terminal_location.t()
   | map()}
  | {:error, any()}

description: Updates a <code>Location</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

post_terminal_readers(client, body)

@spec post_terminal_readers(
  client :: ExOAPI.Client.t(),
  body ::
    %{
      registration_code: String.t(),
      metadata: String.t() | map(),
      location: String.t(),
      label: String.t(),
      expand: [String.t()]
    }
    | map()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.Terminal_reader.t()
   | map()}
  | {:error, any()}

description: Creates a new <code>Reader</code> object.

post_terminal_readers_reader(client, body, reader)

@spec post_terminal_readers_reader(
  client :: ExOAPI.Client.t(),
  body ::
    %{metadata: String.t() | map(), label: String.t(), expand: [String.t()]}
    | map(),
  reader :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.DeletedTerminal_reader.t()
   | ExOAPI.Stripe.Schemas.Terminal_reader.t()
   | map()}
  | {:error, any()}

description: Updates a <code>Reader</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

post_terminal_readers_reader_cancel_action(client, body, reader)

@spec post_terminal_readers_reader_cancel_action(
  client :: ExOAPI.Client.t(),
  body :: %{expand: [String.t()]} | map(),
  reader :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.Terminal_reader.t()
   | map()}
  | {:error, any()}

description: Cancels the current reader action.

post_terminal_readers_reader_process_payment_intent(client, body, reader)

@spec post_terminal_readers_reader_process_payment_intent(
  client :: ExOAPI.Client.t(),
  body ::
    %{
      process_config: %{skip_tipping: boolean()},
      payment_intent: String.t(),
      expand: [String.t()]
    }
    | map(),
  reader :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.Terminal_reader.t()
   | map()}
  | {:error, any()}

description: Initiates a payment flow on a Reader.

post_terminal_readers_reader_process_setup_intent(client, body, reader)

@spec post_terminal_readers_reader_process_setup_intent(
  client :: ExOAPI.Client.t(),
  body ::
    %{
      setup_intent: String.t(),
      expand: [String.t()],
      customer_consent_collected: boolean()
    }
    | map(),
  reader :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.Terminal_reader.t()
   | map()}
  | {:error, any()}

description: Initiates a setup intent flow on a Reader.

post_terminal_readers_reader_set_reader_display(client, body, reader)

@spec post_terminal_readers_reader_set_reader_display(
  client :: ExOAPI.Client.t(),
  body ::
    %{
      type: String.t() | :cart,
      expand: [String.t()],
      cart: %{
        total: integer(),
        tax: integer(),
        line_items: [
          %{quantity: integer(), description: String.t(), amount: integer()}
        ],
        currency: String.t()
      }
    }
    | map(),
  reader :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.Terminal_reader.t()
   | map()}
  | {:error, any()}

description: Sets reader display to show cart details.

Settings View Source ExOAPI.Stripe.SDK.Terminal (exoapi_stripe v0.1.4)

Link to this section Summary

Types

Functions

Link to this section Types

get_terminal_configurations_configuration_opts()

get_terminal_configurations_opts()

get_terminal_locations_location_opts()

get_terminal_locations_opts()

get_terminal_readers_opts()

get_terminal_readers_reader_opts()

Link to this section Functions

delete_terminal_configurations_configuration(client, body, configuration)

delete_terminal_locations_location(client, body, location)

delete_terminal_readers_reader(client, body, reader)

get_terminal_configurations(client, opts \\ [])

get_terminal_configurations_configuration(client, configuration, opts \\ [])

get_terminal_locations(client, opts \\ [])

get_terminal_locations_location(client, location, opts \\ [])

get_terminal_readers(client, opts \\ [])

get_terminal_readers_reader(client, reader, opts \\ [])

post_terminal_configurations(client, body)

post_terminal_configurations_configuration(client, body, configuration)

post_terminal_connection_tokens(client, body)

post_terminal_locations(client, body)

post_terminal_locations_location(client, body, location)

post_terminal_readers(client, body)

post_terminal_readers_reader(client, body, reader)

post_terminal_readers_reader_cancel_action(client, body, reader)

post_terminal_readers_reader_process_payment_intent(client, body, reader)

post_terminal_readers_reader_process_setup_intent(client, body, reader)

post_terminal_readers_reader_set_reader_display(client, body, reader)

View Source ExOAPI.Stripe.SDK.Terminal (exoapi_stripe v0.1.4)