Stripe::PaymentIntent
Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object
A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session. A PaymentIntent transitions through multiple statuses throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge. Related guide: Payment Intents API
Constants
Constructors
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance methods
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
Custom attribute writer method checking allowed values (enum). @param [Object] amount Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] amount_capturable Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] amount_details Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] amount_received Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] application Object to be assigned
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.
Custom attribute writer method checking allowed values (enum). @param [Object] application_fee_amount Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] automatic_payment_methods Object to be assigned
Populated when status is canceled, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.
Custom attribute writer method checking allowed values (enum). @param [Object] canceled_at Object to be assigned
Reason for cancellation of this PaymentIntent, either user-provided (duplicate, fraudulent, requested_by_customer, or abandoned) or generated by Stripe internally (failed_invoice, void_invoice, or automatic).
Custom attribute writer method checking allowed values (enum). @param [Object] cancellation_reason Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] capture_method Object to be assigned
The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs to accept a payment and learn about how client_secret should be handled.
Custom attribute writer method checking allowed values (enum). @param [Object] client_secret Object to be assigned
Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.
Custom attribute writer method checking allowed values (enum). @param [Object] confirmation_method Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] currency Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] customer Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] description Object to be assigned
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] invoice Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] last_payment_error Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] latest_charge Object to be assigned
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] next_action Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] on_behalf_of Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] payment_method Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] payment_method_configuration_details Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] payment_method_options Object to be assigned
The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.
Custom attribute writer method checking allowed values (enum). @param [Object] payment_method_types Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] processing Object to be assigned
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.
Custom attribute writer method checking allowed values (enum). @param [Object] receipt_email Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] review Object to be assigned
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.
Custom attribute writer method checking allowed values (enum). @param [Object] setup_future_usage Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] shipping Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] source Object to be assigned
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.
Custom attribute writer method checking allowed values (enum). @param [Object] statement_descriptor Object to be assigned
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.
Custom attribute writer method checking allowed values (enum). @param [Object] statement_descriptor_suffix Object to be assigned
Status of this PaymentIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, or succeeded. Read more about each PaymentIntent status.
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] transfer_data Object to be assigned
A string that identifies the resulting payment as part of a group. Learn more about the use case for connected accounts.
Custom attribute writer method checking allowed values (enum). @param [Object] transfer_group Object to be assigned
Check to see if the all the properties in the model are valid @return true if the model is valid