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

Parameters for reader process payment intent.

Summary

Types

t()

Types

process_config()

@type process_config() :: %{
  optional(:allow_redisplay) => String.t() | nil,
  optional(:enable_customer_cancellation) => boolean() | nil,
  optional(:return_url) => String.t() | nil,
  optional(:skip_tipping) => boolean() | nil,
  optional(:tipping) => process_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.
return_url - The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.
skip_tipping - Override showing a tipping selection screen on this transaction.
tipping - Tipping configuration for this transaction.

process_config_tipping()

@type process_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.ReaderProcessPaymentIntentParams{
  expand: [String.t()] | nil,
  payment_intent: String.t(),
  process_config: process_config() | nil
}

expand - Specifies which fields in the response should be expanded.
payment_intent - The ID of the PaymentIntent to process on the reader. Max length: 5000.
process_config - Configuration overrides for this transaction, such as tipping and customer cancellation settings.