Payout class final
Payout
A `Payout` object is created when you receive funds from Stripe, or when you initiate a payout to either a bank account or debit card of a [connected Stripe account](/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts, and list all payouts. Payouts are made on [varying schedules](/docs/connect/manage-payout-schedule), depending on your country and industry. Related guide: [Receiving payouts](https://stripe.com/docs/payouts)
- Implemented types
Constructors
-
Payout({required int amount, required DateTime arrivalDate, required bool automatic, BalanceTransactionOrId? balanceTransaction, required DateTime created, required String currency, String? description, PayoutDestinationOrId? destination, BalanceTransactionOrId? failureBalanceTransaction, String? failureCode, String? failureMessage, required String id, required bool livemode, Map<
String, String> ? metadata, required String method, PayoutOrId? originalPayout, required PayoutReconciliationStatus reconciliationStatus, PayoutOrId? reversedBy, required String sourceType, String? statementDescriptor, required String status, required PayoutType type}) -
Payout
const
- Payout.fromJson(Object? json)
-
factory
Properties
- amount → int
-
final
- arrivalDate → DateTime
-
final
- automatic → bool
-
final
- balanceTransaction → BalanceTransactionOrId?
-
final
- created → DateTime
-
final
- currency → String
-
final
- description → String?
-
final
- destination → PayoutDestinationOrId?
-
final
- failureBalanceTransaction → BalanceTransactionOrId?
-
final
- failureCode → String?
-
final
- failureMessage → String?
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
The ID of the BalanceTransactionSource.
final
- livemode → bool
-
final
-
metadata
→ Map<
String, String> ? -
final
- method → String
-
final
- object → String
-
final
- originalPayout → PayoutOrId?
-
final
- reconciliationStatus → PayoutReconciliationStatus
-
final
- reversedBy → PayoutOrId?
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sourceType → String
-
final
- statementDescriptor → String?
-
final
- status → String
-
final
- type → PayoutType
-
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