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
@@ -76,9 +76,6 @@ module Increase
76
76
  required :type, enum: -> { Increase::Transaction::Type }
77
77
 
78
78
  # @!method initialize(id:, account_id:, amount:, created_at:, currency:, description:, route_id:, route_type:, source:, type:)
79
- # Some parameter documentations has been truncated, see
80
- # {Increase::Models::Transaction} for more details.
81
- #
82
79
  # Transactions are the immutable additions and removals of money from your bank
83
80
  # account. They're the equivalent of line items on your bank statement. To learn
84
81
  # more, see [Transactions and Transfers](/documentation/transactions-transfers).
@@ -87,21 +84,40 @@ module Increase
87
84
  #
88
85
  # @param account_id [String] The identifier for the Account the Transaction belongs to.
89
86
  #
90
- # @param amount [Integer] The Transaction amount in the minor unit of its currency. For dollars, for examp
87
+ # @param amount [Integer]
88
+ # The Transaction amount in the minor unit of its currency. For dollars, for
89
+ # example, this is cents.
91
90
  #
92
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
91
+ # @param created_at [Time]
92
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
93
+ # the Transaction occurred.
93
94
  #
94
- # @param currency [Symbol, Increase::Models::Transaction::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Transaction'
95
+ # @param currency [Symbol, Increase::Models::Transaction::Currency]
96
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
97
+ # Transaction's currency. This will match the currency on the Transaction's
98
+ # Account.
95
99
  #
96
- # @param description [String] An informational message describing this transaction. Use the fields in `source`
100
+ # @param description [String]
101
+ # An informational message describing this transaction. Use the fields in `source`
102
+ # to get more detailed information. This field appears as the line-item on the
103
+ # statement.
97
104
  #
98
- # @param route_id [String, nil] The identifier for the route this Transaction came through. Routes are things li
105
+ # @param route_id [String, nil]
106
+ # The identifier for the route this Transaction came through. Routes are things
107
+ # like cards and ACH details.
99
108
  #
100
- # @param route_type [Symbol, Increase::Models::Transaction::RouteType, nil] The type of the route this Transaction came through.
109
+ # @param route_type [Symbol, Increase::Models::Transaction::RouteType, nil]
110
+ # The type of the route this Transaction came through.
101
111
  #
102
- # @param source [Increase::Models::Transaction::Source] This is an object giving more details on the network-level event that caused the
112
+ # @param source [Increase::Models::Transaction::Source]
113
+ # This is an object giving more details on the network-level event that caused the
114
+ # Transaction. Note that for backwards compatibility reasons, additional
115
+ # undocumented keys may appear in this object. These should be treated as
116
+ # deprecated and will be removed in the future.
103
117
  #
104
- # @param type [Symbol, Increase::Models::Transaction::Type] A constant representing the object's type. For this resource it will always be `
118
+ # @param type [Symbol, Increase::Models::Transaction::Type]
119
+ # A constant representing the object's type. For this resource it will always be
120
+ # `transaction`.
105
121
 
106
122
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
107
123
  # Transaction's currency. This will match the currency on the Transaction's
@@ -547,91 +563,244 @@ module Increase
547
563
  nil?: true
548
564
 
549
565
  # @!method initialize(category:, account_revenue_payment: nil, account_transfer_intention: nil, ach_transfer_intention: nil, ach_transfer_rejection: nil, ach_transfer_return: nil, blockchain_offramp_transfer_settlement: nil, blockchain_onramp_transfer_intention: nil, card_dispute_acceptance: nil, card_dispute_financial: nil, card_dispute_loss: nil, card_financial: nil, card_push_transfer_acceptance: nil, card_refund: nil, card_revenue_payment: nil, card_settlement: nil, cashback_payment: nil, check_deposit_acceptance: nil, check_deposit_return: nil, check_transfer_deposit: nil, fednow_transfer_acknowledgement: nil, fee_payment: nil, inbound_ach_transfer: nil, inbound_ach_transfer_return_intention: nil, inbound_check_adjustment: nil, inbound_check_deposit_return_intention: nil, inbound_fednow_transfer_confirmation: nil, inbound_real_time_payments_transfer_confirmation: nil, inbound_wire_reversal: nil, inbound_wire_transfer: nil, inbound_wire_transfer_reversal: nil, interest_payment: nil, internal_source: nil, other: nil, real_time_payments_transfer_acknowledgement: nil, sample_funds: nil, swift_transfer_intention: nil, swift_transfer_return: nil, wire_transfer_intention: nil)
550
- # Some parameter documentations has been truncated, see
551
- # {Increase::Models::Transaction::Source} for more details.
552
- #
553
566
  # This is an object giving more details on the network-level event that caused the
554
567
  # Transaction. Note that for backwards compatibility reasons, additional
555
568
  # undocumented keys may appear in this object. These should be treated as
556
569
  # deprecated and will be removed in the future.
557
570
  #
558
- # @param category [Symbol, Increase::Models::Transaction::Source::Category] The type of the resource. We may add additional possible values for this enum ov
571
+ # @param category [Symbol, Increase::Models::Transaction::Source::Category]
572
+ # The type of the resource. We may add additional possible values for this enum
573
+ # over time; your application should be able to handle such additions gracefully.
559
574
  #
560
- # @param account_revenue_payment [Increase::Models::Transaction::Source::AccountRevenuePayment, nil] An Account Revenue Payment object. This field will be present in the JSON respon
575
+ # @param account_revenue_payment [Increase::Models::Transaction::Source::AccountRevenuePayment, nil]
576
+ # An Account Revenue Payment object. This field will be present in the JSON
577
+ # response if and only if `category` is equal to `account_revenue_payment`. An
578
+ # Account Revenue Payment represents a payment made to an account from the bank.
579
+ # Account revenue is a type of non-interest income.
561
580
  #
562
- # @param account_transfer_intention [Increase::Models::Transaction::Source::AccountTransferIntention, nil] An Account Transfer Intention object. This field will be present in the JSON res
581
+ # @param account_transfer_intention [Increase::Models::Transaction::Source::AccountTransferIntention, nil]
582
+ # An Account Transfer Intention object. This field will be present in the JSON
583
+ # response if and only if `category` is equal to `account_transfer_intention`. Two
584
+ # Account Transfer Intentions are created from each Account Transfer. One
585
+ # decrements the source account, and the other increments the destination account.
563
586
  #
564
- # @param ach_transfer_intention [Increase::Models::Transaction::Source::ACHTransferIntention, nil] An ACH Transfer Intention object. This field will be present in the JSON respons
587
+ # @param ach_transfer_intention [Increase::Models::Transaction::Source::ACHTransferIntention, nil]
588
+ # An ACH Transfer Intention object. This field will be present in the JSON
589
+ # response if and only if `category` is equal to `ach_transfer_intention`. An ACH
590
+ # Transfer Intention is created from an ACH Transfer. It reflects the intention to
591
+ # move money into or out of an Increase account via the ACH network.
565
592
  #
566
- # @param ach_transfer_rejection [Increase::Models::Transaction::Source::ACHTransferRejection, nil] An ACH Transfer Rejection object. This field will be present in the JSON respons
593
+ # @param ach_transfer_rejection [Increase::Models::Transaction::Source::ACHTransferRejection, nil]
594
+ # An ACH Transfer Rejection object. This field will be present in the JSON
595
+ # response if and only if `category` is equal to `ach_transfer_rejection`. An ACH
596
+ # Transfer Rejection is created when an ACH Transfer is rejected by Increase. It
597
+ # offsets the ACH Transfer Intention. These rejections are rare.
567
598
  #
568
- # @param ach_transfer_return [Increase::Models::Transaction::Source::ACHTransferReturn, nil] An ACH Transfer Return object. This field will be present in the JSON response i
599
+ # @param ach_transfer_return [Increase::Models::Transaction::Source::ACHTransferReturn, nil]
600
+ # An ACH Transfer Return object. This field will be present in the JSON response
601
+ # if and only if `category` is equal to `ach_transfer_return`. An ACH Transfer
602
+ # Return is created when an ACH Transfer is returned by the receiving bank. It
603
+ # offsets the ACH Transfer Intention. ACH Transfer Returns usually occur within
604
+ # the first two business days after the transfer is initiated, but can occur much
605
+ # later. The return appears as a new posted Transaction; no Pending Transaction is
606
+ # created.
569
607
  #
570
- # @param blockchain_offramp_transfer_settlement [Increase::Models::Transaction::Source::BlockchainOfframpTransferSettlement, nil] A Blockchain Off-Ramp Transfer Settlement object. This field will be present in
608
+ # @param blockchain_offramp_transfer_settlement [Increase::Models::Transaction::Source::BlockchainOfframpTransferSettlement, nil]
609
+ # A Blockchain Off-Ramp Transfer Settlement object. This field will be present in
610
+ # the JSON response if and only if `category` is equal to
611
+ # `blockchain_offramp_transfer_settlement`.
571
612
  #
572
- # @param blockchain_onramp_transfer_intention [Increase::Models::Transaction::Source::BlockchainOnrampTransferIntention, nil] A Blockchain On-Ramp Transfer Intention object. This field will be present in th
613
+ # @param blockchain_onramp_transfer_intention [Increase::Models::Transaction::Source::BlockchainOnrampTransferIntention, nil]
614
+ # A Blockchain On-Ramp Transfer Intention object. This field will be present in
615
+ # the JSON response if and only if `category` is equal to
616
+ # `blockchain_onramp_transfer_intention`.
573
617
  #
574
- # @param card_dispute_acceptance [Increase::Models::Transaction::Source::CardDisputeAcceptance, nil] A Legacy Card Dispute Acceptance object. This field will be present in the JSON
618
+ # @param card_dispute_acceptance [Increase::Models::Transaction::Source::CardDisputeAcceptance, nil]
619
+ # A Legacy Card Dispute Acceptance object. This field will be present in the JSON
620
+ # response if and only if `category` is equal to `card_dispute_acceptance`.
621
+ # Contains the details of a successful Card Dispute.
575
622
  #
576
- # @param card_dispute_financial [Increase::Models::Transaction::Source::CardDisputeFinancial, nil] A Card Dispute Financial object. This field will be present in the JSON response
623
+ # @param card_dispute_financial [Increase::Models::Transaction::Source::CardDisputeFinancial, nil]
624
+ # A Card Dispute Financial object. This field will be present in the JSON response
625
+ # if and only if `category` is equal to `card_dispute_financial`. Financial event
626
+ # related to a Card Dispute.
577
627
  #
578
- # @param card_dispute_loss [Increase::Models::Transaction::Source::CardDisputeLoss, nil] A Legacy Card Dispute Loss object. This field will be present in the JSON respon
628
+ # @param card_dispute_loss [Increase::Models::Transaction::Source::CardDisputeLoss, nil]
629
+ # A Legacy Card Dispute Loss object. This field will be present in the JSON
630
+ # response if and only if `category` is equal to `card_dispute_loss`. Contains the
631
+ # details of a lost Card Dispute.
579
632
  #
580
- # @param card_financial [Increase::Models::Transaction::Source::CardFinancial, nil] A Card Financial object. This field will be present in the JSON response if and
633
+ # @param card_financial [Increase::Models::Transaction::Source::CardFinancial, nil]
634
+ # A Card Financial object. This field will be present in the JSON response if and
635
+ # only if `category` is equal to `card_financial`. Card Financials are card
636
+ # transactions that have cleared and settled. Unlike a Card Settlement, which
637
+ # clears a previous authorization, a Card Financial is authorized and cleared in a
638
+ # single message.
581
639
  #
582
- # @param card_push_transfer_acceptance [Increase::Models::Transaction::Source::CardPushTransferAcceptance, nil] A Card Push Transfer Acceptance object. This field will be present in the JSON r
640
+ # @param card_push_transfer_acceptance [Increase::Models::Transaction::Source::CardPushTransferAcceptance, nil]
641
+ # A Card Push Transfer Acceptance object. This field will be present in the JSON
642
+ # response if and only if `category` is equal to `card_push_transfer_acceptance`.
643
+ # A Card Push Transfer Acceptance is created when an Outbound Card Push Transfer
644
+ # sent from Increase is accepted by the receiving bank.
583
645
  #
584
- # @param card_refund [Increase::Models::Transaction::Source::CardRefund, nil] A Card Refund object. This field will be present in the JSON response if and onl
646
+ # @param card_refund [Increase::Models::Transaction::Source::CardRefund, nil]
647
+ # A Card Refund object. This field will be present in the JSON response if and
648
+ # only if `category` is equal to `card_refund`. Card Refunds move money back to
649
+ # the cardholder. While they are usually connected to a Card Settlement, an
650
+ # acquirer can also refund money directly to a card without relation to a
651
+ # transaction.
585
652
  #
586
- # @param card_revenue_payment [Increase::Models::Transaction::Source::CardRevenuePayment, nil] A Card Revenue Payment object. This field will be present in the JSON response i
653
+ # @param card_revenue_payment [Increase::Models::Transaction::Source::CardRevenuePayment, nil]
654
+ # A Card Revenue Payment object. This field will be present in the JSON response
655
+ # if and only if `category` is equal to `card_revenue_payment`. Card Revenue
656
+ # Payments reflect earnings from fees on card transactions.
587
657
  #
588
- # @param card_settlement [Increase::Models::Transaction::Source::CardSettlement, nil] A Card Settlement object. This field will be present in the JSON response if and
658
+ # @param card_settlement [Increase::Models::Transaction::Source::CardSettlement, nil]
659
+ # A Card Settlement object. This field will be present in the JSON response if and
660
+ # only if `category` is equal to `card_settlement`. Card Settlements are card
661
+ # transactions that have cleared and settled. While a settlement is usually
662
+ # preceded by an authorization, an acquirer can also directly clear a transaction
663
+ # without first authorizing it.
589
664
  #
590
- # @param cashback_payment [Increase::Models::Transaction::Source::CashbackPayment, nil] A Cashback Payment object. This field will be present in the JSON response if an
665
+ # @param cashback_payment [Increase::Models::Transaction::Source::CashbackPayment, nil]
666
+ # A Cashback Payment object. This field will be present in the JSON response if
667
+ # and only if `category` is equal to `cashback_payment`. A Cashback Payment
668
+ # represents the cashback paid to a cardholder for a given period. Cashback is
669
+ # usually paid monthly for the prior month's transactions.
591
670
  #
592
- # @param check_deposit_acceptance [Increase::Models::Transaction::Source::CheckDepositAcceptance, nil] A Check Deposit Acceptance object. This field will be present in the JSON respon
671
+ # @param check_deposit_acceptance [Increase::Models::Transaction::Source::CheckDepositAcceptance, nil]
672
+ # A Check Deposit Acceptance object. This field will be present in the JSON
673
+ # response if and only if `category` is equal to `check_deposit_acceptance`. A
674
+ # Check Deposit Acceptance is created when a Check Deposit is processed and its
675
+ # details confirmed. Check Deposits may be returned by the receiving bank, which
676
+ # will appear as a Check Deposit Return.
593
677
  #
594
- # @param check_deposit_return [Increase::Models::Transaction::Source::CheckDepositReturn, nil] A Check Deposit Return object. This field will be present in the JSON response i
678
+ # @param check_deposit_return [Increase::Models::Transaction::Source::CheckDepositReturn, nil]
679
+ # A Check Deposit Return object. This field will be present in the JSON response
680
+ # if and only if `category` is equal to `check_deposit_return`. A Check Deposit
681
+ # Return is created when a Check Deposit is returned by the bank holding the
682
+ # account it was drawn against. Check Deposits may be returned for a variety of
683
+ # reasons, including insufficient funds or a mismatched account number. Usually,
684
+ # checks are returned within the first 7 days after the deposit is made.
595
685
  #
596
- # @param check_transfer_deposit [Increase::Models::Transaction::Source::CheckTransferDeposit, nil] A Check Transfer Deposit object. This field will be present in the JSON response
686
+ # @param check_transfer_deposit [Increase::Models::Transaction::Source::CheckTransferDeposit, nil]
687
+ # A Check Transfer Deposit object. This field will be present in the JSON response
688
+ # if and only if `category` is equal to `check_transfer_deposit`. An Inbound Check
689
+ # is a check drawn on an Increase account that has been deposited by an external
690
+ # bank account. These types of checks are not pre-registered.
597
691
  #
598
- # @param fednow_transfer_acknowledgement [Increase::Models::Transaction::Source::FednowTransferAcknowledgement, nil] A FedNow Transfer Acknowledgement object. This field will be present in the JSON
692
+ # @param fednow_transfer_acknowledgement [Increase::Models::Transaction::Source::FednowTransferAcknowledgement, nil]
693
+ # A FedNow Transfer Acknowledgement object. This field will be present in the JSON
694
+ # response if and only if `category` is equal to
695
+ # `fednow_transfer_acknowledgement`. A FedNow Transfer Acknowledgement is created
696
+ # when a FedNow Transfer sent from Increase is acknowledged by the receiving bank.
599
697
  #
600
- # @param fee_payment [Increase::Models::Transaction::Source::FeePayment, nil] A Fee Payment object. This field will be present in the JSON response if and onl
698
+ # @param fee_payment [Increase::Models::Transaction::Source::FeePayment, nil]
699
+ # A Fee Payment object. This field will be present in the JSON response if and
700
+ # only if `category` is equal to `fee_payment`. A Fee Payment represents a payment
701
+ # made to Increase.
601
702
  #
602
- # @param inbound_ach_transfer [Increase::Models::Transaction::Source::InboundACHTransfer, nil] An Inbound ACH Transfer Intention object. This field will be present in the JSON
703
+ # @param inbound_ach_transfer [Increase::Models::Transaction::Source::InboundACHTransfer, nil]
704
+ # An Inbound ACH Transfer Intention object. This field will be present in the JSON
705
+ # response if and only if `category` is equal to `inbound_ach_transfer`. An
706
+ # Inbound ACH Transfer Intention is created when an ACH transfer is initiated at
707
+ # another bank and received by Increase.
603
708
  #
604
- # @param inbound_ach_transfer_return_intention [Increase::Models::Transaction::Source::InboundACHTransferReturnIntention, nil] An Inbound ACH Transfer Return Intention object. This field will be present in t
709
+ # @param inbound_ach_transfer_return_intention [Increase::Models::Transaction::Source::InboundACHTransferReturnIntention, nil]
710
+ # An Inbound ACH Transfer Return Intention object. This field will be present in
711
+ # the JSON response if and only if `category` is equal to
712
+ # `inbound_ach_transfer_return_intention`. An Inbound ACH Transfer Return
713
+ # Intention is created when an ACH transfer is initiated at another bank and
714
+ # returned by Increase.
605
715
  #
606
- # @param inbound_check_adjustment [Increase::Models::Transaction::Source::InboundCheckAdjustment, nil] An Inbound Check Adjustment object. This field will be present in the JSON respo
716
+ # @param inbound_check_adjustment [Increase::Models::Transaction::Source::InboundCheckAdjustment, nil]
717
+ # An Inbound Check Adjustment object. This field will be present in the JSON
718
+ # response if and only if `category` is equal to `inbound_check_adjustment`. An
719
+ # Inbound Check Adjustment is created when Increase receives an adjustment for a
720
+ # check or return deposited through Check21.
607
721
  #
