Stripe.Params.PaymentIntentIncrementAuthorizationParams
(tiger_stripe v0.3.0)
Copy Markdown
View Source
Parameters for payment intent increment authorization.
Summary
Types
@type amount_details() :: %{ optional(:discount_amount) => map() | nil, optional(:enforce_arithmetic_validation) => boolean() | nil, optional(:line_items) => map() | nil, optional(:shipping) => map() | nil, optional(:tax) => map() | nil, optional(String.t()) => term() }
discount_amount- The total discount applied on the transaction represented in the smallest currency unit. An integer greater than 0.
This field is mutually exclusive with the amount_details[line_items][#][discount_amount] field.
enforce_arithmetic_validation- Set tofalseto return arithmetic validation errors in the response without failing the request. Use this when you want the operation to proceed regardless of arithmetic errors in the line item data.
Omit or set to true to immediately return a 400 error when arithmetic validation fails. Use this for strict validation that prevents processing with line item data that has arithmetic inconsistencies.
For card payments, Stripe doesn't send line item data if there's an arithmetic validation error to card networks.
line_items- A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 200 line items.shipping- Contains information about the shipping portion of the amount.tax- Contains information about the tax portion of the amount.
@type hooks() :: %{ optional(:inputs) => hooks_inputs() | nil, optional(String.t()) => term() }
inputs- Arguments passed in automations
@type hooks_inputs() :: %{ optional(:tax) => hooks_inputs_tax() | nil, optional(String.t()) => term() }
tax- Tax arguments for automations
@type hooks_inputs_tax() :: %{ optional(:calculation) => map() | nil, optional(String.t()) => term() }
calculation- The TaxCalculation id
@type payment_details() :: %{ optional(:customer_reference) => map() | nil, optional(:order_reference) => map() | nil, optional(String.t()) => term() }
customer_reference- A unique value to identify the customer. This field is available only for card payments.
This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks.
order_reference- A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates.
Required when the Payment Method Types array contains card, including when automatic_payment_methods.enabled is set to true.
For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app.
@type t() :: %Stripe.Params.PaymentIntentIncrementAuthorizationParams{ amount: integer(), amount_details: amount_details() | nil, application_fee_amount: integer() | nil, description: String.t() | nil, expand: [String.t()] | nil, hooks: hooks() | nil, metadata: %{required(String.t()) => String.t()} | nil, payment_details: payment_details() | nil, statement_descriptor: String.t() | nil, transfer_data: transfer_data() | nil }
amount- The updated total amount that you intend to collect from the cardholder. This amount must be greater than the currently authorized amount.amount_details- Provides industry-specific information about the amount.application_fee_amount- The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents use case for connected accounts.description- An arbitrary string attached to the object. Often useful for displaying to users. Max length: 1000.expand- Specifies which fields in the response should be expanded.hooks- Automations to be run during the PaymentIntent lifecyclemetadata- 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 tometadata.payment_details- Provides industry-specific information about the charge.statement_descriptor- Text that appears on the customer's statement as the statement descriptor for a non-card or card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs. Max length: 22.transfer_data- The parameters used to automatically create a transfer after the payment is captured. Learn more about the use case for connected accounts.
amount- The amount that will be transferred automatically when a charge succeeds.