class

Stripe::PaymentIntentDataParams

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 [automatic, automatic_async, manual]."
ERROR_MESSAGE_FOR_SETUP_FUTURE_USAGE = "invalid value for \"setup_future_usage\", must be one of [off_session, on_session]."
MAX_LENGTH_FOR_DESCRIPTION = 1000
MAX_LENGTH_FOR_STATEMENT_DESCRIPTOR = 22
MAX_LENGTH_FOR_STATEMENT_DESCRIPTOR_SUFFIX = 22
MAX_LENGTH_FOR_TRANSFER_GROUP = 5000
VALID_VALUES_FOR_CAPTURE_METHOD = String.static_array("automatic", "automatic_async", "manual")
VALID_VALUES_FOR_SETUP_FUTURE_USAGE = String.static_array("off_session", "on_session")

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, application_fee_amount : Int64 | Nil = nil, capture_method : String | Nil = nil, description : String | Nil = nil, metadata : Hash(String, String) | Nil = nil, on_behalf_of : String | Nil = nil, receipt_email : String | Nil = nil, setup_future_usage : String | Nil = nil, shipping : Stripe::Shipping | Nil = nil, statement_descriptor : String | Nil = nil, statement_descriptor_suffix : String | Nil = nil, transfer_data : Stripe::TransferDataParams | Nil = nil, transfer_group : String | 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

application_fee_amount

The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents use case for connected accounts.

Source
application_fee_amount=(new_value : Int64 | Nil)

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

Source
capture_method

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

Source
capture_method=(new_value : String | Nil)

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

Source
description

An arbitrary string attached to the object. Often useful for displaying to users.

Source
description=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] description 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

list_invalid_properties

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

Source
metadata
Source
metadata=(new_value : Hash(String, String) | Nil)

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

Source
on_behalf_of

The Stripe account ID for which these funds are intended. For details, see the PaymentIntents use case for connected accounts.

Source
on_behalf_of=(new_value : String | Nil)

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

Source
receipt_email

Email address that the receipt for the resulting payment will be sent to. If receipt_email is specified for a payment in live mode, a receipt will be sent regardless of your email settings.

Source
receipt_email=(new_value : String | Nil)

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

Source
setup_future_usage

Indicates that you intend to make future payments with the payment method collected by this Checkout Session. When setting this to on_session, Checkout will show a notice to the customer that their payment details will be saved. When setting this to off_session, Checkout will show a notice to the customer that their payment details will be saved and used for future payments. If a Customer has been provided or Checkout creates a new Customer,Checkout will attach the payment method to the Customer. If Checkout does not create a Customer, the payment method is not attached to a Customer. To reuse the payment method, you can retrieve it from the Checkout Session's PaymentIntent. When processing card payments, Checkout also uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.

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
shipping
Source
shipping=(new_value : Stripe::Shipping | Nil)

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

Source
statement_descriptor

Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs. Setting this value for a card charge returns an error. For card charges, set the statement_descriptor_suffix instead.

Source
statement_descriptor=(new_value : String | Nil)

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

Source
statement_descriptor_suffix

Provides information about a card charge. Concatenated to the account's statement descriptor prefix to form the complete statement descriptor that appears on the customer's statement.

Source
statement_descriptor_suffix=(new_value : String | Nil)

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

Source
transfer_data
Source
transfer_data=(new_value : Stripe::TransferDataParams | Nil)

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

Source
transfer_group

A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.

Source
transfer_group=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] transfer_group 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