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
@@ -100,9 +100,6 @@ module Increase
100
100
  required :type, enum: -> { Increase::PendingTransaction::Type }
101
101
 
102
102
  # @!method initialize(id:, account_id:, amount:, completed_at:, created_at:, currency:, description:, held_amount:, route_id:, route_type:, source:, status:, type:)
103
- # Some parameter documentations has been truncated, see
104
- # {Increase::Models::PendingTransaction} for more details.
105
- #
106
103
  # Pending Transactions are potential future additions and removals of money from
107
104
  # your bank account. They impact your available balance, but not your current
108
105
  # balance. To learn more, see
@@ -112,27 +109,55 @@ module Increase
112
109
  #
113
110
  # @param account_id [String] The identifier for the account this Pending Transaction belongs to.
114
111
  #
115
- # @param amount [Integer] The Pending Transaction amount in the minor unit of its currency. For dollars, f
112
+ # @param amount [Integer]
113
+ # The Pending Transaction amount in the minor unit of its currency. For dollars,
114
+ # for example, this is cents. This amount does not change after the Pending
115
+ # Transaction is created. If a card authorization settles for a different amount,
116
+ # the settled amount is available on the resulting Transaction and on the Card
117
+ # Payment's `state.settled_amount`.
116
118
  #
117
- # @param completed_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
119
+ # @param completed_at [Time, nil]
120
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
121
+ # Transaction was completed.
118
122
  #
119
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
123
+ # @param created_at [Time]
124
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
125
+ # Transaction occurred.
120
126
  #
121
- # @param currency [Symbol, Increase::Models::PendingTransaction::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending Tran
127
+ # @param currency [Symbol, Increase::Models::PendingTransaction::Currency]
128
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending
129
+ # Transaction's currency. This will match the currency on the Pending
130
+ # Transaction's Account.
122
131
  #
123
- # @param description [String] For a Pending Transaction related to a transfer, this is the description you pro
132
+ # @param description [String]
133
+ # For a Pending Transaction related to a transfer, this is the description you
134
+ # provide. For a Pending Transaction related to a payment, this is the description
135
+ # the vendor provides.
124
136
  #
125
- # @param held_amount [Integer] The amount that this Pending Transaction decrements the available balance of its
137
+ # @param held_amount [Integer]
138
+ # The amount that this Pending Transaction decrements the available balance of its
139
+ # Account. This is usually the same as `amount`, but will differ if the amount is
140
+ # positive.
126
141
  #
127
- # @param route_id [String, nil] The identifier for the route this Pending Transaction came through. Routes are t
142
+ # @param route_id [String, nil]
143
+ # The identifier for the route this Pending Transaction came through. Routes are
144
+ # things like cards and ACH details.
128
145
  #
129
- # @param route_type [Symbol, Increase::Models::PendingTransaction::RouteType, nil] The type of the route this Pending Transaction came through.
146
+ # @param route_type [Symbol, Increase::Models::PendingTransaction::RouteType, nil]
147
+ # The type of the route this Pending Transaction came through.
130
148
  #
131
- # @param source [Increase::Models::PendingTransaction::Source] This is an object giving more details on the network-level event that caused the
149
+ # @param source [Increase::Models::PendingTransaction::Source]
150
+ # This is an object giving more details on the network-level event that caused the
151
+ # Pending Transaction. For example, for a card transaction this lists the
152
+ # merchant's industry and location.
132
153
  #
133
- # @param status [Symbol, Increase::Models::PendingTransaction::Status] Whether the Pending Transaction has been confirmed and has an associated Transac
154
+ # @param status [Symbol, Increase::Models::PendingTransaction::Status]
155
+ # Whether the Pending Transaction has been confirmed and has an associated
156
+ # Transaction.
134
157
  #
135
- # @param type [Symbol, Increase::Models::PendingTransaction::Type] A constant representing the object's type. For this resource it will always be `
158
+ # @param type [Symbol, Increase::Models::PendingTransaction::Type]
159
+ # A constant representing the object's type. For this resource it will always be
160
+ # `pending_transaction`.
136
161
 
137
162
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending
138
163
  # Transaction's currency. This will match the currency on the Pending
@@ -335,46 +360,88 @@ module Increase
335
360
  nil?: true
336
361
 
337
362
  # @!method initialize(category:, account_transfer_instruction: nil, ach_transfer_instruction: nil, blockchain_offramp_transfer: nil, blockchain_onramp_transfer_instruction: nil, card_authorization: nil, card_push_transfer_instruction: nil, check_deposit_instruction: nil, check_transfer_instruction: nil, fednow_transfer_instruction: nil, inbound_funds_hold: nil, inbound_wire_transfer_reversal: nil, other: nil, real_time_payments_transfer_instruction: nil, swift_transfer_instruction: nil, user_initiated_hold: nil, wire_transfer_instruction: nil)
338
- # Some parameter documentations has been truncated, see
339
- # {Increase::Models::PendingTransaction::Source} for more details.
340
- #
341
363
  # This is an object giving more details on the network-level event that caused the
342
364
  # Pending Transaction. For example, for a card transaction this lists the
343
365
  # merchant's industry and location.
344
366
  #
345
- # @param category [Symbol, Increase::Models::PendingTransaction::Source::Category] The type of the resource. We may add additional possible values for this enum ov
367
+ # @param category [Symbol, Increase::Models::PendingTransaction::Source::Category]
368
+ # The type of the resource. We may add additional possible values for this enum
369
+ # over time; your application should be able to handle such additions gracefully.
346
370
  #
347
- # @param account_transfer_instruction [Increase::Models::PendingTransaction::Source::AccountTransferInstruction, nil] An Account Transfer Instruction object. This field will be present in the JSON r
371
+ # @param account_transfer_instruction [Increase::Models::PendingTransaction::Source::AccountTransferInstruction, nil]
372
+ # An Account Transfer Instruction object. This field will be present in the JSON
373
+ # response if and only if `category` is equal to `account_transfer_instruction`.
348
374
  #
349
- # @param ach_transfer_instruction [Increase::Models::PendingTransaction::Source::ACHTransferInstruction, nil] An ACH Transfer Instruction object. This field will be present in the JSON respo
375
+ # @param ach_transfer_instruction [Increase::Models::PendingTransaction::Source::ACHTransferInstruction, nil]
376
+ # An ACH Transfer Instruction object. This field will be present in the JSON
377
+ # response if and only if `category` is equal to `ach_transfer_instruction`.
350
378
  #
351
- # @param blockchain_offramp_transfer [Increase::Models::PendingTransaction::Source::BlockchainOfframpTransfer, nil] A Blockchain Off-Ramp Transfer object. This field will be present in the JSON re
379
+ # @param blockchain_offramp_transfer [Increase::Models::PendingTransaction::Source::BlockchainOfframpTransfer, nil]
380
+ # A Blockchain Off-Ramp Transfer object. This field will be present in the JSON
381
+ # response if and only if `category` is equal to `blockchain_offramp_transfer`.
382
+ # Blockchain Off-Ramp Transfers move funds from a Blockchain Address to an
383
+ # Account. They're automatically created when funds land in a Blockchain Address.
352
384
  #
