increase 1.340.0 → 1.341.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 (306) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/client.rb +8 -6
  4. data/lib/increase/internal/type/converter.rb +13 -12
  5. data/lib/increase/models/account.rb +40 -19
  6. data/lib/increase/models/account_create_params.rb +14 -11
  7. data/lib/increase/models/account_list_params.rb +25 -17
  8. data/lib/increase/models/account_number.rb +22 -14
  9. data/lib/increase/models/account_number_create_params.rb +12 -13
  10. data/lib/increase/models/account_number_list_params.rb +26 -20
  11. data/lib/increase/models/account_number_update_params.rb +12 -11
  12. data/lib/increase/models/account_statement.rb +15 -11
  13. data/lib/increase/models/account_statement_list_params.rb +15 -12
  14. data/lib/increase/models/account_transfer.rb +58 -29
  15. data/lib/increase/models/account_transfer_create_params.rb +12 -7
  16. data/lib/increase/models/account_transfer_list_params.rb +20 -12
  17. data/lib/increase/models/ach_prenotification.rb +48 -27
  18. data/lib/increase/models/ach_prenotification_create_params.rb +15 -8
  19. data/lib/increase/models/ach_prenotification_list_params.rb +20 -12
  20. data/lib/increase/models/ach_transfer.rb +199 -103
  21. data/lib/increase/models/ach_transfer_create_params.rb +110 -61
  22. data/lib/increase/models/ach_transfer_list_params.rb +23 -16
  23. data/lib/increase/models/balance_lookup.rb +14 -11
  24. data/lib/increase/models/beneficial_owner_create_params.rb +48 -37
  25. data/lib/increase/models/beneficial_owner_list_params.rb +11 -6
  26. data/lib/increase/models/beneficial_owner_update_params.rb +44 -31
  27. data/lib/increase/models/card.rb +69 -47
  28. data/lib/increase/models/card_create_details_iframe_params.rb +3 -4
  29. data/lib/increase/models/card_create_params.rb +65 -56
  30. data/lib/increase/models/card_details.rb +7 -5
  31. data/lib/increase/models/card_dispute.rb +530 -306
  32. data/lib/increase/models/card_dispute_create_params.rb +271 -175
  33. data/lib/increase/models/card_dispute_list_params.rb +24 -16
  34. data/lib/increase/models/card_dispute_submit_user_submission_params.rb +288 -191
  35. data/lib/increase/models/card_iframe_url.rb +3 -4
  36. data/lib/increase/models/card_list_params.rb +23 -16
  37. data/lib/increase/models/card_payment.rb +1941 -1200
  38. data/lib/increase/models/card_payment_list_params.rb +15 -11
  39. data/lib/increase/models/card_purchase_supplement.rb +37 -25
  40. data/lib/increase/models/card_purchase_supplement_list_params.rb +18 -13
  41. data/lib/increase/models/card_push_transfer.rb +121 -65
  42. data/lib/increase/models/card_push_transfer_create_params.rb +55 -25
  43. data/lib/increase/models/card_push_transfer_list_params.rb +23 -16
  44. data/lib/increase/models/card_token.rb +9 -6
  45. data/lib/increase/models/card_token_capabilities.rb +11 -8
  46. data/lib/increase/models/card_token_list_params.rb +15 -11
  47. data/lib/increase/models/card_update_params.rb +65 -57
  48. data/lib/increase/models/card_validation.rb +76 -43
  49. data/lib/increase/models/card_validation_create_params.rb +11 -7
  50. data/lib/increase/models/card_validation_list_params.rb +23 -16
  51. data/lib/increase/models/check_deposit.rb +103 -52
  52. data/lib/increase/models/check_deposit_create_params.rb +2 -4
  53. data/lib/increase/models/check_deposit_list_params.rb +20 -12
  54. data/lib/increase/models/check_transfer.rb +124 -75
  55. data/lib/increase/models/check_transfer_create_params.rb +91 -51
  56. data/lib/increase/models/check_transfer_list_params.rb +24 -16
  57. data/lib/increase/models/check_transfer_stop_payment_params.rb +2 -1
  58. data/lib/increase/models/declined_transaction.rb +339 -206
  59. data/lib/increase/models/declined_transaction_list_params.rb +18 -15
  60. data/lib/increase/models/digital_card_profile.rb +16 -9
  61. data/lib/increase/models/digital_card_profile_clone_params.rb +2 -1
  62. data/lib/increase/models/digital_card_profile_create_params.rb +2 -1
  63. data/lib/increase/models/digital_card_profile_list_params.rb +12 -9
  64. data/lib/increase/models/digital_wallet_token.rb +26 -17
  65. data/lib/increase/models/digital_wallet_token_list_params.rb +15 -11
  66. data/lib/increase/models/entity.rb +175 -135
  67. data/lib/increase/models/entity_archive_params.rb +3 -4
  68. data/lib/increase/models/entity_beneficial_owner.rb +24 -19
  69. data/lib/increase/models/entity_create_params.rb +323 -236
  70. data/lib/increase/models/entity_list_params.rb +67 -16
  71. data/lib/increase/models/entity_onboarding_session.rb +25 -11
  72. data/lib/increase/models/entity_onboarding_session_create_params.rb +8 -5
  73. data/lib/increase/models/entity_onboarding_session_list_params.rb +12 -9
  74. data/lib/increase/models/entity_supplemental_document.rb +10 -6
  75. data/lib/increase/models/entity_update_params.rb +112 -86
  76. data/lib/increase/models/event.rb +6 -5
  77. data/lib/increase/models/event_list_params.rb +23 -17
  78. data/lib/increase/models/event_subscription.rb +17 -9
  79. data/lib/increase/models/event_subscription_create_params.rb +14 -8
  80. data/lib/increase/models/event_subscription_list_params.rb +8 -5
  81. data/lib/increase/models/event_subscription_update_params.rb +2 -1
  82. data/lib/increase/models/export.rb +69 -30
  83. data/lib/increase/models/export_create_params.rb +76 -46
  84. data/lib/increase/models/export_list_params.rb +26 -17
  85. data/lib/increase/models/external_account.rb +14 -8
  86. data/lib/increase/models/external_account_create_params.rb +7 -6
  87. data/lib/increase/models/external_account_list_params.rb +12 -9
  88. data/lib/increase/models/external_account_update_params.rb +6 -3
  89. data/lib/increase/models/fednow_transfer.rb +62 -32
  90. data/lib/increase/models/fednow_transfer_create_params.rb +11 -8
  91. data/lib/increase/models/fednow_transfer_list_params.rb +25 -17
  92. data/lib/increase/models/file.rb +13 -7
  93. data/lib/increase/models/file_create_params.rb +6 -5
  94. data/lib/increase/models/file_link.rb +17 -8
  95. data/lib/increase/models/file_link_create_params.rb +3 -4
  96. data/lib/increase/models/file_list_params.rb +23 -16
  97. data/lib/increase/models/group.rb +6 -5
  98. data/lib/increase/models/inbound_ach_transfer.rb +115 -51
  99. data/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rb +3 -5
  100. data/lib/increase/models/inbound_ach_transfer_decline_params.rb +4 -4
  101. data/lib/increase/models/inbound_ach_transfer_list_params.rb +21 -16
  102. data/lib/increase/models/inbound_ach_transfer_transfer_return_params.rb +6 -5
  103. data/lib/increase/models/inbound_check_deposit.rb +46 -19
  104. data/lib/increase/models/inbound_check_deposit_list_params.rb +18 -12
  105. data/lib/increase/models/inbound_check_deposit_return_params.rb +2 -1
  106. data/lib/increase/models/inbound_fednow_transfer.rb +28 -14
  107. data/lib/increase/models/inbound_fednow_transfer_list_params.rb +18 -12
  108. data/lib/increase/models/inbound_fednow_transfer_retrieve_params.rb +2 -1
  109. data/lib/increase/models/inbound_mail_item.rb +13 -8
  110. data/lib/increase/models/inbound_mail_item_action_params.rb +4 -2
  111. data/lib/increase/models/inbound_mail_item_list_params.rb +17 -12
  112. data/lib/increase/models/inbound_real_time_payments_transfer.rb +21 -12
  113. data/lib/increase/models/inbound_real_time_payments_transfer_list_params.rb +21 -14
  114. data/lib/increase/models/inbound_real_time_payments_transfer_retrieve_params.rb +2 -1
  115. data/lib/increase/models/inbound_wire_drawdown_request.rb +23 -10
  116. data/lib/increase/models/inbound_wire_drawdown_request_list_params.rb +3 -4
  117. data/lib/increase/models/inbound_wire_drawdown_request_retrieve_params.rb +2 -1
  118. data/lib/increase/models/inbound_wire_transfer.rb +33 -21
  119. data/lib/increase/models/inbound_wire_transfer_list_params.rb +24 -17
  120. data/lib/increase/models/inbound_wire_transfer_reverse_params.rb +2 -1
  121. data/lib/increase/models/intrafi_account_enrollment.rb +16 -8
  122. data/lib/increase/models/intrafi_account_enrollment_list_params.rb +12 -9
  123. data/lib/increase/models/intrafi_account_enrollment_retrieve_params.rb +2 -1
  124. data/lib/increase/models/intrafi_account_enrollment_unenroll_params.rb +2 -1
  125. data/lib/increase/models/intrafi_balance.rb +18 -12
  126. data/lib/increase/models/intrafi_exclusion.rb +13 -7
  127. data/lib/increase/models/intrafi_exclusion_archive_params.rb +4 -4
  128. data/lib/increase/models/intrafi_exclusion_create_params.rb +5 -4
  129. data/lib/increase/models/intrafi_exclusion_list_params.rb +8 -5
  130. data/lib/increase/models/lockbox_address.rb +16 -11
  131. data/lib/increase/models/lockbox_address_list_params.rb +20 -12
  132. data/lib/increase/models/lockbox_address_update_params.rb +2 -1
  133. data/lib/increase/models/lockbox_recipient.rb +22 -10
  134. data/lib/increase/models/lockbox_recipient_create_params.rb +5 -5
  135. data/lib/increase/models/lockbox_recipient_list_params.rb +22 -13
  136. data/lib/increase/models/lockbox_recipient_update_params.rb +2 -1
  137. data/lib/increase/models/oauth_application.rb +12 -7
  138. data/lib/increase/models/oauth_application_list_params.rb +18 -15
  139. data/lib/increase/models/oauth_connection.rb +9 -6
  140. data/lib/increase/models/oauth_connection_list_params.rb +10 -9
  141. data/lib/increase/models/oauth_token.rb +6 -5
  142. data/lib/increase/models/oauth_token_create_params.rb +14 -7
  143. data/lib/increase/models/pending_transaction.rb +392 -239
  144. data/lib/increase/models/pending_transaction_create_params.rb +6 -6
  145. data/lib/increase/models/pending_transaction_list_params.rb +23 -19
  146. data/lib/increase/models/physical_card.rb +36 -24
  147. data/lib/increase/models/physical_card_create_params.rb +22 -17
  148. data/lib/increase/models/physical_card_list_params.rb +20 -12
  149. data/lib/increase/models/physical_card_profile.rb +33 -17
  150. data/lib/increase/models/physical_card_profile_clone_params.rb +9 -9
  151. data/lib/increase/models/physical_card_profile_create_params.rb +9 -9
  152. data/lib/increase/models/physical_card_profile_list_params.rb +12 -9
  153. data/lib/increase/models/physical_card_update_params.rb +2 -1
  154. data/lib/increase/models/program.rb +15 -8
  155. data/lib/increase/models/program_list_params.rb +3 -4
  156. data/lib/increase/models/real_time_decision.rb +561 -370
  157. data/lib/increase/models/real_time_decision_action_params.rb +86 -75
  158. data/lib/increase/models/real_time_payments_transfer.rb +90 -47
  159. data/lib/increase/models/real_time_payments_transfer_approve_params.rb +2 -1
  160. data/lib/increase/models/real_time_payments_transfer_cancel_params.rb +2 -1
  161. data/lib/increase/models/real_time_payments_transfer_create_params.rb +24 -12
  162. data/lib/increase/models/real_time_payments_transfer_list_params.rb +28 -19
  163. data/lib/increase/models/routing_number_list_params.rb +3 -4
  164. data/lib/increase/models/routing_number_list_response.rb +11 -8
  165. data/lib/increase/models/simulations/account_revenue_payment_create_params.rb +9 -7
  166. data/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb +5 -6
  167. data/lib/increase/models/simulations/ach_transfer_return_params.rb +3 -4
  168. data/lib/increase/models/simulations/ach_transfer_settle_params.rb +4 -4
  169. data/lib/increase/models/simulations/card_authentication_create_params.rb +10 -8
  170. data/lib/increase/models/simulations/card_authorization_create_params.rb +50 -27
  171. data/lib/increase/models/simulations/card_authorization_create_response.rb +11 -7
  172. data/lib/increase/models/simulations/card_balance_inquiry_create_params.rb +26 -13
  173. data/lib/increase/models/simulations/card_dispute_action_params.rb +39 -19
  174. data/lib/increase/models/simulations/card_fuel_confirmation_create_params.rb +3 -5
  175. data/lib/increase/models/simulations/card_increment_create_params.rb +5 -4
  176. data/lib/increase/models/simulations/card_purchase_supplement_create_params.rb +7 -7
  177. data/lib/increase/models/simulations/card_refund_create_params.rb +10 -6
  178. data/lib/increase/models/simulations/card_reversal_create_params.rb +3 -4
  179. data/lib/increase/models/simulations/card_settlement_create_params.rb +6 -5
  180. data/lib/increase/models/simulations/card_token_create_params.rb +18 -9
  181. data/lib/increase/models/simulations/check_deposit_adjustment_params.rb +8 -5
  182. data/lib/increase/models/simulations/check_deposit_submit_params.rb +9 -10
  183. data/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb +9 -7
  184. data/lib/increase/models/simulations/entity_onboarding_session_submit_params.rb +2 -1
  185. data/lib/increase/models/simulations/entity_update_validation_params.rb +5 -5
  186. data/lib/increase/models/simulations/export_create_params.rb +5 -5
  187. data/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb +20 -12
  188. data/lib/increase/models/simulations/inbound_check_deposit_adjustment_params.rb +5 -6
  189. data/lib/increase/models/simulations/inbound_check_deposit_create_params.rb +6 -6
  190. data/lib/increase/models/simulations/inbound_mail_item_create_params.rb +9 -6
  191. data/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rb +5 -6
  192. data/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rb +27 -13
  193. data/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb +45 -19
  194. data/lib/increase/models/simulations/interest_payment_create_params.rb +4 -5
  195. data/lib/increase/models/simulations/pending_transaction_release_inbound_funds_hold_params.rb +3 -5
  196. data/lib/increase/models/simulations/physical_card_advance_shipment_params.rb +2 -1
  197. data/lib/increase/models/simulations/physical_card_create_params.rb +5 -5
  198. data/lib/increase/models/simulations/program_create_params.rb +4 -2
  199. data/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb +6 -3
  200. data/lib/increase/models/supplemental_document_list_params.rb +8 -5
  201. data/lib/increase/models/swift_transfer.rb +48 -26
  202. data/lib/increase/models/swift_transfer_create_params.rb +28 -19
  203. data/lib/increase/models/swift_transfer_list_params.rb +23 -16
  204. data/lib/increase/models/transaction.rb +995 -534
  205. data/lib/increase/models/transaction_list_params.rb +21 -16
  206. data/lib/increase/models/unwrap_webhook_event.rb +6 -5
  207. data/lib/increase/models/wire_drawdown_request.rb +44 -26
  208. data/lib/increase/models/wire_drawdown_request_create_params.rb +23 -19
  209. data/lib/increase/models/wire_drawdown_request_list_params.rb +12 -9
  210. data/lib/increase/models/wire_transfer.rb +100 -55
  211. data/lib/increase/models/wire_transfer_create_params.rb +43 -26
  212. data/lib/increase/models/wire_transfer_list_params.rb +23 -16
  213. data/lib/increase/resources/account_numbers.rb +20 -16
  214. data/lib/increase/resources/account_statements.rb +3 -4
  215. data/lib/increase/resources/account_transfers.rb +20 -12
  216. data/lib/increase/resources/accounts.rb +19 -12
  217. data/lib/increase/resources/ach_prenotifications.rb +23 -13
  218. data/lib/increase/resources/ach_transfers.rb +93 -43
  219. data/lib/increase/resources/beneficial_owners.rb +35 -19
  220. data/lib/increase/resources/card_disputes.rb +43 -22
  221. data/lib/increase/resources/card_payments.rb +3 -4
  222. data/lib/increase/resources/card_purchase_supplements.rb +6 -5
  223. data/lib/increase/resources/card_push_transfers.rb +55 -24
  224. data/lib/increase/resources/card_tokens.rb +3 -4
  225. data/lib/increase/resources/card_validations.rb +19 -12
  226. data/lib/increase/resources/cards.rb +33 -22
  227. data/lib/increase/resources/check_deposits.rb +10 -9
  228. data/lib/increase/resources/check_transfers.rb +37 -17
  229. data/lib/increase/resources/declined_transactions.rb +3 -4
  230. data/lib/increase/resources/digital_card_profiles.rb +12 -7
  231. data/lib/increase/resources/digital_wallet_tokens.rb +3 -4
  232. data/lib/increase/resources/entities.rb +69 -33
  233. data/lib/increase/resources/entity_onboarding_sessions.rb +16 -10
  234. data/lib/increase/resources/event_subscriptions.rb +22 -13
  235. data/lib/increase/resources/events.rb +10 -9
  236. data/lib/increase/resources/exports.rb +40 -22
  237. data/lib/increase/resources/external_accounts.rb +21 -14
  238. data/lib/increase/resources/fednow_transfers.rb +21 -14
  239. data/lib/increase/resources/file_links.rb +3 -4
  240. data/lib/increase/resources/files.rb +14 -10
  241. data/lib/increase/resources/inbound_ach_transfers.rb +18 -19
  242. data/lib/increase/resources/inbound_check_deposits.rb +8 -6
  243. data/lib/increase/resources/inbound_fednow_transfers.rb +8 -6
  244. data/lib/increase/resources/inbound_mail_items.rb +7 -6
  245. data/lib/increase/resources/inbound_real_time_payments_transfers.rb +11 -7
  246. data/lib/increase/resources/inbound_wire_drawdown_requests.rb +5 -5
  247. data/lib/increase/resources/inbound_wire_transfers.rb +10 -7
  248. data/lib/increase/resources/intrafi_account_enrollments.rb +12 -7
  249. data/lib/increase/resources/intrafi_exclusions.rb +17 -13
  250. data/lib/increase/resources/lockbox_addresses.rb +10 -6
  251. data/lib/increase/resources/lockbox_recipients.rb +17 -12
  252. data/lib/increase/resources/oauth_applications.rb +3 -4
  253. data/lib/increase/resources/oauth_connections.rb +6 -5
  254. data/lib/increase/resources/oauth_tokens.rb +14 -7
  255. data/lib/increase/resources/pending_transactions.rb +7 -8
  256. data/lib/increase/resources/physical_card_profiles.rb +18 -15
  257. data/lib/increase/resources/physical_cards.rb +17 -12
  258. data/lib/increase/resources/programs.rb +3 -4
  259. data/lib/increase/resources/real_time_decisions.rb +18 -9
  260. data/lib/increase/resources/real_time_payments_transfers.rb +41 -21
  261. data/lib/increase/resources/routing_numbers.rb +3 -4
  262. data/lib/increase/resources/simulations/account_revenue_payments.rb +9 -7
  263. data/lib/increase/resources/simulations/ach_transfers.rb +12 -14
  264. data/lib/increase/resources/simulations/card_authentications.rb +10 -8
  265. data/lib/increase/resources/simulations/card_authorizations.rb +28 -12
  266. data/lib/increase/resources/simulations/card_balance_inquiries.rb +22 -11
  267. data/lib/increase/resources/simulations/card_disputes.rb +6 -5
  268. data/lib/increase/resources/simulations/card_fuel_confirmations.rb +3 -5
  269. data/lib/increase/resources/simulations/card_increments.rb +5 -4
  270. data/lib/increase/resources/simulations/card_purchase_supplements.rb +7 -7
  271. data/lib/increase/resources/simulations/card_refunds.rb +10 -6
  272. data/lib/increase/resources/simulations/card_reversals.rb +3 -4
  273. data/lib/increase/resources/simulations/card_settlements.rb +6 -5
  274. data/lib/increase/resources/simulations/card_tokens.rb +6 -3
  275. data/lib/increase/resources/simulations/check_deposits.rb +11 -9
  276. data/lib/increase/resources/simulations/entities.rb +3 -4
  277. data/lib/increase/resources/simulations/entity_onboarding_sessions.rb +2 -1
  278. data/lib/increase/resources/simulations/exports.rb +5 -5
  279. data/lib/increase/resources/simulations/inbound_ach_transfers.rb +14 -9
  280. data/lib/increase/resources/simulations/inbound_check_deposits.rb +11 -12
  281. data/lib/increase/resources/simulations/inbound_mail_items.rb +9 -6
  282. data/lib/increase/resources/simulations/inbound_real_time_payments_transfers.rb +5 -6
  283. data/lib/increase/resources/simulations/inbound_wire_drawdown_requests.rb +27 -13
  284. data/lib/increase/resources/simulations/inbound_wire_transfers.rb +45 -19
  285. data/lib/increase/resources/simulations/interest_payments.rb +4 -5
  286. data/lib/increase/resources/simulations/pending_transactions.rb +3 -5
  287. data/lib/increase/resources/simulations/physical_cards.rb +7 -6
  288. data/lib/increase/resources/simulations/programs.rb +4 -2
  289. data/lib/increase/resources/simulations/real_time_payments_transfers.rb +4 -2
  290. data/lib/increase/resources/supplemental_documents.rb +8 -5
  291. data/lib/increase/resources/swift_transfers.rb +28 -16
  292. data/lib/increase/resources/transactions.rb +6 -5
  293. data/lib/increase/resources/wire_drawdown_requests.rb +23 -14
  294. data/lib/increase/resources/wire_transfers.rb +29 -16
  295. data/lib/increase/version.rb +1 -1
  296. data/rbi/increase/models/check_transfer.rbi +8 -0
  297. data/rbi/increase/models/check_transfer_create_params.rbi +35 -36
  298. data/rbi/increase/models/entity_list_params.rbi +119 -0
  299. data/rbi/increase/models/pending_transaction_create_params.rbi +4 -4
  300. data/rbi/increase/resources/entities.rbi +3 -0
  301. data/rbi/increase/resources/pending_transactions.rbi +2 -2
  302. data/sig/increase/models/check_transfer.rbs +5 -0
  303. data/sig/increase/models/check_transfer_create_params.rbs +12 -9
  304. data/sig/increase/models/entity_list_params.rbs +48 -1
  305. data/sig/increase/resources/entities.rbs +1 -0
  306. metadata +2 -2
