Class: Stripe::PaymentIntentIncrementAuthorizationParams

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/payment_intent_increment_authorization_params.rb

Defined Under Namespace

Classes: AmountDetails, Hooks, PaymentDetails, PaymentMethodOptions, TransferData

Instance Attribute Summary collapse

Instance Method Summary collapse

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) ⇒ PaymentIntentIncrementAuthorizationParams

Returns a new instance of PaymentIntentIncrementAuthorizationParams.



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/stripe/params/payment_intent_increment_authorization_params.rb', line 269

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.



246
247
248
 
# File 'lib/stripe/params/payment_intent_increment_authorization_params.rb', line 246

def amount
  @amount
end

#amount_details ⇒ Object

Provides industry-specific information about the amount.



248
249
250
 
# File 'lib/stripe/params/payment_intent_increment_authorization_params.rb', line 248

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).



250
251
252
 
# File 'lib/stripe/params/payment_intent_increment_authorization_params.rb', line 250

def application_fee_amount
  @application_fee_amount
end

#description ⇒ Object

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



252
253
254
 
# File 'lib/stripe/params/payment_intent_increment_authorization_params.rb', line 252

def description
  @description
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



254
255
256
 
# File 'lib/stripe/params/payment_intent_increment_authorization_params.rb', line 254

def expand
  @expand
end

#hooks ⇒ Object

Automations to be run during the PaymentIntent lifecycle



256
257
258
 
# File 'lib/stripe/params/payment_intent_increment_authorization_params.rb', line 256

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`.



258
259
260
 
# File 'lib/stripe/params/payment_intent_increment_authorization_params.rb', line 258

def metadata
  @metadata
end

#payment_details ⇒ Object

Provides industry-specific information about the charge.



260
261
262
 
# File 'lib/stripe/params/payment_intent_increment_authorization_params.rb', line 260

def payment_details
  @payment_details
end

#payment_method_options ⇒ Object

Payment method-specific configuration for this PaymentIntent.



262
263
264
 
# File 'lib/stripe/params/payment_intent_increment_authorization_params.rb', line 262

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).



264
265
266
 
# File 'lib/stripe/params/payment_intent_increment_authorization_params.rb', line 264

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).



267
268
269
 
# File 'lib/stripe/params/payment_intent_increment_authorization_params.rb', line 267

def transfer_data
  @transfer_data
end