353
- # @param blockchain_onramp_transfer_instruction [Increase::Models::PendingTransaction::Source::BlockchainOnrampTransferInstruction, nil] A Blockchain On-Ramp Transfer Instruction object. This field will be present in
385
+ # @param blockchain_onramp_transfer_instruction [Increase::Models::PendingTransaction::Source::BlockchainOnrampTransferInstruction, nil]
386
+ # A Blockchain On-Ramp Transfer Instruction object. This field will be present in
387
+ # the JSON response if and only if `category` is equal to
388
+ # `blockchain_onramp_transfer_instruction`.
354
389
  #
355
- # @param card_authorization [Increase::Models::PendingTransaction::Source::CardAuthorization, nil] A Card Authorization object. This field will be present in the JSON response if
390
+ # @param card_authorization [Increase::Models::PendingTransaction::Source::CardAuthorization, nil]
391
+ # A Card Authorization object. This field will be present in the JSON response if
392
+ # and only if `category` is equal to `card_authorization`. Card Authorizations are
393
+ # temporary holds placed on a customer's funds with the intent to later clear a
394
+ # transaction.
356
395
  #
357
- # @param card_push_transfer_instruction [Increase::Models::PendingTransaction::Source::CardPushTransferInstruction, nil] A Card Push Transfer Instruction object. This field will be present in the JSON
396
+ # @param card_push_transfer_instruction [Increase::Models::PendingTransaction::Source::CardPushTransferInstruction, nil]
397
+ # A Card Push Transfer Instruction object. This field will be present in the JSON
398
+ # response if and only if `category` is equal to `card_push_transfer_instruction`.
358
399
  #
359
- # @param check_deposit_instruction [Increase::Models::PendingTransaction::Source::CheckDepositInstruction, nil] A Check Deposit Instruction object. This field will be present in the JSON respo
400
+ # @param check_deposit_instruction [Increase::Models::PendingTransaction::Source::CheckDepositInstruction, nil]
401
+ # A Check Deposit Instruction object. This field will be present in the JSON
402
+ # response if and only if `category` is equal to `check_deposit_instruction`.
360
403
  #
361
- # @param check_transfer_instruction [Increase::Models::PendingTransaction::Source::CheckTransferInstruction, nil] A Check Transfer Instruction object. This field will be present in the JSON resp
404
+ # @param check_transfer_instruction [Increase::Models::PendingTransaction::Source::CheckTransferInstruction, nil]
405
+ # A Check Transfer Instruction object. This field will be present in the JSON
406
+ # response if and only if `category` is equal to `check_transfer_instruction`.
362
407
  #
363
- # @param fednow_transfer_instruction [Increase::Models::PendingTransaction::Source::FednowTransferInstruction, nil] A FedNow Transfer Instruction object. This field will be present in the JSON res
408
+ # @param fednow_transfer_instruction [Increase::Models::PendingTransaction::Source::FednowTransferInstruction, nil]
409
+ # A FedNow Transfer Instruction object. This field will be present in the JSON
410
+ # response if and only if `category` is equal to `fednow_transfer_instruction`.
364
411
  #
365
- # @param inbound_funds_hold [Increase::Models::PendingTransaction::Source::InboundFundsHold, nil] An Inbound Funds Hold object. This field will be present in the JSON response if
412
+ # @param inbound_funds_hold [Increase::Models::PendingTransaction::Source::InboundFundsHold, nil]
413
+ # An Inbound Funds Hold object. This field will be present in the JSON response if
414
+ # and only if `category` is equal to `inbound_funds_hold`. We hold funds for
415
+ # certain transaction types to account for return windows where funds might still
416
+ # be clawed back by the sending institution.
366
417
  #
367
- # @param inbound_wire_transfer_reversal [Increase::Models::PendingTransaction::Source::InboundWireTransferReversal, nil] An Inbound Wire Transfer Reversal object. This field will be present in the JSON
418
+ # @param inbound_wire_transfer_reversal [Increase::Models::PendingTransaction::Source::InboundWireTransferReversal, nil]
419
+ # An Inbound Wire Transfer Reversal object. This field will be present in the JSON
420
+ # response if and only if `category` is equal to `inbound_wire_transfer_reversal`.
421
+ # An Inbound Wire Transfer Reversal is created when Increase has received a wire
422
+ # and the User requests that it be reversed.
368
423
  #
369
- # @param other [Increase::Models::PendingTransaction::Source::Other, nil] If the category of this Transaction source is equal to `other`, this field will
424
+ # @param other [Increase::Models::PendingTransaction::Source::Other, nil]
425
+ # If the category of this Transaction source is equal to `other`, this field will
426
+ # contain an empty object, otherwise it will contain null.
370
427
  #
371
- # @param real_time_payments_transfer_instruction [Increase::Models::PendingTransaction::Source::RealTimePaymentsTransferInstruction, nil] A Real-Time Payments Transfer Instruction object. This field will be present in
428
+ # @param real_time_payments_transfer_instruction [Increase::Models::PendingTransaction::Source::RealTimePaymentsTransferInstruction, nil]
429
+ # A Real-Time Payments Transfer Instruction object. This field will be present in
430
+ # the JSON response if and only if `category` is equal to
431
+ # `real_time_payments_transfer_instruction`.
372
432
  #
373
- # @param swift_transfer_instruction [Increase::Models::PendingTransaction::Source::SwiftTransferInstruction, nil] A Swift Transfer Instruction object. This field will be present in the JSON resp
433
+ # @param swift_transfer_instruction [Increase::Models::PendingTransaction::Source::SwiftTransferInstruction, nil]
434
+ # A Swift Transfer Instruction object. This field will be present in the JSON
435
+ # response if and only if `category` is equal to `swift_transfer_instruction`.
374
436
  #
375
- # @param user_initiated_hold [Hash{Symbol=>Object}, nil] An User Initiated Hold object. This field will be present in the JSON response i
437
+ # @param user_initiated_hold [Hash{Symbol=>Object}, nil]
438
+ # An User Initiated Hold object. This field will be present in the JSON response
439
+ # if and only if `category` is equal to `user_initiated_hold`. Created when a user
440
+ # initiates a hold on funds in their account.
376
441
  #
377
- # @param wire_transfer_instruction [Increase::Models::PendingTransaction::Source::WireTransferInstruction, nil] A Wire Transfer Instruction object. This field will be present in the JSON respo
442
+ # @param wire_transfer_instruction [Increase::Models::PendingTransaction::Source::WireTransferInstruction, nil]
443
+ # A Wire Transfer Instruction object. This field will be present in the JSON
444
+ # response if and only if `category` is equal to `wire_transfer_instruction`.
378
445
 
379
446
  # The type of the resource. We may add additional possible values for this enum
380
447
  # over time; your application should be able to handle such additions gracefully.
@@ -459,16 +526,16 @@ module Increase
459
526
  required :transfer_id, String
460
527
 
461
528
  # @!method initialize(amount:, currency:, transfer_id:)
462
- # Some parameter documentations has been truncated, see
463
- # {Increase::Models::PendingTransaction::Source::AccountTransferInstruction} for
464
- # more details.
465
- #
466
529
  # An Account Transfer Instruction object. This field will be present in the JSON
467
530
  # response if and only if `category` is equal to `account_transfer_instruction`.
468
531
  #
469
- # @param amount [Integer] The pending amount in the minor unit of the transaction's currency. For dollars,
532
+ # @param amount [Integer]
533
+ # The pending amount in the minor unit of the transaction's currency. For dollars,
534
+ # for example, this is cents.
470
535
  #
