Class: Lithic::Models::NetworkTotal

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/lithic/models/network_total.rb

Defined Under Namespace

Modules: Network Classes: Amounts

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(gross_settlement:, interchange_fees:, net_settlement:, visa_charges: nil) ⇒ Object

Some parameter documentations has been truncated, see Amounts for more details.

Parameters:

  • gross_settlement (Integer) —

    Total settlement amount excluding interchange, in currency’s smallest unit.

  • interchange_fees (Integer) —

    Interchange amount, in currency’s smallest unit.

  • net_settlement (Integer) —

    ‘gross_settlement` net of `interchange_fees` and `visa_charges` (if applicable),

  • visa_charges (Integer) (defaults to: nil) —

    Charges specific to Visa/Interlink, in currency’s smallest unit.




# File 'lib/lithic/models/network_total.rb', line 83

Instance Attribute Details

#amounts ⇒ Lithic::Models::NetworkTotal::Amounts

Returns:



15
 
# File 'lib/lithic/models/network_total.rb', line 15

required :amounts, -> { Lithic::NetworkTotal::Amounts }

#created ⇒ Time

RFC 3339 timestamp for when the record was created. UTC time zone.

Returns:

  • (Time) 


21
 
# File 'lib/lithic/models/network_total.rb', line 21

required :created, Time

#currency ⇒ String

3-character alphabetic ISO 4217 code.

Returns:

  • (String) 


27
 
# File 'lib/lithic/models/network_total.rb', line 27

required :currency, String

#cycle ⇒ Integer?

The clearing cycle that the network total record applies to. Mastercard only.

Returns:

  • (Integer, nil) 


81
 
# File 'lib/lithic/models/network_total.rb', line 81

optional :cycle, Integer

#institution_id ⇒ String

The institution that activity occurred on. For Mastercard: ICA (Interbank Card Association). For Maestro: institution ID. For Visa: lowest level SRE (Settlement Reporting Entity).

Returns:

  • (String) 


35
 
# File 'lib/lithic/models/network_total.rb', line 35

required :institution_id, String

#is_complete ⇒ Boolean

Indicates that all settlement records related to this Network Total are available in the details endpoint.

Returns:

  • (Boolean) 


42
 
# File 'lib/lithic/models/network_total.rb', line 42

required :is_complete, Lithic::Internal::Type::Boolean

#network ⇒ Symbol, Lithic::Models::NetworkTotal::Network

Card network where the transaction took place. AMEX, VISA, MASTERCARD, MAESTRO, or INTERLINK.

Returns:



49
 
# File 'lib/lithic/models/network_total.rb', line 49

required :network, enum: -> { Lithic::NetworkTotal::Network }

#report_date ⇒ Date

Date that the network total record applies to. YYYY-MM-DD format.

Returns:

  • (Date) 


55
 
# File 'lib/lithic/models/network_total.rb', line 55

required :report_date, Date

#settlement_institution_id ⇒ String

The institution responsible for settlement. For Mastercard: same as ‘institution_id`. For Maestro: billing ICA. For Visa: Funds Transfer SRE (FTSRE).

Returns:

  • (String) 


63
 
# File 'lib/lithic/models/network_total.rb', line 63

required :settlement_institution_id, String

#settlement_service ⇒ String

Settlement service.

Returns:

  • (String) 


69
 
# File 'lib/lithic/models/network_total.rb', line 69

required :settlement_service, String

#token ⇒ String

Globally unique identifier.

Returns:

  • (String) 


10
 
# File 'lib/lithic/models/network_total.rb', line 10

required :token, String

#updated ⇒ Time

RFC 3339 timestamp for when the record was last updated. UTC time zone.

Returns:

  • (Time) 


75
 
# File 'lib/lithic/models/network_total.rb', line 75

required :updated, Time