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
@@ -75,9 +75,6 @@ module Increase
75
75
  required :type, enum: -> { Increase::DeclinedTransaction::Type }
76
76
 
77
77
  # @!method initialize(id:, account_id:, amount:, created_at:, currency:, description:, route_id:, route_type:, source:, type:)
78
- # Some parameter documentations has been truncated, see
79
- # {Increase::Models::DeclinedTransaction} for more details.
80
- #
81
78
  # Declined Transactions are refused additions and removals of money from your bank
82
79
  # account. For example, Declined Transactions are caused when your Account has an
83
80
  # insufficient balance or your Limits are triggered.
@@ -86,21 +83,38 @@ module Increase
86
83
  #
87
84
  # @param account_id [String] The identifier for the Account the Declined Transaction belongs to.
88
85
  #
89
- # @param amount [Integer] The Declined Transaction amount in the minor unit of its currency. For dollars,
86
+ # @param amount [Integer]
87
+ # The Declined Transaction amount in the minor unit of its currency. For dollars,
88
+ # for example, this is cents.
90
89
  #
91
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Transac
90
+ # @param created_at [Time]
91
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
92
+ # Transaction occurred.
92
93
  #
93
- # @param currency [Symbol, Increase::Models::DeclinedTransaction::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined Tra
94
+ # @param currency [Symbol, Increase::Models::DeclinedTransaction::Currency]
95
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined
96
+ # Transaction's currency. This will match the currency on the Declined
97
+ # Transaction's Account.
94
98
  #
95
99
  # @param description [String] This is the description the vendor provides.
96
100
  #
97
- # @param route_id [String, nil] The identifier for the route this Declined Transaction came through. Routes are
101
+ # @param route_id [String, nil]
102
+ # The identifier for the route this Declined Transaction came through. Routes are
103
+ # things like cards and ACH details.
98
104
  #
99
- # @param route_type [Symbol, Increase::Models::DeclinedTransaction::RouteType, nil] The type of the route this Declined Transaction came through.
105
+ # @param route_type [Symbol, Increase::Models::DeclinedTransaction::RouteType, nil]
106
+ # The type of the route this Declined Transaction came through.
100
107
  #
101
- # @param source [Increase::Models::DeclinedTransaction::Source] This is an object giving more details on the network-level event that caused the
108
+ # @param source [Increase::Models::DeclinedTransaction::Source]
109
+ # This is an object giving more details on the network-level event that caused the
110
+ # Declined Transaction. For example, for a card transaction this lists the
111
+ # merchant's industry and location. Note that for backwards compatibility reasons,
112
+ # additional undocumented keys may appear in this object. These should be treated
113
+ # as deprecated and will be removed in the future.
102
114
  #
103
- # @param type [Symbol, Increase::Models::DeclinedTransaction::Type] A constant representing the object's type. For this resource it will always be `
115
+ # @param type [Symbol, Increase::Models::DeclinedTransaction::Type]
116
+ # A constant representing the object's type. For this resource it will always be
117
+ # `declined_transaction`.
104
118
 
105
119
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined
106
120
  # Transaction's currency. This will match the currency on the Declined
@@ -210,32 +224,49 @@ module Increase
210
224
  optional :wire_decline, -> { Increase::DeclinedTransaction::Source::WireDecline }, nil?: true
211
225
 
212
226
  # @!method initialize(category:, ach_decline: nil, card_decline: nil, check_decline: nil, check_deposit_rejection: nil, inbound_fednow_transfer_decline: nil, inbound_real_time_payments_transfer_decline: nil, other: nil, wire_decline: nil)
213
- # Some parameter documentations has been truncated, see
214
- # {Increase::Models::DeclinedTransaction::Source} for more details.
215
- #
216
227
  # This is an object giving more details on the network-level event that caused the
217
228
  # Declined Transaction. For example, for a card transaction this lists the
218
229
  # merchant's industry and location. Note that for backwards compatibility reasons,
219
230
  # additional undocumented keys may appear in this object. These should be treated
220
231
  # as deprecated and will be removed in the future.
221
232
  #
222
- # @param category [Symbol, Increase::Models::DeclinedTransaction::Source::Category] The type of the resource. We may add additional possible values for this enum ov
233
+ # @param category [Symbol, Increase::Models::DeclinedTransaction::Source::Category]
234
+ # The type of the resource. We may add additional possible values for this enum
235
+ # over time; your application should be able to handle such additions gracefully.
223
236
  #
224
- # @param ach_decline [Increase::Models::DeclinedTransaction::Source::ACHDecline, nil] An ACH Decline object. This field will be present in the JSON response if and on
237
+ # @param ach_decline [Increase::Models::DeclinedTransaction::Source::ACHDecline, nil]
238
+ # An ACH Decline object. This field will be present in the JSON response if and
239
+ # only if `category` is equal to `ach_decline`.
225
240
  #
226
- # @param card_decline [Increase::Models::DeclinedTransaction::Source::CardDecline, nil] A Card Decline object. This field will be present in the JSON response if and on
241
+ # @param card_decline [Increase::Models::DeclinedTransaction::Source::CardDecline, nil]
242
+ # A Card Decline object. This field will be present in the JSON response if and
243
+ # only if `category` is equal to `card_decline`.
227
244
  #
228
- # @param check_decline [Increase::Models::DeclinedTransaction::Source::CheckDecline, nil] A Check Decline object. This field will be present in the JSON response if and o
245
+ # @param check_decline [Increase::Models::DeclinedTransaction::Source::CheckDecline, nil]
246
+ # A Check Decline object. This field will be present in the JSON response if and
247
+ # only if `category` is equal to `check_decline`.
229
248
  #
230
- # @param check_deposit_rejection [Increase::Models::DeclinedTransaction::Source::CheckDepositRejection, nil] A Check Deposit Rejection object. This field will be present in the JSON respons
249
+ # @param check_deposit_rejection [Increase::Models::DeclinedTransaction::Source::CheckDepositRejection, nil]
250
+ # A Check Deposit Rejection object. This field will be present in the JSON
251
+ # response if and only if `category` is equal to `check_deposit_rejection`.
231
252
  #