@@ -84,9 +84,6 @@ module Increase
84
84
  required :type, enum: -> { Increase::RealTimeDecision::Type }
85
85
 
86
86
  # @!method initialize(id:, card_authentication:, card_authentication_challenge:, card_authorization:, card_balance_inquiry:, category:, created_at:, digital_wallet_authentication:, digital_wallet_token:, status:, timeout_at:, type:)
87
- # Some parameter documentations has been truncated, see
88
- # {Increase::Models::RealTimeDecision} for more details.
89
- #
90
87
  # Real Time Decisions are created when your application needs to take action in
91
88
  # real-time to some event such as a card authorization. For more information, see
92
89
  # our
@@ -94,27 +91,40 @@ module Increase
94
91
  #
95
92
  # @param id [String] The Real-Time Decision identifier.
96
93
  #
97
- # @param card_authentication [Increase::Models::RealTimeDecision::CardAuthentication, nil] Fields related to a 3DS authentication attempt.
94
+ # @param card_authentication [Increase::Models::RealTimeDecision::CardAuthentication, nil]
95
+ # Fields related to a 3DS authentication attempt.
98
96
  #
99
- # @param card_authentication_challenge [Increase::Models::RealTimeDecision::CardAuthenticationChallenge, nil] Fields related to a 3DS authentication attempt.
97
+ # @param card_authentication_challenge [Increase::Models::RealTimeDecision::CardAuthenticationChallenge, nil]
98
+ # Fields related to a 3DS authentication attempt.
100
99
  #
101
- # @param card_authorization [Increase::Models::RealTimeDecision::CardAuthorization, nil] Fields related to a card authorization.
100
+ # @param card_authorization [Increase::Models::RealTimeDecision::CardAuthorization, nil]
101
+ # Fields related to a card authorization.
102
102
  #
103
- # @param card_balance_inquiry [Increase::Models::RealTimeDecision::CardBalanceInquiry, nil] Fields related to a card balance inquiry.
103
+ # @param card_balance_inquiry [Increase::Models::RealTimeDecision::CardBalanceInquiry, nil]
104
+ # Fields related to a card balance inquiry.
104
105
  #
105
- # @param category [Symbol, Increase::Models::RealTimeDecision::Category] The category of the Real-Time Decision.
106
+ # @param category [Symbol, Increase::Models::RealTimeDecision::Category]
107
+ # The category of the Real-Time Decision.
106
108
  #
107
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
109
+ # @param created_at [Time]
110
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
111
+ # the Real-Time Decision was created.
108
112
  #
109
- # @param digital_wallet_authentication [Increase::Models::RealTimeDecision::DigitalWalletAuthentication, nil] Fields related to a digital wallet authentication attempt.
113
+ # @param digital_wallet_authentication [Increase::Models::RealTimeDecision::DigitalWalletAuthentication, nil]
114
+ # Fields related to a digital wallet authentication attempt.
110
115
  #
111
- # @param digital_wallet_token [Increase::Models::RealTimeDecision::DigitalWalletToken, nil] Fields related to a digital wallet token provisioning attempt.
116
+ # @param digital_wallet_token [Increase::Models::RealTimeDecision::DigitalWalletToken, nil]
117
+ # Fields related to a digital wallet token provisioning attempt.
112
118
  #
