Class: Stripe::PaymentLinkCreateParams::PaymentIntentData

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

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(capture_method: nil, description: nil, metadata: nil, setup_future_usage: nil, statement_descriptor: nil, statement_descriptor_suffix: nil, transfer_group: nil) ⇒ PaymentIntentData

Returns a new instance of PaymentIntentData.



548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 548

def initialize(
  capture_method: nil,
  description: nil,
  metadata: nil,
  setup_future_usage: nil,
  statement_descriptor: nil,
  statement_descriptor_suffix: nil,
  transfer_group: nil
)
  @capture_method = capture_method
  @description = description
  @metadata = metadata
  @setup_future_usage = setup_future_usage
  @statement_descriptor = statement_descriptor
  @statement_descriptor_suffix = statement_descriptor_suffix
  @transfer_group = transfer_group
end

Instance Attribute Details

#capture_method ⇒ Object

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



522
523
524
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 522

def capture_method
  @capture_method
end

#description ⇒ Object

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



524
525
526
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 524

def description
  @description
end

#metadata ⇒ Object

Set of key-value pairs that will declaratively set metadata on Payment Intents generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.



526
527
528
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 526

def metadata
  @metadata
end

#setup_future_usage ⇒ Object

Indicates that you intend to make future payments with the payment method collected by this Checkout Session.

When setting this to on_session, Checkout will show a notice to the customer that their payment details will be saved.

When setting this to off_session, Checkout will show a notice to the customer that their payment details will be saved and used for future payments.

If a Customer has been provided or Checkout creates a new Customer,Checkout will attach the payment method to the Customer.

If Checkout does not create a Customer, the payment method is not attached to a Customer. To reuse the payment method, you can retrieve it from the Checkout Session's PaymentIntent.

When processing card payments, Checkout also uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.



538
539
540
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 538

def setup_future_usage
  @setup_future_usage
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.

Setting this value for a card charge returns an error. For card charges, set the statement_descriptor_suffix instead.



542
543
544
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 542

def statement_descriptor
  @statement_descriptor
end

#statement_descriptor_suffix ⇒ Object

Provides information about a card charge. Concatenated to the account's statement descriptor prefix to form the complete statement descriptor that appears on the customer's statement.



544
545
546
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 544

def statement_descriptor_suffix
  @statement_descriptor_suffix
end

#transfer_group ⇒ Object

A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.



546
547
548
 
# File 'lib/stripe/params/payment_link_create_params.rb', line 546

def transfer_group
  @transfer_group
end