232
- # @param inbound_fednow_transfer_decline [Increase::Models::DeclinedTransaction::Source::InboundFednowTransferDecline, nil] An Inbound FedNow Transfer Decline object. This field will be present in the JSO
253
+ # @param inbound_fednow_transfer_decline [Increase::Models::DeclinedTransaction::Source::InboundFednowTransferDecline, nil]
254
+ # An Inbound FedNow Transfer Decline object. This field will be present in the
255
+ # JSON response if and only if `category` is equal to
256
+ # `inbound_fednow_transfer_decline`.
233
257
  #
234
- # @param inbound_real_time_payments_transfer_decline [Increase::Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline, nil] An Inbound Real-Time Payments Transfer Decline object. This field will be presen
258
+ # @param inbound_real_time_payments_transfer_decline [Increase::Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline, nil]
259
+ # An Inbound Real-Time Payments Transfer Decline object. This field will be
260
+ # present in the JSON response if and only if `category` is equal to
261
+ # `inbound_real_time_payments_transfer_decline`.
235
262
  #
236
- # @param other [Increase::Models::DeclinedTransaction::Source::Other, nil] If the category of this Transaction source is equal to `other`, this field will
263
+ # @param other [Increase::Models::DeclinedTransaction::Source::Other, nil]
264
+ # If the category of this Transaction source is equal to `other`, this field will
265
+ # contain an empty object, otherwise it will contain null.
237
266
  #
238
- # @param wire_decline [Increase::Models::DeclinedTransaction::Source::WireDecline, nil] A Wire Decline object. This field will be present in the JSON response if and on
267
+ # @param wire_decline [Increase::Models::DeclinedTransaction::Source::WireDecline, nil]
268
+ # A Wire Decline object. This field will be present in the JSON response if and
269
+ # only if `category` is equal to `wire_decline`.
239
270
 
240
271
  # The type of the resource. We may add additional possible values for this enum
241
272
  # over time; your application should be able to handle such additions gracefully.
@@ -348,9 +379,6 @@ module Increase
348
379
  required :type, enum: -> { Increase::DeclinedTransaction::Source::ACHDecline::Type }
349
380
 
350
381
  # @!method initialize(id:, amount:, inbound_ach_transfer_id:, originator_company_descriptive_date:, originator_company_discretionary_data:, originator_company_id:, originator_company_name:, reason:, receiver_id_number:, receiver_name:, trace_number:, type:)
351
- # Some parameter documentations has been truncated, see
352
- # {Increase::Models::DeclinedTransaction::Source::ACHDecline} for more details.
353
- #
354
382
  # An ACH Decline object. This field will be present in the JSON response if and
355
383
  # only if `category` is equal to `ach_decline`.
356
384
  #
@@ -358,17 +386,20 @@ module Increase
358
386
  #
359
387
  # @param amount [Integer] The declined amount in USD cents.
360
388
  #
361
- # @param inbound_ach_transfer_id [String] The identifier of the Inbound ACH Transfer object associated with this decline.
389
+ # @param inbound_ach_transfer_id [String]
390
+ # The identifier of the Inbound ACH Transfer object associated with this decline.
362
391
  #
363
392
  # @param originator_company_descriptive_date [String, nil] The descriptive date of the transfer.
364
393
  #
365
- # @param originator_company_discretionary_data [String, nil] The additional information included with the transfer.
394
+ # @param originator_company_discretionary_data [String, nil]
395
+ # The additional information included with the transfer.
366
396
  #
367
397
  # @param originator_company_id [String] The identifier of the company that initiated the transfer.
368
398
  #
369
399
  # @param originator_company_name [String] The name of the company that initiated the transfer.
370
400
  #
371
- # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::ACHDecline::Reason] Why the ACH transfer was declined.
401
+ # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::ACHDecline::Reason]
402
+ # Why the ACH transfer was declined.
372
403
  #
373
404
  # @param receiver_id_number [String, nil] The id of the receiver of the transfer.
374
405
  #
@@ -376,7 +407,9 @@ module Increase
376
407
  #
377
408
  # @param trace_number [String] The trace number of the transfer.
378
409
  #
379
- # @param type [Symbol, Increase::Models::DeclinedTransaction::Source::ACHDecline::Type] A constant representing the object's type. For this resource it will always be `
410
+ # @param type [Symbol, Increase::Models::DeclinedTransaction::Source::ACHDecline::Type]
411
+ # A constant representing the object's type. For this resource it will always be
412
+ # `ach_decline`.
380
413
 
381
414
  # Why the ACH transfer was declined.
382
415
  #
@@ -662,35 +695,52 @@ module Increase
662
695
  required :verification, -> { Increase::DeclinedTransaction::Source::CardDecline::Verification }
663
696
 
664
697
  # @!method initialize(id:, actioner:, additional_amounts:, amount:, card_payment_id:, currency:, declined_transaction_id:, digital_wallet_token_id:, direction:, incremented_card_authorization_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:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, real_time_decision_reason:, reason:, scheme_fees:, terminal_id:, verification:)
665
- # Some parameter documentations has been truncated, see
666
- # {Increase::Models::DeclinedTransaction::Source::CardDecline} for more details.
667
- #
668
698
  # A Card Decline object. This field will be present in the JSON response if and
669
699
  # only if `category` is equal to `card_decline`.
670
700
  #
671
701
  # @param id [String] The Card Decline identifier.
672
702
  #
673
- # @param actioner [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Actioner] Whether this authorization was approved by Increase, the card network through st
703
+ # @param actioner [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Actioner]
704
+ # Whether this authorization was approved by Increase, the card network through
705
+ # stand-in processing, or the user through a real-time decision.
674
706
  #
675
- # @param additional_amounts [Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts] Additional amounts associated with the card authorization, such as ATM surcharge
707
+ # @param additional_amounts [Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts]
708
+ # Additional amounts associated with the card authorization, such as ATM
709
+ # surcharges fees. These are usually a subset of the `amount` field and are used
710
+ # to provide more detailed information about the transaction.
676
711
  #
