Class: Tide::API::Transaction

Inherits:
Dry::Struct::Value
  • Object
show all
Defined in:
lib/tide/api/transaction.rb

Overview

Bank account transaction

Constant Summary collapse

CategoryType =

Categories of the transaction

Types::Strict::String.enum('EXPENDITURE', 'INCOME')
Status =

Statuses of the transaction

Types::Strict::String.enum('cleared', 'pending')
Type =

Payment type codes

Types::Strict::String.enum(
  'PYI',     # Faster Payment In
  'PYI_REV', # Faster Payment In Reversal
  'PYO',	   # Faster Payment Out
  'TRD',	   # Inter-Account Transfer Out
  'TRC',	   # Inter-Account Transfer In
  'RED',	   # Card Payment Out
  'RED_REV', # Card Payment Reversal
  'WTH',     # Cash Withdrawal
  'WTH_REV', # Cash Withdrawal Reversal
  'REF',     # Refund
  'REF_REV', # Refund Reversal
  'FEE',	   # Fee
  'TOP',	   # Tide Credit
  'TOP_REV'  # Tide Credit Reversal
)

Instance Method Summary collapse

Instance Method Details

#account_id ⇒ Integer

ID of the parent account.

Returns:

  • (Integer) 


39
 
# File 'lib/tide/api/transaction.rb', line 39

attribute :account_id, Types::Strict::Integer

#amount ⇒ BigDecimal

Transaction amount. Can be positive or negative.

Returns:

  • (BigDecimal) 


45
 
# File 'lib/tide/api/transaction.rb', line 45

attribute :amount, Types::Params::Decimal

#category_id ⇒ Integer

TODO

Returns:

  • (Integer) 


112
 
# File 'lib/tide/api/transaction.rb', line 112

attribute :category_id, Types::Strict::Integer

#category_name ⇒ String|String

TODO

Returns:

  • (String|String) 


118
 
# File 'lib/tide/api/transaction.rb', line 118

attribute :category_name, Types::Strict::String.optional

#category_type ⇒ String|nil

TODO

Returns:

  • (String|nil) 


124
 
# File 'lib/tide/api/transaction.rb', line 124

attribute :category_type, CategoryType.optional

#description ⇒ String

TODO

Returns:

  • (String) 


94
 
# File 'lib/tide/api/transaction.rb', line 94

attribute :description, Types::Strict::String

#iso_applied_date_time ⇒ DateTime

Time when the transaction was applied

Returns:

  • (DateTime) 


70
 
# File 'lib/tide/api/transaction.rb', line 70

attribute :iso_applied_date_time, Types::Params::DateTime

#iso_cleared_date_time ⇒ DateTime

Time when the transaction was cleared.

Returns:

  • (DateTime) 


76
 
# File 'lib/tide/api/transaction.rb', line 76

attribute :iso_cleared_date_time, Types::Params::DateTime

#iso_created_on ⇒ DateTime

TODO

Returns:

  • (DateTime) 


100
 
# File 'lib/tide/api/transaction.rb', line 100

attribute :iso_created_on, Types::Params::DateTime

#iso_transaction_date_time ⇒ DateTime

Time of the transaction.

Returns:

  • (DateTime) 


64
 
# File 'lib/tide/api/transaction.rb', line 64

attribute :iso_transaction_date_time, Types::Params::DateTime

#iso_updated_on ⇒ DateTime

TODO

Returns:

  • (DateTime) 


106
 
# File 'lib/tide/api/transaction.rb', line 106

attribute :iso_updated_on, Types::Params::DateTime

#masked_pan ⇒ String

Masked debit/credit card number.

Returns:

  • (String) 


82
 
# File 'lib/tide/api/transaction.rb', line 82

attribute :masked_pan, Types::Strict::String.optional

#status ⇒ String

TODO

Returns:

  • (String) 


88
 
# File 'lib/tide/api/transaction.rb', line 88

attribute :status, Status

#transaction_id ⇒ Integer

Tide’s unique transaction ID.

Returns:

  • (Integer) 


33
 
# File 'lib/tide/api/transaction.rb', line 33

attribute :transaction_id, Types::Strict::Integer

#txn_ref ⇒ String

Unique reference of the transaction.

Returns:

  • (String) 


58
 
# File 'lib/tide/api/transaction.rb', line 58

attribute :txn_ref, Types::Strict::String

#type ⇒ String

Transaction Type code.

Returns:

  • (String)

See Also:

  • +Type+.


52
 
# File 'lib/tide/api/transaction.rb', line 52

attribute :type, Type