Striped v0.5.0

View Source Stripe.BalanceTransaction (Striped v0.5.0) (generated)

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

Types

available_on()
created()
t()

The balance_transaction type.

Functions

list(client, params \\ %{}, opts \\ [])

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.

retrieve(client, id, params \\ %{}, opts \\ [])

Retrieves the balance transaction with the given ID.

Link to this section Types

Link to this type

available_on()

View Source 
@type available_on() :: %{
  optional(:gt) => integer(),
  optional(:gte) => integer(),
  optional(:lt) => integer(),
  optional(:lte) => integer()
}
Link to this type

created()

View Source 
@type created() :: %{
  optional(:gt) => integer(),
  optional(:gte) => integer(),
  optional(:lt) => integer(),
  optional(:lte) => integer()
}
Link to this type

t()

View Source 
@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.

  • amount Gross amount of the transaction, in %s.
  • available_on The date the transaction's net funds will become available in the Stripe balance.
  • created Time at which the object was created. Measured in seconds since the Unix epoch.
  • currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
  • description An arbitrary string attached to the object. Often useful for displaying to users.
  • exchange_rate The exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then the amount in currency A, times exchange_rate, would be the amount in currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent's amount would be 1000 and currency would be eur. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction's amount would be 1234, currency would be usd, and exchange_rate would be 1.234.
  • fee Fees (in %s) paid for this transaction.
  • fee_details Detailed breakdown of fees (in %s) paid for this transaction.
  • id Unique identifier for the object.
  • net Net amount of the transaction, in %s.
  • object String representing the object's type. Objects of the same type share the same value.
  • reporting_category Learn more about how reporting categories can help you understand balance transactions from an accounting perspective.
  • source The Stripe object to which this transaction is related.
  • status If the transaction's net funds are available in the Stripe balance yet. Either available or pending.
  • type Transaction 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, or transfer_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 consider reporting_category instead.

Link to this section Functions

Link to this function

list(client, params \\ %{}, opts \\ [])

View Source 
@spec list(
  client :: Stripe.t(),
  params :: %{
    optional(:available_on) => available_on() | integer(),
    optional(:created) => created() | integer(),
    optional(:currency) => binary(),
    optional(:ending_before) => binary(),
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:payout) => binary(),
    optional(:source) => binary(),
    optional(:starting_after) => binary(),
    optional(:type) => binary()
  },
  opts :: Keyword.t()
) ::
  {: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
Link to this function

retrieve(client, id, params \\ %{}, opts \\ [])

View Source 
@spec retrieve(
  client :: Stripe.t(),
  id :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {: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}