lithic 0.13.0 → 0.15.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 (145) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +35 -0
  3. data/README.md +1 -1
  4. data/lib/lithic/client.rb +4 -0
  5. data/lib/lithic/internal/transport/base_client.rb +2 -0
  6. data/lib/lithic/models/account_holder_simulate_enrollment_review_response.rb +4 -4
  7. data/lib/lithic/models/account_retrieve_signals_params.rb +20 -0
  8. data/lib/lithic/models/auth_rules/auth_rule.rb +10 -6
  9. data/lib/lithic/models/auth_rules/auth_rule_condition.rb +2 -2
  10. data/lib/lithic/models/auth_rules/auth_rule_version.rb +5 -3
  11. data/lib/lithic/models/auth_rules/conditional_3ds_action_parameters.rb +8 -6
  12. data/lib/lithic/models/auth_rules/conditional_ach_action_parameters.rb +4 -4
  13. data/lib/lithic/models/auth_rules/conditional_authorization_action_parameters.rb +119 -44
  14. data/lib/lithic/models/auth_rules/conditional_authorization_adjustment_parameters.rb +533 -0
  15. data/lib/lithic/models/auth_rules/conditional_card_transaction_update_action_parameters.rb +18 -14
  16. data/lib/lithic/models/auth_rules/conditional_tokenization_action_parameters.rb +6 -6
  17. data/lib/lithic/models/auth_rules/conditional_value.rb +3 -2
  18. data/lib/lithic/models/auth_rules/v2_create_params.rb +15 -9
  19. data/lib/lithic/models/auth_rules/v2_draft_params.rb +5 -3
  20. data/lib/lithic/models/balance.rb +8 -6
  21. data/lib/lithic/models/card_authorization.rb +1266 -0
  22. data/lib/lithic/models/card_authorization_approval_request_webhook_event.rb +3 -1253
  23. data/lib/lithic/models/card_authorization_challenge_response_params.rb +40 -0
  24. data/lib/lithic/models/card_authorization_challenge_response_webhook_event.rb +1 -0
  25. data/lib/lithic/models/card_authorization_challenge_webhook_event.rb +67 -0
  26. data/lib/lithic/models/card_program.rb +2 -2
  27. data/lib/lithic/models/card_retrieve_signals_params.rb +20 -0
  28. data/lib/lithic/models/event.rb +13 -4
  29. data/lib/lithic/models/event_list_params.rb +7 -2
  30. data/lib/lithic/models/event_subscription.rb +7 -2
  31. data/lib/lithic/models/events/subscription_create_params.rb +7 -2
  32. data/lib/lithic/models/events/subscription_send_simulated_example_params.rb +1 -0
  33. data/lib/lithic/models/events/subscription_update_params.rb +7 -2
  34. data/lib/lithic/models/external_bank_account.rb +1 -1
  35. data/lib/lithic/models/external_bank_account_pause_params.rb +20 -0
  36. data/lib/lithic/models/financial_accounts/statement.rb +4 -4
  37. data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +3 -2
  38. data/lib/lithic/models/financial_event.rb +1 -0
  39. data/lib/lithic/models/kyb_business_entity.rb +2 -2
  40. data/lib/lithic/models/parsed_webhook_event.rb +4 -1
  41. data/lib/lithic/models/settlement_detail.rb +14 -14
  42. data/lib/lithic/models/signals_response.rb +306 -0
  43. data/lib/lithic/models/statement_totals.rb +6 -6
  44. data/lib/lithic/models/tokenization_decline_reason.rb +1 -0
  45. data/lib/lithic/models/transaction.rb +2 -2
  46. data/lib/lithic/models/transfer_limits_response.rb +12 -12
  47. data/lib/lithic/models.rb +14 -0
  48. data/lib/lithic/resources/accounts.rb +27 -0
  49. data/lib/lithic/resources/auth_rules/v2.rb +1 -1
  50. data/lib/lithic/resources/card_authorizations.rb +45 -0
  51. data/lib/lithic/resources/cards.rb +25 -0
  52. data/lib/lithic/resources/external_bank_accounts.rb +19 -0
  53. data/lib/lithic/resources/webhooks.rb +1 -1
  54. data/lib/lithic/version.rb +1 -1
  55. data/lib/lithic.rb +9 -0
  56. data/rbi/lithic/client.rbi +3 -0
  57. data/rbi/lithic/models/account_holder_simulate_enrollment_review_response.rbi +6 -12
  58. data/rbi/lithic/models/account_retrieve_signals_params.rbi +35 -0
  59. data/rbi/lithic/models/auth_rules/auth_rule.rbi +8 -4
  60. data/rbi/lithic/models/auth_rules/auth_rule_version.rbi +4 -2
  61. data/rbi/lithic/models/auth_rules/conditional_3ds_action_parameters.rbi +9 -6
  62. data/rbi/lithic/models/auth_rules/conditional_ach_action_parameters.rbi +3 -3
  63. data/rbi/lithic/models/auth_rules/conditional_authorization_action_parameters.rbi +214 -63
  64. data/rbi/lithic/models/auth_rules/conditional_authorization_adjustment_parameters.rbi +1147 -0
  65. data/rbi/lithic/models/auth_rules/conditional_card_transaction_update_action_parameters.rbi +24 -18
  66. data/rbi/lithic/models/auth_rules/conditional_tokenization_action_parameters.rbi +6 -6
  67. data/rbi/lithic/models/auth_rules/conditional_value.rbi +1 -1
  68. data/rbi/lithic/models/auth_rules/v2_create_params.rbi +24 -12
  69. data/rbi/lithic/models/auth_rules/v2_draft_params.rbi +8 -4
  70. data/rbi/lithic/models/balance.rbi +12 -6
  71. data/rbi/lithic/models/card_authorization.rbi +2540 -0
  72. data/rbi/lithic/models/card_authorization_approval_request_webhook_event.rbi +5 -2758
  73. data/rbi/lithic/models/card_authorization_challenge_response_params.rbi +93 -0
  74. data/rbi/lithic/models/card_authorization_challenge_response_webhook_event.rbi +5 -0
  75. data/rbi/lithic/models/card_authorization_challenge_webhook_event.rbi +119 -0
  76. data/rbi/lithic/models/card_program.rbi +3 -6
  77. data/rbi/lithic/models/card_retrieve_signals_params.rbi +35 -0
  78. data/rbi/lithic/models/event.rbi +23 -6
  79. data/rbi/lithic/models/event_list_params.rbi +11 -2
  80. data/rbi/lithic/models/event_subscription.rbi +11 -2
  81. data/rbi/lithic/models/events/subscription_create_params.rbi +11 -2
  82. data/rbi/lithic/models/events/subscription_send_simulated_example_params.rbi +5 -0
  83. data/rbi/lithic/models/events/subscription_update_params.rbi +11 -2
  84. data/rbi/lithic/models/external_bank_account_pause_params.rbi +41 -0
  85. data/rbi/lithic/models/financial_accounts/statement.rbi +6 -12
  86. data/rbi/lithic/models/financial_accounts/statements/statement_line_items.rbi +8 -6
  87. data/rbi/lithic/models/financial_event.rbi +2 -0
  88. data/rbi/lithic/models/kyb_business_entity.rbi +3 -6
  89. data/rbi/lithic/models/parsed_webhook_event.rbi +1 -0
  90. data/rbi/lithic/models/settlement_detail.rbi +15 -15
  91. data/rbi/lithic/models/signals_response.rbi +352 -0
  92. data/rbi/lithic/models/statement_totals.rbi +9 -18
  93. data/rbi/lithic/models/tokenization_decline_reason.rbi +2 -0
  94. data/rbi/lithic/models/transaction.rbi +3 -3
  95. data/rbi/lithic/models/transfer_limits_response.rbi +48 -48
  96. data/rbi/lithic/models.rbi +17 -0
  97. data/rbi/lithic/resources/accounts.rbi +21 -0
  98. data/rbi/lithic/resources/auth_rules/v2.rbi +2 -1
  99. data/rbi/lithic/resources/card_authorizations.rbi +35 -0
  100. data/rbi/lithic/resources/cards.rbi +19 -0
  101. data/rbi/lithic/resources/external_bank_accounts.rbi +10 -0
  102. data/rbi/lithic/resources/webhooks.rbi +4 -1
  103. data/sig/lithic/client.rbs +2 -0
  104. data/sig/lithic/models/account_holder_simulate_enrollment_review_response.rbs +8 -12
  105. data/sig/lithic/models/account_retrieve_signals_params.rbs +23 -0
  106. data/sig/lithic/models/auth_rules/auth_rule.rbs +2 -0
  107. data/sig/lithic/models/auth_rules/auth_rule_version.rbs +1 -0
  108. data/sig/lithic/models/auth_rules/conditional_authorization_action_parameters.rbs +29 -3
  109. data/sig/lithic/models/auth_rules/conditional_authorization_adjustment_parameters.rbs +276 -0
  110. data/sig/lithic/models/auth_rules/conditional_value.rbs +1 -1
  111. data/sig/lithic/models/auth_rules/v2_create_params.rbs +3 -0
  112. data/sig/lithic/models/auth_rules/v2_draft_params.rbs +1 -0
  113. data/sig/lithic/models/balance.rbs +17 -9
  114. data/sig/lithic/models/card_authorization.rbs +1038 -0
  115. data/sig/lithic/models/card_authorization_approval_request_webhook_event.rbs +7 -1013
  116. data/sig/lithic/models/card_authorization_challenge_response_params.rbs +42 -0
  117. data/sig/lithic/models/card_authorization_challenge_response_webhook_event.rbs +2 -1
  118. data/sig/lithic/models/card_authorization_challenge_webhook_event.rbs +53 -0
  119. data/sig/lithic/models/card_program.rbs +4 -6
  120. data/sig/lithic/models/card_retrieve_signals_params.rbs +23 -0
  121. data/sig/lithic/models/event.rbs +2 -0
  122. data/sig/lithic/models/event_list_params.rbs +2 -0
  123. data/sig/lithic/models/event_subscription.rbs +2 -0
  124. data/sig/lithic/models/events/subscription_create_params.rbs +2 -0
  125. data/sig/lithic/models/events/subscription_send_simulated_example_params.rbs +2 -0
  126. data/sig/lithic/models/events/subscription_update_params.rbs +2 -0
  127. data/sig/lithic/models/external_bank_account_pause_params.rbs +24 -0
  128. data/sig/lithic/models/financial_accounts/statement.rbs +8 -12
  129. data/sig/lithic/models/financial_accounts/statements/statement_line_items.rbs +6 -6
  130. data/sig/lithic/models/financial_event.rbs +2 -0
  131. data/sig/lithic/models/kyb_business_entity.rbs +4 -6
  132. data/sig/lithic/models/parsed_webhook_event.rbs +1 -0
  133. data/sig/lithic/models/settlement_detail.rbs +18 -18
  134. data/sig/lithic/models/signals_response.rbs +170 -0
  135. data/sig/lithic/models/statement_totals.rbs +12 -18
  136. data/sig/lithic/models/tokenization_decline_reason.rbs +2 -0
  137. data/sig/lithic/models/transaction.rbs +4 -8
  138. data/sig/lithic/models/transfer_limits_response.rbs +24 -36
  139. data/sig/lithic/models.rbs +14 -0
  140. data/sig/lithic/resources/accounts.rbs +5 -0
  141. data/sig/lithic/resources/card_authorizations.rbs +13 -0
  142. data/sig/lithic/resources/cards.rbs +5 -0
  143. data/sig/lithic/resources/external_bank_accounts.rbs +5 -0
  144. data/sig/lithic/resources/webhooks.rbs +1 -0
  145. metadata +29 -2
