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.



6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6584

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



6522
6523
6524
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6522

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



6524
6525
6526
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6524

def application_fee_amount
  @application_fee_amount
end

#async_workflows ⇒ Object

Automations to be run during the PaymentIntent lifecycle



6526
6527
6528
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6526

def async_workflows
  @async_workflows
end

#capture_method ⇒ Object

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



6528
6529
6530
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6528

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



6530
6531
6532
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6530

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.



6536
6537
6538
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6536

def customer
  @customer
end

#description ⇒ Object

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



6538
6539
6540
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6538

def description
  @description
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



6540
6541
6542
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6540

def expand
  @expand
end

#mandate_data ⇒ Object

This hash contains details about the Mandate to create.



6542
6543
6544
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6542

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



6544
6545
6546
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6544

def metadata
  @metadata
end

#payment_details ⇒ Object

Provides industry-specific information about the charge.



6546
6547
6548
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6546

def payment_details
  @payment_details
end

#payment_method ⇒ Object

Attribute for param field payment_method



6548
6549
6550
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6548

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.



6550
6551
6552
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6550

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.



6554
6555
6556
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6554

def payment_method_data
  @payment_method_data
end

#payment_method_options ⇒ Object

Payment-method-specific configuration for this PaymentIntent.



6556
6557
6558
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6556

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



6558
6559
6560
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6558

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



6560
6561
6562
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6560

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



6570
6571
6572
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6570

def setup_future_usage
  @setup_future_usage
end

#shipping ⇒ Object

Shipping information for this PaymentIntent.



6572
6573
6574
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6572

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.



6576
6577
6578
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6576

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.



6578
6579
6580
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6578

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



6580
6581
6582
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6580

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



6582
6583
6584
 
# File 'lib/stripe/services/payment_intent_service.rb', line 6582

def transfer_group
  @transfer_group
end