Class: Starling::Resources::InboundFasterPaymentsTransactionResource

Inherits:
BaseResource
  • Object
show all
Defined in:
lib/starling/resources/inbound_faster_payments_transaction_resource.rb

Overview

A resource representing a Transaction returned from the Transactions Faster Payments In API

Instance Method Summary collapse

Methods inherited from BaseResource

#initialize

Constructor Details

This class inherits a constructor from Starling::Resources::BaseResource

Instance Method Details

#amount ⇒ Float

Returns the amount of the transaction.

Returns:

  • (Float) —

    the amount of the transaction



17
18
19
 
# File 'lib/starling/resources/inbound_faster_payments_transaction_resource.rb', line 17

def amount
  present_float(parsed_data['amount'])
end

#created ⇒ Time Also known as: created_at

Returns the date and time when the transaction was recorded.

Returns:

  • (Time) —

    the date and time when the transaction was recorded



27
28
29
 
# File 'lib/starling/resources/inbound_faster_payments_transaction_resource.rb', line 27

def created
  present_datetime(parsed_data['created'])
end

#currency ⇒ String

Returns the currency of the transaction (e.g. “GBP” or “UAH”).

Returns:

  • (String) —

    the currency of the transaction (e.g. “GBP” or “UAH”)



12
13
14
 
# File 'lib/starling/resources/inbound_faster_payments_transaction_resource.rb', line 12

def currency
  parsed_data['currency']
end

#direction ⇒ Symbol

Returns the direction of the transaction (e.g. ‘:outbound`).

Returns:

  • (Symbol) —

    the direction of the transaction (e.g. ‘:outbound`)



22
23
24
 
# File 'lib/starling/resources/inbound_faster_payments_transaction_resource.rb', line 22

def direction
  present_enum(parsed_data['direction'])
end

#id ⇒ String

Returns the Starling internal ID of the transaction.

Returns:

  • (String) —

    the Starling internal ID of the transaction



7
8
9
 
# File 'lib/starling/resources/inbound_faster_payments_transaction_resource.rb', line 7

def id
  parsed_data['id']
end

#narrative ⇒ String

Returns the narrative of the transaction.

Returns:

  • (String) —

    the narrative of the transaction



33
34
35
 
# File 'lib/starling/resources/inbound_faster_payments_transaction_resource.rb', line 33

def narrative
  parsed_data['narrative']
end

#sending_contact_account_id ⇒ String?

Returns the Starling internal ID of the contact account which sent the payment, or nil if they are not one of the user’s contacts.

Returns:

  • (String, nil) —

    the Starling internal ID of the contact account which sent the payment, or nil if they are not one of the user’s contacts



51
52
53
 
# File 'lib/starling/resources/inbound_faster_payments_transaction_resource.rb', line 51

def 
  parsed_data['sendingContactAccountId']
end

#sending_contact_id ⇒ String?

Returns the Starling internal ID of the contact who sent the payment, or nil if they are not one of the user’s contacts.

Returns:

  • (String, nil) —

    the Starling internal ID of the contact who sent the payment, or nil if they are not one of the user’s contacts



44
45
46
 
# File 'lib/starling/resources/inbound_faster_payments_transaction_resource.rb', line 44

def sending_contact_id
  parsed_data['sendingContactId']
end

#source ⇒ Symbol

Returns the source of the transaction (e.g. ‘:master_card`).

Returns:

  • (Symbol) —

    the source of the transaction (e.g. ‘:master_card`)



38
39
40
 
# File 'lib/starling/resources/inbound_faster_payments_transaction_resource.rb', line 38

def source
  present_enum(parsed_data['source'])
end