PaymentIntent
A PaymentIntent tracks the process of collecting a payment from your customer.
Types
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).
Controls when the funds will be captured from the customer’s account.
The payment error encountered in the previous PaymentIntent confirmation.
Properties
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).
Populated when status
is canceled
, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch. If unavailable, will return 0.
Reason for cancellation of this PaymentIntent.
Controls when the funds will be captured from the customer’s account. See CaptureMethod.
The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.
One of automatic (default) or manual. See ConfirmationMethod.
Country code of the user.
An arbitrary string attached to the object. Often useful for displaying to users.
Whether confirmation has succeeded and all required actions have been handled.
Has the value true
if the object exists in live mode or the value false
if the object exists in test mode.
The payment error encountered in the previous PaymentIntent confirmation.
Payment types that are accepted when paying with Link.
The expanded PaymentMethod represented by paymentMethodId.
ID of the payment method (a PaymentMethod, Card, BankAccount, or saved Source object) to attach to this PaymentIntent.
The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.
Email address that the receipt for the resulting payment will be sent to.
Shipping information for this PaymentIntent.
Status of this PaymentIntent.
Payment types that have not been activated in livemode, but have been activated in testmode.