increase 1.349.0 → 1.350.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 (134) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/models/account_number.rb +3 -3
  4. data/lib/increase/models/ach_transfer.rb +12 -12
  5. data/lib/increase/models/balance_lookup.rb +1 -1
  6. data/lib/increase/models/beneficial_owner_create_params.rb +2 -4
  7. data/lib/increase/models/beneficial_owner_update_params.rb +2 -4
  8. data/lib/increase/models/card_dispute.rb +9 -1
  9. data/lib/increase/models/card_dispute_submit_user_submission_params.rb +4 -0
  10. data/lib/increase/models/card_payment.rb +58 -58
  11. data/lib/increase/models/card_purchase_supplement.rb +9 -1
  12. data/lib/increase/models/card_token_capabilities.rb +2 -2
  13. data/lib/increase/models/check_deposit.rb +9 -9
  14. data/lib/increase/models/check_transfer.rb +2 -2
  15. data/lib/increase/models/check_transfer_create_params.rb +9 -4
  16. data/lib/increase/models/declined_transaction.rb +12 -9
  17. data/lib/increase/models/digital_wallet_token.rb +9 -1
  18. data/lib/increase/models/entity.rb +5 -5
  19. data/lib/increase/models/entity_create_params.rb +332 -29
  20. data/lib/increase/models/entity_onboarding_session_list_params.rb +2 -2
  21. data/lib/increase/models/entity_update_params.rb +472 -15
  22. data/lib/increase/models/fednow_transfer.rb +115 -4
  23. data/lib/increase/models/fednow_transfer_list_params.rb +3 -3
  24. data/lib/increase/models/inbound_ach_transfer.rb +2 -2
  25. data/lib/increase/models/inbound_check_deposit.rb +2 -2
  26. data/lib/increase/models/inbound_fednow_transfer.rb +3 -0
  27. data/lib/increase/models/inbound_mail_item.rb +14 -1
  28. data/lib/increase/models/inbound_wire_drawdown_request.rb +12 -1
  29. data/lib/increase/models/inbound_wire_transfer.rb +4 -4
  30. data/lib/increase/models/intrafi_exclusion.rb +4 -4
  31. data/lib/increase/models/lockbox_recipient_create_params.rb +2 -2
  32. data/lib/increase/models/pending_transaction.rb +13 -13
  33. data/lib/increase/models/pending_transaction_list_params.rb +4 -6
  34. data/lib/increase/models/physical_card.rb +9 -1
  35. data/lib/increase/models/real_time_decision.rb +18 -18
  36. data/lib/increase/models/simulations/card_authentication_create_params.rb +2 -2
  37. data/lib/increase/models/simulations/card_dispute_action_params.rb +6 -6
  38. data/lib/increase/models/simulations/entity_update_validation_params.rb +3 -3
  39. data/lib/increase/models/simulations/interest_payment_create_params.rb +2 -2
  40. data/lib/increase/models/simulations/pending_transaction_release_inbound_funds_hold_params.rb +2 -2
  41. data/lib/increase/models/simulations/program_create_params.rb +14 -3
  42. data/lib/increase/models/transaction.rb +141 -17
  43. data/lib/increase/models/transaction_list_params.rb +3 -0
  44. data/lib/increase/models/wire_drawdown_request.rb +12 -1
  45. data/lib/increase/models/wire_transfer_create_params.rb +2 -2
  46. data/lib/increase/resources/cards.rb +2 -2
  47. data/lib/increase/resources/check_transfers.rb +1 -1
  48. data/lib/increase/resources/entities.rb +10 -2
  49. data/lib/increase/resources/entity_onboarding_sessions.rb +1 -1
  50. data/lib/increase/resources/lockbox_recipients.rb +1 -1
  51. data/lib/increase/resources/simulations/card_authentications.rb +1 -1
  52. data/lib/increase/resources/simulations/card_disputes.rb +2 -2
  53. data/lib/increase/resources/simulations/interest_payments.rb +1 -1
  54. data/lib/increase/resources/simulations/pending_transactions.rb +1 -1
  55. data/lib/increase/resources/simulations/physical_cards.rb +2 -2
  56. data/lib/increase/resources/simulations/programs.rb +6 -2
  57. data/lib/increase/resources/wire_transfers.rb +1 -1
  58. data/lib/increase/version.rb +1 -1
  59. data/rbi/increase/models/account_number.rbi +3 -3
  60. data/rbi/increase/models/ach_transfer.rbi +12 -12
  61. data/rbi/increase/models/balance_lookup.rbi +1 -1
  62. data/rbi/increase/models/beneficial_owner_create_params.rbi +2 -4
  63. data/rbi/increase/models/beneficial_owner_update_params.rbi +2 -4
  64. data/rbi/increase/models/card_dispute.rbi +8 -0
  65. data/rbi/increase/models/card_dispute_submit_user_submission_params.rbi +3 -0
  66. data/rbi/increase/models/card_payment.rbi +58 -58
  67. data/rbi/increase/models/card_purchase_supplement.rbi +8 -0
  68. data/rbi/increase/models/card_token_capabilities.rbi +2 -2
  69. data/rbi/increase/models/check_deposit.rbi +9 -9
  70. data/rbi/increase/models/check_transfer.rbi +2 -2
  71. data/rbi/increase/models/check_transfer_create_params.rbi +8 -4
  72. data/rbi/increase/models/declined_transaction.rbi +16 -9
  73. data/rbi/increase/models/digital_wallet_token.rbi +8 -0
  74. data/rbi/increase/models/entity.rbi +5 -5
  75. data/rbi/increase/models/entity_create_params.rbi +547 -28
  76. data/rbi/increase/models/entity_onboarding_session_list_params.rbi +2 -2
  77. data/rbi/increase/models/entity_update_params.rbi +814 -14
  78. data/rbi/increase/models/fednow_transfer.rbi +213 -7
  79. data/rbi/increase/models/fednow_transfer_list_params.rbi +7 -7
  80. data/rbi/increase/models/inbound_ach_transfer.rbi +2 -2
  81. data/rbi/increase/models/inbound_check_deposit.rbi +2 -2
  82. data/rbi/increase/models/inbound_fednow_transfer.rbi +7 -0
  83. data/rbi/increase/models/inbound_mail_item.rbi +12 -0
  84. data/rbi/increase/models/inbound_wire_drawdown_request.rbi +10 -0
  85. data/rbi/increase/models/inbound_wire_transfer.rbi +4 -4
  86. data/rbi/increase/models/intrafi_exclusion.rbi +4 -4
  87. data/rbi/increase/models/lockbox_recipient_create_params.rbi +2 -2
  88. data/rbi/increase/models/pending_transaction.rbi +13 -13
  89. data/rbi/increase/models/pending_transaction_list_params.rbi +4 -6
  90. data/rbi/increase/models/physical_card.rbi +8 -0
  91. data/rbi/increase/models/real_time_decision.rbi +18 -18
  92. data/rbi/increase/models/simulations/card_authentication_create_params.rbi +2 -2
  93. data/rbi/increase/models/simulations/card_dispute_action_params.rbi +6 -6
  94. data/rbi/increase/models/simulations/entity_update_validation_params.rbi +3 -3
  95. data/rbi/increase/models/simulations/interest_payment_create_params.rbi +2 -2
  96. data/rbi/increase/models/simulations/pending_transaction_release_inbound_funds_hold_params.rbi +2 -2
  97. data/rbi/increase/models/simulations/program_create_params.rbi +15 -2
  98. data/rbi/increase/models/transaction.rbi +260 -16
  99. data/rbi/increase/models/transaction_list_params.rbi +7 -0
  100. data/rbi/increase/models/wire_drawdown_request.rbi +10 -0
  101. data/rbi/increase/models/wire_transfer_create_params.rbi +2 -2
  102. data/rbi/increase/resources/cards.rbi +2 -2
  103. data/rbi/increase/resources/check_transfers.rbi +1 -1
  104. data/rbi/increase/resources/entities.rbi +10 -0
  105. data/rbi/increase/resources/entity_onboarding_sessions.rbi +1 -1
  106. data/rbi/increase/resources/lockbox_recipients.rbi +1 -1
  107. data/rbi/increase/resources/simulations/card_authentications.rbi +1 -1
  108. data/rbi/increase/resources/simulations/card_disputes.rbi +2 -2
  109. data/rbi/increase/resources/simulations/interest_payments.rbi +1 -1
  110. data/rbi/increase/resources/simulations/pending_transactions.rbi +1 -1
  111. data/rbi/increase/resources/simulations/physical_cards.rbi +2 -2
  112. data/rbi/increase/resources/simulations/programs.rbi +5 -1
  113. data/rbi/increase/resources/wire_transfers.rbi +1 -1
  114. data/sig/increase/models/card_dispute.rbs +5 -0
  115. data/sig/increase/models/card_purchase_supplement.rbs +5 -0
  116. data/sig/increase/models/declined_transaction.rbs +4 -0
  117. data/sig/increase/models/digital_wallet_token.rbs +5 -0
  118. data/sig/increase/models/entity.rbs +3 -3
  119. data/sig/increase/models/entity_create_params.rbs +232 -1
  120. data/sig/increase/models/entity_update_params.rbs +366 -0
  121. data/sig/increase/models/fednow_transfer.rbs +113 -4
  122. data/sig/increase/models/fednow_transfer_list_params.rbs +4 -4
  123. data/sig/increase/models/inbound_fednow_transfer.rbs +4 -0
  124. data/sig/increase/models/inbound_mail_item.rbs +5 -0
  125. data/sig/increase/models/inbound_wire_drawdown_request.rbs +5 -0
  126. data/sig/increase/models/physical_card.rbs +5 -0
  127. data/sig/increase/models/simulations/entity_update_validation_params.rbs +3 -3
  128. data/sig/increase/models/simulations/program_create_params.rbs +7 -0
  129. data/sig/increase/models/transaction.rbs +113 -0
  130. data/sig/increase/models/transaction_list_params.rbs +4 -0
  131. data/sig/increase/models/wire_drawdown_request.rbs +5 -0
  132. data/sig/increase/resources/entities.rbs +2 -0
  133. data/sig/increase/resources/simulations/programs.rbs +1 -0
  134. metadata +2 -2