608
- # @param inbound_check_deposit_return_intention [Increase::Models::Transaction::Source::InboundCheckDepositReturnIntention, nil] An Inbound Check Deposit Return Intention object. This field will be present in
722
+ # @param inbound_check_deposit_return_intention [Increase::Models::Transaction::Source::InboundCheckDepositReturnIntention, nil]
723
+ # An Inbound Check Deposit Return Intention object. This field will be present in
724
+ # the JSON response if and only if `category` is equal to
725
+ # `inbound_check_deposit_return_intention`. An Inbound Check Deposit Return
726
+ # Intention is created when Increase receives an Inbound Check and the User
727
+ # requests that it be returned.
609
728
  #
610
- # @param inbound_fednow_transfer_confirmation [Increase::Models::Transaction::Source::InboundFednowTransferConfirmation, nil] An Inbound FedNow Transfer Confirmation object. This field will be present in th
729
+ # @param inbound_fednow_transfer_confirmation [Increase::Models::Transaction::Source::InboundFednowTransferConfirmation, nil]
730
+ # An Inbound FedNow Transfer Confirmation object. This field will be present in
731
+ # the JSON response if and only if `category` is equal to
732
+ # `inbound_fednow_transfer_confirmation`. An Inbound FedNow Transfer Confirmation
733
+ # is created when a FedNow transfer is initiated at another bank and received by
734
+ # Increase.
611
735
  #
612
- # @param inbound_real_time_payments_transfer_confirmation [Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferConfirmation, nil] An Inbound Real-Time Payments Transfer Confirmation object. This field will be p
736
+ # @param inbound_real_time_payments_transfer_confirmation [Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferConfirmation, nil]
737
+ # An Inbound Real-Time Payments Transfer Confirmation object. This field will be
738
+ # present in the JSON response if and only if `category` is equal to
739
+ # `inbound_real_time_payments_transfer_confirmation`. An Inbound Real-Time
740
+ # Payments Transfer Confirmation is created when a Real-Time Payments transfer is
741
+ # initiated at another bank and received by Increase.
613
742
  #
614
- # @param inbound_wire_reversal [Increase::Models::Transaction::Source::InboundWireReversal, nil] An Inbound Wire Reversal object. This field will be present in the JSON response
743
+ # @param inbound_wire_reversal [Increase::Models::Transaction::Source::InboundWireReversal, nil]
744
+ # An Inbound Wire Reversal object. This field will be present in the JSON response
745
+ # if and only if `category` is equal to `inbound_wire_reversal`. An Inbound Wire
746
+ # Reversal represents a reversal of a wire transfer that was initiated via
747
+ # Increase. The other bank is sending the money back. This most often happens when
748
+ # the original destination account details were incorrect.
615
749
  #
616
- # @param inbound_wire_transfer [Increase::Models::Transaction::Source::InboundWireTransfer, nil] An Inbound Wire Transfer Intention object. This field will be present in the JSO
750
+ # @param inbound_wire_transfer [Increase::Models::Transaction::Source::InboundWireTransfer, nil]
751
+ # An Inbound Wire Transfer Intention object. This field will be present in the
752
+ # JSON response if and only if `category` is equal to `inbound_wire_transfer`. An
753
+ # Inbound Wire Transfer Intention is created when a wire transfer is initiated at
754
+ # another bank and received by Increase.
617
755
  #
618
- # @param inbound_wire_transfer_reversal [Increase::Models::Transaction::Source::InboundWireTransferReversal, nil] An Inbound Wire Transfer Reversal Intention object. This field will be present i
756
+ # @param inbound_wire_transfer_reversal [Increase::Models::Transaction::Source::InboundWireTransferReversal, nil]
757
+ # An Inbound Wire Transfer Reversal Intention object. This field will be present
758
+ # in the JSON response if and only if `category` is equal to
759
+ # `inbound_wire_transfer_reversal`. An Inbound Wire Transfer Reversal Intention is
760
+ # created when Increase has received a wire and the User requests that it be
761
+ # reversed.
619
762
  #
620
- # @param interest_payment [Increase::Models::Transaction::Source::InterestPayment, nil] An Interest Payment object. This field will be present in the JSON response if a
763
+ # @param interest_payment [Increase::Models::Transaction::Source::InterestPayment, nil]
764
+ # An Interest Payment object. This field will be present in the JSON response if
765
+ # and only if `category` is equal to `interest_payment`. An Interest Payment
766
+ # represents a payment of interest on an account. Interest is usually paid
767
+ # monthly.
621
768
  #
622
- # @param internal_source [Increase::Models::Transaction::Source::InternalSource, nil] An Internal Source object. This field will be present in the JSON response if an
769
+ # @param internal_source [Increase::Models::Transaction::Source::InternalSource, nil]
770
+ # An Internal Source object. This field will be present in the JSON response if
771
+ # and only if `category` is equal to `internal_source`. A transaction between the
772
+ # user and Increase. See the `reason` attribute for more information.
623
773
  #
624
- # @param other [Increase::Models::Transaction::Source::Other, nil] If the category of this Transaction source is equal to `other`, this field will
774
+ # @param other [Increase::Models::Transaction::Source::Other, nil]
775
+ # If the category of this Transaction source is equal to `other`, this field will
776
+ # contain an empty object, otherwise it will contain null.
625
777
  #
626
- # @param real_time_payments_transfer_acknowledgement [Increase::Models::Transaction::Source::RealTimePaymentsTransferAcknowledgement, nil] A Real-Time Payments Transfer Acknowledgement object. This field will be present
778
+ # @param real_time_payments_transfer_acknowledgement [Increase::Models::Transaction::Source::RealTimePaymentsTransferAcknowledgement, nil]
779
+ # A Real-Time Payments Transfer Acknowledgement object. This field will be present
780
+ # in the JSON response if and only if `category` is equal to
781
+ # `real_time_payments_transfer_acknowledgement`. A Real-Time Payments Transfer
782
+ # Acknowledgement is created when a Real-Time Payments Transfer sent from Increase
783
+ # is acknowledged by the receiving bank.
627
784
  #
628
- # @param sample_funds [Increase::Models::Transaction::Source::SampleFunds, nil] A Sample Funds object. This field will be present in the JSON response if and on
785
+ # @param sample_funds [Increase::Models::Transaction::Source::SampleFunds, nil]
786
+ # A Sample Funds object. This field will be present in the JSON response if and
787
+ # only if `category` is equal to `sample_funds`. Sample funds for testing
788
+ # purposes.
629
789
  #
630
- # @param swift_transfer_intention [Increase::Models::Transaction::Source::SwiftTransferIntention, nil] A Swift Transfer Intention object. This field will be present in the JSON respon
790
+ # @param swift_transfer_intention [Increase::Models::Transaction::Source::SwiftTransferIntention, nil]
791
+ # A Swift Transfer Intention object. This field will be present in the JSON
792
+ # response if and only if `category` is equal to `swift_transfer_intention`. A
793
+ # Swift Transfer initiated via Increase.
631
794
  #
632
- # @param swift_transfer_return [Increase::Models::Transaction::Source::SwiftTransferReturn, nil] A Swift Transfer Return object. This field will be present in the JSON response
795
+ # @param swift_transfer_return [Increase::Models::Transaction::Source::SwiftTransferReturn, nil]
796
+ # A Swift Transfer Return object. This field will be present in the JSON response
797
+ # if and only if `category` is equal to `swift_transfer_return`. A Swift Transfer
798
+ # Return is created when a Swift Transfer is returned by the receiving bank.
633
799
  #
634
- # @param wire_transfer_intention [Increase::Models::Transaction::Source::WireTransferIntention, nil] A Wire Transfer Intention object. This field will be present in the JSON respons
800
+ # @param wire_transfer_intention [Increase::Models::Transaction::Source::WireTransferIntention, nil]
801
+ # A Wire Transfer Intention object. This field will be present in the JSON
802
+ # response if and only if `category` is equal to `wire_transfer_intention`. A Wire
803
+ # Transfer initiated via Increase and sent to a different bank.
635
804
 
636
805
  # The type of the resource. We may add additional possible values for this enum
637
806
  # over time; your application should be able to handle such additions gracefully.
@@ -832,22 +1001,23 @@ module Increase
832
1001
  required :transfer_id, String
833
1002
 
834
1003
  # @!method initialize(amount:, currency:, description:, destination_account_id:, source_account_id:, transfer_id:)
835
- # Some parameter documentations has been truncated, see
836
- # {Increase::Models::Transaction::Source::AccountTransferIntention} for more
837
- # details.
838
- #
839
1004
  # An Account Transfer Intention object. This field will be present in the JSON
840
1005
  # response if and only if `category` is equal to `account_transfer_intention`. Two
841
1006
  # Account Transfer Intentions are created from each Account Transfer. One
842
1007
  # decrements the source account, and the other increments the destination account.
843
1008
  #
844
- # @param amount [Integer] The pending amount in the minor unit of the transaction's currency. For dollars,
1009
+ # @param amount [Integer]
1010
+ # The pending amount in the minor unit of the transaction's currency. For dollars,
1011
+ # for example, this is cents.
845
1012
  #
846
- # @param currency [Symbol, Increase::Models::Transaction::Source::AccountTransferIntention::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
1013
+ # @param currency [Symbol, Increase::Models::Transaction::Source::AccountTransferIntention::Currency]
1014
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
1015
+ # account currency.
847
1016
  #
848
1017
  # @param description [String] The description you chose to give the transfer.
849
1018
  #
850
- # @param destination_account_id [String] The identifier of the Account to where the Account Transfer was sent.
1019
+ # @param destination_account_id [String]
1020
+ # The identifier of the Account to where the Account Transfer was sent.
851
1021
  #
852
1022
  # @param source_account_id [String] The identifier of the Account from where the Account Transfer was sent.
853
1023
  #
@@ -903,9 +1073,6 @@ module Increase
903
1073
  required :transfer_id, String
904
1074
 
905
1075
  # @!method initialize(account_number:, amount:, routing_number:, statement_descriptor:, transfer_id:)
906
- # Some parameter documentations has been truncated, see
907
- # {Increase::Models::Transaction::Source::ACHTransferIntention} for more details.
908
- #
909
1076
  # An ACH Transfer Intention object. This field will be present in the JSON
910
1077
  # response if and only if `category` is equal to `ach_transfer_intention`. An ACH
911
1078
  # Transfer Intention is created from an ACH Transfer. It reflects the intention to
@@ -913,9 +1080,13 @@ module Increase
913
1080
  #
914
1081
  # @param account_number [String] The account number for the destination account.
915
1082
  #
916
- # @param amount [Integer] The amount in the minor unit of the transaction's currency. For dollars, for exa
1083
+ # @param amount [Integer]
1084
+ # The amount in the minor unit of the transaction's currency. For dollars, for
1085
+ # example, this is cents.
917
1086
  #
918
- # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des
1087
+ # @param routing_number [String]
1088
+ # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
1089
+ # destination account.
919
1090
  #
920
1091
  # @param statement_descriptor [String] A description set when the ACH Transfer was created.
921
1092
  #
@@ -985,9 +1156,6 @@ module Increase
985
1156
  required :transfer_id, String
986
1157
 
987
1158
  # @!method initialize(created_at:, raw_return_reason_code:, return_reason_code:, trace_number:, transaction_id:, transfer_id:)
988
- # Some parameter documentations has been truncated, see
989
- # {Increase::Models::Transaction::Source::ACHTransferReturn} for more details.
990
- #
991
1159
  # An ACH Transfer Return object. This field will be present in the JSON response
992
1160
  # if and only if `category` is equal to `ach_transfer_return`. An ACH Transfer
993
1161
  # Return is created when an ACH Transfer is returned by the receiving bank. It
@@ -996,17 +1164,27 @@ module Increase
996
1164
  # later. The return appears as a new posted Transaction; no Pending Transaction is
997
1165
  # created.
998
1166
  #
999
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
1167
+ # @param created_at [Time]
1168
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1169
+ # the transfer was created.
1000
1170
  #
1001
1171
  # @param raw_return_reason_code [String] The three character ACH return code, in the range R01 to R85.
1002
1172
  #
1003
- # @param return_reason_code [Symbol, Increase::Models::Transaction::Source::ACHTransferReturn::ReturnReasonCode] Why the ACH Transfer was returned. This reason code is sent by the receiving ban
1173
+ # @param return_reason_code [Symbol, Increase::Models::Transaction::Source::ACHTransferReturn::ReturnReasonCode]
1174
+ # Why the ACH Transfer was returned. This reason code is sent by the receiving
1175
+ # bank back to Increase.
1004
1176
  #
1005
- # @param trace_number [String] A 15 digit number that was generated by the bank that initiated the return. The
1177
+ # @param trace_number [String]
1178
+ # A 15 digit number that was generated by the bank that initiated the return. The
1179
+ # trace number of the return is different than that of the original transfer. ACH
1180
+ # trace numbers are not unique, but along with the amount and date this number can
1181
+ # be used to identify the ACH return at the bank that initiated it.
1006
1182
  #
1007
1183
  # @param transaction_id [String] The identifier of the Transaction associated with this return.
1008
1184
  #
1009
- # @param transfer_id [String] The identifier of the ACH Transfer associated with this return. This matches the
1185
+ # @param transfer_id [String]
1186
+ # The identifier of the ACH Transfer associated with this return. This matches the
1187
+ # original Transaction's `source.ach_transfer_intention.transfer_id`.
1010
1188
 
1011
1189
  # Why the ACH Transfer was returned. This reason code is sent by the receiving
1012
1190
  # bank back to Increase.
@@ -1248,17 +1426,15 @@ module Increase
1248
1426
  required :transfer_id, String
1249
1427
 
1250
1428
  # @!method initialize(source_blockchain_address_id:, transfer_id:)
1251
- # Some parameter documentations has been truncated, see
1252
- # {Increase::Models::Transaction::Source::BlockchainOfframpTransferSettlement} for
1253
- # more details.
1254
- #
1255
1429
  # A Blockchain Off-Ramp Transfer Settlement object. This field will be present in
1256
1430
  # the JSON response if and only if `category` is equal to
1257
1431
  # `blockchain_offramp_transfer_settlement`.
1258
1432
  #
1259
- # @param source_blockchain_address_id [String] The identifier of the Blockchain Address the funds were received at.
1433
+ # @param source_blockchain_address_id [String]
1434
+ # The identifier of the Blockchain Address the funds were received at.
1260
1435
  #
1261
- # @param transfer_id [String] The identifier of the Blockchain Off-Ramp Transfer that led to this Transaction.
1436
+ # @param transfer_id [String]
1437
+ # The identifier of the Blockchain Off-Ramp Transfer that led to this Transaction.
1262
1438
  end
1263
1439
 
1264
1440
  # @see Increase::Models::Transaction::Source#blockchain_onramp_transfer_intention
@@ -1282,7 +1458,8 @@ module Increase
1282
1458
  #
1283
1459
  # @param destination_blockchain_address [String] The blockchain address the funds were sent to.
1284
1460
  #
1285
- # @param transfer_id [String] The identifier of the Blockchain On-Ramp Transfer that led to this Transaction.
1461
+ # @param transfer_id [String]
1462
+ # The identifier of the Blockchain On-Ramp Transfer that led to this Transaction.
1286
1463
  end
1287
1464
 
1288
1465
  # @see Increase::Models::Transaction::Source#card_dispute_acceptance
@@ -1302,16 +1479,17 @@ module Increase
1302
1479
  required :transaction_id, String
1303
1480
 
1304
1481
  # @!method initialize(accepted_at:, transaction_id:)
1305
- # Some parameter documentations has been truncated, see
1306
- # {Increase::Models::Transaction::Source::CardDisputeAcceptance} for more details.
1307
- #
1308
1482
  # A Legacy Card Dispute Acceptance object. This field will be present in the JSON
1309
1483
  # response if and only if `category` is equal to `card_dispute_acceptance`.
1310
1484
  # Contains the details of a successful Card Dispute.
1311
1485
  #
1312
- # @param accepted_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
1486
+ # @param accepted_at [Time]
1487
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1488
+ # the Card Dispute was accepted.
1313
1489
  #
1314
- # @param transaction_id [String] The identifier of the Transaction that was created to return the disputed funds
1490
+ # @param transaction_id [String]
1491
+ # The identifier of the Transaction that was created to return the disputed funds
1492
+ # to your account.
1315
1493
  end
1316
1494
 
1317
1495
  # @see Increase::Models::Transaction::Source#card_dispute_financial
@@ -1344,20 +1522,23 @@ module Increase
1344
1522
  required :visa, -> { Increase::Transaction::Source::CardDisputeFinancial::Visa }, nil?: true
1345
1523
 
1346
1524
  # @!method initialize(amount:, network:, transaction_id:, visa:)
1347
- # Some parameter documentations has been truncated, see
1348
- # {Increase::Models::Transaction::Source::CardDisputeFinancial} for more details.
1349
- #
1350
1525
  # A Card Dispute Financial object. This field will be present in the JSON response
1351
1526
  # if and only if `category` is equal to `card_dispute_financial`. Financial event
1352
1527
  # related to a Card Dispute.
1353
1528
  #
1354
1529
  # @param amount [Integer] The amount of the financial event.
1355
1530
  #
1356
- # @param network [Symbol, Increase::Models::Transaction::Source::CardDisputeFinancial::Network] The network that the Card Dispute is associated with.
1531
+ # @param network [Symbol, Increase::Models::Transaction::Source::CardDisputeFinancial::Network]
1532
+ # The network that the Card Dispute is associated with.
1357
1533
  #
1358
- # @param transaction_id [String] The identifier of the Transaction that was created to credit or debit the disput
1534
+ # @param transaction_id [String]
1535
+ # The identifier of the Transaction that was created to credit or debit the
1536
+ # disputed funds to or from your account.
1359
1537
  #
1360
- # @param visa [Increase::Models::Transaction::Source::CardDisputeFinancial::Visa, nil] Information for events related to card dispute for card payments processed over
1538
+ # @param visa [Increase::Models::Transaction::Source::CardDisputeFinancial::Visa, nil]
1539
+ # Information for events related to card dispute for card payments processed over
1540
+ # Visa's network. This field will be present in the JSON response if and only if
1541
+ # `network` is equal to `visa`.
1361
1542
 
1362
1543
  # The network that the Card Dispute is associated with.
1363
1544
  #
@@ -1388,7 +1569,8 @@ module Increase
1388
1569
  # Visa's network. This field will be present in the JSON response if and only if
1389
1570
  # `network` is equal to `visa`.
1390
1571
  #
1391
- # @param event_type [Symbol, Increase::Models::Transaction::Source::CardDisputeFinancial::Visa::EventType] The type of card dispute financial event.
1572
+ # @param event_type [Symbol, Increase::Models::Transaction::Source::CardDisputeFinancial::Visa::EventType]
1573
+ # The type of card dispute financial event.
1392
1574
 
1393
1575
  # The type of card dispute financial event.
1394
1576
  #
@@ -1446,18 +1628,19 @@ module Increase
1446
1628
  required :transaction_id, String
1447
1629
 
1448
1630
  # @!method initialize(explanation:, lost_at:, transaction_id:)
1449
- # Some parameter documentations has been truncated, see
1450
- # {Increase::Models::Transaction::Source::CardDisputeLoss} for more details.
1451
- #
1452
1631
  # A Legacy Card Dispute Loss object. This field will be present in the JSON
