Class: Stripe::PaymentIntentUpdateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/payment_intent_update_params.rb

Defined Under Namespace

Classes: AllocatedFunds, AmountDetails, Hooks, MandateData, PaymentDetails, PaymentMethodData, PaymentMethodOptions, Shipping, TransferData

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, field_encodings, new, #to_h

Constructor Details

#initialize(allocated_funds: nil, amount: nil, amount_details: nil, application_fee_amount: nil, capture_method: nil, currency: nil, customer: nil, customer_account: nil, description: nil, excluded_payment_method_types: nil, expand: nil, fx_quote: nil, hooks: nil, mandate_data: nil, metadata: nil, payment_details: nil, payment_method: nil, payment_method_configuration: nil, payment_method_data: nil, payment_method_options: nil, payment_method_types: nil, receipt_email: nil, setup_future_usage: nil, shipping: nil, statement_descriptor: nil, statement_descriptor_suffix: nil, transfer_data: nil, transfer_group: nil) ⇒ PaymentIntentUpdateParams

Returns a new instance of PaymentIntentUpdateParams.



6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6241

def initialize(
  allocated_funds: nil,
  amount: nil,
  amount_details: nil,
  application_fee_amount: nil,
  capture_method: nil,
  currency: nil,
  customer: nil,
  customer_account: nil,
  description: nil,
  excluded_payment_method_types: nil,
  expand: nil,
  fx_quote: nil,
  hooks: nil,
  mandate_data: nil,
  metadata: nil,
  payment_details: nil,
  payment_method: nil,
  payment_method_configuration: nil,
  payment_method_data: nil,
  payment_method_options: nil,
  payment_method_types: nil,
  receipt_email: nil,
  setup_future_usage: nil,
  shipping: nil,
  statement_descriptor: nil,
  statement_descriptor_suffix: nil,
  transfer_data: nil,
  transfer_group: nil
)
  @allocated_funds = allocated_funds
  @amount = amount
  @amount_details = amount_details
  @application_fee_amount = application_fee_amount
  @capture_method = capture_method
  @currency = currency
  @customer = customer
  @customer_account = 
  @description = description
  @excluded_payment_method_types = excluded_payment_method_types
  @expand = expand
  @fx_quote = fx_quote
  @hooks = hooks
  @mandate_data = mandate_data
  @metadata = metadata
  @payment_details = payment_details
  @payment_method = payment_method
  @payment_method_configuration = payment_method_configuration
  @payment_method_data = payment_method_data
  @payment_method_options = payment_method_options
  @payment_method_types = payment_method_types
  @receipt_email = receipt_email
  @setup_future_usage = setup_future_usage
  @shipping = shipping
  @statement_descriptor = statement_descriptor
  @statement_descriptor_suffix = statement_descriptor_suffix
  @transfer_data = transfer_data
  @transfer_group = transfer_group
end

Instance Attribute Details

#allocated_funds ⇒ Object

Allocated Funds configuration for this PaymentIntent.



6165
6166
6167
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6165

def allocated_funds
  @allocated_funds
end

#amount ⇒ Object

Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).



6167
6168
6169
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6167

def amount
  @amount
end

#amount_details ⇒ Object

Provides industry-specific information about the amount.



6169
6170
6171
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6169

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



6171
6172
6173
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6171

def application_fee_amount
  @application_fee_amount
end

#capture_method ⇒ Object

Controls when the funds will be captured from the customer’s account.



6173
6174
6175
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6173

def capture_method
  @capture_method
end

#currency ⇒ Object

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



6175
6176
6177
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6175

def currency
  @currency
end

#customer ⇒ Object

ID of the Customer this PaymentIntent belongs to, if one exists.

Payment methods attached to other Customers cannot be used with this PaymentIntent.

