Packages

Complete Stripe SDK for Elixir with parity to the official Ruby SDK. V1+V2 coverage (193 services, 320 resource structs, 525 documented params). Per-event modules, Finch HTTP/2, RustyJSON, automatic retries, OAuth, webhooks, telemetry, per-client config, streaming pagination.

Current section

Files

Jump to
tiger_stripe lib stripe params terminal reader_collect_payment_method_params.ex
Raw

lib/stripe/params/terminal/reader_collect_payment_method_params.ex

# File generated from our OpenAPI spec
defmodule Stripe.Params.Terminal.ReaderCollectPaymentMethodParams do
@moduledoc "Parameters for reader collect payment method."
@typedoc """
* `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.
"""
@type t :: %__MODULE__{
collect_config: collect_config() | nil,
expand: [String.t()] | nil,
payment_intent: String.t()
}
defstruct [:collect_config, :expand, :payment_intent]
@typedoc """
* `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.
"""
@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()
}
@typedoc """
* `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).
"""
@type collect_config_tipping :: %{
optional(:amount_eligible) => integer() | nil,
optional(String.t()) => term()
}
end