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
@@ -58,22 +58,31 @@ module Increase
58
58
  optional :digital_wallet_token, -> { Increase::RealTimeDecisionActionParams::DigitalWalletToken }
59
59
 
60
60
  # @!method initialize(real_time_decision_id:, card_authentication: nil, card_authentication_challenge: nil, card_authorization: nil, card_balance_inquiry: nil, digital_wallet_authentication: nil, digital_wallet_token: nil, request_options: {})
61
- # Some parameter documentations has been truncated, see
62
- # {Increase::Models::RealTimeDecisionActionParams} for more details.
63
- #
64
61
  # @param real_time_decision_id [String] The identifier of the Real-Time Decision.
65
62
  #
66
- # @param card_authentication [Increase::Models::RealTimeDecisionActionParams::CardAuthentication] If the Real-Time Decision relates to a 3DS card authentication attempt, this obj
63
+ # @param card_authentication [Increase::Models::RealTimeDecisionActionParams::CardAuthentication]
64
+ # If the Real-Time Decision relates to a 3DS card authentication attempt, this
65
+ # object contains your response to the authentication.
67
66
  #
68
- # @param card_authentication_challenge [Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge] If the Real-Time Decision relates to 3DS card authentication challenge delivery,
67
+ # @param card_authentication_challenge [Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge]
68
+ # If the Real-Time Decision relates to 3DS card authentication challenge delivery,
69
+ # this object contains your response.
69
70
  #
70
- # @param card_authorization [Increase::Models::RealTimeDecisionActionParams::CardAuthorization] If the Real-Time Decision relates to a card authorization attempt, this object c
71
+ # @param card_authorization [Increase::Models::RealTimeDecisionActionParams::CardAuthorization]
72
+ # If the Real-Time Decision relates to a card authorization attempt, this object
73
+ # contains your response to the authorization.
71
74
  #
72
- # @param card_balance_inquiry [Increase::Models::RealTimeDecisionActionParams::CardBalanceInquiry] If the Real-Time Decision relates to a card balance inquiry attempt, this object
75
+ # @param card_balance_inquiry [Increase::Models::RealTimeDecisionActionParams::CardBalanceInquiry]
76
+ # If the Real-Time Decision relates to a card balance inquiry attempt, this object
77
+ # contains your response to the inquiry.
73
78
  #
74
- # @param digital_wallet_authentication [Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication] If the Real-Time Decision relates to a digital wallet authentication attempt, th
79
+ # @param digital_wallet_authentication [Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication]
80
+ # If the Real-Time Decision relates to a digital wallet authentication attempt,
81
+ # this object contains your response to the authentication.
75
82
  #
76
- # @param digital_wallet_token [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken] If the Real-Time Decision relates to a digital wallet token provisioning attempt
83
+ # @param digital_wallet_token [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken]
84
+ # If the Real-Time Decision relates to a digital wallet token provisioning
85
+ # attempt, this object contains your response to the attempt.
77
86
  #
78
87
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
79
88
 
@@ -88,7 +97,8 @@ module Increase
88
97
  # If the Real-Time Decision relates to a 3DS card authentication attempt, this
89
98
  # object contains your response to the authentication.
90
99
  #
91
- # @param decision [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthentication::Decision] Whether the card authentication attempt should be approved or declined.
100
+ # @param decision [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthentication::Decision]
101
+ # Whether the card authentication attempt should be approved or declined.
92
102
 
93
103
  # Whether the card authentication attempt should be approved or declined.
94
104
  #
@@ -126,16 +136,16 @@ module Increase
126
136
  optional :success, -> { Increase::RealTimeDecisionActionParams::CardAuthenticationChallenge::Success }
127
137
 
128
138
  # @!method initialize(result:, success: nil)
129
- # Some parameter documentations has been truncated, see
130
- # {Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge}
131
- # for more details.
132
- #
133
139
  # If the Real-Time Decision relates to 3DS card authentication challenge delivery,
134
140
  # this object contains your response.
135
141
  #
136
- # @param result [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge::Result] Whether the card authentication challenge was successfully delivered to the card
142
+ # @param result [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge::Result]
143
+ # Whether the card authentication challenge was successfully delivered to the
144
+ # cardholder.
137
145
  #
