lithic 0.1.0 → 0.2.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.
Files changed (186) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +13 -0
  3. data/README.md +36 -1
  4. data/lib/lithic/client.rb +4 -0
  5. data/lib/lithic/errors.rb +15 -0
  6. data/lib/lithic/models/account_holder_created_webhook_event.rb +75 -0
  7. data/lib/lithic/models/account_holder_document_updated_webhook_event.rb +191 -0
  8. data/lib/lithic/models/account_holder_updated_webhook_event.rb +702 -0
  9. data/lib/lithic/models/account_holder_verification_webhook_event.rb +69 -0
  10. data/lib/lithic/models/asa_request_webhook_event.rb +1010 -0
  11. data/lib/lithic/models/auth_rules_backtest_report_created_webhook_event.rb +16 -0
  12. data/lib/lithic/models/balance_updated_webhook_event.rb +23 -0
  13. data/lib/lithic/models/book_transfer_transaction_created_webhook_event.rb +18 -0
  14. data/lib/lithic/models/book_transfer_transaction_updated_webhook_event.rb +18 -0
  15. data/lib/lithic/models/card_converted_webhook_event.rb +24 -0
  16. data/lib/lithic/models/card_created_webhook_event.rb +32 -0
  17. data/lib/lithic/models/card_reissued_webhook_event.rb +24 -0
  18. data/lib/lithic/models/card_renewed_webhook_event.rb +56 -0
  19. data/lib/lithic/models/card_shipped_webhook_event.rb +70 -0
  20. data/lib/lithic/models/card_transaction_enhanced_data_created_webhook_event.rb +16 -0
  21. data/lib/lithic/models/card_transaction_enhanced_data_updated_webhook_event.rb +16 -0
  22. data/lib/lithic/models/card_transaction_updated_webhook_event.rb +16 -0
  23. data/lib/lithic/models/digital_wallet_tokenization_approval_request_webhook_event.rb +253 -0
  24. data/lib/lithic/models/digital_wallet_tokenization_result_webhook_event.rb +145 -0
  25. data/lib/lithic/models/digital_wallet_tokenization_two_factor_authentication_code_sent_webhook_event.rb +100 -0
  26. data/lib/lithic/models/digital_wallet_tokenization_two_factor_authentication_code_webhook_event.rb +108 -0
  27. data/lib/lithic/models/digital_wallet_tokenization_updated_webhook_event.rb +47 -0
  28. data/lib/lithic/models/dispute_evidence_upload_failed_webhook_event.rb +18 -0
  29. data/lib/lithic/models/dispute_transaction_created_webhook_event.rb +18 -0
  30. data/lib/lithic/models/dispute_transaction_updated_webhook_event.rb +18 -0
  31. data/lib/lithic/models/dispute_updated_webhook_event.rb +18 -0
  32. data/lib/lithic/models/external_bank_account_created_webhook_event.rb +16 -0
  33. data/lib/lithic/models/external_bank_account_updated_webhook_event.rb +16 -0
  34. data/lib/lithic/models/external_payment_created_webhook_event.rb +16 -0
  35. data/lib/lithic/models/external_payment_updated_webhook_event.rb +16 -0
  36. data/lib/lithic/models/financial_account_created_webhook_event.rb +16 -0
  37. data/lib/lithic/models/financial_account_updated_webhook_event.rb +16 -0
  38. data/lib/lithic/models/funding_event_created_webhook_event.rb +16 -0
  39. data/lib/lithic/models/internal_transaction_created_webhook_event.rb +16 -0
  40. data/lib/lithic/models/internal_transaction_updated_webhook_event.rb +16 -0
  41. data/lib/lithic/models/loan_tape_created_webhook_event.rb +16 -0
  42. data/lib/lithic/models/loan_tape_updated_webhook_event.rb +16 -0
  43. data/lib/lithic/models/management_operation_created_webhook_event.rb +16 -0
  44. data/lib/lithic/models/management_operation_updated_webhook_event.rb +16 -0
  45. data/lib/lithic/models/network_total_created_webhook_event.rb +16 -0
  46. data/lib/lithic/models/network_total_updated_webhook_event.rb +16 -0
  47. data/lib/lithic/models/parsed_webhook_event.rb +818 -0
  48. data/lib/lithic/models/payment_transaction_created_webhook_event.rb +18 -0
  49. data/lib/lithic/models/payment_transaction_updated_webhook_event.rb +18 -0
  50. data/lib/lithic/models/settlement_report_updated_webhook_event.rb +16 -0
  51. data/lib/lithic/models/statements_created_webhook_event.rb +16 -0
  52. data/lib/lithic/models/three_ds_authentication_challenge_webhook_event.rb +89 -0
  53. data/lib/lithic/models/three_ds_authentication_created_webhook_event.rb +18 -0
  54. data/lib/lithic/models/three_ds_authentication_updated_webhook_event.rb +18 -0
  55. data/lib/lithic/models/tokenization_approval_request_webhook_event.rb +249 -0
  56. data/lib/lithic/models/tokenization_decisioning_request_webhook_event.rb +159 -0
  57. data/lib/lithic/models/tokenization_result_webhook_event.rb +141 -0
  58. data/lib/lithic/models/tokenization_two_factor_authentication_code_sent_webhook_event.rb +100 -0
  59. data/lib/lithic/models/tokenization_two_factor_authentication_code_webhook_event.rb +108 -0
  60. data/lib/lithic/models/tokenization_updated_webhook_event.rb +47 -0
  61. data/lib/lithic/models/webhook_parsed_params.rb +14 -0
  62. data/lib/lithic/models.rb +120 -0
  63. data/lib/lithic/resources/webhooks.rb +87 -0
  64. data/lib/lithic/version.rb +1 -1
  65. data/lib/lithic.rb +74 -17
  66. data/rbi/lithic/client.rbi +3 -0
  67. data/rbi/lithic/models/account_holder_created_webhook_event.rbi +149 -0
  68. data/rbi/lithic/models/account_holder_document_updated_webhook_event.rbi +479 -0
  69. data/rbi/lithic/models/account_holder_updated_webhook_event.rbi +1274 -0
  70. data/rbi/lithic/models/account_holder_verification_webhook_event.rbi +143 -0
  71. data/rbi/lithic/models/asa_request_webhook_event.rbi +2229 -0
  72. data/rbi/lithic/models/auth_rules_backtest_report_created_webhook_event.rbi +30 -0
  73. data/rbi/lithic/models/balance_updated_webhook_event.rbi +43 -0
  74. data/rbi/lithic/models/book_transfer_transaction_created_webhook_event.rbi +31 -0
  75. data/rbi/lithic/models/book_transfer_transaction_updated_webhook_event.rbi +31 -0
  76. data/rbi/lithic/models/card_converted_webhook_event.rbi +35 -0
  77. data/rbi/lithic/models/card_created_webhook_event.rbi +53 -0
  78. data/rbi/lithic/models/card_reissued_webhook_event.rbi +38 -0
  79. data/rbi/lithic/models/card_renewed_webhook_event.rbi +92 -0
  80. data/rbi/lithic/models/card_shipped_webhook_event.rbi +150 -0
  81. data/rbi/lithic/models/card_transaction_enhanced_data_created_webhook_event.rbi +30 -0
  82. data/rbi/lithic/models/card_transaction_enhanced_data_updated_webhook_event.rbi +30 -0
  83. data/rbi/lithic/models/card_transaction_updated_webhook_event.rbi +30 -0
  84. data/rbi/lithic/models/digital_wallet_token_metadata.rbi +2 -2
  85. data/rbi/lithic/models/digital_wallet_tokenization_approval_request_webhook_event.rbi +548 -0
  86. data/rbi/lithic/models/digital_wallet_tokenization_result_webhook_event.rbi +295 -0
  87. data/rbi/lithic/models/digital_wallet_tokenization_two_factor_authentication_code_sent_webhook_event.rbi +186 -0
  88. data/rbi/lithic/models/digital_wallet_tokenization_two_factor_authentication_code_webhook_event.rbi +194 -0
  89. data/rbi/lithic/models/digital_wallet_tokenization_updated_webhook_event.rbi +73 -0
  90. data/rbi/lithic/models/dispute_evidence_upload_failed_webhook_event.rbi +31 -0
  91. data/rbi/lithic/models/dispute_transaction_created_webhook_event.rbi +31 -0
  92. data/rbi/lithic/models/dispute_transaction_updated_webhook_event.rbi +31 -0
  93. data/rbi/lithic/models/dispute_updated_webhook_event.rbi +28 -0
  94. data/rbi/lithic/models/external_bank_account_created_webhook_event.rbi +30 -0
  95. data/rbi/lithic/models/external_bank_account_updated_webhook_event.rbi +30 -0
  96. data/rbi/lithic/models/external_payment_created_webhook_event.rbi +30 -0
  97. data/rbi/lithic/models/external_payment_updated_webhook_event.rbi +30 -0
  98. data/rbi/lithic/models/financial_account_created_webhook_event.rbi +30 -0
  99. data/rbi/lithic/models/financial_account_updated_webhook_event.rbi +30 -0
  100. data/rbi/lithic/models/funding_event_created_webhook_event.rbi +30 -0
  101. data/rbi/lithic/models/internal_transaction.rbi +15 -10
  102. data/rbi/lithic/models/internal_transaction_created_webhook_event.rbi +30 -0
  103. data/rbi/lithic/models/internal_transaction_updated_webhook_event.rbi +30 -0
  104. data/rbi/lithic/models/loan_tape_created_webhook_event.rbi +27 -0
  105. data/rbi/lithic/models/loan_tape_updated_webhook_event.rbi +27 -0
  106. data/rbi/lithic/models/management_operation_created_webhook_event.rbi +30 -0
  107. data/rbi/lithic/models/management_operation_updated_webhook_event.rbi +30 -0
  108. data/rbi/lithic/models/network_total_created_webhook_event.rbi +30 -0
  109. data/rbi/lithic/models/network_total_updated_webhook_event.rbi +30 -0
  110. data/rbi/lithic/models/parsed_webhook_event.rbi +1310 -0
  111. data/rbi/lithic/models/payment_transaction_created_webhook_event.rbi +31 -0
  112. data/rbi/lithic/models/payment_transaction_updated_webhook_event.rbi +31 -0
  113. data/rbi/lithic/models/settlement_report_updated_webhook_event.rbi +30 -0
  114. data/rbi/lithic/models/statements_created_webhook_event.rbi +30 -0
  115. data/rbi/lithic/models/three_ds_authentication_challenge_webhook_event.rbi +175 -0
  116. data/rbi/lithic/models/three_ds_authentication_created_webhook_event.rbi +31 -0
  117. data/rbi/lithic/models/three_ds_authentication_updated_webhook_event.rbi +31 -0
  118. data/rbi/lithic/models/tokenization_approval_request_webhook_event.rbi +548 -0
  119. data/rbi/lithic/models/tokenization_decisioning_request_webhook_event.rbi +333 -0
  120. data/rbi/lithic/models/tokenization_result_webhook_event.rbi +295 -0
  121. data/rbi/lithic/models/tokenization_two_factor_authentication_code_sent_webhook_event.rbi +186 -0
  122. data/rbi/lithic/models/tokenization_two_factor_authentication_code_webhook_event.rbi +194 -0
  123. data/rbi/lithic/models/tokenization_updated_webhook_event.rbi +73 -0
  124. data/rbi/lithic/models/webhook_parsed_params.rbi +27 -0
  125. data/rbi/lithic/models.rbi +155 -0
  126. data/rbi/lithic/resources/webhooks.rbi +158 -0
  127. data/sig/lithic/client.rbs +2 -0
  128. data/sig/lithic/models/account_holder_created_webhook_event.rbs +77 -0
  129. data/sig/lithic/models/account_holder_document_updated_webhook_event.rbs +219 -0
  130. data/sig/lithic/models/account_holder_updated_webhook_event.rbs +587 -0
  131. data/sig/lithic/models/account_holder_verification_webhook_event.rbs +69 -0
  132. data/sig/lithic/models/asa_request_webhook_event.rbs +881 -0
  133. data/sig/lithic/models/auth_rules_backtest_report_created_webhook_event.rbs +20 -0
  134. data/sig/lithic/models/balance_updated_webhook_event.rbs +25 -0
  135. data/sig/lithic/models/book_transfer_transaction_created_webhook_event.rbs +20 -0
  136. data/sig/lithic/models/book_transfer_transaction_updated_webhook_event.rbs +20 -0
  137. data/sig/lithic/models/card_converted_webhook_event.rbs +19 -0
  138. data/sig/lithic/models/card_created_webhook_event.rbs +30 -0
  139. data/sig/lithic/models/card_reissued_webhook_event.rbs +21 -0
  140. data/sig/lithic/models/card_renewed_webhook_event.rbs +55 -0
  141. data/sig/lithic/models/card_shipped_webhook_event.rbs +71 -0
  142. data/sig/lithic/models/card_transaction_enhanced_data_created_webhook_event.rbs +20 -0
  143. data/sig/lithic/models/card_transaction_enhanced_data_updated_webhook_event.rbs +20 -0
  144. data/sig/lithic/models/card_transaction_updated_webhook_event.rbs +18 -0
  145. data/sig/lithic/models/digital_wallet_tokenization_approval_request_webhook_event.rbs +223 -0
  146. data/sig/lithic/models/digital_wallet_tokenization_result_webhook_event.rbs +133 -0
  147. data/sig/lithic/models/digital_wallet_tokenization_two_factor_authentication_code_sent_webhook_event.rbs +78 -0
  148. data/sig/lithic/models/digital_wallet_tokenization_two_factor_authentication_code_webhook_event.rbs +83 -0
  149. data/sig/lithic/models/digital_wallet_tokenization_updated_webhook_event.rbs +40 -0
  150. data/sig/lithic/models/dispute_evidence_upload_failed_webhook_event.rbs +18 -0
  151. data/sig/lithic/models/dispute_transaction_created_webhook_event.rbs +18 -0
  152. data/sig/lithic/models/dispute_transaction_updated_webhook_event.rbs +18 -0
  153. data/sig/lithic/models/dispute_updated_webhook_event.rbs +15 -0
  154. data/sig/lithic/models/external_bank_account_created_webhook_event.rbs +18 -0
  155. data/sig/lithic/models/external_bank_account_updated_webhook_event.rbs +18 -0
  156. data/sig/lithic/models/external_payment_created_webhook_event.rbs +18 -0
  157. data/sig/lithic/models/external_payment_updated_webhook_event.rbs +18 -0
  158. data/sig/lithic/models/financial_account_created_webhook_event.rbs +18 -0
  159. data/sig/lithic/models/financial_account_updated_webhook_event.rbs +18 -0
  160. data/sig/lithic/models/funding_event_created_webhook_event.rbs +16 -0
  161. data/sig/lithic/models/internal_transaction_created_webhook_event.rbs +18 -0
  162. data/sig/lithic/models/internal_transaction_updated_webhook_event.rbs +18 -0
  163. data/sig/lithic/models/loan_tape_created_webhook_event.rbs +15 -0
  164. data/sig/lithic/models/loan_tape_updated_webhook_event.rbs +15 -0
  165. data/sig/lithic/models/management_operation_created_webhook_event.rbs +18 -0
  166. data/sig/lithic/models/management_operation_updated_webhook_event.rbs +18 -0
  167. data/sig/lithic/models/network_total_created_webhook_event.rbs +16 -0
  168. data/sig/lithic/models/network_total_updated_webhook_event.rbs +16 -0
  169. data/sig/lithic/models/parsed_webhook_event.rbs +641 -0
  170. data/sig/lithic/models/payment_transaction_created_webhook_event.rbs +18 -0
  171. data/sig/lithic/models/payment_transaction_updated_webhook_event.rbs +18 -0
  172. data/sig/lithic/models/settlement_report_updated_webhook_event.rbs +18 -0
  173. data/sig/lithic/models/statements_created_webhook_event.rbs +16 -0
  174. data/sig/lithic/models/three_ds_authentication_challenge_webhook_event.rbs +72 -0
  175. data/sig/lithic/models/three_ds_authentication_created_webhook_event.rbs +18 -0
  176. data/sig/lithic/models/three_ds_authentication_updated_webhook_event.rbs +18 -0
  177. data/sig/lithic/models/tokenization_approval_request_webhook_event.rbs +223 -0
  178. data/sig/lithic/models/tokenization_decisioning_request_webhook_event.rbs +134 -0
  179. data/sig/lithic/models/tokenization_result_webhook_event.rbs +133 -0
  180. data/sig/lithic/models/tokenization_two_factor_authentication_code_sent_webhook_event.rbs +78 -0
  181. data/sig/lithic/models/tokenization_two_factor_authentication_code_webhook_event.rbs +83 -0
  182. data/sig/lithic/models/tokenization_updated_webhook_event.rbs +40 -0
  183. data/sig/lithic/models/webhook_parsed_params.rbs +15 -0
  184. data/sig/lithic/models.rbs +112 -0
  185. data/sig/lithic/resources/webhooks.rbs +135 -0
  186. metadata +173 -2
