Stripe.Params.Terminal.ReaderCollectInputsParams (tiger_stripe v0.3.0)

Copy Markdown View Source

Parameters for reader collect inputs.

Summary

Types

inputs()
inputs_custom_text()
inputs_selection()
inputs_selection_choices()
inputs_toggles()
t()

Types

inputs()

@type inputs() :: %{
  optional(:custom_text) => inputs_custom_text() | nil,
  optional(:required) => boolean() | nil,
  optional(:selection) => inputs_selection() | nil,
  optional(:toggles) => [inputs_toggles()] | nil,
  optional(:type) => String.t() | nil,
  optional(String.t()) => term()
}
  • custom_text - Customize the text which will be displayed while collecting this input
  • required - Indicate that this input is required, disabling the skip button
  • selection - Options for the selection input
  • toggles - List of toggles to be displayed and customization for the toggles
  • type - The type of input to collect Possible values: email, numeric, phone, selection, signature, text.

inputs_custom_text()

@type inputs_custom_text() :: %{
  optional(:description) => String.t() | nil,
  optional(:skip_button) => String.t() | nil,
  optional(:submit_button) => String.t() | nil,
  optional(:title) => String.t() | nil,
  optional(String.t()) => term()
}
  • description - The description which will be displayed when collecting this input Max length: 500.
  • skip_button - Custom text for the skip button. Maximum 14 characters. Max length: 14.
  • submit_button - Custom text for the submit button. Maximum 30 characters. Max length: 30.
  • title - The title which will be displayed when collecting this input Max length: 40.

inputs_selection()

@type inputs_selection() :: %{
  optional(:choices) => [inputs_selection_choices()] | nil,
  optional(String.t()) => term()
}
  • choices - List of choices for the selection input

inputs_selection_choices()

@type inputs_selection_choices() :: %{
  optional(:id) => String.t() | nil,
  optional(:style) => String.t() | nil,
  optional(:text) => String.t() | nil,
  optional(String.t()) => term()
}
  • id - The unique identifier for this choice Max length: 50.
  • style - The style of the button which will be shown for this choice. Can be primary or secondary. Possible values: primary, secondary.
  • text - The text which will be shown on the button for this choice Max length: 30.

inputs_toggles()

@type inputs_toggles() :: %{
  optional(:default_value) => String.t() | nil,
  optional(:description) => String.t() | nil,
  optional(:title) => String.t() | nil,
  optional(String.t()) => term()
}
  • default_value - The default value of the toggle. Can be enabled or disabled. Possible values: disabled, enabled.
  • description - The description which will be displayed for the toggle. Maximum 50 characters. At least one of title or description must be provided. Max length: 50.
  • title - The title which will be displayed for the toggle. Maximum 50 characters. At least one of title or description must be provided. Max length: 50.

t()

@type t() :: %Stripe.Params.Terminal.ReaderCollectInputsParams{
  expand: [String.t()] | nil,
  inputs: [inputs()],
  metadata: %{required(String.t()) => String.t()} | nil
}
  • expand - Specifies which fields in the response should be expanded.
  • inputs - List of inputs to be collected from the customer using the Reader. Maximum 5 inputs.
  • metadata - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.