Class: Increase::Resources::IntrafiBalances

Inherits:

Object

• Object
• Increase::Resources::IntrafiBalances

Defined in:

lib/increase/resources/intrafi_balances.rb

Instance Method Summary

• #initialize(client:) ⇒ IntrafiBalances constructor private

  A new instance of IntrafiBalances.

• #intrafi_balance(account_id, request_options: {}) ⇒ Increase::Models::IntrafiBalance

  Returns the IntraFi balance for the given account.

Constructor Details

#initialize(client:) ⇒ IntrafiBalances

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 IntrafiBalances.

Parameters:

• client (Increase::Client)

# File 'lib/increase/resources/intrafi_balances.rb', line 31

def initialize(client:)
  @client = client
end

Instance Method Details

#intrafi_balance(account_id, request_options: {}) ⇒ Increase::Models::IntrafiBalance

Returns the IntraFi balance for the given account. IntraFi may sweep funds to multiple banks. This endpoint will include both the total balance and the amount swept to each institution.

Parameters:

• account_id (String) —

  The identifier of the Account to get balances for.

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

Returns:

• (Increase::Models::IntrafiBalance)

See Also:

• Models::IntrafiBalanceIntrafiBalanceParams

# File 'lib/increase/resources/intrafi_balances.rb', line 19

def intrafi_balance(account_id, params = {})
  @client.request(
    method: :get,
    path: ["accounts/%1$s/intrafi_balance", account_id],
    model: Increase::IntrafiBalance,
    options: params[:request_options]
  )
end