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