exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.SDK.BalanceTransactions (exoapi_stripe v0.1.4)

Link to this section Summary

Types

get_balance_transactions_id_opts()
get_balance_transactions_opts()

Functions

get_balance_transactions(client, opts \\ [])

description: <p>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.</p>

get_balance_transactions_id(client, id, opts \\ [])

description: <p>Retrieves the balance transaction with the given ID.</p>

Link to this section Types

Link to this type

get_balance_transactions_id_opts()

View Source 
@type get_balance_transactions_id_opts() :: {:expand, String.t()}
Link to this type

get_balance_transactions_opts()

View Source 
@type get_balance_transactions_opts() ::
  {:type, String.t()}
  | {:starting_after, String.t()}
  | {:source, String.t()}
  | {:payout, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:currency, String.t()}
  | {:created, String.t()}

Link to this section Functions

Link to this function

get_balance_transactions(client, opts \\ [])

View Source 
@spec get_balance_transactions(client :: ExOAPI.Client.t(), [
  get_balance_transactions_opts()
]) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | %{
       url: String.t(),
       object: String.t() | :list,
       has_more: boolean(),
       data: [ExOAPI.Stripe.Schemas.BalanceTransaction.t()]
     }
   | map()}
  | {:error, any()}

description: <p>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.</p>

Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

Link to this function

get_balance_transactions_id(client, id, opts \\ [])

View Source 
@spec get_balance_transactions_id(
  client :: ExOAPI.Client.t(),
  id :: String.t(),
  [get_balance_transactions_id_opts()]
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.BalanceTransaction.t()
   | map()}
  | {:error, any()}

description: <p>Retrieves the balance transaction with the given ID.</p>

Note that this endpoint previously used the path /v1/balance/history/:id.