@@ -2,1266 +2,16 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
- class CardAuthorizationApprovalRequestWebhookEvent < 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
- # @deprecated
22
- #
23
- # Deprecated, use `amounts`. Authorization amount of the transaction (in cents),
24
- # including any acquirer fees. The contents of this field are identical to
25
- # `authorization_amount`.
26
- #
27
- # @return [Integer]
28
- required :amount, Integer
29
-
30
- # @!attribute amounts
31
- # Structured amounts for this authorization. The `cardholder` and `merchant`
32
- # amounts reflect the original network authorization values. For programs with
33
- # hold adjustments enabled (e.g., automated fuel dispensers or tipping MCCs), the
34
- # `hold` amount may exceed the `cardholder` and `merchant` amounts to account for
35
- # anticipated final transaction amounts such as tips or fuel fill-ups
36
- #
37
- # @return [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Amounts]
38
- required :amounts, -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Amounts }
39
-
40
- # @!attribute authorization_amount
41
- # @deprecated
42
- #
43
- # Deprecated, use `amounts`. The base transaction amount (in cents) plus the
44
- # acquirer fee field. This is the amount the issuer should authorize against
45
- # unless the issuer is paying the acquirer fee on behalf of the cardholder.
46
- #
47
- # @return [Integer]
48
- required :authorization_amount, Integer
49
-
50
- # @!attribute avs
51
- #
52
- # @return [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Avs]
53
- required :avs, -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Avs }
54
-
55
- # @!attribute card
56
- # Card object in ASA
57
- #
58
- # @return [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Card]
59
- required :card, -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Card }
60
-
61
- # @!attribute cardholder_currency
62
- # @deprecated
63
- #
64
- # Deprecated, use `amounts`. 3-character alphabetic ISO 4217 code for cardholder's
65
- # billing currency.
66
- #
67
- # @return [String]
68
- required :cardholder_currency, String
69
-
70
- # @!attribute cash_amount
71
- # The portion of the transaction requested as cash back by the cardholder, and
72
- # does not include any acquirer fees. The amount field includes the purchase
73
- # amount, the requested cash back amount, and any acquirer fees.
74
- #
75
- # If no cash back was requested, the value of this field will be 0, and the field
76
- # will always be present.
77
- #
78
- # @return [Integer]
79
- required :cash_amount, Integer
80
-
81
- # @!attribute created
82
- # Date and time when the transaction first occurred in UTC.
83
- #
84
- # @return [Time]
85
- required :created, Time
86
-
5
+ class CardAuthorizationApprovalRequestWebhookEvent < Lithic::Models::CardAuthorization
87
6
  # @!attribute event_type
88
7
  #
89
8
  # @return [Symbol, :"card_authorization.approval_request"]
90
9
  required :event_type, const: :"card_authorization.approval_request"
91
10
 
