Class: Stripe::Order::UpdateParams::Payment::Settings

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/order.rb

Defined Under Namespace

Classes: PaymentMethodOptions, TransferData

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(application_fee_amount: nil, payment_method_options: nil, payment_method_types: nil, return_url: nil, statement_descriptor: nil, statement_descriptor_suffix: nil, transfer_data: nil) ⇒ Settings

Returns a new instance of Settings.



2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
 
# File 'lib/stripe/resources/order.rb', line 2831

def initialize(
  application_fee_amount: nil,
  payment_method_options: nil,
  payment_method_types: nil,
  return_url: nil,
  statement_descriptor: nil,
  statement_descriptor_suffix: nil,
  transfer_data: nil
)
  @application_fee_amount = application_fee_amount
  @payment_method_options = payment_method_options
  @payment_method_types = payment_method_types
  @return_url = return_url
  @statement_descriptor = statement_descriptor
  @statement_descriptor_suffix = statement_descriptor_suffix
  @transfer_data = transfer_data
end

Instance Attribute Details

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



2817
2818
2819
 
# File 'lib/stripe/resources/order.rb', line 2817

def application_fee_amount
  @application_fee_amount
end

#payment_method_options ⇒ Object

PaymentMethod-specific configuration to provide to the order’s PaymentIntent.



2819
2820
2821
 
# File 'lib/stripe/resources/order.rb', line 2819

def payment_method_options
  @payment_method_options
end

#payment_method_types ⇒ Object

The list of [payment method types](stripe.com/docs/payments/payment-methods/overview) to provide to the order’s PaymentIntent. Do not include this attribute if you prefer to manage your payment methods from the [Stripe Dashboard](dashboard.stripe.com/settings/payment_methods).



2821
2822
2823
 
# File 'lib/stripe/resources/order.rb', line 2821

def payment_method_types
  @payment_method_types
end

#return_url ⇒ Object

The URL to redirect the customer to after they authenticate their payment.



2823
2824
2825
 
# File 'lib/stripe/resources/order.rb', line 2823

def return_url
  @return_url
end

#statement_descriptor ⇒ Object

For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.



2825
2826
2827
 
# File 'lib/stripe/resources/order.rb', line 2825

def statement_descriptor
  @statement_descriptor
end

#statement_descriptor_suffix ⇒ Object

Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.



2827
2828
2829
 
# File 'lib/stripe/resources/order.rb', line 2827

def statement_descriptor_suffix
  @statement_descriptor_suffix
end

#transfer_data ⇒ Object

Provides configuration for completing a transfer for the order after it is paid.



2829
2830
2831
 
# File 'lib/stripe/resources/order.rb', line 2829

def transfer_data
  @transfer_data
end