Struct stripe::BalanceTransaction

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

The resource representing a Stripe "BalanceTransaction".

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

Fields

id: BalanceTransactionId

Unique identifier for the object.

amount: i64

Gross amount of the transaction, in %s.

available_on: Timestamp

The date the transaction's net funds will become available in the Stripe balance.

created: Timestamp

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>

fee: i64

Fees (in %s) paid for this transaction.

fee_details: Vec<Fee>

Detailed breakdown of fees (in %s) paid for this transaction.

net: i64

Net amount of the transaction, in %s.

source: Option<Expandable<BalanceTransactionSource>>

The Stripe object to which this transaction is related.

status: BalanceTransactionStatus

If the transaction's net funds are available in the Stripe balance yet.

Either available or pending.

type_: BalanceTransactionType

Transaction type: adjustment, advance, advance_funding, application_fee, application_fee_refund, charge, connect_collection_transfer, issuing_authorization_hold, issuing_authorization_release, issuing_transaction, payment, payment_failure_refund, payment_refund, payout, payout_cancel, payout_failure, refund, refund_failure, reserve_transaction, reserved_funds, stripe_fee, stripe_fx_fee, tax_fee, topup, topup_reversal, transfer, transfer_cancel, transfer_failure, or transfer_refund.

Learn more about balance transaction types and what they represent.

Methods

impl BalanceTransaction

pub fn retrieve(
    client: &Client,
    id: &BalanceTransactionId
) -> Response<BalanceTransaction>

Retrieves the balance transaction with the given ID.

For more details see https://stripe.com/docs/api/balance/balance_transaction_retrieve.

Trait Implementations

impl Object for BalanceTransaction

type Id = BalanceTransactionId

The canonical id type for this object.

fn id(&self) -> Self::Id

The id of the object.

fn object(&self) -> &'static str

The object's type, typically represented in wire format as the object property.

impl Clone for BalanceTransaction

fn clone(&self) -> BalanceTransaction

Returns a copy 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

Formats the value using the given formatter.

impl Serialize for BalanceTransaction

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for BalanceTransaction

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.