471
- # @param currency [Symbol, Increase::Models::PendingTransaction::Source::AccountTransferInstruction::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
536
+ # @param currency [Symbol, Increase::Models::PendingTransaction::Source::AccountTransferInstruction::Currency]
537
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
538
+ # account currency.
472
539
  #
473
540
  # @param transfer_id [String] The identifier of the Account Transfer that led to this Pending Transaction.
474
541
 
@@ -575,10 +642,6 @@ module Increase
575
642
  required :type, enum: -> { Increase::PendingTransaction::Source::BlockchainOfframpTransfer::Type }
576
643
 
577
644
  # @!method initialize(id:, token:, amount:, created_at:, destination_account_id:, initiating_transaction_hash:, source_blockchain_address_id:, status:, transaction_id:, type:)
578
- # Some parameter documentations has been truncated, see
579
- # {Increase::Models::PendingTransaction::Source::BlockchainOfframpTransfer} for
580
- # more details.
581
- #
582
645
  # A Blockchain Off-Ramp Transfer object. This field will be present in the JSON
583
646
  # response if and only if `category` is equal to `blockchain_offramp_transfer`.
584
647
  # Blockchain Off-Ramp Transfers move funds from a Blockchain Address to an
@@ -586,23 +649,30 @@ module Increase
586
649
  #
587
650
  # @param id [String] The Blockchain Off-Ramp Transfer's identifier.
588
651
  #
589
- # @param token [Symbol, Increase::Models::PendingTransaction::Source::BlockchainOfframpTransfer::Token] The token that was received.
652
+ # @param token [Symbol, Increase::Models::PendingTransaction::Source::BlockchainOfframpTransfer::Token]
653
+ # The token that was received.
590
654
  #
591
655
  # @param amount [Integer] The transfer amount in USD cents.
592
656
  #
593
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
657
+ # @param created_at [Time]
658
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
659
+ # the transfer was created.
594
660
  #
595
661
  # @param destination_account_id [String] The Account the funds were transferred into.
596
662
  #
597
- # @param initiating_transaction_hash [String] The transaction hash of the blockchain transaction that initiated this transfer.
663
+ # @param initiating_transaction_hash [String]
664
+ # The transaction hash of the blockchain transaction that initiated this transfer.
598
665
  #
599
666
  # @param source_blockchain_address_id [String] The Blockchain Address from which the transfer originated.
600
667
  #
601
- # @param status [Symbol, Increase::Models::PendingTransaction::Source::BlockchainOfframpTransfer::Status] The lifecycle status of the transfer.
668
+ # @param status [Symbol, Increase::Models::PendingTransaction::Source::BlockchainOfframpTransfer::Status]
669
+ # The lifecycle status of the transfer.
602
670
  #
603
671
  # @param transaction_id [String, nil] The Transaction crediting the Account once the transfer is settled.
604
672
  #
605
- # @param type [Symbol, Increase::Models::PendingTransaction::Source::BlockchainOfframpTransfer::Type] A constant representing the object's type. For this resource it will always be `
673
+ # @param type [Symbol, Increase::Models::PendingTransaction::Source::BlockchainOfframpTransfer::Type]
674
+ # A constant representing the object's type. For this resource it will always be
675
+ # `blockchain_offramp_transfer`.
606
676
 
607
677
  # The token that was received.
608
678
  #
@@ -669,10 +739,6 @@ module Increase
669
739
  required :transfer_id, String
670
740
 
671
741
  # @!method initialize(amount:, destination_blockchain_address:, transfer_id:)
672
- # Some parameter documentations has been truncated, see
673
- # {Increase::Models::PendingTransaction::Source::BlockchainOnrampTransferInstruction}
674
- # for more details.
675
- #
676
742
  # A Blockchain On-Ramp Transfer Instruction object. This field will be present in
677
743
  # the JSON response if and only if `category` is equal to
678
744
  # `blockchain_onramp_transfer_instruction`.
@@ -681,7 +747,9 @@ module Increase
681
747
  #
682
748
  # @param destination_blockchain_address [String] The blockchain address the funds are being sent to.
683
749
  #
684
- # @param transfer_id [String] The identifier of the Blockchain On-Ramp Transfer that led to this Pending Trans
750
+ # @param transfer_id [String]
751
+ # The identifier of the Blockchain On-Ramp Transfer that led to this Pending
752
+ # Transaction.
685
753
  end
686
754
 
687
755
  # @see Increase::Models::PendingTransaction::Source#card_authorization
@@ -893,10 +961,6 @@ module Increase
893
961
  required :verification, -> { Increase::PendingTransaction::Source::CardAuthorization::Verification }
894
962
 
895
963
  # @!method initialize(id:, actioner:, additional_amounts:, amount:, card_payment_id:, currency:, digital_wallet_token_id:, direction:, expires_at:, healthcare:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, pending_transaction_id:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, scheme_fees:, terminal_id:, type:, verification:)
896
- # Some parameter documentations has been truncated, see
897
- # {Increase::Models::PendingTransaction::Source::CardAuthorization} for more
898
- # details.
899
- #
900
964
  # A Card Authorization object. This field will be present in the JSON response if
901
965
  # and only if `category` is equal to `card_authorization`. Card Authorizations are
902
966
  # temporary holds placed on a customer's funds with the intent to later clear a
@@ -904,27 +968,48 @@ module Increase
904
968
  #
905
969
  # @param id [String] The Card Authorization identifier.
906
970
  #
907
- # @param actioner [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Actioner] Whether this authorization was approved by Increase, the card network through st
971
+ # @param actioner [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Actioner]
972
+ # Whether this authorization was approved by Increase, the card network through
973
+ # stand-in processing, or the user through a real-time decision.
908
974
  #
909
- # @param additional_amounts [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts] Additional amounts associated with the card authorization, such as ATM surcharge
975
+ # @param additional_amounts [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts]
976
+ # Additional amounts associated with the card authorization, such as ATM
977
+ # surcharges fees. These are usually a subset of the `amount` field and are used
978
+ # to provide more detailed information about the transaction.
910
979
  #
911
- # @param amount [Integer] The pending amount in the minor unit of the transaction's currency. For dollars,
980
+ # @param amount [Integer]
981
+ # The pending amount in the minor unit of the transaction's currency. For dollars,
982
+ # for example, this is cents.
912
983
  #
913
984
  # @param card_payment_id [String] The ID of the Card Payment this transaction belongs to.
914
985
  #
915
- # @param currency [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction'
986
+ # @param currency [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Currency]
987
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
988
+ # transaction's currency.
916
989
  #
917
- # @param digital_wallet_token_id [String, nil] If the authorization was made via a Digital Wallet Token (such as an Apple Pay p
990
+ # @param digital_wallet_token_id [String, nil]
991
+ # If the authorization was made via a Digital Wallet Token (such as an Apple Pay
992
+ # purchase), the identifier of the token that was used.
918
993
  #
919
- # @param direction [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Direction] The direction describes the direction the funds will move, either from the cardh
994
+ # @param direction [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Direction]
995
+ # The direction describes the direction the funds will move, either from the
996
+ # cardholder to the merchant or from the merchant to the cardholder.
920
997
  #
921
- # @param expires_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization w
998
+ # @param expires_at [Time]
999
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization
1000
+ # will expire and the pending transaction will be released.
922
1001
  #