1453
1632
  # response if and only if `category` is equal to `card_dispute_loss`. Contains the
1454
1633
  # details of a lost Card Dispute.
1455
1634
  #
1456
1635
  # @param explanation [String] Why the Card Dispute was lost.
1457
1636
  #
1458
- # @param lost_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
1637
+ # @param lost_at [Time]
1638
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1639
+ # the Card Dispute was lost.
1459
1640
  #
1460
- # @param transaction_id [String] The identifier of the Transaction that was created to debit the disputed funds f
1641
+ # @param transaction_id [String]
1642
+ # The identifier of the Transaction that was created to debit the disputed funds
1643
+ # from your account.
1461
1644
  end
1462
1645
 
1463
1646
  # @see Increase::Models::Transaction::Source#card_financial
@@ -1651,9 +1834,6 @@ module Increase
1651
1834
  required :verification, -> { Increase::Transaction::Source::CardFinancial::Verification }
1652
1835
 
1653
1836
  # @!method initialize(id:, actioner:, additional_amounts:, amount:, card_payment_id:, currency:, digital_wallet_token_id:, direction:, 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:, scheme_fees:, terminal_id:, transaction_id:, type:, verification:)
1654
- # Some parameter documentations has been truncated, see
1655
- # {Increase::Models::Transaction::Source::CardFinancial} for more details.
1656
- #
1657
1837
  # A Card Financial object. This field will be present in the JSON response if and
1658
1838
  # only if `category` is equal to `card_financial`. Card Financials are card
1659
1839
  # transactions that have cleared and settled. Unlike a Card Settlement, which
@@ -1662,23 +1842,40 @@ module Increase
1662
1842
  #
1663
1843
  # @param id [String] The Card Financial identifier.
1664
1844
  #
1665
- # @param actioner [Symbol, Increase::Models::Transaction::Source::CardFinancial::Actioner] Whether this financial was approved by Increase, the card network through stand-
1845
+ # @param actioner [Symbol, Increase::Models::Transaction::Source::CardFinancial::Actioner]
1846
+ # Whether this financial was approved by Increase, the card network through
1847
+ # stand-in processing, or the user through a real-time decision.
1666
1848
  #
1667
- # @param additional_amounts [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts] Additional amounts associated with the card authorization, such as ATM surcharge
1849
+ # @param additional_amounts [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts]
1850
+ # Additional amounts associated with the card authorization, such as ATM
1851
+ # surcharges fees. These are usually a subset of the `amount` field and are used
1852
+ # to provide more detailed information about the transaction.
1668
1853
  #
1669
- # @param amount [Integer] The pending amount in the minor unit of the transaction's currency. For dollars,
1854
+ # @param amount [Integer]
1855
+ # The pending amount in the minor unit of the transaction's currency. For dollars,
1856
+ # for example, this is cents.
1670
1857
  #
1671
1858
  # @param card_payment_id [String] The ID of the Card Payment this transaction belongs to.
1672
1859
  #
1673
- # @param currency [Symbol, Increase::Models::Transaction::Source::CardFinancial::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction'
1860
+ # @param currency [Symbol, Increase::Models::Transaction::Source::CardFinancial::Currency]
1861
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
1862
+ # transaction's currency.
1674
1863
  #
1675
- # @param digital_wallet_token_id [String, nil] If the authorization was made via a Digital Wallet Token (such as an Apple Pay p
1864
+ # @param digital_wallet_token_id [String, nil]
1865
+ # If the authorization was made via a Digital Wallet Token (such as an Apple Pay
1866
+ # purchase), the identifier of the token that was used.
1676
1867
  #
1677
- # @param direction [Symbol, Increase::Models::Transaction::Source::CardFinancial::Direction] The direction describes the direction the funds will move, either from the cardh
1868
+ # @param direction [Symbol, Increase::Models::Transaction::Source::CardFinancial::Direction]
1869
+ # The direction describes the direction the funds will move, either from the
1870
+ # cardholder to the merchant or from the merchant to the cardholder.
1678
1871
  #
1679
- # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i
1872
+ # @param merchant_acceptor_id [String]
1873
+ # The merchant identifier (commonly abbreviated as MID) of the merchant the card
1874
+ # is transacting with.
1680
1875
  #
1681
- # @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car
1876
+ # @param merchant_category_code [String]
1877
+ # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
1878
+ # card is transacting with.
1682
1879
  #
1683
1880
  # @param merchant_city [String, nil] The city the merchant resides in.
1684
1881
  #
@@ -1686,35 +1883,57 @@ module Increase
1686
1883
  #
1687
1884
  # @param merchant_descriptor [String] The merchant descriptor of the merchant the card is transacting with.
1688
1885
  #
1689
- # @param merchant_postal_code [String, nil] The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
1886
+ # @param merchant_postal_code [String, nil]
1887
+ # The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
1888
+ # ZIP code, where the first 5 and last 4 are separated by a dash.
1690
1889
  #
1691
1890
  # @param merchant_state [String, nil] The state the merchant resides in.
1692
1891
  #
1693
- # @param network_details [Increase::Models::Transaction::Source::CardFinancial::NetworkDetails] Fields specific to the `network`.
1892
+ # @param network_details [Increase::Models::Transaction::Source::CardFinancial::NetworkDetails]
1893
+ # Fields specific to the `network`.
1694
1894
  #
1695
- # @param network_identifiers [Increase::Models::Transaction::Source::CardFinancial::NetworkIdentifiers] Network-specific identifiers for a specific request or transaction.
1895
+ # @param network_identifiers [Increase::Models::Transaction::Source::CardFinancial::NetworkIdentifiers]
1896
+ # Network-specific identifiers for a specific request or transaction.
1696
1897
  #
1697
- # @param network_risk_score [Integer, nil] The risk score generated by the card network. For Visa this is the Visa Advanced
1898
+ # @param network_risk_score [Integer, nil]
1899
+ # The risk score generated by the card network. For Visa this is the Visa Advanced
1900
+ # Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
1901
+ # score is from 0 to 999, where 999 is the riskiest.
1698
1902
  #
1699
- # @param physical_card_id [String, nil] If the authorization was made in-person with a physical card, the Physical Card
1903
+ # @param physical_card_id [String, nil]
1904
+ # If the authorization was made in-person with a physical card, the Physical Card
1905
+ # that was used.
1700
1906
  #
1701
- # @param presentment_amount [Integer] The pending amount in the minor unit of the transaction's presentment currency.
1907
+ # @param presentment_amount [Integer]
1908
+ # The pending amount in the minor unit of the transaction's presentment currency.
1702
1909
  #
1703
- # @param presentment_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction'
1910
+ # @param presentment_currency [String]
1911
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
1912
+ # transaction's presentment currency.
1704
1913
  #
1705
- # @param processing_category [Symbol, Increase::Models::Transaction::Source::CardFinancial::ProcessingCategory] The processing category describes the intent behind the financial, such as wheth
1914
+ # @param processing_category [Symbol, Increase::Models::Transaction::Source::CardFinancial::ProcessingCategory]
1915
+ # The processing category describes the intent behind the financial, such as
1916
+ # whether it was used for bill payments or an automatic fuel dispenser.
1706
1917
  #
1707
- # @param real_time_decision_id [String, nil] The identifier of the Real-Time Decision sent to approve or decline this transac
1918
+ # @param real_time_decision_id [String, nil]
1919
+ # The identifier of the Real-Time Decision sent to approve or decline this
1920
+ # transaction.
1708
1921
  #
1709
- # @param scheme_fees [Array<Increase::Models::Transaction::Source::CardFinancial::SchemeFee>] The scheme fees associated with this card financial.
1922
+ # @param scheme_fees [Array<Increase::Models::Transaction::Source::CardFinancial::SchemeFee>]
1923
+ # The scheme fees associated with this card financial.
1710
1924
  #
1711
- # @param terminal_id [String, nil] The terminal identifier (commonly abbreviated as TID) of the terminal the card i
1925
+ # @param terminal_id [String, nil]
1926
+ # The terminal identifier (commonly abbreviated as TID) of the terminal the card
1927
+ # is transacting with.
1712
1928
  #
1713
1929
  # @param transaction_id [String] The identifier of the Transaction associated with this Transaction.
1714
1930
  #
1715
- # @param type [Symbol, Increase::Models::Transaction::Source::CardFinancial::Type] A constant representing the object's type. For this resource it will always be `
1931
+ # @param type [Symbol, Increase::Models::Transaction::Source::CardFinancial::Type]
1932
+ # A constant representing the object's type. For this resource it will always be
1933
+ # `card_financial`.
1716
1934
  #
1717
- # @param verification [Increase::Models::Transaction::Source::CardFinancial::Verification] Fields related to verification of cardholder-provided values.
1935
+ # @param verification [Increase::Models::Transaction::Source::CardFinancial::Verification]
1936
+ # Fields related to verification of cardholder-provided values.
1718
1937
 
1719
1938
  # Whether this financial was approved by Increase, the card network through
1720
1939
  # stand-in processing, or the user through a real-time decision.
@@ -1819,33 +2038,39 @@ module Increase
1819
2038
  nil?: true
1820
2039
 
1821
2040
  # @!method initialize(clinic:, dental:, original:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
1822
- # Some parameter documentations has been truncated, see
1823
- # {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts} for
1824
- # more details.
1825
- #
1826
2041
  # Additional amounts associated with the card authorization, such as ATM
1827
2042
  # surcharges fees. These are usually a subset of the `amount` field and are used
1828
2043
  # to provide more detailed information about the transaction.
1829
2044
  #
1830
- # @param clinic [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Clinic, nil] The part of this transaction amount that was for clinic-related services.
2045
+ # @param clinic [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Clinic, nil]
2046
+ # The part of this transaction amount that was for clinic-related services.
1831
2047
  #
1832
- # @param dental [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Dental, nil] The part of this transaction amount that was for dental-related services.
2048
+ # @param dental [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Dental, nil]
2049
+ # The part of this transaction amount that was for dental-related services.
1833
2050
  #
1834
- # @param original [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Original, nil] The original pre-authorized amount.
2051
+ # @param original [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Original, nil]
2052
+ # The original pre-authorized amount.
1835
2053
  #
1836
- # @param prescription [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Prescription, nil] The part of this transaction amount that was for healthcare prescriptions.
2054
+ # @param prescription [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Prescription, nil]
2055
+ # The part of this transaction amount that was for healthcare prescriptions.
1837
2056
  #
1838
- # @param surcharge [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Surcharge, nil] The surcharge amount charged for this transaction by the merchant.
2057
+ # @param surcharge [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Surcharge, nil]
2058
+ # The surcharge amount charged for this transaction by the merchant.
1839
2059
  #
1840
- # @param total_cumulative [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::TotalCumulative, nil] The total amount of a series of incremental authorizations, optionally provided.
2060
+ # @param total_cumulative [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::TotalCumulative, nil]
2061
+ # The total amount of a series of incremental authorizations, optionally provided.
1841
2062
  #
1842
- # @param total_healthcare [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::TotalHealthcare, nil] The total amount of healthcare-related additional amounts.
2063
+ # @param total_healthcare [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::TotalHealthcare, nil]
2064
+ # The total amount of healthcare-related additional amounts.
1843
2065
  #
1844
- # @param transit [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Transit, nil] The part of this transaction amount that was for transit-related services.
2066
+ # @param transit [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Transit, nil]
2067
+ # The part of this transaction amount that was for transit-related services.
1845
2068
  #
1846
- # @param unknown [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Unknown, nil] An unknown additional amount.
2069
+ # @param unknown [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Unknown, nil]
2070
+ # An unknown additional amount.
1847
2071
  #
1848
- # @param vision [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Vision, nil] The part of this transaction amount that was for vision-related services.
2072
+ # @param vision [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Vision, nil]
2073
+ # The part of this transaction amount that was for vision-related services.
1849
2074
 
1850
2075
  # @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#clinic
1851
2076
  class Clinic < Increase::Internal::Type::BaseModel
@@ -1865,15 +2090,16 @@ module Increase
1865
2090
  required :currency, String
1866
2091
 
1867
2092
  # @!method initialize(amount:, currency:)
1868
- # Some parameter documentations has been truncated, see
1869
- # {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Clinic}
1870
- # for more details.
1871
- #
1872
2093
  # The part of this transaction amount that was for clinic-related services.
1873
2094
  #
1874
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
2095
+ # @param amount [Integer]
2096
+ # The amount in minor units of the `currency` field. The amount is positive if it
2097
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
2098
+ # subtracted from the amount (such as a discount).
1875
2099
  #
1876
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2100
+ # @param currency [String]
2101
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2102
+ # amount's currency.
1877
2103
  end
1878
2104
 
1879
2105
  # @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#dental
@@ -1894,15 +2120,16 @@ module Increase
1894
2120
  required :currency, String
1895
2121
 
1896
2122
  # @!method initialize(amount:, currency:)
1897
- # Some parameter documentations has been truncated, see
1898
- # {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Dental}
1899
- # for more details.
1900
- #
1901
2123
  # The part of this transaction amount that was for dental-related services.
1902
2124
  #
1903
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
2125
+ # @param amount [Integer]
2126
+ # The amount in minor units of the `currency` field. The amount is positive if it
2127
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
2128
+ # subtracted from the amount (such as a discount).
1904
2129
  #
1905
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2130
+ # @param currency [String]
2131
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2132
+ # amount's currency.
1906
2133
  end
1907
2134
 
1908
2135
  # @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#original
@@ -1923,15 +2150,16 @@ module Increase
1923
2150
  required :currency, String
1924
2151
 
1925
2152
  # @!method initialize(amount:, currency:)
1926
- # Some parameter documentations has been truncated, see
1927
- # {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Original}
1928
- # for more details.
1929
- #
1930
2153
  # The original pre-authorized amount.
1931
2154
  #
1932
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
2155
+ # @param amount [Integer]
2156
+ # The amount in minor units of the `currency` field. The amount is positive if it
2157
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
2158
+ # subtracted from the amount (such as a discount).
1933
2159
  #
1934
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2160
+ # @param currency [String]
2161
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2162
+ # amount's currency.
1935
2163
  end
1936
2164
 
1937
2165
  # @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#prescription
@@ -1952,15 +2180,16 @@ module Increase
1952
2180
  required :currency, String
1953
2181
 
1954
2182
  # @!method initialize(amount:, currency:)
1955
- # Some parameter documentations has been truncated, see
1956
- # {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Prescription}
1957
- # for more details.
1958
- #
1959
2183
  # The part of this transaction amount that was for healthcare prescriptions.
1960
2184
  #
1961
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
2185
+ # @param amount [Integer]
2186
+ # The amount in minor units of the `currency` field. The amount is positive if it
2187
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
2188
+ # subtracted from the amount (such as a discount).
1962
2189
  #
1963
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2190
+ # @param currency [String]
2191
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2192
+ # amount's currency.
1964
2193
  end
1965
2194
 
1966
2195
  # @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#surcharge
@@ -1981,15 +2210,16 @@ module Increase
1981
2210
  required :currency, String
1982
2211
 
1983
2212
  # @!method initialize(amount:, currency:)
1984
- # Some parameter documentations has been truncated, see
1985
- # {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Surcharge}
1986
- # for more details.
1987
- #
1988
2213
  # The surcharge amount charged for this transaction by the merchant.
1989
2214
  #
1990
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
2215
+ # @param amount [Integer]
2216
+ # The amount in minor units of the `currency` field. The amount is positive if it
2217
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
2218
+ # subtracted from the amount (such as a discount).
1991
2219
  #
1992
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2220
+ # @param currency [String]
2221
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2222
+ # amount's currency.
1993
2223
  end
1994
2224
 
1995
2225
  # @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#total_cumulative
@@ -2010,15 +2240,16 @@ module Increase
2010
2240
  required :currency, String
2011
2241
 
2012
2242
  # @!method initialize(amount:, currency:)
2013
- # Some parameter documentations has been truncated, see
2014
- # {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::TotalCumulative}
2015
- # for more details.
2016
- #
2017
2243
  # The total amount of a series of incremental authorizations, optionally provided.
2018
2244
  #
2019
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
2245
+ # @param amount [Integer]
2246
+ # The amount in minor units of the `currency` field. The amount is positive if it
2247
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
2248
+ # subtracted from the amount (such as a discount).
2020
2249
  #
2021
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2250
+ # @param currency [String]
2251
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2252
+ # amount's currency.
2022
2253
  end
2023
2254
 
2024
2255
  # @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#total_healthcare
@@ -2039,15 +2270,16 @@ module Increase
2039
2270
  required :currency, String
2040
2271
 
2041
2272
  # @!method initialize(amount:, currency:)
2042
- # Some parameter documentations has been truncated, see
2043
- # {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::TotalHealthcare}
2044
- # for more details.
2045
- #
2046
2273
  # The total amount of healthcare-related additional amounts.
2047
2274
  #
2048
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
2275
+ # @param amount [Integer]
2276
+ # The amount in minor units of the `currency` field. The amount is positive if it
2277
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
2278
+ # subtracted from the amount (such as a discount).
2049
2279
  #
2050
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2280
+ # @param currency [String]
2281
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2282
+ # amount's currency.
2051
2283
  end
2052
2284
 
2053
2285
  # @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#transit
@@ -2068,15 +2300,16 @@ module Increase
2068
2300
  required :currency, String
2069
2301
 
2070
2302
  # @!method initialize(amount:, currency:)
2071
- # Some parameter documentations has been truncated, see
2072
- # {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Transit}
2073
- # for more details.
2074
- #
2075
2303
  # The part of this transaction amount that was for transit-related services.
2076
2304
  #
2077
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
2305
+ # @param amount [Integer]
2306
+ # The amount in minor units of the `currency` field. The amount is positive if it
2307
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
2308
+ # subtracted from the amount (such as a discount).
2078
2309
  #
2079
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2310
+ # @param currency [String]
2311
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2312
+ # amount's currency.
2080
2313
  end
2081
2314
 
2082
2315
  # @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#unknown
@@ -2097,15 +2330,16 @@ module Increase
2097
2330
  required :currency, String
2098
2331
 
2099
2332
  # @!method initialize(amount:, currency:)
2100
- # Some parameter documentations has been truncated, see
2101
- # {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Unknown}
2102
- # for more details.
2103
- #
2104
2333
  # An unknown additional amount.
2105
2334
  #
2106
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
2335
+ # @param amount [Integer]
2336
+ # The amount in minor units of the `currency` field. The amount is positive if it
2337
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
2338
+ # subtracted from the amount (such as a discount).
2107
2339
  #
2108
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2340
+ # @param currency [String]
2341
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2342
+ # amount's currency.
2109
2343
  end
2110
2344
 
2111
2345
  # @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#vision
@@ -2126,15 +2360,16 @@ module Increase
2126
2360
  required :currency, String
2127
2361
 
2128
2362
  # @!method initialize(amount:, currency:)
2129
- # Some parameter documentations has been truncated, see
2130
- # {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Vision}
2131
- # for more details.
2132
- #
2133
2363
  # The part of this transaction amount that was for vision-related services.
2134
2364
  #
2135
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
2365
+ # @param amount [Integer]
2366
+ # The amount in minor units of the `currency` field. The amount is positive if it
2367
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
2368
+ # subtracted from the amount (such as a discount).
2136
2369
  #
