View Source Stripe.BalanceTransaction (Striped v0.1.0)
Balance transactions represent funds moving through your Stripe account. They're created for every type of transaction that comes into or flows out of your Stripe account balance.
Related guide: Balance Transaction Types.
Link to this section Summary
Functions
Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.
Retrieves the balance transaction with the given ID.
Link to this section Types
@type t() :: %Stripe.BalanceTransaction{ amount: integer(), available_on: integer(), created: integer(), currency: binary(), description: binary() | nil, exchange_rate: term() | nil, fee: integer(), fee_details: term(), id: binary(), net: integer(), object: binary(), reporting_category: binary(), source: (binary() | term()) | nil, status: binary(), type: binary() }
The balance_transaction type.
amountGross amount of the transaction, in %s.available_onThe date the transaction's net funds will become available in the Stripe balance.createdTime at which the object was created. Measured in seconds since the Unix epoch.currencyThree-letter ISO currency code, in lowercase. Must be a supported currency.descriptionAn arbitrary string attached to the object. Often useful for displaying to users.exchange_rateThe exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then theamountin currency A, timesexchange_rate, would be theamountin currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent'samountwould be1000andcurrencywould beeur. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction'samountwould be1234,currencywould beusd, andexchange_ratewould be1.234.feeFees (in %s) paid for this transaction.fee_detailsDetailed breakdown of fees (in %s) paid for this transaction.idUnique identifier for the object.netNet amount of the transaction, in %s.objectString representing the object's type. Objects of the same type share the same value.reporting_categoryLearn more about how reporting categories can help you understand balance transactions from an accounting perspective.sourceThe Stripe object to which this transaction is related.statusIf the transaction's net funds are available in the Stripe balance yet. Eitheravailableorpending.typeTransaction type:adjustment,advance,advance_funding,anticipation_repayment,application_fee,application_fee_refund,charge,connect_collection_transfer,contribution,issuing_authorization_hold,issuing_authorization_release,issuing_dispute,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, ortransfer_refund. Learn more about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might want to considerreporting_categoryinstead.
Link to this section Functions
@spec list(client :: term(), params :: map()) :: {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.
Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
Details
- Method:
get - Path:
/v1/balance_transactions
Query parameters
:available_onany of:- object with (optional) properties:
gt: integergte: integerlt: integerlte: integer
- integer
- object with (optional) properties:
:createdany of:- object with (optional) properties:
gt: integergte: integerlt: integerlte: integer
- integer
- object with (optional) properties:
:currencystring:ending_beforestring:expandarray of: string:limitinteger:payoutstring:sourcestring:starting_afterstring:typestring
@spec retrieve(client :: term(), id :: binary(), params :: map()) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Retrieves the balance transaction with the given ID.
Note that this endpoint previously used the path /v1/balance/history/:id.
Details
- Method:
get - Path:
/v1/balance_transactions/{id}
Query parameters
:expandarray of: string