@@ -0,0 +1,1010 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ class AsaRequestWebhookEvent < Lithic::Internal::Type::BaseModel
6
+ # @!attribute token
7
+ # The provisional transaction group uuid associated with the authorization
8
+ #
9
+ # @return [String]
10
+ required :token, String
11
+
12
+ # @!attribute acquirer_fee
13
+ # Fee (in cents) assessed by the merchant and paid for by the cardholder. Will be
14
+ # zero if no fee is assessed. Rebates may be transmitted as a negative value to
15
+ # indicate credited fees.
16
+ #
17
+ # @return [Integer]
18
+ required :acquirer_fee, Integer
19
+
20
+ # @!attribute amount
21
+ # Authorization amount of the transaction (in cents), including any acquirer fees.
22
+ # The contents of this field are identical to `authorization_amount`.
23
+ #
24
+ # @return [Integer]
25
+ required :amount, Integer
26
+
27
+ # @!attribute authorization_amount
28
+ # The base transaction amount (in cents) plus the acquirer fee field. This is the
29
+ # amount the issuer should authorize against unless the issuer is paying the
30
+ # acquirer fee on behalf of the cardholder.
31
+ #
32
+ # @return [Integer]
33
+ required :authorization_amount, Integer
34
+
35
+ # @!attribute avs
36
+ #
37
+ # @return [Lithic::Models::AsaRequestWebhookEvent::Avs]
38
+ required :avs, -> { Lithic::AsaRequestWebhookEvent::Avs }
39
+
40
+ # @!attribute card
41
+ # Card object in ASA
42
+ #
43
+ # @return [Lithic::Models::AsaRequestWebhookEvent::Card]
44
+ required :card, -> { Lithic::AsaRequestWebhookEvent::Card }
45
+
46
+ # @!attribute cardholder_currency
47
+ # 3-character alphabetic ISO 4217 code for cardholder's billing currency.
48
+ #
49
+ # @return [String]
50
+ required :cardholder_currency, String
51
+
52
+ # @!attribute cash_amount
53
+ # The portion of the transaction requested as cash back by the cardholder, and
54
+ # does not include any acquirer fees. The amount field includes the purchase
55
+ # amount, the requested cash back amount, and any acquirer fees.
56
+ #
57
+ # If no cash back was requested, the value of this field will be 0, and the field
58
+ # will always be present.
59
+ #
60
+ # @return [Integer]
61
+ required :cash_amount, Integer
62
+
63
+ # @!attribute created
64
+ # Date and time when the transaction first occurred in UTC.
65
+ #
66
+ # @return [Time]
67
+ required :created, Time
68
+
69
+ # @!attribute merchant
70
+ #
71
+ # @return [Lithic::Models::Merchant]
72
+ required :merchant, -> { Lithic::Merchant }
73
+
74
+ # @!attribute merchant_amount
75
+ # The amount that the merchant will receive, denominated in `merchant_currency`
76
+ # and in the smallest currency unit. Note the amount includes `acquirer_fee`,
77
+ # similar to `authorization_amount`. It will be different from
78
+ # `authorization_amount` if the merchant is taking payment in a different
79
+ # currency.
80
+ #
81
+ # @return [Integer]
82
+ required :merchant_amount, Integer
83
+
84
+ # @!attribute merchant_currency
85
+ # 3-character alphabetic ISO 4217 code for the local currency of the transaction.
86
+ #
87
+ # @return [String]
88
+ required :merchant_currency, String
89
+
90
+ # @!attribute settled_amount
91
+ # Amount (in cents) of the transaction that has been settled, including any
92
+ # acquirer fees
93
+ #
94
+ # @return [Integer]
95
+ required :settled_amount, Integer
96
+
97
+ # @!attribute status
98
+ # The type of authorization request that this request is for. Note that
99
+ # `CREDIT_AUTHORIZATION` and `FINANCIAL_CREDIT_AUTHORIZATION` is only available to
100
+ # users with credit decisioning via ASA enabled.
101
+ #
102
+ # @return [Symbol, Lithic::Models::AsaRequestWebhookEvent::Status]
103
+ required :status, enum: -> { Lithic::AsaRequestWebhookEvent::Status }
104
+
105
+ # @!attribute transaction_initiator
106
+ # The entity that initiated the transaction.
107
+ #
108
+ # @return [Symbol, Lithic::Models::AsaRequestWebhookEvent::TransactionInitiator]
109
+ required :transaction_initiator, enum: -> { Lithic::AsaRequestWebhookEvent::TransactionInitiator }
110
+
111
+ # @!attribute account_type
112
+ #
113
+ # @return [Symbol, Lithic::Models::AsaRequestWebhookEvent::AccountType, nil]
114
+ optional :account_type, enum: -> { Lithic::AsaRequestWebhookEvent::AccountType }
115
+
116
+ # @!attribute cardholder_authentication
117
+ #
118
+ # @return [Lithic::Models::CardholderAuthentication, nil]
119
+ optional :cardholder_authentication, -> { Lithic::CardholderAuthentication }
120
+
121
+ # @!attribute cashback
122
+ # Deprecated, use `cash_amount`.
123
+ #
124
+ # @return [Integer, nil]
125
+ optional :cashback, Integer
126
+
127
+ # @!attribute conversion_rate
128
+ # If the transaction was requested in a currency other than the settlement
129
+ # currency, this field will be populated to indicate the rate used to translate
130
+ # the merchant_amount to the amount (i.e., `merchant_amount` x `conversion_rate` =
131
+ # `amount`). Note that the `merchant_amount` is in the local currency and the
132
+ # amount is in the settlement currency.
133
+ #
134
+ # @return [Float, nil]
135
+ optional :conversion_rate, Float
136
+
137
+ # @!attribute event_token
138
+ # The event token associated with the authorization. This field is only set for
139
+ # programs enrolled into the beta.
140
+ #
141
+ # @return [String, nil]
142
+ optional :event_token, String
143
+
144
+ # @!attribute fleet_info
145
+ # Optional Object containing information if the Card is a part of a Fleet managed
146
+ # program
147
+ #
148
+ # @return [Lithic::Models::AsaRequestWebhookEvent::FleetInfo, nil]
149
+ optional :fleet_info, -> { Lithic::AsaRequestWebhookEvent::FleetInfo }, nil?: true
150
+
151
+ # @!attribute latest_challenge
152
+ # The latest Authorization Challenge that was issued to the cardholder for this
153
+ # merchant.
154
+ #
155
+ # @return [Lithic::Models::AsaRequestWebhookEvent::LatestChallenge, nil]
156
+ optional :latest_challenge, -> { Lithic::AsaRequestWebhookEvent::LatestChallenge }
157
+
158
+ # @!attribute network
159
+ # Card network of the authorization.
160
+ #
161
+ # @return [Symbol, Lithic::Models::AsaRequestWebhookEvent::Network, nil]
162
+ optional :network, enum: -> { Lithic::AsaRequestWebhookEvent::Network }
163
+
164
+ # @!attribute network_risk_score
165
+ # Network-provided score assessing risk level associated with a given
166
+ # authorization. Scores are on a range of 0-999, with 0 representing the lowest
167
+ # risk and 999 representing the highest risk. For Visa transactions, where the raw
168
+ # score has a range of 0-99, Lithic will normalize the score by multiplying the
169
+ # raw score by 10x.
170
+ #
171
+ # @return [Integer, nil]
172
+ optional :network_risk_score, Integer, nil?: true
173
+
174
+ # @!attribute network_specific_data
175
+ # Contains raw data provided by the card network, including attributes that
176
+ # provide further context about the authorization. If populated by the network,
177
+ # data is organized by Lithic and passed through without further modification.
178
+ # Please consult the official network documentation for more details about these
179
+ # values and how to use them. This object is only available to certain programs-
180
+ # contact your Customer Success Manager to discuss enabling access.
181
+ #
182
+ # @return [Lithic::Models::AsaRequestWebhookEvent::NetworkSpecificData, nil]
183
+ optional :network_specific_data, -> { Lithic::AsaRequestWebhookEvent::NetworkSpecificData }, nil?: true
184
+
185
+ # @!attribute pos
186
+ #
187
+ # @return [Lithic::Models::AsaRequestWebhookEvent::Pos, nil]
188
+ optional :pos, -> { Lithic::AsaRequestWebhookEvent::Pos }
189
+
190
+ # @!attribute token_info
191
+ #
192
+ # @return [Lithic::Models::TokenInfo, nil]
193
+ optional :token_info, -> { Lithic::TokenInfo }, nil?: true
194
+
195
+ # @!attribute ttl
196
+ # Deprecated: approximate time-to-live for the authorization.
197
+ #
198
+ # @return [Time, nil]
199
+ optional :ttl, Time
200
+
201
+ # @!method initialize(token:, acquirer_fee:, amount:, authorization_amount:, avs:, card:, cardholder_currency:, cash_amount:, created:, merchant:, merchant_amount:, merchant_currency:, settled_amount:, status:, transaction_initiator:, account_type: nil, cardholder_authentication: nil, cashback: nil, conversion_rate: nil, event_token: nil, fleet_info: nil, latest_challenge: nil, network: nil, network_risk_score: nil, network_specific_data: nil, pos: nil, token_info: nil, ttl: nil)
202
+ # Some parameter documentations has been truncated, see
203
+ # {Lithic::Models::AsaRequestWebhookEvent} for more details.
204
+ #
205
+ # The Auth Stream Access request payload that was sent to the ASA responder.
206
+ #
207
+ # @param token [String] The provisional transaction group uuid associated with the authorization
208
+ #
209
+ # @param acquirer_fee [Integer] Fee (in cents) assessed by the merchant and paid for by the cardholder. Will be
210
+ #
211
+ # @param amount [Integer] Authorization amount of the transaction (in cents), including any acquirer fees.
212
+ #
213
+ # @param authorization_amount [Integer] The base transaction amount (in cents) plus the acquirer fee field. This is the
214
+ #
215
+ # @param avs [Lithic::Models::AsaRequestWebhookEvent::Avs]
216
+ #
217
+ # @param card [Lithic::Models::AsaRequestWebhookEvent::Card] Card object in ASA
218
+ #
219
+ # @param cardholder_currency [String] 3-character alphabetic ISO 4217 code for cardholder's billing currency.
220
+ #
221
+ # @param cash_amount [Integer] The portion of the transaction requested as cash back by the cardholder, and doe
222
+ #
223
+ # @param created [Time] Date and time when the transaction first occurred in UTC.
224
+ #
225
+ # @param merchant [Lithic::Models::Merchant]
226
+ #
227
+ # @param merchant_amount [Integer] The amount that the merchant will receive, denominated in `merchant_currency` an
228
+ #
229
+ # @param merchant_currency [String] 3-character alphabetic ISO 4217 code for the local currency of the transaction.
230
+ #
231
+ # @param settled_amount [Integer] Amount (in cents) of the transaction that has been settled, including any acquir
232
+ #
233
+ # @param status [Symbol, Lithic::Models::AsaRequestWebhookEvent::Status] The type of authorization request that this request is for. Note that `CREDIT_AU
234
+ #
235
+ # @param transaction_initiator [Symbol, Lithic::Models::AsaRequestWebhookEvent::TransactionInitiator] The entity that initiated the transaction.
236
+ #
237
+ # @param account_type [Symbol, Lithic::Models::AsaRequestWebhookEvent::AccountType]
238
+ #
239
+ # @param cardholder_authentication [Lithic::Models::CardholderAuthentication]
240
+ #
241
+ # @param cashback [Integer] Deprecated, use `cash_amount`.
242
+ #
243
+ # @param conversion_rate [Float] If the transaction was requested in a currency other than the settlement currenc
244
+ #
245
+ # @param event_token [String] The event token associated with the authorization. This field is only set for pr
246
+ #
247
+ # @param fleet_info [Lithic::Models::AsaRequestWebhookEvent::FleetInfo, nil] Optional Object containing information if the Card is a part of a Fleet managed
248
+ #
249
+ # @param latest_challenge [Lithic::Models::AsaRequestWebhookEvent::LatestChallenge] The latest Authorization Challenge that was issued to the cardholder for this me
250
+ #
251
+ # @param network [Symbol, Lithic::Models::AsaRequestWebhookEvent::Network] Card network of the authorization.
252
+ #
253
+ # @param network_risk_score [Integer, nil] Network-provided score assessing risk level associated with a given authorizatio
254
+ #
255
+ # @param network_specific_data [Lithic::Models::AsaRequestWebhookEvent::NetworkSpecificData, nil] Contains raw data provided by the card network, including attributes that provid
256
+ #
257
+ # @param pos [Lithic::Models::AsaRequestWebhookEvent::Pos]
258
+ #
259
+ # @param token_info [Lithic::Models::TokenInfo, nil]
260
+ #
261
+ # @param ttl [Time] Deprecated: approximate time-to-live for the authorization.
262
+
263
+ # @see Lithic::Models::AsaRequestWebhookEvent#avs
264
+ class Avs < Lithic::Internal::Type::BaseModel
265
+ # @!attribute address
266
+ # Cardholder address
267
+ #
268
+ # @return [String]
269
+ required :address, String
270
+
271
+ # @!attribute address_on_file_match
272
+ # Lithic's evaluation result comparing the transaction's address data with the
273
+ # cardholder KYC data if it exists. In the event Lithic does not have any
274
+ # Cardholder KYC data, or the transaction does not contain any address data,
275
+ # NOT_PRESENT will be returned
276
+ #
277
+ # @return [Symbol, Lithic::Models::AsaRequestWebhookEvent::Avs::AddressOnFileMatch]
278
+ required :address_on_file_match, enum: -> { Lithic::AsaRequestWebhookEvent::Avs::AddressOnFileMatch }
279
+
280
+ # @!attribute zipcode
281
+ # Cardholder ZIP code
282
+ #
283
+ # @return [String]
284
+ required :zipcode, String
285
+
286
+ # @!method initialize(address:, address_on_file_match:, zipcode:)
287
+ # Some parameter documentations has been truncated, see
288
+ # {Lithic::Models::AsaRequestWebhookEvent::Avs} for more details.
289
+ #
290
+ # @param address [String] Cardholder address
291
+ #
292
+ # @param address_on_file_match [Symbol, Lithic::Models::AsaRequestWebhookEvent::Avs::AddressOnFileMatch] Lithic's evaluation result comparing the transaction's address data with the car
293
+ #
294
+ # @param zipcode [String] Cardholder ZIP code
295
+
296
+ # Lithic's evaluation result comparing the transaction's address data with the
297
+ # cardholder KYC data if it exists. In the event Lithic does not have any
298
+ # Cardholder KYC data, or the transaction does not contain any address data,
299
+ # NOT_PRESENT will be returned
300
+ #
301
+ # @see Lithic::Models::AsaRequestWebhookEvent::Avs#address_on_file_match
302
+ module AddressOnFileMatch
303
+ extend Lithic::Internal::Type::Enum
304
+
305
+ MATCH = :MATCH
306
+ MATCH_ADDRESS_ONLY = :MATCH_ADDRESS_ONLY
307
+ MATCH_ZIP_ONLY = :MATCH_ZIP_ONLY
308
+ MISMATCH = :MISMATCH
309
+ NOT_PRESENT = :NOT_PRESENT
310
+
311
+ # @!method self.values
312
+ # @return [Array<Symbol>]
313
+ end
314
+ end
315
+
316
+ # @see Lithic::Models::AsaRequestWebhookEvent#card
317
+ class Card < Lithic::Internal::Type::BaseModel
318
+ # @!attribute token
319
+ # Globally unique identifier for the card.
320
+ #
321
+ # @return [String, nil]
322
+ optional :token, String
323
+
324
+ # @!attribute hostname
325
+ # Hostname of card’s locked merchant (will be empty if not applicable)
326
+ #
327
+ # @return [String, nil]
328
+ optional :hostname, String
329
+
330
+ # @!attribute last_four
331
+ # Last four digits of the card number
332
+ #
333
+ # @return [String, nil]
334
+ optional :last_four, String
335
+
336
+ # @!attribute memo
337
+ # Customizable name to identify the card. We recommend against using this field to
338
+ # store JSON data as it can cause unexpected behavior.
339
+ #
340
+ # @return [String, nil]
341
+ optional :memo, String
342
+
343
+ # @!attribute spend_limit
344
+ # Amount (in cents) to limit approved authorizations. Purchase requests above the
345
+ # spend limit will be declined (refunds and credits will be approved).
346
+ #
347
+ # Note that while spend limits are enforced based on authorized and settled volume
348
+ # on a card, they are not recommended to be used for balance or
349
+ # reconciliation-level accuracy. Spend limits also cannot block force posted
350
+ # charges (i.e., when a merchant sends a clearing message without a prior
351
+ # authorization).
352
+ #
353
+ # @return [Integer, nil]
354
+ optional :spend_limit, Integer
355
+
356
+ # @!attribute spend_limit_duration
357
+ # Note that to support recurring monthly payments, which can occur on different
358
+ # day every month, the time window we consider for MONTHLY velocity starts 6 days
359
+ # after the current calendar date one month prior.
360
+ #
361
+ # @return [Symbol, Lithic::Models::AsaRequestWebhookEvent::Card::SpendLimitDuration, nil]
362
+ optional :spend_limit_duration, enum: -> { Lithic::AsaRequestWebhookEvent::Card::SpendLimitDuration }
363
+
364
+ # @!attribute state
365
+ #
366
+ # @return [Symbol, Lithic::Models::AsaRequestWebhookEvent::Card::State, nil]
367
+ optional :state, enum: -> { Lithic::AsaRequestWebhookEvent::Card::State }
368
+
369
+ # @!attribute type
370
+ #
371
+ # @return [Symbol, Lithic::Models::AsaRequestWebhookEvent::Card::Type, nil]
372
+ optional :type, enum: -> { Lithic::AsaRequestWebhookEvent::Card::Type }
373
+
374
+ # @!method initialize(token: nil, hostname: nil, last_four: nil, memo: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, type: nil)
375
+ # Some parameter documentations has been truncated, see
376
+ # {Lithic::Models::AsaRequestWebhookEvent::Card} for more details.
377
+ #
378
+ # Card object in ASA
379
+ #
380
+ # @param token [String] Globally unique identifier for the card.
381
+ #
382
+ # @param hostname [String] Hostname of card’s locked merchant (will be empty if not applicable)
383
+ #
384
+ # @param last_four [String] Last four digits of the card number
385
+ #
386
+ # @param memo [String] Customizable name to identify the card. We recommend against using this field to
387
+ #
388
+ # @param spend_limit [Integer] Amount (in cents) to limit approved authorizations. Purchase requests above the
389
+ #
390
+ # @param spend_limit_duration [Symbol, Lithic::Models::AsaRequestWebhookEvent::Card::SpendLimitDuration] Note that to support recurring monthly payments, which can occur on different da
391
+ #
392
+ # @param state [Symbol, Lithic::Models::AsaRequestWebhookEvent::Card::State]
393
+ #
394
+ # @param type [Symbol, Lithic::Models::AsaRequestWebhookEvent::Card::Type]
395
+
396
+ # Note that to support recurring monthly payments, which can occur on different
397
+ # day every month, the time window we consider for MONTHLY velocity starts 6 days
398
+ # after the current calendar date one month prior.
399
+ #
400
+ # @see Lithic::Models::AsaRequestWebhookEvent::Card#spend_limit_duration
401
+ module SpendLimitDuration
402
+ extend Lithic::Internal::Type::Enum
403
+
404
+ ANNUALLY = :ANNUALLY
405
+ FOREVER = :FOREVER
406
+ MONTHLY = :MONTHLY
407
+ TRANSACTION = :TRANSACTION
408
+
409
+ # @!method self.values
410
+ # @return [Array<Symbol>]
411
+ end
412
+
413
+ # @see Lithic::Models::AsaRequestWebhookEvent::Card#state
414
+ module State
415
+ extend Lithic::Internal::Type::Enum
416
+
417
+ CLOSED = :CLOSED
418
+ OPEN = :OPEN
419
+ PAUSED = :PAUSED
420
+ PENDING_ACTIVATION = :PENDING_ACTIVATION
421
+ PENDING_FULFILLMENT = :PENDING_FULFILLMENT
422
+
423
+ # @!method self.values
424
+ # @return [Array<Symbol>]
425
+ end
426
+
427
+ # @see Lithic::Models::AsaRequestWebhookEvent::Card#type
428
+ module Type
429
+ extend Lithic::Internal::Type::Enum
430
+
431
+ SINGLE_USE = :SINGLE_USE
432
+ MERCHANT_LOCKED = :MERCHANT_LOCKED
433
+ UNLOCKED = :UNLOCKED
434
+ PHYSICAL = :PHYSICAL
435
+ DIGITAL_WALLET = :DIGITAL_WALLET
436
+ VIRTUAL = :VIRTUAL
437
+
438
+ # @!method self.values
439
+ # @return [Array<Symbol>]
440
+ end
441
+ end
442
+
443
+ # The type of authorization request that this request is for. Note that
444
+ # `CREDIT_AUTHORIZATION` and `FINANCIAL_CREDIT_AUTHORIZATION` is only available to
445
+ # users with credit decisioning via ASA enabled.
446
+ #
447
+ # @see Lithic::Models::AsaRequestWebhookEvent#status
448
+ module Status
449
+ extend Lithic::Internal::Type::Enum
450
+
451
+ AUTHORIZATION = :AUTHORIZATION
452
+ CREDIT_AUTHORIZATION = :CREDIT_AUTHORIZATION
453
+ FINANCIAL_AUTHORIZATION = :FINANCIAL_AUTHORIZATION
454
+ FINANCIAL_CREDIT_AUTHORIZATION = :FINANCIAL_CREDIT_AUTHORIZATION
455
+ BALANCE_INQUIRY = :BALANCE_INQUIRY
456
+
457
+ # @!method self.values
458
+ # @return [Array<Symbol>]
459
+ end
460
+
461
+ # The entity that initiated the transaction.
462
+ #
463
+ # @see Lithic::Models::AsaRequestWebhookEvent#transaction_initiator
464
+ module TransactionInitiator
465
+ extend Lithic::Internal::Type::Enum
466
+
467
+ CARDHOLDER = :CARDHOLDER
468
+ MERCHANT = :MERCHANT
469
+ UNKNOWN = :UNKNOWN
470
+
471
+ # @!method self.values
472
+ # @return [Array<Symbol>]
473
+ end
474
+
475
+ # @see Lithic::Models::AsaRequestWebhookEvent#account_type
476
+ module AccountType
477
+ extend Lithic::Internal::Type::Enum
478
+
479
+ CHECKING = :CHECKING
480
+ SAVINGS = :SAVINGS
481
+
482
+ # @!method self.values
483
+ # @return [Array<Symbol>]
484
+ end
485
+
486
+ # @see Lithic::Models::AsaRequestWebhookEvent#fleet_info
487
+ class FleetInfo < Lithic::Internal::Type::BaseModel
488
+ # @!attribute fleet_prompt_code
489
+ # Code indicating what the driver was prompted to enter at time of purchase. This
490
+ # is configured at a program level and is a static configuration, and does not
491
+ # change on a request to request basis
492
+ #
493
+ # @return [Symbol, Lithic::Models::AsaRequestWebhookEvent::FleetInfo::FleetPromptCode]
494
+ required :fleet_prompt_code, enum: -> { Lithic::AsaRequestWebhookEvent::FleetInfo::FleetPromptCode }
495
+
496
+ # @!attribute fleet_restriction_code
497
+ # Code indicating which restrictions, if any, there are on purchase. This is
498
+ # configured at a program level and is a static configuration, and does not change
499
+ # on a request to request basis
500
+ #
501
+ # @return [Symbol, Lithic::Models::AsaRequestWebhookEvent::FleetInfo::FleetRestrictionCode]
502
+ required :fleet_restriction_code,
503
+ enum: -> { Lithic::AsaRequestWebhookEvent::FleetInfo::FleetRestrictionCode }
504
+
505
+ # @!attribute driver_number
506
+ # Number representing the driver
507
+ #
508
+ # @return [String, nil]
509
+ optional :driver_number, String, nil?: true
510
+
511
+ # @!attribute vehicle_number
512
+ # Number associated with the vehicle
513
+ #
514
+ # @return [String, nil]
515
+ optional :vehicle_number, String, nil?: true
516
+
517
+ # @!method initialize(fleet_prompt_code:, fleet_restriction_code:, driver_number: nil, vehicle_number: nil)
518
+ # Some parameter documentations has been truncated, see
519
+ # {Lithic::Models::AsaRequestWebhookEvent::FleetInfo} for more details.
520
+ #
521
+ # Optional Object containing information if the Card is a part of a Fleet managed
522
+ # program
523
+ #
524
+ # @param fleet_prompt_code [Symbol, Lithic::Models::AsaRequestWebhookEvent::FleetInfo::FleetPromptCode] Code indicating what the driver was prompted to enter at time of purchase. This
525
+ #
526
+ # @param fleet_restriction_code [Symbol, Lithic::Models::AsaRequestWebhookEvent::FleetInfo::FleetRestrictionCode] Code indicating which restrictions, if any, there are on purchase. This is confi
527
+ #
528
+ # @param driver_number [String, nil] Number representing the driver
529
+ #
530
+ # @param vehicle_number [String, nil] Number associated with the vehicle
531
+
532
+ # Code indicating what the driver was prompted to enter at time of purchase. This
533
+ # is configured at a program level and is a static configuration, and does not
534
+ # change on a request to request basis
535
+ #
536
+ # @see Lithic::Models::AsaRequestWebhookEvent::FleetInfo#fleet_prompt_code
537
+ module FleetPromptCode
538
+ extend Lithic::Internal::Type::Enum
539
+
540
+ NO_PROMPT = :NO_PROMPT
541
+ VEHICLE_NUMBER = :VEHICLE_NUMBER
542
+ DRIVER_NUMBER = :DRIVER_NUMBER
543
+
544
+ # @!method self.values
545
+ # @return [Array<Symbol>]
546
+ end
547
+
548
+ # Code indicating which restrictions, if any, there are on purchase. This is
549
+ # configured at a program level and is a static configuration, and does not change
550
+ # on a request to request basis
551
+ #
552
+ # @see Lithic::Models::AsaRequestWebhookEvent::FleetInfo#fleet_restriction_code
553
+ module FleetRestrictionCode
554
+ extend Lithic::Internal::Type::Enum
555
+
556
+ NO_RESTRICTIONS = :NO_RESTRICTIONS
557
+ FUEL_ONLY = :FUEL_ONLY
558
+
559
+ # @!method self.values
560
+ # @return [Array<Symbol>]
561
+ end
562
+ end
563
+
564
+ # @see Lithic::Models::AsaRequestWebhookEvent#latest_challenge
565
+ class LatestChallenge < Lithic::Internal::Type::BaseModel
566
+ # @!attribute phone_number
567
+ # The phone number used for sending Authorization Challenge SMS.
568
+ #
569
+ # @return [String]
570
+ required :phone_number, String
571
+
572
+ # @!attribute status
573
+ # The status of the Authorization Challenge
574
+ #
575
+ # - `COMPLETED` - Challenge was successfully completed by the cardholder
576
+ # - `PENDING` - Challenge is still open
577
+ # - `EXPIRED` - Challenge has expired without being completed
578
+ # - `ERROR` - There was an error processing the challenge
579
+ #
580
+ # @return [Symbol, Lithic::Models::AsaRequestWebhookEvent::LatestChallenge::Status]
581
+ required :status, enum: -> { Lithic::AsaRequestWebhookEvent::LatestChallenge::Status }
582
+
583
+ # @!attribute completed_at
584
+ # The date and time when the Authorization Challenge was completed in UTC. Present
585
+ # only if the status is `COMPLETED`.
586
+ #
587
+ # @return [Time, nil]
588
+ optional :completed_at, Time
589
+
590
+ # @!method initialize(phone_number:, status:, completed_at: nil)
591
+ # Some parameter documentations has been truncated, see
592
+ # {Lithic::Models::AsaRequestWebhookEvent::LatestChallenge} for more details.
593
+ #
594
+ # The latest Authorization Challenge that was issued to the cardholder for this
595
+ # merchant.
596
+ #
597
+ # @param phone_number [String] The phone number used for sending Authorization Challenge SMS.
598
+ #
599
+ # @param status [Symbol, Lithic::Models::AsaRequestWebhookEvent::LatestChallenge::Status] The status of the Authorization Challenge
600
+ #
601
+ # @param completed_at [Time] The date and time when the Authorization Challenge was completed in UTC. Present
602
+
603
+ # The status of the Authorization Challenge
604
+ #
605
+ # - `COMPLETED` - Challenge was successfully completed by the cardholder
606
+ # - `PENDING` - Challenge is still open
607
+ # - `EXPIRED` - Challenge has expired without being completed
608
+ # - `ERROR` - There was an error processing the challenge
609
+ #
610
+ # @see Lithic::Models::AsaRequestWebhookEvent::LatestChallenge#status
611
+ module Status
612
+ extend Lithic::Internal::Type::Enum
613
+
614
+ COMPLETED = :COMPLETED
615
+ PENDING = :PENDING
616
+ EXPIRED = :EXPIRED
617
+ ERROR = :ERROR
618
+
619
+ # @!method self.values
620
+ # @return [Array<Symbol>]
621
+ end
622
+ end
623
+
624
+ # Card network of the authorization.
625
+ #
626
+ # @see Lithic::Models::AsaRequestWebhookEvent#network
627
+ module Network
628
+ extend Lithic::Internal::Type::Enum
629
+
630
+ AMEX = :AMEX
631
+ INTERLINK = :INTERLINK
632
+ MAESTRO = :MAESTRO
633
+ MASTERCARD = :MASTERCARD
634
+ UNKNOWN = :UNKNOWN
635
+ VISA = :VISA
636
+
637
+ # @!method self.values
638
+ # @return [Array<Symbol>]
639
+ end
640
+
641
+ # @see Lithic::Models::AsaRequestWebhookEvent#network_specific_data
642
+ class NetworkSpecificData < Lithic::Internal::Type::BaseModel
643
+ # @!attribute mastercard
644
+ #
645
+ # @return [Lithic::Models::AsaRequestWebhookEvent::NetworkSpecificData::Mastercard, nil]
646
+ optional :mastercard,
647
+ -> {
648
+ Lithic::AsaRequestWebhookEvent::NetworkSpecificData::Mastercard
649
+ },
650
+ nil?: true
651
+
652
+ # @!attribute visa
653
+ #
654
+ # @return [Lithic::Models::AsaRequestWebhookEvent::NetworkSpecificData::Visa, nil]
655
+ optional :visa, -> { Lithic::AsaRequestWebhookEvent::NetworkSpecificData::Visa }, nil?: true
656
+
657
+ # @!method initialize(mastercard: nil, visa: nil)
658
+ # Contains raw data provided by the card network, including attributes that
659
+ # provide further context about the authorization. If populated by the network,
660
+ # data is organized by Lithic and passed through without further modification.
661
+ # Please consult the official network documentation for more details about these
662
+ # values and how to use them. This object is only available to certain programs-
663
+ # contact your Customer Success Manager to discuss enabling access.
664
+ #
665
+ # @param mastercard [Lithic::Models::AsaRequestWebhookEvent::NetworkSpecificData::Mastercard, nil]
666
+ # @param visa [Lithic::Models::AsaRequestWebhookEvent::NetworkSpecificData::Visa, nil]
667
+
668
+ # @see Lithic::Models::AsaRequestWebhookEvent::NetworkSpecificData#mastercard
669
+ class Mastercard < Lithic::Internal::Type::BaseModel
670
+ # @!attribute ecommerce_security_level_indicator
671
+ # Indicates the electronic commerce security level and UCAF collection.
672
+ #
673
+ # @return [String, nil]
674
+ optional :ecommerce_security_level_indicator, String, nil?: true
675
+
676
+ # @!attribute on_behalf_service_result
677
+ # The On-behalf Service performed on the transaction and the results. Contains all
678
+ # applicable, on-behalf service results that were performed on a given
679
+ # transaction.
680
+ #
681
+ # @return [Array<Lithic::Models::AsaRequestWebhookEvent::NetworkSpecificData::Mastercard::OnBehalfServiceResult>, nil]
682
+ optional :on_behalf_service_result,
683
+ -> {
684
+ Lithic::Internal::Type::ArrayOf[Lithic::AsaRequestWebhookEvent::NetworkSpecificData::Mastercard::OnBehalfServiceResult]
685
+ },
686
+ nil?: true
687
+
688
+ # @!attribute transaction_type_identifier
689
+ # Indicates the type of additional transaction purpose.
690
+ #
691
+ # @return [String, nil]
692
+ optional :transaction_type_identifier, String, nil?: true
693
+
694
+ # @!method initialize(ecommerce_security_level_indicator: nil, on_behalf_service_result: nil, transaction_type_identifier: nil)
695
+ # Some parameter documentations has been truncated, see
696
+ # {Lithic::Models::AsaRequestWebhookEvent::NetworkSpecificData::Mastercard} for
697
+ # more details.
698
+ #
699
+ # @param ecommerce_security_level_indicator [String, nil] Indicates the electronic commerce security level and UCAF collection.
700
+ #
701
+ # @param on_behalf_service_result [Array<Lithic::Models::AsaRequestWebhookEvent::NetworkSpecificData::Mastercard::OnBehalfServiceResult>, nil] The On-behalf Service performed on the transaction and the results. Contains all
702
+ #
703
+ # @param transaction_type_identifier [String, nil] Indicates the type of additional transaction purpose.
704
+
705
+ class OnBehalfServiceResult < Lithic::Internal::Type::BaseModel
706
+ # @!attribute result_1
707
+ # Indicates the results of the service processing.
708
+ #
709
+ # @return [String]
710
+ required :result_1, String
711
+
712
+ # @!attribute result_2
713
+ # Identifies the results of the service processing.
714
+ #
715
+ # @return [String]
716
+ required :result_2, String
717
+
718
+ # @!attribute service
719
+ # Indicates the service performed on the transaction.
720
+ #
721
+ # @return [String]
722
+ required :service, String
723
+
724
+ # @!method initialize(result_1:, result_2:, service:)
725
+ # @param result_1 [String] Indicates the results of the service processing.
726
+ #
727
+ # @param result_2 [String] Identifies the results of the service processing.
728
+ #
729
+ # @param service [String] Indicates the service performed on the transaction.
730
+ end
731
+ end
732
+
733
+ # @see Lithic::Models::AsaRequestWebhookEvent::NetworkSpecificData#visa
734
+ class Visa < Lithic::Internal::Type::BaseModel
735
+ # @!attribute business_application_identifier
736
+ # Identifies the purpose or category of a transaction, used to classify and
737
+ # process transactions according to Visa’s rules.
738
+ #
739
+ # @return [String, nil]
740
+ optional :business_application_identifier, String, nil?: true
741
+
742
+ # @!method initialize(business_application_identifier: nil)
743
+ # Some parameter documentations has been truncated, see
744
+ # {Lithic::Models::AsaRequestWebhookEvent::NetworkSpecificData::Visa} for more
745
+ # details.
746
+ #
747
+ # @param business_application_identifier [String, nil] Identifies the purpose or category of a transaction, used to classify and proces
748
+ end
749
+ end
750
+
751
+ # @see Lithic::Models::AsaRequestWebhookEvent#pos
752
+ class Pos < Lithic::Internal::Type::BaseModel
753
+ # @!attribute entry_mode
754
+ # POS > Entry Mode object in ASA
755
+ #
756
+ # @return [Lithic::Models::AsaRequestWebhookEvent::Pos::EntryMode, nil]
757
+ optional :entry_mode, -> { Lithic::AsaRequestWebhookEvent::Pos::EntryMode }
758
+
759
+ # @!attribute terminal
760
+ #
761
+ # @return [Lithic::Models::AsaRequestWebhookEvent::Pos::Terminal, nil]
762
+ optional :terminal, -> { Lithic::AsaRequestWebhookEvent::Pos::Terminal }
763
+
764
+ # @!method initialize(entry_mode: nil, terminal: nil)
765
+ # @param entry_mode [Lithic::Models::AsaRequestWebhookEvent::Pos::EntryMode] POS > Entry Mode object in ASA
766
+ #
767
+ # @param terminal [Lithic::Models::AsaRequestWebhookEvent::Pos::Terminal]
768
+
769
+ # @see Lithic::Models::AsaRequestWebhookEvent::Pos#entry_mode
770
+ class EntryMode < Lithic::Internal::Type::BaseModel
771
+ # @!attribute card
772
+ # Card Presence Indicator
773
+ #
774
+ # @return [Symbol, Lithic::Models::AsaRequestWebhookEvent::Pos::EntryMode::Card, nil]
775
+ optional :card, enum: -> { Lithic::AsaRequestWebhookEvent::Pos::EntryMode::Card }
776
+
777
+ # @!attribute cardholder
778
+ # Cardholder Presence Indicator
779
+ #
780
+ # @return [Symbol, Lithic::Models::AsaRequestWebhookEvent::Pos::EntryMode::Cardholder, nil]
781
+ optional :cardholder, enum: -> { Lithic::AsaRequestWebhookEvent::Pos::EntryMode::Cardholder }
782
+
783
+ # @!attribute pan
784
+ # Method of entry for the PAN
785
+ #
786
+ # @return [Symbol, Lithic::Models::AsaRequestWebhookEvent::Pos::EntryMode::Pan, nil]
787
+ optional :pan, enum: -> { Lithic::AsaRequestWebhookEvent::Pos::EntryMode::Pan }
788
+
789
+ # @!attribute pin_entered
790
+ # Indicates whether the cardholder entered the PIN. True if the PIN was entered.
791
+ #
792
+ # @return [Boolean, nil]
793
+ optional :pin_entered, Lithic::Internal::Type::Boolean
794
+
795
+ # @!method initialize(card: nil, cardholder: nil, pan: nil, pin_entered: nil)
796
+ # POS > Entry Mode object in ASA
797
+ #
798
+ # @param card [Symbol, Lithic::Models::AsaRequestWebhookEvent::Pos::EntryMode::Card] Card Presence Indicator
799
+ #
800
+ # @param cardholder [Symbol, Lithic::Models::AsaRequestWebhookEvent::Pos::EntryMode::Cardholder] Cardholder Presence Indicator
801
+ #
802
+ # @param pan [Symbol, Lithic::Models::AsaRequestWebhookEvent::Pos::EntryMode::Pan] Method of entry for the PAN
803
+ #
804
+ # @param pin_entered [Boolean] Indicates whether the cardholder entered the PIN. True if the PIN was entered.
805
+
806
+ # Card Presence Indicator
807
+ #
808
+ # @see Lithic::Models::AsaRequestWebhookEvent::Pos::EntryMode#card
809
+ module Card
810
+ extend Lithic::Internal::Type::Enum
811
+
812
+ PRESENT = :PRESENT
813
+ NOT_PRESENT = :NOT_PRESENT
814
+ UNKNOWN = :UNKNOWN
815
+
816
+ # @!method self.values
817
+ # @return [Array<Symbol>]
818
+ end
819
+
820
+ # Cardholder Presence Indicator
821
+ #
822
+ # @see Lithic::Models::AsaRequestWebhookEvent::Pos::EntryMode#cardholder
823
+ module Cardholder
824
+ extend Lithic::Internal::Type::Enum
825
+
826
+ DEFERRED_BILLING = :DEFERRED_BILLING
827
+ ELECTRONIC_ORDER = :ELECTRONIC_ORDER
828
+ INSTALLMENT = :INSTALLMENT
829
+ MAIL_ORDER = :MAIL_ORDER
830
+ NOT_PRESENT = :NOT_PRESENT
831
+ PRESENT = :PRESENT
832
+ REOCCURRING = :REOCCURRING
833
+ TELEPHONE_ORDER = :TELEPHONE_ORDER
834
+ UNKNOWN = :UNKNOWN
835
+
836
+ # @!method self.values
837
+ # @return [Array<Symbol>]
838
+ end
839
+
840
+ # Method of entry for the PAN
841
+ #
842
+ # @see Lithic::Models::AsaRequestWebhookEvent::Pos::EntryMode#pan
843
+ module Pan
844
+ extend Lithic::Internal::Type::Enum
845
+
846
+ AUTO_ENTRY = :AUTO_ENTRY
847
+ BAR_CODE = :BAR_CODE
848
+ CONTACTLESS = :CONTACTLESS
849
+ ECOMMERCE = :ECOMMERCE
850
+ ERROR_KEYED = :ERROR_KEYED
851
+ ERROR_MAGNETIC_STRIPE = :ERROR_MAGNETIC_STRIPE
852
+ ICC = :ICC
853
+ KEY_ENTERED = :KEY_ENTERED
854
+ MAGNETIC_STRIPE = :MAGNETIC_STRIPE
855
+ MANUAL = :MANUAL
856
+ OCR = :OCR
857
+ SECURE_CARDLESS = :SECURE_CARDLESS
858
+ UNSPECIFIED = :UNSPECIFIED
859
+ UNKNOWN = :UNKNOWN
860
+ CREDENTIAL_ON_FILE = :CREDENTIAL_ON_FILE
861
+
862
+ # @!method self.values
863
+ # @return [Array<Symbol>]
864
+ end
865
+ end
866
+
867
+ # @see Lithic::Models::AsaRequestWebhookEvent::Pos#terminal
868
+ class Terminal < Lithic::Internal::Type::BaseModel
869
+ # @!attribute attended
870
+ # True if a clerk is present at the sale.
871
+ #
872
+ # @return [Boolean]
873
+ required :attended, Lithic::Internal::Type::Boolean
874
+
875
+ # @!attribute card_retention_capable
876
+ # True if the terminal is capable of retaining the card.
877
+ #
878
+ # @return [Boolean]
879
+ required :card_retention_capable, Lithic::Internal::Type::Boolean
880
+
881
+ # @!attribute on_premise
882
+ # True if the sale was made at the place of business (vs. mobile).
883
+ #
884
+ # @return [Boolean]
885
+ required :on_premise, Lithic::Internal::Type::Boolean
886
+
887
+ # @!attribute operator
888
+ # The person that is designated to swipe the card
889
+ #
890
+ # @return [Symbol, Lithic::Models::AsaRequestWebhookEvent::Pos::Terminal::Operator]
891
+ required :operator, enum: -> { Lithic::AsaRequestWebhookEvent::Pos::Terminal::Operator }
892
+
893
+ # @!attribute partial_approval_capable
894
+ # True if the terminal is capable of partial approval. Partial approval is when
895
+ # part of a transaction is approved and another payment must be used for the
896
+ # remainder. Example scenario: A $40 transaction is attempted on a prepaid card
897
+ # with a $25 balance. If partial approval is enabled, $25 can be authorized, at
898
+ # which point the POS will prompt the user for an additional payment of $15.
899
+ #
900
+ # @return [Boolean]
901
+ required :partial_approval_capable, Lithic::Internal::Type::Boolean
902
+
903
+ # @!attribute pin_capability
904
+ # Status of whether the POS is able to accept PINs
905
+ #
906
+ # @return [Symbol, Lithic::Models::AsaRequestWebhookEvent::Pos::Terminal::PinCapability]
907
+ required :pin_capability, enum: -> { Lithic::AsaRequestWebhookEvent::Pos::Terminal::PinCapability }
908
+
909
+ # @!attribute type
910
+ # POS Type
911
+ #
912
+ # @return [Symbol, Lithic::Models::AsaRequestWebhookEvent::Pos::Terminal::Type]
913
+ required :type, enum: -> { Lithic::AsaRequestWebhookEvent::Pos::Terminal::Type }
914
+
915
+ # @!attribute acceptor_terminal_id
916
+ # Uniquely identifies a terminal at the card acceptor location of acquiring
917
+ # institutions or merchant POS Systems. Left justified with trailing spaces.
918
+ #
919
+ # @return [String, nil]
920
+ optional :acceptor_terminal_id, String, nil?: true
921
+
922
+ # @!method initialize(attended:, card_retention_capable:, on_premise:, operator:, partial_approval_capable:, pin_capability:, type:, acceptor_terminal_id: nil)
923
+ # Some parameter documentations has been truncated, see
924
+ # {Lithic::Models::AsaRequestWebhookEvent::Pos::Terminal} for more details.
925
+ #
926
+ # @param attended [Boolean] True if a clerk is present at the sale.
927
+ #
928
+ # @param card_retention_capable [Boolean] True if the terminal is capable of retaining the card.
929
+ #
930
+ # @param on_premise [Boolean] True if the sale was made at the place of business (vs. mobile).
931
+ #
932
+ # @param operator [Symbol, Lithic::Models::AsaRequestWebhookEvent::Pos::Terminal::Operator] The person that is designated to swipe the card
933
+ #
934
+ # @param partial_approval_capable [Boolean] True if the terminal is capable of partial approval. Partial approval is when pa
935
+ #
936
+ # @param pin_capability [Symbol, Lithic::Models::AsaRequestWebhookEvent::Pos::Terminal::PinCapability] Status of whether the POS is able to accept PINs
937
+ #
938
+ # @param type [Symbol, Lithic::Models::AsaRequestWebhookEvent::Pos::Terminal::Type] POS Type
939
+ #
940
+ # @param acceptor_terminal_id [String, nil] Uniquely identifies a terminal at the card acceptor location of acquiring instit
941
+
942
+ # The person that is designated to swipe the card
943
+ #
944
+ # @see Lithic::Models::AsaRequestWebhookEvent::Pos::Terminal#operator
945
+ module Operator
946
+ extend Lithic::Internal::Type::Enum
947
+
948
+ ADMINISTRATIVE = :ADMINISTRATIVE
949
+ CARDHOLDER = :CARDHOLDER
950
+ CARD_ACCEPTOR = :CARD_ACCEPTOR
951
+ UNKNOWN = :UNKNOWN
952
+
953
+ # @!method self.values
954
+ # @return [Array<Symbol>]
955
+ end
956
+
957
+ # Status of whether the POS is able to accept PINs
958
+ #
959
+ # @see Lithic::Models::AsaRequestWebhookEvent::Pos::Terminal#pin_capability
960
+ module PinCapability
961
+ extend Lithic::Internal::Type::Enum
962
+
963
+ CAPABLE = :CAPABLE
964
+ INOPERATIVE = :INOPERATIVE
965
+ NOT_CAPABLE = :NOT_CAPABLE
966
+ UNSPECIFIED = :UNSPECIFIED
967
+
968
+ # @!method self.values
969
+ # @return [Array<Symbol>]
970
+ end
971
+
972
+ # POS Type
973
+ #
974
+ # @see Lithic::Models::AsaRequestWebhookEvent::Pos::Terminal#type
975
+ module Type
976
+ extend Lithic::Internal::Type::Enum
977
+
978
+ ADMINISTRATIVE = :ADMINISTRATIVE
979
+ ATM = :ATM
980
+ AUTHORIZATION = :AUTHORIZATION
981
+ COUPON_MACHINE = :COUPON_MACHINE
982
+ DIAL_TERMINAL = :DIAL_TERMINAL
983
+ ECOMMERCE = :ECOMMERCE
984
+ ECR = :ECR
985
+ FUEL_MACHINE = :FUEL_MACHINE
986
+ HOME_TERMINAL = :HOME_TERMINAL
987
+ MICR = :MICR
988
+ OFF_PREMISE = :OFF_PREMISE
989
+ PAYMENT = :PAYMENT
990
+ PDA = :PDA
991
+ PHONE = :PHONE
992
+ POINT = :POINT
993
+ POS_TERMINAL = :POS_TERMINAL
994
+ PUBLIC_UTILITY = :PUBLIC_UTILITY
995
+ SELF_SERVICE = :SELF_SERVICE
996
+ TELEVISION = :TELEVISION
997
+ TELLER = :TELLER
998
+ TRAVELERS_CHECK_MACHINE = :TRAVELERS_CHECK_MACHINE
999
+ VENDING = :VENDING
1000
+ VOICE = :VOICE
1001
+ UNKNOWN = :UNKNOWN
1002
+
1003
+ # @!method self.values
1004
+ # @return [Array<Symbol>]
1005
+ end
1006
+ end
1007
+ end
1008
+ end
1009
+ end
1010
+ end