2137
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
2370
+ # @param currency [String]
2371
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
2372
+ # amount's currency.
2138
2373
  end
2139
2374
  end
2140
2375
 
@@ -2200,11 +2435,14 @@ module Increase
2200
2435
  # @!method initialize(category:, pulse:, visa:)
2201
2436
  # Fields specific to the `network`.
2202
2437
  #
2203
- # @param category [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Category] The payment network used to process this card authorization.
2438
+ # @param category [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Category]
2439
+ # The payment network used to process this card authorization.
2204
2440
  #
2205
- # @param pulse [Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Pulse, nil] Fields specific to the `pulse` network.
2441
+ # @param pulse [Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Pulse, nil]
2442
+ # Fields specific to the `pulse` network.
2206
2443
  #
2207
- # @param visa [Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa, nil] Fields specific to the `visa` network.
2444
+ # @param visa [Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa, nil]
2445
+ # Fields specific to the `visa` network.
2208
2446
 
2209
2447
  # The payment network used to process this card authorization.
2210
2448
  #
@@ -2279,19 +2517,27 @@ module Increase
2279
2517
  nil?: true
2280
2518
 
2281
2519
  # @!method initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:, terminal_entry_capability:)
2282
- # Some parameter documentations has been truncated, see
2283
- # {Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa} for
2284
- # more details.
2285
- #
2286
2520
  # Fields specific to the `visa` network.
2287
2521
  #
2288
- # @param electronic_commerce_indicator [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] For electronic commerce transactions, this identifies the level of security used
2522
+ # @param electronic_commerce_indicator [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa::ElectronicCommerceIndicator, nil]
2523
+ # For electronic commerce transactions, this identifies the level of security used
2524
+ # in obtaining the customer's payment credential. For mail or telephone order
2525
+ # transactions, identifies the type of mail or telephone order.
2289
2526
  #
2290
- # @param point_of_service_entry_mode [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa::PointOfServiceEntryMode, nil] The method used to enter the cardholder's primary account number and card expira
2527
+ # @param point_of_service_entry_mode [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa::PointOfServiceEntryMode, nil]
2528
+ # The method used to enter the cardholder's primary account number and card
2529
+ # expiration date.
2291
2530
  #
2292
- # @param stand_in_processing_reason [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa::StandInProcessingReason, nil] Only present when `actioner: network`. Describes why a card authorization was ap
2531
+ # @param stand_in_processing_reason [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa::StandInProcessingReason, nil]
2532
+ # Only present when `actioner: network`. Describes why a card authorization was
2533
+ # approved or declined by Visa through stand-in processing.
2293
2534
  #
2294
- # @param terminal_entry_capability [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa::TerminalEntryCapability, nil] The capability of the terminal being used to read the card. Shows whether a term
2535
+ # @param terminal_entry_capability [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa::TerminalEntryCapability, nil]
2536
+ # The capability of the terminal being used to read the card. Shows whether a
2537
+ # terminal can e.g., accept chip cards or if it only supports magnetic stripe
2538
+ # reads. This reflects the highest capability of the terminal — for example, a
2539
+ # terminal that supports both chip and magnetic stripe will be identified as
2540
+ # chip-capable.
2295
2541
 
2296
2542
  # For electronic commerce transactions, this identifies the level of security used
2297
2543
  # in obtaining the customer's payment credential. For mail or telephone order
@@ -2480,19 +2726,24 @@ module Increase
2480
2726
  required :transaction_id, String, nil?: true
2481
2727
 
2482
2728
  # @!method initialize(authorization_identification_response:, retrieval_reference_number:, trace_number:, transaction_id:)
2483
- # Some parameter documentations has been truncated, see
2484
- # {Increase::Models::Transaction::Source::CardFinancial::NetworkIdentifiers} for
2485
- # more details.
2486
- #
2487
2729
  # Network-specific identifiers for a specific request or transaction.
2488
2730
  #
2489
- # @param authorization_identification_response [String, nil] The randomly generated 6-character Authorization Identification Response code se
2731
+ # @param authorization_identification_response [String, nil]
2732
+ # The randomly generated 6-character Authorization Identification Response code
2733
+ # sent back to the acquirer in an approved response.
2490
2734
  #
2491
- # @param retrieval_reference_number [String, nil] A life-cycle identifier used across e.g., an authorization and a reversal. Expec
2735
+ # @param retrieval_reference_number [String, nil]
2736
+ # A life-cycle identifier used across e.g., an authorization and a reversal.
2737
+ # Expected to be unique per acquirer within a window of time. For some card
2738
+ # networks the retrieval reference number includes the trace counter.
2492
2739
  #
2493
- # @param trace_number [String, nil] A counter used to verify an individual authorization. Expected to be unique per
2740
+ # @param trace_number [String, nil]
2741
+ # A counter used to verify an individual authorization. Expected to be unique per
2742
+ # acquirer within a window of time.
2494
2743
  #
2495
- # @param transaction_id [String, nil] A globally unique transaction identifier provided by the card network, used acro
2744
+ # @param transaction_id [String, nil]
2745
+ # A globally unique transaction identifier provided by the card network, used
2746
+ # across multiple life-cycle requests.
2496
2747
  end
2497
2748
 
2498
2749
  # The processing category describes the intent behind the financial, such as
@@ -2581,21 +2832,26 @@ module Increase
2581
2832
  required :variable_rate, String, nil?: true
2582
2833
 
2583
2834
  # @!method initialize(amount:, created_at:, currency:, fee_type:, fixed_component:, variable_rate:)
2584
- # Some parameter documentations has been truncated, see
2585
- # {Increase::Models::Transaction::Source::CardFinancial::SchemeFee} for more
2586
- # details.
2587
- #
2588
2835
  # @param amount [String] The fee amount given as a string containing a decimal number.
2589
2836
  #
2590
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was
2837
+ # @param created_at [Time]
2838
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was
2839
+ # created.
2591
2840
  #
2592
- # @param currency [Symbol, Increase::Models::Transaction::Source::CardFinancial::SchemeFee::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimburs
2841
+ # @param currency [Symbol, Increase::Models::Transaction::Source::CardFinancial::SchemeFee::Currency]
2842
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
2843
+ # reimbursement.
2593
2844
  #
2594
- # @param fee_type [Symbol, Increase::Models::Transaction::Source::CardFinancial::SchemeFee::FeeType] The type of fee being assessed.
2845
+ # @param fee_type [Symbol, Increase::Models::Transaction::Source::CardFinancial::SchemeFee::FeeType]
2846
+ # The type of fee being assessed.
2595
2847
  #
2596
- # @param fixed_component [String, nil] The fixed component of the fee, if applicable, given in major units of the fee a
2848
+ # @param fixed_component [String, nil]
2849
+ # The fixed component of the fee, if applicable, given in major units of the fee
2850
+ # amount.
2597
2851
  #
2598
- # @param variable_rate [String, nil] The variable rate component of the fee, if applicable, given as a decimal (e.g.,
2852
+ # @param variable_rate [String, nil]
2853
+ # The variable rate component of the fee, if applicable, given as a decimal (e.g.,
2854
+ # 0.015 for 1.5%).
2599
2855
 
2600
2856
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
2601
2857
  # reimbursement.
@@ -2752,17 +3008,18 @@ module Increase
2752
3008
  nil?: true
2753
3009
 
2754
3010
  # @!method initialize(card_verification_code:, cardholder_address:, cardholder_name:)
2755
- # Some parameter documentations has been truncated, see
2756
- # {Increase::Models::Transaction::Source::CardFinancial::Verification} for more
2757
- # details.
2758
- #
2759
3011
  # Fields related to verification of cardholder-provided values.
2760
3012
  #
2761
- # @param card_verification_code [Increase::Models::Transaction::Source::CardFinancial::Verification::CardVerificationCode] Fields related to verification of the Card Verification Code, a 3-digit code on
3013
+ # @param card_verification_code [Increase::Models::Transaction::Source::CardFinancial::Verification::CardVerificationCode]
3014
+ # Fields related to verification of the Card Verification Code, a 3-digit code on
3015
+ # the back of the card.
2762
3016
  #
2763
- # @param cardholder_address [Increase::Models::Transaction::Source::CardFinancial::Verification::CardholderAddress] Cardholder address provided in the authorization request and the address on file
3017
+ # @param cardholder_address [Increase::Models::Transaction::Source::CardFinancial::Verification::CardholderAddress]
3018
+ # Cardholder address provided in the authorization request and the address on file
3019
+ # we verified it against.
2764
3020
  #
2765
- # @param cardholder_name [Increase::Models::Transaction::Source::CardFinancial::Verification::CardholderName, nil] Cardholder name provided in the authorization request.
3021
+ # @param cardholder_name [Increase::Models::Transaction::Source::CardFinancial::Verification::CardholderName, nil]
3022
+ # Cardholder name provided in the authorization request.
2766
3023
 
2767
3024
  # @see Increase::Models::Transaction::Source::CardFinancial::Verification#card_verification_code
2768
3025
  class CardVerificationCode < Increase::Internal::Type::BaseModel
@@ -2777,7 +3034,8 @@ module Increase
2777
3034
  # Fields related to verification of the Card Verification Code, a 3-digit code on
2778
3035
  # the back of the card.
2779
3036
  #
2780
- # @param result [Symbol, Increase::Models::Transaction::Source::CardFinancial::Verification::CardVerificationCode::Result] The result of verifying the Card Verification Code.
3037
+ # @param result [Symbol, Increase::Models::Transaction::Source::CardFinancial::Verification::CardVerificationCode::Result]
3038
+ # The result of verifying the Card Verification Code.
2781
3039
 
2782
3040
  # The result of verifying the Card Verification Code.
2783
3041
  #
@@ -2834,10 +3092,6 @@ module Increase
2834
3092
  enum: -> { Increase::Transaction::Source::CardFinancial::Verification::CardholderAddress::Result }
2835
3093
 
2836
3094
  # @!method initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:)
2837
- # Some parameter documentations has been truncated, see
2838
- # {Increase::Models::Transaction::Source::CardFinancial::Verification::CardholderAddress}
2839
- # for more details.
2840
- #
2841
3095
  # Cardholder address provided in the authorization request and the address on file
2842
3096
  # we verified it against.
2843
3097
  #
@@ -2845,11 +3099,15 @@ module Increase
2845
3099
  #
2846
3100
  # @param actual_postal_code [String, nil] The postal code of the address on file for the cardholder.
2847
3101
  #
2848
- # @param provided_line1 [String, nil] The cardholder address line 1 provided for verification in the authorization req
3102
+ # @param provided_line1 [String, nil]
3103
+ # The cardholder address line 1 provided for verification in the authorization
3104
+ # request.
2849
3105
  #
2850
- # @param provided_postal_code [String, nil] The postal code provided for verification in the authorization request.
3106
+ # @param provided_postal_code [String, nil]
3107
+ # The postal code provided for verification in the authorization request.
2851
3108
  #
2852
- # @param result [Symbol, Increase::Models::Transaction::Source::CardFinancial::Verification::CardholderAddress::Result] The address verification result returned to the card network.
3109
+ # @param result [Symbol, Increase::Models::Transaction::Source::CardFinancial::Verification::CardholderAddress::Result]
3110
+ # The address verification result returned to the card network.
2853
3111
 
2854
3112
  # The address verification result returned to the card network.
2855
3113
  #
@@ -2903,11 +3161,14 @@ module Increase
2903
3161
  # @!method initialize(provided_first_name:, provided_last_name:, provided_middle_name:)
2904
3162
  # Cardholder name provided in the authorization request.
2905
3163
  #
2906
- # @param provided_first_name [String, nil] The first name provided for verification in the authorization request.
3164
+ # @param provided_first_name [String, nil]
3165
+ # The first name provided for verification in the authorization request.
2907
3166
  #
2908
- # @param provided_last_name [String, nil] The last name provided for verification in the authorization request.
3167
+ # @param provided_last_name [String, nil]
3168
+ # The last name provided for verification in the authorization request.
2909
3169
  #
2910
- # @param provided_middle_name [String, nil] The middle name provided for verification in the authorization request.
3170
+ # @param provided_middle_name [String, nil]
3171
+ # The middle name provided for verification in the authorization request.
2911
3172
  end
2912
3173
  end
2913
3174
  end
@@ -3072,9 +3333,6 @@ module Increase
3072
3333
  required :type, enum: -> { Increase::Transaction::Source::CardRefund::Type }
3073
3334
 
3074
3335
  # @!method initialize(id:, amount:, card_payment_id:, cashback:, currency:, interchange:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_name:, merchant_postal_code:, merchant_state:, network_identifiers:, presentment_amount:, presentment_currency:, purchase_details:, scheme_fees:, transaction_id:, type:)
3075
- # Some parameter documentations has been truncated, see
3076
- # {Increase::Models::Transaction::Source::CardRefund} for more details.
3077
- #
3078
3336
  # A Card Refund object. This field will be present in the JSON response if and
3079
3337
  # only if `category` is equal to `card_refund`. Card Refunds move money back to
3080
3338
  # the cardholder. While they are usually connected to a Card Settlement, an
@@ -3083,17 +3341,26 @@ module Increase
3083
3341
  #
3084
3342
  # @param id [String] The Card Refund identifier.
3085
3343
  #
3086
- # @param amount [Integer] The amount in the minor unit of the transaction's settlement currency. For dolla
3344
+ # @param amount [Integer]
3345
+ # The amount in the minor unit of the transaction's settlement currency. For
3346
+ # dollars, for example, this is cents.
3087
3347
  #
3088
3348
  # @param card_payment_id [String] The ID of the Card Payment this transaction belongs to.
3089
3349
  #
3090
- # @param cashback [Increase::Models::Transaction::Source::CardRefund::Cashback, nil] Cashback debited for this transaction, if eligible. Cashback is paid out in aggr
3350
+ # @param cashback [Increase::Models::Transaction::Source::CardRefund::Cashback, nil]
3351
+ # Cashback debited for this transaction, if eligible. Cashback is paid out in
3352
+ # aggregate, monthly.
3091
3353
  #
3092
- # @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction'
3354
+ # @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::Currency]
3355
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
3356
+ # transaction's settlement currency.
3093
3357
  #
3094
- # @param interchange [Increase::Models::Transaction::Source::CardRefund::Interchange, nil] Interchange assessed as a part of this transaction.
3358
+ # @param interchange [Increase::Models::Transaction::Source::CardRefund::Interchange, nil]
3359
+ # Interchange assessed as a part of this transaction.
3095
3360
  #
3096
- # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i
3361
+ # @param merchant_acceptor_id [String]
3362
+ # The merchant identifier (commonly abbreviated as MID) of the merchant the card
3363
+ # is transacting with.
3097
3364
  #
3098
3365
  # @param merchant_category_code [String] The 4-digit MCC describing the merchant's business.
3099
3366
  #
@@ -3103,23 +3370,33 @@ module Increase
3103
3370
  #
3104
3371
  # @param merchant_name [String] The name of the merchant.
3105
3372
  #
3106
- # @param merchant_postal_code [String, nil] The merchant's postal code. For US merchants this is always a 5-digit ZIP code.
3373
+ # @param merchant_postal_code [String, nil]
3374
+ # The merchant's postal code. For US merchants this is always a 5-digit ZIP code.
3107
3375
  #
3108
3376
  # @param merchant_state [String, nil] The state the merchant resides in.
3109
3377
  #
3110
- # @param network_identifiers [Increase::Models::Transaction::Source::CardRefund::NetworkIdentifiers] Network-specific identifiers for this refund.
3378
+ # @param network_identifiers [Increase::Models::Transaction::Source::CardRefund::NetworkIdentifiers]
3379
+ # Network-specific identifiers for this refund.
3111
3380
  #
3112
- # @param presentment_amount [Integer] The amount in the minor unit of the transaction's presentment currency.
3381
+ # @param presentment_amount [Integer]
3382
+ # The amount in the minor unit of the transaction's presentment currency.
3113
3383
  #
3114
- # @param presentment_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction'
3384
+ # @param presentment_currency [String]
3385
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
3386
+ # transaction's presentment currency.
3115
3387
  #
3116
- # @param purchase_details [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails, nil] Additional details about the card purchase, such as tax and industry-specific fi
3388
+ # @param purchase_details [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails, nil]
3389
+ # Additional details about the card purchase, such as tax and industry-specific
3390
+ # fields.
3117
3391
  #
3118
- # @param scheme_fees [Array<Increase::Models::Transaction::Source::CardRefund::SchemeFee>] The scheme fees associated with this card refund.
3392
+ # @param scheme_fees [Array<Increase::Models::Transaction::Source::CardRefund::SchemeFee>]
3393
+ # The scheme fees associated with this card refund.
3119
3394
  #
3120
3395
  # @param transaction_id [String] The identifier of the Transaction associated with this Transaction.
3121
3396
  #
3122
- # @param type [Symbol, Increase::Models::Transaction::Source::CardRefund::Type] A constant representing the object's type. For this resource it will always be `
3397
+ # @param type [Symbol, Increase::Models::Transaction::Source::CardRefund::Type]
3398
+ # A constant representing the object's type. For this resource it will always be
3399
+ # `card_refund`.
3123
3400
 
3124
3401
  # @see Increase::Models::Transaction::Source::CardRefund#cashback
3125
3402
  class Cashback < Increase::Internal::Type::BaseModel
@@ -3138,15 +3415,16 @@ module Increase
3138
3415
  required :currency, enum: -> { Increase::Transaction::Source::CardRefund::Cashback::Currency }
3139
3416
 
3140
3417
  # @!method initialize(amount:, currency:)
3141
- # Some parameter documentations has been truncated, see
3142
- # {Increase::Models::Transaction::Source::CardRefund::Cashback} for more details.
3143
- #
3144
3418
  # Cashback debited for this transaction, if eligible. Cashback is paid out in
3145
3419
  # aggregate, monthly.
3146
3420
  #
3147
- # @param amount [String] The cashback amount given as a string containing a decimal number. The amount is
3421
+ # @param amount [String]
3422
+ # The cashback amount given as a string containing a decimal number. The amount is
3423
+ # a positive number if it will be credited to you (e.g., settlements) and a
3424
+ # negative number if it will be debited (e.g., refunds).
3148
3425
  #
3149
- # @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::Cashback::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback.
3426
+ # @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::Cashback::Currency]
3427
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback.
3150
3428
 
3151
3429
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback.
3152
3430
  #
@@ -3201,17 +3479,19 @@ module Increase
3201
3479
  required :currency, enum: -> { Increase::Transaction::Source::CardRefund::Interchange::Currency }
3202
3480
 
3203
3481
  # @!method initialize(amount:, code:, currency:)
3204
- # Some parameter documentations has been truncated, see
3205
- # {Increase::Models::Transaction::Source::CardRefund::Interchange} for more
3206
- # details.
3207
- #
3208
3482
  # Interchange assessed as a part of this transaction.
3209
3483
  #
3210
- # @param amount [String] The interchange amount given as a string containing a decimal number in major un
3484
+ # @param amount [String]
3485
+ # The interchange amount given as a string containing a decimal number in major
3486
+ # units (so e.g., "3.14" for $3.14). The amount is a positive number if it is
3487
+ # credited to Increase (e.g., settlements) and a negative number if it is debited
3488
+ # (e.g., refunds).
3211
3489
  #