923
- # @param healthcare [Increase::Models::PendingTransaction::Source::CardAuthorization::Healthcare, nil] The healthcare-related fields for this authorization. Only present for specific
1002
+ # @param healthcare [Increase::Models::PendingTransaction::Source::CardAuthorization::Healthcare, nil]
1003
+ # The healthcare-related fields for this authorization. Only present for specific
1004
+ # programs.
924
1005
  #
925
- # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i
1006
+ # @param merchant_acceptor_id [String]
1007
+ # The merchant identifier (commonly abbreviated as MID) of the merchant the card
1008
+ # is transacting with.
926
1009
  #
927
- # @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car
1010
+ # @param merchant_category_code [String]
1011
+ # The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
1012
+ # card is transacting with.
928
1013
  #
929
1014
  # @param merchant_city [String, nil] The city the merchant resides in.
930
1015
  #
@@ -932,35 +1017,58 @@ module Increase
932
1017
  #
933
1018
  # @param merchant_descriptor [String] The merchant descriptor of the merchant the card is transacting with.
934
1019
  #
935
- # @param merchant_postal_code [String, nil] The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
1020
+ # @param merchant_postal_code [String, nil]
1021
+ # The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
1022
+ # ZIP code, where the first 5 and last 4 are separated by a dash.
936
1023
  #
937
1024
  # @param merchant_state [String, nil] The state the merchant resides in.
938
1025
  #
939
- # @param network_details [Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails] Fields specific to the `network`.
1026
+ # @param network_details [Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails]
1027
+ # Fields specific to the `network`.
940
1028
  #
941
- # @param network_identifiers [Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkIdentifiers] Network-specific identifiers for a specific request or transaction.
1029
+ # @param network_identifiers [Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkIdentifiers]
1030
+ # Network-specific identifiers for a specific request or transaction.
942
1031
  #
943
- # @param network_risk_score [Integer, nil] The risk score generated by the card network. For Visa this is the Visa Advanced
1032
+ # @param network_risk_score [Integer, nil]
1033
+ # The risk score generated by the card network. For Visa this is the Visa Advanced
1034
+ # Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
1035
+ # score is from 0 to 999, where 999 is the riskiest.
944
1036
  #
945
- # @param pending_transaction_id [String, nil] The identifier of the Pending Transaction associated with this Transaction.
1037
+ # @param pending_transaction_id [String, nil]
1038
+ # The identifier of the Pending Transaction associated with this Transaction.
946
1039
  #
947
- # @param physical_card_id [String, nil] If the authorization was made in-person with a physical card, the Physical Card
1040
+ # @param physical_card_id [String, nil]
1041
+ # If the authorization was made in-person with a physical card, the Physical Card
1042
+ # that was used.
948
1043
  #
949
- # @param presentment_amount [Integer] The pending amount in the minor unit of the transaction's presentment currency.
1044
+ # @param presentment_amount [Integer]
1045
+ # The pending amount in the minor unit of the transaction's presentment currency.
950
1046
  #
951
- # @param presentment_currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction'
1047
+ # @param presentment_currency [String]
1048
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
1049
+ # transaction's presentment currency.
952
1050
  #
953
- # @param processing_category [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::ProcessingCategory] The processing category describes the intent behind the authorization, such as w
1051
+ # @param processing_category [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::ProcessingCategory]
1052
+ # The processing category describes the intent behind the authorization, such as
1053
+ # whether it was used for bill payments or an automatic fuel dispenser.
954
1054
  #
955
- # @param real_time_decision_id [String, nil] The identifier of the Real-Time Decision sent to approve or decline this transac
1055
+ # @param real_time_decision_id [String, nil]
1056
+ # The identifier of the Real-Time Decision sent to approve or decline this
1057
+ # transaction.
956
1058
  #
957
- # @param scheme_fees [Array<Increase::Models::PendingTransaction::Source::CardAuthorization::SchemeFee>] The scheme fees associated with this card authorization.
1059
+ # @param scheme_fees [Array<Increase::Models::PendingTransaction::Source::CardAuthorization::SchemeFee>]
1060
+ # The scheme fees associated with this card authorization.
958
1061
  #
959
- # @param terminal_id [String, nil] The terminal identifier (commonly abbreviated as TID) of the terminal the card i
1062
+ # @param terminal_id [String, nil]
1063
+ # The terminal identifier (commonly abbreviated as TID) of the terminal the card
1064
+ # is transacting with.
960
1065
  #
961
- # @param type [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Type] A constant representing the object's type. For this resource it will always be `
1066
+ # @param type [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Type]
1067
+ # A constant representing the object's type. For this resource it will always be
1068
+ # `card_authorization`.
962
1069
  #
963
- # @param verification [Increase::Models::PendingTransaction::Source::CardAuthorization::Verification] Fields related to verification of cardholder-provided values.
1070
+ # @param verification [Increase::Models::PendingTransaction::Source::CardAuthorization::Verification]
1071
+ # Fields related to verification of cardholder-provided values.
964
1072
 
965
1073
  # Whether this authorization was approved by Increase, the card network through
966
1074
  # stand-in processing, or the user through a real-time decision.
@@ -1085,33 +1193,39 @@ module Increase
1085
1193
  nil?: true
1086
1194
 
1087
1195
  # @!method initialize(clinic:, dental:, original:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
1088
- # Some parameter documentations has been truncated, see
1089
- # {Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts}
1090
- # for more details.
1091
- #
1092
1196
  # Additional amounts associated with the card authorization, such as ATM
1093
1197
  # surcharges fees. These are usually a subset of the `amount` field and are used
1094
1198
  # to provide more detailed information about the transaction.
1095
1199
  #
1096
- # @param clinic [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Clinic, nil] The part of this transaction amount that was for clinic-related services.
1200
+ # @param clinic [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Clinic, nil]
1201
+ # The part of this transaction amount that was for clinic-related services.
1097
1202
  #
1098
- # @param dental [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Dental, nil] The part of this transaction amount that was for dental-related services.
1203
+ # @param dental [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Dental, nil]
1204
+ # The part of this transaction amount that was for dental-related services.
1099
1205
  #
1100
- # @param original [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Original, nil] The original pre-authorized amount.
1206
+ # @param original [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Original, nil]
1207
+ # The original pre-authorized amount.
1101
1208
  #
1102
- # @param prescription [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Prescription, nil] The part of this transaction amount that was for healthcare prescriptions.
1209
+ # @param prescription [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Prescription, nil]
1210
+ # The part of this transaction amount that was for healthcare prescriptions.
1103
1211
  #
1104
- # @param surcharge [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Surcharge, nil] The surcharge amount charged for this transaction by the merchant.
1212
+ # @param surcharge [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Surcharge, nil]
1213
+ # The surcharge amount charged for this transaction by the merchant.
1105
1214
  #
1106
- # @param total_cumulative [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::TotalCumulative, nil] The total amount of a series of incremental authorizations, optionally provided.
1215
+ # @param total_cumulative [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::TotalCumulative, nil]
1216
+ # The total amount of a series of incremental authorizations, optionally provided.
1107
1217
  #
1108
- # @param total_healthcare [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::TotalHealthcare, nil] The total amount of healthcare-related additional amounts.
1218
+ # @param total_healthcare [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::TotalHealthcare, nil]
1219
+ # The total amount of healthcare-related additional amounts.
1109
1220
  #
