PaymentIntent class abstract

A payment intent represents the interaction between the user and the payment form.

For more detailed info see: https://stripe.com/docs/payments/payment-intents.

Available extensions

• PaymentIntentPatterns

Annotations

• @freezed

Constructors

PaymentIntent.new({required String id, required num amount, required String created, required String currency, required PaymentIntentsStatus status, required String clientSecret, required bool livemode, required CaptureMethod captureMethod, required ConfirmationMethod confirmationMethod, String? paymentMethodId, String? description, String? receiptEmail, String? canceledAt, NextAction? nextAction, ShippingDetails? shipping, MandateData? mandateData, String? latestCharge})

const

factory

PaymentIntent.fromJson(Map<String, dynamic> json)

factory

Properties

amount → num

Amount that will be collected in the payment intent.

no setter, inherited

canceledAt → String?

Timestamp since epoch when the intent is cancelled.

no setter, inherited

captureMethod → CaptureMethod

How the funds will be caputure from the customer's account.

no setter, inherited

clientSecret → String

The client is secret is used for handling the payment from the Client side.

no setter, inherited

confirmationMethod → ConfirmationMethod

Method of how the payment will be confirmed.

no setter, inherited

copyWith → $PaymentIntentCopyWith<PaymentIntent>

Create a copy of PaymentIntent with the given fields replaced by the non-null parameter values.

no setter, inherited

created → String

Timestamp since epoch that represents the time the intent is created.

no setter, inherited

currency → String

The three letter ISO 4217 code for the currency.

no setter, inherited

description → String?

Localized description that provides additional context to users.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

id → String

Unique identifier.

no setter, inherited

latestCharge → String?

The latest charge created by this payment intent.

no setter, inherited

livemode → bool

Determines whether the intent is in live mode or in test mode.

no setter, inherited

mandateData → MandateData?

Mandata data for this paymentintent.

no setter, inherited

nextAction → NextAction?

Additional action that needs to be taken in order to complete a payment using the provided resource.

no setter, inherited

paymentMethodId → String?

Id of the payment method used in this intent.

no setter, inherited

receiptEmail → String?

Email address where the receipt will be send to.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

shipping → ShippingDetails?

Shipping information of the payment intent.

no setter, inherited

status → PaymentIntentsStatus

Current status of the intent.

no setter, inherited

Methods

map<TResult extends Object?>(TResult $default(_PaymentIntent value)) → TResult

Available on PaymentIntent, provided by the PaymentIntentPatterns extension

A switch-like method, using callbacks.

mapOrNull<TResult extends Object?>(TResult? $default(_PaymentIntent value)?) → TResult?

Available on PaymentIntent, provided by the PaymentIntentPatterns extension

A variant of map that fallback to returning null.

maybeMap<TResult extends Object?>(TResult $default(_PaymentIntent value)?, {required TResult orElse()}) → TResult

Available on PaymentIntent, provided by the PaymentIntentPatterns extension

A variant of map that fallback to returning orElse.

maybeWhen<TResult extends Object?>(TResult $default(String id, num amount, String created, String currency, PaymentIntentsStatus status, String clientSecret, bool livemode, CaptureMethod captureMethod, ConfirmationMethod confirmationMethod, String? paymentMethodId, String? description, String? receiptEmail, String? canceledAt, NextAction? nextAction, ShippingDetails? shipping, MandateData? mandateData, String? latestCharge)?, {required TResult orElse()}) → TResult

Available on PaymentIntent, provided by the PaymentIntentPatterns extension

A variant of when that fallback to an orElse callback.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Serializes this PaymentIntent to a JSON map.

inherited

toString() → String

A string representation of this object.

inherited

when<TResult extends Object?>(TResult $default(String id, num amount, String created, String currency, PaymentIntentsStatus status, String clientSecret, bool livemode, CaptureMethod captureMethod, ConfirmationMethod confirmationMethod, String? paymentMethodId, String? description, String? receiptEmail, String? canceledAt, NextAction? nextAction, ShippingDetails? shipping, MandateData? mandateData, String? latestCharge)) → TResult

Available on PaymentIntent, provided by the PaymentIntentPatterns extension

A switch-like method, using callbacks.

whenOrNull<TResult extends Object?>(TResult? $default(String id, num amount, String created, String currency, PaymentIntentsStatus status, String clientSecret, bool livemode, CaptureMethod captureMethod, ConfirmationMethod confirmationMethod, String? paymentMethodId, String? description, String? receiptEmail, String? canceledAt, NextAction? nextAction, ShippingDetails? shipping, MandateData? mandateData, String? latestCharge)?) → TResult?

Available on PaymentIntent, provided by the PaymentIntentPatterns extension

A variant of when that fallback to returning null

Operators

operator ==(Object other) → bool

The equality operator.

inherited