113
119
  # @param status [Symbol, Increase::Models::RealTimeDecision::Status] The status of the Real-Time Decision.
114
120
  #
115
- # @param timeout_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which yo
121
+ # @param timeout_at [Time]
122
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
123
+ # your application can no longer respond to the Real-Time Decision.
116
124
  #
117
- # @param type [Symbol, Increase::Models::RealTimeDecision::Type] A constant representing the object's type. For this resource it will always be `
125
+ # @param type [Symbol, Increase::Models::RealTimeDecision::Type]
126
+ # A constant representing the object's type. For this resource it will always be
127
+ # `real_time_decision`.
118
128
 
119
129
  # @see Increase::Models::RealTimeDecision#card_authentication
120
130
  class CardAuthentication < Increase::Internal::Type::BaseModel
@@ -344,28 +354,41 @@ module Increase
344
354
  required :upcoming_card_payment_id, String
345
355
 
346
356
  # @!method initialize(access_control_server_transaction_identifier:, account_id:, billing_address_city:, billing_address_country:, billing_address_line1:, billing_address_line2:, billing_address_line3:, billing_address_postal_code:, billing_address_state:, card_id:, cardholder_email:, cardholder_name:, decision:, device_channel:, directory_server_transaction_identifier:, merchant_acceptor_id:, merchant_category_code:, merchant_country:, merchant_name:, message_category:, prior_authenticated_card_payment_id:, requestor_authentication_indicator:, requestor_challenge_indicator:, requestor_name:, requestor_url:, shipping_address_city:, shipping_address_country:, shipping_address_line1:, shipping_address_line2:, shipping_address_line3:, shipping_address_postal_code:, shipping_address_state:, three_d_secure_server_transaction_identifier:, upcoming_card_payment_id:)
347
- # Some parameter documentations has been truncated, see
348
- # {Increase::Models::RealTimeDecision::CardAuthentication} for more details.
349
- #
350
357
  # Fields related to a 3DS authentication attempt.
351
358
  #
352
- # @param access_control_server_transaction_identifier [String] A unique identifier assigned by the Access Control Server (us) for this transact
359
+ # @param access_control_server_transaction_identifier [String]
360
+ # A unique identifier assigned by the Access Control Server (us) for this
361
+ # transaction.
353
362
  #
354
363
  # @param account_id [String] The identifier of the Account the card belongs to.
355
364
  #
356
- # @param billing_address_city [String, nil] The city of the cardholder billing address associated with the card used for thi
365
+ # @param billing_address_city [String, nil]
366
+ # The city of the cardholder billing address associated with the card used for
367
+ # this purchase.
357
368
  #
358
- # @param billing_address_country [String, nil] The country of the cardholder billing address associated with the card used for
369
+ # @param billing_address_country [String, nil]
370
+ # The country of the cardholder billing address associated with the card used for
371
+ # this purchase.
359
372
  #
360
- # @param billing_address_line1 [String, nil] The first line of the cardholder billing address associated with the card used f
373
+ # @param billing_address_line1 [String, nil]
374
+ # The first line of the cardholder billing address associated with the card used
375
+ # for this purchase.
361
376
  #
362
- # @param billing_address_line2 [String, nil] The second line of the cardholder billing address associated with the card used
377
+ # @param billing_address_line2 [String, nil]
378
+ # The second line of the cardholder billing address associated with the card used
379
+ # for this purchase.
363
380
  #
364
- # @param billing_address_line3 [String, nil] The third line of the cardholder billing address associated with the card used f
381
+ # @param billing_address_line3 [String, nil]
382
+ # The third line of the cardholder billing address associated with the card used
383
+ # for this purchase.
365
384
  #
366
- # @param billing_address_postal_code [String, nil] The postal code of the cardholder billing address associated with the card used
385
+ # @param billing_address_postal_code [String, nil]
386
+ # The postal code of the cardholder billing address associated with the card used
387
+ # for this purchase.
367
388
  #
368
- # @param billing_address_state [String, nil] The US state of the cardholder billing address associated with the card used for
389
+ # @param billing_address_state [String, nil]
390
+ # The US state of the cardholder billing address associated with the card used for
391
+ # this purchase.
369
392
  #
370
393
  # @param card_id [String] The identifier of the Card.
371
394
  #
@@ -373,27 +396,41 @@ module Increase
373
396
  #
374
397
  # @param cardholder_name [String, nil] The name of the cardholder.
375
398
  #
376
- # @param decision [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::Decision, nil] Whether or not the authentication attempt was approved.
399
+ # @param decision [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::Decision, nil]
400
+ # Whether or not the authentication attempt was approved.
377
401
  #
378
- # @param device_channel [Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel] The device channel of the card authentication attempt.
402
+ # @param device_channel [Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel]
403
+ # The device channel of the card authentication attempt.
379
404
  #
380
- # @param directory_server_transaction_identifier [String] A unique identifier assigned by the Directory Server (the card network) for this
405
+ # @param directory_server_transaction_identifier [String]
406
+ # A unique identifier assigned by the Directory Server (the card network) for this
407
+ # transaction.
381
408
  #
382
- # @param merchant_acceptor_id [String, nil] The merchant identifier (commonly abbreviated as MID) of the merchant the card i
409
+ # @param merchant_acceptor_id [String, nil]
410
+ # The merchant identifier (commonly abbreviated as MID) of the merchant the card
411
+ # is transacting with.
383
412
  #
384
- # @param merchant_category_code [String, nil] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car
413
+ # @param merchant_category_code [String, nil]
414
+ # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
415
+ # card is transacting with.
385
416
  #
386
417
  # @param merchant_country [String, nil] The country the merchant resides in.
387
418
  #
388
419
  # @param merchant_name [String, nil] The name of the merchant.
389
420
  #
390
- # @param message_category [Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory] The message category of the card authentication attempt.
421
+ # @param message_category [Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory]
422
+ # The message category of the card authentication attempt.
391
423
  #
392
- # @param prior_authenticated_card_payment_id [String, nil] The ID of a prior Card Authentication that the requestor used to authenticate th
424
+ # @param prior_authenticated_card_payment_id [String, nil]
425
+ # The ID of a prior Card Authentication that the requestor used to authenticate
426
+ # this cardholder for a previous transaction.
393
427
  #
394
- # @param requestor_authentication_indicator [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::RequestorAuthenticationIndicator, nil] The 3DS requestor authentication indicator describes why the authentication atte
428
+ # @param requestor_authentication_indicator [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::RequestorAuthenticationIndicator, nil]
429
+ # The 3DS requestor authentication indicator describes why the authentication
430
+ # attempt is performed, such as for a recurring transaction.
395
431
  #
396
- # @param requestor_challenge_indicator [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::RequestorChallengeIndicator, nil] Indicates whether a challenge is requested for this transaction.
432
+ # @param requestor_challenge_indicator [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::RequestorChallengeIndicator, nil]
433
+ # Indicates whether a challenge is requested for this transaction.
397
434
  #
398
435
  # @param requestor_name [String] The name of the 3DS requestor.
399
436
  #
@@ -401,21 +438,31 @@ module Increase
401
438
  #
402
439
  # @param shipping_address_city [String, nil] The city of the shipping address associated with this purchase.
403
440
  #
404
- # @param shipping_address_country [String, nil] The country of the shipping address associated with this purchase.
441
+ # @param shipping_address_country [String, nil]
442
+ # The country of the shipping address associated with this purchase.
405
443
  #
406
- # @param shipping_address_line1 [String, nil] The first line of the shipping address associated with this purchase.
444
+ # @param shipping_address_line1 [String, nil]
445
+ # The first line of the shipping address associated with this purchase.
407
446
  #
408
- # @param shipping_address_line2 [String, nil] The second line of the shipping address associated with this purchase.
447
+ # @param shipping_address_line2 [String, nil]
448
+ # The second line of the shipping address associated with this purchase.
409
449
  #
410
- # @param shipping_address_line3 [String, nil] The third line of the shipping address associated with this purchase.
450
+ # @param shipping_address_line3 [String, nil]
451
+ # The third line of the shipping address associated with this purchase.
411
452
  #
412
- # @param shipping_address_postal_code [String, nil] The postal code of the shipping address associated with this purchase.
453
+ # @param shipping_address_postal_code [String, nil]
454
+ # The postal code of the shipping address associated with this purchase.
413
455
  #
414
- # @param shipping_address_state [String, nil] The US state of the shipping address associated with this purchase.
456
+ # @param shipping_address_state [String, nil]
457
+ # The US state of the shipping address associated with this purchase.
415
458
  #
416
- # @param three_d_secure_server_transaction_identifier [String] A unique identifier assigned by the 3DS Server initiating the authentication att
459
+ # @param three_d_secure_server_transaction_identifier [String]
460
+ # A unique identifier assigned by the 3DS Server initiating the authentication
461
+ # attempt for this transaction.
417
462
  #
418
- # @param upcoming_card_payment_id [String] The identifier of the Card Payment this authentication attempt will belong to. A
463
+ # @param upcoming_card_payment_id [String]
464
+ # The identifier of the Card Payment this authentication attempt will belong to.
465
+ # Available in the API once the card authentication has completed.
419
466
 
420
467
  # Whether or not the authentication attempt was approved.
421
468
  #
@@ -463,11 +510,14 @@ module Increase
463
510
  # @!method initialize(browser:, category:, merchant_initiated:)
464
511
  # The device channel of the card authentication attempt.
465
512
  #
466
- # @param browser [Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel::Browser, nil] Fields specific to the browser device channel.
513
+ # @param browser [Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel::Browser, nil]
514
+ # Fields specific to the browser device channel.
467
515
  #
468
- # @param category [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel::Category] The category of the device channel.
516
+ # @param category [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel::Category]
517
+ # The category of the device channel.
469
518
  #
470
- # @param merchant_initiated [Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated, nil] Fields specific to merchant initiated transactions.
519
+ # @param merchant_initiated [Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated, nil]
520
+ # Fields specific to merchant initiated transactions.
471
521
 
472
522
  # @see Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel#browser
473
523
  class Browser < Increase::Internal::Type::BaseModel
@@ -512,7 +562,8 @@ module Increase
512
562
  #
513
563
  # @param ip_address [String, nil] The IP address of the cardholder's browser.
514
564
  #
515
- # @param javascript_enabled [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel::Browser::JavascriptEnabled, nil] Whether JavaScript is enabled in the cardholder's browser.
565
+ # @param javascript_enabled [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel::Browser::JavascriptEnabled, nil]
566
+ # Whether JavaScript is enabled in the cardholder's browser.
516
567
  #
517
568
  # @param language [String, nil] The language of the cardholder's browser.
518
569
  #
@@ -566,7 +617,8 @@ module Increase
566
617
  # @!method initialize(indicator:)
567
618
  # Fields specific to merchant initiated transactions.
568
619
  #
569
- # @param indicator [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator] The merchant initiated indicator for the transaction.
620
+ # @param indicator [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator]
621
+ # The merchant initiated indicator for the transaction.
570
622
 
571
623
  # The merchant initiated indicator for the transaction.
572
624
  #
@@ -664,11 +716,14 @@ module Increase
664
716
  # @!method initialize(category:, non_payment:, payment:)
665
717
  # The message category of the card authentication attempt.
666
718
  #
667
- # @param category [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::Category] The category of the card authentication attempt.
719
+ # @param category [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::Category]
720
+ # The category of the card authentication attempt.
668
721
  #
669
- # @param non_payment [Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::NonPayment, nil] Fields specific to non-payment authentication attempts.
722
+ # @param non_payment [Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::NonPayment, nil]
723
+ # Fields specific to non-payment authentication attempts.
670
724
  #
671
- # @param payment [Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::Payment, nil] Fields specific to payment authentication attempts.
725
+ # @param payment [Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::Payment, nil]
726
+ # Fields specific to payment authentication attempts.
672
727
 
673
728
  # The category of the card authentication attempt.
674
729
  #
@@ -725,19 +780,20 @@ module Increase
725
780
  nil?: true
726
781
 
727
782
  # @!method initialize(purchase_amount:, purchase_amount_cardholder_estimated:, purchase_currency:, transaction_type:)
728
- # Some parameter documentations has been truncated, see
729
- # {Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::Payment}
730
- # for more details.
731
- #
732
783
  # Fields specific to payment authentication attempts.
733
784
  #
734
785
  # @param purchase_amount [Integer] The purchase amount in minor units.
735
786
  #
736
- # @param purchase_amount_cardholder_estimated [Integer, nil] The purchase amount in the cardholder's currency (i.e., USD) estimated using dai
787
+ # @param purchase_amount_cardholder_estimated [Integer, nil]
788
+ # The purchase amount in the cardholder's currency (i.e., USD) estimated using
789
+ # daily conversion rates from the card network.
737
790
  #
738
- # @param purchase_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the authenticati
791
+ # @param purchase_currency [String]
792
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
793
+ # authentication attempt's purchase currency.
739
794
  #
740
- # @param transaction_type [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::Payment::TransactionType, nil] The type of transaction being authenticated.
795
+ # @param transaction_type [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::MessageCategory::Payment::TransactionType, nil]
796
+ # The type of transaction being authenticated.
741
797
 
