Class: Stripe::SetupIntentConfirmParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/setup_intent_confirm_params.rb

Defined Under Namespace

Classes: MandateData, PaymentMethodData, PaymentMethodOptions

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(confirmation_token: nil, expand: nil, mandate_data: nil, payment_method: nil, payment_method_data: nil, payment_method_options: nil, return_url: nil, use_stripe_sdk: nil) ⇒ SetupIntentConfirmParams

Returns a new instance of SetupIntentConfirmParams.



1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1030

def initialize(
  confirmation_token: nil,
  expand: nil,
  mandate_data: nil,
  payment_method: nil,
  payment_method_data: nil,
  payment_method_options: nil,
  return_url: nil,
  use_stripe_sdk: nil
)
  @confirmation_token = confirmation_token
  @expand = expand
  @mandate_data = mandate_data
  @payment_method = payment_method
  @payment_method_data = payment_method_data
  @payment_method_options = payment_method_options
  @return_url = return_url
  @use_stripe_sdk = use_stripe_sdk
end

Instance Attribute Details

#confirmation_token ⇒ Object

ID of the ConfirmationToken used to confirm this SetupIntent.

If the provided ConfirmationToken contains properties that are also being provided in this request, such as ‘payment_method`, then the values in this request will take precedence.



1011
1012
1013
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1011

def confirmation_token
  @confirmation_token
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



1013
1014
1015
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1013

def expand
  @expand
end

#mandate_data ⇒ Object

Attribute for param field mandate_data



1015
1016
1017
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1015

def mandate_data
  @mandate_data
end

#payment_method ⇒ Object

ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.



1017
1018
1019
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1017

def payment_method
  @payment_method
end

#payment_method_data ⇒ Object

When included, this hash creates a PaymentMethod that is set as the [‘payment_method`](stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method) value in the SetupIntent.



1020
1021
1022
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1020

def payment_method_data
  @payment_method_data
end

#payment_method_options ⇒ Object

Payment method-specific configuration for this SetupIntent.



1022
1023
1024
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1022

def payment_method_options
  @payment_method_options
end

#return_url ⇒ Object

The URL to redirect your customer back to after they authenticate on the payment method’s app or site. If you’d prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter is only used for cards and other redirect-based payment methods.



1026
1027
1028
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1026

def return_url
  @return_url
end

#use_stripe_sdk ⇒ Object

Set to ‘true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.



1028
1029
1030
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1028

def use_stripe_sdk
  @use_stripe_sdk
end