Class: Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card

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

Defined Under Namespace

Classes: Installments, MandateOptions, StatementDetails, ThreeDSecure

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(capture_method: nil, cvc_token: nil, installments: nil, mandate_options: nil, moto: nil, network: nil, request_decremental_authorization: nil, request_extended_authorization: nil, request_incremental_authorization: nil, request_multicapture: nil, request_overcapture: nil, request_partial_authorization: nil, request_three_d_secure: nil, require_cvc_recollection: nil, setup_future_usage: nil, statement_descriptor_suffix_kana: nil, statement_descriptor_suffix_kanji: nil, statement_details: nil, three_d_secure: nil) ⇒ Card

Returns a new instance of Card.



4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
 
# File 'lib/stripe/resources/payment_intent.rb', line 4421

def initialize(
  capture_method: nil,
  cvc_token: nil,
  installments: nil,
  mandate_options: nil,
  moto: nil,
  network: nil,
  request_decremental_authorization: nil,
  request_extended_authorization: nil,
  request_incremental_authorization: nil,
  request_multicapture: nil,
  request_overcapture: nil,
  request_partial_authorization: nil,
  request_three_d_secure: nil,
  require_cvc_recollection: nil,
  setup_future_usage: nil,
  statement_descriptor_suffix_kana: nil,
  statement_descriptor_suffix_kanji: nil,
  statement_details: nil,
  three_d_secure: nil
)
  @capture_method = capture_method
  @cvc_token = cvc_token
  @installments = installments
  @mandate_options = mandate_options
  @moto = moto
  @network = network
  @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_partial_authorization = request_partial_authorization
  @request_three_d_secure = request_three_d_secure
  @require_cvc_recollection = require_cvc_recollection
  @setup_future_usage = setup_future_usage
  @statement_descriptor_suffix_kana = statement_descriptor_suffix_kana
  @statement_descriptor_suffix_kanji = statement_descriptor_suffix_kanji
  @statement_details = statement_details
  @three_d_secure = three_d_secure
end

Instance Attribute Details

#capture_method ⇒ Object

Controls when the funds are captured from the customer’s account.

If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type.

If ‘capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.



4352
4353
4354
 
# File 'lib/stripe/resources/payment_intent.rb', line 4352

def capture_method
  @capture_method
end

#cvc_token ⇒ Object

A single-use ‘cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation.



4355
4356
4357
 
# File 'lib/stripe/resources/payment_intent.rb', line 4355

def cvc_token
  @cvc_token
end

#installments ⇒ Object

Installment configuration for payments attempted on this PaymentIntent (Mexico Only).

For more information, see the [installments integration guide](stripe.com/docs/payments/installments).



4360
4361
4362
 
# File 'lib/stripe/resources/payment_intent.rb', line 4360

def installments
  @installments
end

#mandate_options ⇒ Object

Configuration options for setting up an eMandate for cards issued in India.



4363
4364
4365
 
# File 'lib/stripe/resources/payment_intent.rb', line 4363

def mandate_options
  @mandate_options
end

#moto ⇒ Object

When specified, this parameter indicates that a transaction will be marked as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This parameter can only be provided during confirmation.



4368
4369
4370
 
# File 'lib/stripe/resources/payment_intent.rb', line 4368

def moto
  @moto
end

#network ⇒ Object

Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent. Can be only set confirm-time.



4371
4372
4373
 
# File 'lib/stripe/resources/payment_intent.rb', line 4371

def network
  @network
end

#request_decremental_authorization ⇒ Object

Request ability to [decrement the authorization](stripe.com/docs/payments/decremental-authorization) for this PaymentIntent.



4374
4375
4376
 
# File 'lib/stripe/resources/payment_intent.rb', line 4374

def request_decremental_authorization
  @request_decremental_authorization
end

#request_extended_authorization ⇒ Object

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



4377
4378
4379
 
# File 'lib/stripe/resources/payment_intent.rb', line 4377

def request_extended_authorization
  @request_extended_authorization
end

#request_incremental_authorization ⇒ Object

Request ability to [increment the authorization](stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.



4380
4381
4382
 
# File 'lib/stripe/resources/payment_intent.rb', line 4380

def request_incremental_authorization
  @request_incremental_authorization
end

#request_multicapture ⇒ Object

Request ability to make [multiple captures](stripe.com/docs/payments/multicapture) for this PaymentIntent.



4383
4384
4385
 
# File 'lib/stripe/resources/payment_intent.rb', line 4383

def request_multicapture
  @request_multicapture
end

#request_overcapture ⇒ Object

Request ability to [overcapture](stripe.com/docs/payments/overcapture) for this PaymentIntent.



4386
4387
4388
 
# File 'lib/stripe/resources/payment_intent.rb', line 4386

def request_overcapture
  @request_overcapture
end

#request_partial_authorization ⇒ Object

Request partial authorization on this PaymentIntent.



4389
4390
4391
 
# File 'lib/stripe/resources/payment_intent.rb', line 4389

def request_partial_authorization
  @request_partial_authorization
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.



4392
4393
4394
 
# File 'lib/stripe/resources/payment_intent.rb', line 4392

def request_three_d_secure
  @request_three_d_secure
end

#require_cvc_recollection ⇒ Object

When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).



4395
4396
4397
 
# File 'lib/stripe/resources/payment_intent.rb', line 4395

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



4406
4407
4408
 
# File 'lib/stripe/resources/payment_intent.rb', line 4406

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.



4409
4410
4411
 
# File 'lib/stripe/resources/payment_intent.rb', line 4409

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.



4412
4413
4414
 
# File 'lib/stripe/resources/payment_intent.rb', line 4412

def statement_descriptor_suffix_kanji
  @statement_descriptor_suffix_kanji
end

#statement_details ⇒ Object

Statement details for this payment intent. You can use this to override the merchant details shown on your customers’ statements.



4415
4416
4417
 
# File 'lib/stripe/resources/payment_intent.rb', line 4415

def statement_details
  @statement_details
end

#three_d_secure ⇒ Object

If 3D Secure authentication was performed with a third-party provider, the authentication details to use for this payment.



4419
4420
4421
 
# File 'lib/stripe/resources/payment_intent.rb', line 4419

def three_d_secure
  @three_d_secure
end