742
798
  # The type of transaction being authenticated.
743
799
  #
@@ -878,21 +934,20 @@ module Increase
878
934
  nil?: true
879
935
 
880
936
  # @!method initialize(account_id:, card_id:, card_payment_id:, one_time_code:, result:)
881
- # Some parameter documentations has been truncated, see
882
- # {Increase::Models::RealTimeDecision::CardAuthenticationChallenge} for more
883
- # details.
884
- #
885
937
  # Fields related to a 3DS authentication attempt.
886
938
  #
887
939
  # @param account_id [String] The identifier of the Account the card belongs to.
888
940
  #
889
941
  # @param card_id [String] The identifier of the Card that is being tokenized.
890
942
  #
891
- # @param card_payment_id [String] The identifier of the Card Payment this authentication challenge attempt belongs
943
+ # @param card_payment_id [String]
944
+ # The identifier of the Card Payment this authentication challenge attempt belongs
945
+ # to.
892
946
  #
893
947
  # @param one_time_code [String] The one-time code delivered to the cardholder.
894
948
  #
895
- # @param result [Symbol, Increase::Models::RealTimeDecision::CardAuthenticationChallenge::Result, nil] Whether or not the challenge was delivered to the cardholder.
949
+ # @param result [Symbol, Increase::Models::RealTimeDecision::CardAuthenticationChallenge::Result, nil]
950
+ # Whether or not the challenge was delivered to the cardholder.
896
951
 
897
952
  # Whether or not the challenge was delivered to the cardholder.
898
953
  #
@@ -1117,32 +1172,47 @@ module Increase
1117
1172
  required :verification, -> { Increase::RealTimeDecision::CardAuthorization::Verification }
1118
1173
 
1119
1174
  # @!method initialize(account_id:, additional_amounts:, approval:, card_id:, decision:, decline:, digital_wallet_token_id:, direction:, healthcare:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, partial_approval_capability:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, request_details:, settlement_amount:, settlement_currency:, terminal_id:, upcoming_card_payment_id:, verification:)
1120
- # Some parameter documentations has been truncated, see
1121
- # {Increase::Models::RealTimeDecision::CardAuthorization} for more details.
1122
- #
1123
1175
  # Fields related to a card authorization.
1124
1176
  #
1125
1177
  # @param account_id [String] The identifier of the Account the authorization will debit.
1126
1178
  #
1127
- # @param additional_amounts [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts] Additional amounts associated with the card authorization, such as ATM surcharge
1179
+ # @param additional_amounts [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts]
1180
+ # Additional amounts associated with the card authorization, such as ATM
1181
+ # surcharges fees. These are usually a subset of the `amount` field and are used
1182
+ # to provide more detailed information about the transaction.
1128
1183
  #
1129
- # @param approval [Increase::Models::RealTimeDecision::CardAuthorization::Approval, nil] Present if and only if `decision` is `approve`. Contains information related to
1184
+ # @param approval [Increase::Models::RealTimeDecision::CardAuthorization::Approval, nil]
1185
+ # Present if and only if `decision` is `approve`. Contains information related to
1186
+ # the approval of the authorization.
1130
1187
  #
1131
1188
  # @param card_id [String] The identifier of the Card that is being authorized.
1132
1189
  #
1133
- # @param decision [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Decision, nil] Whether or not the authorization was approved.
1190
+ # @param decision [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Decision, nil]
1191
+ # Whether or not the authorization was approved.
1134
1192
  #
1135
- # @param decline [Increase::Models::RealTimeDecision::CardAuthorization::Decline, nil] Present if and only if `decision` is `decline`. Contains information related to
1193
+ # @param decline [Increase::Models::RealTimeDecision::CardAuthorization::Decline, nil]
1194
+ # Present if and only if `decision` is `decline`. Contains information related to
1195
+ # the reason the authorization was declined.
1136
1196
  #
1137
- # @param digital_wallet_token_id [String, nil] If the authorization was made via a Digital Wallet Token (such as an Apple Pay p
1197
+ # @param digital_wallet_token_id [String, nil]
1198
+ # If the authorization was made via a Digital Wallet Token (such as an Apple Pay
1199
+ # purchase), the identifier of the token that was used.
1138
1200
  #
1139
- # @param direction [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Direction] The direction describes the direction the funds will move, either from the cardh
1201
+ # @param direction [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Direction]
1202
+ # The direction describes the direction the funds will move, either from the
1203
+ # cardholder to the merchant or from the merchant to the cardholder.
1140
1204
  #
1141
- # @param healthcare [Increase::Models::RealTimeDecision::CardAuthorization::Healthcare, nil] The healthcare-related fields for this authorization. Only present for specific
1205
+ # @param healthcare [Increase::Models::RealTimeDecision::CardAuthorization::Healthcare, nil]
1206
+ # The healthcare-related fields for this authorization. Only present for specific
1207
+ # programs.
1142
1208
  #
1143
- # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i
1209
+ # @param merchant_acceptor_id [String]
1210
+ # The merchant identifier (commonly abbreviated as MID) of the merchant the card
1211
+ # is transacting with.
1144
1212
  #
1145
- # @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car
1213
+ # @param merchant_category_code [String]
1214
+ # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
1215
+ # card is transacting with.
1146
1216
  #
1147
1217
  # @param merchant_city [String, nil] The city the merchant resides in.
1148
1218
  #
@@ -1150,37 +1220,64 @@ module Increase
1150
1220
  #
1151
1221
  # @param merchant_descriptor [String] The merchant descriptor of the merchant the card is transacting with.
1152
1222
  #
1153
- # @param merchant_postal_code [String, nil] The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
1223
+ # @param merchant_postal_code [String, nil]
1224
+ # The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
1225
+ # ZIP code, where the first 5 and last 4 are separated by a dash.
1154
1226
  #
1155
1227
  # @param merchant_state [String, nil] The state the merchant resides in.
1156
1228
  #
1157
- # @param network_details [Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails] Fields specific to the `network`.
1229
+ # @param network_details [Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails]
1230
+ # Fields specific to the `network`.
1158
1231
  #
1159
- # @param network_identifiers [Increase::Models::RealTimeDecision::CardAuthorization::NetworkIdentifiers] Network-specific identifiers for a specific request or transaction.
1232
+ # @param network_identifiers [Increase::Models::RealTimeDecision::CardAuthorization::NetworkIdentifiers]
1233
+ # Network-specific identifiers for a specific request or transaction.
1160
1234
  #
1161
- # @param network_risk_score [Integer, nil] The risk score generated by the card network. For Visa this is the Visa Advanced
1235
+ # @param network_risk_score [Integer, nil]
1236
+ # The risk score generated by the card network. For Visa this is the Visa Advanced
1237
+ # Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
1238
+ # score is from 0 to 999, where 999 is the riskiest.
1162
1239
  #
1163
- # @param partial_approval_capability [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::PartialApprovalCapability] Whether or not the authorization supports partial approvals.
1240
+ # @param partial_approval_capability [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::PartialApprovalCapability]
1241
+ # Whether or not the authorization supports partial approvals.
1164
1242
  #
1165
- # @param physical_card_id [String, nil] If the authorization was made in-person with a physical card, the Physical Card
1243
+ # @param physical_card_id [String, nil]
1244
+ # If the authorization was made in-person with a physical card, the Physical Card
1245
+ # that was used.
1166
1246
  #
1167
- # @param presentment_amount [Integer] The amount of the attempted authorization in the currency the card user sees at
1247
+ # @param presentment_amount [Integer]
1248
+ # The amount of the attempted authorization in the currency the card user sees at
1249
+ # the time of purchase, in the minor unit of that currency. For dollars, for
1250
+ # example, this is cents.
1168
1251
  #
1169
- # @param presentment_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the
1252
+ # @param presentment_currency [String]
1253
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the
1254
+ # user sees at the time of purchase.
1170
1255
  #
1171
- # @param processing_category [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::ProcessingCategory] The processing category describes the intent behind the authorization, such as w
1256
+ # @param processing_category [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::ProcessingCategory]
1257
+ # The processing category describes the intent behind the authorization, such as
1258
+ # whether it was used for bill payments or an automatic fuel dispenser.
1172
1259
  #
1173
- # @param request_details [Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails] Fields specific to the type of request, such as an incremental authorization.
1260
+ # @param request_details [Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails]
1261
+ # Fields specific to the type of request, such as an incremental authorization.
1174
1262
  #
1175
- # @param settlement_amount [Integer] The amount of the attempted authorization in the currency it will be settled in.
1263
+ # @param settlement_amount [Integer]
1264
+ # The amount of the attempted authorization in the currency it will be settled in.
1265
+ # This currency is the same as that of the Account the card belongs to.
1176
1266
  #
1177
- # @param settlement_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the
1267
+ # @param settlement_currency [String]
1268
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the
1269
+ # transaction will be settled in.
1178
1270
  #
1179
- # @param terminal_id [String, nil] The terminal identifier (commonly abbreviated as TID) of the terminal the card i
1271
+ # @param terminal_id [String, nil]
1272
+ # The terminal identifier (commonly abbreviated as TID) of the terminal the card
1273
+ # is transacting with.
1180
1274
  #
1181
- # @param upcoming_card_payment_id [String] The identifier of the Card Payment this authorization will belong to. Available
1275
+ # @param upcoming_card_payment_id [String]
1276
+ # The identifier of the Card Payment this authorization will belong to. Available
1277
+ # in the API once the card authorization has completed.
1182
1278
  #
1183
- # @param verification [Increase::Models::RealTimeDecision::CardAuthorization::Verification] Fields related to verification of cardholder-provided values.
1279
+ # @param verification [Increase::Models::RealTimeDecision::CardAuthorization::Verification]
1280
+ # Fields related to verification of cardholder-provided values.
1184
1281
 
1185
1282
  # @see Increase::Models::RealTimeDecision::CardAuthorization#additional_amounts
1186
1283
  class AdditionalAmounts < Increase::Internal::Type::BaseModel
@@ -1265,33 +1362,39 @@ module Increase
1265
1362
  nil?: true
1266
1363
 
1267
1364
  # @!method initialize(clinic:, dental:, original:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
1268
- # Some parameter documentations has been truncated, see
1269
- # {Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts} for
1270
- # more details.
1271
- #
1272
1365
  # Additional amounts associated with the card authorization, such as ATM
1273
1366
  # surcharges fees. These are usually a subset of the `amount` field and are used
1274
1367
  # to provide more detailed information about the transaction.
1275
1368
  #
1276
- # @param clinic [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Clinic, nil] The part of this transaction amount that was for clinic-related services.
1369
+ # @param clinic [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Clinic, nil]
1370
+ # The part of this transaction amount that was for clinic-related services.
1277
1371
  #
1278
- # @param dental [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Dental, nil] The part of this transaction amount that was for dental-related services.
1372
+ # @param dental [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Dental, nil]
1373
+ # The part of this transaction amount that was for dental-related services.
1279
1374
  #
1280
- # @param original [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Original, nil] The original pre-authorized amount.
1375
+ # @param original [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Original, nil]
1376
+ # The original pre-authorized amount.
1281
1377
  #
1282
- # @param prescription [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Prescription, nil] The part of this transaction amount that was for healthcare prescriptions.
1378
+ # @param prescription [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Prescription, nil]
1379
+ # The part of this transaction amount that was for healthcare prescriptions.
1283
1380
  #
1284
- # @param surcharge [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Surcharge, nil] The surcharge amount charged for this transaction by the merchant.
1381
+ # @param surcharge [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Surcharge, nil]
1382
+ # The surcharge amount charged for this transaction by the merchant.
1285
1383
  #
1286
- # @param total_cumulative [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::TotalCumulative, nil] The total amount of a series of incremental authorizations, optionally provided.
1384
+ # @param total_cumulative [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::TotalCumulative, nil]
1385
+ # The total amount of a series of incremental authorizations, optionally provided.
1287
1386
  #
1288
- # @param total_healthcare [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::TotalHealthcare, nil] The total amount of healthcare-related additional amounts.
1387
+ # @param total_healthcare [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::TotalHealthcare, nil]
1388
+ # The total amount of healthcare-related additional amounts.
1289
1389
  #
1290
- # @param transit [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Transit, nil] The part of this transaction amount that was for transit-related services.
1390
+ # @param transit [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Transit, nil]
1391
+ # The part of this transaction amount that was for transit-related services.
1291
1392
  #
1292
- # @param unknown [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Unknown, nil] An unknown additional amount.
1393
+ # @param unknown [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Unknown, nil]
1394
+ # An unknown additional amount.
1293
1395
  #
1294
- # @param vision [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Vision, nil] The part of this transaction amount that was for vision-related services.
1396
+ # @param vision [Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Vision, nil]
1397
+ # The part of this transaction amount that was for vision-related services.
1295
1398
 
1296
1399
  # @see Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts#clinic
1297
1400
  class Clinic < Increase::Internal::Type::BaseModel
@@ -1311,15 +1414,16 @@ module Increase
1311
1414
  required :currency, String
1312
1415
 