677
- # @param amount [Integer] The declined amount in the minor unit of the destination account currency. For d
712
+ # @param amount [Integer]
713
+ # The declined amount in the minor unit of the destination account currency. For
714
+ # dollars, for example, this is cents.
678
715
  #
679
716
  # @param card_payment_id [String] The ID of the Card Payment this transaction belongs to.
680
717
  #
681
- # @param currency [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
718
+ # @param currency [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Currency]
719
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
720
+ # account currency.
682
721
  #
683
- # @param declined_transaction_id [String] The identifier of the declined transaction created for this Card Decline.
722
+ # @param declined_transaction_id [String]
723
+ # The identifier of the declined transaction created for this Card Decline.
684
724
  #
685
- # @param digital_wallet_token_id [String, nil] If the authorization was made via a Digital Wallet Token (such as an Apple Pay p
725
+ # @param digital_wallet_token_id [String, nil]
726
+ # If the authorization was made via a Digital Wallet Token (such as an Apple Pay
727
+ # purchase), the identifier of the token that was used.
686
728
  #
687
- # @param direction [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Direction] The direction describes the direction the funds will move, either from the cardh
729
+ # @param direction [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Direction]
730
+ # The direction describes the direction the funds will move, either from the
731
+ # cardholder to the merchant or from the merchant to the cardholder.
688
732
  #
689
- # @param incremented_card_authorization_id [String, nil] The identifier of the card authorization this request attempted to incrementally
733
+ # @param incremented_card_authorization_id [String, nil]
734
+ # The identifier of the card authorization this request attempted to incrementally
735
+ # authorize.
690
736
  #
691
- # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i
737
+ # @param merchant_acceptor_id [String]
738
+ # The merchant identifier (commonly abbreviated as MID) of the merchant the card
739
+ # is transacting with.
692
740
  #
693
- # @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car
741
+ # @param merchant_category_code [String]
742
+ # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
743
+ # card is transacting with.
694
744
  #
695
745
  # @param merchant_city [String, nil] The city the merchant resides in.
696
746
  #
@@ -698,35 +748,58 @@ module Increase
698
748
  #
699
749
  # @param merchant_descriptor [String] The merchant descriptor of the merchant the card is transacting with.
700
750
  #
701
- # @param merchant_postal_code [String, nil] The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
751
+ # @param merchant_postal_code [String, nil]
752
+ # The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
753
+ # ZIP code, where the first 5 and last 4 are separated by a dash.
702
754
  #
703
755
  # @param merchant_state [String, nil] The state the merchant resides in.
704
756
  #
705
- # @param network_details [Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails] Fields specific to the `network`.
757
+ # @param network_details [Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails]
758
+ # Fields specific to the `network`.
706
759
  #
707
- # @param network_identifiers [Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkIdentifiers] Network-specific identifiers for a specific request or transaction.
760
+ # @param network_identifiers [Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkIdentifiers]
761
+ # Network-specific identifiers for a specific request or transaction.
708
762
  #
709
- # @param network_risk_score [Integer, nil] The risk score generated by the card network. For Visa this is the Visa Advanced
763
+ # @param network_risk_score [Integer, nil]
764
+ # The risk score generated by the card network. For Visa this is the Visa Advanced
765
+ # Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
766
+ # score is from 0 to 999, where 999 is the riskiest.
710
767
  #
711
- # @param physical_card_id [String, nil] If the authorization was made in-person with a physical card, the Physical Card
768
+ # @param physical_card_id [String, nil]
769
+ # If the authorization was made in-person with a physical card, the Physical Card
770
+ # that was used.
712
771
  #
713
- # @param presentment_amount [Integer] The declined amount in the minor unit of the transaction's presentment currency.
772
+ # @param presentment_amount [Integer]
773
+ # The declined amount in the minor unit of the transaction's presentment currency.
714
774
  #
715
- # @param presentment_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction'
775
+ # @param presentment_currency [String]
776
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
777
+ # transaction's presentment currency.
716
778
  #
717
- # @param processing_category [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::ProcessingCategory] The processing category describes the intent behind the authorization, such as w
779
+ # @param processing_category [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::ProcessingCategory]
780
+ # The processing category describes the intent behind the authorization, such as
781
+ # whether it was used for bill payments or an automatic fuel dispenser.
718
782
  #
719
- # @param real_time_decision_id [String, nil] The identifier of the Real-Time Decision sent to approve or decline this transac
783
+ # @param real_time_decision_id [String, nil]
784
+ # The identifier of the Real-Time Decision sent to approve or decline this
785
+ # transaction.
720
786
  #
721
- # @param real_time_decision_reason [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::RealTimeDecisionReason, nil] This is present if a specific decline reason was given in the real-time decision
787
+ # @param real_time_decision_reason [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::RealTimeDecisionReason, nil]
788
+ # This is present if a specific decline reason was given in the real-time
789
+ # decision.
722
790
  #
723
- # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Reason] Why the transaction was declined.
791
+ # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Reason]
792
+ # Why the transaction was declined.
724
793
  #
725
- # @param scheme_fees [Array<Increase::Models::DeclinedTransaction::Source::CardDecline::SchemeFee>] The scheme fees associated with this card decline.
794
+ # @param scheme_fees [Array<Increase::Models::DeclinedTransaction::Source::CardDecline::SchemeFee>]
795
+ # The scheme fees associated with this card decline.
726
796
  #
727
- # @param terminal_id [String, nil] The terminal identifier (commonly abbreviated as TID) of the terminal the card i
797
+ # @param terminal_id [String, nil]
798
+ # The terminal identifier (commonly abbreviated as TID) of the terminal the card
799
+ # is transacting with.
728
800
  #
729
- # @param verification [Increase::Models::DeclinedTransaction::Source::CardDecline::Verification] Fields related to verification of cardholder-provided values.
801
+ # @param verification [Increase::Models::DeclinedTransaction::Source::CardDecline::Verification]
802
+ # Fields related to verification of cardholder-provided values.
730
803
 
