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

Parameters for reader collect payment method.

Summary

Types

t()

Types

collect_config()

@type collect_config() :: %{
  optional(:allow_redisplay) => String.t() | nil,
  optional(:enable_customer_cancellation) => boolean() | nil,
  optional(:skip_tipping) => boolean() | nil,
  optional(:tipping) => collect_config_tipping() | nil,
  optional(String.t()) => term()
}

allow_redisplay - This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. Possible values: always, limited, unspecified.
enable_customer_cancellation - Enables cancel button on transaction screens.
skip_tipping - Override showing a tipping selection screen on this transaction.
tipping - Tipping configuration for this transaction.

collect_config_tipping()

@type collect_config_tipping() :: %{
  optional(:amount_eligible) => integer() | nil,
  optional(String.t()) => term()
}

amount_eligible - Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).

t()

@type t() :: %Stripe.Params.Terminal.ReaderCollectPaymentMethodParams{
  collect_config: collect_config() | nil,
  expand: [String.t()] | nil,
  payment_intent: String.t()
}

collect_config - Configuration overrides for this collection, such as tipping, surcharging, and customer cancellation settings.
expand - Specifies which fields in the response should be expanded.
payment_intent - The ID of the PaymentIntent to collect a payment method for. Max length: 5000.