Class: Stripe::OrderService::CreateParams::Payment::Settings

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/order_service.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.



835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'lib/stripe/services/order_service.rb', line 835

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.



821
822
823
 
# File 'lib/stripe/services/order_service.rb', line 821

def application_fee_amount
  @application_fee_amount
end

#payment_method_options ⇒ Object

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



823
824
825
 
# File 'lib/stripe/services/order_service.rb', line 823

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



825
826
827
 
# File 'lib/stripe/services/order_service.rb', line 825

def payment_method_types
  @payment_method_types
end

#return_url ⇒ Object

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



827
828
829
 
# File 'lib/stripe/services/order_service.rb', line 827

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.



829
830
831
 
# File 'lib/stripe/services/order_service.rb', line 829

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.



831
832
833
 
# File 'lib/stripe/services/order_service.rb', line 831

def statement_descriptor_suffix
  @statement_descriptor_suffix
end

#transfer_data ⇒ Object

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



833
834
835
 
# File 'lib/stripe/services/order_service.rb', line 833

def transfer_data
  @transfer_data
end