3212
3490
  # @param code [String, nil] The card network specific interchange code.
3213
3491
  #
3214
- # @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::Interchange::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange
3492
+ # @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::Interchange::Currency]
3493
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange
3494
+ # reimbursement.
3215
3495
 
3216
3496
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange
3217
3497
  # reimbursement.
@@ -3258,19 +3538,21 @@ module Increase
3258
3538
  required :transaction_id, String, nil?: true
3259
3539
 
3260
3540
  # @!method initialize(acquirer_business_id:, acquirer_reference_number:, authorization_identification_response:, transaction_id:)
3261
- # Some parameter documentations has been truncated, see
3262
- # {Increase::Models::Transaction::Source::CardRefund::NetworkIdentifiers} for more
3263
- # details.
3264
- #
3265
3541
  # Network-specific identifiers for this refund.
3266
3542
  #
3267
- # @param acquirer_business_id [String] A network assigned business ID that identifies the acquirer that processed this
3543
+ # @param acquirer_business_id [String]
3544
+ # A network assigned business ID that identifies the acquirer that processed this
3545
+ # transaction.
3268
3546
  #
3269
3547
  # @param acquirer_reference_number [String] A globally unique identifier for this settlement.
3270
3548
  #
3271
- # @param authorization_identification_response [String, nil] The randomly generated 6-character Authorization Identification Response code se
3549
+ # @param authorization_identification_response [String, nil]
3550
+ # The randomly generated 6-character Authorization Identification Response code
3551
+ # sent back to the acquirer in an approved response.
3272
3552
  #
3273
- # @param transaction_id [String, nil] A globally unique transaction identifier provided by the card network, used acro
3553
+ # @param transaction_id [String, nil]
3554
+ # A globally unique transaction identifier provided by the card network, used
3555
+ # across multiple life-cycle requests.
3274
3556
  end
3275
3557
 
3276
3558
  # @see Increase::Models::Transaction::Source::CardRefund#purchase_details
@@ -3352,32 +3634,38 @@ module Increase
3352
3634
  nil?: true
3353
3635
 
3354
3636
  # @!method initialize(car_rental:, customer_reference_identifier:, local_tax_amount:, local_tax_currency:, lodging:, national_tax_amount:, national_tax_currency:, purchase_identifier:, purchase_identifier_format:, travel:)
3355
- # Some parameter documentations has been truncated, see
3356
- # {Increase::Models::Transaction::Source::CardRefund::PurchaseDetails} for more
3357
- # details.
3358
- #
3359
3637
  # Additional details about the card purchase, such as tax and industry-specific
3360
3638
  # fields.
3361
3639
  #
3362
- # @param car_rental [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental, nil] Fields specific to car rentals.
3640
+ # @param car_rental [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental, nil]
3641
+ # Fields specific to car rentals.
3363
3642
  #
3364
- # @param customer_reference_identifier [String, nil] An identifier from the merchant for the customer or consumer.
3643
+ # @param customer_reference_identifier [String, nil]
3644
+ # An identifier from the merchant for the customer or consumer.
3365
3645
  #
3366
3646
  # @param local_tax_amount [Integer, nil] The state or provincial tax amount in minor units.
3367
3647
  #
3368
- # @param local_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax as
3648
+ # @param local_tax_currency [String, nil]
3649
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
3650
+ # assessed.
3369
3651
  #
3370
- # @param lodging [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging, nil] Fields specific to lodging.
3652
+ # @param lodging [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging, nil]
3653
+ # Fields specific to lodging.
3371
3654
  #
3372
3655
  # @param national_tax_amount [Integer, nil] The national tax amount in minor units.
3373
3656
  #
3374
- # @param national_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax as
3657
+ # @param national_tax_currency [String, nil]
3658
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
3659
+ # assessed.
3375
3660
  #
3376
- # @param purchase_identifier [String, nil] An identifier from the merchant for the purchase to the issuer and cardholder.
3661
+ # @param purchase_identifier [String, nil]
3662
+ # An identifier from the merchant for the purchase to the issuer and cardholder.
3377
3663
  #
3378
- # @param purchase_identifier_format [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::PurchaseIdentifierFormat, nil] The format of the purchase identifier.
3664
+ # @param purchase_identifier_format [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::PurchaseIdentifierFormat, nil]
3665
+ # The format of the purchase identifier.
3379
3666
  #
3380
- # @param travel [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel, nil] Fields specific to travel.
3667
+ # @param travel [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel, nil]
3668
+ # Fields specific to travel.
3381
3669
 
3382
3670
  # @see Increase::Models::Transaction::Source::CardRefund::PurchaseDetails#car_rental
3383
3671
  class CarRental < Increase::Internal::Type::BaseModel
@@ -3494,43 +3782,56 @@ module Increase
3494
3782
  required :weekly_rental_rate_currency, String, nil?: true
3495
3783
 
3496
3784
  # @!method initialize(car_class_code:, checkout_date:, daily_rental_rate_amount:, daily_rental_rate_currency:, days_rented:, extra_charges:, fuel_charges_amount:, fuel_charges_currency:, insurance_charges_amount:, insurance_charges_currency:, no_show_indicator:, one_way_drop_off_charges_amount:, one_way_drop_off_charges_currency:, renter_name:, weekly_rental_rate_amount:, weekly_rental_rate_currency:)
3497
- # Some parameter documentations has been truncated, see
3498
- # {Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental}
3499
- # for more details.
3500
- #
3501
3785
  # Fields specific to car rentals.
3502
3786
  #
3503
3787
  # @param car_class_code [String, nil] Code indicating the vehicle's class.
3504
3788
  #
3505
- # @param checkout_date [Date, nil] Date the customer picked up the car or, in the case of a no-show or pre-pay tran
3789
+ # @param checkout_date [Date, nil]
3790
+ # Date the customer picked up the car or, in the case of a no-show or pre-pay
3791
+ # transaction, the scheduled pick up date.
3506
3792
  #
3507
3793
  # @param daily_rental_rate_amount [Integer, nil] Daily rate being charged for the vehicle.
3508
3794
  #
3509
- # @param daily_rental_rate_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
3795
+ # @param daily_rental_rate_currency [String, nil]
3796
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
3797
+ # rate.
3510
3798
  #
3511
3799
  # @param days_rented [Integer, nil] Number of days the vehicle was rented.
3512
3800
  #
3513
- # @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental::ExtraCharges, nil] Additional charges (gas, late fee, etc.) being billed.
3801
+ # @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental::ExtraCharges, nil]
3802
+ # Additional charges (gas, late fee, etc.) being billed.
3514
3803
  #
3515
3804
  # @param fuel_charges_amount [Integer, nil] Fuel charges for the vehicle.
3516
3805
  #
3517
- # @param fuel_charges_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
3806
+ # @param fuel_charges_currency [String, nil]
3807
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
3808
+ # assessed.
3518
3809
  #
3519
3810
  # @param insurance_charges_amount [Integer, nil] Any insurance being charged for the vehicle.
3520
3811
  #
3521
- # @param insurance_charges_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance ch
3812
+ # @param insurance_charges_currency [String, nil]
3813
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
3814
+ # charges assessed.
3522
3815
  #
3523
- # @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental::NoShowIndicator, nil] An indicator that the cardholder is being billed for a reserved vehicle that was
3816
+ # @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental::NoShowIndicator, nil]
3817
+ # An indicator that the cardholder is being billed for a reserved vehicle that was
3818
+ # not actually rented (that is, a "no-show" charge).
3524
3819
  #
3525
- # @param one_way_drop_off_charges_amount [Integer, nil] Charges for returning the vehicle at a different location than where it was pick
3820
+ # @param one_way_drop_off_charges_amount [Integer, nil]
3821
+ # Charges for returning the vehicle at a different location than where it was
3822
+ # picked up.
3526
3823
  #
3527
- # @param one_way_drop_off_charges_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way drop
3824
+ # @param one_way_drop_off_charges_currency [String, nil]
3825
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
3826
+ # drop-off charges assessed.
3528
3827
  #
3529
3828
  # @param renter_name [String, nil] Name of the person renting the vehicle.
3530
3829
  #
3531
3830
  # @param weekly_rental_rate_amount [Integer, nil] Weekly rate being charged for the vehicle.
3532
3831
  #
3533
- # @param weekly_rental_rate_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly renta
3832
+ # @param weekly_rental_rate_currency [String, nil]
3833
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
3834
+ # rental rate.
3534
3835
 
3535
3836
  # Additional charges (gas, late fee, etc.) being billed.
3536
3837
  #
@@ -3692,43 +3993,54 @@ module Increase
3692
3993
  required :total_tax_currency, String, nil?: true
3693
3994
 
3694
3995
  # @!method initialize(check_in_date:, daily_room_rate_amount:, daily_room_rate_currency:, extra_charges:, folio_cash_advances_amount:, folio_cash_advances_currency:, food_beverage_charges_amount:, food_beverage_charges_currency:, no_show_indicator:, prepaid_expenses_amount:, prepaid_expenses_currency:, room_nights:, total_room_tax_amount:, total_room_tax_currency:, total_tax_amount:, total_tax_currency:)
3695
- # Some parameter documentations has been truncated, see
3696
- # {Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging}
3697
- # for more details.
3698
- #
3699
3996
  # Fields specific to lodging.
3700
3997
  #
3701
3998
  # @param check_in_date [Date, nil] Date the customer checked in.
3702
3999
  #
3703
4000
  # @param daily_room_rate_amount [Integer, nil] Daily rate being charged for the room.
3704
4001
  #
3705
- # @param daily_room_rate_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room r
4002
+ # @param daily_room_rate_currency [String, nil]
4003
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
4004
+ # rate.
3706
4005
  #
3707
- # @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging::ExtraCharges, nil] Additional charges (phone, late check-out, etc.) being billed.
4006
+ # @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging::ExtraCharges, nil]
4007
+ # Additional charges (phone, late check-out, etc.) being billed.
3708
4008
  #
3709
4009
  # @param folio_cash_advances_amount [Integer, nil] Folio cash advances for the room.
3710
4010
  #
3711
- # @param folio_cash_advances_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash a
4011
+ # @param folio_cash_advances_currency [String, nil]
4012
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
4013
+ # advances.
3712
4014
  #
3713
4015
  # @param food_beverage_charges_amount [Integer, nil] Food and beverage charges for the room.
3714
4016
  #
3715
- # @param food_beverage_charges_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and bev
4017
+ # @param food_beverage_charges_currency [String, nil]
4018
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
4019
+ # beverage charges.
3716
4020
  #
3717
- # @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging::NoShowIndicator, nil] Indicator that the cardholder is being billed for a reserved room that was not a
4021
+ # @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging::NoShowIndicator, nil]
4022
+ # Indicator that the cardholder is being billed for a reserved room that was not
4023
+ # actually used.
3718
4024
  #
3719
4025
  # @param prepaid_expenses_amount [Integer, nil] Prepaid expenses being charged for the room.
3720
4026
  #
3721
- # @param prepaid_expenses_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid expe
4027
+ # @param prepaid_expenses_currency [String, nil]
4028
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
4029
+ # expenses.
3722
4030
  #
3723
4031
  # @param room_nights [Integer, nil] Number of nights the room was rented.
3724
4032
  #
3725
4033
  # @param total_room_tax_amount [Integer, nil] Total room tax being charged.
3726
4034
  #
3727
- # @param total_room_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room t
4035
+ # @param total_room_tax_currency [String, nil]
4036
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
4037
+ # tax.
3728
4038
  #
3729
4039
  # @param total_tax_amount [Integer, nil] Total tax being charged for the room.
3730
4040
  #
3731
- # @param total_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax as
4041
+ # @param total_tax_currency [String, nil]
4042
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
4043
+ # assessed.
3732
4044
 
3733
4045
  # Additional charges (phone, late check-out, etc.) being billed.
3734
4046
  #
@@ -3899,11 +4211,14 @@ module Increase
3899
4211
  # @!method initialize(ancillary:, computerized_reservation_system:, credit_reason_indicator:, departure_date:, origination_city_airport_code:, passenger_name:, restricted_ticket_indicator:, ticket_change_indicator:, ticket_number:, travel_agency_code:, travel_agency_name:, trip_legs:)
3900
4212
  # Fields specific to travel.
3901
4213
  #
3902
- # @param ancillary [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary, nil] Ancillary purchases in addition to the airfare.
4214
+ # @param ancillary [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary, nil]
4215
+ # Ancillary purchases in addition to the airfare.
3903
4216
  #
3904
- # @param computerized_reservation_system [String, nil] Indicates the computerized reservation system used to book the ticket.
4217
+ # @param computerized_reservation_system [String, nil]
4218
+ # Indicates the computerized reservation system used to book the ticket.
3905
4219
  #
3906
- # @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::CreditReasonIndicator, nil] Indicates the reason for a credit to the cardholder.
4220
+ # @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::CreditReasonIndicator, nil]
4221
+ # Indicates the reason for a credit to the cardholder.
3907
4222
  #
3908
4223
  # @param departure_date [Date, nil] Date of departure.
3909
4224
  #
@@ -3911,17 +4226,22 @@ module Increase
3911
4226
  #
3912
4227
  # @param passenger_name [String, nil] Name of the passenger.
3913
4228
  #
3914
- # @param restricted_ticket_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::RestrictedTicketIndicator, nil] Indicates whether this ticket is non-refundable.
4229
+ # @param restricted_ticket_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::RestrictedTicketIndicator, nil]
4230
+ # Indicates whether this ticket is non-refundable.
3915
4231
  #
3916
- # @param ticket_change_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TicketChangeIndicator, nil] Indicates why a ticket was changed.
4232
+ # @param ticket_change_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TicketChangeIndicator, nil]
4233
+ # Indicates why a ticket was changed.
3917
4234
  #
3918
4235
  # @param ticket_number [String, nil] Ticket number.
3919
4236
  #
3920
- # @param travel_agency_code [String, nil] Code for the travel agency if the ticket was issued by a travel agency.
4237
+ # @param travel_agency_code [String, nil]
4238
+ # Code for the travel agency if the ticket was issued by a travel agency.
3921
4239
  #
3922
- # @param travel_agency_name [String, nil] Name of the travel agency if the ticket was issued by a travel agency.
4240
+ # @param travel_agency_name [String, nil]
4241
+ # Name of the travel agency if the ticket was issued by a travel agency.
3923
4242
  #
3924
- # @param trip_legs [Array<Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TripLeg>, nil] Fields specific to each leg of the journey.
4243
+ # @param trip_legs [Array<Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TripLeg>, nil]
4244
+ # Fields specific to each leg of the journey.
3925
4245
 
3926
4246
  # @see Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel#ancillary
3927
4247
  class Ancillary < Increase::Internal::Type::BaseModel
@@ -3963,19 +4283,21 @@ module Increase
3963
4283
  required :ticket_document_number, String, nil?: true
3964
4284
 
3965
4285
  # @!method initialize(connected_ticket_document_number:, credit_reason_indicator:, passenger_name_or_description:, services:, ticket_document_number:)
3966
- # Some parameter documentations has been truncated, see
3967
- # {Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary}
3968
- # for more details.
3969
- #
3970
4286
  # Ancillary purchases in addition to the airfare.
3971
4287
  #
3972
- # @param connected_ticket_document_number [String, nil] If this purchase has a connection or relationship to another purchase, such as a
4288
+ # @param connected_ticket_document_number [String, nil]
4289
+ # If this purchase has a connection or relationship to another purchase, such as a
4290
+ # baggage fee for a passenger transport ticket, this field should contain the
4291
+ # ticket document number for the other purchase.
3973
4292
  #
3974
- # @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator, nil] Indicates the reason for a credit to the cardholder.
4293
+ # @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator, nil]
4294
+ # Indicates the reason for a credit to the cardholder.
3975
4295
  #
3976
- # @param passenger_name_or_description [String, nil] Name of the passenger or description of the ancillary purchase.
4296
+ # @param passenger_name_or_description [String, nil]
4297
+ # Name of the passenger or description of the ancillary purchase.
3977
4298
  #
3978
- # @param services [Array<Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary::Service>] Additional travel charges, such as baggage fees.
4299
+ # @param services [Array<Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary::Service>]
4300
+ # Additional travel charges, such as baggage fees.
3979
4301
  #
3980
4302
  # @param ticket_document_number [String, nil] Ticket document number.
3981
4303
 
@@ -4021,7 +4343,8 @@ module Increase
4021
4343
  required :sub_category, String, nil?: true
4022
4344
 
4023
4345
  # @!method initialize(category:, sub_category:)
4024
- # @param category [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary::Service::Category, nil] Category of the ancillary service.
4346
+ # @param category [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary::Service::Category, nil]
4347
+ # Category of the ancillary service.
4025
4348
  #
4026
4349
  # @param sub_category [String, nil] Sub-category of the ancillary service, free-form.
4027
4350
 
@@ -4226,7 +4549,8 @@ module Increase
4226
4549
  #
4227
4550
  # @param service_class [String, nil] Service class (e.g., first class, business class, etc.).
4228
4551
  #
4229
- # @param stop_over_code [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TripLeg::StopOverCode, nil] Indicates whether a stopover is allowed on this ticket.
4552
+ # @param stop_over_code [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TripLeg::StopOverCode, nil]
4553
+ # Indicates whether a stopover is allowed on this ticket.
4230
4554
 
4231
4555
  # Indicates whether a stopover is allowed on this ticket.
4232
4556
  #
@@ -4292,20 +4616,26 @@ module Increase
4292
4616
  required :variable_rate, String, nil?: true
4293
4617
 
4294
4618
  # @!method initialize(amount:, created_at:, currency:, fee_type:, fixed_component:, variable_rate:)
4295
- # Some parameter documentations has been truncated, see
4296
- # {Increase::Models::Transaction::Source::CardRefund::SchemeFee} for more details.
4297
- #
4298
4619
  # @param amount [String] The fee amount given as a string containing a decimal number.
4299
4620
  #
4300
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was
4621
+ # @param created_at [Time]
4622
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was
4623
+ # created.
4301
4624
  #
4302
- # @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::SchemeFee::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimburs
4625
+ # @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::SchemeFee::Currency]
4626
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
4627
+ # reimbursement.
4303
4628
  #
4304
- # @param fee_type [Symbol, Increase::Models::Transaction::Source::CardRefund::SchemeFee::FeeType] The type of fee being assessed.
4629
+ # @param fee_type [Symbol, Increase::Models::Transaction::Source::CardRefund::SchemeFee::FeeType]
4630
+ # The type of fee being assessed.
4305
4631
  #
4306
- # @param fixed_component [String, nil] The fixed component of the fee, if applicable, given in major units of the fee a
4632
+ # @param fixed_component [String, nil]
4633
+ # The fixed component of the fee, if applicable, given in major units of the fee
4634
+ # amount.
4307
4635
  #
4308
- # @param variable_rate [String, nil] The variable rate component of the fee, if applicable, given as a decimal (e.g.,
4636
+ # @param variable_rate [String, nil]
4637
+ # The variable rate component of the fee, if applicable, given as a decimal (e.g.,
4638
+ # 0.015 for 1.5%).
4309
4639
 
4310
4640
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
4311
4641
  # reimbursement.