1110
- # @param transit [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Transit, nil] The part of this transaction amount that was for transit-related services.
1221
+ # @param transit [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Transit, nil]
1222
+ # The part of this transaction amount that was for transit-related services.
1111
1223
  #
1112
- # @param unknown [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Unknown, nil] An unknown additional amount.
1224
+ # @param unknown [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Unknown, nil]
1225
+ # An unknown additional amount.
1113
1226
  #
1114
- # @param vision [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Vision, nil] The part of this transaction amount that was for vision-related services.
1227
+ # @param vision [Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Vision, nil]
1228
+ # The part of this transaction amount that was for vision-related services.
1115
1229
 
1116
1230
  # @see Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts#clinic
1117
1231
  class Clinic < Increase::Internal::Type::BaseModel
@@ -1131,15 +1245,16 @@ module Increase
1131
1245
  required :currency, String
1132
1246
 
1133
1247
  # @!method initialize(amount:, currency:)
1134
- # Some parameter documentations has been truncated, see
1135
- # {Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Clinic}
1136
- # for more details.
1137
- #
1138
1248
  # The part of this transaction amount that was for clinic-related services.
1139
1249
  #
1140
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1250
+ # @param amount [Integer]
1251
+ # The amount in minor units of the `currency` field. The amount is positive if it
1252
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1253
+ # subtracted from the amount (such as a discount).
1141
1254
  #
1142
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1255
+ # @param currency [String]
1256
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1257
+ # amount's currency.
1143
1258
  end
1144
1259
 
1145
1260
  # @see Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts#dental
@@ -1160,15 +1275,16 @@ module Increase
1160
1275
  required :currency, String
1161
1276
 
1162
1277
  # @!method initialize(amount:, currency:)
1163
- # Some parameter documentations has been truncated, see
1164
- # {Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Dental}
1165
- # for more details.
1166
- #
1167
1278
  # The part of this transaction amount that was for dental-related services.
1168
1279
  #
1169
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1280
+ # @param amount [Integer]
1281
+ # The amount in minor units of the `currency` field. The amount is positive if it
1282
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1283
+ # subtracted from the amount (such as a discount).
1170
1284
  #
1171
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1285
+ # @param currency [String]
1286
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1287
+ # amount's currency.
1172
1288
  end
1173
1289
 
1174
1290
  # @see Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts#original
@@ -1189,15 +1305,16 @@ module Increase
1189
1305
  required :currency, String
1190
1306
 
1191
1307
  # @!method initialize(amount:, currency:)
1192
- # Some parameter documentations has been truncated, see
1193
- # {Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Original}
1194
- # for more details.
1195
- #
1196
1308
  # The original pre-authorized amount.
1197
1309
  #
1198
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1310
+ # @param amount [Integer]
1311
+ # The amount in minor units of the `currency` field. The amount is positive if it
1312
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1313
+ # subtracted from the amount (such as a discount).
1199
1314
  #
1200
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1315
+ # @param currency [String]
1316
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1317
+ # amount's currency.
1201
1318
  end
1202
1319
 
1203
1320
  # @see Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts#prescription
@@ -1218,15 +1335,16 @@ module Increase
1218
1335
  required :currency, String
1219
1336
 
1220
1337
  # @!method initialize(amount:, currency:)
1221
- # Some parameter documentations has been truncated, see
1222
- # {Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Prescription}
1223
- # for more details.
1224
- #
1225
1338
  # The part of this transaction amount that was for healthcare prescriptions.
1226
1339
  #
1227
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1340
+ # @param amount [Integer]
1341
+ # The amount in minor units of the `currency` field. The amount is positive if it
1342
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1343
+ # subtracted from the amount (such as a discount).
1228
1344
  #
1229
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1345
+ # @param currency [String]
1346
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1347
+ # amount's currency.
1230
1348
  end
1231
1349
 
1232
1350
  # @see Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts#surcharge
@@ -1247,15 +1365,16 @@ module Increase
1247
1365
  required :currency, String
1248
1366
 
1249
1367
  # @!method initialize(amount:, currency:)
1250
- # Some parameter documentations has been truncated, see
1251
- # {Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Surcharge}
1252
- # for more details.
1253
- #
1254
1368
  # The surcharge amount charged for this transaction by the merchant.
1255
1369
  #
1256
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1370
+ # @param amount [Integer]
1371
+ # The amount in minor units of the `currency` field. The amount is positive if it
1372
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1373
+ # subtracted from the amount (such as a discount).
1257
1374
  #
1258
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1375
+ # @param currency [String]
1376
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1377
+ # amount's currency.
1259
1378
  end
1260
1379
 
1261
1380
  # @see Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts#total_cumulative
@@ -1276,15 +1395,16 @@ module Increase
1276
1395
  required :currency, String
1277
1396
 
1278
1397
  # @!method initialize(amount:, currency:)
1279
- # Some parameter documentations has been truncated, see
1280
- # {Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::TotalCumulative}
1281
- # for more details.
1282
- #
1283
1398
  # The total amount of a series of incremental authorizations, optionally provided.
1284
1399
  #
1285
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1400
+ # @param amount [Integer]
1401
+ # The amount in minor units of the `currency` field. The amount is positive if it
1402
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1403
+ # subtracted from the amount (such as a discount).
1286
1404
  #
1287
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1405
+ # @param currency [String]
1406
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1407
+ # amount's currency.
1288
1408
  end
1289
1409
 
1290
1410
  # @see Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts#total_healthcare
@@ -1305,15 +1425,16 @@ module Increase
1305
1425
  required :currency, String
1306
1426
 
1307
1427
  # @!method initialize(amount:, currency:)
1308
- # Some parameter documentations has been truncated, see
1309
- # {Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::TotalHealthcare}
1310
- # for more details.
1311
- #
1312
1428
  # The total amount of healthcare-related additional amounts.
1313
1429
  #
1314
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1430
+ # @param amount [Integer]
1431
+ # The amount in minor units of the `currency` field. The amount is positive if it
1432
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1433
+ # subtracted from the amount (such as a discount).
1315
1434
  #
1316
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1435
+ # @param currency [String]
1436
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1437
+ # amount's currency.
1317
1438
  end
1318
1439
 
1319
1440
  # @see Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts#transit
@@ -1334,15 +1455,16 @@ module Increase
1334
1455
  required :currency, String
1335
1456
 
1336
1457
  # @!method initialize(amount:, currency:)
1337
- # Some parameter documentations has been truncated, see
1338
- # {Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Transit}
1339
- # for more details.
1340
- #
1341
1458
  # The part of this transaction amount that was for transit-related services.
1342
1459
  #
1343
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1460
+ # @param amount [Integer]
1461
+ # The amount in minor units of the `currency` field. The amount is positive if it
1462
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1463
+ # subtracted from the amount (such as a discount).
1344
1464
  #
1345
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1465
+ # @param currency [String]
1466
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1467
+ # amount's currency.
1346
1468
  end
1347
1469
 
1348
1470
  # @see Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts#unknown
@@ -1363,15 +1485,16 @@ module Increase
1363
1485
  required :currency, String
1364
1486
 
1365
1487
  # @!method initialize(amount:, currency:)
1366
- # Some parameter documentations has been truncated, see
1367
- # {Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Unknown}
1368
- # for more details.
1369
- #
1370
1488
  # An unknown additional amount.
