Class: Lithic::Resources::FinancialAccounts::FinancialTransactions

Inherits:

Object

• Object
• Lithic::Resources::FinancialAccounts::FinancialTransactions

Defined in:

lib/lithic/resources/financial_accounts/financial_transactions.rb

Instance Method Summary

• #initialize(client:) ⇒ FinancialTransactions constructor private

  A new instance of FinancialTransactions.

• #list(financial_account_token, begin_: nil, category: nil, end_: nil, ending_before: nil, result: nil, starting_after: nil, status: nil, request_options: {}) ⇒ Lithic::Internal::SinglePage<Lithic::Models::FinancialTransaction>

  Some parameter documentations has been truncated, see Models::FinancialAccounts::FinancialTransactionListParams for more details.

• #retrieve(financial_transaction_token, financial_account_token:, request_options: {}) ⇒ Lithic::Models::FinancialTransaction

  Get the financial transaction for the provided token.

Constructor Details

#initialize(client:) ⇒ FinancialTransactions

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

Parameters:

• client (Lithic::Client)

# File 'lib/lithic/resources/financial_accounts/financial_transactions.rb', line 82

def initialize(client:)
  @client = client
end

Instance Method Details

#list(financial_account_token, begin_: nil, category: nil, end_: nil, ending_before: nil, result: nil, starting_after: nil, status: nil, request_options: {}) ⇒ Lithic::Internal::SinglePage<Lithic::Models::FinancialTransaction>

Some parameter documentations has been truncated, see Models::FinancialAccounts::FinancialTransactionListParams for more details.

List the financial transactions for a given financial account.

Parameters:

• financial_account_token (String) —

  Globally unique identifier for financial account.

• begin_ (Time) —

  Date string in RFC 3339 format. Only entries created after the specified time wi

• category (Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Category) —

  Financial Transaction category to be returned.

• end_ (Time) —

  Date string in RFC 3339 format. Only entries created before the specified time w

• ending_before (String) —

  A cursor representing an item’s token before which a page of results should end.

• result (Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Result) —

  Financial Transaction result to be returned.

• starting_after (String) —

  A cursor representing an item’s token after which a page of results should begin

• status (Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Status) —

  Financial Transaction status to be returned.

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

Returns:

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

See Also:

• Models::FinancialAccounts::FinancialTransactionListParams

# File 'lib/lithic/resources/financial_accounts/financial_transactions.rb', line 67

def list(financial_account_token, params = {})
  parsed, options = Lithic::FinancialAccounts::FinancialTransactionListParams.dump_request(params)
  @client.request(
    method: :get,
    path: ["v1/financial_accounts/%1$s/financial_transactions", financial_account_token],
    query: parsed.transform_keys(begin_: "begin", end_: "end"),
    page: Lithic::Internal::SinglePage,
    model: Lithic::FinancialTransaction,
    options: options
  )
end

#retrieve(financial_transaction_token, financial_account_token:, request_options: {}) ⇒ Lithic::Models::FinancialTransaction

Get the financial transaction for the provided token.

Parameters:

• financial_transaction_token (String) —

  Globally unique identifier for financial transaction token.

• financial_account_token (String) —

  Globally unique identifier for financial account.

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

Returns:

• (Lithic::Models::FinancialTransaction)

See Also:

• Models::FinancialAccounts::FinancialTransactionRetrieveParams

# File 'lib/lithic/resources/financial_accounts/financial_transactions.rb', line 20

def retrieve(financial_transaction_token, params)
  parsed, options = Lithic::FinancialAccounts::FinancialTransactionRetrieveParams.dump_request(params)
  financial_account_token =
    parsed.delete(:financial_account_token) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: [
      "v1/financial_accounts/%1$s/financial_transactions/%2$s",
      financial_account_token,
      financial_transaction_token
    ],
    model: Lithic::FinancialTransaction,
    options: options
  )
end