92
- # @!attribute merchant
93
- # Merchant information including full location details.
94
- #
95
- # @return [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Merchant]
96
- required :merchant, -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Merchant }
97
-
98
- # @!attribute merchant_amount
99
- # @deprecated
100
- #
101
- # Deprecated, use `amounts`. The amount that the merchant will receive,
102
- # denominated in `merchant_currency` and in the smallest currency unit. Note the
103
- # amount includes `acquirer_fee`, similar to `authorization_amount`. It will be
104
- # different from `authorization_amount` if the merchant is taking payment in a
105
- # different currency.
106
- #
107
- # @return [Integer]
108
- required :merchant_amount, Integer
109
-
110
- # @!attribute merchant_currency
111
- # @deprecated
112
- #
113
- # 3-character alphabetic ISO 4217 code for the local currency of the transaction.
114
- #
115
- # @return [String]
116
- required :merchant_currency, String
117
-
118
- # @!attribute service_location
119
- # Where the cardholder received the service, when different from the card acceptor
120
- # location. This is populated from network data elements such as Mastercard DE-122
121
- # SE1 SF9-14 and Visa F34 DS02.
122
- #
123
- # @return [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::ServiceLocation, nil]
124
- required :service_location,
125
- -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::ServiceLocation },
126
- nil?: true
127
-
128
- # @!attribute settled_amount
129
- # @deprecated
130
- #
131
- # Deprecated, use `amounts`. Amount (in cents) of the transaction that has been
132
- # settled, including any acquirer fees.
133
- #
134
- # @return [Integer]
135
- required :settled_amount, Integer
136
-
137
- # @!attribute status
138
- # The type of authorization request that this request is for. Note that
139
- # `CREDIT_AUTHORIZATION` and `FINANCIAL_CREDIT_AUTHORIZATION` is only available to
140
- # users with credit decisioning via ASA enabled.
141
- #
142
- # @return [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Status]
143
- required :status, enum: -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Status }
144
-
145
- # @!attribute transaction_initiator
146
- # The entity that initiated the transaction.
147
- #
148
- # @return [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::TransactionInitiator]
149
- required :transaction_initiator,
150
- enum: -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::TransactionInitiator }
151
-
152
- # @!attribute account_type
153
- #
154
- # @return [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::AccountType, nil]
155
- optional :account_type, enum: -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::AccountType }
156
-
157
- # @!attribute cardholder_authentication
158
- #
159
- # @return [Lithic::Models::CardholderAuthentication, nil]
160
- optional :cardholder_authentication, -> { Lithic::CardholderAuthentication }
161
-
162
- # @!attribute cashback
163
- # Deprecated, use `cash_amount`.
164
- #
165
- # @return [Integer, nil]
166
- optional :cashback, Integer
167
-
168
- # @!attribute conversion_rate
169
- # @deprecated
170
- #
171
- # Deprecated, use `amounts`. If the transaction was requested in a currency other
172
- # than the settlement currency, this field will be populated to indicate the rate
173
- # used to translate the merchant_amount to the amount (i.e., `merchant_amount` x
174
- # `conversion_rate` = `amount`). Note that the `merchant_amount` is in the local
175
- # currency and the amount is in the settlement currency.
176
- #
177
- # @return [Float, nil]
178
- optional :conversion_rate, Float
179
-
180
- # @!attribute event_token
181
- # The event token associated with the authorization. This field is only set for
182
- # programs enrolled into the beta.
183
- #
184
- # @return [String, nil]
185
- optional :event_token, String
186
-
187
- # @!attribute fleet_info
188
- # Optional Object containing information if the Card is a part of a Fleet managed
189
- # program
190
- #
191
- # @return [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::FleetInfo, nil]
192
- optional :fleet_info, -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::FleetInfo }, nil?: true
193
-
194
- # @!attribute latest_challenge
195
- # The latest Authorization Challenge that was issued to the cardholder for this
196
- # merchant.
197
- #
198
- # @return [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::LatestChallenge, nil]
199
- optional :latest_challenge, -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::LatestChallenge }
200
-
201
- # @!attribute network
202
- # Card network of the authorization.
203
- #
204
- # @return [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Network, nil]
205
- optional :network, enum: -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Network }
206
-
207
- # @!attribute network_risk_score
208
- # Network-provided score assessing risk level associated with a given
209
- # authorization. Scores are on a range of 0-999, with 0 representing the lowest
210
- # risk and 999 representing the highest risk. For Visa transactions, where the raw
211
- # score has a range of 0-99, Lithic will normalize the score by multiplying the
212
- # raw score by 10x.
213
- #
214
- # @return [Integer, nil]
215
- optional :network_risk_score, Integer, nil?: true
216
-
217
- # @!attribute network_specific_data
218
- # Contains raw data provided by the card network, including attributes that
219
- # provide further context about the authorization. If populated by the network,
220
- # data is organized by Lithic and passed through without further modification.
221
- # Please consult the official network documentation for more details about these
222
- # values and how to use them. This object is only available to certain programs-
223
- # contact your Customer Success Manager to discuss enabling access.
224
- #
225
- # @return [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::NetworkSpecificData, nil]
226
- optional :network_specific_data,
227
- -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::NetworkSpecificData },
228
- nil?: true
229
-
230
- # @!attribute pos
231
- #
232
- # @return [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos, nil]
233
- optional :pos, -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Pos }
234
-
235
- # @!attribute token_info
236
- #
237
- # @return [Lithic::Models::TokenInfo, nil]
238
- optional :token_info, -> { Lithic::TokenInfo }, nil?: true
239
-
240
- # @!attribute ttl
241
- # Deprecated: approximate time-to-live for the authorization.
242
- #
243
- # @return [Time, nil]
244
- optional :ttl, Time
245
-
246
- # @!method initialize(token:, acquirer_fee:, amount:, amounts:, authorization_amount:, avs:, card:, cardholder_currency:, cash_amount:, created:, merchant:, merchant_amount:, merchant_currency:, service_location:, 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, event_type: :"card_authorization.approval_request")
247
- # Some parameter documentations has been truncated, see
248
- # {Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent} for more details.
249
- #
250
- # @param token [String] The provisional transaction group uuid associated with the authorization
251
- #
252
- # @param acquirer_fee [Integer] Fee (in cents) assessed by the merchant and paid for by the cardholder. Will be
253
- #
254
- # @param amount [Integer] Deprecated, use `amounts`. Authorization amount of the transaction (in cents), i
255
- #
256
- # @param amounts [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Amounts] Structured amounts for this authorization. The `cardholder` and `merchant` amoun
257
- #
258
- # @param authorization_amount [Integer] Deprecated, use `amounts`. The base transaction amount (in cents) plus the acqui
259
- #
260
- # @param avs [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Avs]
261
- #
262
- # @param card [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Card] Card object in ASA
263
- #
264
- # @param cardholder_currency [String] Deprecated, use `amounts`. 3-character alphabetic ISO 4217 code for cardholder's
265
- #
266
- # @param cash_amount [Integer] The portion of the transaction requested as cash back by the cardholder, and doe
267
- #
268
- # @param created [Time] Date and time when the transaction first occurred in UTC.
269
- #
270
- # @param merchant [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Merchant] Merchant information including full location details.
271
- #
272
- # @param merchant_amount [Integer] Deprecated, use `amounts`. The amount that the merchant will receive, denominate
273
- #
274
- # @param merchant_currency [String] 3-character alphabetic ISO 4217 code for the local currency of the transaction.
275
- #
276
- # @param service_location [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::ServiceLocation, nil] Where the cardholder received the service, when different from the card acceptor
277
- #
278
- # @param settled_amount [Integer] Deprecated, use `amounts`. Amount (in cents) of the transaction that has been se
279
- #
280
- # @param status [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Status] The type of authorization request that this request is for. Note that `CREDIT_AU
281
- #
282
- # @param transaction_initiator [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::TransactionInitiator] The entity that initiated the transaction.
283
- #
284
- # @param account_type [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::AccountType]
285
- #
286
- # @param cardholder_authentication [Lithic::Models::CardholderAuthentication]
287
- #
288
- # @param cashback [Integer] Deprecated, use `cash_amount`.
289
- #
290
- # @param conversion_rate [Float] Deprecated, use `amounts`. If the transaction was requested in a currency other
291
- #
292
- # @param event_token [String] The event token associated with the authorization. This field is only set for pr
293
- #
294
- # @param fleet_info [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::FleetInfo, nil] Optional Object containing information if the Card is a part of a Fleet managed
295
- #
296
- # @param latest_challenge [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::LatestChallenge] The latest Authorization Challenge that was issued to the cardholder for this me
297
- #
298
- # @param network [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Network] Card network of the authorization.
299
- #
300
- # @param network_risk_score [Integer, nil] Network-provided score assessing risk level associated with a given authorizatio
301
- #
302
- # @param network_specific_data [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::NetworkSpecificData, nil] Contains raw data provided by the card network, including attributes that provid
303
- #
304
- # @param pos [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos]
305
- #
306
- # @param token_info [Lithic::Models::TokenInfo, nil]
307
- #
308
- # @param ttl [Time] Deprecated: approximate time-to-live for the authorization.
11
+ # @!method initialize(event_type: :"card_authorization.approval_request")
12
+ # The Auth Stream Access request payload that was sent to the ASA responder.
309
13
  #