If [setup_future_usage](api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent’s payment method is not ‘card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn’t a digital wallet, then a [generated_card](docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.



6181
6182
6183
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6181

def customer
  @customer
end

#customer_account ⇒ Object

ID of the Account representing the customer that this PaymentIntent belongs to, if one exists.

Payment methods attached to other Accounts cannot be used with this PaymentIntent.

If [setup_future_usage](api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent’s payment method is not ‘card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn’t a digital wallet, then a [generated_card](docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead.



6187
6188
6189
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6187

def 
  @customer_account
end

#description ⇒ Object

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



6189
6190
6191
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6189

def description
  @description
end

#excluded_payment_method_types ⇒ Object

The list of payment method types to exclude from use with this payment.



6191
6192
6193
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6191

def excluded_payment_method_types
  @excluded_payment_method_types
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



6193
6194
6195
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6193

def expand
  @expand
end

#fx_quote ⇒ Object

The FX rate in the quote is validated and used to convert the presentment amount to the settlement amount.



6195
6196
6197
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6195

def fx_quote
  @fx_quote
end

#hooks ⇒ Object

Automations to be run during the PaymentIntent lifecycle



6197
6198
6199
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6197

def hooks
  @hooks
end

#mandate_data ⇒ Object

This hash contains details about the Mandate to create.



6199
6200
6201
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6199

def mandate_data
  @mandate_data
end

#metadata ⇒ Object

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



6201
6202
6203
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6201

def metadata
  @metadata
end

#payment_details ⇒ Object

Provides industry-specific information about the charge.



6203
6204
6205
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6203

def payment_details
  @payment_details
end

#payment_method ⇒ Object

Attribute for param field payment_method



6205
6206
6207
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6205

def payment_method
  @payment_method
end

#payment_method_configuration ⇒ Object

The ID of the [payment method configuration](docs.stripe.com/api/payment_method_configurations) to use with this PaymentIntent.



6207
6208
6209
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6207

def payment_method_configuration
  @payment_method_configuration
end

#payment_method_data ⇒ Object

If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear in the [payment_method](docs.stripe.com/api/payment_intents/object#payment_intent_object-payment_method) property on the PaymentIntent.



6211
6212
6213
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6211

def payment_method_data
  @payment_method_data
end

#payment_method_options ⇒ Object

Payment-method-specific configuration for this PaymentIntent.



6213
6214
6215
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6213

def payment_method_options
  @payment_method_options
end

#payment_method_types ⇒ Object

The list of payment method types (for example, card) that this PaymentIntent can use. Use ‘automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](docs.stripe.com/api/payment_methods/object#payment_method_object-type).



6215
6216
6217
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6215

def payment_method_types
  @payment_method_types
end

#receipt_email ⇒ Object

Email address that the receipt for the resulting payment will be sent to. If ‘receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](dashboard.stripe.com/account/emails).



6217
6218
6219
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6217

def receipt_email
  @receipt_email
end

#setup_future_usage ⇒ Object

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.

If the payment method is ‘card_present` and isn’t a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.

When processing card payments, Stripe uses ‘setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).

If you’ve already set ‘setup_future_usage` and you’re performing a request using a publishable key, you can only update the value from ‘on_session` to `off_session`.



6227
6228
6229
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6227

def setup_future_usage
  @setup_future_usage
end

#shipping ⇒ Object

Shipping information for this PaymentIntent.



6229
6230
6231
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6229

def shipping
  @shipping
end

#statement_descriptor ⇒ Object

Text that appears on the customer’s statement as the statement descriptor for a non-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).

Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.



6233
6234
6235
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6233

def statement_descriptor
  @statement_descriptor
end

#statement_descriptor_suffix ⇒ Object

Provides information about a card charge. Concatenated to the account’s [statement descriptor prefix](docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer’s statement.



6235
6236
6237
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6235

def statement_descriptor_suffix
  @statement_descriptor_suffix
end

#transfer_data ⇒ Object

Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the [use case for connected accounts](docs.stripe.com/payments/connected-accounts).



6237
6238
6239
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6237

def transfer_data
  @transfer_data
end

#transfer_group ⇒ Object

A string that identifies the resulting payment as part of a group. You can only provide ‘transfer_group` if it hasn’t been set. Learn more about the [use case for connected accounts](docs.stripe.com/payments/connected-accounts).



6239
6240
6241
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 6239

def transfer_group
  @transfer_group
end