731
804
  # Whether this authorization was approved by Increase, the card network through
732
805
  # stand-in processing, or the user through a real-time decision.
@@ -837,33 +910,39 @@ module Increase
837
910
  nil?: true
838
911
 
839
912
  # @!method initialize(clinic:, dental:, original:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
840
- # Some parameter documentations has been truncated, see
841
- # {Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts}
842
- # for more details.
843
- #
844
913
  # Additional amounts associated with the card authorization, such as ATM
845
914
  # surcharges fees. These are usually a subset of the `amount` field and are used
846
915
  # to provide more detailed information about the transaction.
847
916
  #
848
- # @param clinic [Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::Clinic, nil] The part of this transaction amount that was for clinic-related services.
917
+ # @param clinic [Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::Clinic, nil]
918
+ # The part of this transaction amount that was for clinic-related services.
849
919
  #
850
- # @param dental [Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::Dental, nil] The part of this transaction amount that was for dental-related services.
920
+ # @param dental [Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::Dental, nil]
921
+ # The part of this transaction amount that was for dental-related services.
851
922
  #
852
- # @param original [Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::Original, nil] The original pre-authorized amount.
923
+ # @param original [Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::Original, nil]
924
+ # The original pre-authorized amount.
853
925
  #
854
- # @param prescription [Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::Prescription, nil] The part of this transaction amount that was for healthcare prescriptions.
926
+ # @param prescription [Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::Prescription, nil]
927
+ # The part of this transaction amount that was for healthcare prescriptions.
855
928
  #
856
- # @param surcharge [Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::Surcharge, nil] The surcharge amount charged for this transaction by the merchant.
929
+ # @param surcharge [Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::Surcharge, nil]
930
+ # The surcharge amount charged for this transaction by the merchant.
857
931
  #
858
- # @param total_cumulative [Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::TotalCumulative, nil] The total amount of a series of incremental authorizations, optionally provided.
932
+ # @param total_cumulative [Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::TotalCumulative, nil]
933
+ # The total amount of a series of incremental authorizations, optionally provided.
859
934
  #
860
- # @param total_healthcare [Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::TotalHealthcare, nil] The total amount of healthcare-related additional amounts.
935
+ # @param total_healthcare [Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::TotalHealthcare, nil]
936
+ # The total amount of healthcare-related additional amounts.
861
937
  #
862
- # @param transit [Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::Transit, nil] The part of this transaction amount that was for transit-related services.
938
+ # @param transit [Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::Transit, nil]
939
+ # The part of this transaction amount that was for transit-related services.
863
940
  #
864
- # @param unknown [Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::Unknown, nil] An unknown additional amount.
941
+ # @param unknown [Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::Unknown, nil]
942
+ # An unknown additional amount.
865
943
  #
866
- # @param vision [Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::Vision, nil] The part of this transaction amount that was for vision-related services.
944
+ # @param vision [Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::Vision, nil]
945
+ # The part of this transaction amount that was for vision-related services.
867
946
 
868
947
  # @see Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts#clinic
869
948
  class Clinic < Increase::Internal::Type::BaseModel
@@ -883,15 +962,16 @@ module Increase
883
962
  required :currency, String
884
963
 
885
964
  # @!method initialize(amount:, currency:)
886
- # Some parameter documentations has been truncated, see
887
- # {Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::Clinic}
888
- # for more details.
889
- #
890
965
  # The part of this transaction amount that was for clinic-related services.
891
966
  #
892
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
967
+ # @param amount [Integer]
968
+ # The amount in minor units of the `currency` field. The amount is positive if it
969
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
970
+ # subtracted from the amount (such as a discount).
893
971
  #
894
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
972
+ # @param currency [String]
973
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
974
+ # amount's currency.
895
975
  end
896
976
 
897
977
  # @see Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts#dental
@@ -912,15 +992,16 @@ module Increase
912
992
  required :currency, String
913
993
 
914
994
  # @!method initialize(amount:, currency:)
915
- # Some parameter documentations has been truncated, see
916
- # {Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::Dental}
917
- # for more details.
918
- #
919
995
  # The part of this transaction amount that was for dental-related services.
920
996
  #
921
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
997
+ # @param amount [Integer]
998
+ # The amount in minor units of the `currency` field. The amount is positive if it
999
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1000
+ # subtracted from the amount (such as a discount).
922
1001
  #
923
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1002
+ # @param currency [String]
1003
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1004
+ # amount's currency.
924
1005
  end
925
1006
 
926
1007
  # @see Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts#original
@@ -941,15 +1022,16 @@ module Increase
941
1022
  required :currency, String
942
1023
 
943
1024
  # @!method initialize(amount:, currency:)
944
- # Some parameter documentations has been truncated, see
945
- # {Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::Original}
946
- # for more details.
947
- #
948
1025
  # The original pre-authorized amount.
949
1026
  #
950
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1027
+ # @param amount [Integer]
1028
+ # The amount in minor units of the `currency` field. The amount is positive if it
1029
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1030
+ # subtracted from the amount (such as a discount).
951
1031
  #
952
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1032
+ # @param currency [String]
1033
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1034
+ # amount's currency.
953
1035
  end
954
1036
 
955
1037
  # @see Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts#prescription
@@ -970,15 +1052,16 @@ module Increase
970
1052
  required :currency, String
971
1053
 
972
1054
  # @!method initialize(amount:, currency:)
973
- # Some parameter documentations has been truncated, see
974
- # {Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::Prescription}
975
- # for more details.
976
- #
977
1055
  # The part of this transaction amount that was for healthcare prescriptions.
978
1056
  #
979
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1057
+ # @param amount [Integer]
1058
+ # The amount in minor units of the `currency` field. The amount is positive if it
1059
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1060
+ # subtracted from the amount (such as a discount).
980
1061
  #
981
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1062
+ # @param currency [String]
1063
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1064
+ # amount's currency.
982
1065
  end
983
1066
 
984
1067
  # @see Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts#surcharge
@@ -999,15 +1082,16 @@ module Increase
999
1082
  required :currency, String
1000
1083
 
