Class: Stripe::Checkout::SessionCreateParams::PaymentMethodOptions::Paypal

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/checkout/session_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, preferred_locale: nil, reference: nil, risk_correlation_id: nil, setup_future_usage: nil) ⇒ Paypal

Returns a new instance of Paypal.



1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1523

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

Instance Attribute Details

#capture_method ⇒ Object

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



1505
1506
1507
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1505

def capture_method
  @capture_method
end

#preferred_locale ⇒ Object

Preferred locale of the PayPal checkout page that the customer is redirected to.



1507
1508
1509
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1507

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.



1509
1510
1511
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1509

def reference
  @reference
end

#risk_correlation_id ⇒ Object

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



1511
1512
1513
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1511

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

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.



1521
1522
1523
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1521

def setup_future_usage
  @setup_future_usage
end