Class: Stripe::Checkout::SessionCreateParams::PaymentMethodOptions::Card

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/checkout/session_create_params.rb

Defined Under Namespace

Classes: Installments, Restrictions

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



1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1126

def initialize(
  capture_method: nil,
  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
)
  @capture_method = capture_method
  @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

#capture_method ⇒ Object

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



1096
1097
1098
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1096

def capture_method
  @capture_method
end

#installments ⇒ Object

Installment options for card payments



1098
1099
1100
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1098

def installments
  @installments
end

#request_decremental_authorization ⇒ Object

Request ability to capture beyond the standard authorization validity window for this CheckoutSession.



1100
1101
1102
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1100

def request_decremental_authorization
  @request_decremental_authorization
end

#request_extended_authorization ⇒ Object

Request ability to capture beyond the standard authorization validity window for this CheckoutSession.



1102
1103
1104
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1102

def request_extended_authorization
  @request_extended_authorization
end

#request_incremental_authorization ⇒ Object

Request ability to increment the authorization for this CheckoutSession.



1104
1105
1106
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1104

def request_incremental_authorization
  @request_incremental_authorization
end

#request_multicapture ⇒ Object

Request ability to make multiple captures for this CheckoutSession.



1106
1107
1108
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1106

def request_multicapture
  @request_multicapture
end

#request_overcapture ⇒ Object

Request ability to overcapture for this CheckoutSession.



1108
1109
1110
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1108

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. 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 for more information on how this configuration interacts with Radar and our SCA Engine.



1110
1111
1112
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1110

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. You can't set this parameter if ui_mode is custom.



1112
1113
1114
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1112

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



1120
1121
1122
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1120

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.



1122
1123
1124
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1122

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.



1124
1125
1126
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1124

def statement_descriptor_suffix_kanji
  @statement_descriptor_suffix_kanji
end