1001
1084
  # @!method initialize(amount:, currency:)
1002
- # Some parameter documentations has been truncated, see
1003
- # {Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::Surcharge}
1004
- # for more details.
1005
- #
1006
1085
  # The surcharge amount charged for this transaction by the merchant.
1007
1086
  #
1008
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1087
+ # @param amount [Integer]
1088
+ # The amount in minor units of the `currency` field. The amount is positive if it
1089
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1090
+ # subtracted from the amount (such as a discount).
1009
1091
  #
1010
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1092
+ # @param currency [String]
1093
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1094
+ # amount's currency.
1011
1095
  end
1012
1096
 
1013
1097
  # @see Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts#total_cumulative
@@ -1028,15 +1112,16 @@ module Increase
1028
1112
  required :currency, String
1029
1113
 
1030
1114
  # @!method initialize(amount:, currency:)
1031
- # Some parameter documentations has been truncated, see
1032
- # {Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::TotalCumulative}
1033
- # for more details.
1034
- #
1035
1115
  # The total amount of a series of incremental authorizations, optionally provided.
1036
1116
  #
1037
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1117
+ # @param amount [Integer]
1118
+ # The amount in minor units of the `currency` field. The amount is positive if it
1119
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1120
+ # subtracted from the amount (such as a discount).
1038
1121
  #
1039
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1122
+ # @param currency [String]
1123
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1124
+ # amount's currency.
1040
1125
  end
1041
1126
 
1042
1127
  # @see Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts#total_healthcare
@@ -1057,15 +1142,16 @@ module Increase
1057
1142
  required :currency, String
1058
1143
 
1059
1144
  # @!method initialize(amount:, currency:)
1060
- # Some parameter documentations has been truncated, see
1061
- # {Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::TotalHealthcare}
1062
- # for more details.
1063
- #
1064
1145
  # The total amount of healthcare-related additional amounts.
1065
1146
  #
1066
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1147
+ # @param amount [Integer]
1148
+ # The amount in minor units of the `currency` field. The amount is positive if it
1149
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1150
+ # subtracted from the amount (such as a discount).
1067
1151
  #
1068
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1152
+ # @param currency [String]
1153
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1154
+ # amount's currency.
1069
1155
  end
1070
1156
 
1071
1157
  # @see Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts#transit
@@ -1086,15 +1172,16 @@ module Increase
1086
1172
  required :currency, String
1087
1173
 
1088
1174
  # @!method initialize(amount:, currency:)
1089
- # Some parameter documentations has been truncated, see
1090
- # {Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::Transit}
1091
- # for more details.
1092
- #
1093
1175
  # The part of this transaction amount that was for transit-related services.
1094
1176
  #
1095
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1177
+ # @param amount [Integer]
1178
+ # The amount in minor units of the `currency` field. The amount is positive if it
1179
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1180
+ # subtracted from the amount (such as a discount).
1096
1181
  #
1097
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1182
+ # @param currency [String]
1183
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1184
+ # amount's currency.
1098
1185
  end
1099
1186
 
1100
1187
  # @see Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts#unknown
@@ -1115,15 +1202,16 @@ module Increase
1115
1202
  required :currency, String
1116
1203
 
1117
1204
  # @!method initialize(amount:, currency:)
1118
- # Some parameter documentations has been truncated, see
1119
- # {Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::Unknown}
1120
- # for more details.
1121
- #
1122
1205
  # An unknown additional amount.
1123
1206
  #
1124
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1207
+ # @param amount [Integer]
1208
+ # The amount in minor units of the `currency` field. The amount is positive if it
1209
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1210
+ # subtracted from the amount (such as a discount).
1125
1211
  #
1126
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1212
+ # @param currency [String]
1213
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1214
+ # amount's currency.
1127
1215
  end
1128
1216
 
1129
1217
  # @see Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts#vision
@@ -1144,15 +1232,16 @@ module Increase
1144
1232
  required :currency, String
1145
1233
 
1146
1234
  # @!method initialize(amount:, currency:)
1147
- # Some parameter documentations has been truncated, see
1148
- # {Increase::Models::DeclinedTransaction::Source::CardDecline::AdditionalAmounts::Vision}
1149
- # for more details.
1150
- #
1151
1235
  # The part of this transaction amount that was for vision-related services.
1152
1236
  #
1153
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1237
+ # @param amount [Integer]
1238
+ # The amount in minor units of the `currency` field. The amount is positive if it
1239
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1240
+ # subtracted from the amount (such as a discount).
1154
1241
  #
1155
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1242
+ # @param currency [String]
1243
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1244
+ # amount's currency.
1156
1245
  end
1157
1246
  end
1158
1247
 
@@ -1215,11 +1304,14 @@ module Increase
1215
1304
  # @!method initialize(category:, pulse:, visa:)
1216
1305
  # Fields specific to the `network`.
1217
1306
  #
1218
- # @param category [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Category] The payment network used to process this card authorization.
1307
+ # @param category [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Category]
1308
+ # The payment network used to process this card authorization.
1219
1309
  #
1220
- # @param pulse [Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Pulse, nil] Fields specific to the `pulse` network.
1310
+ # @param pulse [Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Pulse, nil]
1311
+ # Fields specific to the `pulse` network.
1221
1312
  #
1222
- # @param visa [Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa, nil] Fields specific to the `visa` network.
1313
+ # @param visa [Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa, nil]
1314
+ # Fields specific to the `visa` network.
1223
1315
 
1224
1316
  # The payment network used to process this card authorization.
1225
1317
  #
@@ -1294,19 +1386,27 @@ module Increase
1294
1386
  nil?: true
1295
1387
 
1296
1388
  # @!method initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:, terminal_entry_capability:)
1297
- # Some parameter documentations has been truncated, see
1298
- # {Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa}
1299
- # for more details.
1300
- #
1301
1389
  # Fields specific to the `visa` network.
1302
1390
  #