138
- # @param success [Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge::Success] If your application was able to deliver the one-time code, this contains metadat
146
+ # @param success [Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge::Success]
147
+ # If your application was able to deliver the one-time code, this contains
148
+ # metadata about the delivery.
139
149
 
140
150
  # Whether the card authentication challenge was successfully delivered to the
141
151
  # cardholder.
@@ -170,16 +180,14 @@ module Increase
170
180
  optional :phone, String
171
181
 
172
182
  # @!method initialize(email: nil, phone: nil)
173
- # Some parameter documentations has been truncated, see
174
- # {Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge::Success}
175
- # for more details.
176
- #
177
183
  # If your application was able to deliver the one-time code, this contains
178
184
  # metadata about the delivery.
179
185
  #
180
186
  # @param email [String] The email address that was used to deliver the one-time code to the cardholder.
181
187
  #
182
- # @param phone [String] The phone number that was used to deliver the one-time code to the cardholder vi
188
+ # @param phone [String]
189
+ # The phone number that was used to deliver the one-time code to the cardholder
190
+ # via SMS.
183
191
  end
184
192
  end
185
193
 
@@ -207,18 +215,21 @@ module Increase
207
215
  optional :decline, -> { Increase::RealTimeDecisionActionParams::CardAuthorization::Decline }
208
216
 
209
217
  # @!method initialize(decision:, approval: nil, decline: nil)
210
- # Some parameter documentations has been truncated, see
211
- # {Increase::Models::RealTimeDecisionActionParams::CardAuthorization} for more
212
- # details.
213
- #
214
218
  # If the Real-Time Decision relates to a card authorization attempt, this object
215
219
  # contains your response to the authorization.
216
220
  #
217
- # @param decision [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Decision] Whether the card authorization should be approved or declined.
221
+ # @param decision [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Decision]
222
+ # Whether the card authorization should be approved or declined.
218
223
  #
219
- # @param approval [Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Approval] If your application approves the authorization, this contains metadata about you
224
+ # @param approval [Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Approval]
225
+ # If your application approves the authorization, this contains metadata about
226
+ # your decision to approve. Your response here is advisory to the acquiring bank.
227
+ # The bank may choose to reverse the authorization if you approve the transaction
228
+ # but indicate the address does not match.
220
229
  #
221
- # @param decline [Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Decline] If your application declines the authorization, this contains details about the
230
+ # @param decline [Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Decline]
231
+ # If your application declines the authorization, this contains details about the
232
+ # decline.
222
233
 
223
234
  # Whether the card authorization should be approved or declined.
224
235
  #
@@ -260,18 +271,24 @@ module Increase
260
271
  optional :partial_amount, Integer
261
272
 
262
273
  # @!method initialize(cardholder_address_verification_result: nil, partial_amount: nil)
263
- # Some parameter documentations has been truncated, see
264
- # {Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Approval}
265
- # for more details.
266
- #
267
274
  # If your application approves the authorization, this contains metadata about
268
275
  # your decision to approve. Your response here is advisory to the acquiring bank.
269
276
  # The bank may choose to reverse the authorization if you approve the transaction
270
277
  # but indicate the address does not match.
271
278
  #
272
- # @param cardholder_address_verification_result [Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult] Your decisions on whether or not each provided address component is a match. You
279
+ # @param cardholder_address_verification_result [Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult]
280
+ # Your decisions on whether or not each provided address component is a match.
281
+ # Your response here is evaluated against the customer's provided `postal_code`
282
+ # and `line1`, and an appropriate network response is generated. For more
283
+ # information, see our
284
+ # [Address Verification System Codes and Overrides](https://increase.com/documentation/address-verification-system-codes-and-overrides)
285
+ # guide.
273
286
  #
274
- # @param partial_amount [Integer] If the transaction supports partial approvals (`partial_approval_capability: sup
287
+ # @param partial_amount [Integer]
288
+ # If the transaction supports partial approvals
289
+ # (`partial_approval_capability: supported`) the `partial_amount` can be provided
290
+ # in the transaction's settlement currency to approve a lower amount than was
291
+ # requested.
275
292
 
276
293
  # @see Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Approval#cardholder_address_verification_result
277
294
  class CardholderAddressVerificationResult < Increase::Internal::Type::BaseModel