@@ -4471,16 +4801,17 @@ module Increase
4471
4801
  required :transacted_on_account_id, String, nil?: true
4472
4802
 
4473
4803
  # @!method initialize(amount:, currency:, period_end:, period_start:, transacted_on_account_id:)
4474
- # Some parameter documentations has been truncated, see
4475
- # {Increase::Models::Transaction::Source::CardRevenuePayment} for more details.
4476
- #
4477
4804
  # A Card Revenue Payment object. This field will be present in the JSON response
4478
4805
  # if and only if `category` is equal to `card_revenue_payment`. Card Revenue
4479
4806
  # Payments reflect earnings from fees on card transactions.
4480
4807
  #
4481
- # @param amount [Integer] The amount in the minor unit of the transaction's currency. For dollars, for exa
4808
+ # @param amount [Integer]
4809
+ # The amount in the minor unit of the transaction's currency. For dollars, for
4810
+ # example, this is cents.
4482
4811
  #
4483
- # @param currency [Symbol, Increase::Models::Transaction::Source::CardRevenuePayment::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
4812
+ # @param currency [Symbol, Increase::Models::Transaction::Source::CardRevenuePayment::Currency]
4813
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
4814
+ # currency.
4484
4815
  #
4485
4816
  # @param period_end [Time] The end of the period for which this transaction paid interest.
4486
4817
  #
@@ -4663,9 +4994,6 @@ module Increase
4663
4994
  required :type, enum: -> { Increase::Transaction::Source::CardSettlement::Type }
4664
4995
 
4665
4996
  # @!method initialize(id:, amount:, card_authorization:, card_payment_id:, cashback:, currency:, interchange:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_name:, merchant_postal_code:, merchant_state:, network:, network_identifiers:, pending_transaction_id:, presentment_amount:, presentment_currency:, purchase_details:, scheme_fees:, surcharge:, transaction_id:, type:)
4666
- # Some parameter documentations has been truncated, see
4667
- # {Increase::Models::Transaction::Source::CardSettlement} for more details.
4668
- #
4669
4997
  # A Card Settlement object. This field will be present in the JSON response if and
4670
4998
  # only if `category` is equal to `card_settlement`. Card Settlements are card
4671
4999
  # transactions that have cleared and settled. While a settlement is usually
@@ -4674,19 +5002,30 @@ module Increase
4674
5002
  #
4675
5003
  # @param id [String] The Card Settlement identifier.
4676
5004
  #
4677
- # @param amount [Integer] The amount in the minor unit of the transaction's settlement currency. For dolla
5005
+ # @param amount [Integer]
5006
+ # The amount in the minor unit of the transaction's settlement currency. For
5007
+ # dollars, for example, this is cents.
4678
5008
  #
4679
- # @param card_authorization [String, nil] The Card Authorization that was created prior to this Card Settlement, if one ex
5009
+ # @param card_authorization [String, nil]
5010
+ # The Card Authorization that was created prior to this Card Settlement, if one
5011
+ # exists.
4680
5012
  #
4681
5013
  # @param card_payment_id [String] The ID of the Card Payment this transaction belongs to.
4682
5014
  #
4683
- # @param cashback [Increase::Models::Transaction::Source::CardSettlement::Cashback, nil] Cashback earned on this transaction, if eligible. Cashback is paid out in aggreg
5015
+ # @param cashback [Increase::Models::Transaction::Source::CardSettlement::Cashback, nil]
5016
+ # Cashback earned on this transaction, if eligible. Cashback is paid out in
5017
+ # aggregate, monthly.
4684
5018
  #
4685
- # @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction'
5019
+ # @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::Currency]
5020
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
5021
+ # transaction's settlement currency.
4686
5022
  #
4687
- # @param interchange [Increase::Models::Transaction::Source::CardSettlement::Interchange, nil] Interchange assessed as a part of this transaction.
5023
+ # @param interchange [Increase::Models::Transaction::Source::CardSettlement::Interchange, nil]
5024
+ # Interchange assessed as a part of this transaction.
4688
5025
  #
4689
- # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i
5026
+ # @param merchant_acceptor_id [String]
5027
+ # The merchant identifier (commonly abbreviated as MID) of the merchant the card
5028
+ # is transacting with.
4690
5029
  #
4691
5030
  # @param merchant_category_code [String] The 4-digit MCC describing the merchant's business.
4692
5031
  #
@@ -4696,29 +5035,44 @@ module Increase
4696
5035
  #
4697
5036
  # @param merchant_name [String] The name of the merchant.
4698
5037
  #
4699
- # @param merchant_postal_code [String, nil] The merchant's postal code. For US merchants this is always a 5-digit ZIP code.
5038
+ # @param merchant_postal_code [String, nil]
5039
+ # The merchant's postal code. For US merchants this is always a 5-digit ZIP code.
4700
5040
  #
4701
5041
  # @param merchant_state [String, nil] The state the merchant resides in.
4702
5042
  #
4703
- # @param network [Symbol, Increase::Models::Transaction::Source::CardSettlement::Network] The card network on which this transaction was processed.
5043
+ # @param network [Symbol, Increase::Models::Transaction::Source::CardSettlement::Network]
5044
+ # The card network on which this transaction was processed.
4704
5045
  #
4705
- # @param network_identifiers [Increase::Models::Transaction::Source::CardSettlement::NetworkIdentifiers] Network-specific identifiers for this refund.
5046
+ # @param network_identifiers [Increase::Models::Transaction::Source::CardSettlement::NetworkIdentifiers]
5047
+ # Network-specific identifiers for this refund.
4706
5048
  #
4707
- # @param pending_transaction_id [String, nil] The identifier of the Pending Transaction associated with this Transaction.
5049
+ # @param pending_transaction_id [String, nil]
5050
+ # The identifier of the Pending Transaction associated with this Transaction.
4708
5051
  #
4709
- # @param presentment_amount [Integer] The amount in the minor unit of the transaction's presentment currency.
5052
+ # @param presentment_amount [Integer]
5053
+ # The amount in the minor unit of the transaction's presentment currency.
4710
5054
  #
4711
- # @param presentment_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction'
5055
+ # @param presentment_currency [String]
5056
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
5057
+ # transaction's presentment currency.
4712
5058
  #
4713
- # @param purchase_details [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails, nil] Additional details about the card purchase, such as tax and industry-specific fi
5059
+ # @param purchase_details [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails, nil]
5060
+ # Additional details about the card purchase, such as tax and industry-specific
5061
+ # fields.
4714
5062
  #
4715
- # @param scheme_fees [Array<Increase::Models::Transaction::Source::CardSettlement::SchemeFee>] The scheme fees associated with this card settlement.
5063
+ # @param scheme_fees [Array<Increase::Models::Transaction::Source::CardSettlement::SchemeFee>]
5064
+ # The scheme fees associated with this card settlement.
4716
5065
  #
4717
- # @param surcharge [Increase::Models::Transaction::Source::CardSettlement::Surcharge, nil] Surcharge amount details, if applicable. The amount is positive if the surcharge
5066
+ # @param surcharge [Increase::Models::Transaction::Source::CardSettlement::Surcharge, nil]
5067
+ # Surcharge amount details, if applicable. The amount is positive if the surcharge
5068
+ # is added to the overall transaction amount (surcharge), and negative if the
5069
+ # surcharge is deducted from the overall transaction amount (discount).
4718
5070
  #
4719
5071
  # @param transaction_id [String] The identifier of the Transaction associated with this Transaction.
4720
5072
  #
4721
- # @param type [Symbol, Increase::Models::Transaction::Source::CardSettlement::Type] A constant representing the object's type. For this resource it will always be `
5073
+ # @param type [Symbol, Increase::Models::Transaction::Source::CardSettlement::Type]
5074
+ # A constant representing the object's type. For this resource it will always be
5075
+ # `card_settlement`.
4722
5076
 
4723
5077
  # @see Increase::Models::Transaction::Source::CardSettlement#cashback
4724
5078
  class Cashback < Increase::Internal::Type::BaseModel
@@ -4737,16 +5091,16 @@ module Increase
4737
5091
  required :currency, enum: -> { Increase::Transaction::Source::CardSettlement::Cashback::Currency }
4738
5092
 
4739
5093
  # @!method initialize(amount:, currency:)
4740
- # Some parameter documentations has been truncated, see
4741
- # {Increase::Models::Transaction::Source::CardSettlement::Cashback} for more
4742
- # details.
4743
- #
4744
5094
  # Cashback earned on this transaction, if eligible. Cashback is paid out in
4745
5095
  # aggregate, monthly.
4746
5096
  #
4747
- # @param amount [String] The cashback amount given as a string containing a decimal number. The amount is
5097
+ # @param amount [String]
5098
+ # The cashback amount given as a string containing a decimal number. The amount is
5099
+ # a positive number if it will be credited to you (e.g., settlements) and a
5100
+ # negative number if it will be debited (e.g., refunds).
4748
5101
  #
4749
- # @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::Cashback::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback.
5102
+ # @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::Cashback::Currency]
5103
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback.
4750
5104
 
4751
5105
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback.
4752
5106
  #
@@ -4801,17 +5155,19 @@ module Increase
4801
5155
  required :currency, enum: -> { Increase::Transaction::Source::CardSettlement::Interchange::Currency }
4802
5156
 
4803
5157
  # @!method initialize(amount:, code:, currency:)
4804
- # Some parameter documentations has been truncated, see
4805
- # {Increase::Models::Transaction::Source::CardSettlement::Interchange} for more
4806
- # details.
4807
- #
4808
5158
  # Interchange assessed as a part of this transaction.
4809
5159
  #
4810
- # @param amount [String] The interchange amount given as a string containing a decimal number in major un
5160
+ # @param amount [String]
5161
+ # The interchange amount given as a string containing a decimal number in major
5162
+ # units (so e.g., "3.14" for $3.14). The amount is a positive number if it is
5163
+ # credited to Increase (e.g., settlements) and a negative number if it is debited
5164
+ # (e.g., refunds).
4811
5165
  #
4812
5166
  # @param code [String, nil] The card network specific interchange code.
4813
5167
  #
4814
- # @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::Interchange::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange
5168
+ # @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::Interchange::Currency]
5169
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange
5170
+ # reimbursement.
4815
5171
 
4816
5172
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange
4817
5173
  # reimbursement.
@@ -4874,19 +5230,21 @@ module Increase
4874
5230
  required :transaction_id, String, nil?: true
4875
5231
 
4876
5232
  # @!method initialize(acquirer_business_id:, acquirer_reference_number:, authorization_identification_response:, transaction_id:)
4877
- # Some parameter documentations has been truncated, see
4878
- # {Increase::Models::Transaction::Source::CardSettlement::NetworkIdentifiers} for
4879
- # more details.
4880
- #
4881
5233
  # Network-specific identifiers for this refund.
4882
5234
  #
4883
- # @param acquirer_business_id [String] A network assigned business ID that identifies the acquirer that processed this
5235
+ # @param acquirer_business_id [String]
5236
+ # A network assigned business ID that identifies the acquirer that processed this
5237
+ # transaction.
4884
5238
  #
4885
5239
  # @param acquirer_reference_number [String] A globally unique identifier for this settlement.
4886
5240
  #
4887
- # @param authorization_identification_response [String, nil] The randomly generated 6-character Authorization Identification Response code se
5241
+ # @param authorization_identification_response [String, nil]
5242
+ # The randomly generated 6-character Authorization Identification Response code
5243
+ # sent back to the acquirer in an approved response.
4888
5244
  #
4889
- # @param transaction_id [String, nil] A globally unique transaction identifier provided by the card network, used acro
5245
+ # @param transaction_id [String, nil]
5246
+ # A globally unique transaction identifier provided by the card network, used
5247
+ # across multiple life-cycle requests.
4890
5248
  end
4891
5249
 
4892
5250
  # @see Increase::Models::Transaction::Source::CardSettlement#purchase_details
@@ -4964,32 +5322,38 @@ module Increase
4964
5322
  nil?: true
4965
5323
 
4966
5324
  # @!method initialize(car_rental:, customer_reference_identifier:, local_tax_amount:, local_tax_currency:, lodging:, national_tax_amount:, national_tax_currency:, purchase_identifier:, purchase_identifier_format:, travel:)
4967
- # Some parameter documentations has been truncated, see
4968
- # {Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails} for
4969
- # more details.
4970
- #
4971
5325
  # Additional details about the card purchase, such as tax and industry-specific
4972
5326
  # fields.
4973
5327
  #
4974
- # @param car_rental [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental, nil] Fields specific to car rentals.
5328
+ # @param car_rental [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental, nil]
5329
+ # Fields specific to car rentals.
4975
5330
  #
4976
- # @param customer_reference_identifier [String, nil] An identifier from the merchant for the customer or consumer.
5331
+ # @param customer_reference_identifier [String, nil]
5332
+ # An identifier from the merchant for the customer or consumer.
4977
5333
  #
4978
5334
  # @param local_tax_amount [Integer, nil] The state or provincial tax amount in minor units.
4979
5335
  #
4980
- # @param local_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax as
5336
+ # @param local_tax_currency [String, nil]
5337
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
5338
+ # assessed.
4981
5339
  #
4982
- # @param lodging [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging, nil] Fields specific to lodging.
5340
+ # @param lodging [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging, nil]
5341
+ # Fields specific to lodging.
4983
5342
  #
4984
5343
  # @param national_tax_amount [Integer, nil] The national tax amount in minor units.
4985
5344
  #
4986
- # @param national_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax as
5345
+ # @param national_tax_currency [String, nil]
5346
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
5347
+ # assessed.
4987
5348
  #
4988
- # @param purchase_identifier [String, nil] An identifier from the merchant for the purchase to the issuer and cardholder.
5349
+ # @param purchase_identifier [String, nil]
5350
+ # An identifier from the merchant for the purchase to the issuer and cardholder.
4989
5351
  #
4990
- # @param purchase_identifier_format [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::PurchaseIdentifierFormat, nil] The format of the purchase identifier.
5352
+ # @param purchase_identifier_format [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::PurchaseIdentifierFormat, nil]
5353
+ # The format of the purchase identifier.
4991
5354
  #
4992
- # @param travel [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel, nil] Fields specific to travel.
5355
+ # @param travel [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel, nil]
5356
+ # Fields specific to travel.
4993
5357
 
4994
5358
  # @see Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails#car_rental
4995
5359
  class CarRental < Increase::Internal::Type::BaseModel
@@ -5106,43 +5470,56 @@ module Increase
5106
5470
  required :weekly_rental_rate_currency, String, nil?: true
5107
5471
 
5108
5472
  # @!method initialize(car_class_code:, checkout_date:, daily_rental_rate_amount:, daily_rental_rate_currency:, days_rented:, extra_charges:, fuel_charges_amount:, fuel_charges_currency:, insurance_charges_amount:, insurance_charges_currency:, no_show_indicator:, one_way_drop_off_charges_amount:, one_way_drop_off_charges_currency:, renter_name:, weekly_rental_rate_amount:, weekly_rental_rate_currency:)
5109
- # Some parameter documentations has been truncated, see
5110
- # {Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental}
5111
- # for more details.
5112
- #
5113
5473
  # Fields specific to car rentals.
5114
5474
  #
5115
5475
  # @param car_class_code [String, nil] Code indicating the vehicle's class.
5116
5476
  #
5117
- # @param checkout_date [Date, nil] Date the customer picked up the car or, in the case of a no-show or pre-pay tran
5477
+ # @param checkout_date [Date, nil]
5478
+ # Date the customer picked up the car or, in the case of a no-show or pre-pay
5479
+ # transaction, the scheduled pick up date.
5118
5480
  #
5119
5481
  # @param daily_rental_rate_amount [Integer, nil] Daily rate being charged for the vehicle.
5120
5482
  #
5121
- # @param daily_rental_rate_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
5483
+ # @param daily_rental_rate_currency [String, nil]
5484
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
5485
+ # rate.
5122
5486
  #
5123
5487
  # @param days_rented [Integer, nil] Number of days the vehicle was rented.
5124
5488
  #
5125
- # @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental::ExtraCharges, nil] Additional charges (gas, late fee, etc.) being billed.
5489
+ # @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental::ExtraCharges, nil]
5490
+ # Additional charges (gas, late fee, etc.) being billed.
5126
5491
  #
5127
5492
  # @param fuel_charges_amount [Integer, nil] Fuel charges for the vehicle.
5128
5493
  #
5129
- # @param fuel_charges_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
5494
+ # @param fuel_charges_currency [String, nil]
5495
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
5496
+ # assessed.
5130
5497
  #
5131
5498
  # @param insurance_charges_amount [Integer, nil] Any insurance being charged for the vehicle.
5132
5499
  #
5133
- # @param insurance_charges_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance ch
5500
+ # @param insurance_charges_currency [String, nil]
5501
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
5502
+ # charges assessed.
5134
5503
  #
5135
- # @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental::NoShowIndicator, nil] An indicator that the cardholder is being billed for a reserved vehicle that was
5504
+ # @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental::NoShowIndicator, nil]
5505
+ # An indicator that the cardholder is being billed for a reserved vehicle that was
5506
+ # not actually rented (that is, a "no-show" charge).
5136
5507
  #
5137
- # @param one_way_drop_off_charges_amount [Integer, nil] Charges for returning the vehicle at a different location than where it was pick
5508
+ # @param one_way_drop_off_charges_amount [Integer, nil]
5509
+ # Charges for returning the vehicle at a different location than where it was
5510
+ # picked up.
5138
5511
  #
5139
- # @param one_way_drop_off_charges_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way drop
5512
+ # @param one_way_drop_off_charges_currency [String, nil]
5513
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
5514
+ # drop-off charges assessed.
5140
5515
  #
5141
5516
  # @param renter_name [String, nil] Name of the person renting the vehicle.
5142
5517
  #
5143
5518
  # @param weekly_rental_rate_amount [Integer, nil] Weekly rate being charged for the vehicle.
5144
5519
  #
5145
- # @param weekly_rental_rate_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly renta
5520
+ # @param weekly_rental_rate_currency [String, nil]
5521
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
5522
+ # rental rate.
5146
5523
 
5147
5524
  # Additional charges (gas, late fee, etc.) being billed.
5148
5525
  #
@@ -5304,43 +5681,54 @@ module Increase
5304
5681
  required :total_tax_currency, String, nil?: true
5305
5682
 
5306
5683
  # @!method initialize(check_in_date:, daily_room_rate_amount:, daily_room_rate_currency:, extra_charges:, folio_cash_advances_amount:, folio_cash_advances_currency:, food_beverage_charges_amount:, food_beverage_charges_currency:, no_show_indicator:, prepaid_expenses_amount:, prepaid_expenses_currency:, room_nights:, total_room_tax_amount:, total_room_tax_currency:, total_tax_amount:, total_tax_currency:)
5307
- # Some parameter documentations has been truncated, see
5308
- # {Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging}
5309
- # for more details.
5310
- #
5311
5684
  # Fields specific to lodging.
5312
5685
  #
5313
5686
  # @param check_in_date [Date, nil] Date the customer checked in.
5314
5687
  #
5315
5688
  # @param daily_room_rate_amount [Integer, nil] Daily rate being charged for the room.
5316
5689
  #
5317
- # @param daily_room_rate_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room r
5690
+ # @param daily_room_rate_currency [String, nil]
5691
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
5692
+ # rate.
5318
5693
  #
