Class: Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Card

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

Defined Under Namespace

Classes: Installments, Restrictions

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(installments: nil, request_decremental_authorization: nil, request_extended_authorization: nil, request_incremental_authorization: nil, request_multicapture: nil, request_overcapture: nil, request_three_d_secure: nil, restrictions: nil, setup_future_usage: nil, statement_descriptor_suffix_kana: nil, statement_descriptor_suffix_kanji: nil) ⇒ Card

Returns a new instance of Card.



2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
 
# File 'lib/stripe/resources/checkout/session.rb', line 2086

def initialize(
  installments: nil,
  request_decremental_authorization: nil,
  request_extended_authorization: nil,
  request_incremental_authorization: nil,
  request_multicapture: nil,
  request_overcapture: nil,
  request_three_d_secure: nil,
  restrictions: nil,
  setup_future_usage: nil,
  statement_descriptor_suffix_kana: nil,
  statement_descriptor_suffix_kanji: nil
)
  @installments = installments
  @request_decremental_authorization = request_decremental_authorization
  @request_extended_authorization = request_extended_authorization
  @request_incremental_authorization = request_incremental_authorization
  @request_multicapture = request_multicapture
  @request_overcapture = request_overcapture
  @request_three_d_secure = request_three_d_secure
  @restrictions = restrictions
  @setup_future_usage = setup_future_usage
  @statement_descriptor_suffix_kana = statement_descriptor_suffix_kana
  @statement_descriptor_suffix_kanji = statement_descriptor_suffix_kanji
end

Instance Attribute Details

#installments ⇒ Object

Installment options for card payments



2058
2059
2060
 
# File 'lib/stripe/resources/checkout/session.rb', line 2058

def installments
  @installments
end

#request_decremental_authorization ⇒ Object

Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.



2060
2061
2062
 
# File 'lib/stripe/resources/checkout/session.rb', line 2060

def request_decremental_authorization
  @request_decremental_authorization
end

#request_extended_authorization ⇒ Object

Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.



2062
2063
2064
 
# File 'lib/stripe/resources/checkout/session.rb', line 2062

def request_extended_authorization
  @request_extended_authorization
end

#request_incremental_authorization ⇒ Object

Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.



2064
2065
2066
 
# File 'lib/stripe/resources/checkout/session.rb', line 2064

def request_incremental_authorization
  @request_incremental_authorization
end

#request_multicapture ⇒ Object

Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.



2066
2067
2068
 
# File 'lib/stripe/resources/checkout/session.rb', line 2066

def request_multicapture
  @request_multicapture
end

#request_overcapture ⇒ Object

Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.



2068
2069
2070
 
# File 'lib/stripe/resources/checkout/session.rb', line 2068

def request_overcapture
  @request_overcapture
end

#request_three_d_secure ⇒ Object

We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to ‘automatic`. Read our guide on [manually requesting 3D Secure](stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.



2070
2071
2072
 
# File 'lib/stripe/resources/checkout/session.rb', line 2070

def request_three_d_secure
  @request_three_d_secure
end

#restrictions ⇒ Object

Restrictions to apply to the card payment method. For example, you can block specific card brands.



2072
2073
2074
 
# File 'lib/stripe/resources/checkout/session.rb', line 2072

def restrictions
  @restrictions
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).



2080
2081
2082
 
# File 'lib/stripe/resources/checkout/session.rb', line 2080

def setup_future_usage
  @setup_future_usage
end

#statement_descriptor_suffix_kana ⇒ Object

Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the concatenation of both prefix and suffix (including separators) will appear truncated to 22 characters.



2082
2083
2084
 
# File 'lib/stripe/resources/checkout/session.rb', line 2082

def statement_descriptor_suffix_kana
  @statement_descriptor_suffix_kana
end

#statement_descriptor_suffix_kanji ⇒ Object

Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the concatenation of both prefix and suffix (including separators) will appear truncated to 17 characters.



2084
2085
2086
 
# File 'lib/stripe/resources/checkout/session.rb', line 2084

def statement_descriptor_suffix_kanji
  @statement_descriptor_suffix_kanji
end