1371
1489
  #
1372
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1490
+ # @param amount [Integer]
1491
+ # The amount in minor units of the `currency` field. The amount is positive if it
1492
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1493
+ # subtracted from the amount (such as a discount).
1373
1494
  #
1374
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1495
+ # @param currency [String]
1496
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1497
+ # amount's currency.
1375
1498
  end
1376
1499
 
1377
1500
  # @see Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts#vision
@@ -1392,15 +1515,16 @@ module Increase
1392
1515
  required :currency, String
1393
1516
 
1394
1517
  # @!method initialize(amount:, currency:)
1395
- # Some parameter documentations has been truncated, see
1396
- # {Increase::Models::PendingTransaction::Source::CardAuthorization::AdditionalAmounts::Vision}
1397
- # for more details.
1398
- #
1399
1518
  # The part of this transaction amount that was for vision-related services.
1400
1519
  #
1401
- # @param amount [Integer] The amount in minor units of the `currency` field. The amount is positive if it
1520
+ # @param amount [Integer]
1521
+ # The amount in minor units of the `currency` field. The amount is positive if it
1522
+ # is added to the amount (such as an ATM surcharge fee) and negative if it is
1523
+ # subtracted from the amount (such as a discount).
1402
1524
  #
1403
- # @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional a
1525
+ # @param currency [String]
1526
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
1527
+ # amount's currency.
1404
1528
  end
1405
1529
  end
1406
1530
 
@@ -1448,14 +1572,14 @@ module Increase
1448
1572
  enum: -> { Increase::PendingTransaction::Source::CardAuthorization::Healthcare::MerchantNinetyPercentEligibility }
1449
1573
 
1450
1574
  # @!method initialize(merchant_ninety_percent_eligibility:)
1451
- # Some parameter documentations has been truncated, see
1452
- # {Increase::Models::PendingTransaction::Source::CardAuthorization::Healthcare}
1453
- # for more details.
1454
- #
1455
1575
  # The healthcare-related fields for this authorization. Only present for specific
1456
1576
  # programs.
1457
1577
  #
1458
- # @param merchant_ninety_percent_eligibility [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Healthcare::MerchantNinetyPercentEligibility] The merchant's eligibility under the Internal Revenue Service's 90% Rule for Fle
1578
+ # @param merchant_ninety_percent_eligibility [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Healthcare::MerchantNinetyPercentEligibility]
1579
+ # The merchant's eligibility under the Internal Revenue Service's 90% Rule for
1580
+ # Flexible Spending Account (FSA) and Health Savings Account (HSA) eligible
1581
+ # products. The eligibility is determined based on the list of merchants
1582
+ # maintained by the Special Interest Group for IIAS Standards (SIGIS).
1459
1583
 
1460
1584
  # The merchant's eligibility under the Internal Revenue Service's 90% Rule for
1461
1585
  # Flexible Spending Account (FSA) and Health Savings Account (HSA) eligible
@@ -1505,11 +1629,14 @@ module Increase
1505
1629
  # @!method initialize(category:, pulse:, visa:)
1506
1630
  # Fields specific to the `network`.
1507
1631
  #
1508
- # @param category [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Category] The payment network used to process this card authorization.
1632
+ # @param category [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Category]
1633
+ # The payment network used to process this card authorization.
1509
1634
  #
1510
- # @param pulse [Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Pulse, nil] Fields specific to the `pulse` network.
1635
+ # @param pulse [Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Pulse, nil]
1636
+ # Fields specific to the `pulse` network.
1511
1637
  #
1512
- # @param visa [Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa, nil] Fields specific to the `visa` network.
1638
+ # @param visa [Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa, nil]
1639
+ # Fields specific to the `visa` network.
1513
1640
 
1514
1641
  # The payment network used to process this card authorization.
1515
1642
  #
@@ -1584,19 +1711,27 @@ module Increase
1584
1711
  nil?: true
1585
1712
 
1586
1713
  # @!method initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:, terminal_entry_capability:)
1587
- # Some parameter documentations has been truncated, see
1588
- # {Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa}
1589
- # for more details.
1590
- #
1591
1714
  # Fields specific to the `visa` network.
1592
1715
  #
1593
- # @param electronic_commerce_indicator [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::ElectronicCommerceIndicator, nil] For electronic commerce transactions, this identifies the level of security used
1716
+ # @param electronic_commerce_indicator [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::ElectronicCommerceIndicator, nil]
1717
+ # For electronic commerce transactions, this identifies the level of security used
1718
+ # in obtaining the customer's payment credential. For mail or telephone order
1719
+ # transactions, identifies the type of mail or telephone order.
1594
1720
  #
1595
- # @param point_of_service_entry_mode [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::PointOfServiceEntryMode, nil] The method used to enter the cardholder's primary account number and card expira
1721
+ # @param point_of_service_entry_mode [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::PointOfServiceEntryMode, nil]
1722
+ # The method used to enter the cardholder's primary account number and card
1723
+ # expiration date.
1596
1724
  #
1597
- # @param stand_in_processing_reason [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason, nil] Only present when `actioner: network`. Describes why a card authorization was ap
1725
+ # @param stand_in_processing_reason [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::StandInProcessingReason, nil]
1726
+ # Only present when `actioner: network`. Describes why a card authorization was
1727
+ # approved or declined by Visa through stand-in processing.
1598
1728
  #
1599
- # @param terminal_entry_capability [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::TerminalEntryCapability, nil] The capability of the terminal being used to read the card. Shows whether a term
1729
+ # @param terminal_entry_capability [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkDetails::Visa::TerminalEntryCapability, nil]
1730
+ # The capability of the terminal being used to read the card. Shows whether a
1731
+ # terminal can e.g., accept chip cards or if it only supports magnetic stripe
1732
+ # reads. This reflects the highest capability of the terminal — for example, a
1733
+ # terminal that supports both chip and magnetic stripe will be identified as
1734
+ # chip-capable.
1600
1735
 
1601
1736
  # For electronic commerce transactions, this identifies the level of security used
1602
1737
  # in obtaining the customer's payment credential. For mail or telephone order
@@ -1785,19 +1920,24 @@ module Increase
1785
1920
  required :transaction_id, String, nil?: true
1786
1921
 
1787
1922
  # @!method initialize(authorization_identification_response:, retrieval_reference_number:, trace_number:, transaction_id:)
1788
- # Some parameter documentations has been truncated, see
1789
- # {Increase::Models::PendingTransaction::Source::CardAuthorization::NetworkIdentifiers}
1790
- # for more details.
1791
- #
1792
1923
  # Network-specific identifiers for a specific request or transaction.
1793
1924
  #
1794
- # @param authorization_identification_response [String, nil] The randomly generated 6-character Authorization Identification Response code se
1925
+ # @param authorization_identification_response [String, nil]
1926
+ # The randomly generated 6-character Authorization Identification Response code
1927
+ # sent back to the acquirer in an approved response.
1795
1928
  #
1796
- # @param retrieval_reference_number [String, nil] A life-cycle identifier used across e.g., an authorization and a reversal. Expec
1929
+ # @param retrieval_reference_number [String, nil]
1930
+ # A life-cycle identifier used across e.g., an authorization and a reversal.
1931
+ # Expected to be unique per acquirer within a window of time. For some card
1932
+ # networks the retrieval reference number includes the trace counter.
1797
1933
  #