1303
- # @param electronic_commerce_indicator [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] For electronic commerce transactions, this identifies the level of security used
1391
+ # @param electronic_commerce_indicator [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::ElectronicCommerceIndicator, nil]
1392
+ # For electronic commerce transactions, this identifies the level of security used
1393
+ # in obtaining the customer's payment credential. For mail or telephone order
1394
+ # transactions, identifies the type of mail or telephone order.
1304
1395
  #
1305
- # @param point_of_service_entry_mode [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::PointOfServiceEntryMode, nil] The method used to enter the cardholder's primary account number and card expira
1396
+ # @param point_of_service_entry_mode [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::PointOfServiceEntryMode, nil]
1397
+ # The method used to enter the cardholder's primary account number and card
1398
+ # expiration date.
1306
1399
  #
1307
- # @param stand_in_processing_reason [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::StandInProcessingReason, nil] Only present when `actioner: network`. Describes why a card authorization was ap
1400
+ # @param stand_in_processing_reason [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::StandInProcessingReason, nil]
1401
+ # Only present when `actioner: network`. Describes why a card authorization was
1402
+ # approved or declined by Visa through stand-in processing.
1308
1403
  #
1309
- # @param terminal_entry_capability [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::TerminalEntryCapability, nil] The capability of the terminal being used to read the card. Shows whether a term
1404
+ # @param terminal_entry_capability [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkDetails::Visa::TerminalEntryCapability, nil]
1405
+ # The capability of the terminal being used to read the card. Shows whether a
1406
+ # terminal can e.g., accept chip cards or if it only supports magnetic stripe
1407
+ # reads. This reflects the highest capability of the terminal — for example, a
1408
+ # terminal that supports both chip and magnetic stripe will be identified as
1409
+ # chip-capable.
1310
1410
 
1311
1411
  # For electronic commerce transactions, this identifies the level of security used
1312
1412
  # in obtaining the customer's payment credential. For mail or telephone order
@@ -1495,19 +1595,24 @@ module Increase
1495
1595
  required :transaction_id, String, nil?: true
1496
1596
 
1497
1597
  # @!method initialize(authorization_identification_response:, retrieval_reference_number:, trace_number:, transaction_id:)
1498
- # Some parameter documentations has been truncated, see
1499
- # {Increase::Models::DeclinedTransaction::Source::CardDecline::NetworkIdentifiers}
1500
- # for more details.
1501
- #
1502
1598
  # Network-specific identifiers for a specific request or transaction.
1503
1599
  #
1504
- # @param authorization_identification_response [String, nil] The randomly generated 6-character Authorization Identification Response code se
1600
+ # @param authorization_identification_response [String, nil]
1601
+ # The randomly generated 6-character Authorization Identification Response code
1602
+ # sent back to the acquirer in an approved response.
1505
1603
  #
1506
- # @param retrieval_reference_number [String, nil] A life-cycle identifier used across e.g., an authorization and a reversal. Expec
1604
+ # @param retrieval_reference_number [String, nil]
1605
+ # A life-cycle identifier used across e.g., an authorization and a reversal.
1606
+ # Expected to be unique per acquirer within a window of time. For some card
1607
+ # networks the retrieval reference number includes the trace counter.
1507
1608
  #
1508
- # @param trace_number [String, nil] A counter used to verify an individual authorization. Expected to be unique per
1609
+ # @param trace_number [String, nil]
1610
+ # A counter used to verify an individual authorization. Expected to be unique per
1611
+ # acquirer within a window of time.
1509
1612
  #
1510
- # @param transaction_id [String, nil] A globally unique transaction identifier provided by the card network, used acro
1613
+ # @param transaction_id [String, nil]
1614
+ # A globally unique transaction identifier provided by the card network, used
1615
+ # across multiple life-cycle requests.
1511
1616
  end
1512
1617
 
1513
1618
  # The processing category describes the intent behind the authorization, such as
@@ -1698,21 +1803,26 @@ module Increase
1698
1803
  required :variable_rate, String, nil?: true
1699
1804
 
1700
1805
  # @!method initialize(amount:, created_at:, currency:, fee_type:, fixed_component:, variable_rate:)
1701
- # Some parameter documentations has been truncated, see
1702
- # {Increase::Models::DeclinedTransaction::Source::CardDecline::SchemeFee} for more
1703
- # details.
1704
- #
1705
1806
  # @param amount [String] The fee amount given as a string containing a decimal number.
1706
1807
  #
1707
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was
1808
+ # @param created_at [Time]
1809
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was
1810
+ # created.
1708
1811
  #
1709
- # @param currency [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::SchemeFee::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimburs
1812
+ # @param currency [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::SchemeFee::Currency]
1813
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
1814
+ # reimbursement.
1710
1815
  #
1711
- # @param fee_type [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType] The type of fee being assessed.
1816
+ # @param fee_type [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType]
1817
+ # The type of fee being assessed.
1712
1818
  #
1713
- # @param fixed_component [String, nil] The fixed component of the fee, if applicable, given in major units of the fee a
1819
+ # @param fixed_component [String, nil]
1820
+ # The fixed component of the fee, if applicable, given in major units of the fee
1821
+ # amount.
1714
1822
  #
1715
- # @param variable_rate [String, nil] The variable rate component of the fee, if applicable, given as a decimal (e.g.,
1823
+ # @param variable_rate [String, nil]
1824
+ # The variable rate component of the fee, if applicable, given as a decimal (e.g.,
1825
+ # 0.015 for 1.5%).
1716
1826
 
1717
1827
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
1718
1828
  # reimbursement.
@@ -1856,17 +1966,18 @@ module Increase
1856
1966
  nil?: true
1857
1967
 
1858
1968
  # @!method initialize(card_verification_code:, cardholder_address:, cardholder_name:)
1859
- # Some parameter documentations has been truncated, see
1860
- # {Increase::Models::DeclinedTransaction::Source::CardDecline::Verification} for
1861
- # more details.
1862
- #
1863
1969
  # Fields related to verification of cardholder-provided values.
1864
1970
  #
