Payout class final

A transfer of balance funds to a configured financial-account destination.

status and the lifecycle timestamps describe execution progress. failure and error provide caller-safe failure information when the payout does not complete.

Constructors

Payout({Amount? amount, String? balanceTransactionId, List<BalanceTransaction>? balanceTransactions, DateTime? canceledAt, CustomData? customData, required String destinationId, Error? error, required DateTime executeAfter, String? executedBy, DateTime? expectedAt, DateTime? failedAt, Failure? failure, required String id, required DateTime initiatedAt, String? initiatedBy, required Amount maxAmount, String? reference, String? scheduleId, DateTime? scheduledAt, String? scheduledBy, DateTime? sentAt, String? sourceId, required Status status, DateTime? succeededAt})
const
Payout.fromJson(Map<String, Object?> json)
factory

Properties

amount → Amount?
final
balanceTransactionId → String?
final
balanceTransactions → List<BalanceTransaction>?
final
canceledAt → DateTime?
final
customData → CustomData?
final
destinationId → String
final
error → Error?
final
executeAfter → DateTime
final
executedBy → String?
final
expectedAt → DateTime?
final
failedAt → DateTime?
final
failure → Failure?
final
hashCode → int
The hash code for this object.
no setterinherited
id → String
final
initiatedAt → DateTime
final
initiatedBy → String?
final
maxAmount → Amount
final
reference → String?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scheduledAt → DateTime?
final
scheduledBy → String?
final
scheduleId → String?
final
sentAt → DateTime?
final
sourceId → String?
final
status → Status
final
succeededAt → DateTime?
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