1798
- # @param trace_number [String, nil] A counter used to verify an individual authorization. Expected to be unique per
1934
+ # @param trace_number [String, nil]
1935
+ # A counter used to verify an individual authorization. Expected to be unique per
1936
+ # acquirer within a window of time.
1799
1937
  #
1800
- # @param transaction_id [String, nil] A globally unique transaction identifier provided by the card network, used acro
1938
+ # @param transaction_id [String, nil]
1939
+ # A globally unique transaction identifier provided by the card network, used
1940
+ # across multiple life-cycle requests.
1801
1941
  end
1802
1942
 
1803
1943
  # The processing category describes the intent behind the authorization, such as
@@ -1888,21 +2028,26 @@ module Increase
1888
2028
  required :variable_rate, String, nil?: true
1889
2029
 
1890
2030
  # @!method initialize(amount:, created_at:, currency:, fee_type:, fixed_component:, variable_rate:)
1891
- # Some parameter documentations has been truncated, see
1892
- # {Increase::Models::PendingTransaction::Source::CardAuthorization::SchemeFee} for
1893
- # more details.
1894
- #
1895
2031
  # @param amount [String] The fee amount given as a string containing a decimal number.
1896
2032
  #
1897
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was
2033
+ # @param created_at [Time]
2034
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was
2035
+ # created.
1898
2036
  #
1899
- # @param currency [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::SchemeFee::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimburs
2037
+ # @param currency [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::SchemeFee::Currency]
2038
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
2039
+ # reimbursement.
1900
2040
  #
1901
- # @param fee_type [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType] The type of fee being assessed.
2041
+ # @param fee_type [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType]
2042
+ # The type of fee being assessed.
1902
2043
  #
1903
- # @param fixed_component [String, nil] The fixed component of the fee, if applicable, given in major units of the fee a
2044
+ # @param fixed_component [String, nil]
2045
+ # The fixed component of the fee, if applicable, given in major units of the fee
2046
+ # amount.
1904
2047
  #
1905
- # @param variable_rate [String, nil] The variable rate component of the fee, if applicable, given as a decimal (e.g.,
2048
+ # @param variable_rate [String, nil]
2049
+ # The variable rate component of the fee, if applicable, given as a decimal (e.g.,
2050
+ # 0.015 for 1.5%).
1906
2051
 
1907
2052
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
1908
2053
  # reimbursement.
@@ -2061,17 +2206,18 @@ module Increase
2061
2206
  nil?: true
2062
2207
 
2063
2208
  # @!method initialize(card_verification_code:, cardholder_address:, cardholder_name:)
2064
- # Some parameter documentations has been truncated, see
2065
- # {Increase::Models::PendingTransaction::Source::CardAuthorization::Verification}
2066
- # for more details.
2067
- #
2068
2209
  # Fields related to verification of cardholder-provided values.
2069
2210
  #
2070
- # @param card_verification_code [Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardVerificationCode] Fields related to verification of the Card Verification Code, a 3-digit code on
2211
+ # @param card_verification_code [Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardVerificationCode]
2212
+ # Fields related to verification of the Card Verification Code, a 3-digit code on
2213
+ # the back of the card.
2071
2214
  #
2072
- # @param cardholder_address [Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress] Cardholder address provided in the authorization request and the address on file
2215
+ # @param cardholder_address [Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress]
2216
+ # Cardholder address provided in the authorization request and the address on file
2217
+ # we verified it against.
2073
2218
  #
2074
- # @param cardholder_name [Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardholderName, nil] Cardholder name provided in the authorization request.
2219
+ # @param cardholder_name [Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardholderName, nil]
2220
+ # Cardholder name provided in the authorization request.
2075
2221
 
2076
2222
  # @see Increase::Models::PendingTransaction::Source::CardAuthorization::Verification#card_verification_code
2077
2223
  class CardVerificationCode < Increase::Internal::Type::BaseModel
@@ -2086,7 +2232,8 @@ module Increase
2086
2232
  # Fields related to verification of the Card Verification Code, a 3-digit code on
2087
2233
  # the back of the card.
2088
2234
  #
2089
- # @param result [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardVerificationCode::Result] The result of verifying the Card Verification Code.
2235
+ # @param result [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardVerificationCode::Result]
2236
+ # The result of verifying the Card Verification Code.
2090
2237
 
2091
2238
  # The result of verifying the Card Verification Code.
2092
2239
  #
@@ -2143,10 +2290,6 @@ module Increase
2143
2290
  enum: -> { Increase::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress::Result }
2144
2291
 
2145
2292
  # @!method initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:)
2146
- # Some parameter documentations has been truncated, see
2147
- # {Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress}
2148
- # for more details.
2149
- #
2150
2293
  # Cardholder address provided in the authorization request and the address on file
2151
2294
  # we verified it against.
2152
2295
  #
@@ -2154,11 +2297,15 @@ module Increase
2154
2297
  #
2155
2298
  # @param actual_postal_code [String, nil] The postal code of the address on file for the cardholder.
2156
2299
  #
2157
- # @param provided_line1 [String, nil] The cardholder address line 1 provided for verification in the authorization req
2300
+ # @param provided_line1 [String, nil]
2301
+ # The cardholder address line 1 provided for verification in the authorization
2302
+ # request.
2158
2303
  #
2159
- # @param provided_postal_code [String, nil] The postal code provided for verification in the authorization request.
2304
+ # @param provided_postal_code [String, nil]
2305
+ # The postal code provided for verification in the authorization request.
2160
2306
  #
2161
- # @param result [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress::Result] The address verification result returned to the card network.
2307
+ # @param result [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Verification::CardholderAddress::Result]
2308
+ # The address verification result returned to the card network.
2162
2309
 
2163
2310
  # The address verification result returned to the card network.
2164
2311
  #
@@ -2212,11 +2359,14 @@ module Increase
2212
2359
  # @!method initialize(provided_first_name:, provided_last_name:, provided_middle_name:)
2213
2360
  # Cardholder name provided in the authorization request.
2214
2361
  #
2215
- # @param provided_first_name [String, nil] The first name provided for verification in the authorization request.
2362
+ # @param provided_first_name [String, nil]
2363
+ # The first name provided for verification in the authorization request.
2216
2364
  #
2217
- # @param provided_last_name [String, nil] The last name provided for verification in the authorization request.
2365
+ # @param provided_last_name [String, nil]
2366
+ # The last name provided for verification in the authorization request.
2218
2367
  #
2219
- # @param provided_middle_name [String, nil] The middle name provided for verification in the authorization request.
2368
+ # @param provided_middle_name [String, nil]
2369
+ # The middle name provided for verification in the authorization request.
2220
2370
  end
2221
2371
  end
2222
2372
  end
@@ -2280,22 +2430,24 @@ module Increase
2280
2430
  required :front_image_file_id, String
2281
2431
 
2282
2432
  # @!method initialize(amount:, back_image_file_id:, check_deposit_id:, currency:, front_image_file_id:)
2283
- # Some parameter documentations has been truncated, see
2284
- # {Increase::Models::PendingTransaction::Source::CheckDepositInstruction} for more
2285
- # details.
2286
- #
2287
2433
  # A Check Deposit Instruction object. This field will be present in the JSON
2288
2434
  # response if and only if `category` is equal to `check_deposit_instruction`.
