Class: Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::Paypal

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

Defined Under Namespace

Classes: LineItem

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(capture_method: nil, line_items: nil, preferred_locale: nil, reference: nil, reference_id: nil, risk_correlation_id: nil, setup_future_usage: nil, subsellers: nil) ⇒ Paypal

Returns a new instance of Paypal.



1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
 
# File 'lib/stripe/services/order_service.rb', line 1711

def initialize(
  capture_method: nil,
  line_items: nil,
  preferred_locale: nil,
  reference: nil,
  reference_id: nil,
  risk_correlation_id: nil,
  setup_future_usage: nil,
  subsellers: nil
)
  @capture_method = capture_method
  @line_items = line_items
  @preferred_locale = preferred_locale
  @reference = reference
  @reference_id = reference_id
  @risk_correlation_id = risk_correlation_id
  @setup_future_usage = setup_future_usage
  @subsellers = subsellers
end

Instance Attribute Details

#capture_method ⇒ Object

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



1687
1688
1689
 
# File 'lib/stripe/services/order_service.rb', line 1687

def capture_method
  @capture_method
end

#line_items ⇒ Object

The line items purchased by the customer.



1689
1690
1691
 
# File 'lib/stripe/services/order_service.rb', line 1689

def line_items
  @line_items
end

#preferred_locale ⇒ Object

[Preferred locale](stripe.com/docs/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.



1691
1692
1693
 
# File 'lib/stripe/services/order_service.rb', line 1691

def preferred_locale
  @preferred_locale
end

#reference ⇒ Object

A reference of the PayPal transaction visible to customer which is mapped to PayPal’s invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.



1693
1694
1695
 
# File 'lib/stripe/services/order_service.rb', line 1693

def reference
  @reference
end

#reference_id ⇒ Object

A reference of the PayPal transaction visible to customer which is mapped to PayPal’s invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.



1695
1696
1697
 
# File 'lib/stripe/services/order_service.rb', line 1695

def reference_id
  @reference_id
end

#risk_correlation_id ⇒ Object

The risk correlation ID for an on-session payment using a saved PayPal payment method.



1697
1698
1699
 
# File 'lib/stripe/services/order_service.rb', line 1697

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



1707
1708
1709
 
# File 'lib/stripe/services/order_service.rb', line 1707

def setup_future_usage
  @setup_future_usage
end

#subsellers ⇒ Object

The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](stripe.com/docs/connect/separate-charges-and-transfers) are used.



1709
1710
1711
 
# File 'lib/stripe/services/order_service.rb', line 1709

def subsellers
  @subsellers
end