5319
- # @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::ExtraCharges, nil] Additional charges (phone, late check-out, etc.) being billed.
5694
+ # @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::ExtraCharges, nil]
5695
+ # Additional charges (phone, late check-out, etc.) being billed.
5320
5696
  #
5321
5697
  # @param folio_cash_advances_amount [Integer, nil] Folio cash advances for the room.
5322
5698
  #
5323
- # @param folio_cash_advances_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash a
5699
+ # @param folio_cash_advances_currency [String, nil]
5700
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
5701
+ # advances.
5324
5702
  #
5325
5703
  # @param food_beverage_charges_amount [Integer, nil] Food and beverage charges for the room.
5326
5704
  #
5327
- # @param food_beverage_charges_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and bev
5705
+ # @param food_beverage_charges_currency [String, nil]
5706
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
5707
+ # beverage charges.
5328
5708
  #
5329
- # @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::NoShowIndicator, nil] Indicator that the cardholder is being billed for a reserved room that was not a
5709
+ # @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::NoShowIndicator, nil]
5710
+ # Indicator that the cardholder is being billed for a reserved room that was not
5711
+ # actually used.
5330
5712
  #
5331
5713
  # @param prepaid_expenses_amount [Integer, nil] Prepaid expenses being charged for the room.
5332
5714
  #
5333
- # @param prepaid_expenses_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid expe
5715
+ # @param prepaid_expenses_currency [String, nil]
5716
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
5717
+ # expenses.
5334
5718
  #
5335
5719
  # @param room_nights [Integer, nil] Number of nights the room was rented.
5336
5720
  #
5337
5721
  # @param total_room_tax_amount [Integer, nil] Total room tax being charged.
5338
5722
  #
5339
- # @param total_room_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room t
5723
+ # @param total_room_tax_currency [String, nil]
5724
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
5725
+ # tax.
5340
5726
  #
5341
5727
  # @param total_tax_amount [Integer, nil] Total tax being charged for the room.
5342
5728
  #
5343
- # @param total_tax_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax as
5729
+ # @param total_tax_currency [String, nil]
5730
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
5731
+ # assessed.
5344
5732
 
5345
5733
  # Additional charges (phone, late check-out, etc.) being billed.
5346
5734
  #
@@ -5513,11 +5901,14 @@ module Increase
5513
5901
  # @!method initialize(ancillary:, computerized_reservation_system:, credit_reason_indicator:, departure_date:, origination_city_airport_code:, passenger_name:, restricted_ticket_indicator:, ticket_change_indicator:, ticket_number:, travel_agency_code:, travel_agency_name:, trip_legs:)
5514
5902
  # Fields specific to travel.
5515
5903
  #
5516
- # @param ancillary [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary, nil] Ancillary purchases in addition to the airfare.
5904
+ # @param ancillary [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary, nil]
5905
+ # Ancillary purchases in addition to the airfare.
5517
5906
  #
5518
- # @param computerized_reservation_system [String, nil] Indicates the computerized reservation system used to book the ticket.
5907
+ # @param computerized_reservation_system [String, nil]
5908
+ # Indicates the computerized reservation system used to book the ticket.
5519
5909
  #
5520
- # @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::CreditReasonIndicator, nil] Indicates the reason for a credit to the cardholder.
5910
+ # @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::CreditReasonIndicator, nil]
5911
+ # Indicates the reason for a credit to the cardholder.
5521
5912
  #
5522
5913
  # @param departure_date [Date, nil] Date of departure.
5523
5914
  #
@@ -5525,17 +5916,22 @@ module Increase
5525
5916
  #
5526
5917
  # @param passenger_name [String, nil] Name of the passenger.
5527
5918
  #
5528
- # @param restricted_ticket_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::RestrictedTicketIndicator, nil] Indicates whether this ticket is non-refundable.
5919
+ # @param restricted_ticket_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::RestrictedTicketIndicator, nil]
5920
+ # Indicates whether this ticket is non-refundable.
5529
5921
  #
5530
- # @param ticket_change_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TicketChangeIndicator, nil] Indicates why a ticket was changed.
5922
+ # @param ticket_change_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TicketChangeIndicator, nil]
5923
+ # Indicates why a ticket was changed.
5531
5924
  #
5532
5925
  # @param ticket_number [String, nil] Ticket number.
5533
5926
  #
5534
- # @param travel_agency_code [String, nil] Code for the travel agency if the ticket was issued by a travel agency.
5927
+ # @param travel_agency_code [String, nil]
5928
+ # Code for the travel agency if the ticket was issued by a travel agency.
5535
5929
  #
5536
- # @param travel_agency_name [String, nil] Name of the travel agency if the ticket was issued by a travel agency.
5930
+ # @param travel_agency_name [String, nil]
5931
+ # Name of the travel agency if the ticket was issued by a travel agency.
5537
5932
  #
5538
- # @param trip_legs [Array<Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TripLeg>, nil] Fields specific to each leg of the journey.
5933
+ # @param trip_legs [Array<Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TripLeg>, nil]
5934
+ # Fields specific to each leg of the journey.
5539
5935
 
5540
5936
  # @see Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel#ancillary
5541
5937
  class Ancillary < Increase::Internal::Type::BaseModel
@@ -5577,19 +5973,21 @@ module Increase
5577
5973
  required :ticket_document_number, String, nil?: true
5578
5974
 
5579
5975
  # @!method initialize(connected_ticket_document_number:, credit_reason_indicator:, passenger_name_or_description:, services:, ticket_document_number:)
5580
- # Some parameter documentations has been truncated, see
5581
- # {Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary}
5582
- # for more details.
5583
- #
5584
5976
  # Ancillary purchases in addition to the airfare.
5585
5977
  #
5586
- # @param connected_ticket_document_number [String, nil] If this purchase has a connection or relationship to another purchase, such as a
5978
+ # @param connected_ticket_document_number [String, nil]
5979
+ # If this purchase has a connection or relationship to another purchase, such as a
5980
+ # baggage fee for a passenger transport ticket, this field should contain the
5981
+ # ticket document number for the other purchase.
5587
5982
  #
5588
- # @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator, nil] Indicates the reason for a credit to the cardholder.
5983
+ # @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator, nil]
5984
+ # Indicates the reason for a credit to the cardholder.
5589
5985
  #
5590
- # @param passenger_name_or_description [String, nil] Name of the passenger or description of the ancillary purchase.
5986
+ # @param passenger_name_or_description [String, nil]
5987
+ # Name of the passenger or description of the ancillary purchase.
5591
5988
  #
5592
- # @param services [Array<Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary::Service>] Additional travel charges, such as baggage fees.
5989
+ # @param services [Array<Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary::Service>]
5990
+ # Additional travel charges, such as baggage fees.
5593
5991
  #
5594
5992
  # @param ticket_document_number [String, nil] Ticket document number.
5595
5993
 
@@ -5635,7 +6033,8 @@ module Increase
5635
6033
  required :sub_category, String, nil?: true
5636
6034
 
5637
6035
  # @!method initialize(category:, sub_category:)
5638
- # @param category [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary::Service::Category, nil] Category of the ancillary service.
6036
+ # @param category [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary::Service::Category, nil]
6037
+ # Category of the ancillary service.
5639
6038
  #
5640
6039
  # @param sub_category [String, nil] Sub-category of the ancillary service, free-form.
5641
6040
 
@@ -5840,7 +6239,8 @@ module Increase
5840
6239
  #
5841
6240
  # @param service_class [String, nil] Service class (e.g., first class, business class, etc.).
5842
6241
  #
5843
- # @param stop_over_code [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TripLeg::StopOverCode, nil] Indicates whether a stopover is allowed on this ticket.
6242
+ # @param stop_over_code [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TripLeg::StopOverCode, nil]
6243
+ # Indicates whether a stopover is allowed on this ticket.
5844
6244
 
5845
6245
  # Indicates whether a stopover is allowed on this ticket.
5846
6246
  #
@@ -5906,21 +6306,26 @@ module Increase
5906
6306
  required :variable_rate, String, nil?: true
5907
6307
 
5908
6308
  # @!method initialize(amount:, created_at:, currency:, fee_type:, fixed_component:, variable_rate:)
5909
- # Some parameter documentations has been truncated, see
5910
- # {Increase::Models::Transaction::Source::CardSettlement::SchemeFee} for more
5911
- # details.
5912
- #
5913
6309
  # @param amount [String] The fee amount given as a string containing a decimal number.
5914
6310
  #
5915
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was
6311
+ # @param created_at [Time]
6312
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was
6313
+ # created.
5916
6314
  #
5917
- # @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::SchemeFee::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimburs
6315
+ # @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::SchemeFee::Currency]
6316
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
6317
+ # reimbursement.
5918
6318
  #
5919
- # @param fee_type [Symbol, Increase::Models::Transaction::Source::CardSettlement::SchemeFee::FeeType] The type of fee being assessed.
6319
+ # @param fee_type [Symbol, Increase::Models::Transaction::Source::CardSettlement::SchemeFee::FeeType]
6320
+ # The type of fee being assessed.
5920
6321
  #
5921
- # @param fixed_component [String, nil] The fixed component of the fee, if applicable, given in major units of the fee a
6322
+ # @param fixed_component [String, nil]
6323
+ # The fixed component of the fee, if applicable, given in major units of the fee
6324
+ # amount.
5922
6325
  #
5923
- # @param variable_rate [String, nil] The variable rate component of the fee, if applicable, given as a decimal (e.g.,
6326
+ # @param variable_rate [String, nil]
6327
+ # The variable rate component of the fee, if applicable, given as a decimal (e.g.,
6328
+ # 0.015 for 1.5%).
5924
6329
 
5925
6330
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
5926
6331
  # reimbursement.
@@ -6053,17 +6458,15 @@ module Increase
6053
6458
  required :presentment_amount, Integer
6054
6459
 
6055
6460
  # @!method initialize(amount:, presentment_amount:)
6056
- # Some parameter documentations has been truncated, see
6057
- # {Increase::Models::Transaction::Source::CardSettlement::Surcharge} for more
6058
- # details.
6059
- #
6060
6461
  # Surcharge amount details, if applicable. The amount is positive if the surcharge
6061
6462
  # is added to the overall transaction amount (surcharge), and negative if the
6062
6463
  # surcharge is deducted from the overall transaction amount (discount).
6063
6464
  #
6064
6465
  # @param amount [Integer] The surcharge amount in the minor unit of the transaction's settlement currency.
6065
6466
  #
6066
- # @param presentment_amount [Integer] The surcharge amount in the minor unit of the transaction's presentment currency
6467
+ # @param presentment_amount [Integer]
6468
+ # The surcharge amount in the minor unit of the transaction's presentment
6469
+ # currency.
6067
6470
  end
6068
6471
 
6069
6472
  # A constant representing the object's type. For this resource it will always be
@@ -6115,9 +6518,6 @@ module Increase
6115
6518
  required :period_start, Time
6116
6519
 
6117
6520
  # @!method initialize(accrued_on_card_id:, amount:, currency:, period_end:, period_start:)
6118
- # Some parameter documentations has been truncated, see
6119
- # {Increase::Models::Transaction::Source::CashbackPayment} for more details.
6120
- #
6121
6521
  # A Cashback Payment object. This field will be present in the JSON response if
6122
6522
  # and only if `category` is equal to `cashback_payment`. A Cashback Payment
6123
6523
  # represents the cashback paid to a cardholder for a given period. Cashback is
@@ -6125,9 +6525,13 @@ module Increase
6125
6525
  #
6126
6526
  # @param accrued_on_card_id [String, nil] The card on which the cashback was accrued.
6127
6527
  #
6128
- # @param amount [Integer] The amount in the minor unit of the transaction's currency. For dollars, for exa
6528
+ # @param amount [Integer]
6529
+ # The amount in the minor unit of the transaction's currency. For dollars, for
6530
+ # example, this is cents.
6129
6531
  #
6130
- # @param currency [Symbol, Increase::Models::Transaction::Source::CashbackPayment::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
6532
+ # @param currency [Symbol, Increase::Models::Transaction::Source::CashbackPayment::Currency]
6533
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
6534
+ # currency.
6131
6535
  #
6132
6536
  # @param period_end [Time] The end of the period for which this transaction paid cashback.
6133
6537
  #
@@ -6199,29 +6603,37 @@ module Increase
6199
6603
  required :serial_number, String, nil?: true
6200
6604
 
6201
6605
  # @!method initialize(account_number:, amount:, auxiliary_on_us:, check_deposit_id:, currency:, routing_number:, serial_number:)
6202
- # Some parameter documentations has been truncated, see
6203
- # {Increase::Models::Transaction::Source::CheckDepositAcceptance} for more
6204
- # details.
6205
- #
6206
6606
  # A Check Deposit Acceptance object. This field will be present in the JSON
6207
6607
  # response if and only if `category` is equal to `check_deposit_acceptance`. A
6208
6608
  # Check Deposit Acceptance is created when a Check Deposit is processed and its
6209
6609
  # details confirmed. Check Deposits may be returned by the receiving bank, which
6210
6610
  # will appear as a Check Deposit Return.
6211
6611
  #
6212
- # @param account_number [String] The account number printed on the check. This is an account at the bank that iss
6612
+ # @param account_number [String]
6613
+ # The account number printed on the check. This is an account at the bank that
6614
+ # issued the check.
6213
6615
  #
6214
- # @param amount [Integer] The amount to be deposited in the minor unit of the transaction's currency. For
6616
+ # @param amount [Integer]
6617
+ # The amount to be deposited in the minor unit of the transaction's currency. For
6618
+ # dollars, for example, this is cents.
6215
6619
  #
6216
- # @param auxiliary_on_us [String, nil] An additional line of metadata printed on the check. This typically includes the
6620
+ # @param auxiliary_on_us [String, nil]
6621
+ # An additional line of metadata printed on the check. This typically includes the
6622
+ # check number for business checks.
6217
6623
  #
6218
6624
  # @param check_deposit_id [String] The ID of the Check Deposit that was accepted.
6219
6625
  #
6220
- # @param currency [Symbol, Increase::Models::Transaction::Source::CheckDepositAcceptance::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction'
6626
+ # @param currency [Symbol, Increase::Models::Transaction::Source::CheckDepositAcceptance::Currency]
6627
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
6628
+ # transaction's currency.
6221
6629
  #
6222
- # @param routing_number [String] The routing number printed on the check. This is a routing number for the bank t
6630
+ # @param routing_number [String]
6631
+ # The routing number printed on the check. This is a routing number for the bank
6632
+ # that issued the check.
6223
6633
  #
6224
- # @param serial_number [String, nil] The check serial number, if present, for consumer checks. For business checks, t
6634
+ # @param serial_number [String, nil]
6635
+ # The check serial number, if present, for consumer checks. For business checks,
6636
+ # the serial number is usually in the `auxiliary_on_us` field.
6225
6637
 
6226
6638
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
6227
6639
  # transaction's currency.
@@ -6281,9 +6693,6 @@ module Increase
6281
6693
  required :transaction_id, String
6282
6694
 
6283
6695
  # @!method initialize(amount:, check_deposit_id:, currency:, return_reason:, returned_at:, transaction_id:)
6284
- # Some parameter documentations has been truncated, see
6285
- # {Increase::Models::Transaction::Source::CheckDepositReturn} for more details.
6286
- #
6287
6696
  # A Check Deposit Return object. This field will be present in the JSON response
6288
6697
  # if and only if `category` is equal to `check_deposit_return`. A Check Deposit
6289
6698
  # Return is created when a Check Deposit is returned by the bank holding the
@@ -6295,13 +6704,21 @@ module Increase
6295
6704
  #
6296
6705
  # @param check_deposit_id [String] The identifier of the Check Deposit that was returned.
6297
6706
  #
6298
- # @param currency [Symbol, Increase::Models::Transaction::Source::CheckDepositReturn::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction'
6707
+ # @param currency [Symbol, Increase::Models::Transaction::Source::CheckDepositReturn::Currency]
6708
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
6709
+ # transaction's currency.
6299
6710
  #
6300
- # @param return_reason [Symbol, Increase::Models::Transaction::Source::CheckDepositReturn::ReturnReason] Why this check was returned by the bank holding the account it was drawn against
6711
+ # @param return_reason [Symbol, Increase::Models::Transaction::Source::CheckDepositReturn::ReturnReason]
6712
+ # Why this check was returned by the bank holding the account it was drawn
6713
+ # against.
6301
6714
  #
6302
- # @param returned_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
6715
+ # @param returned_at [Time]
6716
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
6717
+ # the check deposit was returned.
6303
6718
  #
6304
- # @param transaction_id [String] The identifier of the transaction that reversed the original check deposit trans
6719
+ # @param transaction_id [String]
6720
+ # The identifier of the transaction that reversed the original check deposit
6721
+ # transaction.
6305
6722
 
6306
6723
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
6307
6724
  # transaction's currency.
@@ -6464,29 +6881,38 @@ module Increase
6464
6881
  required :type, enum: -> { Increase::Transaction::Source::CheckTransferDeposit::Type }
6465
6882
 
6466
6883
  # @!method initialize(back_image_file_id:, bank_of_first_deposit_routing_number:, deposited_at:, front_image_file_id:, inbound_check_deposit_id:, transaction_id:, transfer_id:, type:)
6467
- # Some parameter documentations has been truncated, see
6468
- # {Increase::Models::Transaction::Source::CheckTransferDeposit} for more details.
6469
- #
6470
6884
  # A Check Transfer Deposit object. This field will be present in the JSON response
6471
6885
  # if and only if `category` is equal to `check_transfer_deposit`. An Inbound Check
6472
6886
  # is a check drawn on an Increase account that has been deposited by an external
6473
6887
  # bank account. These types of checks are not pre-registered.
6474
6888
  #
6475
- # @param back_image_file_id [String, nil] The identifier of the API File object containing an image of the back of the dep
6889
+ # @param back_image_file_id [String, nil]
6890
+ # The identifier of the API File object containing an image of the back of the
6891
+ # deposited check.
6476
6892
  #
6477
- # @param bank_of_first_deposit_routing_number [String, nil] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the ban
6893
+ # @param bank_of_first_deposit_routing_number [String, nil]
6894
+ # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
6895
+ # bank depositing this check. In some rare cases, this is not transmitted via
6896
+ # Check21 and the value will be null.
6478
6897
  #
6479
6898
  # @param deposited_at [Time] When the check was deposited.
6480
6899
  #
6481
- # @param front_image_file_id [String, nil] The identifier of the API File object containing an image of the front of the de
6900
+ # @param front_image_file_id [String, nil]
6901
+ # The identifier of the API File object containing an image of the front of the
6902
+ # deposited check.
6482
6903
  #
6483
- # @param inbound_check_deposit_id [String, nil] The identifier of the Inbound Check Deposit object associated with this transact
6904
+ # @param inbound_check_deposit_id [String, nil]
6905
+ # The identifier of the Inbound Check Deposit object associated with this
6906
+ # transaction.
6484
6907
  #
6485
- # @param transaction_id [String, nil] The identifier of the Transaction object created when the check was deposited.
6908
+ # @param transaction_id [String, nil]
6909
+ # The identifier of the Transaction object created when the check was deposited.
6486
6910
  #
