PaymentIntent
The PaymentIntent represents your intent to collect payment from a customer, tracking the lifecycle of the payment process through each step. Each PaymentIntent typically correlates with a single “cart” or customer session in your application.
Use of this SDK is subject to the Stripe Terminal Terms: https://stripe.com/terminal/legal
Properties
Get the amount of the PaymentIntent
Amount that can be captured from this PaymentIntent
Details about items included in the amount
Amount that was collected by this PaymentIntent.
Indicates how much the user intends to tip in addition to the amount by at confirmation time. This is only non-null in the PaymentIntent instance returned during collect when using updatePaymentIntent set to true in the CollectConfiguration. After confirmPaymentIntent the amount will have this tip amount added to it and the amountDetails will contain the breakdown of how much of the amount was a tip.
ID of the Connect application that created the PaymentIntent
The amount of the application fee for this PaymentIntent
Populated when status is PaymentIntentStatus.CANCELED, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.
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).
One of automatic (default) or manual. When the capture method is automatic, Stripe automatically captures funds when the customer authorizes the payment.
Get the client secret returned by this intent.
One of automatic (default) or manual. When the confirmation method is automatic, a PaymentIntent can be confirmed using a publishable key. After next_actions are handled, no additional confirmation is required to complete the payment.
Time at which the PaymentIntent was created. Measured in seconds since the Unix epoch.
ID of the Customer this PaymentIntent belongs to, if one exists. If present, payment methods used with this PaymentIntent can only be attached to this Customer, and payment methods attached to other Customers cannot be used with this PaymentIntent.
An arbitrary string attached to the PaymentIntent. Often useful for displaying to users.
Get the unique identifier for the PaymentIntent
ID of the invoice that created this PaymentIntent, if it exists.
The payment error encountered in the previous PaymentIntent confirmation.
Next Action required
The offlineDetails for this intent, if created or processed while offline. When created offline the id will be nil. The OfflineDetails.requiresUpload can be used to identify that the intent was processed offline and requires the device to be brought back online before the intent can be captured. See Also: How to operate offline
Return the account that the PaymentIntent is on behalf of
Full payment method object from the API.
ID of the payment method used in this PaymentIntent.
PaymentMethod options configured on the payment intent
Available Payment Method Types
Email address that the receipt for the resulting payment will be sent to.
ID of the review associated with this PaymentIntent, if any.
Value of setup_future_usage associated with this PaymentIntent, if any.
Extra information about a PaymentIntent. This will appear on your customer’s statement when this PaymentIntent succeeds in creating a charge.
Extra dynamic information about a PaymentIntent. This will appear concatenated with the statementDescriptor on your customer’s statement when this PaymentIntent succeeds in creating a charge.
Status of this PaymentIntent.
Get the transfer group of this PaymentIntent
Functions
Return the Charge objects associated with this PaymentIntent