1865
- # @param card_verification_code [Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardVerificationCode] Fields related to verification of the Card Verification Code, a 3-digit code on
1971
+ # @param card_verification_code [Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardVerificationCode]
1972
+ # Fields related to verification of the Card Verification Code, a 3-digit code on
1973
+ # the back of the card.
1866
1974
  #
1867
- # @param cardholder_address [Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress] Cardholder address provided in the authorization request and the address on file
1975
+ # @param cardholder_address [Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress]
1976
+ # Cardholder address provided in the authorization request and the address on file
1977
+ # we verified it against.
1868
1978
  #
1869
- # @param cardholder_name [Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardholderName, nil] Cardholder name provided in the authorization request.
1979
+ # @param cardholder_name [Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardholderName, nil]
1980
+ # Cardholder name provided in the authorization request.
1870
1981
 
1871
1982
  # @see Increase::Models::DeclinedTransaction::Source::CardDecline::Verification#card_verification_code
1872
1983
  class CardVerificationCode < Increase::Internal::Type::BaseModel
@@ -1881,7 +1992,8 @@ module Increase
1881
1992
  # Fields related to verification of the Card Verification Code, a 3-digit code on
1882
1993
  # the back of the card.
1883
1994
  #
1884
- # @param result [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardVerificationCode::Result] The result of verifying the Card Verification Code.
1995
+ # @param result [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardVerificationCode::Result]
1996
+ # The result of verifying the Card Verification Code.
1885
1997
 
1886
1998
  # The result of verifying the Card Verification Code.
1887
1999
  #
@@ -1938,10 +2050,6 @@ module Increase
1938
2050
  enum: -> { Increase::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress::Result }
1939
2051
 
1940
2052
  # @!method initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:)
1941
- # Some parameter documentations has been truncated, see
1942
- # {Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress}
1943
- # for more details.
1944
- #
1945
2053
  # Cardholder address provided in the authorization request and the address on file
1946
2054
  # we verified it against.
1947
2055
  #
@@ -1949,11 +2057,15 @@ module Increase
1949
2057
  #
1950
2058
  # @param actual_postal_code [String, nil] The postal code of the address on file for the cardholder.
1951
2059
  #
1952
- # @param provided_line1 [String, nil] The cardholder address line 1 provided for verification in the authorization req
2060
+ # @param provided_line1 [String, nil]
2061
+ # The cardholder address line 1 provided for verification in the authorization
2062
+ # request.
1953
2063
  #
1954
- # @param provided_postal_code [String, nil] The postal code provided for verification in the authorization request.
2064
+ # @param provided_postal_code [String, nil]
2065
+ # The postal code provided for verification in the authorization request.
1955
2066
  #
1956
- # @param result [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress::Result] The address verification result returned to the card network.
2067
+ # @param result [Symbol, Increase::Models::DeclinedTransaction::Source::CardDecline::Verification::CardholderAddress::Result]
2068
+ # The address verification result returned to the card network.
1957
2069
 
1958
2070
  # The address verification result returned to the card network.
1959
2071
  #
@@ -2007,11 +2119,14 @@ module Increase
2007
2119
  # @!method initialize(provided_first_name:, provided_last_name:, provided_middle_name:)
2008
2120
  # Cardholder name provided in the authorization request.
2009
2121
  #
2010
- # @param provided_first_name [String, nil] The first name provided for verification in the authorization request.
2122
+ # @param provided_first_name [String, nil]
2123
+ # The first name provided for verification in the authorization request.
2011
2124
  #
2012
- # @param provided_last_name [String, nil] The last name provided for verification in the authorization request.
2125
+ # @param provided_last_name [String, nil]
2126
+ # The last name provided for verification in the authorization request.
2013
2127
  #
2014
- # @param provided_middle_name [String, nil] The middle name provided for verification in the authorization request.
2128
+ # @param provided_middle_name [String, nil]
2129
+ # The middle name provided for verification in the authorization request.
2015
2130
  end
2016
2131
  end
2017
2132
  end
@@ -2065,25 +2180,32 @@ module Increase
2065
2180
  required :reason, enum: -> { Increase::DeclinedTransaction::Source::CheckDecline::Reason }
2066
2181
 
2067
2182
  # @!method initialize(amount:, auxiliary_on_us:, back_image_file_id:, check_transfer_id:, front_image_file_id:, inbound_check_deposit_id:, reason:)
2068
- # Some parameter documentations has been truncated, see
2069
- # {Increase::Models::DeclinedTransaction::Source::CheckDecline} for more details.
2070
- #
2071
2183
  # A Check Decline object. This field will be present in the JSON response if and
2072
2184
  # only if `category` is equal to `check_decline`.
2073
2185
  #
2074
2186
  # @param amount [Integer] The declined amount in USD cents.
2075
2187
  #
2076
- # @param auxiliary_on_us [String, nil] A computer-readable number printed on the MICR line of business checks, usually
2188
+ # @param auxiliary_on_us [String, nil]
2189
+ # A computer-readable number printed on the MICR line of business checks, usually
2190
+ # the check number. This is useful for positive pay checks, but can be unreliably
2191
+ # transmitted by the bank of first deposit.
2077
2192
  #
2078
- # @param back_image_file_id [String, nil] The identifier of the API File object containing an image of the back of the dec
2193
+ # @param back_image_file_id [String, nil]
2194
+ # The identifier of the API File object containing an image of the back of the
2195
+ # declined check.
2079
2196
  #
2080
- # @param check_transfer_id [String, nil] The identifier of the Check Transfer object associated with this decline.
2197
+ # @param check_transfer_id [String, nil]
2198
+ # The identifier of the Check Transfer object associated with this decline.
2081
2199
  #
2082
- # @param front_image_file_id [String, nil] The identifier of the API File object containing an image of the front of the de
2200
+ # @param front_image_file_id [String, nil]
2201
+ # The identifier of the API File object containing an image of the front of the
2202
+ # declined check.
2083
2203
  #
2084
- # @param inbound_check_deposit_id [String, nil] The identifier of the Inbound Check Deposit object associated with this decline.
2204
+ # @param inbound_check_deposit_id [String, nil]
2205
+ # The identifier of the Inbound Check Deposit object associated with this decline.
2085
2206
  #