@@ -297,9 +314,11 @@ module Increase
297
314
  # [Address Verification System Codes and Overrides](https://increase.com/documentation/address-verification-system-codes-and-overrides)
298
315
  # guide.
299
316
  #
300
- # @param line1 [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult::Line1] Your decision on the address line of the provided address.
317
+ # @param line1 [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult::Line1]
318
+ # Your decision on the address line of the provided address.
301
319
  #
302
- # @param postal_code [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult::PostalCode] Your decision on the postal code of the provided address.
320
+ # @param postal_code [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Approval::CardholderAddressVerificationResult::PostalCode]
321
+ # Your decision on the postal code of the provided address.
303
322
 
304
323
  # Your decision on the address line of the provided address.
305
324
  #
@@ -345,14 +364,12 @@ module Increase
345
364
  required :reason, enum: -> { Increase::RealTimeDecisionActionParams::CardAuthorization::Decline::Reason }
346
365
 
347
366
  # @!method initialize(reason:)
348
- # Some parameter documentations has been truncated, see
349
- # {Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Decline} for
350
- # more details.
351
- #
352
367
  # If your application declines the authorization, this contains details about the
353
368
  # decline.
354
369
  #
355
- # @param reason [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Decline::Reason] The reason the card authorization was declined. This translates to a specific de
370
+ # @param reason [Symbol, Increase::Models::RealTimeDecisionActionParams::CardAuthorization::Decline::Reason]
371
+ # The reason the card authorization was declined. This translates to a specific
372
+ # decline code that is sent to the card network.
356
373
 
357
374
  # The reason the card authorization was declined. This translates to a specific
358
375
  # decline code that is sent to the card network.
@@ -400,16 +417,15 @@ module Increase
400
417
  optional :approval, -> { Increase::RealTimeDecisionActionParams::CardBalanceInquiry::Approval }
401
418
 
402
419
  # @!method initialize(decision:, approval: nil)
403
- # Some parameter documentations has been truncated, see
404
- # {Increase::Models::RealTimeDecisionActionParams::CardBalanceInquiry} for more
405
- # details.
406
- #
407
420
  # If the Real-Time Decision relates to a card balance inquiry attempt, this object
408
421
  # contains your response to the inquiry.
409
422
  #
410
- # @param decision [Symbol, Increase::Models::RealTimeDecisionActionParams::CardBalanceInquiry::Decision] Whether the card balance inquiry should be approved or declined.
423
+ # @param decision [Symbol, Increase::Models::RealTimeDecisionActionParams::CardBalanceInquiry::Decision]
424
+ # Whether the card balance inquiry should be approved or declined.
411
425
  #
412
- # @param approval [Increase::Models::RealTimeDecisionActionParams::CardBalanceInquiry::Approval] If your application approves the balance inquiry, this contains metadata about y
426
+ # @param approval [Increase::Models::RealTimeDecisionActionParams::CardBalanceInquiry::Approval]
427
+ # If your application approves the balance inquiry, this contains metadata about
428
+ # your decision to approve.
413
429
 
414
430
  # Whether the card balance inquiry should be approved or declined.
415
431
  #
@@ -458,16 +474,15 @@ module Increase
458
474
  optional :success, -> { Increase::RealTimeDecisionActionParams::DigitalWalletAuthentication::Success }
459
475
 
460
476
  # @!method initialize(result:, success: nil)
461
- # Some parameter documentations has been truncated, see
462
- # {Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication}
463
- # for more details.
464
- #
465
477
  # If the Real-Time Decision relates to a digital wallet authentication attempt,
466
478
  # this object contains your response to the authentication.
467
479
  #
468
- # @param result [Symbol, Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication::Result] Whether your application was able to deliver the one-time passcode.
480
+ # @param result [Symbol, Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication::Result]
481
+ # Whether your application was able to deliver the one-time passcode.
469
482
  #
470
- # @param success [Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication::Success] If your application was able to deliver the one-time passcode, this contains met
483
+ # @param success [Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication::Success]
484
+ # If your application was able to deliver the one-time passcode, this contains
485
+ # metadata about the delivery. Exactly one of `phone` or `email` must be provided.
471
486
 
472
487
  # Whether your application was able to deliver the one-time passcode.
473
488
  #