2289
2435
  #
2290
2436
  # @param amount [Integer] The pending amount in USD cents.
2291
2437
  #
2292
- # @param back_image_file_id [String, nil] The identifier of the File containing the image of the back of the check that wa
2438
+ # @param back_image_file_id [String, nil]
2439
+ # The identifier of the File containing the image of the back of the check that
2440
+ # was deposited.
2293
2441
  #
2294
2442
  # @param check_deposit_id [String, nil] The identifier of the Check Deposit.
2295
2443
  #
2296
- # @param currency [Symbol, Increase::Models::PendingTransaction::Source::CheckDepositInstruction::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction'
2444
+ # @param currency [Symbol, Increase::Models::PendingTransaction::Source::CheckDepositInstruction::Currency]
2445
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
2446
+ # transaction's currency.
2297
2447
  #
2298
- # @param front_image_file_id [String] The identifier of the File containing the image of the front of the check that w
2448
+ # @param front_image_file_id [String]
2449
+ # The identifier of the File containing the image of the front of the check that
2450
+ # was deposited.
2299
2451
 
2300
2452
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
2301
2453
  # transaction's currency.
@@ -2334,16 +2486,14 @@ module Increase
2334
2486
  required :transfer_id, String
2335
2487
 
2336
2488
  # @!method initialize(amount:, currency:, transfer_id:)
2337
- # Some parameter documentations has been truncated, see
2338
- # {Increase::Models::PendingTransaction::Source::CheckTransferInstruction} for
2339
- # more details.
2340
- #
2341
2489
  # A Check Transfer Instruction object. This field will be present in the JSON
2342
2490
  # response if and only if `category` is equal to `check_transfer_instruction`.
2343
2491
  #
2344
2492
  # @param amount [Integer] The transfer amount in USD cents.
2345
2493
  #
2346
- # @param currency [Symbol, Increase::Models::PendingTransaction::Source::CheckTransferInstruction::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's curr
2494
+ # @param currency [Symbol, Increase::Models::PendingTransaction::Source::CheckTransferInstruction::Currency]
2495
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
2496
+ # currency.
2347
2497
  #
2348
2498
  # @param transfer_id [String] The identifier of the Check Transfer that led to this Pending Transaction.
2349
2499
 
@@ -2439,22 +2589,26 @@ module Increase
2439
2589
  required :type, enum: -> { Increase::PendingTransaction::Source::InboundFundsHold::Type }
2440
2590
 
2441
2591
  # @!method initialize(amount:, automatically_releases_at:, created_at:, currency:, held_transaction_id:, pending_transaction_id:, released_at:, status:, type:)
2442
- # Some parameter documentations has been truncated, see
2443
- # {Increase::Models::PendingTransaction::Source::InboundFundsHold} for more
2444
- # details.
2445
- #
2446
2592
  # An Inbound Funds Hold object. This field will be present in the JSON response if
2447
2593
  # and only if `category` is equal to `inbound_funds_hold`. We hold funds for
2448
2594
  # certain transaction types to account for return windows where funds might still
2449
2595
  # be clawed back by the sending institution.
2450
2596
  #
2451
- # @param amount [Integer] The held amount in the minor unit of the account's currency. For dollars, for ex
2597
+ # @param amount [Integer]
2598
+ # The held amount in the minor unit of the account's currency. For dollars, for
2599
+ # example, this is cents.
2452
2600
  #
2453
- # @param automatically_releases_at [Time] When the hold will be released automatically. Certain conditions may cause it to
2601
+ # @param automatically_releases_at [Time]
2602
+ # When the hold will be released automatically. Certain conditions may cause it to
2603
+ # be released before this time.
2454
2604
  #
2455
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold wa
2605
+ # @param created_at [Time]
2606
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold
2607
+ # was created.
2456
2608
  #
2457
- # @param currency [Symbol, Increase::Models::PendingTransaction::Source::InboundFundsHold::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's curre
2609
+ # @param currency [Symbol, Increase::Models::PendingTransaction::Source::InboundFundsHold::Currency]
2610
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's
2611
+ # currency.
2458
2612
  #
2459
2613
  # @param held_transaction_id [String, nil] The ID of the Transaction for which funds were held.
2460
2614
  #
@@ -2462,9 +2616,12 @@ module Increase
2462
2616
  #
2463
2617
  # @param released_at [Time, nil] When the hold was released (if it has been released).
2464
2618
  #
2465
- # @param status [Symbol, Increase::Models::PendingTransaction::Source::InboundFundsHold::Status] The status of the hold.
2619
+ # @param status [Symbol, Increase::Models::PendingTransaction::Source::InboundFundsHold::Status]
2620
+ # The status of the hold.
2466
2621
  #
2467
- # @param type [Symbol, Increase::Models::PendingTransaction::Source::InboundFundsHold::Type] A constant representing the object's type. For this resource it will always be `
2622
+ # @param type [Symbol, Increase::Models::PendingTransaction::Source::InboundFundsHold::Type]
2623
+ # A constant representing the object's type. For this resource it will always be
2624
+ # `inbound_funds_hold`.
2468
2625
 
2469
2626
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's
2470
2627
  # currency.
@@ -2550,17 +2707,15 @@ module Increase
2550
2707
  required :transfer_id, String
2551
2708
 
2552
2709
  # @!method initialize(amount:, transfer_id:)
2553
- # Some parameter documentations has been truncated, see
2554
- # {Increase::Models::PendingTransaction::Source::RealTimePaymentsTransferInstruction}
2555
- # for more details.
2556
- #
2557
2710
  # A Real-Time Payments Transfer Instruction object. This field will be present in
2558
2711
  # the JSON response if and only if `category` is equal to
2559
2712
  # `real_time_payments_transfer_instruction`.
2560
2713
  #
2561
2714
  # @param amount [Integer] The transfer amount in USD cents.
2562
2715
  #
2563
- # @param transfer_id [String] The identifier of the Real-Time Payments Transfer that led to this Pending Trans
2716
+ # @param transfer_id [String]
2717
+ # The identifier of the Real-Time Payments Transfer that led to this Pending
2718
+ # Transaction.
2564
2719
  end
2565
2720
 
2566
2721
  # @see Increase::Models::PendingTransaction::Source#swift_transfer_instruction
@@ -2612,10 +2767,6 @@ module Increase
2612
2767
  required :transfer_id, String
2613
2768
 
2614
2769
  # @!method initialize(account_number:, amount:, message_to_recipient:, routing_number:, transfer_id:)
2615
- # Some parameter documentations has been truncated, see
2616
- # {Increase::Models::PendingTransaction::Source::WireTransferInstruction} for more
2617
- # details.
2618
- #
2619
2770
  # A Wire Transfer Instruction object. This field will be present in the JSON
2620
2771
  # response if and only if `category` is equal to `wire_transfer_instruction`.
2621
2772
  #
@@ -2625,7 +2776,9 @@ module Increase
2625
2776
  #
2626
2777
  # @param message_to_recipient [String] The message that will show on the recipient's bank statement.
2627
2778
  #
2628
- # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des
2779
+ # @param routing_number [String]
2780
+ # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
2781
+ # destination account.
2629
2782
  #
2630
2783
  # @param transfer_id [String] The identifier of the Wire Transfer that led to this Pending Transaction.
2631
2784
  end