1313
1416
  # @!method initialize(amount:, currency:)
1314
- # Some parameter documentations has been truncated, see
1315
- # {Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Clinic}
1316
- # for more details.
1317
- #
1318
1417
  # The part of this transaction amount that was for clinic-related services.
1319
1418
  #
1320
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1419
+ # @param amount [Integer]
1420
+ # The amount in minor units of the `currency` field. The amount is positive if it
1421
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1422
+ # subtracted from the amount (such as a discount).
1321
1423
  #
1322
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1424
+ # @param currency [String]
1425
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1426
+ # amount's currency.
1323
1427
  end
1324
1428
 
1325
1429
  # @see Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts#dental
@@ -1340,15 +1444,16 @@ module Increase
1340
1444
  required :currency, String
1341
1445
 
1342
1446
  # @!method initialize(amount:, currency:)
1343
- # Some parameter documentations has been truncated, see
1344
- # {Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Dental}
1345
- # for more details.
1346
- #
1347
1447
  # The part of this transaction amount that was for dental-related services.
1348
1448
  #
1349
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1449
+ # @param amount [Integer]
1450
+ # The amount in minor units of the `currency` field. The amount is positive if it
1451
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1452
+ # subtracted from the amount (such as a discount).
1350
1453
  #
1351
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1454
+ # @param currency [String]
1455
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1456
+ # amount's currency.
1352
1457
  end
1353
1458
 
1354
1459
  # @see Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts#original
@@ -1369,15 +1474,16 @@ module Increase
1369
1474
  required :currency, String
1370
1475
 
1371
1476
  # @!method initialize(amount:, currency:)
1372
- # Some parameter documentations has been truncated, see
1373
- # {Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Original}
1374
- # for more details.
1375
- #
1376
1477
  # The original pre-authorized amount.
1377
1478
  #
1378
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1479
+ # @param amount [Integer]
1480
+ # The amount in minor units of the `currency` field. The amount is positive if it
1481
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1482
+ # subtracted from the amount (such as a discount).
1379
1483
  #
1380
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1484
+ # @param currency [String]
1485
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1486
+ # amount's currency.
1381
1487
  end
1382
1488
 
1383
1489
  # @see Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts#prescription
@@ -1398,15 +1504,16 @@ module Increase
1398
1504
  required :currency, String
1399
1505
 
1400
1506
  # @!method initialize(amount:, currency:)
1401
- # Some parameter documentations has been truncated, see
1402
- # {Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Prescription}
1403
- # for more details.
1404
- #
1405
1507
  # The part of this transaction amount that was for healthcare prescriptions.
1406
1508
  #
1407
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1509
+ # @param amount [Integer]
1510
+ # The amount in minor units of the `currency` field. The amount is positive if it
1511
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1512
+ # subtracted from the amount (such as a discount).
1408
1513
  #
1409
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1514
+ # @param currency [String]
1515
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1516
+ # amount's currency.
1410
1517
  end
1411
1518
 
1412
1519
  # @see Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts#surcharge
@@ -1427,15 +1534,16 @@ module Increase
1427
1534
  required :currency, String
1428
1535
 
1429
1536
  # @!method initialize(amount:, currency:)
1430
- # Some parameter documentations has been truncated, see
1431
- # {Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Surcharge}
1432
- # for more details.
1433
- #
1434
1537
  # The surcharge amount charged for this transaction by the merchant.
1435
1538
  #
1436
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1539
+ # @param amount [Integer]
1540
+ # The amount in minor units of the `currency` field. The amount is positive if it
1541
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1542
+ # subtracted from the amount (such as a discount).
1437
1543
  #
1438
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1544
+ # @param currency [String]
1545
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1546
+ # amount's currency.
1439
1547
  end
1440
1548
 
1441
1549
  # @see Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts#total_cumulative
@@ -1456,15 +1564,16 @@ module Increase
1456
1564
  required :currency, String
1457
1565
 
1458
1566
  # @!method initialize(amount:, currency:)
1459
- # Some parameter documentations has been truncated, see
1460
- # {Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::TotalCumulative}
1461
- # for more details.
1462
- #
1463
1567
  # The total amount of a series of incremental authorizations, optionally provided.
1464
1568
  #
1465
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1569
+ # @param amount [Integer]
1570
+ # The amount in minor units of the `currency` field. The amount is positive if it
1571
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1572
+ # subtracted from the amount (such as a discount).
1466
1573
  #
1467
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1574
+ # @param currency [String]
1575
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1576
+ # amount's currency.
1468
1577
  end
1469
1578
 
1470
1579
  # @see Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts#total_healthcare
@@ -1485,15 +1594,16 @@ module Increase
1485
1594
  required :currency, String
1486
1595
 
1487
1596
  # @!method initialize(amount:, currency:)
1488
- # Some parameter documentations has been truncated, see
1489
- # {Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::TotalHealthcare}
1490
- # for more details.
1491
- #
1492
1597
  # The total amount of healthcare-related additional amounts.
1493
1598
  #
1494
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1599
+ # @param amount [Integer]
1600
+ # The amount in minor units of the `currency` field. The amount is positive if it
1601
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1602
+ # subtracted from the amount (such as a discount).
1495
1603
  #
1496
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1604
+ # @param currency [String]
1605
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1606
+ # amount's currency.
1497
1607
  end
1498
1608
 
1499
1609
  # @see Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts#transit
@@ -1514,15 +1624,16 @@ module Increase
1514
1624
  required :currency, String
1515
1625
 
1516
1626
  # @!method initialize(amount:, currency:)
1517
- # Some parameter documentations has been truncated, see
1518
- # {Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Transit}
1519
- # for more details.
1520
- #
1521
1627
  # The part of this transaction amount that was for transit-related services.
1522
1628
  #
1523
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1629
+ # @param amount [Integer]
1630
+ # The amount in minor units of the `currency` field. The amount is positive if it
1631
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1632
+ # subtracted from the amount (such as a discount).
1524
1633
  #
1525
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1634
+ # @param currency [String]
1635
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1636
+ # amount's currency.
1526
1637
  end
1527
1638
 
1528
1639
  # @see Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts#unknown
@@ -1543,15 +1654,16 @@ module Increase
1543
1654
  required :currency, String
1544
1655
 
1545
1656
  # @!method initialize(amount:, currency:)
1546
- # Some parameter documentations has been truncated, see
1547
- # {Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Unknown}
1548
- # for more details.
1549
- #
1550
1657
  # An unknown additional amount.
1551
1658
  #
1552
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1659
+ # @param amount [Integer]
1660
+ # The amount in minor units of the `currency` field. The amount is positive if it
1661
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1662
+ # subtracted from the amount (such as a discount).
1553
1663
  #
1554
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1664
+ # @param currency [String]
1665
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1666
+ # amount's currency.
1555
1667
  end
1556
1668
 
1557
1669
  # @see Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts#vision
@@ -1572,15 +1684,16 @@ module Increase
1572
1684
  required :currency, String
1573
1685
 
1574
1686
  # @!method initialize(amount:, currency:)
1575
- # Some parameter documentations has been truncated, see
1576
- # {Increase::Models::RealTimeDecision::CardAuthorization::AdditionalAmounts::Vision}
1577
- # for more details.
1578
- #
1579
1687
  # The part of this transaction amount that was for vision-related services.
1580
1688
  #
1581
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1689
+ # @param amount [Integer]
1690
+ # The amount in minor units of the `currency` field. The amount is positive if it
1691
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1692
+ # subtracted from the amount (such as a discount).
1582
1693
  #
1583
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1694
+ # @param currency [String]
1695
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1696
+ # amount's currency.
1584
1697
  end
1585
1698
  end
1586
1699
 
@@ -1594,14 +1707,12 @@ module Increase
1594
1707
  required :partial_amount, Integer, nil?: true
1595
1708
 
1596
1709
  # @!method initialize(partial_amount:)
1597
- # Some parameter documentations has been truncated, see
1598
- # {Increase::Models::RealTimeDecision::CardAuthorization::Approval} for more
1599
- # details.
1600
- #
1601
1710
  # Present if and only if `decision` is `approve`. Contains information related to
1602
1711
  # the approval of the authorization.
1603
1712
  #
1604
- # @param partial_amount [Integer, nil] If the authorization was partially approved, this field contains the approved am
1713
+ # @param partial_amount [Integer, nil]
1714
+ # If the authorization was partially approved, this field contains the approved
1715
+ # amount in the minor unit of the settlement currency.
1605
1716
  end
1606
1717
 
1607
1718
  # Whether or not the authorization was approved.
@@ -1632,7 +1743,8 @@ module Increase
1632
1743
  # Present if and only if `decision` is `decline`. Contains information related to
1633
1744
  # the reason the authorization was declined.
1634
1745
  #
1635
- # @param reason [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Decline::Reason] The reason the authorization was declined.
1746
+ # @param reason [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Decline::Reason]
1747
+ # The reason the authorization was declined.
1636
1748
 
1637
1749
  # The reason the authorization was declined.
1638
1750
  #
@@ -1693,14 +1805,14 @@ module Increase
1693
1805
  enum: -> { Increase::RealTimeDecision::CardAuthorization::Healthcare::MerchantNinetyPercentEligibility }
1694
1806
 
1695
1807
  # @!method initialize(merchant_ninety_percent_eligibility:)
1696
- # Some parameter documentations has been truncated, see
1697
- # {Increase::Models::RealTimeDecision::CardAuthorization::Healthcare} for more
1698
- # details.
1699
- #
1700
1808
  # The healthcare-related fields for this authorization. Only present for specific
1701
1809
  # programs.
1702
1810
  #
1703
- # @param merchant_ninety_percent_eligibility [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Healthcare::MerchantNinetyPercentEligibility] The merchant's eligibility under the Internal Revenue Service's 90% Rule for Fle
1811
+ # @param merchant_ninety_percent_eligibility [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Healthcare::MerchantNinetyPercentEligibility]
1812
+ # The merchant's eligibility under the Internal Revenue Service's 90% Rule for
1813
+ # Flexible Spending Account (FSA) and Health Savings Account (HSA) eligible
1814
+ # products. The eligibility is determined based on the list of merchants
1815
+ # maintained by the Special Interest Group for IIAS Standards (SIGIS).
1704
1816
 
1705
1817
  # The merchant's eligibility under the Internal Revenue Service's 90% Rule for
1706
1818
  # Flexible Spending Account (FSA) and Health Savings Account (HSA) eligible
@@ -1753,11 +1865,14 @@ module Increase
1753
1865
  # @!method initialize(category:, pulse:, visa:)
1754
1866
  # Fields specific to the `network`.
1755
1867
  #
1756
- # @param category [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Category] The payment network used to process this card authorization.
1868
+ # @param category [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Category]
1869
+ # The payment network used to process this card authorization.
1757
1870
  #
1758
- # @param pulse [Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Pulse, nil] Fields specific to the `pulse` network.
1871
+ # @param pulse [Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Pulse, nil]
1872
+ # Fields specific to the `pulse` network.
1759
1873
  #
1760
- # @param visa [Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa, nil] Fields specific to the `visa` network.
1874
+ # @param visa [Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa, nil]
1875
+ # Fields specific to the `visa` network.
1761
1876
 
1762
1877
  # The payment network used to process this card authorization.
1763
1878
  #
@@ -1832,19 +1947,27 @@ module Increase
1832
1947
  nil?: true
1833
1948
 
1834
1949
  # @!method initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:, terminal_entry_capability:)
1835
- # Some parameter documentations has been truncated, see
1836
- # {Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa}
1837
- # for more details.
1838
- #
1839
1950
  # Fields specific to the `visa` network.
1840
1951
  #
1841
- # @param electronic_commerce_indicator [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] For electronic commerce transactions, this identifies the level of security used
1952
+ # @param electronic_commerce_indicator [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::ElectronicCommerceIndicator, nil]
1953
+ # For electronic commerce transactions, this identifies the level of security used
1954
+ # in obtaining the customer's payment credential. For mail or telephone order
1955
+ # transactions, identifies the type of mail or telephone order.
1842
1956
  #
1843
- # @param point_of_service_entry_mode [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::PointOfServiceEntryMode, nil] The method used to enter the cardholder's primary account number and card expira
1957
+ # @param point_of_service_entry_mode [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::PointOfServiceEntryMode, nil]
1958
+ # The method used to enter the cardholder's primary account number and card
1959
+ # expiration date.
1844
1960
  #
1845
- # @param stand_in_processing_reason [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason, nil] Only present when `actioner: network`. Describes why a card authorization was ap
1961
+ # @param stand_in_processing_reason [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason, nil]
1962
+ # Only present when `actioner: network`. Describes why a card authorization was
1963
+ # approved or declined by Visa through stand-in processing.
1846
1964
  #
1847
- # @param terminal_entry_capability [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::TerminalEntryCapability, nil] The capability of the terminal being used to read the card. Shows whether a term
1965
+ # @param terminal_entry_capability [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::NetworkDetails::Visa::TerminalEntryCapability, nil]
1966
+ # The capability of the terminal being used to read the card. Shows whether a
1967
+ # terminal can e.g., accept chip cards or if it only supports magnetic stripe
1968
+ # reads. This reflects the highest capability of the terminal — for example, a
1969
+ # terminal that supports both chip and magnetic stripe will be identified as
1970
+ # chip-capable.
1848
1971
 
