class

Stripe::PaymentIntentParam

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

Constants

ERROR_MESSAGE_FOR_CAPTURE_METHOD = "invalid value for \"capture_method\", must be one of [, manual]."
ERROR_MESSAGE_FOR_NETWORK = "invalid value for \"network\", must be one of [amex, cartes_bancaires, diners, discover, eftpos_au, girocard, interac, jcb, mastercard, unionpay, unknown, visa]."
ERROR_MESSAGE_FOR_REQUEST_EXTENDED_AUTHORIZATION = "invalid value for \"request_extended_authorization\", must be one of [if_available, never]."
ERROR_MESSAGE_FOR_REQUEST_INCREMENTAL_AUTHORIZATION = "invalid value for \"request_incremental_authorization\", must be one of [if_available, never]."
ERROR_MESSAGE_FOR_REQUEST_MULTICAPTURE = "invalid value for \"request_multicapture\", must be one of [if_available, never]."
ERROR_MESSAGE_FOR_REQUEST_OVERCAPTURE = "invalid value for \"request_overcapture\", must be one of [if_available, never]."
ERROR_MESSAGE_FOR_REQUEST_THREE_D_SECURE = "invalid value for \"request_three_d_secure\", must be one of [any, automatic, challenge]."
ERROR_MESSAGE_FOR_SETUP_FUTURE_USAGE = "invalid value for \"setup_future_usage\", must be one of [, none, off_session, on_session]."
MAX_LENGTH_FOR_CVC_TOKEN = 5000
MAX_LENGTH_FOR_NETWORK = 5000
VALID_VALUES_FOR_CAPTURE_METHOD = String.static_array("", "manual")
VALID_VALUES_FOR_NETWORK = String.static_array("amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "girocard", "interac", "jcb", "mastercard", "unionpay", "unknown", "visa")
VALID_VALUES_FOR_REQUEST_EXTENDED_AUTHORIZATION = String.static_array("if_available", "never")
VALID_VALUES_FOR_REQUEST_INCREMENTAL_AUTHORIZATION = String.static_array("if_available", "never")
VALID_VALUES_FOR_REQUEST_MULTICAPTURE = String.static_array("if_available", "never")
VALID_VALUES_FOR_REQUEST_OVERCAPTURE = String.static_array("if_available", "never")
VALID_VALUES_FOR_REQUEST_THREE_D_SECURE = String.static_array("any", "automatic", "challenge")
VALID_VALUES_FOR_SETUP_FUTURE_USAGE = String.static_array("", "none", "off_session", "on_session")

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, capture_method : String | Nil = nil, cvc_token : String | Nil = nil, installments : Stripe::InstallmentsParam | Nil = nil, mandate_options : Stripe::MandateOptionsParam | Nil = nil, moto : Bool | Nil = nil, network : String | Nil = nil, request_extended_authorization : String | Nil = nil, request_incremental_authorization : String | Nil = nil, request_multicapture : String | Nil = nil, request_overcapture : String | Nil = nil, request_three_d_secure : String | Nil = nil, require_cvc_recollection : Bool | Nil = nil, setup_future_usage : String | Nil = nil, statement_descriptor_suffix_kana : Stripe::PaymentIntentParamStatementDescriptorSuffixKana | Nil = nil, statement_descriptor_suffix_kanji : Stripe::PaymentIntentParamStatementDescriptorSuffixKanji | Nil = nil, three_d_secure : Stripe::PaymentMethodOptionsParam | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

capture_method

Controls when the funds are captured from the customer's account. If provided, this parameter overrides the behavior of the top-level 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.

Source
capture_method=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] capture_method Object to be assigned

Source
cvc_token

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.

Source
cvc_token=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] cvc_token Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

installments
Source
installments=(new_value : Stripe::InstallmentsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] installments Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
mandate_options
Source
mandate_options=(new_value : Stripe::MandateOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] mandate_options Object to be assigned

Source
moto

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.

Source
moto=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] moto Object to be assigned

Source
network

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.

Source
network=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] network Object to be assigned

Source
request_extended_authorization

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

Source
request_extended_authorization=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] request_extended_authorization Object to be assigned

Source
request_incremental_authorization

Request ability to increment the authorization for this PaymentIntent.

Source
request_incremental_authorization=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] request_incremental_authorization Object to be assigned

Source
request_multicapture

Request ability to make multiple captures for this PaymentIntent.

Source
request_multicapture=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] request_multicapture Object to be assigned

Source
request_overcapture

Request ability to overcapture for this PaymentIntent.

Source
request_overcapture=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] request_overcapture Object to be assigned

Source
request_three_d_secure

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.

Source
request_three_d_secure=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] request_three_d_secure Object to be assigned

Source
require_cvc_recollection

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

Source
require_cvc_recollection=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] require_cvc_recollection Object to be assigned

Source
setup_future_usage

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.

Source
setup_future_usage=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] setup_future_usage Object to be assigned

Source
statement_descriptor_suffix_kana
Source
statement_descriptor_suffix_kana=(new_value : Stripe::PaymentIntentParamStatementDescriptorSuffixKana | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] statement_descriptor_suffix_kana Object to be assigned

Source
statement_descriptor_suffix_kanji
Source
statement_descriptor_suffix_kanji=(new_value : Stripe::PaymentIntentParamStatementDescriptorSuffixKanji | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] statement_descriptor_suffix_kanji Object to be assigned

Source
three_d_secure
Source
three_d_secure=(new_value : Stripe::PaymentMethodOptionsParam | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] three_d_secure Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source