Class: Stripe::PaymentIntentService::UpdateParams

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/payment_intent_service.rb

Defined Under Namespace

Classes: AsyncWorkflows, MandateData, PaymentDetails, PaymentMethodData, PaymentMethodOptions, Shipping, TransferData

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, application_fee_amount: nil, async_workflows: nil, capture_method: nil, currency: nil, customer: nil, description: nil, expand: 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) ⇒ UpdateParams

Returns a new instance of UpdateParams.



6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6654

def initialize(
  amount: nil,
  application_fee_amount: nil,
  async_workflows: nil,
  capture_method: nil,
  currency: nil,
  customer: nil,
  description: nil,
  expand: 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
)
  @amount = amount
  @application_fee_amount = application_fee_amount
  @async_workflows = async_workflows
  @capture_method = capture_method
  @currency = currency
  @customer = customer
  @description = description
  @expand = expand
  @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

#amount ⇒ Object

Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](stripe.com/docs/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](stripe.com/docs/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).



6592
6593
6594
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6592

def amount
  @amount
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 payment amount. For more information, see the PaymentIntents [use case for connected accounts](stripe.com/docs/payments/connected-accounts).



6594
6595
6596
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6594

def application_fee_amount
  @application_fee_amount
end

#async_workflows ⇒ Object

Automations to be run during the PaymentIntent lifecycle



6596
6597
6598
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6596

def async_workflows
  @async_workflows
end

#capture_method ⇒ Object

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



6598
6599
6600
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6598

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



6600
6601
6602
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6600

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](stripe.com/docs/api#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.



6606
6607
6608
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6606

def customer
  @customer
end

#description ⇒ Object

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



6608
6609
6610
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6608

def description
  @description
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



6610
6611
6612
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6610

def expand
  @expand
end

#mandate_data ⇒ Object

This hash contains details about the Mandate to create.



6612
6613
6614
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6612

def mandate_data
  @mandate_data
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`.



6614
6615
6616
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6614

def metadata
  @metadata
end

#payment_details ⇒ Object

Provides industry-specific information about the charge.



6616
6617
6618
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6616

def payment_details
  @payment_details
end

#payment_method ⇒ Object

Attribute for param field payment_method



6618
6619
6620
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6618

def payment_method
  @payment_method
end

#payment_method_configuration ⇒ Object

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



6620
6621
6622
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6620

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](stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method) property on the PaymentIntent.



6624
6625
6626
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6624

def payment_method_data
  @payment_method_data
end

#payment_method_options ⇒ Object

Payment-method-specific configuration for this PaymentIntent.



6626
6627
6628
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6626

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



6628
6629
6630
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6628

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



6630
6631
6632
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6630

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



6640
6641
6642
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6640

def setup_future_usage
  @setup_future_usage
end

#shipping ⇒ Object

Shipping information for this PaymentIntent.



6642
6643
6644
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6642

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.



6646
6647
6648
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6646

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.



6648
6649
6650
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6648

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



6650
6651
6652
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6650

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



6652
6653
6654
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6652

def transfer_group
  @transfer_group
end