1849
1972
  # For electronic commerce transactions, this identifies the level of security used
1850
1973
  # in obtaining the customer's payment credential. For mail or telephone order
@@ -2033,19 +2156,24 @@ module Increase
2033
2156
  required :transaction_id, String, nil?: true
2034
2157
 
2035
2158
  # @!method initialize(authorization_identification_response:, retrieval_reference_number:, trace_number:, transaction_id:)
2036
- # Some parameter documentations has been truncated, see
2037
- # {Increase::Models::RealTimeDecision::CardAuthorization::NetworkIdentifiers} for
2038
- # more details.
2039
- #
2040
2159
  # Network-specific identifiers for a specific request or transaction.
2041
2160
  #
2042
- # @param authorization_identification_response [String, nil] The randomly generated 6-character Authorization Identification Response code se
2161
+ # @param authorization_identification_response [String, nil]
2162
+ # The randomly generated 6-character Authorization Identification Response code
2163
+ # sent back to the acquirer in an approved response.
2043
2164
  #
2044
- # @param retrieval_reference_number [String, nil] A life-cycle identifier used across e.g., an authorization and a reversal. Expec
2165
+ # @param retrieval_reference_number [String, nil]
2166
+ # A life-cycle identifier used across e.g., an authorization and a reversal.
2167
+ # Expected to be unique per acquirer within a window of time. For some card
2168
+ # networks the retrieval reference number includes the trace counter.
2045
2169
  #
2046
- # @param trace_number [String, nil] A counter used to verify an individual authorization. Expected to be unique per
2170
+ # @param trace_number [String, nil]
2171
+ # A counter used to verify an individual authorization. Expected to be unique per
2172
+ # acquirer within a window of time.
2047
2173
  #
2048
- # @param transaction_id [String, nil] A globally unique transaction identifier provided by the card network, used acro
2174
+ # @param transaction_id [String, nil]
2175
+ # A globally unique transaction identifier provided by the card network, used
2176
+ # across multiple life-cycle requests.
2049
2177
  end
2050
2178
 
2051
2179
  # Whether or not the authorization supports partial approvals.
@@ -2136,17 +2264,17 @@ module Increase
2136
2264
  nil?: true
2137
2265
 
2138
2266
  # @!method initialize(category:, incremental_authorization:, initial_authorization:)
2139
- # Some parameter documentations has been truncated, see
2140
- # {Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails} for more
2141
- # details.
2142
- #
2143
2267
  # Fields specific to the type of request, such as an incremental authorization.
2144
2268
  #
2145
- # @param category [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails::Category] The type of this request (e.g., an initial authorization or an incremental autho
2269
+ # @param category [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails::Category]
2270
+ # The type of this request (e.g., an initial authorization or an incremental
2271
+ # authorization).
2146
2272
  #
2147
- # @param incremental_authorization [Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails::IncrementalAuthorization, nil] Fields specific to the category `incremental_authorization`.
2273
+ # @param incremental_authorization [Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails::IncrementalAuthorization, nil]
2274
+ # Fields specific to the category `incremental_authorization`.
2148
2275
  #
2149
- # @param initial_authorization [Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails::InitialAuthorization, nil] Fields specific to the category `initial_authorization`.
2276
+ # @param initial_authorization [Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails::InitialAuthorization, nil]
2277
+ # Fields specific to the category `initial_authorization`.
2150
2278
 
2151
2279
  # The type of this request (e.g., an initial authorization or an incremental
2152
2280
  # authorization).
@@ -2181,15 +2309,13 @@ module Increase
2181
2309
  required :original_card_authorization_id, String
2182
2310
 
2183
2311
  # @!method initialize(card_payment_id:, original_card_authorization_id:)
2184
- # Some parameter documentations has been truncated, see
2185
- # {Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails::IncrementalAuthorization}
2186
- # for more details.
2187
- #
2188
2312
  # Fields specific to the category `incremental_authorization`.
2189
2313
  #
2190
2314
  # @param card_payment_id [String] The card payment for this authorization and increment.
2191
2315
  #
2192
- # @param original_card_authorization_id [String] The identifier of the card authorization this request is attempting to increment
2316
+ # @param original_card_authorization_id [String]
2317
+ # The identifier of the card authorization this request is attempting to
2318
+ # increment.
2193
2319
  end
2194
2320
 
2195
2321
  # @see Increase::Models::RealTimeDecision::CardAuthorization::RequestDetails#initial_authorization
@@ -2226,17 +2352,18 @@ module Increase
2226
2352
  nil?: true
2227
2353
 
2228
2354
  # @!method initialize(card_verification_code:, cardholder_address:, cardholder_name:)
2229
- # Some parameter documentations has been truncated, see
2230
- # {Increase::Models::RealTimeDecision::CardAuthorization::Verification} for more
2231
- # details.
2232
- #
2233
2355
  # Fields related to verification of cardholder-provided values.
2234
2356
  #
2235
- # @param card_verification_code [Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardVerificationCode] Fields related to verification of the Card Verification Code, a 3-digit code on
2357
+ # @param card_verification_code [Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardVerificationCode]
2358
+ # Fields related to verification of the Card Verification Code, a 3-digit code on
2359
+ # the back of the card.
2236
2360
  #
2237
- # @param cardholder_address [Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardholderAddress] Cardholder address provided in the authorization request and the address on file
2361
+ # @param cardholder_address [Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardholderAddress]
2362
+ # Cardholder address provided in the authorization request and the address on file
2363
+ # we verified it against.
2238
2364
  #
2239
- # @param cardholder_name [Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardholderName, nil] Cardholder name provided in the authorization request.
2365
+ # @param cardholder_name [Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardholderName, nil]
2366
+ # Cardholder name provided in the authorization request.
2240
2367
 
2241
2368
  # @see Increase::Models::RealTimeDecision::CardAuthorization::Verification#card_verification_code
2242
2369
  class CardVerificationCode < Increase::Internal::Type::BaseModel
@@ -2251,7 +2378,8 @@ module Increase
2251
2378
  # Fields related to verification of the Card Verification Code, a 3-digit code on
2252
2379
  # the back of the card.
2253
2380
  #
2254
- # @param result [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardVerificationCode::Result] The result of verifying the Card Verification Code.
2381
+ # @param result [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardVerificationCode::Result]
2382
+ # The result of verifying the Card Verification Code.
2255
2383
 
2256
2384
  # The result of verifying the Card Verification Code.
2257
2385
  #
@@ -2308,10 +2436,6 @@ module Increase
2308
2436
  enum: -> { Increase::RealTimeDecision::CardAuthorization::Verification::CardholderAddress::Result }
2309
2437
 
2310
2438
  # @!method initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:)
2311
- # Some parameter documentations has been truncated, see
2312
- # {Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardholderAddress}
2313
- # for more details.
2314
- #
2315
2439
  # Cardholder address provided in the authorization request and the address on file
2316
2440
  # we verified it against.
2317
2441
  #
@@ -2319,11 +2443,15 @@ module Increase
2319
2443
  #
2320
2444
  # @param actual_postal_code [String, nil] The postal code of the address on file for the cardholder.
2321
2445
  #
2322
- # @param provided_line1 [String, nil] The cardholder address line 1 provided for verification in the authorization req
2446
+ # @param provided_line1 [String, nil]
2447
+ # The cardholder address line 1 provided for verification in the authorization
2448
+ # request.
2323
2449
  #
2324
- # @param provided_postal_code [String, nil] The postal code provided for verification in the authorization request.
2450
+ # @param provided_postal_code [String, nil]
2451
+ # The postal code provided for verification in the authorization request.
2325
2452
  #
2326
- # @param result [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardholderAddress::Result] The address verification result returned to the card network.
2453
+ # @param result [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Verification::CardholderAddress::Result]
2454
+ # The address verification result returned to the card network.
2327
2455
 
2328
2456
  # The address verification result returned to the card network.
2329
2457
  #
@@ -2377,11 +2505,14 @@ module Increase
2377
2505
  # @!method initialize(provided_first_name:, provided_last_name:, provided_middle_name:)
2378
2506
  # Cardholder name provided in the authorization request.
2379
2507
  #
2380
- # @param provided_first_name [String, nil] The first name provided for verification in the authorization request.
2508
+ # @param provided_first_name [String, nil]
2509
+ # The first name provided for verification in the authorization request.
2381
2510
  #
2382
- # @param provided_last_name [String, nil] The last name provided for verification in the authorization request.
2511
+ # @param provided_last_name [String, nil]
2512
+ # The last name provided for verification in the authorization request.
2383
2513
  #
2384
- # @param provided_middle_name [String, nil] The middle name provided for verification in the authorization request.
2514
+ # @param provided_middle_name [String, nil]
2515
+ # The middle name provided for verification in the authorization request.
2385
2516
  end
2386
2517
  end
2387
2518
  end
@@ -2521,26 +2652,35 @@ module Increase
2521
2652
  required :verification, -> { Increase::RealTimeDecision::CardBalanceInquiry::Verification }
2522
2653
 
2523
2654
  # @!method initialize(account_id:, additional_amounts:, approval:, card_id:, decision:, digital_wallet_token_id:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, physical_card_id:, terminal_id:, upcoming_card_payment_id:, verification:)
2524
- # Some parameter documentations has been truncated, see
2525
- # {Increase::Models::RealTimeDecision::CardBalanceInquiry} for more details.
2526
- #
2527
2655
  # Fields related to a card balance inquiry.
2528
2656
  #
2529
2657
  # @param account_id [String] The identifier of the Account the authorization will debit.
2530
2658
  #
2531
- # @param additional_amounts [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts] Additional amounts associated with the card authorization, such as ATM surcharge
2659
+ # @param additional_amounts [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts]
2660
+ # Additional amounts associated with the card authorization, such as ATM
2661
+ # surcharges fees. These are usually a subset of the `amount` field and are used
2662
+ # to provide more detailed information about the transaction.
2532
2663
  #
2533
- # @param approval [Increase::Models::RealTimeDecision::CardBalanceInquiry::Approval, nil] Present if and only if `decision` is `approve`. Contains information related to
2664
+ # @param approval [Increase::Models::RealTimeDecision::CardBalanceInquiry::Approval, nil]
2665
+ # Present if and only if `decision` is `approve`. Contains information related to
2666
+ # the approval of the balance inquiry.
2534
2667
  #
2535
2668
  # @param card_id [String] The identifier of the Card that is being authorized.
2536
2669
  #
2537
- # @param decision [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::Decision, nil] Whether or not the authorization was approved.
2670
+ # @param decision [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::Decision, nil]
2671
+ # Whether or not the authorization was approved.
2538
2672
  #
2539
- # @param digital_wallet_token_id [String, nil] If the authorization was made via a Digital Wallet Token (such as an Apple Pay p
2673
+ # @param digital_wallet_token_id [String, nil]
2674
+ # If the authorization was made via a Digital Wallet Token (such as an Apple Pay
2675
+ # purchase), the identifier of the token that was used.
2540
2676
  #
2541
- # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i
2677
+ # @param merchant_acceptor_id [String]
2678
+ # The merchant identifier (commonly abbreviated as MID) of the merchant the card
2679
+ # is transacting with.
2542
2680
  #
2543
- # @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car
2681
+ # @param merchant_category_code [String]
2682
+ # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
2683
+ # card is transacting with.
2544
2684
  #
2545
2685
  # @param merchant_city [String, nil] The city the merchant resides in.
2546
2686
  #
@@ -2548,23 +2688,37 @@ module Increase
2548
2688
  #
2549
2689
  # @param merchant_descriptor [String] The merchant descriptor of the merchant the card is transacting with.
2550
2690
  #
2551
- # @param merchant_postal_code [String, nil] The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
2691
+ # @param merchant_postal_code [String, nil]
2692
+ # The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
2693
+ # ZIP code, where the first 5 and last 4 are separated by a dash.
2552
2694
  #
2553
2695
  # @param merchant_state [String, nil] The state the merchant resides in.
2554
2696
  #
2555
- # @param network_details [Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails] Fields specific to the `network`.
2697
+ # @param network_details [Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails]
2698
+ # Fields specific to the `network`.
2556
2699
  #
2557
- # @param network_identifiers [Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkIdentifiers] Network-specific identifiers for a specific request or transaction.
2700
+ # @param network_identifiers [Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkIdentifiers]
2701
+ # Network-specific identifiers for a specific request or transaction.
2558
2702
  #
2559
- # @param network_risk_score [Integer, nil] The risk score generated by the card network. For Visa this is the Visa Advanced
2703
+ # @param network_risk_score [Integer, nil]
2704
+ # The risk score generated by the card network. For Visa this is the Visa Advanced
2705
+ # Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
2706
+ # score is from 0 to 999, where 999 is the riskiest.
2560
2707
  #
2561
- # @param physical_card_id [String, nil] If the authorization was made in-person with a physical card, the Physical Card
2708
+ # @param physical_card_id [String, nil]
2709
+ # If the authorization was made in-person with a physical card, the Physical Card
2710
+ # that was used.
2562
2711
  #
