Struct BalanceTransaction

pub struct BalanceTransaction {

    pub amount: i64,
    pub available_on: i64,
    pub created: i64,
    pub currency: Currency,
    pub description: Option<String>,
    pub exchange_rate: Option<f64>,
    pub fee: i64,
    pub fee_details: Vec<Fee>,
    pub id: BalanceTransactionId,
    pub net: i64,
    pub reporting_category: String,
    pub source: Option<Expandable<BalanceTransactionSource>>,
    pub status: String,
    pub type_: BalanceTransactionType,
}

Balance transactions represent funds moving through your Stripe account. Stripe creates them for every type of transaction that enters or leaves your Stripe account balance.

Related guide: Balance transaction types.

For more details see <https://stripe.com/docs/api/balance_transactions/object>.

Fields

amount: i64

Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party.

available_on: i64

The date that the transaction’s net funds become available in the Stripe balance.

created: i64

Time at which the object was created. Measured in seconds since the Unix epoch.

currency: Currency

Three-letter ISO currency code, in lowercase. Must be a supported currency.

description: Option<String>

An arbitrary string attached to the object. Often useful for displaying to users.

exchange_rate: Option<f64>

If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the amount in currency A, multipled by the exchange_rate, equals the amount in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent’s amount is 1000 and currency is eur. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction’s amount is 1234, its currency is usd, and the exchange_rate is 1.234.

fee: i64

Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed.

fee_details: Vec<Fee>

Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction.

id: BalanceTransactionId

Unique identifier for the object.

net: i64

Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by amount - fee.

reporting_category: String

Learn more about how reporting categories can help you understand balance transactions from an accounting perspective.

source: Option<Expandable<BalanceTransactionSource>>

This transaction relates to the Stripe object.

status: String

The transaction’s net funds status in the Stripe balance, which are either available or pending.

type_: BalanceTransactionType

Transaction type: adjustment, advance, advance_funding, anticipation_repayment, application_fee, application_fee_refund, charge, climate_order_purchase, climate_order_refund, connect_collection_transfer, contribution, issuing_authorization_hold, issuing_authorization_release, issuing_dispute, issuing_transaction, obligation_outbound, obligation_reversal_inbound, payment, payment_failure_refund, payment_network_reserve_hold, payment_network_reserve_release, payment_refund, payment_reversal, payment_unreconciled, payout, payout_cancel, payout_failure, payout_minimum_balance_hold, payout_minimum_balance_release, refund, refund_failure, reserve_transaction, reserved_funds, stripe_fee, stripe_fx_fee, stripe_balance_payment_debit, stripe_balance_payment_debit_reversal, tax_fee, topup, topup_reversal, transfer, transfer_cancel, transfer_failure, or transfer_refund. Learn more about balance transaction types and what they represent. To classify transactions for accounting purposes, consider reporting_category instead.

Trait Implementations

impl Clone for BalanceTransaction

fn clone(&self) -> BalanceTransaction

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BalanceTransaction

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deserialize for BalanceTransaction

fn begin(out: &mut Option<BalanceTransaction>) -> &mut dyn Visitor

The only correct implementation of this method is:

impl Object for BalanceTransaction

type Id = BalanceTransactionId

The canonical id type for this object.

fn id(&self) -> &<BalanceTransaction as Object>::Id

The id of the object.

fn into_id(self) -> <BalanceTransaction as Object>::Id

The owned id of the object.

impl ObjectDeser for BalanceTransaction

type Builder = BalanceTransactionBuilder