PaymentIntent class

Constructors

PaymentIntent.new({required String id, required int amount, Map<String, dynamic>? automatic_payment_methods, required Map<String, dynamic> charges, required String client_secret, required String currency, required String? customer, required String? description, Map<String, dynamic>? last_payment_error, Map<String, dynamic>? metadata, required String? payment_method, Map<String, dynamic>? next_action, required List<String> payment_method_types, required String? receipt_email, String? setup_future_usage, Map<String, dynamic>? shipping, String? statement_descriptor, String? statement_descriptor_suffix, required String status})

Properties

amount int
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).
final
automatic_payment_methods Map<String, dynamic>?
Settings to configure compatible payment methods from the Stripe Dashboard
final
charges Map<String, dynamic>
Charges that were created by this PaymentIntent, if any.
final
client_secret String
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.
final
currency String
Three-letter ISO currency code, in lowercase. Must be a supported currency.
final
customer String?
ID of the Customer this PaymentIntent belongs to, if one exists. Payment methods attached to other Customers cannot be used with this PaymentIntent. If present in combination with setup_future_usage, this PaymentIntent’s payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.
final
description String?
An arbitrary string attached to the object. Often useful for displaying to users.
final
hashCode int
The hash code for this object.
no setterinherited
id String
Unique identifier for the object.
final
last_payment_error Map<String, dynamic>?
The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.
final
metadata Map<String, dynamic>?
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. For more information, see the documentation.
final
next_action Map<String, dynamic>?
If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.
final
payment_method String?
ID of the payment method used in this PaymentIntent.
final
payment_method_types List<String>
The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.
final
receipt_email String?
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.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
setup_future_usage String?
Indicates that you intend to make future payments with this PaymentIntent’s payment method. Providing this parameter will attach the payment method to the PaymentIntent’s Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes. When processing card payments, Stripe also uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
final
shipping Map<String, dynamic>?
Shipping information for this PaymentIntent.
final
statement_descriptor String?
For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.
final
statement_descriptor_suffix String?
Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
final
status String
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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

parse(Map<String, dynamic> parsedJSON) PaymentIntent