6487
6911
  # @param transfer_id [String, nil] The identifier of the Check Transfer object that was deposited.
6488
6912
  #
6489
- # @param type [Symbol, Increase::Models::Transaction::Source::CheckTransferDeposit::Type] A constant representing the object's type. For this resource it will always be `
6913
+ # @param type [Symbol, Increase::Models::Transaction::Source::CheckTransferDeposit::Type]
6914
+ # A constant representing the object's type. For this resource it will always be
6915
+ # `check_transfer_deposit`.
6490
6916
 
6491
6917
  # A constant representing the object's type. For this resource it will always be
6492
6918
  # `check_transfer_deposit`.
@@ -6548,16 +6974,17 @@ module Increase
6548
6974
  required :program_id, String, nil?: true
6549
6975
 
6550
6976
  # @!method initialize(amount:, currency:, fee_period_start:, program_id:)
6551
- # Some parameter documentations has been truncated, see
6552
- # {Increase::Models::Transaction::Source::FeePayment} for more details.
6553
- #
6554
6977
  # A Fee Payment object. This field will be present in the JSON response if and
6555
6978
  # only if `category` is equal to `fee_payment`. A Fee Payment represents a payment
6556
6979
  # made to Increase.
6557
6980
  #
6558
- # @param amount [Integer] The amount in the minor unit of the transaction's currency. For dollars, for exa
6981
+ # @param amount [Integer]
6982
+ # The amount in the minor unit of the transaction's currency. For dollars, for
6983
+ # example, this is cents.
6559
6984
  #
6560
- # @param currency [Symbol, Increase::Models::Transaction::Source::FeePayment::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
6985
+ # @param currency [Symbol, Increase::Models::Transaction::Source::FeePayment::Currency]
6986
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
6987
+ # currency.
6561
6988
  #
6562
6989
  # @param fee_period_start [Date] The start of this payment's fee period, usually the first day of a month.
6563
6990
  #
@@ -6653,33 +7080,41 @@ module Increase
6653
7080
  required :transfer_id, String
6654
7081
 
6655
7082
  # @!method initialize(addenda:, amount:, originator_company_descriptive_date:, originator_company_discretionary_data:, originator_company_entry_description:, originator_company_id:, originator_company_name:, receiver_id_number:, receiver_name:, trace_number:, transfer_id:)
6656
- # Some parameter documentations has been truncated, see
6657
- # {Increase::Models::Transaction::Source::InboundACHTransfer} for more details.
6658
- #
6659
7083
  # An Inbound ACH Transfer Intention object. This field will be present in the JSON
6660
7084
  # response if and only if `category` is equal to `inbound_ach_transfer`. An
6661
7085
  # Inbound ACH Transfer Intention is created when an ACH transfer is initiated at
6662
7086
  # another bank and received by Increase.
6663
7087
  #
6664
- # @param addenda [Increase::Models::Transaction::Source::InboundACHTransfer::Addenda, nil] Additional information sent from the originator.
7088
+ # @param addenda [Increase::Models::Transaction::Source::InboundACHTransfer::Addenda, nil]
7089
+ # Additional information sent from the originator.
6665
7090
  #
6666
7091
  # @param amount [Integer] The transfer amount in USD cents.
6667
7092
  #
6668
- # @param originator_company_descriptive_date [String, nil] The description of the date of the transfer, usually in the format `YYMMDD`.
7093
+ # @param originator_company_descriptive_date [String, nil]
7094
+ # The description of the date of the transfer, usually in the format `YYMMDD`.
6669
7095
  #
6670
7096
  # @param originator_company_discretionary_data [String, nil] Data set by the originator.
6671
7097
  #
6672
7098
  # @param originator_company_entry_description [String] An informational description of the transfer.
6673
7099
  #
6674
- # @param originator_company_id [String] An identifier for the originating company. This is generally, but not always, a
7100
+ # @param originator_company_id [String]
7101
+ # An identifier for the originating company. This is generally, but not always, a
7102
+ # stable identifier across multiple transfers.
6675
7103
  #
6676
7104
  # @param originator_company_name [String] A name set by the originator to identify themselves.
6677
7105
  #
6678
7106
  # @param receiver_id_number [String, nil] The originator's identifier for the transfer recipient.
6679
7107
  #
6680
- # @param receiver_name [String, nil] The name of the transfer recipient. This value is informational and not verified
7108
+ # @param receiver_name [String, nil]
7109
+ # The name of the transfer recipient. This value is informational and not verified
7110
+ # by Increase.
6681
7111
  #
6682
- # @param trace_number [String] A 15 digit number recorded in the Nacha file and available to both the originati
7112
+ # @param trace_number [String]
7113
+ # A 15 digit number recorded in the Nacha file and available to both the
7114
+ # originating and receiving bank. Along with the amount, date, and originating
7115
+ # routing number, this can be used to identify the ACH transfer at either bank.
7116
+ # ACH trace numbers are not unique, but are
7117
+ # [used to correlate returns](https://increase.com/documentation/ach-returns#ach-returns).
6683
7118
  #
6684
7119
  # @param transfer_id [String] The Inbound ACH Transfer's identifier.
6685
7120
 
@@ -6702,9 +7137,11 @@ module Increase
6702
7137
  # @!method initialize(category:, freeform:)
6703
7138
  # Additional information sent from the originator.
6704
7139
  #
6705
- # @param category [Symbol, Increase::Models::Transaction::Source::InboundACHTransfer::Addenda::Category] The type of addendum.
7140
+ # @param category [Symbol, Increase::Models::Transaction::Source::InboundACHTransfer::Addenda::Category]
7141
+ # The type of addendum.
6706
7142
  #
6707
- # @param freeform [Increase::Models::Transaction::Source::InboundACHTransfer::Addenda::Freeform, nil] Unstructured `payment_related_information` passed through by the originator.
7143
+ # @param freeform [Increase::Models::Transaction::Source::InboundACHTransfer::Addenda::Freeform, nil]
7144
+ # Unstructured `payment_related_information` passed through by the originator.
6708
7145
 
6709
7146
  # The type of addendum.
6710
7147
  #
@@ -6731,7 +7168,8 @@ module Increase
6731
7168
  # @!method initialize(entries:)
6732
7169
  # Unstructured `payment_related_information` passed through by the originator.
6733
7170
  #
6734
- # @param entries [Array<Increase::Models::Transaction::Source::InboundACHTransfer::Addenda::Freeform::Entry>] Each entry represents an addendum received from the originator.
7171
+ # @param entries [Array<Increase::Models::Transaction::Source::InboundACHTransfer::Addenda::Freeform::Entry>]
7172
+ # Each entry represents an addendum received from the originator.
6735
7173
 
6736
7174
  class Entry < Increase::Internal::Type::BaseModel
6737
7175
  # @!attribute payment_related_information
@@ -6795,7 +7233,8 @@ module Increase
6795
7233
  #
6796
7234
  # @param amount [Integer] The amount of the check adjustment.
6797
7235
  #
6798
- # @param reason [Symbol, Increase::Models::Transaction::Source::InboundCheckAdjustment::Reason] The reason for the adjustment.
7236
+ # @param reason [Symbol, Increase::Models::Transaction::Source::InboundCheckAdjustment::Reason]
7237
+ # The reason for the adjustment.
6799
7238
 
6800
7239
  # The reason for the adjustment.
6801
7240
  #
@@ -6927,21 +7366,22 @@ module Increase
6927
7366
  required :unstructured_remittance_information, String, nil?: true
6928
7367
 
6929
7368
  # @!method initialize(amount:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, transaction_identification:, transfer_id:, unstructured_remittance_information:)
6930
- # Some parameter documentations has been truncated, see
6931
- # {Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferConfirmation}
6932
- # for more details.
6933
- #
6934
7369
  # An Inbound Real-Time Payments Transfer Confirmation object. This field will be
6935
7370
  # present in the JSON response if and only if `category` is equal to
6936
7371
  # `inbound_real_time_payments_transfer_confirmation`. An Inbound Real-Time
6937
7372
  # Payments Transfer Confirmation is created when a Real-Time Payments transfer is
6938
7373
  # initiated at another bank and received by Increase.
6939
7374
  #
6940
- # @param amount [Integer] The amount in the minor unit of the transfer's currency. For dollars, for exampl
7375
+ # @param amount [Integer]
7376
+ # The amount in the minor unit of the transfer's currency. For dollars, for
7377
+ # example, this is cents.
6941
7378
  #
6942
- # @param creditor_name [String] The name the sender of the transfer specified as the recipient of the transfer.
7379
+ # @param creditor_name [String]
7380
+ # The name the sender of the transfer specified as the recipient of the transfer.
6943
7381
  #
6944
- # @param currency [Symbol, Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferConfirmation::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's cu
7382
+ # @param currency [Symbol, Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferConfirmation::Currency]
7383
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's
7384
+ # currency. This will always be "USD" for a Real-Time Payments transfer.
6945
7385
  #
6946
7386
  # @param debtor_account_number [String] The account number of the account that sent the transfer.
6947
7387
  #
@@ -6951,9 +7391,11 @@ module Increase
6951
7391
  #
6952
7392
  # @param transaction_identification [String] The Real-Time Payments network identification of the transfer.
6953
7393
  #
6954
- # @param transfer_id [String] The identifier of the Real-Time Payments Transfer that led to this Transaction.
7394
+ # @param transfer_id [String]
7395
+ # The identifier of the Real-Time Payments Transfer that led to this Transaction.
6955
7396
  #
6956
- # @param unstructured_remittance_information [String, nil] Additional information included with the transfer.
7397
+ # @param unstructured_remittance_information [String, nil]
7398
+ # Additional information included with the transfer.
6957
7399
 
6958
7400
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's
6959
7401
  # currency. This will always be "USD" for a Real-Time Payments transfer.
@@ -7061,9 +7503,6 @@ module Increase
7061
7503
  required :wire_transfer_id, String
7062
7504
 
7063
7505
  # @!method initialize(amount:, created_at:, debtor_routing_number:, description:, input_cycle_date:, input_message_accountability_data:, input_sequence_number:, input_source:, instruction_identification:, return_reason_additional_information:, return_reason_code:, return_reason_code_description:, transaction_id:, wire_transfer_id:)
7064
- # Some parameter documentations has been truncated, see
7065
- # {Increase::Models::Transaction::Source::InboundWireReversal} for more details.
7066
- #
7067
7506
  # An Inbound Wire Reversal object. This field will be present in the JSON response
7068
7507
  # if and only if `category` is equal to `inbound_wire_reversal`. An Inbound Wire
7069
7508
  # Reversal represents a reversal of a wire transfer that was initiated via
@@ -7072,13 +7511,18 @@ module Increase
7072
7511
  #
7073
7512
  # @param amount [Integer] The amount that was reversed in USD cents.
7074
7513
  #
7075
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
7514
+ # @param created_at [Time]
7515
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
7516
+ # the reversal was created.
7076
7517
  #
7077
7518
  # @param debtor_routing_number [String, nil] The debtor's routing number.
7078
7519
  #
7079
- # @param description [String] The description on the reversal message from Fedwire, set by the reversing bank.
7520
+ # @param description [String]
7521
+ # The description on the reversal message from Fedwire, set by the reversing bank.
7080
7522
  #
7081
- # @param input_cycle_date [Date] The Fedwire cycle date for the wire reversal. The "Fedwire day" begins at 9:00 P
7523
+ # @param input_cycle_date [Date]
7524
+ # The Fedwire cycle date for the wire reversal. The "Fedwire day" begins at 9:00
7525
+ # PM Eastern Time on the evening before the `cycle date`.
7082
7526
  #
7083
7527
  # @param input_message_accountability_data [String] The Fedwire transaction identifier.
7084
7528
  #
@@ -7088,11 +7532,16 @@ module Increase
7088
7532
  #
7089
7533
  # @param instruction_identification [String, nil] The sending bank's identifier for the reversal.
7090
7534
  #
7091
- # @param return_reason_additional_information [String, nil] Additional information about the reason for the reversal.
7535
+ # @param return_reason_additional_information [String, nil]
7536
+ # Additional information about the reason for the reversal.
7092
7537
  #
7093
- # @param return_reason_code [String, nil] A code provided by the sending bank giving a reason for the reversal. The common
7538
+ # @param return_reason_code [String, nil]
7539
+ # A code provided by the sending bank giving a reason for the reversal. The common
7540
+ # return reason codes are
7541
+ # [documented here](/documentation/wire-reversals#reversal-reason-codes).
7094
7542
  #
7095
- # @param return_reason_code_description [String, nil] An Increase-generated description of the `return_reason_code`.
7543
+ # @param return_reason_code_description [String, nil]
7544
+ # An Increase-generated description of the `return_reason_code`.
7096
7545
  #
7097
7546
  # @param transaction_id [String] The ID for the Transaction associated with the transfer reversal.
7098
7547
  #
@@ -7215,9 +7664,6 @@ module Increase
7215
7664
  required :unstructured_remittance_information, String, nil?: true
7216
7665
 
7217
7666
  # @!method initialize(amount:, creditor_address_line1:, creditor_address_line2:, creditor_address_line3:, creditor_name:, debtor_address_line1:, debtor_address_line2:, debtor_address_line3:, debtor_name:, description:, end_to_end_identification:, input_message_accountability_data:, instructing_agent_routing_number:, instruction_identification:, purpose:, transfer_id:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
7218
- # Some parameter documentations has been truncated, see
7219
- # {Increase::Models::Transaction::Source::InboundWireTransfer} for more details.
7220
- #
7221
7667
  # An Inbound Wire Transfer Intention object. This field will be present in the
7222
7668
  # JSON response if and only if `category` is equal to `inbound_wire_transfer`. An
7223
7669
  # Inbound Wire Transfer Intention is created when a wire transfer is initiated at
@@ -7243,11 +7689,17 @@ module Increase
7243
7689
  #
7244
7690
  # @param description [String] An Increase-constructed description of the transfer.
7245
7691
  #
7246
- # @param end_to_end_identification [String, nil] A free-form reference string set by the sender, to help identify the transfer.
7692
+ # @param end_to_end_identification [String, nil]
7693
+ # A free-form reference string set by the sender, to help identify the transfer.
7247
7694
  #
7248
- # @param input_message_accountability_data [String, nil] A unique identifier available to the originating and receiving banks, commonly a
7695
+ # @param input_message_accountability_data [String, nil]
7696
+ # A unique identifier available to the originating and receiving banks, commonly
7697
+ # abbreviated as IMAD. It is created when the wire is submitted to the Fedwire
7698
+ # service and is helpful when debugging wires with the originating bank.
7249
7699
  #
7250
- # @param instructing_agent_routing_number [String, nil] The American Banking Association (ABA) routing number of the bank that sent the
7700
+ # @param instructing_agent_routing_number [String, nil]
7701
+ # The American Banking Association (ABA) routing number of the bank that sent the
7702
+ # wire.
7251
7703
  #
7252
7704
  # @param instruction_identification [String, nil] The sending bank's identifier for the wire transfer.
7253
7705
  #
@@ -7255,7 +7707,10 @@ module Increase
7255
7707
  #
7256
7708
  # @param transfer_id [String] The ID of the Inbound Wire Transfer object that resulted in this Transaction.
7257
7709
  #
7258
- # @param unique_end_to_end_transaction_reference [String, nil] The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/paymen
7710
+ # @param unique_end_to_end_transaction_reference [String, nil]
7711
+ # The Unique End-to-end Transaction Reference
7712
+ # ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
7713
+ # of the transfer.
7259
7714
  #
7260
7715
  # @param unstructured_remittance_information [String, nil] A free-form message set by the sender.
7261
7716
  end
@@ -7313,9 +7768,6 @@ module Increase
7313
7768
  required :period_start, Time
7314
7769
 
7315
7770
  # @!method initialize(accrued_on_account_id:, amount:, currency:, period_end:, period_start:)
7316
- # Some parameter documentations has been truncated, see
7317
- # {Increase::Models::Transaction::Source::InterestPayment} for more details.
7318
- #
7319
7771
  # An Interest Payment object. This field will be present in the JSON response if
7320
7772
  # and only if `category` is equal to `interest_payment`. An Interest Payment
7321
7773
  # represents a payment of interest on an account. Interest is usually paid
@@ -7323,9 +7775,13 @@ module Increase
7323
7775
  #
7324
7776
  # @param accrued_on_account_id [String] The account on which the interest was accrued.
7325
7777
  #
7326
- # @param amount [Integer] The amount in the minor unit of the transaction's currency. For dollars, for exa
7778
+ # @param amount [Integer]
7779
+ # The amount in the minor unit of the transaction's currency. For dollars, for
7780
+ # example, this is cents.
7327
7781
  #
7328
- # @param currency [Symbol, Increase::Models::Transaction::Source::InterestPayment::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
7782
+ # @param currency [Symbol, Increase::Models::Transaction::Source::InterestPayment::Currency]
7783
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
7784
+ # currency.
7329
7785
  #
7330
7786
  # @param period_end [Time] The end of the period for which this transaction paid interest.
7331
7787
  #
@@ -7370,18 +7826,21 @@ module Increase
7370
7826
  required :reason, enum: -> { Increase::Transaction::Source::InternalSource::Reason }
7371
7827
 
7372
7828
  # @!method initialize(amount:, currency:, reason:)
7373
- # Some parameter documentations has been truncated, see
7374
- # {Increase::Models::Transaction::Source::InternalSource} for more details.
7375
- #
7376
7829
  # An Internal Source object. This field will be present in the JSON response if
7377
7830
  # and only if `category` is equal to `internal_source`. A transaction between the
7378
7831
  # user and Increase. See the `reason` attribute for more information.
7379
7832
  #
7380
- # @param amount [Integer] The amount in the minor unit of the transaction's currency. For dollars, for exa
7833
+ # @param amount [Integer]
7834
+ # The amount in the minor unit of the transaction's currency. For dollars, for
7835
+ # example, this is cents.
7381
7836
  #
7382
- # @param currency [Symbol, Increase::Models::Transaction::Source::InternalSource::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
7837
+ # @param currency [Symbol, Increase::Models::Transaction::Source::InternalSource::Currency]
7838
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
7839
+ # currency.
7383
7840
  #
7384
- # @param reason [Symbol, Increase::Models::Transaction::Source::InternalSource::Reason] An Internal Source is a transaction between you and Increase. This describes the
7841
+ # @param reason [Symbol, Increase::Models::Transaction::Source::InternalSource::Reason]
7842
+ # An Internal Source is a transaction between you and Increase. This describes the
7843
+ # reason for the transaction.
7385
7844
 
7386
7845
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
7387
7846
  # currency.
@@ -7515,9 +7974,11 @@ module Increase
7515
7974
  #
7516
7975
  # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN).
7517
7976
  #
7518
- # @param transfer_id [String] The identifier of the Real-Time Payments Transfer that led to this Transaction.
7977
+ # @param transfer_id [String]
7978
+ # The identifier of the Real-Time Payments Transfer that led to this Transaction.
7519
7979
  #
7520
- # @param unstructured_remittance_information [String] Unstructured information that will show on the recipient's bank statement.
7980
+ # @param unstructured_remittance_information [String]
7981
+ # Unstructured information that will show on the recipient's bank statement.
7521
7982
  end
7522
7983
 
7523
7984
  # @see Increase::Models::Transaction::Source#sample_funds