2563
- # @param terminal_id [String, nil] The terminal identifier (commonly abbreviated as TID) of the terminal the card i
2712
+ # @param terminal_id [String, nil]
2713
+ # The terminal identifier (commonly abbreviated as TID) of the terminal the card
2714
+ # is transacting with.
2564
2715
  #
2565
- # @param upcoming_card_payment_id [String] The identifier of the Card Payment this authorization will belong to. Available
2716
+ # @param upcoming_card_payment_id [String]
2717
+ # The identifier of the Card Payment this authorization will belong to. Available
2718
+ # in the API once the card authorization has completed.
2566
2719
  #
2567
- # @param verification [Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification] Fields related to verification of cardholder-provided values.
2720
+ # @param verification [Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification]
2721
+ # Fields related to verification of cardholder-provided values.
2568
2722
 
2569
2723
  # @see Increase::Models::RealTimeDecision::CardBalanceInquiry#additional_amounts
2570
2724
  class AdditionalAmounts < Increase::Internal::Type::BaseModel
@@ -2649,33 +2803,39 @@ module Increase
2649
2803
  nil?: true
2650
2804
 
2651
2805
  # @!method initialize(clinic:, dental:, original:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
2652
- # Some parameter documentations has been truncated, see
2653
- # {Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts} for
2654
- # more details.
2655
- #
2656
2806
  # Additional amounts associated with the card authorization, such as ATM
2657
2807
  # surcharges fees. These are usually a subset of the `amount` field and are used
2658
2808
  # to provide more detailed information about the transaction.
2659
2809
  #
2660
- # @param clinic [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Clinic, nil] The part of this transaction amount that was for clinic-related services.
2810
+ # @param clinic [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Clinic, nil]
2811
+ # The part of this transaction amount that was for clinic-related services.
2661
2812
  #
2662
- # @param dental [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Dental, nil] The part of this transaction amount that was for dental-related services.
2813
+ # @param dental [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Dental, nil]
2814
+ # The part of this transaction amount that was for dental-related services.
2663
2815
  #
2664
- # @param original [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Original, nil] The original pre-authorized amount.
2816
+ # @param original [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Original, nil]
2817
+ # The original pre-authorized amount.
2665
2818
  #
2666
- # @param prescription [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Prescription, nil] The part of this transaction amount that was for healthcare prescriptions.
2819
+ # @param prescription [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Prescription, nil]
2820
+ # The part of this transaction amount that was for healthcare prescriptions.
2667
2821
  #
2668
- # @param surcharge [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Surcharge, nil] The surcharge amount charged for this transaction by the merchant.
2822
+ # @param surcharge [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Surcharge, nil]
2823
+ # The surcharge amount charged for this transaction by the merchant.
2669
2824
  #
2670
- # @param total_cumulative [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::TotalCumulative, nil] The total amount of a series of incremental authorizations, optionally provided.
2825
+ # @param total_cumulative [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::TotalCumulative, nil]
2826
+ # The total amount of a series of incremental authorizations, optionally provided.
2671
2827
  #
2672
- # @param total_healthcare [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::TotalHealthcare, nil] The total amount of healthcare-related additional amounts.
2828
+ # @param total_healthcare [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::TotalHealthcare, nil]
2829
+ # The total amount of healthcare-related additional amounts.
2673
2830
  #
2674
- # @param transit [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Transit, nil] The part of this transaction amount that was for transit-related services.
2831
+ # @param transit [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Transit, nil]
2832
+ # The part of this transaction amount that was for transit-related services.
2675
2833
  #
2676
- # @param unknown [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Unknown, nil] An unknown additional amount.
2834
+ # @param unknown [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Unknown, nil]
2835
+ # An unknown additional amount.
2677
2836
  #
2678
- # @param vision [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Vision, nil] The part of this transaction amount that was for vision-related services.
2837
+ # @param vision [Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Vision, nil]
2838
+ # The part of this transaction amount that was for vision-related services.
2679
2839
 
2680
2840
  # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts#clinic
2681
2841
  class Clinic < Increase::Internal::Type::BaseModel
@@ -2695,15 +2855,16 @@ module Increase
2695
2855
  required :currency, String
2696
2856
 
2697
2857
  # @!method initialize(amount:, currency:)
2698
- # Some parameter documentations has been truncated, see
2699
- # {Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Clinic}
2700
- # for more details.
2701
- #
2702
2858
  # The part of this transaction amount that was for clinic-related services.
2703
2859
  #
2704
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
2860
+ # @param amount [Integer]
2861
+ # The amount in minor units of the `currency` field. The amount is positive if it
2862
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
2863
+ # subtracted from the amount (such as a discount).
2705
2864
  #
2706
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2865
+ # @param currency [String]
2866
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2867
+ # amount's currency.
2707
2868
  end
2708
2869
 
2709
2870
  # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts#dental
@@ -2724,15 +2885,16 @@ module Increase
2724
2885
  required :currency, String
2725
2886
 
2726
2887
  # @!method initialize(amount:, currency:)
2727
- # Some parameter documentations has been truncated, see
2728
- # {Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Dental}
2729
- # for more details.
2730
- #
2731
2888
  # The part of this transaction amount that was for dental-related services.
2732
2889
  #
2733
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
2890
+ # @param amount [Integer]
2891
+ # The amount in minor units of the `currency` field. The amount is positive if it
2892
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
2893
+ # subtracted from the amount (such as a discount).
2734
2894
  #
2735
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2895
+ # @param currency [String]
2896
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2897
+ # amount's currency.
2736
2898
  end
2737
2899
 
2738
2900
  # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts#original
@@ -2753,15 +2915,16 @@ module Increase
2753
2915
  required :currency, String
2754
2916
 
2755
2917
  # @!method initialize(amount:, currency:)
2756
- # Some parameter documentations has been truncated, see
2757
- # {Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Original}
2758
- # for more details.
2759
- #
2760
2918
  # The original pre-authorized amount.
2761
2919
  #
2762
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
2920
+ # @param amount [Integer]
2921
+ # The amount in minor units of the `currency` field. The amount is positive if it
2922
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
2923
+ # subtracted from the amount (such as a discount).
2763
2924
  #
2764
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2925
+ # @param currency [String]
2926
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2927
+ # amount's currency.
2765
2928
  end
2766
2929
 
2767
2930
  # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts#prescription
@@ -2782,15 +2945,16 @@ module Increase
2782
2945
  required :currency, String
2783
2946
 
2784
2947
  # @!method initialize(amount:, currency:)
2785
- # Some parameter documentations has been truncated, see
2786
- # {Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Prescription}
2787
- # for more details.
2788
- #
2789
2948
  # The part of this transaction amount that was for healthcare prescriptions.
2790
2949
  #
2791
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
2950
+ # @param amount [Integer]
2951
+ # The amount in minor units of the `currency` field. The amount is positive if it
2952
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
2953
+ # subtracted from the amount (such as a discount).
2792
2954
  #
2793
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2955
+ # @param currency [String]
2956
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2957
+ # amount's currency.
2794
2958
  end
2795
2959
 
2796
2960
  # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts#surcharge
@@ -2811,15 +2975,16 @@ module Increase
2811
2975
  required :currency, String
2812
2976
 
2813
2977
  # @!method initialize(amount:, currency:)
2814
- # Some parameter documentations has been truncated, see
2815
- # {Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Surcharge}
2816
- # for more details.
2817
- #
2818
2978
  # The surcharge amount charged for this transaction by the merchant.
2819
2979
  #
2820
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
2980
+ # @param amount [Integer]
2981
+ # The amount in minor units of the `currency` field. The amount is positive if it
2982
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
2983
+ # subtracted from the amount (such as a discount).
2821
2984
  #
2822
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2985
+ # @param currency [String]
2986
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2987
+ # amount's currency.
2823
2988
  end
2824
2989
 
2825
2990
  # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts#total_cumulative
@@ -2840,15 +3005,16 @@ module Increase
2840
3005
  required :currency, String
2841
3006
 
2842
3007
  # @!method initialize(amount:, currency:)
2843
- # Some parameter documentations has been truncated, see
2844
- # {Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::TotalCumulative}
2845
- # for more details.
2846
- #
2847
3008
  # The total amount of a series of incremental authorizations, optionally provided.
2848
3009
  #
2849
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
3010
+ # @param amount [Integer]
3011
+ # The amount in minor units of the `currency` field. The amount is positive if it
3012
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
3013
+ # subtracted from the amount (such as a discount).
2850
3014
  #
2851
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
3015
+ # @param currency [String]
3016
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
3017
+ # amount's currency.
2852
3018
  end
2853
3019
 
2854
3020
  # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts#total_healthcare
@@ -2869,15 +3035,16 @@ module Increase
2869
3035
  required :currency, String
2870
3036
 
2871
3037
  # @!method initialize(amount:, currency:)
2872
- # Some parameter documentations has been truncated, see
2873
- # {Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::TotalHealthcare}
2874
- # for more details.
2875
- #
2876
3038
  # The total amount of healthcare-related additional amounts.
2877
3039
  #
2878
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
3040
+ # @param amount [Integer]
3041
+ # The amount in minor units of the `currency` field. The amount is positive if it
3042
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
3043
+ # subtracted from the amount (such as a discount).
2879
3044
  #
2880
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
3045
+ # @param currency [String]
3046
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
3047
+ # amount's currency.
2881
3048
  end
2882
3049
 
2883
3050
  # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts#transit
@@ -2898,15 +3065,16 @@ module Increase
2898
3065
  required :currency, String
2899
3066
 
2900
3067
  # @!method initialize(amount:, currency:)
2901
- # Some parameter documentations has been truncated, see
2902
- # {Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Transit}
2903
- # for more details.
2904
- #
2905
3068
  # The part of this transaction amount that was for transit-related services.
2906
3069
  #
2907
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
3070
+ # @param amount [Integer]
3071
+ # The amount in minor units of the `currency` field. The amount is positive if it
3072
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
3073
+ # subtracted from the amount (such as a discount).
2908
3074
  #
2909
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
3075
+ # @param currency [String]
3076
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
3077
+ # amount's currency.
2910
3078
  end
2911
3079
 
2912
3080
  # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts#unknown
@@ -2927,15 +3095,16 @@ module Increase
2927
3095
  required :currency, String
2928
3096
 
2929
3097
  # @!method initialize(amount:, currency:)
2930
- # Some parameter documentations has been truncated, see
2931
- # {Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Unknown}
2932
- # for more details.
2933
- #
2934
3098
  # An unknown additional amount.
2935
3099
  #
2936
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
3100
+ # @param amount [Integer]
3101
+ # The amount in minor units of the `currency` field. The amount is positive if it
3102
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
3103
+ # subtracted from the amount (such as a discount).
2937
3104
  #
2938
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
3105
+ # @param currency [String]
3106
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
3107
+ # amount's currency.
2939
3108
  end
2940
3109
 
2941
3110
  # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts#vision
@@ -2956,15 +3125,16 @@ module Increase
2956
3125
  required :currency, String
2957
3126
 
2958
3127
  # @!method initialize(amount:, currency:)
2959
- # Some parameter documentations has been truncated, see
2960
- # {Increase::Models::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts::Vision}
2961
- # for more details.
2962
- #
2963
3128
  # The part of this transaction amount that was for vision-related services.
2964
3129
  #
2965
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
3130
+ # @param amount [Integer]
3131
+ # The amount in minor units of the `currency` field. The amount is positive if it
3132
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
3133
+ # subtracted from the amount (such as a discount).
2966
3134
  #
2967
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
3135
+ # @param currency [String]
3136
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
3137
+ # amount's currency.
2968
3138
  end
2969
3139
  end
2970
3140
 
@@ -2978,14 +3148,12 @@ module Increase
2978
3148
  required :balance, Integer
2979
3149
 
2980
3150
  # @!method initialize(balance:)
2981
- # Some parameter documentations has been truncated, see
2982
- # {Increase::Models::RealTimeDecision::CardBalanceInquiry::Approval} for more
2983
- # details.
2984
- #
2985
3151
  # Present if and only if `decision` is `approve`. Contains information related to
2986
3152
  # the approval of the balance inquiry.
2987
3153
  #
2988
- # @param balance [Integer] If the balance inquiry was approved, this field contains the balance in the mino
3154
+ # @param balance [Integer]
3155
+ # If the balance inquiry was approved, this field contains the balance in the
3156
+ # minor unit of the settlement currency.
2989
3157
  end
2990
3158
 
2991
3159
  # Whether or not the authorization was approved.
@@ -3035,11 +3203,14 @@ module Increase
3035
3203
  # @!method initialize(category:, pulse:, visa:)
3036
3204
  # Fields specific to the `network`.
3037
3205
  #
3038
- # @param category [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Category] The payment network used to process this card authorization.
3206
+ # @param category [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Category]
3207
+ # The payment network used to process this card authorization.
3039
3208
  #
3040
- # @param pulse [Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Pulse, nil] Fields specific to the `pulse` network.
3209
+ # @param pulse [Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Pulse, nil]
3210
+ # Fields specific to the `pulse` network.
3041
3211
  #