@@ -501,16 +516,14 @@ module Increase
501
516
  optional :phone, String
502
517
 
503
518
  # @!method initialize(email: nil, phone: nil)
504
- # Some parameter documentations has been truncated, see
505
- # {Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication::Success}
506
- # for more details.
507
- #
508
519
  # If your application was able to deliver the one-time passcode, this contains
509
520
  # metadata about the delivery. Exactly one of `phone` or `email` must be provided.
510
521
  #
511
522
  # @param email [String] The email address that was used to verify the cardholder via one-time passcode.
512
523
  #
513
- # @param phone [String] The phone number that was used to verify the cardholder via one-time passcode ov
524
+ # @param phone [String]
525
+ # The phone number that was used to verify the cardholder via one-time passcode
526
+ # over SMS.
514
527
  end
515
528
  end
516
529
 
@@ -530,16 +543,16 @@ module Increase
530
543
  optional :decline, -> { Increase::RealTimeDecisionActionParams::DigitalWalletToken::Decline }
531
544
 
532
545
  # @!method initialize(approval: nil, decline: nil)
533
- # Some parameter documentations has been truncated, see
534
- # {Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken} for more
535
- # details.
536
- #
537
546
  # If the Real-Time Decision relates to a digital wallet token provisioning
538
547
  # attempt, this object contains your response to the attempt.
539
548
  #
540
- # @param approval [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken::Approval] If your application approves the provisioning attempt, this contains metadata ab
549
+ # @param approval [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken::Approval]
550
+ # If your application approves the provisioning attempt, this contains metadata
551
+ # about the digital wallet token that will be generated.
541
552
  #
542
- # @param decline [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken::Decline] If your application declines the provisioning attempt, this contains details abo
553
+ # @param decline [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken::Decline]
554
+ # If your application declines the provisioning attempt, this contains details
555
+ # about the decline.
543
556
 
544
557
  # @see Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken#approval
545
558
  class Approval < Increase::Internal::Type::BaseModel
@@ -558,16 +571,16 @@ module Increase
558
571
  optional :phone, String
559
572
 
560
573
  # @!method initialize(email: nil, phone: nil)
561
- # Some parameter documentations has been truncated, see
562
- # {Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken::Approval}
563
- # for more details.
564
- #
565
574
  # If your application approves the provisioning attempt, this contains metadata
566
575
  # about the digital wallet token that will be generated.
567
576
  #
568
- # @param email [String] An email address that can be used to verify the cardholder via one-time passcode
577
+ # @param email [String]
578
+ # An email address that can be used to verify the cardholder via one-time
579
+ # passcode.
569
580
  #
570
- # @param phone [String] A phone number that can be used to verify the cardholder via one-time passcode o
581
+ # @param phone [String]
582
+ # A phone number that can be used to verify the cardholder via one-time passcode
583
+ # over SMS.
571
584
  end
572
585
 
573
586
  # @see Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken#decline
@@ -580,14 +593,12 @@ module Increase
580
593
  optional :reason, String
581
594
 
582
595
  # @!method initialize(reason: nil)
583
- # Some parameter documentations has been truncated, see
584
- # {Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken::Decline}
585
- # for more details.
586
- #
587
596
  # If your application declines the provisioning attempt, this contains details
588
597
  # about the decline.
589
598
  #
590
- # @param reason [String] Why the tokenization attempt was declined. This is for logging purposes only and
599
+ # @param reason [String]
600
+ # Why the tokenization attempt was declined. This is for logging purposes only and
601
+ # is not displayed to the end-user.
591
602
  end
592
603
  end
593
604
  end
@@ -173,9 +173,6 @@ module Increase
173
173
  required :unstructured_remittance_information, String
174
174
 
175
175
  # @!method initialize(id:, account_id:, account_number:, acknowledgement:, amount:, approval:, cancellation:, created_at:, created_by:, creditor_name:, currency:, debtor_name:, external_account_id:, idempotency_key:, pending_transaction_id:, rejection:, routing_number:, source_account_number_id:, status:, submission:, transaction_id:, type:, ultimate_creditor_name:, ultimate_debtor_name:, unstructured_remittance_information:)
