Class: Increase::Models::Transaction

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/increase/models/transaction.rb

Defined Under Namespace

Classes: Source

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

#[], #inspect, #to_h, #to_s

Instance Attribute Details

#account_idString

The identifier for the Account the Transaction belongs to.

Returns:

  • (String)


14
# File 'lib/increase/models/transaction.rb', line 14

required :account_id, String

#amountInteger

The Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.

Returns:

  • (Integer)


19
# File 'lib/increase/models/transaction.rb', line 19

required :amount, Integer

#created_atString

The ISO 8601 date on which the Transaction occurred.

Returns:

  • (String)


24
# File 'lib/increase/models/transaction.rb', line 24

required :created_at, String

#currencySymbol

The ISO 4217 code for the Transaction's currency. This will match the currency on the Transaction's Account.

Returns:

  • (Symbol)


29
# File 'lib/increase/models/transaction.rb', line 29

required :currency, Increase::Enum.new(:CAD, :CHF, :EUR, :GBP, :JPY, :USD)

#descriptionString

An informational message describing this transaction. Use the fields in source to get more detailed information. This field appears as the line-item on the statement.

Returns:

  • (String)


34
# File 'lib/increase/models/transaction.rb', line 34

required :description, String

#idString

The Transaction identifier.

Returns:

  • (String)


9
# File 'lib/increase/models/transaction.rb', line 9

required :id, String

#route_idString

The identifier for the route this Transaction came through. Routes are things like cards and ACH details.

Returns:

  • (String)


39
# File 'lib/increase/models/transaction.rb', line 39

required :route_id, String

#route_typeSymbol

The type of the route this Transaction came through.

Returns:

  • (Symbol)


44
# File 'lib/increase/models/transaction.rb', line 44

required :route_type, Increase::Enum.new(:account_number, :card, :lockbox)

#sourceIncrease::Models::Transaction::Source

This is an object giving more details on the network-level event that caused the Transaction. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.



49
# File 'lib/increase/models/transaction.rb', line 49

required :source, -> { Increase::Models::Transaction::Source }

#typeSymbol

A constant representing the object's type. For this resource it will always be transaction.

Returns:

  • (Symbol)


54
# File 'lib/increase/models/transaction.rb', line 54

required :type, Increase::Enum.new(:transaction)