@@ -1700,9 +1700,9 @@ module Increase
1700
1700
  sig { returns(String) }
1701
1701
  attr_accessor :account_id
1702
1702
 
1703
- # Additional amounts associated with the card authorization, such as ATM
1704
- # surcharges fees. These are usually a subset of the `amount` field and are used
1705
- # to provide more detailed information about the transaction.
1703
+ # Additional amounts associated with the card authorization, such as ATM surcharge
1704
+ # fees. These are usually a subset of the `amount` field and are used to provide
1705
+ # more detailed information about the transaction.
1706
1706
  sig do
1707
1707
  returns(
1708
1708
  Increase::RealTimeDecision::CardAuthorization::AdditionalAmounts
@@ -2018,9 +2018,9 @@ module Increase
2018
2018
  def self.new(
2019
2019
  # The identifier of the Account the authorization will debit.
2020
2020
  account_id:,
2021
- # Additional amounts associated with the card authorization, such as ATM
2022
- # surcharges fees. These are usually a subset of the `amount` field and are used
2023
- # to provide more detailed information about the transaction.
2021
+ # Additional amounts associated with the card authorization, such as ATM surcharge
2022
+ # fees. These are usually a subset of the `amount` field and are used to provide
2023
+ # more detailed information about the transaction.
2024
2024
  additional_amounts:,
2025
2025
  # Present if and only if `decision` is `approve`. Contains information related to
2026
2026
  # the approval of the authorization.
@@ -2375,9 +2375,9 @@ module Increase
2375
2375
  end
2376
2376
  attr_writer :vision
2377
2377
 
2378
- # Additional amounts associated with the card authorization, such as ATM
2379
- # surcharges fees. These are usually a subset of the `amount` field and are used
2380
- # to provide more detailed information about the transaction.
2378
+ # Additional amounts associated with the card authorization, such as ATM surcharge
2379
+ # fees. These are usually a subset of the `amount` field and are used to provide
2380
+ # more detailed information about the transaction.
2381
2381
  sig do
2382
2382
  params(
2383
2383
  clinic:
@@ -4669,9 +4669,9 @@ module Increase
4669
4669
  sig { returns(String) }
4670
4670
  attr_accessor :account_id
4671
4671
 
4672
- # Additional amounts associated with the card authorization, such as ATM
4673
- # surcharges fees. These are usually a subset of the `amount` field and are used
4674
- # to provide more detailed information about the transaction.
4672
+ # Additional amounts associated with the card authorization, such as ATM surcharge
4673
+ # fees. These are usually a subset of the `amount` field and are used to provide
4674
+ # more detailed information about the transaction.
4675
4675
  sig do
4676
4676
  returns(
4677
4677
  Increase::RealTimeDecision::CardBalanceInquiry::AdditionalAmounts
@@ -4861,9 +4861,9 @@ module Increase
4861
4861
  def self.new(
4862
4862
  # The identifier of the Account the authorization will debit.
4863
4863
  account_id:,
4864
- # Additional amounts associated with the card authorization, such as ATM
4865
- # surcharges fees. These are usually a subset of the `amount` field and are used
4866
- # to provide more detailed information about the transaction.
4864
+ # Additional amounts associated with the card authorization, such as ATM surcharge
4865
+ # fees. These are usually a subset of the `amount` field and are used to provide
4866
+ # more detailed information about the transaction.
4867
4867
  additional_amounts:,
4868
4868
  # Present if and only if `decision` is `approve`. Contains information related to
4869
4869
  # the approval of the balance inquiry.
@@ -5162,9 +5162,9 @@ module Increase
5162
5162
  end
5163
5163
  attr_writer :vision
5164
5164
 
5165
- # Additional amounts associated with the card authorization, such as ATM
5166
- # surcharges fees. These are usually a subset of the `amount` field and are used
5167
- # to provide more detailed information about the transaction.
5165
+ # Additional amounts associated with the card authorization, such as ATM surcharge
5166
+ # fees. These are usually a subset of the `amount` field and are used to provide
5167
+ # more detailed information about the transaction.
5168
5168
  sig do
5169
5169
  params(
5170
5170
  clinic:
@@ -78,7 +78,7 @@ module Increase
78
78
  sig { params(merchant_country: String).void }
79
79
  attr_writer :merchant_country
80
80
 
81
- # The name of the merchant
81
+ # The name of the merchant.
82
82
  sig { returns(T.nilable(String)) }
83
83
  attr_reader :merchant_name
84
84
 
@@ -122,7 +122,7 @@ module Increase
122
122
  merchant_category_code: nil,
123
123
  # The country the merchant resides in.
124
124
  merchant_country: nil,
125
- # The name of the merchant
125
+ # The name of the merchant.
126
126
  merchant_name: nil,
127
127
  # The purchase amount in cents.
128
128
  purchase_amount: nil,
@@ -28,8 +28,8 @@ module Increase
28
28
  end
29
29
  attr_accessor :network
30
30
 
31
- # The Visa-specific parameters for the taking action on the dispute. Required if
32
- # and only if `network` is `visa`.
31
+ # The Visa-specific parameters for taking action on the dispute. Required if and
32
+ # only if `network` is `visa`.
33
33
  sig do
34
34
  returns(
35
35
  T.nilable(Increase::Simulations::CardDisputeActionParams::Visa)
@@ -59,8 +59,8 @@ module Increase
59
59
  # The network of the Card Dispute. Details specific to the network are required
60
60
  # under the sub-object with the same identifier as the network.
61
61
  network:,
62
- # The Visa-specific parameters for the taking action on the dispute. Required if
63
- # and only if `network` is `visa`.
62
+ # The Visa-specific parameters for taking action on the dispute. Required if and
63
+ # only if `network` is `visa`.
64
64
  visa: nil,
65
65
  request_options: {}
66
66
  )
@@ -339,8 +339,8 @@ module Increase
339
339
  end
340
340
  attr_writer :time_out_user_prearbitration
341
341
 
342
- # The Visa-specific parameters for the taking action on the dispute. Required if
343
- # and only if `network` is `visa`.
342
+ # The Visa-specific parameters for taking action on the dispute. Required if and
343
+ # only if `network` is `visa`.
344
344
  sig do
345
345
  params(
346
346
  action:
@@ -116,21 +116,21 @@ module Increase
116
116
  end
117
117
  OrSymbol = T.type_alias { T.any(Symbol, String) }
118
118
 
119
- # The entity's tax identifier could not be verified. Update the tax ID with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.legal_identifier).
119
+ # The entity's tax identifier could not be verified. Update the tax ID with the [update an entity API](/documentation/api/entities#update-an-entity).
120
120
  ENTITY_TAX_IDENTIFIER =
121
121
  T.let(
122
122
  :entity_tax_identifier,
123
123
  Increase::Simulations::EntityUpdateValidationParams::Issue::Category::TaggedSymbol
124
124
  )
125
125
 
126
- # The entity's address could not be validated. Update the address with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.address).
126
+ # The entity's address could not be validated. Update the address with the [update an entity API](/documentation/api/entities#update-an-entity).
127
127
  ENTITY_ADDRESS =
128
128
  T.let(
129
129
  :entity_address,
130
130
  Increase::Simulations::EntityUpdateValidationParams::Issue::Category::TaggedSymbol
131
131
  )
132
132
 
133
- # The entity's identity could not be verified. Update the identification with the [update an entity API](/documentation/api/entities#update-an-entity.natural_person.identification).
133
+ # The entity's identity could not be verified. Update the identification with the [update an entity API](/documentation/api/entities#update-an-entity).
134
134
  ENTITY_IDENTITY =
135
135
  T.let(
136
136
  :entity_identity,
@@ -15,7 +15,7 @@ module Increase
15
15
  )
16
16
  end
17
17
 
18
- # The identifier of the Account the Interest Payment should be paid to is for.
18
+ # The identifier of the Account the Interest Payment should be paid to.
19
19
  sig { returns(String) }
20
20
  attr_accessor :account_id
21
21
 
@@ -55,7 +55,7 @@ module Increase
55
55
  ).returns(T.attached_class)
56
56
  end
57
57
  def self.new(
58
- # The identifier of the Account the Interest Payment should be paid to is for.
58
+ # The identifier of the Account the Interest Payment should be paid to.
59
59
  account_id:,
60
60
  # The interest amount in cents. Must be positive.
61
61
  amount:,
@@ -15,7 +15,7 @@ module Increase
15
15
  )
16
16
  end
17
17
 
18
- # The pending transaction to release. The pending transaction must have a
18
+ # The pending transaction to release. The pending transaction must have an
19
19
  # `inbound_funds_hold` source.
20
20
  sig { returns(String) }
21
21
  attr_accessor :pending_transaction_id
@@ -27,7 +27,7 @@ module Increase
27
27
  ).returns(T.attached_class)
28
28
  end
29
29
  def self.new(
30
- # The pending transaction to release. The pending transaction must have a
30
+ # The pending transaction to release. The pending transaction must have an
31
31
  # `inbound_funds_hold` source.
32
32
  pending_transaction_id:,
33
33
  request_options: {}
@@ -43,7 +43,15 @@ module Increase
43
43
  sig { params(lending_maximum_extendable_credit: Integer).void }
44
44
  attr_writer :lending_maximum_extendable_credit
45
45
 
46
- # The identifier of the Account the Program should be added to is for.
46
+ # Whether opening a loan Account under this Program requires an accepted Loan
47
+ # Offer. Requires `lending_maximum_extendable_credit`. Defaults to `false`.
48
+ sig { returns(T.nilable(T::Boolean)) }
49
+ attr_reader :loan_accounts_require_loan_offers
50
+
51
+ sig { params(loan_accounts_require_loan_offers: T::Boolean).void }
52
+ attr_writer :loan_accounts_require_loan_offers
53
+
54
+ # The identifier of the Account the Program should be added to.
47
55
  sig { returns(T.nilable(String)) }
48
56
  attr_reader :reserve_account_id
49
57
 
@@ -55,6 +63,7 @@ module Increase
55
63
  name: String,
56
64
  bank: Increase::Simulations::ProgramCreateParams::Bank::OrSymbol,
57
65
  lending_maximum_extendable_credit: Integer,
66
+ loan_accounts_require_loan_offers: T::Boolean,
58
67
  reserve_account_id: String,
59
68
  request_options: Increase::RequestOptions::OrHash
60
69
  ).returns(T.attached_class)
@@ -66,7 +75,10 @@ module Increase
66
75
  bank: nil,
67
76
  # The maximum extendable credit of the program being added.
68
77
  lending_maximum_extendable_credit: nil,
69
- # The identifier of the Account the Program should be added to is for.
78
+ # Whether opening a loan Account under this Program requires an accepted Loan
79
+ # Offer. Requires `lending_maximum_extendable_credit`. Defaults to `false`.
80
+ loan_accounts_require_loan_offers: nil,
81
+ # The identifier of the Account the Program should be added to.
70
82
  reserve_account_id: nil,
71
83
  request_options: {}
72
84
  )
@@ -78,6 +90,7 @@ module Increase
78
90
  name: String,
79
91
  bank: Increase::Simulations::ProgramCreateParams::Bank::OrSymbol,
80
92
  lending_maximum_extendable_credit: Integer,
93
+ loan_accounts_require_loan_offers: T::Boolean,
81
94
  reserve_account_id: String,
82
95
  request_options: Increase::RequestOptions
83
96
  }
@@ -594,6 +594,27 @@ module Increase
594
594
  end
595
595
  attr_writer :fednow_transfer_acknowledgement
596
596
 
597
+ # A FedNow Transfer Return object. This field will be present in the JSON response
598
+ # if and only if `category` is equal to `fednow_transfer_return`. A FedNow
599
+ # Transfer Return is created when a FedNow Transfer sent from Increase is returned
600
+ # by the recipient's bank.
601
+ sig do
602
+ returns(
603
+ T.nilable(Increase::Transaction::Source::FednowTransferReturn)
604
+ )
605
+ end
606
+ attr_reader :fednow_transfer_return
607
+
608
+ sig do
609
+ params(
610
+ fednow_transfer_return:
611
+ T.nilable(
612
+ Increase::Transaction::Source::FednowTransferReturn::OrHash
613
+ )
614
+ ).void
615
+ end
616
+ attr_writer :fednow_transfer_return
617
+
597
618
  # A Fee Payment object. This field will be present in the JSON response if and
598
619
  # only if `category` is equal to `fee_payment`. A Fee Payment represents a payment
599
620
  # made to Increase.
@@ -654,7 +675,7 @@ module Increase
654
675
  # An Inbound Check Adjustment object. This field will be present in the JSON
655
676
  # response if and only if `category` is equal to `inbound_check_adjustment`. An
656
677
  # Inbound Check Adjustment is created when Increase receives an adjustment for a
657
- # check or return deposited through Check21.
678
+ # check or return deposited through Check 21.
658
679
  sig do
659
680
  returns(
660
681
  T.nilable(Increase::Transaction::Source::InboundCheckAdjustment)
@@ -1025,6 +1046,10 @@ module Increase
1025
1046
  T.nilable(
1026
1047
  Increase::Transaction::Source::FednowTransferAcknowledgement::OrHash
1027
1048
  ),
1049
+ fednow_transfer_return:
1050
+ T.nilable(
1051
+ Increase::Transaction::Source::FednowTransferReturn::OrHash
1052
+ ),
1028
1053
  fee_payment:
1029
1054
  T.nilable(Increase::Transaction::Source::FeePayment::OrHash),
1030
1055
  inbound_ach_transfer:
@@ -1195,6 +1220,11 @@ module Increase
1195
1220
  # `fednow_transfer_acknowledgement`. A FedNow Transfer Acknowledgement is created
1196
1221
  # when a FedNow Transfer sent from Increase is acknowledged by the receiving bank.
1197
1222
  fednow_transfer_acknowledgement: nil,
1223
+ # A FedNow Transfer Return object. This field will be present in the JSON response
1224
+ # if and only if `category` is equal to `fednow_transfer_return`. A FedNow
1225
+ # Transfer Return is created when a FedNow Transfer sent from Increase is returned
1226
+ # by the recipient's bank.
1227
+ fednow_transfer_return: nil,
1198
1228
  # A Fee Payment object. This field will be present in the JSON response if and
1199
1229
  # only if `category` is equal to `fee_payment`. A Fee Payment represents a payment
1200
1230
  # made to Increase.
@@ -1213,7 +1243,7 @@ module Increase
1213
1243
  # An Inbound Check Adjustment object. This field will be present in the JSON
1214
1244
  # response if and only if `category` is equal to `inbound_check_adjustment`. An
1215
1245
  # Inbound Check Adjustment is created when Increase receives an adjustment for a
1216
- # check or return deposited through Check21.
1246
+ # check or return deposited through Check 21.
1217
1247
  inbound_check_adjustment: nil,
1218
1248
  # An Inbound Check Deposit Return Intention object. This field will be present in
1219
1249
  # the JSON response if and only if `category` is equal to
@@ -1342,6 +1372,8 @@ module Increase
1342
1372
  T.nilable(
1343
1373
  Increase::Transaction::Source::FednowTransferAcknowledgement
1344
1374
  ),
1375
+ fednow_transfer_return:
1376
+ T.nilable(Increase::Transaction::Source::FednowTransferReturn),
1345
1377
  fee_payment: T.nilable(Increase::Transaction::Source::FeePayment),
1346
1378
  inbound_ach_transfer:
1347
1379
  T.nilable(Increase::Transaction::Source::InboundACHTransfer),
@@ -1514,6 +1546,13 @@ module Increase
1514
1546
  Increase::Transaction::Source::Category::TaggedSymbol
1515
1547
  )
1516
1548
 
1549
+ # FedNow Transfer Return: details will be under the `fednow_transfer_return` object.
1550
+ FEDNOW_TRANSFER_RETURN =
1551
+ T.let(
1552
+ :fednow_transfer_return,
1553
+ Increase::Transaction::Source::Category::TaggedSymbol
1554
+ )
1555
+
1517
1556
  # Check Transfer Deposit: details will be under the `check_transfer_deposit` object.
1518
1557
  CHECK_TRANSFER_DEPOSIT =
1519
1558
  T.let(
@@ -3051,9 +3090,9 @@ module Increase
3051
3090
  end
3052
3091
  attr_accessor :actioner
3053
3092
 
3054
- # Additional amounts associated with the card authorization, such as ATM
3055
- # surcharges fees. These are usually a subset of the `amount` field and are used
3056
- # to provide more detailed information about the transaction.
3093
+ # Additional amounts associated with the card authorization, such as ATM surcharge
3094
+ # fees. These are usually a subset of the `amount` field and are used to provide
3095
+ # more detailed information about the transaction.
3057
3096
  sig do
3058
3097
  returns(
3059
3098
  Increase::Transaction::Source::CardFinancial::AdditionalAmounts
@@ -3293,9 +3332,9 @@ module Increase
3293
3332
  # Whether this financial was approved by Increase, the card network through
3294
3333
  # stand-in processing, or the user through a real-time decision.
3295
3334
  actioner:,
3296
- # Additional amounts associated with the card authorization, such as ATM
3297
- # surcharges fees. These are usually a subset of the `amount` field and are used
3298
- # to provide more detailed information about the transaction.
3335
+ # Additional amounts associated with the card authorization, such as ATM surcharge
3336
+ # fees. These are usually a subset of the `amount` field and are used to provide
3337
+ # more detailed information about the transaction.
3299
3338
  additional_amounts:,
3300
3339
  # The pending amount in the minor unit of the transaction's currency. For dollars,
3301
3340
  # for example, this is cents.
@@ -3669,9 +3708,9 @@ module Increase
3669
3708
  end
3670
3709
  attr_writer :vision
3671
3710
 
3672
- # Additional amounts associated with the card authorization, such as ATM
3673
- # surcharges fees. These are usually a subset of the `amount` field and are used
3674
- # to provide more detailed information about the transaction.
3711
+ # Additional amounts associated with the card authorization, such as ATM surcharge
3712
+ # fees. These are usually a subset of the `amount` field and are used to provide
3713
+ # more detailed information about the transaction.
3675
3714
  sig do
3676
3715
  params(
3677
3716
  clinic:
@@ -12167,7 +12206,7 @@ module Increase
12167
12206
 
12168
12207
  # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
12169
12208
  # bank depositing this check. In some rare cases, this is not transmitted via
12170
- # Check21 and the value will be null.
12209
+ # Check 21 and the value will be null.
12171
12210
  sig { returns(T.nilable(String)) }
12172
12211
  attr_accessor :bank_of_first_deposit_routing_number
12173
12212
 
@@ -12225,7 +12264,7 @@ module Increase
12225
12264
  back_image_file_id:,
12226
12265
  # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
12227
12266
  # bank depositing this check. In some rare cases, this is not transmitted via
12228
- # Check21 and the value will be null.
12267
+ # Check 21 and the value will be null.
12229
12268
  bank_of_first_deposit_routing_number:,
12230
12269
  # When the check was deposited.
12231
12270
  deposited_at:,
@@ -12324,6 +12363,211 @@ module Increase
12324
12363
  end
12325
12364
  end
12326
12365
 
12366
+ class FednowTransferReturn < Increase::Internal::Type::BaseModel
12367
+ OrHash =
12368
+ T.type_alias do
12369
+ T.any(
12370
+ Increase::Transaction::Source::FednowTransferReturn,
12371
+ Increase::Internal::AnyHash
12372
+ )
12373
+ end
12374
+
12375
+ # The returned amount in USD cents. This is always a positive number.
12376
+ sig { returns(Integer) }
12377
+ attr_accessor :amount
12378
+
12379
+ # Additional information about the return provided by the recipient's bank.
12380
+ sig { returns(T.nilable(String)) }
12381
+ attr_accessor :return_reason_additional_information
12382
+
12383
+ # The reason the transfer was returned as provided by the recipient's bank.
12384
+ sig do
12385
+ returns(
12386
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12387
+ )
12388
+ end
12389
+ attr_accessor :return_reason_code
12390
+
12391
+ # The identifier of the FedNow Transfer that led to this Transaction.
12392
+ sig { returns(String) }
12393
+ attr_accessor :transfer_id
12394
+
12395
+ # A FedNow Transfer Return object. This field will be present in the JSON response
12396
+ # if and only if `category` is equal to `fednow_transfer_return`. A FedNow
12397
+ # Transfer Return is created when a FedNow Transfer sent from Increase is returned
12398
+ # by the recipient's bank.
12399
+ sig do
12400
+ params(
12401
+ amount: Integer,
12402
+ return_reason_additional_information: T.nilable(String),
12403
+ return_reason_code:
12404
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::OrSymbol,
12405
+ transfer_id: String
12406
+ ).returns(T.attached_class)
12407
+ end
12408
+ def self.new(
12409
+ # The returned amount in USD cents. This is always a positive number.
12410
+ amount:,
12411
+ # Additional information about the return provided by the recipient's bank.
12412
+ return_reason_additional_information:,
12413
+ # The reason the transfer was returned as provided by the recipient's bank.
12414
+ return_reason_code:,
12415
+ # The identifier of the FedNow Transfer that led to this Transaction.
12416
+ transfer_id:
12417
+ )
12418
+ end
12419
+
12420
+ sig do
12421
+ override.returns(
12422
+ {
12423
+ amount: Integer,
12424
+ return_reason_additional_information: T.nilable(String),
12425
+ return_reason_code:
12426
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol,
12427
+ transfer_id: String
12428
+ }
12429
+ )
12430
+ end
12431
+ def to_hash
12432
+ end
12433
+
12434
+ # The reason the transfer was returned as provided by the recipient's bank.
12435
+ module ReturnReasonCode
12436
+ extend Increase::Internal::Type::Enum
12437
+
12438
+ TaggedSymbol =
12439
+ T.type_alias do
12440
+ T.all(
12441
+ Symbol,
12442
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode
12443
+ )
12444
+ end
12445
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
12446
+
12447
+ # The destination account is closed. Corresponds to the FedNow reason codes `AC04` and `AC07`.
12448
+ ACCOUNT_CLOSED =
12449
+ T.let(
12450
+ :account_closed,
12451
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12452
+ )
12453
+
12454
+ # The destination account is currently blocked from receiving transactions. Corresponds to the FedNow reason code `AC06`.
12455
+ ACCOUNT_BLOCKED =
12456
+ T.let(
12457
+ :account_blocked,
12458
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12459
+ )
12460
+
12461
+ # The recipient's bank was not a valid agent for this transfer. Corresponds to the FedNow reason codes `AC14` and `AGNT`.
12462
+ INVALID_AGENT =
12463
+ T.let(
12464
+ :invalid_agent,
12465
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12466
+ )
12467
+
12468
+ # The destination account does not exist. Corresponds to the FedNow reason code `AC03`.
12469
+ INVALID_CREDITOR_ACCOUNT_NUMBER =
12470
+ T.let(
12471
+ :invalid_creditor_account_number,
12472
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12473
+ )
12474
+
12475
+ # The destination account number was incorrect. Corresponds to the FedNow reason code `AC01`.
12476
+ INCORRECT_ACCOUNT_NUMBER =
12477
+ T.let(
12478
+ :incorrect_account_number,
12479
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12480
+ )
12481
+
12482
+ # The destination account holder is deceased. Corresponds to the FedNow reason code `MD07`.
12483
+ END_CUSTOMER_DECEASED =
12484
+ T.let(
12485
+ :end_customer_deceased,
12486
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12487
+ )
12488
+
12489
+ # The transfer was not permitted by the recipient's bank. Corresponds to the FedNow reason code `AG01`.
12490
+ TRANSACTION_FORBIDDEN =
12491
+ T.let(
12492
+ :transaction_forbidden,
12493
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12494
+ )
12495
+
12496
+ # The transfer was returned for a regulatory reason at the recipient's bank. Corresponds to the FedNow reason code `RR04`.
12497
+ REGULATORY_REASON =
12498
+ T.let(
12499
+ :regulatory_reason,
12500
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12501
+ )
12502
+
12503
+ # The transfer was reported as fraudulent. Corresponds to the FedNow reason code `FR01`.
12504
+ FRAUD =
12505
+ T.let(
12506
+ :fraud,
12507
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12508
+ )
12509
+
12510
+ # The transfer duplicated another transfer. Corresponds to the FedNow reason codes `AM05` and `DUPL`.
12511
+ DUPLICATION =
12512
+ T.let(
12513
+ :duplication,
12514
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12515
+ )
12516
+
12517
+ # The transfer amount was incorrect. Corresponds to the FedNow reason code `AM09`.
12518
+ WRONG_AMOUNT =
12519
+ T.let(
12520
+ :wrong_amount,
12521
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12522
+ )
12523
+
12524
+ # The transfer was returned at the request of the recipient's customer. Corresponds to the FedNow reason code `CUST`.
12525
+ REQUESTED_BY_CUSTOMER =
12526
+ T.let(
12527
+ :requested_by_customer,
12528
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12529
+ )
12530
+
12531
+ # The recipient's bank could not apply the funds. Corresponds to the FedNow reason code `RUTA`.
12532
+ UNABLE_TO_APPLY =
12533
+ T.let(
12534
+ :unable_to_apply,
12535
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12536
+ )
12537
+
12538
+ # The recipient's bank did not specify a reason. Corresponds to the FedNow reason codes `MS02` and `MS03`.
12539
+ NOT_SPECIFIED =
12540
+ T.let(
12541
+ :not_specified,
12542
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12543
+ )
12544
+
12545
+ # The reason is provided as narrative information in the additional information field. Corresponds to the FedNow reason code `NARR`.
12546
+ NARRATIVE =
12547
+ T.let(
12548
+ :narrative,
12549
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12550
+ )
12551
+
12552
+ # The transfer was returned for some other reason.
12553
+ OTHER =
12554
+ T.let(
12555
+ :other,
12556
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12557
+ )
12558
+
12559
+ sig do
12560
+ override.returns(
12561
+ T::Array[
12562
+ Increase::Transaction::Source::FednowTransferReturn::ReturnReasonCode::TaggedSymbol
12563
+ ]
12564
+ )
12565
+ end
12566
+ def self.values
12567
+ end
12568
+ end
12569
+ end
12570
+
12327
12571
  class FeePayment < Increase::Internal::Type::BaseModel
12328
12572
  OrHash =
12329
12573
  T.type_alias do
@@ -12824,7 +13068,7 @@ module Increase
12824
13068
  # An Inbound Check Adjustment object. This field will be present in the JSON
12825
13069
  # response if and only if `category` is equal to `inbound_check_adjustment`. An
12826
13070
  # Inbound Check Adjustment is created when Increase receives an adjustment for a
12827
- # check or return deposited through Check21.
13071
+ # check or return deposited through Check 21.
12828
13072
  sig do
12829
13073
  params(
12830
13074
  adjusted_transaction_id: String,
@@ -13352,7 +13596,7 @@ module Increase
13352
13596
  sig { returns(T.nilable(String)) }
13353
13597
  attr_accessor :input_message_accountability_data
13354
13598
 
13355
- # The American Banking Association (ABA) routing number of the bank that sent the
13599
+ # The American Bankers' Association (ABA) routing number of the bank that sent the
13356
13600
  # wire.
13357
13601
  sig { returns(T.nilable(String)) }
13358
13602
  attr_accessor :instructing_agent_routing_number
@@ -13432,7 +13676,7 @@ module Increase
13432
13676
  # abbreviated as IMAD. It is created when the wire is submitted to the Fedwire
13433
13677
  # service and is helpful when debugging wires with the originating bank.
13434
13678
  input_message_accountability_data:,
13435
- # The American Banking Association (ABA) routing number of the bank that sent the
13679
+ # The American Bankers' Association (ABA) routing number of the bank that sent the
13436
13680
  # wire.
13437
13681
  instructing_agent_routing_number:,
13438
13682
  # The sending bank's identifier for the wire transfer.
@@ -275,6 +275,13 @@ module Increase
275
275
  Increase::TransactionListParams::Category::In::TaggedSymbol
276
276
  )
277
277
 
278
+ # FedNow Transfer Return: details will be under the `fednow_transfer_return` object.
279
+ FEDNOW_TRANSFER_RETURN =
280
+ T.let(
281
+ :fednow_transfer_return,
282
+ Increase::TransactionListParams::Category::In::TaggedSymbol
283
+ )
284
+
278
285
  # Check Transfer Deposit: details will be under the `check_transfer_deposit` object.
279
286
  CHECK_TRANSFER_DEPOSIT =
280
287
  T.let(
@@ -12,6 +12,11 @@ module Increase
12
12
  sig { returns(String) }
13
13
  attr_accessor :id
14
14
 
15
+ # The Account to which the debtor—the recipient of this request—is being requested
16
+ # to send funds.
17
+ sig { returns(String) }
18
+ attr_accessor :account_id
19
+
15
20
  # The Account Number to which the debtor—the recipient of this request—is being
16
21
  # requested to send funds.
17
22
  sig { returns(String) }
@@ -131,6 +136,7 @@ module Increase
131
136
  sig do
132
137
  params(
133
138
  id: String,
139
+ account_id: String,
134
140
  account_number_id: String,
135
141
  amount: Integer,
136
142
  created_at: Time,
@@ -157,6 +163,9 @@ module Increase
157
163
  def self.new(
158
164
  # The Wire drawdown request identifier.
159
165
  id:,
166
+ # The Account to which the debtor—the recipient of this request—is being requested
167
+ # to send funds.
168
+ account_id:,
160
169
  # The Account Number to which the debtor—the recipient of this request—is being
161
170
  # requested to send funds.
162
171
  account_number_id:,
@@ -213,6 +222,7 @@ module Increase
213
222
  override.returns(
214
223
  {
215
224
  id: String,
225
+ account_id: String,
216
226
  account_number_id: String,
217
227
  amount: Integer,
218
228
  created_at: Time,