176
- # Some parameter documentations has been truncated, see
177
- # {Increase::Models::RealTimePaymentsTransfer} for more details.
178
- #
179
176
  # Real-Time Payments transfers move funds, within seconds, between your Increase
180
177
  # account and any other account on the Real-Time Payments network.
181
178
  #
@@ -185,49 +182,87 @@ module Increase
185
182
  #
186
183
  # @param account_number [String] The destination account number.
187
184
  #
188
- # @param acknowledgement [Increase::Models::RealTimePaymentsTransfer::Acknowledgement, nil] If the transfer is acknowledged by the recipient bank, this will contain supplem
185
+ # @param acknowledgement [Increase::Models::RealTimePaymentsTransfer::Acknowledgement, nil]
186
+ # If the transfer is acknowledged by the recipient bank, this will contain
187
+ # supplemental details.
189
188
  #
190
189
  # @param amount [Integer] The transfer amount in USD cents.
191
190
  #
192
- # @param approval [Increase::Models::RealTimePaymentsTransfer::Approval, nil] If your account requires approvals for transfers and the transfer was approved,
191
+ # @param approval [Increase::Models::RealTimePaymentsTransfer::Approval, nil]
192
+ # If your account requires approvals for transfers and the transfer was approved,
193
+ # this will contain details of the approval.
193
194
  #
194
- # @param cancellation [Increase::Models::RealTimePaymentsTransfer::Cancellation, nil] If your account requires approvals for transfers and the transfer was not approv
195
+ # @param cancellation [Increase::Models::RealTimePaymentsTransfer::Cancellation, nil]
196
+ # If your account requires approvals for transfers and the transfer was not
197
+ # approved, this will contain details of the cancellation.
195
198
  #
196
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
199
+ # @param created_at [Time]
200
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
201
+ # the transfer was created.
197
202
  #
198
- # @param created_by [Increase::Models::RealTimePaymentsTransfer::CreatedBy, nil] What object created the transfer, either via the API or the dashboard.
203
+ # @param created_by [Increase::Models::RealTimePaymentsTransfer::CreatedBy, nil]
204
+ # What object created the transfer, either via the API or the dashboard.
199
205
  #
200
- # @param creditor_name [String] The name of the transfer's recipient. This is set by the sender when creating th
206
+ # @param creditor_name [String]
207
+ # The name of the transfer's recipient. This is set by the sender when creating
208
+ # the transfer.
201
209
  #
202
- # @param currency [Symbol, Increase::Models::RealTimePaymentsTransfer::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's c
210
+ # @param currency [Symbol, Increase::Models::RealTimePaymentsTransfer::Currency]
211
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
212
+ # currency. For real-time payments transfers this is always equal to `USD`.
203
213
  #
204
- # @param debtor_name [String, nil] The name of the transfer's sender. If not provided, defaults to the name of the
214
+ # @param debtor_name [String, nil]
215
+ # The name of the transfer's sender. If not provided, defaults to the name of the
216
+ # account's entity.
205
217
  #
206
- # @param external_account_id [String, nil] The identifier of the External Account the transfer was made to, if any.
218
+ # @param external_account_id [String, nil]
219
+ # The identifier of the External Account the transfer was made to, if any.
207
220
  #
208
- # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
221
+ # @param idempotency_key [String, nil]
222
+ # The idempotency key you chose for this object. This value is unique across
223
+ # Increase and is used to ensure that a request is only processed once. Learn more
224
+ # about [idempotency](https://increase.com/documentation/idempotency-keys).
209
225
  #
210
- # @param pending_transaction_id [String, nil] The ID for the pending transaction representing the transfer. A pending transact
226
+ # @param pending_transaction_id [String, nil]
227
+ # The ID for the pending transaction representing the transfer. A pending
228
+ # transaction is created when the transfer
229
+ # [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
230
+ # by someone else in your organization.
211
231
  #
212
- # @param rejection [Increase::Models::RealTimePaymentsTransfer::Rejection, nil] If the transfer is rejected by Real-Time Payments or the destination financial i
232
+ # @param rejection [Increase::Models::RealTimePaymentsTransfer::Rejection, nil]
233
+ # If the transfer is rejected by Real-Time Payments or the destination financial
234
+ # institution, this will contain supplemental details.
213
235
  #
