Class: Stripe::PaymentIntent::IncrementAuthorizationParams

Inherits:

RequestParams

• Object
• RequestParams
• Stripe::PaymentIntent::IncrementAuthorizationParams

Defined in:

lib/stripe/resources/payment_intent.rb

Defined Under Namespace

Classes: AmountDetails, Hooks, PaymentDetails, PaymentMethodOptions, TransferData

Instance Attribute Summary

• #amount ⇒ Object

  The updated total amount that you intend to collect from the cardholder.

• #amount_details ⇒ Object

  Provides industry-specific information about the amount.

• #application_fee_amount ⇒ Object

  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.

• #description ⇒ Object

  An arbitrary string attached to the object.

• #expand ⇒ Object

  Specifies which fields in the response should be expanded.

• #hooks ⇒ Object

  Automations to be run during the PaymentIntent lifecycle.

• #metadata ⇒ Object

  Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object.

• #payment_details ⇒ Object

  Provides industry-specific information about the charge.

• #payment_method_options ⇒ Object

  Payment method-specific configuration for this PaymentIntent.

• #statement_descriptor ⇒ Object

  Text that appears on the customer’s statement as the statement descriptor for a non-card or card charge.

• #transfer_data ⇒ Object

  The parameters used to automatically create a transfer after the payment is captured.

Instance Method Summary

• #initialize(amount: nil, amount_details: nil, application_fee_amount: nil, description: nil, expand: nil, hooks: nil, metadata: nil, payment_details: nil, payment_method_options: nil, statement_descriptor: nil, transfer_data: nil) ⇒ IncrementAuthorizationParams constructor

  A new instance of IncrementAuthorizationParams.

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, amount_details: nil, application_fee_amount: nil, description: nil, expand: nil, hooks: nil, metadata: nil, payment_details: nil, payment_method_options: nil, statement_descriptor: nil, transfer_data: nil) ⇒ IncrementAuthorizationParams

Returns a new instance of IncrementAuthorizationParams.

# File 'lib/stripe/resources/payment_intent.rb', line 16023

def initialize(
  amount: nil,
  amount_details: nil,
  application_fee_amount: nil,
  description: nil,
  expand: nil,
  hooks: nil,
  metadata: nil,
  payment_details: nil,
  payment_method_options: nil,
  statement_descriptor: nil,
  transfer_data: nil
)
  @amount = amount
  @amount_details = amount_details
  @application_fee_amount = application_fee_amount
  @description = description
  @expand = expand
  @hooks = hooks
  @metadata = metadata
  @payment_details = payment_details
  @payment_method_options = payment_method_options
  @statement_descriptor = statement_descriptor
  @transfer_data = transfer_data
end

Instance Attribute Details

#amount ⇒ Object

The updated total amount that you intend to collect from the cardholder. This amount must be greater than the currently authorized amount.

# File 'lib/stripe/resources/payment_intent.rb', line 16000

def amount
  @amount
end

#amount_details ⇒ Object

Provides industry-specific information about the amount.

# File 'lib/stripe/resources/payment_intent.rb', line 16002

def amount_details
  @amount_details
end

#application_fee_amount ⇒ Object

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](stripe.com/docs/payments/connected-accounts).

# File 'lib/stripe/resources/payment_intent.rb', line 16004

def application_fee_amount
  @application_fee_amount
end

#description ⇒ Object

An arbitrary string attached to the object. Often useful for displaying to users.

# File 'lib/stripe/resources/payment_intent.rb', line 16006

def description
  @description
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.

# File 'lib/stripe/resources/payment_intent.rb', line 16008

def expand
  @expand
end

#hooks ⇒ Object

Automations to be run during the PaymentIntent lifecycle

# File 'lib/stripe/resources/payment_intent.rb', line 16010

def hooks
  @hooks
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/docs/api/metadata) 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`.

# File 'lib/stripe/resources/payment_intent.rb', line 16012

def metadata
  @metadata
end

#payment_details ⇒ Object

Provides industry-specific information about the charge.

# File 'lib/stripe/resources/payment_intent.rb', line 16014

def payment_details
  @payment_details
end

#payment_method_options ⇒ Object

Payment method-specific configuration for this PaymentIntent.

# File 'lib/stripe/resources/payment_intent.rb', line 16016

def payment_method_options
  @payment_method_options
end

#statement_descriptor ⇒ Object

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](docs.stripe.com/get-started/account/statement-descriptors).

# File 'lib/stripe/resources/payment_intent.rb', line 16018

def statement_descriptor
  @statement_descriptor
end

#transfer_data ⇒ Object

The parameters used to automatically create a transfer after the payment is captured. Learn more about the [use case for connected accounts](stripe.com/docs/payments/connected-accounts).

# File 'lib/stripe/resources/payment_intent.rb', line 16021

def transfer_data
  @transfer_data
end