2086
- # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::CheckDecline::Reason] Why the check was declined.
2207
+ # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::CheckDecline::Reason]
2208
+ # Why the check was declined.
2087
2209
 
2088
2210
  # Why the check was declined.
2089
2211
  #
@@ -2192,24 +2314,27 @@ module Increase
2192
2314
  required :rejected_at, Time
2193
2315
 
2194
2316
  # @!method initialize(amount:, check_deposit_id:, currency:, declined_transaction_id:, reason:, rejected_at:)
2195
- # Some parameter documentations has been truncated, see
2196
- # {Increase::Models::DeclinedTransaction::Source::CheckDepositRejection} for more
2197
- # details.
2198
- #
2199
2317
  # A Check Deposit Rejection object. This field will be present in the JSON
2200
2318
  # response if and only if `category` is equal to `check_deposit_rejection`.
2201
2319
  #
2202
- # @param amount [Integer] The rejected amount in the minor unit of check's currency. For dollars, for exam
2320
+ # @param amount [Integer]
2321
+ # The rejected amount in the minor unit of check's currency. For dollars, for
2322
+ # example, this is cents.
2203
2323
  #
2204
2324
  # @param check_deposit_id [String] The identifier of the Check Deposit that was rejected.
2205
2325
  #
2206
- # @param currency [Symbol, Increase::Models::DeclinedTransaction::Source::CheckDepositRejection::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's curr
2326
+ # @param currency [Symbol, Increase::Models::DeclinedTransaction::Source::CheckDepositRejection::Currency]
2327
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
2328
+ # currency.
2207
2329
  #
2208
2330
  # @param declined_transaction_id [String] The identifier of the associated declined transaction.
2209
2331
  #
2210
- # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::CheckDepositRejection::Reason] Why the check deposit was rejected.
2332
+ # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::CheckDepositRejection::Reason]
2333
+ # Why the check deposit was rejected.
2211
2334
  #
2212
- # @param rejected_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
2335
+ # @param rejected_at [Time]
2336
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
2337
+ # the check deposit was rejected.
2213
2338
 
2214
2339
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
2215
2340
  # currency.
@@ -2291,7 +2416,8 @@ module Increase
2291
2416
  # JSON response if and only if `category` is equal to
2292
2417
  # `inbound_fednow_transfer_decline`.
2293
2418
  #
2294
- # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::InboundFednowTransferDecline::Reason] Why the transfer was declined.
2419
+ # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::InboundFednowTransferDecline::Reason]
2420
+ # Why the transfer was declined.
2295
2421
  #
2296
2422
  # @param transfer_id [String] The identifier of the FedNow Transfer that led to this declined transaction.
2297
2423
 
@@ -2392,19 +2518,21 @@ module Increase
2392
2518
  required :unstructured_remittance_information, String, nil?: true
2393
2519
 
2394
2520
  # @!method initialize(amount:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, reason:, transaction_identification:, transfer_id:, unstructured_remittance_information:)
2395
- # Some parameter documentations has been truncated, see
2396
- # {Increase::Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline}
2397
- # for more details.
2398
- #
2399
2521
  # An Inbound Real-Time Payments Transfer Decline object. This field will be
2400
2522
  # present in the JSON response if and only if `category` is equal to
2401
2523
  # `inbound_real_time_payments_transfer_decline`.
2402
2524
  #
2403
- # @param amount [Integer] The declined amount in the minor unit of the destination account currency. For d
2525
+ # @param amount [Integer]
2526
+ # The declined amount in the minor unit of the destination account currency. For
2527
+ # dollars, for example, this is cents.
2404
2528
  #
2405
- # @param creditor_name [String] The name the sender of the transfer specified as the recipient of the transfer.
2529
+ # @param creditor_name [String]
2530
+ # The name the sender of the transfer specified as the recipient of the transfer.
2406
2531
  #
2407
- # @param currency [Symbol, Increase::Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined tran
2532
+ # @param currency [Symbol, Increase::Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline::Currency]
2533
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined
2534
+ # transfer's currency. This will always be "USD" for a Real-Time Payments
2535
+ # transfer.
2408
2536
  #
2409
2537
  # @param debtor_account_number [String] The account number of the account that sent the transfer.
2410
2538
  #
@@ -2412,13 +2540,17 @@ module Increase
2412
2540
  #
2413
2541
  # @param debtor_routing_number [String] The routing number of the account that sent the transfer.
2414
2542
  #
2415
- # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline::Reason] Why the transfer was declined.
2543
+ # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::InboundRealTimePaymentsTransferDecline::Reason]
2544
+ # Why the transfer was declined.
2416
2545
  #
2417
- # @param transaction_identification [String] The Real-Time Payments network identification of the declined transfer.
2546
+ # @param transaction_identification [String]
2547
+ # The Real-Time Payments network identification of the declined transfer.
2418
2548
  #
2419
- # @param transfer_id [String] The identifier of the Real-Time Payments Transfer that led to this Transaction.
2549
+ # @param transfer_id [String]
2550
+ # The identifier of the Real-Time Payments Transfer that led to this Transaction.
2420
2551
  #
2421
- # @param unstructured_remittance_information [String, nil] Additional information included with the transfer.
2552
+ # @param unstructured_remittance_information [String, nil]
2553
+ # Additional information included with the transfer.
2422
2554
 
2423
2555
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined
2424
2556
  # transfer's currency. This will always be "USD" for a Real-Time Payments
@@ -2491,7 +2623,8 @@ module Increase
2491
2623
  #
2492
2624
  # @param inbound_wire_transfer_id [String] The identifier of the Inbound Wire Transfer that was declined.
2493
2625
  #
2494
- # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::WireDecline::Reason] Why the wire transfer was declined.
2626
+ # @param reason [Symbol, Increase::Models::DeclinedTransaction::Source::WireDecline::Reason]
2627
+ # Why the wire transfer was declined.
2495
2628
 
2496
2629
  # Why the wire transfer was declined.
2497
2630
  #