214
- # @param routing_number [String] The destination American Bankers' Association (ABA) Routing Transit Number (RTN)
236
+ # @param routing_number [String]
237
+ # The destination American Bankers' Association (ABA) Routing Transit Number
238
+ # (RTN).
215
239
  #
216
- # @param source_account_number_id [String] The Account Number the recipient will see as having sent the transfer.
240
+ # @param source_account_number_id [String]
241
+ # The Account Number the recipient will see as having sent the transfer.
217
242
  #
218
- # @param status [Symbol, Increase::Models::RealTimePaymentsTransfer::Status] The lifecycle status of the transfer.
243
+ # @param status [Symbol, Increase::Models::RealTimePaymentsTransfer::Status]
244
+ # The lifecycle status of the transfer.
219
245
  #
220
- # @param submission [Increase::Models::RealTimePaymentsTransfer::Submission, nil] After the transfer is submitted to Real-Time Payments, this will contain supplem
246
+ # @param submission [Increase::Models::RealTimePaymentsTransfer::Submission, nil]
247
+ # After the transfer is submitted to Real-Time Payments, this will contain
248
+ # supplemental details.
221
249
  #
222
250
  # @param transaction_id [String, nil] The Transaction funding the transfer once it is complete.
223
251
  #
224
- # @param type [Symbol, Increase::Models::RealTimePaymentsTransfer::Type] A constant representing the object's type. For this resource it will always be `
252
+ # @param type [Symbol, Increase::Models::RealTimePaymentsTransfer::Type]
253
+ # A constant representing the object's type. For this resource it will always be
254
+ # `real_time_payments_transfer`.
225
255
  #
226
- # @param ultimate_creditor_name [String, nil] The name of the ultimate recipient of the transfer. Set this if the creditor is
256
+ # @param ultimate_creditor_name [String, nil]
257
+ # The name of the ultimate recipient of the transfer. Set this if the creditor is
258
+ # an intermediary receiving the payment for someone else.
227
259
  #
228
- # @param ultimate_debtor_name [String, nil] The name of the ultimate sender of the transfer. Set this if the funds are being
260
+ # @param ultimate_debtor_name [String, nil]
261
+ # The name of the ultimate sender of the transfer. Set this if the funds are being
262
+ # sent on behalf of someone who is not the account holder at Increase.
229
263
  #
230
- # @param unstructured_remittance_information [String] Unstructured information that will show on the recipient's bank statement.
264
+ # @param unstructured_remittance_information [String]
265
+ # Unstructured information that will show on the recipient's bank statement.
231
266
 
232
267
  # @see Increase::Models::RealTimePaymentsTransfer#acknowledgement
233
268
  class Acknowledgement < Increase::Internal::Type::BaseModel
@@ -261,15 +296,16 @@ module Increase
261
296
  required :approved_by, String, nil?: true
262
297
 
263
298
  # @!method initialize(approved_at:, approved_by:)
264
- # Some parameter documentations has been truncated, see
265
- # {Increase::Models::RealTimePaymentsTransfer::Approval} for more details.
266
- #
267
299
  # If your account requires approvals for transfers and the transfer was approved,
268
300
  # this will contain details of the approval.
269
301
  #
270
- # @param approved_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
302
+ # @param approved_at [Time]
303
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
304
+ # the transfer was approved.
271
305
  #
272
- # @param approved_by [String, nil] If the Transfer was approved by a user in the dashboard, the email address of th
306
+ # @param approved_by [String, nil]
307
+ # If the Transfer was approved by a user in the dashboard, the email address of
308
+ # that user.
273
309
  end
274
310
 
275
311
  # @see Increase::Models::RealTimePaymentsTransfer#cancellation
@@ -289,15 +325,16 @@ module Increase
289
325
  required :canceled_by, String, nil?: true
290
326
 
291
327
  # @!method initialize(canceled_at:, canceled_by:)
292
- # Some parameter documentations has been truncated, see
293
- # {Increase::Models::RealTimePaymentsTransfer::Cancellation} for more details.
294
- #
295
328
  # If your account requires approvals for transfers and the transfer was not
296
329
  # approved, this will contain details of the cancellation.
297
330
  #
298
- # @param canceled_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
331
+ # @param canceled_at [Time]
332
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
333
+ # the Transfer was canceled.
299
334
  #