310
14
  # @param event_type [Symbol, :"card_authorization.approval_request"]
311
-
312
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent#amounts
313
- class Amounts < Lithic::Internal::Type::BaseModel
314
- # @!attribute cardholder
315
- #
316
- # @return [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Amounts::Cardholder]
317
- required :cardholder, -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Amounts::Cardholder }
318
-
319
- # @!attribute hold
320
- #
321
- # @return [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Amounts::Hold, nil]
322
- required :hold, -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Amounts::Hold }, nil?: true
323
-
324
- # @!attribute merchant
325
- #
326
- # @return [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Amounts::Merchant]
327
- required :merchant, -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Amounts::Merchant }
328
-
329
- # @!attribute settlement
330
- #
331
- # @return [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Amounts::Settlement, nil]
332
- required :settlement,
333
- -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Amounts::Settlement },
334
- nil?: true
335
-
336
- # @!method initialize(cardholder:, hold:, merchant:, settlement:)
337
- # Structured amounts for this authorization. The `cardholder` and `merchant`
338
- # amounts reflect the original network authorization values. For programs with
339
- # hold adjustments enabled (e.g., automated fuel dispensers or tipping MCCs), the
340
- # `hold` amount may exceed the `cardholder` and `merchant` amounts to account for
341
- # anticipated final transaction amounts such as tips or fuel fill-ups
342
- #
343
- # @param cardholder [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Amounts::Cardholder]
344
- # @param hold [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Amounts::Hold, nil]
345
- # @param merchant [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Amounts::Merchant]
346
- # @param settlement [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Amounts::Settlement, nil]
347
-
348
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Amounts#cardholder
349
- class Cardholder < Lithic::Internal::Type::BaseModel
350
- # @!attribute amount
351
- # Amount in the smallest unit of the applicable currency (e.g., cents)
352
- #
353
- # @return [Integer]
354
- required :amount, Integer
355
-
356
- # @!attribute conversion_rate
357
- # Exchange rate used for currency conversion
358
- #
359
- # @return [String]
360
- required :conversion_rate, String
361
-
362
- # @!attribute currency
363
- # 3-character alphabetic ISO 4217 currency
364
- #
365
- # @return [String]
366
- required :currency, String
367
-
368
- # @!method initialize(amount:, conversion_rate:, currency:)
369
- # @param amount [Integer] Amount in the smallest unit of the applicable currency (e.g., cents)
370
- #
371
- # @param conversion_rate [String] Exchange rate used for currency conversion
372
- #
373
- # @param currency [String] 3-character alphabetic ISO 4217 currency
374
- end
375
-
376
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Amounts#hold
377
- class Hold < Lithic::Internal::Type::BaseModel
378
- # @!attribute amount
379
- # Amount in the smallest unit of the applicable currency (e.g., cents)
380
- #
381
- # @return [Integer]
382
- required :amount, Integer
383
-
384
- # @!attribute currency
385
- # 3-character alphabetic ISO 4217 currency
386
- #
387
- # @return [String]
388
- required :currency, String
389
-
390
- # @!method initialize(amount:, currency:)
391
- # @param amount [Integer] Amount in the smallest unit of the applicable currency (e.g., cents)
392
- #
393
- # @param currency [String] 3-character alphabetic ISO 4217 currency
394
- end
395
-
396
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Amounts#merchant
397
- class Merchant < Lithic::Internal::Type::BaseModel
398
- # @!attribute amount
399
- # Amount in the smallest unit of the applicable currency (e.g., cents)
400
- #
401
- # @return [Integer]
402
- required :amount, Integer
403
-
404
- # @!attribute currency
405
- # 3-character alphabetic ISO 4217 currency
406
- #
407
- # @return [String]
408
- required :currency, String
409
-
410
- # @!method initialize(amount:, currency:)
411
- # @param amount [Integer] Amount in the smallest unit of the applicable currency (e.g., cents)
412
- #
413
- # @param currency [String] 3-character alphabetic ISO 4217 currency
414
- end
415
-
416
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Amounts#settlement
417
- class Settlement < Lithic::Internal::Type::BaseModel
418
- # @!attribute amount
419
- # Amount in the smallest unit of the applicable currency (e.g., cents)
420
- #
421
- # @return [Integer]
422
- required :amount, Integer
423
-
424
- # @!attribute currency
425
- # 3-character alphabetic ISO 4217 currency
426
- #
427
- # @return [String]
428
- required :currency, String
429
-
430
- # @!method initialize(amount:, currency:)
431
- # @param amount [Integer] Amount in the smallest unit of the applicable currency (e.g., cents)
432
- #
433
- # @param currency [String] 3-character alphabetic ISO 4217 currency
434
- end
435
- end
436
-
437
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent#avs
438
- class Avs < Lithic::Internal::Type::BaseModel
439
- # @!attribute address
440
- # Cardholder address
441
- #
442
- # @return [String]
443
- required :address, String
444
-
445
- # @!attribute address_on_file_match
446
- # Lithic's evaluation result comparing the transaction's address data with the
447
- # cardholder KYC data if it exists. In the event Lithic does not have any
448
- # Cardholder KYC data, or the transaction does not contain any address data,
449
- # NOT_PRESENT will be returned
450
- #
451
- # @return [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Avs::AddressOnFileMatch]
452
- required :address_on_file_match,
453
- enum: -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Avs::AddressOnFileMatch }
454
-
455
- # @!attribute zipcode
456
- # Cardholder ZIP code
457
- #
458
- # @return [String]
459
- required :zipcode, String
460
-
461
- # @!method initialize(address:, address_on_file_match:, zipcode:)
462
- # Some parameter documentations has been truncated, see
463
- # {Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Avs} for more
464
- # details.
465
- #
466
- # @param address [String] Cardholder address
467
- #
468
- # @param address_on_file_match [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Avs::AddressOnFileMatch] Lithic's evaluation result comparing the transaction's address data with the car
469
- #
470
- # @param zipcode [String] Cardholder ZIP code
471
-
472
- # Lithic's evaluation result comparing the transaction's address data with the
473
- # cardholder KYC data if it exists. In the event Lithic does not have any
474
- # Cardholder KYC data, or the transaction does not contain any address data,
475
- # NOT_PRESENT will be returned
476
- #
477
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Avs#address_on_file_match
478
- module AddressOnFileMatch
479
- extend Lithic::Internal::Type::Enum
480
-
481
- MATCH = :MATCH
482
- MATCH_ADDRESS_ONLY = :MATCH_ADDRESS_ONLY
483
- MATCH_ZIP_ONLY = :MATCH_ZIP_ONLY
484
- MISMATCH = :MISMATCH
485
- NOT_PRESENT = :NOT_PRESENT
486
-
487
- # @!method self.values
488
- # @return [Array<Symbol>]
489
- end
490
- end
491
-
492
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent#card
493
- class Card < Lithic::Internal::Type::BaseModel
494
- # @!attribute token
495
- # Globally unique identifier for the card.
496
- #
497
- # @return [String]
498
- required :token, String
499
-
500
- # @!attribute last_four
501
- # Last four digits of the card number
502
- #
503
- # @return [String]
504
- required :last_four, String
505
-
506
- # @!attribute memo
507
- # Customizable name to identify the card
508
- #
509
- # @return [String]
510
- required :memo, String
511
-
512
- # @!attribute spend_limit
513
- # Amount (in cents) to limit approved authorizations. Purchase requests above the
514
- # spend limit will be declined (refunds and credits will be approved).
515
- #
516
- # Note that while spend limits are enforced based on authorized and settled volume
517
- # on a card, they are not recommended to be used for balance or
518
- # reconciliation-level accuracy. Spend limits also cannot block force posted
519
- # charges (i.e., when a merchant sends a clearing message without a prior
520
- # authorization).
521
- #
522
- # @return [Integer]
523
- required :spend_limit, Integer
524
-
525
- # @!attribute spend_limit_duration
526
- # Note that to support recurring monthly payments, which can occur on different
527
- # day every month, the time window we consider for MONTHLY velocity starts 6 days
528
- # after the current calendar date one month prior.
529
- #
530
- # @return [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Card::SpendLimitDuration]
531
- required :spend_limit_duration,
532
- enum: -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Card::SpendLimitDuration }
533
-
534
- # @!attribute state
535
- #
536
- # @return [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Card::State]
537
- required :state, enum: -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Card::State }
538
-
539
- # @!attribute type
540
- #
541
- # @return [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Card::Type]
542
- required :type, enum: -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Card::Type }
543
-
544
- # @!method initialize(token:, last_four:, memo:, spend_limit:, spend_limit_duration:, state:, type:)
545
- # Some parameter documentations has been truncated, see
546
- # {Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Card} for more
547
- # details.
548
- #
549
- # Card object in ASA
550
- #
551
- # @param token [String] Globally unique identifier for the card.
552
- #
553
- # @param last_four [String] Last four digits of the card number
554
- #
555
- # @param memo [String] Customizable name to identify the card
556
- #
557
- # @param spend_limit [Integer] Amount (in cents) to limit approved authorizations. Purchase requests above the
558
- #
559
- # @param spend_limit_duration [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Card::SpendLimitDuration] Note that to support recurring monthly payments, which can occur on different da
560
- #
561
- # @param state [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Card::State]
562
- #
563
- # @param type [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Card::Type]
564
-
565
- # Note that to support recurring monthly payments, which can occur on different
566
- # day every month, the time window we consider for MONTHLY velocity starts 6 days
567
- # after the current calendar date one month prior.
568
- #
569
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Card#spend_limit_duration
570
- module SpendLimitDuration
571
- extend Lithic::Internal::Type::Enum
572
-
573
- ANNUALLY = :ANNUALLY
574
- FOREVER = :FOREVER
575
- MONTHLY = :MONTHLY
576
- TRANSACTION = :TRANSACTION
577
-
578
- # @!method self.values
579
- # @return [Array<Symbol>]
580
- end
581
-
582
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Card#state
583
- module State
584
- extend Lithic::Internal::Type::Enum
585
-
586
- CLOSED = :CLOSED
587
- OPEN = :OPEN
588
- PAUSED = :PAUSED
589
- PENDING_ACTIVATION = :PENDING_ACTIVATION
590
- PENDING_FULFILLMENT = :PENDING_FULFILLMENT
591
-
592
- # @!method self.values
593
- # @return [Array<Symbol>]
594
- end
595
-
596
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Card#type
597
- module Type
598
- extend Lithic::Internal::Type::Enum
599
-
600
- SINGLE_USE = :SINGLE_USE
601
- MERCHANT_LOCKED = :MERCHANT_LOCKED
602
- UNLOCKED = :UNLOCKED
603
- PHYSICAL = :PHYSICAL
604
- DIGITAL_WALLET = :DIGITAL_WALLET
605
- VIRTUAL = :VIRTUAL
606
-
607
- # @!method self.values
608
- # @return [Array<Symbol>]
609
- end
610
- end
611
-
612
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent#merchant
613
- class Merchant < Lithic::Models::Merchant
614
- # @!attribute phone_number
615
- # Phone number of card acceptor.
616
- #
617
- # @return [String, nil]
618
- required :phone_number, String, nil?: true
619
-
620
- # @!attribute postal_code
621
- # Postal code of card acceptor.
622
- #
623
- # @return [String, nil]
624
- required :postal_code, String, nil?: true
625
-
626
- # @!attribute street_address
627
- # Street address of card acceptor.
628
- #
629
- # @return [String, nil]
630
- required :street_address, String, nil?: true
631
-
632
- # @!method initialize(phone_number:, postal_code:, street_address:)
633
- # Merchant information including full location details.
634
- #
635
- # @param phone_number [String, nil] Phone number of card acceptor.
636
- #
637
- # @param postal_code [String, nil] Postal code of card acceptor.
638
- #
639
- # @param street_address [String, nil] Street address of card acceptor.
640
- end
641
-
642
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent#service_location
643
- class ServiceLocation < Lithic::Internal::Type::BaseModel
644
- # @!attribute city
645
- # City of service location.
646
- #
647
- # @return [String, nil]
648
- required :city, String, nil?: true
649
-
650
- # @!attribute country
651
- # Country code of service location, ISO 3166-1 alpha-3.
652
- #
653
- # @return [String, nil]
654
- required :country, String, nil?: true
655
-
656
- # @!attribute postal_code
657
- # Postal code of service location.
658
- #
659
- # @return [String, nil]
660
- required :postal_code, String, nil?: true
661
-
662
- # @!attribute state
663
- # State/province code of service location, ISO 3166-2.
664
- #
665
- # @return [String, nil]
666
- required :state, String, nil?: true
667
-
668
- # @!attribute street_address
669
- # Street address of service location.
670
- #
671
- # @return [String, nil]
672
- required :street_address, String, nil?: true
673
-
674
- # @!method initialize(city:, country:, postal_code:, state:, street_address:)
675
- # Where the cardholder received the service, when different from the card acceptor
676
- # location. This is populated from network data elements such as Mastercard DE-122
677
- # SE1 SF9-14 and Visa F34 DS02.
678
- #
679
- # @param city [String, nil] City of service location.
680
- #
681
- # @param country [String, nil] Country code of service location, ISO 3166-1 alpha-3.
682
- #
683
- # @param postal_code [String, nil] Postal code of service location.
684
- #
685
- # @param state [String, nil] State/province code of service location, ISO 3166-2.
686
- #
687
- # @param street_address [String, nil] Street address of service location.
688
- end
689
-
690
- # The type of authorization request that this request is for. Note that
691
- # `CREDIT_AUTHORIZATION` and `FINANCIAL_CREDIT_AUTHORIZATION` is only available to
692
- # users with credit decisioning via ASA enabled.
693
- #
694
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent#status
695
- module Status
696
- extend Lithic::Internal::Type::Enum
697
-
698
- AUTHORIZATION = :AUTHORIZATION
699
- CREDIT_AUTHORIZATION = :CREDIT_AUTHORIZATION
700
- FINANCIAL_AUTHORIZATION = :FINANCIAL_AUTHORIZATION
701
- FINANCIAL_CREDIT_AUTHORIZATION = :FINANCIAL_CREDIT_AUTHORIZATION
702
- BALANCE_INQUIRY = :BALANCE_INQUIRY
703
-
704
- # @!method self.values
705
- # @return [Array<Symbol>]
706
- end
707
-
708
- # The entity that initiated the transaction.
709
- #
710
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent#transaction_initiator
711
- module TransactionInitiator
712
- extend Lithic::Internal::Type::Enum
713
-
714
- CARDHOLDER = :CARDHOLDER
715
- MERCHANT = :MERCHANT
716
- UNKNOWN = :UNKNOWN
717
-
718
- # @!method self.values
719
- # @return [Array<Symbol>]
720
- end
721
-
722
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent#account_type
723
- module AccountType
724
- extend Lithic::Internal::Type::Enum
725
-
726
- CHECKING = :CHECKING
727
- SAVINGS = :SAVINGS
728
-
729
- # @!method self.values
730
- # @return [Array<Symbol>]
731
- end
732
-
733
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent#fleet_info
734
- class FleetInfo < Lithic::Internal::Type::BaseModel
735
- # @!attribute fleet_prompt_code
736
- # Code indicating what the driver was prompted to enter at time of purchase. This
737
- # is configured at a program level and is a static configuration, and does not
738
- # change on a request to request basis
739
- #
740
- # @return [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::FleetInfo::FleetPromptCode]
741
- required :fleet_prompt_code,
742
- enum: -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::FleetInfo::FleetPromptCode }
743
-
744
- # @!attribute fleet_restriction_code
745
- # Code indicating which restrictions, if any, there are on purchase. This is
746
- # configured at a program level and is a static configuration, and does not change
747
- # on a request to request basis
748
- #
749
- # @return [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::FleetInfo::FleetRestrictionCode]
750
- required :fleet_restriction_code,
751
- enum: -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::FleetInfo::FleetRestrictionCode }
752
-
753
- # @!attribute driver_number
754
- # Number representing the driver
755
- #
756
- # @return [String, nil]
757
- optional :driver_number, String, nil?: true
758
-
759
- # @!attribute vehicle_number
760
- # Number associated with the vehicle
761
- #
762
- # @return [String, nil]
763
- optional :vehicle_number, String, nil?: true
764
-
765
- # @!method initialize(fleet_prompt_code:, fleet_restriction_code:, driver_number: nil, vehicle_number: nil)
766
- # Some parameter documentations has been truncated, see
767
- # {Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::FleetInfo} for
768
- # more details.
769
- #
770
- # Optional Object containing information if the Card is a part of a Fleet managed
771
- # program
772
- #
773
- # @param fleet_prompt_code [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::FleetInfo::FleetPromptCode] Code indicating what the driver was prompted to enter at time of purchase. This
774
- #
775
- # @param fleet_restriction_code [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::FleetInfo::FleetRestrictionCode] Code indicating which restrictions, if any, there are on purchase. This is confi
776
- #
777
- # @param driver_number [String, nil] Number representing the driver
778
- #
779
- # @param vehicle_number [String, nil] Number associated with the vehicle
780
-
781
- # Code indicating what the driver was prompted to enter at time of purchase. This
782
- # is configured at a program level and is a static configuration, and does not
783
- # change on a request to request basis
784
- #
785
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::FleetInfo#fleet_prompt_code
786
- module FleetPromptCode
787
- extend Lithic::Internal::Type::Enum
788
-
789
- NO_PROMPT = :NO_PROMPT
790
- VEHICLE_NUMBER = :VEHICLE_NUMBER
791
- DRIVER_NUMBER = :DRIVER_NUMBER
792
-
793
- # @!method self.values
794
- # @return [Array<Symbol>]
795
- end
796
-
797
- # Code indicating which restrictions, if any, there are on purchase. This is
798
- # configured at a program level and is a static configuration, and does not change
799
- # on a request to request basis
800
- #
801
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::FleetInfo#fleet_restriction_code
802
- module FleetRestrictionCode
803
- extend Lithic::Internal::Type::Enum
804
-
805
- NO_RESTRICTIONS = :NO_RESTRICTIONS
806
- FUEL_ONLY = :FUEL_ONLY
807
-
808
- # @!method self.values
809
- # @return [Array<Symbol>]
810
- end
811
- end
812
-
813
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent#latest_challenge
814
- class LatestChallenge < Lithic::Internal::Type::BaseModel
815
- # @!attribute phone_number
816
- # The phone number used for sending Authorization Challenge SMS.
817
- #
818
- # @return [String]
819
- required :phone_number, String
820
-
821
- # @!attribute status
822
- # The status of the Authorization Challenge
823
- #
824
- # - `COMPLETED` - Challenge was successfully completed by the cardholder
825
- # - `PENDING` - Challenge is still open
826
- # - `EXPIRED` - Challenge has expired without being completed
827
- # - `ERROR` - There was an error processing the challenge
828
- #
829
- # @return [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::LatestChallenge::Status]
830
- required :status,
831
- enum: -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::LatestChallenge::Status }
832
-
833
- # @!attribute completed_at
834
- # The date and time when the Authorization Challenge was completed in UTC. Present
835
- # only if the status is `COMPLETED`.
836
- #
837
- # @return [Time, nil]
838
- optional :completed_at, Time
839
-
840
- # @!method initialize(phone_number:, status:, completed_at: nil)
841
- # Some parameter documentations has been truncated, see
842
- # {Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::LatestChallenge}
843
- # for more details.
844
- #
845
- # The latest Authorization Challenge that was issued to the cardholder for this
846
- # merchant.
847
- #
848
- # @param phone_number [String] The phone number used for sending Authorization Challenge SMS.
849
- #
850
- # @param status [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::LatestChallenge::Status] The status of the Authorization Challenge
851
- #
852
- # @param completed_at [Time] The date and time when the Authorization Challenge was completed in UTC. Present
853
-
854
- # The status of the Authorization Challenge
855
- #
856
- # - `COMPLETED` - Challenge was successfully completed by the cardholder
857
- # - `PENDING` - Challenge is still open
858
- # - `EXPIRED` - Challenge has expired without being completed
859
- # - `ERROR` - There was an error processing the challenge
860
- #
861
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::LatestChallenge#status
862
- module Status
863
- extend Lithic::Internal::Type::Enum
864
-
865
- COMPLETED = :COMPLETED
866
- PENDING = :PENDING
867
- EXPIRED = :EXPIRED
868
- ERROR = :ERROR
869
-
870
- # @!method self.values
871
- # @return [Array<Symbol>]
872
- end
873
- end
874
-
875
- # Card network of the authorization.
876
- #
877
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent#network
878
- module Network
879
- extend Lithic::Internal::Type::Enum
880
-
881
- AMEX = :AMEX
882
- INTERLINK = :INTERLINK
883
- MAESTRO = :MAESTRO
884
- MASTERCARD = :MASTERCARD
885
- UNKNOWN = :UNKNOWN
886
- VISA = :VISA
887
-
888
- # @!method self.values
889
- # @return [Array<Symbol>]
890
- end
891
-
892
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent#network_specific_data
893
- class NetworkSpecificData < Lithic::Internal::Type::BaseModel
894
- # @!attribute mastercard
895
- #
896
- # @return [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::NetworkSpecificData::Mastercard, nil]
897
- optional :mastercard,
898
- -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::NetworkSpecificData::Mastercard },
899
- nil?: true
900
-
901
- # @!attribute visa
902
- #
903
- # @return [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::NetworkSpecificData::Visa, nil]
904
- optional :visa,
905
- -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::NetworkSpecificData::Visa },
906
- nil?: true
907
-
908
- # @!method initialize(mastercard: nil, visa: nil)
909
- # Contains raw data provided by the card network, including attributes that
910
- # provide further context about the authorization. If populated by the network,
911
- # data is organized by Lithic and passed through without further modification.
912
- # Please consult the official network documentation for more details about these
913
- # values and how to use them. This object is only available to certain programs-
914
- # contact your Customer Success Manager to discuss enabling access.
915
- #
916
- # @param mastercard [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::NetworkSpecificData::Mastercard, nil]
917
- # @param visa [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::NetworkSpecificData::Visa, nil]
918
-
919
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::NetworkSpecificData#mastercard
920
- class Mastercard < Lithic::Internal::Type::BaseModel
921
- # @!attribute ecommerce_security_level_indicator
922
- # Indicates the electronic commerce security level and UCAF collection.
923
- #
924
- # @return [String, nil]
925
- optional :ecommerce_security_level_indicator, String, nil?: true
926
-
927
- # @!attribute on_behalf_service_result
928
- # The On-behalf Service performed on the transaction and the results. Contains all
929
- # applicable, on-behalf service results that were performed on a given
930
- # transaction.
931
- #
932
- # @return [Array<Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::NetworkSpecificData::Mastercard::OnBehalfServiceResult>, nil]
933
- optional :on_behalf_service_result,
934
- -> do
935
- Lithic::Internal::Type::ArrayOf[
936
- Lithic::CardAuthorizationApprovalRequestWebhookEvent::NetworkSpecificData::Mastercard::OnBehalfServiceResult
937
- ]
938
- end,
939
- nil?: true
940
-
941
- # @!attribute transaction_type_identifier
942
- # Indicates the type of additional transaction purpose.
943
- #
944
- # @return [String, nil]
945
- optional :transaction_type_identifier, String, nil?: true
946
-
947
- # @!method initialize(ecommerce_security_level_indicator: nil, on_behalf_service_result: nil, transaction_type_identifier: nil)
948
- # Some parameter documentations has been truncated, see
949
- # {Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::NetworkSpecificData::Mastercard}
950
- # for more details.
951
- #
952
- # @param ecommerce_security_level_indicator [String, nil] Indicates the electronic commerce security level and UCAF collection.
953
- #
954
- # @param on_behalf_service_result [Array<Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::NetworkSpecificData::Mastercard::OnBehalfServiceResult>, nil] The On-behalf Service performed on the transaction and the results. Contains all
955
- #
956
- # @param transaction_type_identifier [String, nil] Indicates the type of additional transaction purpose.
957
-
958
- class OnBehalfServiceResult < Lithic::Internal::Type::BaseModel
959
- # @!attribute result_1
960
- # Indicates the results of the service processing.
961
- #
962
- # @return [String]
963
- required :result_1, String
964
-
965
- # @!attribute result_2
966
- # Identifies the results of the service processing.
967
- #
968
- # @return [String]
969
- required :result_2, String
970
-
971
- # @!attribute service
972
- # Indicates the service performed on the transaction.
973
- #
974
- # @return [String]
975
- required :service, String
976
-
977
- # @!method initialize(result_1:, result_2:, service:)
978
- # @param result_1 [String] Indicates the results of the service processing.
979
- #
980
- # @param result_2 [String] Identifies the results of the service processing.
981
- #
982
- # @param service [String] Indicates the service performed on the transaction.
983
- end
984
- end
985
-
986
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::NetworkSpecificData#visa
987
- class Visa < Lithic::Internal::Type::BaseModel
988
- # @!attribute business_application_identifier
989
- # Identifies the purpose or category of a transaction, used to classify and
990
- # process transactions according to Visa’s rules.
991
- #
992
- # @return [String, nil]
993
- optional :business_application_identifier, String, nil?: true
994
-
995
- # @!method initialize(business_application_identifier: nil)
996
- # Some parameter documentations has been truncated, see
997
- # {Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::NetworkSpecificData::Visa}
998
- # for more details.
999
- #
1000
- # @param business_application_identifier [String, nil] Identifies the purpose or category of a transaction, used to classify and proces
1001
- end
1002
- end
1003
-
1004
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent#pos
1005
- class Pos < Lithic::Internal::Type::BaseModel
1006
- # @!attribute entry_mode
1007
- # POS > Entry Mode object in ASA
1008
- #
1009
- # @return [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos::EntryMode, nil]
1010
- optional :entry_mode, -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Pos::EntryMode }
1011
-
1012
- # @!attribute terminal
1013
- #
1014
- # @return [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos::Terminal, nil]
1015
- optional :terminal, -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Pos::Terminal }
1016
-
1017
- # @!method initialize(entry_mode: nil, terminal: nil)
1018
- # @param entry_mode [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos::EntryMode] POS > Entry Mode object in ASA
1019
- #
1020
- # @param terminal [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos::Terminal]
1021
-
1022
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos#entry_mode
1023
- class EntryMode < Lithic::Internal::Type::BaseModel
1024
- # @!attribute card
1025
- # Card Presence Indicator
1026
- #
1027
- # @return [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos::EntryMode::Card, nil]
1028
- optional :card, enum: -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Pos::EntryMode::Card }
1029
-
1030
- # @!attribute cardholder
1031
- # Cardholder Presence Indicator
1032
- #
1033
- # @return [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos::EntryMode::Cardholder, nil]
1034
- optional :cardholder,
1035
- enum: -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Pos::EntryMode::Cardholder }
1036
-
1037
- # @!attribute pan
1038
- # Method of entry for the PAN
1039
- #
1040
- # @return [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos::EntryMode::Pan, nil]
1041
- optional :pan, enum: -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Pos::EntryMode::Pan }
1042
-
1043
- # @!attribute pin_entered
1044
- # Indicates whether the cardholder entered the PIN. True if the PIN was entered.
1045
- #
1046
- # @return [Boolean, nil]
1047
- optional :pin_entered, Lithic::Internal::Type::Boolean
1048
-
1049
- # @!method initialize(card: nil, cardholder: nil, pan: nil, pin_entered: nil)
1050
- # POS > Entry Mode object in ASA
1051
- #
1052
- # @param card [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos::EntryMode::Card] Card Presence Indicator
1053
- #
1054
- # @param cardholder [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos::EntryMode::Cardholder] Cardholder Presence Indicator
1055
- #
1056
- # @param pan [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos::EntryMode::Pan] Method of entry for the PAN
1057
- #
1058
- # @param pin_entered [Boolean] Indicates whether the cardholder entered the PIN. True if the PIN was entered.
1059
-
1060
- # Card Presence Indicator
1061
- #
1062
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos::EntryMode#card
1063
- module Card
1064
- extend Lithic::Internal::Type::Enum
1065
-
1066
- PRESENT = :PRESENT
1067
- NOT_PRESENT = :NOT_PRESENT
1068
- UNKNOWN = :UNKNOWN
1069
-
1070
- # @!method self.values
1071
- # @return [Array<Symbol>]
1072
- end
1073
-
1074
- # Cardholder Presence Indicator
1075
- #
1076
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos::EntryMode#cardholder
1077
- module Cardholder
1078
- extend Lithic::Internal::Type::Enum
1079
-
1080
- DEFERRED_BILLING = :DEFERRED_BILLING
1081
- ELECTRONIC_ORDER = :ELECTRONIC_ORDER
1082
- INSTALLMENT = :INSTALLMENT
1083
- MAIL_ORDER = :MAIL_ORDER
1084
- NOT_PRESENT = :NOT_PRESENT
1085
- PRESENT = :PRESENT
1086
- REOCCURRING = :REOCCURRING
1087
- TELEPHONE_ORDER = :TELEPHONE_ORDER
1088
- UNKNOWN = :UNKNOWN
1089
-
1090
- # @!method self.values
1091
- # @return [Array<Symbol>]
1092
- end
1093
-
1094
- # Method of entry for the PAN
1095
- #
1096
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos::EntryMode#pan
1097
- module Pan
1098
- extend Lithic::Internal::Type::Enum
1099
-
1100
- AUTO_ENTRY = :AUTO_ENTRY
1101
- BAR_CODE = :BAR_CODE
1102
- CONTACTLESS = :CONTACTLESS
1103
- ECOMMERCE = :ECOMMERCE
1104
- ERROR_KEYED = :ERROR_KEYED
1105
- ERROR_MAGNETIC_STRIPE = :ERROR_MAGNETIC_STRIPE
1106
- ICC = :ICC
1107
- KEY_ENTERED = :KEY_ENTERED
1108
- MAGNETIC_STRIPE = :MAGNETIC_STRIPE
1109
- MANUAL = :MANUAL
1110
- OCR = :OCR
1111
- SECURE_CARDLESS = :SECURE_CARDLESS
1112
- UNSPECIFIED = :UNSPECIFIED
1113
- UNKNOWN = :UNKNOWN
1114
- CREDENTIAL_ON_FILE = :CREDENTIAL_ON_FILE
1115
-
1116
- # @!method self.values
1117
- # @return [Array<Symbol>]
1118
- end
1119
- end
1120
-
1121
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos#terminal
1122
- class Terminal < Lithic::Internal::Type::BaseModel
1123
- # @!attribute attended
1124
- # True if a clerk is present at the sale.
1125
- #
1126
- # @return [Boolean]
1127
- required :attended, Lithic::Internal::Type::Boolean
1128
-
1129
- # @!attribute card_retention_capable
1130
- # True if the terminal is capable of retaining the card.
1131
- #
1132
- # @return [Boolean]
1133
- required :card_retention_capable, Lithic::Internal::Type::Boolean
1134
-
1135
- # @!attribute on_premise
1136
- # True if the sale was made at the place of business (vs. mobile).
1137
- #
1138
- # @return [Boolean]
1139
- required :on_premise, Lithic::Internal::Type::Boolean
1140
-
1141
- # @!attribute operator
1142
- # The person that is designated to swipe the card
1143
- #
1144
- # @return [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos::Terminal::Operator]
1145
- required :operator,
1146
- enum: -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Pos::Terminal::Operator }
1147
-
1148
- # @!attribute partial_approval_capable
1149
- # True if the terminal is capable of partial approval. Partial approval is when
1150
- # part of a transaction is approved and another payment must be used for the
1151
- # remainder. Example scenario: A $40 transaction is attempted on a prepaid card
1152
- # with a $25 balance. If partial approval is enabled, $25 can be authorized, at
1153
- # which point the POS will prompt the user for an additional payment of $15.
1154
- #
1155
- # @return [Boolean]
1156
- required :partial_approval_capable, Lithic::Internal::Type::Boolean
1157
-
1158
- # @!attribute pin_capability
1159
- # Status of whether the POS is able to accept PINs
1160
- #
1161
- # @return [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos::Terminal::PinCapability]
1162
- required :pin_capability,
1163
- enum: -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Pos::Terminal::PinCapability }
1164
-
1165
- # @!attribute type
1166
- # POS Type
1167
- #
1168
- # @return [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos::Terminal::Type]
1169
- required :type, enum: -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Pos::Terminal::Type }
1170
-
1171
- # @!attribute acceptor_terminal_id
1172
- # Uniquely identifies a terminal at the card acceptor location of acquiring
1173
- # institutions or merchant POS Systems. Left justified with trailing spaces.
1174
- #
1175
- # @return [String, nil]
1176
- optional :acceptor_terminal_id, String, nil?: true
1177
-
1178
- # @!method initialize(attended:, card_retention_capable:, on_premise:, operator:, partial_approval_capable:, pin_capability:, type:, acceptor_terminal_id: nil)
1179
- # Some parameter documentations has been truncated, see
1180
- # {Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos::Terminal}
1181
- # for more details.
1182
- #
1183
- # @param attended [Boolean] True if a clerk is present at the sale.
1184
- #
1185
- # @param card_retention_capable [Boolean] True if the terminal is capable of retaining the card.
1186
- #
1187
- # @param on_premise [Boolean] True if the sale was made at the place of business (vs. mobile).
1188
- #
1189
- # @param operator [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos::Terminal::Operator] The person that is designated to swipe the card
1190
- #
1191
- # @param partial_approval_capable [Boolean] True if the terminal is capable of partial approval. Partial approval is when pa
1192
- #
1193
- # @param pin_capability [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos::Terminal::PinCapability] Status of whether the POS is able to accept PINs
1194
- #
1195
- # @param type [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos::Terminal::Type] POS Type
1196
- #
1197
- # @param acceptor_terminal_id [String, nil] Uniquely identifies a terminal at the card acceptor location of acquiring instit
1198
-
1199
- # The person that is designated to swipe the card
1200
- #
1201
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos::Terminal#operator
1202
- module Operator
1203
- extend Lithic::Internal::Type::Enum
1204
-
1205
- ADMINISTRATIVE = :ADMINISTRATIVE
1206
- CARDHOLDER = :CARDHOLDER
1207
- CARD_ACCEPTOR = :CARD_ACCEPTOR
1208
- UNKNOWN = :UNKNOWN
1209
-
1210
- # @!method self.values
1211
- # @return [Array<Symbol>]
1212
- end
1213
-
1214
- # Status of whether the POS is able to accept PINs
1215
- #
1216
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos::Terminal#pin_capability
1217
- module PinCapability
1218
- extend Lithic::Internal::Type::Enum
1219
-
1220
- CAPABLE = :CAPABLE
1221
- INOPERATIVE = :INOPERATIVE
1222
- NOT_CAPABLE = :NOT_CAPABLE
1223
- UNSPECIFIED = :UNSPECIFIED
1224
-
1225
- # @!method self.values
1226
- # @return [Array<Symbol>]
1227
- end
1228
-
1229
- # POS Type
1230
- #
1231
- # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Pos::Terminal#type
1232
- module Type
1233
- extend Lithic::Internal::Type::Enum
1234
-
1235
- ADMINISTRATIVE = :ADMINISTRATIVE
1236
- ATM = :ATM
1237
- AUTHORIZATION = :AUTHORIZATION
1238
- COUPON_MACHINE = :COUPON_MACHINE
1239
- DIAL_TERMINAL = :DIAL_TERMINAL
1240
- ECOMMERCE = :ECOMMERCE
1241
- ECR = :ECR
1242
- FUEL_MACHINE = :FUEL_MACHINE
1243
- HOME_TERMINAL = :HOME_TERMINAL
1244
- MICR = :MICR
1245
- OFF_PREMISE = :OFF_PREMISE
1246
- PAYMENT = :PAYMENT
1247
- PDA = :PDA
1248
- PHONE = :PHONE
1249
- POINT = :POINT
1250
- POS_TERMINAL = :POS_TERMINAL
1251
- PUBLIC_UTILITY = :PUBLIC_UTILITY
1252
- SELF_SERVICE = :SELF_SERVICE
1253
- TELEVISION = :TELEVISION
1254
- TELLER = :TELLER
1255
- TRAVELERS_CHECK_MACHINE = :TRAVELERS_CHECK_MACHINE
1256
- VENDING = :VENDING
1257
- VOICE = :VOICE
1258
- UNKNOWN = :UNKNOWN
1259
-
1260
- # @!method self.values
1261
- # @return [Array<Symbol>]
1262
- end
1263
- end
1264
- end
1265
15
  end
1266
16
  end
1267
17
  end