Payment class final

A payment and its current processing state.

The model includes the amount, lifecycle timestamps, payment-method snapshot, latest attempt, and any nextAction the customer or merchant must complete. Compare status with the constants on Status instead of parsing its wire value directly.

Available extensions

Constructors

Payment({required String id, required Status status, required String statementDescriptor, required Amount amount, BillingDetails? billingDetails, BalanceTransaction? balanceTransaction, Snapshot? paymentMethod, Customer? customer, Receipt? receipt, Attempt? latestAttempt, NextAction? nextAction, Error? latestError, required DateTime initiatedAt, DateTime? executedAt, DateTime? paidAt, DateTime? canceledAt, DateTime? dueAt, DateTime? expiredAt, DateTime? failedAt, bool? paidOffline, List<String>? paymentMethodTypes, PaymentConfiguration? payoutConfiguration})
const
Payment.fromJson(Map<String, Object?> json)
factory

Properties

amount → Amount
final
balanceTransaction → BalanceTransaction?
final
billingDetails → BillingDetails?
final
canceledAt → DateTime?
final
customer → Customer?
final
dueAt → DateTime?
final
executedAt → DateTime?
final
expiredAt → DateTime?
final
failedAt → DateTime?
final
hashCode → int
The hash code for this object.
no setterinherited
id → String
final
initiatedAt → DateTime
final
isPaid → bool

Available on Payment, provided by the PaymentSemantics extension

no setter
isTerminal → bool

Available on Payment, provided by the PaymentSemantics extension

no setter
latestAttempt → Attempt?
final
latestError → Error?
final
nextAction → NextAction?
final
paidAt → DateTime?
final
paidOffline → bool?
final
paymentMethod → Snapshot?
final
paymentMethodTypes → List<String>?
final
payoutConfiguration → PaymentConfiguration?
final
receipt → Receipt?
final
requiredAction → NextAction?

Available on Payment, provided by the PaymentSemantics extension

no setter
requiresAction → bool

Available on Payment, provided by the PaymentSemantics extension

no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
statementDescriptor → String
final
status → Status
final

Methods

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

Operators

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