300
- # @param canceled_by [String, nil] If the Transfer was canceled by a user in the dashboard, the email address of th
335
+ # @param canceled_by [String, nil]
336
+ # If the Transfer was canceled by a user in the dashboard, the email address of
337
+ # that user.
301
338
  end
302
339
 
303
340
  # @see Increase::Models::RealTimePaymentsTransfer#created_by
@@ -331,13 +368,17 @@ module Increase
331
368
  # @!method initialize(category:, api_key: nil, oauth_application: nil, user: nil)
332
369
  # What object created the transfer, either via the API or the dashboard.
333
370
  #
334
- # @param category [Symbol, Increase::Models::RealTimePaymentsTransfer::CreatedBy::Category] The type of object that created this transfer.
371
+ # @param category [Symbol, Increase::Models::RealTimePaymentsTransfer::CreatedBy::Category]
372
+ # The type of object that created this transfer.
335
373
  #
336
- # @param api_key [Increase::Models::RealTimePaymentsTransfer::CreatedBy::APIKey, nil] If present, details about the API key that created the transfer.
374
+ # @param api_key [Increase::Models::RealTimePaymentsTransfer::CreatedBy::APIKey, nil]
375
+ # If present, details about the API key that created the transfer.
337
376
  #
338
- # @param oauth_application [Increase::Models::RealTimePaymentsTransfer::CreatedBy::OAuthApplication, nil] If present, details about the OAuth Application that created the transfer.
377
+ # @param oauth_application [Increase::Models::RealTimePaymentsTransfer::CreatedBy::OAuthApplication, nil]
378
+ # If present, details about the OAuth Application that created the transfer.
339
379
  #
340
- # @param user [Increase::Models::RealTimePaymentsTransfer::CreatedBy::User, nil] If present, details about the User that created the transfer.
380
+ # @param user [Increase::Models::RealTimePaymentsTransfer::CreatedBy::User, nil]
381
+ # If present, details about the User that created the transfer.
341
382
 
342
383
  # The type of object that created this transfer.
343
384
  #
@@ -439,17 +480,20 @@ module Increase
439
480
  required :rejected_at, Time, nil?: true
440
481
 
441
482
  # @!method initialize(reject_reason_additional_information:, reject_reason_code:, rejected_at:)
442
- # Some parameter documentations has been truncated, see
443
- # {Increase::Models::RealTimePaymentsTransfer::Rejection} for more details.
444
- #
445
483
  # If the transfer is rejected by Real-Time Payments or the destination financial
446
484
  # institution, this will contain supplemental details.
447
485
  #
448
- # @param reject_reason_additional_information [String, nil] Additional information about the rejection provided by the recipient bank when t
486
+ # @param reject_reason_additional_information [String, nil]
487
+ # Additional information about the rejection provided by the recipient bank when
488
+ # the `reject_reason_code` is `NARRATIVE`.
449
489
  #
450
- # @param reject_reason_code [Symbol, Increase::Models::RealTimePaymentsTransfer::Rejection::RejectReasonCode] The reason the transfer was rejected as provided by the recipient bank or the Re
490
+ # @param reject_reason_code [Symbol, Increase::Models::RealTimePaymentsTransfer::Rejection::RejectReasonCode]
491
+ # The reason the transfer was rejected as provided by the recipient bank or the
492
+ # Real-Time Payments network.
451
493
  #
452
- # @param rejected_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
494
+ # @param rejected_at [Time, nil]
495
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
496
+ # the transfer was rejected.
453
497
 
454
498
  # The reason the transfer was rejected as provided by the recipient bank or the
455
499
  # Real-Time Payments network.
@@ -576,13 +620,12 @@ module Increase
576
620
  required :transaction_identification, String
577
621
 
578
622
  # @!method initialize(submitted_at:, transaction_identification:)
579
- # Some parameter documentations has been truncated, see
580
- # {Increase::Models::RealTimePaymentsTransfer::Submission} for more details.
581
- #
582
623
  # After the transfer is submitted to Real-Time Payments, this will contain
583
624
  # supplemental details.
584
625
  #
585
- # @param submitted_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
626
+ # @param submitted_at [Time, nil]
627
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
628
+ # the transfer was submitted to The Clearing House.
586
629
  #
