PaymentIntent class final

PaymentIntent

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](https://stripe.com/docs/payments/intents#intent-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](https://stripe.com/docs/payments/payment-intents)

Implemented types

Constructors

PaymentIntent({required int amount, required int amountCapturable, PaymentFlowsAmountDetails? amountDetails, required int amountReceived, ApplicationOrId? application, int? applicationFeeAmount, PaymentFlowsAutomaticPaymentMethodsPaymentIntent? automaticPaymentMethods, DateTime? canceledAt, PaymentIntentCancellationReason? cancellationReason, required PaymentIntentCaptureMethod captureMethod, String? clientSecret, required CustomerBalanceCustomerBalanceSettingsReconciliationMode confirmationMethod, required DateTime created, required String currency, BankAccountCustomerOrId? customer, String? description, required String id, InvoiceOrId? invoice, ApiErrors? lastPaymentError, ChargeOrId? latestCharge, required bool livemode, required Map<String, String> metadata, PaymentIntentNextAction? nextAction, AccountOrId? onBehalfOf, PaymentMethodOrId? paymentMethod, CheckoutSessionPaymentMethodConfigurationDetails? paymentMethodConfigurationDetails, PaymentIntentPaymentMethodOptions? paymentMethodOptions, required List<String> paymentMethodTypes, PaymentIntentProcessing? processing, String? receiptEmail, ReviewOrId? review, ConfirmationTokenSetupFutureUsage? setupFutureUsage, ChargeShipping? shipping, PaymentIntentSourceOrId? source, String? statementDescriptor, String? statementDescriptorSuffix, required PaymentIntentStatus status, PaymentIntentTransferData? transferData, String? transferGroup}): PaymentIntent
const
PaymentIntent.fromJson(Object? json): factory

Properties

amount → int: final
amountCapturable → int: final
amountDetails → PaymentFlowsAmountDetails?: final
amountReceived → int: final
application → ApplicationOrId?: final
applicationFeeAmount → int?: final
automaticPaymentMethods → PaymentFlowsAutomaticPaymentMethodsPaymentIntent?: final
canceledAt → DateTime?: final
cancellationReason → PaymentIntentCancellationReason?: final
captureMethod → PaymentIntentCaptureMethod: final
clientSecret → String?: final
confirmationMethod → CustomerBalanceCustomerBalanceSettingsReconciliationMode: final
created → DateTime: final
currency → String: final
customer → BankAccountCustomerOrId?: final
description → String?: final
hashCode → int: The hash code for this object.
no setterinherited
id → String: The ID of the PaymentIntent.
final
invoice → InvoiceOrId?: final
lastPaymentError → ApiErrors?: final
latestCharge → ChargeOrId?: final
livemode → bool: final
metadata → Map<String, String>: final
nextAction → PaymentIntentNextAction?: 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
object → String: The resource's type.
final
onBehalfOf → AccountOrId?: final
paymentMethod → PaymentMethodOrId?: final
paymentMethodConfigurationDetails → CheckoutSessionPaymentMethodConfigurationDetails?: final
paymentMethodOptions → PaymentIntentPaymentMethodOptions?: Payment-method-specific configuration for this PaymentIntent.
final
paymentMethodTypes → List<String>: final
processing → PaymentIntentProcessing?: If present, this property tells you about the processing state of the payment.
final
receiptEmail → String?: final
review → ReviewOrId?: final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
setupFutureUsage → ConfirmationTokenSetupFutureUsage?: final
shipping → ChargeShipping?: final
source → PaymentIntentSourceOrId?: final
statementDescriptor → String?: final
statementDescriptorSuffix → String?: final
status → PaymentIntentStatus: final
transferData → PaymentIntentTransferData?: The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
final
transferGroup → String?: final

Methods

encodeWith<V>(Encoder<V> encoder) → V: override
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, Object?>: override
toString() → String: A string representation of this object.
override

Operators

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

Static Methods

encode<V>(PaymentIntent instance, Encoder<V> encoder) → V: override