Class: Lithic::Resources::AggregateBalances

Inherits:

Object

• Object
• Lithic::Resources::AggregateBalances

Defined in:

lib/lithic/resources/aggregate_balances.rb

Instance Method Summary

• #initialize(client:) ⇒ AggregateBalances constructor private

  A new instance of AggregateBalances.

• #list(financial_account_type: nil, request_options: {}) ⇒ Lithic::Internal::SinglePage<Lithic::Models::AggregateBalance>

  Get the aggregated balance across all end-user accounts by financial account type.

Constructor Details

#initialize(client:) ⇒ AggregateBalances

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of AggregateBalances.

Parameters:

• client (Lithic::Client)

# File 'lib/lithic/resources/aggregate_balances.rb', line 33

def initialize(client:)
  @client = client
end

Instance Method Details

#list(financial_account_type: nil, request_options: {}) ⇒ Lithic::Internal::SinglePage<Lithic::Models::AggregateBalance>

Get the aggregated balance across all end-user accounts by financial account type

Parameters:

• financial_account_type (Symbol, Lithic::Models::AggregateBalanceListParams::FinancialAccountType) —

  Get the aggregate balance for a given Financial Account type.

• request_options (Lithic::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Lithic::Internal::SinglePage<Lithic::Models::AggregateBalance>)

See Also:

• Models::AggregateBalanceListParams

# File 'lib/lithic/resources/aggregate_balances.rb', line 18

def list(params = {})
  parsed, options = Lithic::AggregateBalanceListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "v1/aggregate_balances",
    query: parsed,
    page: Lithic::Internal::SinglePage,
    model: Lithic::AggregateBalance,
    options: options
  )
end