Class: Lithic::Resources::Cards::Balances

Inherits:
Object
  • Object
show all
Defined in:
lib/lithic/resources/cards/balances.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Balances

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

Parameters:



40
41
42
 
# File 'lib/lithic/resources/cards/balances.rb', line 40

def initialize(client:)
  @client = client
end

Instance Method Details

#list(card_token, balance_date: nil, last_transaction_event_token: nil, request_options: {}) ⇒ Lithic::Internal::SinglePage<Lithic::Models::FinancialAccountBalance>

Some parameter documentations has been truncated, see Models::Cards::BalanceListParams for more details.

Get the balances for a given card.

Parameters:

  • card_token (String)
  • balance_date (Time) —

    UTC date of the balance to retrieve. Defaults to latest available balance

  • last_transaction_event_token (String) —

    Balance after a given financial event occured.

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

Returns:

See Also:



25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/lithic/resources/cards/balances.rb', line 25

def list(card_token, params = {})
  parsed, options = Lithic::Cards::BalanceListParams.dump_request(params)
  @client.request(
    method: :get,
    path: ["v1/cards/%1$s/balances", card_token],
    query: parsed,
    page: Lithic::Internal::SinglePage,
    model: Lithic::FinancialAccountBalance,
    options: options
  )
end