3042
- # @param visa [Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa, nil] Fields specific to the `visa` network.
3212
+ # @param visa [Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa, nil]
3213
+ # Fields specific to the `visa` network.
3043
3214
 
3044
3215
  # The payment network used to process this card authorization.
3045
3216
  #
@@ -3114,19 +3285,27 @@ module Increase
3114
3285
  nil?: true
3115
3286
 
3116
3287
  # @!method initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:, terminal_entry_capability:)
3117
- # Some parameter documentations has been truncated, see
3118
- # {Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa}
3119
- # for more details.
3120
- #
3121
3288
  # Fields specific to the `visa` network.
3122
3289
  #
3123
- # @param electronic_commerce_indicator [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] For electronic commerce transactions, this identifies the level of security used
3290
+ # @param electronic_commerce_indicator [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa::ElectronicCommerceIndicator, nil]
3291
+ # For electronic commerce transactions, this identifies the level of security used
3292
+ # in obtaining the customer's payment credential. For mail or telephone order
3293
+ # transactions, identifies the type of mail or telephone order.
3124
3294
  #
3125
- # @param point_of_service_entry_mode [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa::PointOfServiceEntryMode, nil] The method used to enter the cardholder's primary account number and card expira
3295
+ # @param point_of_service_entry_mode [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa::PointOfServiceEntryMode, nil]
3296
+ # The method used to enter the cardholder's primary account number and card
3297
+ # expiration date.
3126
3298
  #
3127
- # @param stand_in_processing_reason [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa::StandInProcessingReason, nil] Only present when `actioner: network`. Describes why a card authorization was ap
3299
+ # @param stand_in_processing_reason [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa::StandInProcessingReason, nil]
3300
+ # Only present when `actioner: network`. Describes why a card authorization was
3301
+ # approved or declined by Visa through stand-in processing.
3128
3302
  #
3129
- # @param terminal_entry_capability [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa::TerminalEntryCapability, nil] The capability of the terminal being used to read the card. Shows whether a term
3303
+ # @param terminal_entry_capability [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkDetails::Visa::TerminalEntryCapability, nil]
3304
+ # The capability of the terminal being used to read the card. Shows whether a
3305
+ # terminal can e.g., accept chip cards or if it only supports magnetic stripe
3306
+ # reads. This reflects the highest capability of the terminal — for example, a
3307
+ # terminal that supports both chip and magnetic stripe will be identified as
3308
+ # chip-capable.
3130
3309
 
3131
3310
  # For electronic commerce transactions, this identifies the level of security used
3132
3311
  # in obtaining the customer's payment credential. For mail or telephone order
@@ -3315,19 +3494,24 @@ module Increase
3315
3494
  required :transaction_id, String, nil?: true
3316
3495
 
3317
3496
  # @!method initialize(authorization_identification_response:, retrieval_reference_number:, trace_number:, transaction_id:)
3318
- # Some parameter documentations has been truncated, see
3319
- # {Increase::Models::RealTimeDecision::CardBalanceInquiry::NetworkIdentifiers} for
3320
- # more details.
3321
- #
3322
3497
  # Network-specific identifiers for a specific request or transaction.
3323
3498
  #
3324
- # @param authorization_identification_response [String, nil] The randomly generated 6-character Authorization Identification Response code se
3499
+ # @param authorization_identification_response [String, nil]
3500
+ # The randomly generated 6-character Authorization Identification Response code
3501
+ # sent back to the acquirer in an approved response.
3325
3502
  #
3326
- # @param retrieval_reference_number [String, nil] A life-cycle identifier used across e.g., an authorization and a reversal. Expec
3503
+ # @param retrieval_reference_number [String, nil]
3504
+ # A life-cycle identifier used across e.g., an authorization and a reversal.
3505
+ # Expected to be unique per acquirer within a window of time. For some card
3506
+ # networks the retrieval reference number includes the trace counter.
3327
3507
  #
3328
- # @param trace_number [String, nil] A counter used to verify an individual authorization. Expected to be unique per
3508
+ # @param trace_number [String, nil]
3509
+ # A counter used to verify an individual authorization. Expected to be unique per
3510
+ # acquirer within a window of time.
3329
3511
  #
3330
- # @param transaction_id [String, nil] A globally unique transaction identifier provided by the card network, used acro
3512
+ # @param transaction_id [String, nil]
3513
+ # A globally unique transaction identifier provided by the card network, used
3514
+ # across multiple life-cycle requests.
3331
3515
  end
3332
3516
 
3333
3517
  # @see Increase::Models::RealTimeDecision::CardBalanceInquiry#verification
@@ -3357,17 +3541,18 @@ module Increase
3357
3541
  nil?: true
3358
3542
 
3359
3543
  # @!method initialize(card_verification_code:, cardholder_address:, cardholder_name:)
3360
- # Some parameter documentations has been truncated, see
3361
- # {Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification} for more
3362
- # details.
3363
- #
3364
3544
  # Fields related to verification of cardholder-provided values.
3365
3545
  #
3366
- # @param card_verification_code [Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification::CardVerificationCode] Fields related to verification of the Card Verification Code, a 3-digit code on
3546
+ # @param card_verification_code [Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification::CardVerificationCode]
3547
+ # Fields related to verification of the Card Verification Code, a 3-digit code on
3548
+ # the back of the card.
3367
3549
  #
3368
- # @param cardholder_address [Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification::CardholderAddress] Cardholder address provided in the authorization request and the address on file
3550
+ # @param cardholder_address [Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification::CardholderAddress]
3551
+ # Cardholder address provided in the authorization request and the address on file
3552
+ # we verified it against.
3369
3553
  #
3370
- # @param cardholder_name [Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification::CardholderName, nil] Cardholder name provided in the authorization request.
3554
+ # @param cardholder_name [Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification::CardholderName, nil]
3555
+ # Cardholder name provided in the authorization request.
3371
3556
 
3372
3557
  # @see Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification#card_verification_code
3373
3558
  class CardVerificationCode < Increase::Internal::Type::BaseModel
@@ -3382,7 +3567,8 @@ module Increase
3382
3567
  # Fields related to verification of the Card Verification Code, a 3-digit code on
3383
3568
  # the back of the card.
3384
3569
  #
3385
- # @param result [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification::CardVerificationCode::Result] The result of verifying the Card Verification Code.
3570
+ # @param result [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification::CardVerificationCode::Result]
3571
+ # The result of verifying the Card Verification Code.
3386
3572
 
3387
3573
  # The result of verifying the Card Verification Code.
3388
3574
  #
@@ -3439,10 +3625,6 @@ module Increase
3439
3625
  enum: -> { Increase::RealTimeDecision::CardBalanceInquiry::Verification::CardholderAddress::Result }
3440
3626
 
3441
3627
  # @!method initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:)
3442
- # Some parameter documentations has been truncated, see
3443
- # {Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification::CardholderAddress}
3444
- # for more details.
3445
- #
3446
3628
  # Cardholder address provided in the authorization request and the address on file
3447
3629
  # we verified it against.
3448
3630
  #
@@ -3450,11 +3632,15 @@ module Increase
3450
3632
  #
3451
3633
  # @param actual_postal_code [String, nil] The postal code of the address on file for the cardholder.
3452
3634
  #
3453
- # @param provided_line1 [String, nil] The cardholder address line 1 provided for verification in the authorization req
3635
+ # @param provided_line1 [String, nil]
3636
+ # The cardholder address line 1 provided for verification in the authorization
3637
+ # request.
3454
3638
  #
3455
- # @param provided_postal_code [String, nil] The postal code provided for verification in the authorization request.
3639
+ # @param provided_postal_code [String, nil]
3640
+ # The postal code provided for verification in the authorization request.
3456
3641
  #
3457
- # @param result [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification::CardholderAddress::Result] The address verification result returned to the card network.
3642
+ # @param result [Symbol, Increase::Models::RealTimeDecision::CardBalanceInquiry::Verification::CardholderAddress::Result]
3643
+ # The address verification result returned to the card network.
3458
3644
 
3459
3645
  # The address verification result returned to the card network.
3460
3646
  #
@@ -3508,11 +3694,14 @@ module Increase
3508
3694
  # @!method initialize(provided_first_name:, provided_last_name:, provided_middle_name:)
3509
3695
  # Cardholder name provided in the authorization request.
3510
3696
  #
3511
- # @param provided_first_name [String, nil] The first name provided for verification in the authorization request.
3697
+ # @param provided_first_name [String, nil]
3698
+ # The first name provided for verification in the authorization request.
3512
3699
  #
3513
- # @param provided_last_name [String, nil] The last name provided for verification in the authorization request.
3700
+ # @param provided_last_name [String, nil]
3701
+ # The last name provided for verification in the authorization request.
3514
3702
  #
3515
- # @param provided_middle_name [String, nil] The middle name provided for verification in the authorization request.
3703
+ # @param provided_middle_name [String, nil]
3704
+ # The middle name provided for verification in the authorization request.
3516
3705
  end
3517
3706
  end
3518
3707
  end
@@ -3596,25 +3785,26 @@ module Increase
3596
3785
  nil?: true
3597
3786
 
3598
3787
  # @!method initialize(card_id:, channel:, digital_wallet:, email:, one_time_passcode:, phone:, result:)
3599
- # Some parameter documentations has been truncated, see
3600
- # {Increase::Models::RealTimeDecision::DigitalWalletAuthentication} for more
3601
- # details.
3602
- #
3603
3788
  # Fields related to a digital wallet authentication attempt.
3604
3789
  #
3605
3790
  # @param card_id [String] The identifier of the Card that is being tokenized.
3606
3791
  #
3607
- # @param channel [Symbol, Increase::Models::RealTimeDecision::DigitalWalletAuthentication::Channel] The channel to send the card user their one-time passcode.
3792
+ # @param channel [Symbol, Increase::Models::RealTimeDecision::DigitalWalletAuthentication::Channel]
3793
+ # The channel to send the card user their one-time passcode.
3608
3794
  #
3609
- # @param digital_wallet [Symbol, Increase::Models::RealTimeDecision::DigitalWalletAuthentication::DigitalWallet] The digital wallet app being used.
3795
+ # @param digital_wallet [Symbol, Increase::Models::RealTimeDecision::DigitalWalletAuthentication::DigitalWallet]
3796
+ # The digital wallet app being used.
3610
3797
  #
3611
3798
  # @param email [String, nil] The email to send the one-time passcode to if `channel` is equal to `email`.
3612
3799
  #
3613
3800
  # @param one_time_passcode [String] The one-time passcode to send the card user.
3614
3801
  #
3615
- # @param phone [String, nil] The phone number to send the one-time passcode to if `channel` is equal to `sms`
3802
+ # @param phone [String, nil]
3803
+ # The phone number to send the one-time passcode to if `channel` is equal to
3804
+ # `sms`.
3616
3805
  #
3617
- # @param result [Symbol, Increase::Models::RealTimeDecision::DigitalWalletAuthentication::Result, nil] Whether your application successfully delivered the one-time passcode.
3806
+ # @param result [Symbol, Increase::Models::RealTimeDecision::DigitalWalletAuthentication::Result, nil]
3807
+ # Whether your application successfully delivered the one-time passcode.
3618
3808
 
3619
3809
  # The channel to send the card user their one-time passcode.
3620
3810
  #
@@ -3699,18 +3889,19 @@ module Increase
3699
3889
  required :digital_wallet, enum: -> { Increase::RealTimeDecision::DigitalWalletToken::DigitalWallet }
3700
3890
 
3701
3891
  # @!method initialize(card_id:, decision:, device:, digital_wallet:)
3702
- # Some parameter documentations has been truncated, see
3703
- # {Increase::Models::RealTimeDecision::DigitalWalletToken} for more details.
3704
- #
3705
3892
  # Fields related to a digital wallet token provisioning attempt.
3706
3893
  #
3707
3894
  # @param card_id [String] The identifier of the Card that is being tokenized.
3708
3895
  #
3709
- # @param decision [Symbol, Increase::Models::RealTimeDecision::DigitalWalletToken::Decision, nil] Whether or not the provisioning request was approved. This will be null until th
3896
+ # @param decision [Symbol, Increase::Models::RealTimeDecision::DigitalWalletToken::Decision, nil]
3897
+ # Whether or not the provisioning request was approved. This will be null until
3898
+ # the real time decision is responded to.
3710
3899
  #
3711
- # @param device [Increase::Models::RealTimeDecision::DigitalWalletToken::Device] Device that is being used to provision the digital wallet token.
3900
+ # @param device [Increase::Models::RealTimeDecision::DigitalWalletToken::Device]
3901
+ # Device that is being used to provision the digital wallet token.
3712
3902
  #
3713
- # @param digital_wallet [Symbol, Increase::Models::RealTimeDecision::DigitalWalletToken::DigitalWallet] The digital wallet app being used.
3903
+ # @param digital_wallet [Symbol, Increase::Models::RealTimeDecision::DigitalWalletToken::DigitalWallet]
3904
+ # The digital wallet app being used.
3714
3905
 
3715
3906
  # Whether or not the provisioning request was approved. This will be null until
3716
3907
  # the real time decision is responded to.