Charge class final

Charge

The `Charge` object represents a single attempt to move money into your Stripe account. PaymentIntent confirmation is the most common way to create Charges, but transferring money to a different Stripe account through Connect also creates Charges. Some legacy payment flows create Charges directly, which is not recommended for new integrations.

Implemented types

Constructors

Charge({required int amount, required int amountCaptured, required int amountRefunded, ApplicationOrId? application, ApplicationFeeOrId? applicationFee, int? applicationFeeAmount, String? authorizationCode, BalanceTransactionOrId? balanceTransaction, required BillingDetails billingDetails, String? calculatedStatementDescriptor, required bool captured, required DateTime created, required String currency, BankAccountCustomerOrId? customer, String? description, required bool disputed, BalanceTransactionOrId? failureBalanceTransaction, String? failureCode, String? failureMessage, ChargeFraudDetails? fraudDetails, required String id, InvoiceOrId? invoice, Level3? level3, required bool livemode, required Map<String, String> metadata, AccountOrId? onBehalfOf, ChargeOutcome? outcome, required bool paid, PaymentIntentOrId? paymentIntent, String? paymentMethod, ChargePaymentMethodDetails? paymentMethodDetails, RadarRadarOptions? radarOptions, String? receiptEmail, String? receiptNumber, String? receiptUrl, required bool refunded, ChargeRefunds? refunds, ReviewOrId? review, ChargeShipping? shipping, ChargeSource? source, TransferOrId? sourceTransfer, String? statementDescriptor, String? statementDescriptorSuffix, required BankConnectionsResourceBalanceRefreshStatus status, TransferOrId? transfer, ChargeTransferData? transferData, String? transferGroup}): Charge
const
Charge.fromJson(Object? json): factory

Properties

amount → int: final
amountCaptured → int: final
amountRefunded → int: final
application → ApplicationOrId?: final
applicationFee → ApplicationFeeOrId?: final
applicationFeeAmount → int?: final
authorizationCode → String?: final
balanceTransaction → BalanceTransactionOrId?: final
billingDetails → BillingDetails: final
calculatedStatementDescriptor → String?: final
captured → bool: final
created → DateTime: final
currency → String: final
customer → BankAccountCustomerOrId?: final
description → String?: final
disputed → bool: final
failureBalanceTransaction → BalanceTransactionOrId?: final
failureCode → String?: final
failureMessage → String?: final
fraudDetails → ChargeFraudDetails?: Information on fraud assessments for the charge.
final
hashCode → int: The hash code for this object.
no setterinherited
id → String: The ID of the BalanceTransactionSource.
final
invoice → InvoiceOrId?: final
level3 → Level3?: final
livemode → bool: final
metadata → Map<String, String>: final
object → String: final
onBehalfOf → AccountOrId?: final
outcome → ChargeOutcome?: Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details.
final
paid → bool: final
paymentIntent → PaymentIntentOrId?: final
paymentMethod → String?: final
paymentMethodDetails → ChargePaymentMethodDetails?: Details about the payment method at the time of the transaction.
final
radarOptions → RadarRadarOptions?: final
receiptEmail → String?: final
receiptNumber → String?: final
receiptUrl → String?: final
refunded → bool: final
refunds → ChargeRefunds?: RefundList
final
review → ReviewOrId?: final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
shipping → ChargeShipping?: Shipping information for the charge.
final
source → ChargeSource?: final
sourceTransfer → TransferOrId?: final
statementDescriptor → String?: final
statementDescriptorSuffix → String?: final
status → BankConnectionsResourceBalanceRefreshStatus: final
transfer → TransferOrId?: final
transferData → ChargeTransferData?: An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.
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>(Charge instance, Encoder<V> encoder) → V: override