587
630
  # @param transaction_identification [String] The Real-Time Payments network identification of the transfer.
588
631
  end
@@ -14,7 +14,8 @@ module Increase
14
14
  required :real_time_payments_transfer_id, String
15
15
 
16
16
  # @!method initialize(real_time_payments_transfer_id:, request_options: {})
17
- # @param real_time_payments_transfer_id [String] The identifier of the Real-Time Payments Transfer to approve.
17
+ # @param real_time_payments_transfer_id [String]
18
+ # The identifier of the Real-Time Payments Transfer to approve.
18
19
  #
19
20
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
20
21
  end
@@ -14,7 +14,8 @@ module Increase
14
14
  required :real_time_payments_transfer_id, String
15
15
 
16
16
  # @!method initialize(real_time_payments_transfer_id:, request_options: {})
17
- # @param real_time_payments_transfer_id [String] The identifier of the pending Real-Time Payments Transfer to cancel.
17
+ # @param real_time_payments_transfer_id [String]
18
+ # The identifier of the pending Real-Time Payments Transfer to cancel.
18
19
  #
19
20
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
20
21
  end
@@ -80,30 +80,42 @@ module Increase
80
80
  optional :ultimate_debtor_name, String
81
81
 
82
82
  # @!method initialize(amount:, creditor_name:, source_account_number_id:, unstructured_remittance_information:, account_number: nil, debtor_name: nil, external_account_id: nil, require_approval: nil, routing_number: nil, ultimate_creditor_name: nil, ultimate_debtor_name: nil, request_options: {})
83
- # Some parameter documentations has been truncated, see
84
- # {Increase::Models::RealTimePaymentsTransferCreateParams} for more details.
85
- #
86
- # @param amount [Integer] The transfer amount in USD cents. For Real-Time Payments transfers, must be posi
83
+ # @param amount [Integer]
84
+ # The transfer amount in USD cents. For Real-Time Payments transfers, must be
85
+ # positive.
87
86
  #
88
87
  # @param creditor_name [String] The name of the transfer's recipient.
89
88
  #
90
- # @param source_account_number_id [String] The identifier of the Account Number from which to send the transfer.
89
+ # @param source_account_number_id [String]
90
+ # The identifier of the Account Number from which to send the transfer.
91
91
  #
92
- # @param unstructured_remittance_information [String] Unstructured information that will show on the recipient's bank statement.
92
+ # @param unstructured_remittance_information [String]
93
+ # Unstructured information that will show on the recipient's bank statement.
93
94
  #
94
95
  # @param account_number [String] The destination account number.
95
96
  #
96
- # @param debtor_name [String] The name of the transfer's sender. If not provided, defaults to the name of the
97
+ # @param debtor_name [String]
98
+ # The name of the transfer's sender. If not provided, defaults to the name of the
99
+ # account's entity.
97
100
  #
98
- # @param external_account_id [String] The ID of an External Account to initiate a transfer to. If this parameter is pr
101
+ # @param external_account_id [String]
102
+ # The ID of an External Account to initiate a transfer to. If this parameter is
103
+ # provided, `account_number` and `routing_number` must be absent.
99
104
  #
100
- # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
105
+ # @param require_approval [Boolean]
106
+ # Whether the transfer requires explicit approval via the dashboard or API.
101
107
  #
102
- # @param routing_number [String] The destination American Bankers' Association (ABA) Routing Transit Number (RTN)
108
+ # @param routing_number [String]
109
+ # The destination American Bankers' Association (ABA) Routing Transit Number
110
+ # (RTN).
103
111
  #
104
- # @param ultimate_creditor_name [String] The name of the ultimate recipient of the transfer. Set this if the creditor is
112
+ # @param ultimate_creditor_name [String]
113
+ # The name of the ultimate recipient of the transfer. Set this if the creditor is
114
+ # an intermediary receiving the payment for someone else.
105
115
  #
106
- # @param ultimate_debtor_name [String] The name of the ultimate sender of the transfer. Set this if the funds are being
116
+ # @param ultimate_debtor_name [String]
117
+ # The name of the ultimate sender of the transfer. Set this if the funds are being
118
+ # sent on behalf of someone who is not the account holder at Increase.
107
119
  #
108
120
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
109
121
  end