lithic 0.1.0.pre.alpha.56 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +33 -0
- data/README.md +1 -1
- data/lib/lithic/client.rb +8 -0
- data/lib/lithic/models/account_activity_list_params.rb +2 -0
- data/lib/lithic/models/account_activity_list_response.rb +2 -0
- data/lib/lithic/models/account_activity_retrieve_transaction_response.rb +2 -0
- data/lib/lithic/models/auth_rules/auth_rule.rb +208 -49
- data/lib/lithic/models/auth_rules/auth_rule_condition.rb +2 -2
- data/lib/lithic/models/auth_rules/conditional_3ds_action_parameters.rb +2 -2
- data/lib/lithic/models/auth_rules/conditional_ach_action_parameters.rb +2 -2
- data/lib/lithic/models/auth_rules/conditional_authorization_action_parameters.rb +2 -2
- data/lib/lithic/models/auth_rules/conditional_operation.rb +5 -0
- data/lib/lithic/models/auth_rules/conditional_tokenization_action_parameters.rb +19 -2
- data/lib/lithic/models/auth_rules/conditional_value.rb +4 -1
- data/lib/lithic/models/auth_rules/event_stream.rb +21 -0
- data/lib/lithic/models/auth_rules/v2_create_params.rb +3 -17
- data/lib/lithic/models/auth_rules/v2_list_params.rb +16 -19
- data/lib/lithic/models/card_bulk_order.rb +106 -0
- data/lib/lithic/models/card_bulk_order_create_params.rb +52 -0
- data/lib/lithic/models/card_bulk_order_list_params.rb +61 -0
- data/lib/lithic/models/card_bulk_order_retrieve_params.rb +14 -0
- data/lib/lithic/models/card_bulk_order_update_params.rb +32 -0
- data/lib/lithic/models/card_convert_physical_params.rb +3 -0
- data/lib/lithic/models/card_create_params.rb +14 -1
- data/lib/lithic/models/card_program.rb +10 -10
- data/lib/lithic/models/card_reissue_params.rb +3 -0
- data/lib/lithic/models/card_renew_params.rb +3 -0
- data/lib/lithic/models/card_web_provision_params.rb +32 -1
- data/lib/lithic/models/card_web_provision_response.rb +98 -60
- data/lib/lithic/models/cardholder_authentication.rb +132 -0
- data/lib/lithic/models/device.rb +37 -0
- data/lib/lithic/models/digital_wallet_token_metadata.rb +141 -0
- data/lib/lithic/models/{external_bank_account_unpause_response.rb → external_bank_account.rb} +15 -16
- data/lib/lithic/models/external_payment.rb +12 -0
- data/lib/lithic/models/external_payment_create_params.rb +2 -0
- data/lib/lithic/models/external_payment_list_params.rb +2 -0
- data/lib/lithic/models/financial_account_balance.rb +112 -0
- data/lib/lithic/models/financial_accounts/statement.rb +9 -9
- data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +18 -0
- data/lib/lithic/models/financial_event.rb +16 -0
- data/lib/lithic/models/{funding_event_retrieve_response.rb → funding_event.rb} +9 -10
- data/lib/lithic/models/internal_transaction.rb +166 -0
- data/lib/lithic/models/management_operation_create_params.rb +6 -0
- data/lib/lithic/models/management_operation_transaction.rb +6 -0
- data/lib/lithic/models/network_total.rb +169 -0
- data/lib/lithic/models/non_pci_card.rb +10 -1
- data/lib/lithic/models/payment.rb +11 -1
- data/lib/lithic/models/payment_create_params.rb +10 -1
- data/lib/lithic/models/three_ds_authentication.rb +1259 -0
- data/lib/lithic/models/token_info.rb +42 -0
- data/lib/lithic/models/tokenization.rb +9 -111
- data/lib/lithic/models/tokenization_decline_reason.rb +27 -0
- data/lib/lithic/models/tokenization_rule_result.rb +61 -0
- data/lib/lithic/models/tokenization_tfa_reason.rb +29 -0
- data/lib/lithic/models/transaction.rb +6 -174
- data/lib/lithic/models/wallet_decisioning_info.rb +44 -0
- data/lib/lithic/models.rb +38 -0
- data/lib/lithic/resources/auth_rules/v2.rb +17 -15
- data/lib/lithic/resources/card_bulk_orders.rb +127 -0
- data/lib/lithic/resources/cards/balances.rb +2 -2
- data/lib/lithic/resources/cards.rb +14 -3
- data/lib/lithic/resources/external_bank_accounts.rb +4 -4
- data/lib/lithic/resources/financial_accounts/balances.rb +2 -2
- data/lib/lithic/resources/funding_events.rb +4 -4
- data/lib/lithic/resources/internal_transaction.rb +14 -0
- data/lib/lithic/resources/reports/settlement/network_totals.rb +4 -4
- data/lib/lithic/resources/three_ds/authentication.rb +2 -2
- data/lib/lithic/resources/tokenizations.rb +4 -4
- data/lib/lithic/version.rb +1 -1
- data/lib/lithic.rb +23 -17
- data/manifest.yaml +1 -0
- data/rbi/lithic/client.rbi +6 -0
- data/rbi/lithic/models/account_activity_list_params.rbi +10 -0
- data/rbi/lithic/models/account_activity_list_response.rbi +10 -0
- data/rbi/lithic/models/account_activity_retrieve_transaction_response.rbi +10 -0
- data/rbi/lithic/models/auth_rules/auth_rule.rbi +339 -80
- data/rbi/lithic/models/auth_rules/conditional_operation.rbi +25 -0
- data/rbi/lithic/models/auth_rules/conditional_tokenization_action_parameters.rbi +29 -0
- data/rbi/lithic/models/auth_rules/conditional_value.rbi +2 -1
- data/rbi/lithic/models/auth_rules/event_stream.rbi +44 -0
- data/rbi/lithic/models/auth_rules/v2_create_params.rbi +4 -60
- data/rbi/lithic/models/auth_rules/v2_list_params.rbi +27 -59
- data/rbi/lithic/models/card_bulk_order.rbi +141 -0
- data/rbi/lithic/models/card_bulk_order_create_params.rbi +92 -0
- data/rbi/lithic/models/card_bulk_order_list_params.rbi +98 -0
- data/rbi/lithic/models/card_bulk_order_retrieve_params.rbi +27 -0
- data/rbi/lithic/models/card_bulk_order_update_params.rbi +68 -0
- data/rbi/lithic/models/card_convert_physical_params.rbi +8 -0
- data/rbi/lithic/models/card_create_params.rbi +23 -0
- data/rbi/lithic/models/card_program.rbi +10 -13
- data/rbi/lithic/models/card_reissue_params.rbi +8 -0
- data/rbi/lithic/models/card_renew_params.rbi +8 -0
- data/rbi/lithic/models/card_web_provision_params.rbi +44 -0
- data/rbi/lithic/models/card_web_provision_response.rbi +182 -102
- data/rbi/lithic/models/cardholder_authentication.rbi +296 -0
- data/rbi/lithic/models/device.rbi +54 -0
- data/rbi/lithic/models/digital_wallet_token_metadata.rbi +290 -0
- data/rbi/lithic/models/{external_bank_account_unpause_response.rbi → external_bank_account.rbi} +26 -75
- data/rbi/lithic/models/external_payment.rbi +57 -0
- data/rbi/lithic/models/external_payment_create_params.rbi +10 -0
- data/rbi/lithic/models/external_payment_list_params.rbi +10 -0
- data/rbi/lithic/models/financial_account_balance.rbi +144 -0
- data/rbi/lithic/models/financial_accounts/statement.rbi +9 -9
- data/rbi/lithic/models/financial_accounts/statements/statement_line_items.rbi +90 -0
- data/rbi/lithic/models/financial_event.rbi +60 -0
- data/rbi/lithic/models/{funding_event_list_response.rbi → funding_event.rbi} +13 -35
- data/rbi/lithic/models/internal_transaction.rbi +277 -0
- data/rbi/lithic/models/management_operation_create_params.rbi +30 -0
- data/rbi/lithic/models/management_operation_transaction.rbi +30 -0
- data/rbi/lithic/models/network_total.rbi +226 -0
- data/rbi/lithic/models/non_pci_card.rbi +10 -0
- data/rbi/lithic/models/payment.rbi +12 -0
- data/rbi/lithic/models/payment_create_params.rbi +15 -1
- data/rbi/lithic/models/three_ds_authentication.rbi +2432 -0
- data/rbi/lithic/models/token_info.rbi +70 -0
- data/rbi/lithic/models/tokenization.rbi +12 -335
- data/rbi/lithic/models/tokenization_decline_reason.rbi +73 -0
- data/rbi/lithic/models/tokenization_rule_result.rbi +96 -0
- data/rbi/lithic/models/tokenization_tfa_reason.rbi +74 -0
- data/rbi/lithic/models/transaction.rbi +8 -410
- data/rbi/lithic/models/wallet_decisioning_info.rbi +63 -0
- data/rbi/lithic/models.rbi +38 -0
- data/rbi/lithic/resources/auth_rules/v2.rbi +15 -15
- data/rbi/lithic/resources/card_bulk_orders.rbi +101 -0
- data/rbi/lithic/resources/cards/balances.rbi +1 -3
- data/rbi/lithic/resources/cards.rbi +22 -1
- data/rbi/lithic/resources/external_bank_accounts.rbi +2 -2
- data/rbi/lithic/resources/financial_accounts/balances.rbi +1 -3
- data/rbi/lithic/resources/funding_events.rbi +2 -4
- data/rbi/lithic/resources/internal_transaction.rbi +12 -0
- data/rbi/lithic/resources/reports/settlement/network_totals.rbi +2 -8
- data/rbi/lithic/resources/three_ds/authentication.rbi +1 -1
- data/rbi/lithic/resources/tokenizations.rbi +2 -2
- data/sig/lithic/client.rbs +4 -0
- data/sig/lithic/models/account_activity_list_params.rbs +4 -0
- data/sig/lithic/models/account_activity_list_response.rbs +4 -0
- data/sig/lithic/models/account_activity_retrieve_transaction_response.rbs +4 -0
- data/sig/lithic/models/auth_rules/auth_rule.rbs +135 -36
- data/sig/lithic/models/auth_rules/conditional_operation.rbs +10 -0
- data/sig/lithic/models/auth_rules/conditional_tokenization_action_parameters.rbs +2 -0
- data/sig/lithic/models/auth_rules/conditional_value.rbs +1 -1
- data/sig/lithic/models/auth_rules/event_stream.rbs +24 -0
- data/sig/lithic/models/auth_rules/v2_create_params.rbs +6 -25
- data/sig/lithic/models/auth_rules/v2_list_params.rbs +15 -25
- data/sig/lithic/models/card_bulk_order.rbs +76 -0
- data/sig/lithic/models/card_bulk_order_create_params.rbs +46 -0
- data/sig/lithic/models/card_bulk_order_list_params.rbs +56 -0
- data/sig/lithic/models/card_bulk_order_retrieve_params.rbs +15 -0
- data/sig/lithic/models/card_bulk_order_update_params.rbs +34 -0
- data/sig/lithic/models/card_convert_physical_params.rbs +2 -0
- data/sig/lithic/models/card_create_params.rbs +9 -0
- data/sig/lithic/models/card_program.rbs +5 -7
- data/sig/lithic/models/card_reissue_params.rbs +2 -0
- data/sig/lithic/models/card_renew_params.rbs +2 -0
- data/sig/lithic/models/card_web_provision_params.rbs +26 -2
- data/sig/lithic/models/card_web_provision_response.rbs +81 -51
- data/sig/lithic/models/cardholder_authentication.rbs +98 -0
- data/sig/lithic/models/device.rbs +21 -0
- data/sig/lithic/models/digital_wallet_token_metadata.rbs +119 -0
- data/sig/lithic/models/{external_bank_account_unpause_response.rbs → external_bank_account.rbs} +17 -17
- data/sig/lithic/models/external_payment.rbs +28 -1
- data/sig/lithic/models/external_payment_create_params.rbs +8 -1
- data/sig/lithic/models/external_payment_list_params.rbs +8 -1
- data/sig/lithic/models/financial_account_balance.rbs +78 -0
- data/sig/lithic/models/financial_accounts/statement.rbs +12 -12
- data/sig/lithic/models/financial_accounts/statements/statement_line_items.rbs +36 -0
- data/sig/lithic/models/financial_event.rbs +32 -0
- data/sig/lithic/models/{funding_event_list_response.rbs → funding_event.rbs} +11 -11
- data/sig/lithic/models/internal_transaction.rbs +165 -0
- data/sig/lithic/models/management_operation_create_params.rbs +12 -0
- data/sig/lithic/models/management_operation_transaction.rbs +12 -0
- data/sig/lithic/models/network_total.rbs +125 -0
- data/sig/lithic/models/non_pci_card.rbs +5 -0
- data/sig/lithic/models/payment.rbs +9 -0
- data/sig/lithic/models/payment_create_params.rbs +7 -0
- data/sig/lithic/models/three_ds_authentication.rbs +911 -0
- data/sig/lithic/models/token_info.rbs +36 -0
- data/sig/lithic/models/tokenization.rbs +18 -137
- data/sig/lithic/models/tokenization_decline_reason.rbs +38 -0
- data/sig/lithic/models/tokenization_rule_result.rbs +48 -0
- data/sig/lithic/models/tokenization_tfa_reason.rbs +42 -0
- data/sig/lithic/models/transaction.rbs +8 -140
- data/sig/lithic/models/wallet_decisioning_info.rbs +35 -0
- data/sig/lithic/models.rbs +38 -0
- data/sig/lithic/resources/auth_rules/v2.rbs +9 -8
- data/sig/lithic/resources/card_bulk_orders.rbs +34 -0
- data/sig/lithic/resources/cards/balances.rbs +1 -1
- data/sig/lithic/resources/cards.rbs +5 -1
- data/sig/lithic/resources/external_bank_accounts.rbs +2 -2
- data/sig/lithic/resources/financial_accounts/balances.rbs +1 -1
- data/sig/lithic/resources/funding_events.rbs +2 -2
- data/sig/lithic/resources/internal_transaction.rbs +7 -0
- data/sig/lithic/resources/reports/settlement/network_totals.rbs +2 -2
- data/sig/lithic/resources/three_ds/authentication.rbs +1 -1
- data/sig/lithic/resources/tokenizations.rbs +2 -2
- metadata +70 -55
- data/lib/lithic/models/auth_rules/v2_create_response.rb +0 -280
- data/lib/lithic/models/auth_rules/v2_draft_response.rb +0 -279
- data/lib/lithic/models/auth_rules/v2_list_response.rb +0 -279
- data/lib/lithic/models/auth_rules/v2_promote_response.rb +0 -280
- data/lib/lithic/models/auth_rules/v2_retrieve_response.rb +0 -284
- data/lib/lithic/models/auth_rules/v2_update_response.rb +0 -280
- data/lib/lithic/models/cards/balance_list_response.rb +0 -115
- data/lib/lithic/models/external_bank_account_retry_prenote_response.rb +0 -242
- data/lib/lithic/models/financial_accounts/balance_list_response.rb +0 -115
- data/lib/lithic/models/funding_event_list_response.rb +0 -108
- data/lib/lithic/models/reports/settlement/network_total_list_response.rb +0 -176
- data/lib/lithic/models/reports/settlement/network_total_retrieve_response.rb +0 -176
- data/lib/lithic/models/three_ds/authentication_retrieve_response.rb +0 -1288
- data/lib/lithic/models/tokenization_simulate_response.rb +0 -16
- data/lib/lithic/models/tokenization_update_digital_card_art_response.rb +0 -16
- data/rbi/lithic/models/auth_rules/v2_create_response.rbi +0 -522
- data/rbi/lithic/models/auth_rules/v2_draft_response.rbi +0 -522
- data/rbi/lithic/models/auth_rules/v2_list_response.rbi +0 -518
- data/rbi/lithic/models/auth_rules/v2_promote_response.rbi +0 -525
- data/rbi/lithic/models/auth_rules/v2_retrieve_response.rbi +0 -528
- data/rbi/lithic/models/auth_rules/v2_update_response.rbi +0 -522
- data/rbi/lithic/models/cards/balance_list_response.rbi +0 -170
- data/rbi/lithic/models/external_bank_account_retry_prenote_response.rbi +0 -375
- data/rbi/lithic/models/financial_accounts/balance_list_response.rbi +0 -174
- data/rbi/lithic/models/funding_event_retrieve_response.rbi +0 -184
- data/rbi/lithic/models/reports/settlement/network_total_list_response.rbi +0 -280
- data/rbi/lithic/models/reports/settlement/network_total_retrieve_response.rbi +0 -280
- data/rbi/lithic/models/three_ds/authentication_retrieve_response.rbi +0 -2580
- data/rbi/lithic/models/tokenization_simulate_response.rbi +0 -33
- data/rbi/lithic/models/tokenization_update_digital_card_art_response.rbi +0 -31
- data/sig/lithic/models/auth_rules/v2_create_response.rbs +0 -205
- data/sig/lithic/models/auth_rules/v2_draft_response.rbs +0 -205
- data/sig/lithic/models/auth_rules/v2_list_response.rbs +0 -205
- data/sig/lithic/models/auth_rules/v2_promote_response.rbs +0 -205
- data/sig/lithic/models/auth_rules/v2_retrieve_response.rbs +0 -205
- data/sig/lithic/models/auth_rules/v2_update_response.rbs +0 -205
- data/sig/lithic/models/cards/balance_list_response.rbs +0 -80
- data/sig/lithic/models/external_bank_account_retry_prenote_response.rbs +0 -162
- data/sig/lithic/models/financial_accounts/balance_list_response.rbs +0 -80
- data/sig/lithic/models/funding_event_retrieve_response.rbs +0 -85
- data/sig/lithic/models/reports/settlement/network_total_list_response.rbs +0 -129
- data/sig/lithic/models/reports/settlement/network_total_retrieve_response.rbs +0 -129
- data/sig/lithic/models/three_ds/authentication_retrieve_response.rbs +0 -913
- data/sig/lithic/models/tokenization_simulate_response.rbs +0 -18
- data/sig/lithic/models/tokenization_update_digital_card_art_response.rbs +0 -16
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Lithic
|
|
4
|
+
module Models
|
|
5
|
+
class FinancialAccountBalance < Lithic::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute token
|
|
7
|
+
# Globally unique identifier for the financial account that holds this balance.
|
|
8
|
+
#
|
|
9
|
+
# @return [String]
|
|
10
|
+
required :token, String
|
|
11
|
+
|
|
12
|
+
# @!attribute available_amount
|
|
13
|
+
# Funds available for spend in the currency's smallest unit (e.g., cents for USD)
|
|
14
|
+
#
|
|
15
|
+
# @return [Integer]
|
|
16
|
+
required :available_amount, Integer
|
|
17
|
+
|
|
18
|
+
# @!attribute created
|
|
19
|
+
# Date and time for when the balance was first created.
|
|
20
|
+
#
|
|
21
|
+
# @return [Time]
|
|
22
|
+
required :created, Time
|
|
23
|
+
|
|
24
|
+
# @!attribute currency
|
|
25
|
+
# 3-character alphabetic ISO 4217 code for the local currency of the balance.
|
|
26
|
+
#
|
|
27
|
+
# @return [String]
|
|
28
|
+
required :currency, String
|
|
29
|
+
|
|
30
|
+
# @!attribute last_transaction_event_token
|
|
31
|
+
# Globally unique identifier for the last financial transaction event that
|
|
32
|
+
# impacted this balance.
|
|
33
|
+
#
|
|
34
|
+
# @return [String]
|
|
35
|
+
required :last_transaction_event_token, String
|
|
36
|
+
|
|
37
|
+
# @!attribute last_transaction_token
|
|
38
|
+
# Globally unique identifier for the last financial transaction that impacted this
|
|
39
|
+
# balance.
|
|
40
|
+
#
|
|
41
|
+
# @return [String]
|
|
42
|
+
required :last_transaction_token, String
|
|
43
|
+
|
|
44
|
+
# @!attribute pending_amount
|
|
45
|
+
# Funds not available for spend due to card authorizations or pending ACH release.
|
|
46
|
+
# Shown in the currency's smallest unit (e.g., cents for USD).
|
|
47
|
+
#
|
|
48
|
+
# @return [Integer]
|
|
49
|
+
required :pending_amount, Integer
|
|
50
|
+
|
|
51
|
+
# @!attribute total_amount
|
|
52
|
+
# The sum of available and pending balance in the currency's smallest unit (e.g.,
|
|
53
|
+
# cents for USD).
|
|
54
|
+
#
|
|
55
|
+
# @return [Integer]
|
|
56
|
+
required :total_amount, Integer
|
|
57
|
+
|
|
58
|
+
# @!attribute type
|
|
59
|
+
# Type of financial account.
|
|
60
|
+
#
|
|
61
|
+
# @return [Symbol, Lithic::Models::FinancialAccountBalance::Type]
|
|
62
|
+
required :type, enum: -> { Lithic::FinancialAccountBalance::Type }
|
|
63
|
+
|
|
64
|
+
# @!attribute updated
|
|
65
|
+
# Date and time for when the balance was last updated.
|
|
66
|
+
#
|
|
67
|
+
# @return [Time]
|
|
68
|
+
required :updated, Time
|
|
69
|
+
|
|
70
|
+
# @!method initialize(token:, available_amount:, created:, currency:, last_transaction_event_token:, last_transaction_token:, pending_amount:, total_amount:, type:, updated:)
|
|
71
|
+
# Some parameter documentations has been truncated, see
|
|
72
|
+
# {Lithic::Models::FinancialAccountBalance} for more details.
|
|
73
|
+
#
|
|
74
|
+
# Balance of a Financial Account
|
|
75
|
+
#
|
|
76
|
+
# @param token [String] Globally unique identifier for the financial account that holds this balance.
|
|
77
|
+
#
|
|
78
|
+
# @param available_amount [Integer] Funds available for spend in the currency's smallest unit (e.g., cents for USD)
|
|
79
|
+
#
|
|
80
|
+
# @param created [Time] Date and time for when the balance was first created.
|
|
81
|
+
#
|
|
82
|
+
# @param currency [String] 3-character alphabetic ISO 4217 code for the local currency of the balance.
|
|
83
|
+
#
|
|
84
|
+
# @param last_transaction_event_token [String] Globally unique identifier for the last financial transaction event that impacte
|
|
85
|
+
#
|
|
86
|
+
# @param last_transaction_token [String] Globally unique identifier for the last financial transaction that impacted this
|
|
87
|
+
#
|
|
88
|
+
# @param pending_amount [Integer] Funds not available for spend due to card authorizations or pending ACH release.
|
|
89
|
+
#
|
|
90
|
+
# @param total_amount [Integer] The sum of available and pending balance in the currency's smallest unit (e.g.,
|
|
91
|
+
#
|
|
92
|
+
# @param type [Symbol, Lithic::Models::FinancialAccountBalance::Type] Type of financial account.
|
|
93
|
+
#
|
|
94
|
+
# @param updated [Time] Date and time for when the balance was last updated.
|
|
95
|
+
|
|
96
|
+
# Type of financial account.
|
|
97
|
+
#
|
|
98
|
+
# @see Lithic::Models::FinancialAccountBalance#type
|
|
99
|
+
module Type
|
|
100
|
+
extend Lithic::Internal::Type::Enum
|
|
101
|
+
|
|
102
|
+
ISSUING = :ISSUING
|
|
103
|
+
OPERATING = :OPERATING
|
|
104
|
+
RESERVE = :RESERVE
|
|
105
|
+
SECURITY = :SECURITY
|
|
106
|
+
|
|
107
|
+
# @!method self.values
|
|
108
|
+
# @return [Array<Symbol>]
|
|
109
|
+
end
|
|
110
|
+
end
|
|
111
|
+
end
|
|
112
|
+
end
|
|
@@ -434,22 +434,22 @@ module Lithic
|
|
|
434
434
|
# @!attribute payoff_period_length_months
|
|
435
435
|
# Number of months to full pay off
|
|
436
436
|
#
|
|
437
|
-
# @return [Integer]
|
|
438
|
-
required :payoff_period_length_months, Integer
|
|
437
|
+
# @return [Integer, nil]
|
|
438
|
+
required :payoff_period_length_months, Integer, nil?: true
|
|
439
439
|
|
|
440
440
|
# @!attribute payoff_period_monthly_payment_amount
|
|
441
441
|
# The amount needed to be paid, in cents, each month in order to pay off current
|
|
442
442
|
# balance in the payoff period
|
|
443
443
|
#
|
|
444
|
-
# @return [Integer]
|
|
445
|
-
required :payoff_period_monthly_payment_amount, Integer
|
|
444
|
+
# @return [Integer, nil]
|
|
445
|
+
required :payoff_period_monthly_payment_amount, Integer, nil?: true
|
|
446
446
|
|
|
447
447
|
# @!attribute payoff_period_payment_total
|
|
448
448
|
# The sum of all interest and principal paid, in cents, when paying off in the
|
|
449
449
|
# payoff period
|
|
450
450
|
#
|
|
451
|
-
# @return [Integer]
|
|
452
|
-
required :payoff_period_payment_total, Integer
|
|
451
|
+
# @return [Integer, nil]
|
|
452
|
+
required :payoff_period_payment_total, Integer, nil?: true
|
|
453
453
|
|
|
454
454
|
# @!method initialize(minimum_payment_months:, minimum_payment_total:, payoff_period_length_months:, payoff_period_monthly_payment_amount:, payoff_period_payment_total:)
|
|
455
455
|
# Some parameter documentations has been truncated, see
|
|
@@ -461,11 +461,11 @@ module Lithic
|
|
|
461
461
|
#
|
|
462
462
|
# @param minimum_payment_total [String] The sum of all interest and principal paid, in cents, when only paying minimum m
|
|
463
463
|
#
|
|
464
|
-
# @param payoff_period_length_months [Integer] Number of months to full pay off
|
|
464
|
+
# @param payoff_period_length_months [Integer, nil] Number of months to full pay off
|
|
465
465
|
#
|
|
466
|
-
# @param payoff_period_monthly_payment_amount [Integer] The amount needed to be paid, in cents, each month in order to pay off current b
|
|
466
|
+
# @param payoff_period_monthly_payment_amount [Integer, nil] The amount needed to be paid, in cents, each month in order to pay off current b
|
|
467
467
|
#
|
|
468
|
-
# @param payoff_period_payment_total [Integer] The sum of all interest and principal paid, in cents, when paying off in the pay
|
|
468
|
+
# @param payoff_period_payment_total [Integer, nil] The sum of all interest and principal paid, in cents, when paying off in the pay
|
|
469
469
|
end
|
|
470
470
|
end
|
|
471
471
|
end
|
|
@@ -135,6 +135,8 @@ module Lithic
|
|
|
135
135
|
CARD = :CARD
|
|
136
136
|
EXTERNAL_ACH = :EXTERNAL_ACH
|
|
137
137
|
EXTERNAL_CHECK = :EXTERNAL_CHECK
|
|
138
|
+
EXTERNAL_FEDNOW = :EXTERNAL_FEDNOW
|
|
139
|
+
EXTERNAL_RTP = :EXTERNAL_RTP
|
|
138
140
|
EXTERNAL_TRANSFER = :EXTERNAL_TRANSFER
|
|
139
141
|
EXTERNAL_WIRE = :EXTERNAL_WIRE
|
|
140
142
|
MANAGEMENT_ADJUSTMENT = :MANAGEMENT_ADJUSTMENT
|
|
@@ -195,6 +197,16 @@ module Lithic
|
|
|
195
197
|
EXTERNAL_CHECK_RELEASED = :EXTERNAL_CHECK_RELEASED
|
|
196
198
|
EXTERNAL_CHECK_REVERSED = :EXTERNAL_CHECK_REVERSED
|
|
197
199
|
EXTERNAL_CHECK_SETTLED = :EXTERNAL_CHECK_SETTLED
|
|
200
|
+
EXTERNAL_FEDNOW_CANCELED = :EXTERNAL_FEDNOW_CANCELED
|
|
201
|
+
EXTERNAL_FEDNOW_INITIATED = :EXTERNAL_FEDNOW_INITIATED
|
|
202
|
+
EXTERNAL_FEDNOW_RELEASED = :EXTERNAL_FEDNOW_RELEASED
|
|
203
|
+
EXTERNAL_FEDNOW_REVERSED = :EXTERNAL_FEDNOW_REVERSED
|
|
204
|
+
EXTERNAL_FEDNOW_SETTLED = :EXTERNAL_FEDNOW_SETTLED
|
|
205
|
+
EXTERNAL_RTP_CANCELED = :EXTERNAL_RTP_CANCELED
|
|
206
|
+
EXTERNAL_RTP_INITIATED = :EXTERNAL_RTP_INITIATED
|
|
207
|
+
EXTERNAL_RTP_RELEASED = :EXTERNAL_RTP_RELEASED
|
|
208
|
+
EXTERNAL_RTP_REVERSED = :EXTERNAL_RTP_REVERSED
|
|
209
|
+
EXTERNAL_RTP_SETTLED = :EXTERNAL_RTP_SETTLED
|
|
198
210
|
EXTERNAL_TRANSFER_CANCELED = :EXTERNAL_TRANSFER_CANCELED
|
|
199
211
|
EXTERNAL_TRANSFER_INITIATED = :EXTERNAL_TRANSFER_INITIATED
|
|
200
212
|
EXTERNAL_TRANSFER_RELEASED = :EXTERNAL_TRANSFER_RELEASED
|
|
@@ -223,6 +235,12 @@ module Lithic
|
|
|
223
235
|
RETURNED_PAYMENT = :RETURNED_PAYMENT
|
|
224
236
|
RETURNED_PAYMENT_REVERSAL = :RETURNED_PAYMENT_REVERSAL
|
|
225
237
|
LITHIC_NETWORK_PAYMENT = :LITHIC_NETWORK_PAYMENT
|
|
238
|
+
ANNUAL = :ANNUAL
|
|
239
|
+
ANNUAL_REVERSAL = :ANNUAL_REVERSAL
|
|
240
|
+
QUARTERLY = :QUARTERLY
|
|
241
|
+
QUARTERLY_REVERSAL = :QUARTERLY_REVERSAL
|
|
242
|
+
MONTHLY = :MONTHLY
|
|
243
|
+
MONTHLY_REVERSAL = :MONTHLY_REVERSAL
|
|
226
244
|
|
|
227
245
|
# @!method self.values
|
|
228
246
|
# @return [Array<Symbol>]
|
|
@@ -111,6 +111,16 @@ module Lithic
|
|
|
111
111
|
EXTERNAL_CHECK_RELEASED = :EXTERNAL_CHECK_RELEASED
|
|
112
112
|
EXTERNAL_CHECK_REVERSED = :EXTERNAL_CHECK_REVERSED
|
|
113
113
|
EXTERNAL_CHECK_SETTLED = :EXTERNAL_CHECK_SETTLED
|
|
114
|
+
EXTERNAL_FEDNOW_CANCELED = :EXTERNAL_FEDNOW_CANCELED
|
|
115
|
+
EXTERNAL_FEDNOW_INITIATED = :EXTERNAL_FEDNOW_INITIATED
|
|
116
|
+
EXTERNAL_FEDNOW_RELEASED = :EXTERNAL_FEDNOW_RELEASED
|
|
117
|
+
EXTERNAL_FEDNOW_REVERSED = :EXTERNAL_FEDNOW_REVERSED
|
|
118
|
+
EXTERNAL_FEDNOW_SETTLED = :EXTERNAL_FEDNOW_SETTLED
|
|
119
|
+
EXTERNAL_RTP_CANCELED = :EXTERNAL_RTP_CANCELED
|
|
120
|
+
EXTERNAL_RTP_INITIATED = :EXTERNAL_RTP_INITIATED
|
|
121
|
+
EXTERNAL_RTP_RELEASED = :EXTERNAL_RTP_RELEASED
|
|
122
|
+
EXTERNAL_RTP_REVERSED = :EXTERNAL_RTP_REVERSED
|
|
123
|
+
EXTERNAL_RTP_SETTLED = :EXTERNAL_RTP_SETTLED
|
|
114
124
|
EXTERNAL_TRANSFER_CANCELED = :EXTERNAL_TRANSFER_CANCELED
|
|
115
125
|
EXTERNAL_TRANSFER_INITIATED = :EXTERNAL_TRANSFER_INITIATED
|
|
116
126
|
EXTERNAL_TRANSFER_RELEASED = :EXTERNAL_TRANSFER_RELEASED
|
|
@@ -139,6 +149,12 @@ module Lithic
|
|
|
139
149
|
RETURNED_PAYMENT = :RETURNED_PAYMENT
|
|
140
150
|
RETURNED_PAYMENT_REVERSAL = :RETURNED_PAYMENT_REVERSAL
|
|
141
151
|
LITHIC_NETWORK_PAYMENT = :LITHIC_NETWORK_PAYMENT
|
|
152
|
+
ANNUAL = :ANNUAL
|
|
153
|
+
ANNUAL_REVERSAL = :ANNUAL_REVERSAL
|
|
154
|
+
QUARTERLY = :QUARTERLY
|
|
155
|
+
QUARTERLY_REVERSAL = :QUARTERLY_REVERSAL
|
|
156
|
+
MONTHLY = :MONTHLY
|
|
157
|
+
MONTHLY_REVERSAL = :MONTHLY_REVERSAL
|
|
142
158
|
|
|
143
159
|
# @!method self.values
|
|
144
160
|
# @return [Array<Symbol>]
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
module Lithic
|
|
4
4
|
module Models
|
|
5
5
|
# @see Lithic::Resources::FundingEvents#retrieve
|
|
6
|
-
class
|
|
6
|
+
class FundingEvent < Lithic::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute token
|
|
8
8
|
# Unique token ID
|
|
9
9
|
#
|
|
@@ -13,9 +13,8 @@ module Lithic
|
|
|
13
13
|
# @!attribute collection_resource_type
|
|
14
14
|
# Collection resource type
|
|
15
15
|
#
|
|
16
|
-
# @return [Symbol, Lithic::Models::
|
|
17
|
-
required :collection_resource_type,
|
|
18
|
-
enum: -> { Lithic::Models::FundingEventRetrieveResponse::CollectionResourceType }
|
|
16
|
+
# @return [Symbol, Lithic::Models::FundingEvent::CollectionResourceType]
|
|
17
|
+
required :collection_resource_type, enum: -> { Lithic::FundingEvent::CollectionResourceType }
|
|
19
18
|
|
|
20
19
|
# @!attribute collection_tokens
|
|
21
20
|
# IDs of collections, further information can be gathered from the appropriate
|
|
@@ -39,9 +38,9 @@ module Lithic
|
|
|
39
38
|
# @!attribute network_settlement_summary
|
|
40
39
|
# Network settlement summary breakdown by network settlement date
|
|
41
40
|
#
|
|
42
|
-
# @return [Array<Lithic::Models::
|
|
41
|
+
# @return [Array<Lithic::Models::FundingEvent::NetworkSettlementSummary>]
|
|
43
42
|
required :network_settlement_summary,
|
|
44
|
-
-> { Lithic::Internal::Type::ArrayOf[Lithic::
|
|
43
|
+
-> { Lithic::Internal::Type::ArrayOf[Lithic::FundingEvent::NetworkSettlementSummary] }
|
|
45
44
|
|
|
46
45
|
# @!attribute previous_high_watermark
|
|
47
46
|
# Time of the previous high watermark
|
|
@@ -57,11 +56,11 @@ module Lithic
|
|
|
57
56
|
|
|
58
57
|
# @!method initialize(token:, collection_resource_type:, collection_tokens:, created:, high_watermark:, network_settlement_summary:, previous_high_watermark:, updated:)
|
|
59
58
|
# Some parameter documentations has been truncated, see
|
|
60
|
-
# {Lithic::Models::
|
|
59
|
+
# {Lithic::Models::FundingEvent} for more details.
|
|
61
60
|
#
|
|
62
61
|
# @param token [String] Unique token ID
|
|
63
62
|
#
|
|
64
|
-
# @param collection_resource_type [Symbol, Lithic::Models::
|
|
63
|
+
# @param collection_resource_type [Symbol, Lithic::Models::FundingEvent::CollectionResourceType] Collection resource type
|
|
65
64
|
#
|
|
66
65
|
# @param collection_tokens [Array<String>] IDs of collections, further information can be gathered from the appropriate col
|
|
67
66
|
#
|
|
@@ -69,7 +68,7 @@ module Lithic
|
|
|
69
68
|
#
|
|
70
69
|
# @param high_watermark [Time] Time of the high watermark
|
|
71
70
|
#
|
|
72
|
-
# @param network_settlement_summary [Array<Lithic::Models::
|
|
71
|
+
# @param network_settlement_summary [Array<Lithic::Models::FundingEvent::NetworkSettlementSummary>] Network settlement summary breakdown by network settlement date
|
|
73
72
|
#
|
|
74
73
|
# @param previous_high_watermark [Time] Time of the previous high watermark
|
|
75
74
|
#
|
|
@@ -77,7 +76,7 @@ module Lithic
|
|
|
77
76
|
|
|
78
77
|
# Collection resource type
|
|
79
78
|
#
|
|
80
|
-
# @see Lithic::Models::
|
|
79
|
+
# @see Lithic::Models::FundingEvent#collection_resource_type
|
|
81
80
|
module CollectionResourceType
|
|
82
81
|
extend Lithic::Internal::Type::Enum
|
|
83
82
|
|
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Lithic
|
|
4
|
+
module Models
|
|
5
|
+
class InternalTransactionAPI < Lithic::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute token
|
|
7
|
+
#
|
|
8
|
+
# @return [String]
|
|
9
|
+
required :token, String
|
|
10
|
+
|
|
11
|
+
# @!attribute category
|
|
12
|
+
#
|
|
13
|
+
# @return [Symbol, Lithic::Models::InternalTransactionAPI::Category]
|
|
14
|
+
required :category, enum: -> { Lithic::InternalTransactionAPI::Category }
|
|
15
|
+
|
|
16
|
+
# @!attribute created
|
|
17
|
+
#
|
|
18
|
+
# @return [Time]
|
|
19
|
+
required :created, Time
|
|
20
|
+
|
|
21
|
+
# @!attribute currency
|
|
22
|
+
#
|
|
23
|
+
# @return [String]
|
|
24
|
+
required :currency, String
|
|
25
|
+
|
|
26
|
+
# @!attribute descriptor
|
|
27
|
+
#
|
|
28
|
+
# @return [String]
|
|
29
|
+
required :descriptor, String
|
|
30
|
+
|
|
31
|
+
# @!attribute events
|
|
32
|
+
#
|
|
33
|
+
# @return [Array<Lithic::Models::InternalTransactionAPI::Event>]
|
|
34
|
+
required :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::InternalTransactionAPI::Event] }
|
|
35
|
+
|
|
36
|
+
# @!attribute pending_amount
|
|
37
|
+
#
|
|
38
|
+
# @return [Integer]
|
|
39
|
+
required :pending_amount, Integer
|
|
40
|
+
|
|
41
|
+
# @!attribute result
|
|
42
|
+
#
|
|
43
|
+
# @return [Symbol, Lithic::Models::InternalTransactionAPI::Result]
|
|
44
|
+
required :result, enum: -> { Lithic::InternalTransactionAPI::Result }
|
|
45
|
+
|
|
46
|
+
# @!attribute settled_amount
|
|
47
|
+
#
|
|
48
|
+
# @return [Integer]
|
|
49
|
+
required :settled_amount, Integer
|
|
50
|
+
|
|
51
|
+
# @!attribute status
|
|
52
|
+
#
|
|
53
|
+
# @return [Symbol, Lithic::Models::InternalTransactionAPI::Status]
|
|
54
|
+
required :status, enum: -> { Lithic::InternalTransactionAPI::Status }
|
|
55
|
+
|
|
56
|
+
# @!attribute updated
|
|
57
|
+
#
|
|
58
|
+
# @return [Time]
|
|
59
|
+
required :updated, Time
|
|
60
|
+
|
|
61
|
+
# @!method initialize(token:, category:, created:, currency:, descriptor:, events:, pending_amount:, result:, settled_amount:, status:, updated:)
|
|
62
|
+
# @param token [String]
|
|
63
|
+
# @param category [Symbol, Lithic::Models::InternalTransactionAPI::Category]
|
|
64
|
+
# @param created [Time]
|
|
65
|
+
# @param currency [String]
|
|
66
|
+
# @param descriptor [String]
|
|
67
|
+
# @param events [Array<Lithic::Models::InternalTransactionAPI::Event>]
|
|
68
|
+
# @param pending_amount [Integer]
|
|
69
|
+
# @param result [Symbol, Lithic::Models::InternalTransactionAPI::Result]
|
|
70
|
+
# @param settled_amount [Integer]
|
|
71
|
+
# @param status [Symbol, Lithic::Models::InternalTransactionAPI::Status]
|
|
72
|
+
# @param updated [Time]
|
|
73
|
+
|
|
74
|
+
# @see Lithic::Models::InternalTransactionAPI#category
|
|
75
|
+
module Category
|
|
76
|
+
extend Lithic::Internal::Type::Enum
|
|
77
|
+
|
|
78
|
+
INTERNAL = :INTERNAL
|
|
79
|
+
|
|
80
|
+
# @!method self.values
|
|
81
|
+
# @return [Array<Symbol>]
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
class Event < Lithic::Internal::Type::BaseModel
|
|
85
|
+
# @!attribute token
|
|
86
|
+
#
|
|
87
|
+
# @return [String]
|
|
88
|
+
required :token, String
|
|
89
|
+
|
|
90
|
+
# @!attribute amount
|
|
91
|
+
#
|
|
92
|
+
# @return [Integer]
|
|
93
|
+
required :amount, Integer
|
|
94
|
+
|
|
95
|
+
# @!attribute created
|
|
96
|
+
#
|
|
97
|
+
# @return [Time]
|
|
98
|
+
required :created, Time
|
|
99
|
+
|
|
100
|
+
# @!attribute result
|
|
101
|
+
#
|
|
102
|
+
# @return [Symbol, Lithic::Models::InternalTransactionAPI::Event::Result]
|
|
103
|
+
required :result, enum: -> { Lithic::InternalTransactionAPI::Event::Result }
|
|
104
|
+
|
|
105
|
+
# @!attribute type
|
|
106
|
+
#
|
|
107
|
+
# @return [Symbol, Lithic::Models::InternalTransactionAPI::Event::Type]
|
|
108
|
+
required :type, enum: -> { Lithic::InternalTransactionAPI::Event::Type }
|
|
109
|
+
|
|
110
|
+
# @!method initialize(token:, amount:, created:, result:, type:)
|
|
111
|
+
# @param token [String]
|
|
112
|
+
# @param amount [Integer]
|
|
113
|
+
# @param created [Time]
|
|
114
|
+
# @param result [Symbol, Lithic::Models::InternalTransactionAPI::Event::Result]
|
|
115
|
+
# @param type [Symbol, Lithic::Models::InternalTransactionAPI::Event::Type]
|
|
116
|
+
|
|
117
|
+
# @see Lithic::Models::InternalTransactionAPI::Event#result
|
|
118
|
+
module Result
|
|
119
|
+
extend Lithic::Internal::Type::Enum
|
|
120
|
+
|
|
121
|
+
APPROVED = :APPROVED
|
|
122
|
+
DECLINED = :DECLINED
|
|
123
|
+
|
|
124
|
+
# @!method self.values
|
|
125
|
+
# @return [Array<Symbol>]
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
# @see Lithic::Models::InternalTransactionAPI::Event#type
|
|
129
|
+
module Type
|
|
130
|
+
extend Lithic::Internal::Type::Enum
|
|
131
|
+
|
|
132
|
+
INTERNAL_ADJUSTMENT = :INTERNAL_ADJUSTMENT
|
|
133
|
+
|
|
134
|
+
# @!method self.values
|
|
135
|
+
# @return [Array<Symbol>]
|
|
136
|
+
end
|
|
137
|
+
end
|
|
138
|
+
|
|
139
|
+
# @see Lithic::Models::InternalTransactionAPI#result
|
|
140
|
+
module Result
|
|
141
|
+
extend Lithic::Internal::Type::Enum
|
|
142
|
+
|
|
143
|
+
APPROVED = :APPROVED
|
|
144
|
+
DECLINED = :DECLINED
|
|
145
|
+
|
|
146
|
+
# @!method self.values
|
|
147
|
+
# @return [Array<Symbol>]
|
|
148
|
+
end
|
|
149
|
+
|
|
150
|
+
# @see Lithic::Models::InternalTransactionAPI#status
|
|
151
|
+
module Status
|
|
152
|
+
extend Lithic::Internal::Type::Enum
|
|
153
|
+
|
|
154
|
+
PENDING = :PENDING
|
|
155
|
+
SETTLED = :SETTLED
|
|
156
|
+
DECLINED = :DECLINED
|
|
157
|
+
REVERSED = :REVERSED
|
|
158
|
+
CANCELED = :CANCELED
|
|
159
|
+
RETURNED = :RETURNED
|
|
160
|
+
|
|
161
|
+
# @!method self.values
|
|
162
|
+
# @return [Array<Symbol>]
|
|
163
|
+
end
|
|
164
|
+
end
|
|
165
|
+
end
|
|
166
|
+
end
|
|
@@ -133,6 +133,12 @@ module Lithic
|
|
|
133
133
|
DISPUTE_WON_REVERSAL = :DISPUTE_WON_REVERSAL
|
|
134
134
|
DISBURSE = :DISBURSE
|
|
135
135
|
DISBURSE_REVERSAL = :DISBURSE_REVERSAL
|
|
136
|
+
ANNUAL = :ANNUAL
|
|
137
|
+
ANNUAL_REVERSAL = :ANNUAL_REVERSAL
|
|
138
|
+
QUARTERLY = :QUARTERLY
|
|
139
|
+
QUARTERLY_REVERSAL = :QUARTERLY_REVERSAL
|
|
140
|
+
MONTHLY = :MONTHLY
|
|
141
|
+
MONTHLY_REVERSAL = :MONTHLY_REVERSAL
|
|
136
142
|
|
|
137
143
|
# @!method self.values
|
|
138
144
|
# @return [Array<Symbol>]
|
|
@@ -271,6 +271,12 @@ module Lithic
|
|
|
271
271
|
DISPUTE_WON_REVERSAL = :DISPUTE_WON_REVERSAL
|
|
272
272
|
DISBURSE = :DISBURSE
|
|
273
273
|
DISBURSE_REVERSAL = :DISBURSE_REVERSAL
|
|
274
|
+
ANNUAL = :ANNUAL
|
|
275
|
+
ANNUAL_REVERSAL = :ANNUAL_REVERSAL
|
|
276
|
+
QUARTERLY = :QUARTERLY
|
|
277
|
+
QUARTERLY_REVERSAL = :QUARTERLY_REVERSAL
|
|
278
|
+
MONTHLY = :MONTHLY
|
|
279
|
+
MONTHLY_REVERSAL = :MONTHLY_REVERSAL
|
|
274
280
|
|
|
275
281
|
# @!method self.values
|
|
276
282
|
# @return [Array<Symbol>]
|
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Lithic
|
|
4
|
+
module Models
|
|
5
|
+
class NetworkTotal < Lithic::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute token
|
|
7
|
+
# Globally unique identifier.
|
|
8
|
+
#
|
|
9
|
+
# @return [String]
|
|
10
|
+
required :token, String
|
|
11
|
+
|
|
12
|
+
# @!attribute amounts
|
|
13
|
+
#
|
|
14
|
+
# @return [Lithic::Models::NetworkTotal::Amounts]
|
|
15
|
+
required :amounts, -> { Lithic::NetworkTotal::Amounts }
|
|
16
|
+
|
|
17
|
+
# @!attribute created
|
|
18
|
+
# RFC 3339 timestamp for when the record was created. UTC time zone.
|
|
19
|
+
#
|
|
20
|
+
# @return [Time]
|
|
21
|
+
required :created, Time
|
|
22
|
+
|
|
23
|
+
# @!attribute currency
|
|
24
|
+
# 3-character alphabetic ISO 4217 code.
|
|
25
|
+
#
|
|
26
|
+
# @return [String]
|
|
27
|
+
required :currency, String
|
|
28
|
+
|
|
29
|
+
# @!attribute institution_id
|
|
30
|
+
# The institution that activity occurred on. For Mastercard: ICA (Interbank Card
|
|
31
|
+
# Association). For Maestro: institution ID. For Visa: lowest level SRE
|
|
32
|
+
# (Settlement Reporting Entity).
|
|
33
|
+
#
|
|
34
|
+
# @return [String]
|
|
35
|
+
required :institution_id, String
|
|
36
|
+
|
|
37
|
+
# @!attribute is_complete
|
|
38
|
+
# Indicates that all settlement records related to this Network Total are
|
|
39
|
+
# available in the details endpoint.
|
|
40
|
+
#
|
|
41
|
+
# @return [Boolean]
|
|
42
|
+
required :is_complete, Lithic::Internal::Type::Boolean
|
|
43
|
+
|
|
44
|
+
# @!attribute network
|
|
45
|
+
# Card network where the transaction took place. AMEX, VISA, MASTERCARD, MAESTRO,
|
|
46
|
+
# or INTERLINK.
|
|
47
|
+
#
|
|
48
|
+
# @return [Symbol, Lithic::Models::NetworkTotal::Network]
|
|
49
|
+
required :network, enum: -> { Lithic::NetworkTotal::Network }
|
|
50
|
+
|
|
51
|
+
# @!attribute report_date
|
|
52
|
+
# Date that the network total record applies to. YYYY-MM-DD format.
|
|
53
|
+
#
|
|
54
|
+
# @return [Date]
|
|
55
|
+
required :report_date, Date
|
|
56
|
+
|
|
57
|
+
# @!attribute settlement_institution_id
|
|
58
|
+
# The institution responsible for settlement. For Mastercard: same as
|
|
59
|
+
# `institution_id`. For Maestro: billing ICA. For Visa: Funds Transfer SRE
|
|
60
|
+
# (FTSRE).
|
|
61
|
+
#
|
|
62
|
+
# @return [String]
|
|
63
|
+
required :settlement_institution_id, String
|
|
64
|
+
|
|
65
|
+
# @!attribute settlement_service
|
|
66
|
+
# Settlement service.
|
|
67
|
+
#
|
|
68
|
+
# @return [String]
|
|
69
|
+
required :settlement_service, String
|
|
70
|
+
|
|
71
|
+
# @!attribute updated
|
|
72
|
+
# RFC 3339 timestamp for when the record was last updated. UTC time zone.
|
|
73
|
+
#
|
|
74
|
+
# @return [Time]
|
|
75
|
+
required :updated, Time
|
|
76
|
+
|
|
77
|
+
# @!attribute cycle
|
|
78
|
+
# The clearing cycle that the network total record applies to. Mastercard only.
|
|
79
|
+
#
|
|
80
|
+
# @return [Integer, nil]
|
|
81
|
+
optional :cycle, Integer
|
|
82
|
+
|
|
83
|
+
# @!method initialize(token:, amounts:, created:, currency:, institution_id:, is_complete:, network:, report_date:, settlement_institution_id:, settlement_service:, updated:, cycle: nil)
|
|
84
|
+
# Some parameter documentations has been truncated, see
|
|
85
|
+
# {Lithic::Models::NetworkTotal} for more details.
|
|
86
|
+
#
|
|
87
|
+
# @param token [String] Globally unique identifier.
|
|
88
|
+
#
|
|
89
|
+
# @param amounts [Lithic::Models::NetworkTotal::Amounts]
|
|
90
|
+
#
|
|
91
|
+
# @param created [Time] RFC 3339 timestamp for when the record was created. UTC time zone.
|
|
92
|
+
#
|
|
93
|
+
# @param currency [String] 3-character alphabetic ISO 4217 code.
|
|
94
|
+
#
|
|
95
|
+
# @param institution_id [String] The institution that activity occurred on. For Mastercard: ICA (Interbank Card A
|
|
96
|
+
#
|
|
97
|
+
# @param is_complete [Boolean] Indicates that all settlement records related to this Network Total are availabl
|
|
98
|
+
#
|
|
99
|
+
# @param network [Symbol, Lithic::Models::NetworkTotal::Network] Card network where the transaction took place. AMEX, VISA, MASTERCARD, MAESTRO,
|
|
100
|
+
#
|
|
101
|
+
# @param report_date [Date] Date that the network total record applies to. YYYY-MM-DD format.
|
|
102
|
+
#
|
|
103
|
+
# @param settlement_institution_id [String] The institution responsible for settlement. For Mastercard: same as `institution
|
|
104
|
+
#
|
|
105
|
+
# @param settlement_service [String] Settlement service.
|
|
106
|
+
#
|
|
107
|
+
# @param updated [Time] RFC 3339 timestamp for when the record was last updated. UTC time zone.
|
|
108
|
+
#
|
|
109
|
+
# @param cycle [Integer] The clearing cycle that the network total record applies to. Mastercard only.
|
|
110
|
+
|
|
111
|
+
# @see Lithic::Models::NetworkTotal#amounts
|
|
112
|
+
class Amounts < Lithic::Internal::Type::BaseModel
|
|
113
|
+
# @!attribute gross_settlement
|
|
114
|
+
# Total settlement amount excluding interchange, in currency's smallest unit.
|
|
115
|
+
#
|
|
116
|
+
# @return [Integer]
|
|
117
|
+
required :gross_settlement, Integer
|
|
118
|
+
|
|
119
|
+
# @!attribute interchange_fees
|
|
120
|
+
# Interchange amount, in currency's smallest unit.
|
|
121
|
+
#
|
|
122
|
+
# @return [Integer]
|
|
123
|
+
required :interchange_fees, Integer
|
|
124
|
+
|
|
125
|
+
# @!attribute net_settlement
|
|
126
|
+
# `gross_settlement` net of `interchange_fees` and `visa_charges` (if applicable),
|
|
127
|
+
# in currency's smallest unit.
|
|
128
|
+
#
|
|
129
|
+
# @return [Integer]
|
|
130
|
+
required :net_settlement, Integer
|
|
131
|
+
|
|
132
|
+
# @!attribute visa_charges
|
|
133
|
+
# Charges specific to Visa/Interlink, in currency's smallest unit.
|
|
134
|
+
#
|
|
135
|
+
# @return [Integer, nil]
|
|
136
|
+
optional :visa_charges, Integer
|
|
137
|
+
|
|
138
|
+
# @!method initialize(gross_settlement:, interchange_fees:, net_settlement:, visa_charges: nil)
|
|
139
|
+
# Some parameter documentations has been truncated, see
|
|
140
|
+
# {Lithic::Models::NetworkTotal::Amounts} for more details.
|
|
141
|
+
#
|
|
142
|
+
# @param gross_settlement [Integer] Total settlement amount excluding interchange, in currency's smallest unit.
|
|
143
|
+
#
|
|
144
|
+
# @param interchange_fees [Integer] Interchange amount, in currency's smallest unit.
|
|
145
|
+
#
|
|
146
|
+
# @param net_settlement [Integer] `gross_settlement` net of `interchange_fees` and `visa_charges` (if applicable),
|
|
147
|
+
#
|
|
148
|
+
# @param visa_charges [Integer] Charges specific to Visa/Interlink, in currency's smallest unit.
|
|
149
|
+
end
|
|
150
|
+
|
|
151
|
+
# Card network where the transaction took place. AMEX, VISA, MASTERCARD, MAESTRO,
|
|
152
|
+
# or INTERLINK.
|
|
153
|
+
#
|
|
154
|
+
# @see Lithic::Models::NetworkTotal#network
|
|
155
|
+
module Network
|
|
156
|
+
extend Lithic::Internal::Type::Enum
|
|
157
|
+
|
|
158
|
+
AMEX = :AMEX
|
|
159
|
+
VISA = :VISA
|
|
160
|
+
MASTERCARD = :MASTERCARD
|
|
161
|
+
MAESTRO = :MAESTRO
|
|
162
|
+
INTERLINK = :INTERLINK
|
|
163
|
+
|
|
164
|
+
# @!method self.values
|
|
165
|
+
# @return [Array<Symbol>]
|
|
166
|
+
end
|
|
167
|
+
end
|
|
168
|
+
end
|
|
169
|
+
end
|
|
@@ -117,6 +117,13 @@ module Lithic
|
|
|
117
117
|
# @return [Array<String>, nil]
|
|
118
118
|
optional :auth_rule_tokens, Lithic::Internal::Type::ArrayOf[String]
|
|
119
119
|
|
|
120
|
+
# @!attribute bulk_order_token
|
|
121
|
+
# Globally unique identifier for the bulk order associated with this card. Only
|
|
122
|
+
# applicable to physical cards that are part of a bulk shipment
|
|
123
|
+
#
|
|
124
|
+
# @return [String, nil]
|
|
125
|
+
optional :bulk_order_token, String, nil?: true
|
|
126
|
+
|
|
120
127
|
# @!attribute cardholder_currency
|
|
121
128
|
# 3-character alphabetic ISO 4217 code for the currency of the cardholder.
|
|
122
129
|
#
|
|
@@ -217,7 +224,7 @@ module Lithic
|
|
|
217
224
|
# @return [Symbol, Lithic::Models::NonPCICard::Substatus, nil]
|
|
218
225
|
optional :substatus, enum: -> { Lithic::NonPCICard::Substatus }
|
|
219
226
|
|
|
220
|
-
# @!method initialize(token:, account_token:, card_program_token:, created:, funding:, last_four:, pin_status:, spend_limit:, spend_limit_duration:, state:, type:, auth_rule_tokens: nil, cardholder_currency: nil, comment: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, hostname: nil, memo: nil, network_program_token: nil, pending_commands: nil, product_id: nil, replacement_for: nil, substatus: nil)
|
|
227
|
+
# @!method initialize(token:, account_token:, card_program_token:, created:, funding:, last_four:, pin_status:, spend_limit:, spend_limit_duration:, state:, type:, auth_rule_tokens: nil, bulk_order_token: nil, cardholder_currency: nil, comment: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, hostname: nil, memo: nil, network_program_token: nil, pending_commands: nil, product_id: nil, replacement_for: nil, substatus: nil)
|
|
221
228
|
# Some parameter documentations has been truncated, see
|
|
222
229
|
# {Lithic::Models::NonPCICard} for more details.
|
|
223
230
|
#
|
|
@@ -249,6 +256,8 @@ module Lithic
|
|
|
249
256
|
#
|
|
250
257
|
# @param auth_rule_tokens [Array<String>] List of identifiers for the Auth Rule(s) that are applied on the card. This fiel
|
|
251
258
|
#
|
|
259
|
+
# @param bulk_order_token [String, nil] Globally unique identifier for the bulk order associated with this card. Only ap
|
|
260
|
+
#
|
|
252
261
|
# @param cardholder_currency [String] 3-character alphabetic ISO 4217 code for the currency of the cardholder.
|
|
253
262
|
#
|
|
254
263
|
# @param comment [String] Additional context or information related to the card.
|