increase 1.338.0 → 1.340.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 (109) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/models/account_create_params.rb +4 -3
  4. data/lib/increase/models/ach_transfer.rb +19 -18
  5. data/lib/increase/models/ach_transfer_create_params.rb +48 -36
  6. data/lib/increase/models/ach_transfer_list_params.rb +1 -1
  7. data/lib/increase/models/beneficial_owner_create_params.rb +5 -3
  8. data/lib/increase/models/beneficial_owner_update_params.rb +2 -1
  9. data/lib/increase/models/card_push_transfer.rb +3 -3
  10. data/lib/increase/models/card_push_transfer_list_params.rb +3 -3
  11. data/lib/increase/models/check_transfer.rb +8 -2
  12. data/lib/increase/models/check_transfer_list_params.rb +3 -0
  13. data/lib/increase/models/entity.rb +8 -6
  14. data/lib/increase/models/entity_create_params.rb +19 -10
  15. data/lib/increase/models/entity_supplemental_document.rb +1 -1
  16. data/lib/increase/models/entity_update_params.rb +5 -4
  17. data/lib/increase/models/fednow_transfer.rb +3 -3
  18. data/lib/increase/models/fednow_transfer_list_params.rb +3 -3
  19. data/lib/increase/models/inbound_mail_item.rb +3 -1
  20. data/lib/increase/models/inbound_real_time_payments_transfer.rb +1 -1
  21. data/lib/increase/models/lockbox_address.rb +5 -1
  22. data/lib/increase/models/lockbox_recipient_create_params.rb +3 -2
  23. data/lib/increase/models/pending_transaction.rb +5 -2
  24. data/lib/increase/models/pending_transaction_list_params.rb +1 -1
  25. data/lib/increase/models/physical_card.rb +5 -2
  26. data/lib/increase/models/real_time_payments_transfer.rb +3 -3
  27. data/lib/increase/models/real_time_payments_transfer_list_params.rb +3 -3
  28. data/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb +3 -2
  29. data/lib/increase/models/simulations/inbound_mail_item_create_params.rb +6 -4
  30. data/lib/increase/models/simulations/physical_card_create_params.rb +5 -2
  31. data/lib/increase/models/swift_transfer.rb +3 -3
  32. data/lib/increase/models/swift_transfer_list_params.rb +3 -3
  33. data/lib/increase/models/transaction.rb +7 -4
  34. data/lib/increase/models/wire_transfer.rb +3 -3
  35. data/lib/increase/models/wire_transfer_list_params.rb +3 -3
  36. data/lib/increase/resources/accounts.rb +1 -1
  37. data/lib/increase/resources/ach_transfers.rb +10 -10
  38. data/lib/increase/resources/beneficial_owners.rb +1 -1
  39. data/lib/increase/resources/inbound_mail_items.rb +3 -1
  40. data/lib/increase/resources/lockbox_addresses.rb +4 -1
  41. data/lib/increase/resources/lockbox_recipients.rb +1 -1
  42. data/lib/increase/resources/simulations/card_authorizations.rb +4 -1
  43. data/lib/increase/resources/simulations/inbound_ach_transfers.rb +1 -1
  44. data/lib/increase/resources/simulations/inbound_mail_items.rb +6 -3
  45. data/lib/increase/version.rb +1 -1
  46. data/rbi/increase/models/account_create_params.rbi +6 -4
  47. data/rbi/increase/models/ach_transfer.rbi +22 -19
  48. data/rbi/increase/models/ach_transfer_create_params.rbi +67 -45
  49. data/rbi/increase/models/ach_transfer_list_params.rbi +1 -1
  50. data/rbi/increase/models/beneficial_owner_create_params.rbi +8 -4
  51. data/rbi/increase/models/beneficial_owner_update_params.rbi +4 -2
  52. data/rbi/increase/models/card_push_transfer.rbi +7 -7
  53. data/rbi/increase/models/card_push_transfer_list_params.rbi +7 -7
  54. data/rbi/increase/models/check_transfer.rbi +16 -2
  55. data/rbi/increase/models/check_transfer_list_params.rbi +7 -0
  56. data/rbi/increase/models/entity.rbi +9 -6
  57. data/rbi/increase/models/entity_create_params.rbi +34 -17
  58. data/rbi/increase/models/entity_supplemental_document.rbi +1 -1
  59. data/rbi/increase/models/entity_update_params.rbi +8 -6
  60. data/rbi/increase/models/fednow_transfer.rbi +7 -7
  61. data/rbi/increase/models/fednow_transfer_list_params.rbi +7 -7
  62. data/rbi/increase/models/inbound_mail_item.rbi +3 -1
  63. data/rbi/increase/models/inbound_real_time_payments_transfer.rbi +1 -1
  64. data/rbi/increase/models/lockbox_address.rbi +5 -1
  65. data/rbi/increase/models/lockbox_recipient_create_params.rbi +4 -2
  66. data/rbi/increase/models/pending_transaction.rbi +9 -3
  67. data/rbi/increase/models/pending_transaction_list_params.rbi +1 -1
  68. data/rbi/increase/models/physical_card.rbi +9 -2
  69. data/rbi/increase/models/real_time_payments_transfer.rbi +7 -7
  70. data/rbi/increase/models/real_time_payments_transfer_list_params.rbi +7 -7
  71. data/rbi/increase/models/simulations/inbound_ach_transfer_create_params.rbi +4 -2
  72. data/rbi/increase/models/simulations/inbound_mail_item_create_params.rbi +8 -4
  73. data/rbi/increase/models/simulations/physical_card_create_params.rbi +9 -2
  74. data/rbi/increase/models/swift_transfer.rbi +7 -7
  75. data/rbi/increase/models/swift_transfer_list_params.rbi +7 -7
  76. data/rbi/increase/models/transaction.rbi +10 -5
  77. data/rbi/increase/models/wire_transfer.rbi +4 -4
  78. data/rbi/increase/models/wire_transfer_list_params.rbi +7 -7
  79. data/rbi/increase/resources/accounts.rbi +3 -2
  80. data/rbi/increase/resources/ach_transfers.rbi +29 -19
  81. data/rbi/increase/resources/beneficial_owners.rbi +2 -1
  82. data/rbi/increase/resources/inbound_mail_items.rbi +3 -1
  83. data/rbi/increase/resources/lockbox_addresses.rbi +4 -1
  84. data/rbi/increase/resources/lockbox_recipients.rbi +2 -1
  85. data/rbi/increase/resources/simulations/card_authorizations.rbi +4 -1
  86. data/rbi/increase/resources/simulations/inbound_ach_transfers.rbi +2 -1
  87. data/rbi/increase/resources/simulations/inbound_mail_items.rbi +8 -3
  88. data/sig/increase/models/ach_transfer.rbs +2 -2
  89. data/sig/increase/models/ach_transfer_create_params.rbs +1 -1
  90. data/sig/increase/models/ach_transfer_list_params.rbs +1 -1
  91. data/sig/increase/models/card_push_transfer.rbs +4 -4
  92. data/sig/increase/models/card_push_transfer_list_params.rbs +4 -4
  93. data/sig/increase/models/check_transfer.rbs +10 -2
  94. data/sig/increase/models/check_transfer_list_params.rbs +4 -0
  95. data/sig/increase/models/fednow_transfer.rbs +5 -5
  96. data/sig/increase/models/fednow_transfer_list_params.rbs +5 -5
  97. data/sig/increase/models/inbound_real_time_payments_transfer.rbs +1 -1
  98. data/sig/increase/models/pending_transaction.rbs +1 -1
  99. data/sig/increase/models/pending_transaction_list_params.rbs +1 -1
  100. data/sig/increase/models/physical_card.rbs +6 -2
  101. data/sig/increase/models/real_time_payments_transfer.rbs +4 -4
  102. data/sig/increase/models/real_time_payments_transfer_list_params.rbs +4 -4
  103. data/sig/increase/models/simulations/physical_card_create_params.rbs +6 -2
  104. data/sig/increase/models/swift_transfer.rbs +4 -4
  105. data/sig/increase/models/swift_transfer_list_params.rbs +4 -4
  106. data/sig/increase/models/wire_transfer.rbs +4 -4
  107. data/sig/increase/models/wire_transfer_list_params.rbs +4 -4
  108. metadata +2 -3
  109. data/CHANGELOG.md +0 -4541
@@ -8,7 +8,10 @@ module Increase
8
8
  # {Increase::Models::Simulations::InboundMailItemCreateParams} for more details.
9
9
  #
10
10
  # Simulates an Inbound Mail Item to one of your Lockbox Addresses or Lockbox
11
- # Recipients, as if someone had mailed a physical check.
11
+ # Recipients, as if someone had mailed a physical check. Increase automatically
12
+ # deposits a check mailed to a Lockbox Recipient into the recipient's Account. A
13
+ # check mailed to a Lockbox Address must be deposited or ignored with the
14
+ # [Action an Inbound Mail Item](#inbound-mail-items) endpoint.
12
15
  #
13
16
  # @overload create(amount:, contents_file_id: nil, lockbox_address_id: nil, lockbox_recipient_id: nil, request_options: {})
14
17
  #
@@ -16,9 +19,9 @@ module Increase
16
19
  #
17
20
  # @param contents_file_id [String] The file containing the PDF contents. If not present, a default check image file
18
21
  #
19
- # @param lockbox_address_id [String] The identifier of the Lockbox Address to simulate inbound mail to.
22
+ # @param lockbox_address_id [String] The identifier of the Lockbox Address to simulate inbound mail to. Exactly one l
20
23
  #
21
- # @param lockbox_recipient_id [String] The identifier of the Lockbox Recipient to simulate inbound mail to.
24
+ # @param lockbox_recipient_id [String] The identifier of the Lockbox Recipient to simulate inbound mail to. Exactly one
22
25
  #
23
26
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
24
27
  #
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.338.0"
4
+ VERSION = "1.340.0"
5
5
  end
@@ -48,8 +48,9 @@ module Increase
48
48
  sig { params(loan: Increase::AccountCreateParams::Loan::OrHash).void }
49
49
  attr_writer :loan
50
50
 
51
- # The identifier for the Program that this Account falls under. Required if you
52
- # operate more than one Program.
51
+ # The identifier for the Program that this Account falls under. Required if your
52
+ # Group operates more than one Program. List your [Programs](#programs) to find
53
+ # their identifiers.
53
54
  sig { returns(T.nilable(String)) }
54
55
  attr_reader :program_id
55
56
 
@@ -79,8 +80,9 @@ module Increase
79
80
  informational_entity_id: nil,
80
81
  # The loan details for the account.
81
82
  loan: nil,
82
- # The identifier for the Program that this Account falls under. Required if you
83
- # operate more than one Program.
83
+ # The identifier for the Program that this Account falls under. Required if your
84
+ # Group operates more than one Program. List your [Programs](#programs) to find
85
+ # their identifiers.
84
86
  program_id: nil,
85
87
  request_options: {}
86
88
  )
@@ -16,7 +16,7 @@ module Increase
16
16
  sig { returns(String) }
17
17
  attr_accessor :account_id
18
18
 
19
- # The destination account number.
19
+ # The receiver's account number.
20
20
  sig { returns(String) }
21
21
  attr_accessor :account_number
22
22
 
@@ -114,8 +114,7 @@ module Increase
114
114
  sig { returns(Increase::ACHTransfer::Currency::TaggedSymbol) }
115
115
  attr_accessor :currency
116
116
 
117
- # The type of entity that owns the account to which the ACH Transfer is being
118
- # sent.
117
+ # The type of entity that owns the receiver's account.
119
118
  sig do
120
119
  returns(Increase::ACHTransfer::DestinationAccountHolder::TaggedSymbol)
121
120
  end
@@ -125,7 +124,7 @@ module Increase
125
124
  sig { returns(T.nilable(String)) }
126
125
  attr_accessor :external_account_id
127
126
 
128
- # The type of the account to which the transfer will be sent.
127
+ # The type of the receiver's bank account.
129
128
  sig { returns(Increase::ACHTransfer::Funding::TaggedSymbol) }
130
129
  attr_accessor :funding
131
130
 
@@ -148,7 +147,8 @@ module Increase
148
147
  end
149
148
  attr_writer :inbound_funds_hold
150
149
 
151
- # Your identifier for the transfer recipient.
150
+ # Your internal identifier for the transfer recipient. This value is informational
151
+ # and not verified by the recipient's bank.
152
152
  sig { returns(T.nilable(String)) }
153
153
  attr_accessor :individual_id
154
154
 
@@ -197,7 +197,8 @@ module Increase
197
197
  end
198
198
  attr_writer :return_
199
199
 
200
- # The American Bankers' Association (ABA) Routing Transit Number (RTN).
200
+ # The American Bankers' Association (ABA) Routing Transit Number (RTN) of the
201
+ # receiver's bank.
201
202
  sig { returns(String) }
202
203
  attr_accessor :routing_number
203
204
 
@@ -306,7 +307,7 @@ module Increase
306
307
  id:,
307
308
  # The Account to which the transfer belongs.
308
309
  account_id:,
309
- # The destination account number.
310
+ # The receiver's account number.
310
311
  account_number:,
311
312
  # After the transfer is acknowledged by FedACH, this will contain supplemental
312
313
  # details. The Federal Reserve sends an acknowledgement message for each file that
@@ -342,12 +343,11 @@ module Increase
342
343
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
343
344
  # currency. For ACH transfers this is always equal to `usd`.
344
345
  currency:,
345
- # The type of entity that owns the account to which the ACH Transfer is being
346
- # sent.
346
+ # The type of entity that owns the receiver's account.
347
347
  destination_account_holder:,
348
348
  # The identifier of the External Account the transfer was made to, if any.
349
349
  external_account_id:,
350
- # The type of the account to which the transfer will be sent.
350
+ # The type of the receiver's bank account.
351
351
  funding:,
352
352
  # The idempotency key you chose for this object. This value is unique across
353
353
  # Increase and is used to ensure that a request is only processed once. Learn more
@@ -356,7 +356,8 @@ module Increase
356
356
  # Increase will sometimes hold the funds for ACH debit transfers. If funds are
357
357
  # held, this sub-object will contain details of the hold.
358
358
  inbound_funds_hold:,
359
- # Your identifier for the transfer recipient.
359
+ # Your internal identifier for the transfer recipient. This value is informational
360
+ # and not verified by the recipient's bank.
360
361
  individual_id:,
361
362
  # The name of the transfer recipient. This value is informational and not verified
362
363
  # by the recipient's bank.
@@ -378,7 +379,8 @@ module Increase
378
379
  preferred_effective_date:,
379
380
  # If your transfer is returned, this will contain details of the return.
380
381
  return_:,
381
- # The American Bankers' Association (ABA) Routing Transit Number (RTN).
382
+ # The American Bankers' Association (ABA) Routing Transit Number (RTN) of the
383
+ # receiver's bank.
382
384
  routing_number:,
383
385
  # A subhash containing information about when and how the transfer settled at the
384
386
  # Federal Reserve.
@@ -1088,8 +1090,7 @@ module Increase
1088
1090
  end
1089
1091
  end
1090
1092
 
1091
- # The type of entity that owns the account to which the ACH Transfer is being
1092
- # sent.
1093
+ # The type of entity that owns the receiver's account.
1093
1094
  module DestinationAccountHolder
1094
1095
  extend Increase::Internal::Type::Enum
1095
1096
 
@@ -1131,7 +1132,7 @@ module Increase
1131
1132
  end
1132
1133
  end
1133
1134
 
1134
- # The type of the account to which the transfer will be sent.
1135
+ # The type of the receiver's bank account.
1135
1136
  module Funding
1136
1137
  extend Increase::Internal::Type::Enum
1137
1138
 
@@ -1781,7 +1782,7 @@ module Increase
1781
1782
  # The chosen effective date will be the same as the ACH processing date on which the transfer is submitted.
1782
1783
  # This is necessary, but not sufficient for the transfer to be settled same-day:
1783
1784
  # it must also be submitted before the last same-day cutoff
1784
- # and be less than or equal to $1,000.000.00.
1785
+ # and be less than or equal to $1,000,000.00.
1785
1786
  SAME_DAY =
1786
1787
  T.let(
1787
1788
  :same_day,
@@ -1840,7 +1841,8 @@ module Increase
1840
1841
  sig { returns(String) }
1841
1842
  attr_accessor :transaction_id
1842
1843
 
1843
- # The identifier of the ACH Transfer associated with this return.
1844
+ # The identifier of the ACH Transfer associated with this return. This matches the
1845
+ # original Transaction's `source.ach_transfer_intention.transfer_id`.
1844
1846
  sig { returns(String) }
1845
1847
  attr_accessor :transfer_id
1846
1848
 
@@ -1872,7 +1874,8 @@ module Increase
1872
1874
  trace_number:,
1873
1875
  # The identifier of the Transaction associated with this return.
1874
1876
  transaction_id:,
1875
- # The identifier of the ACH Transfer associated with this return.
1877
+ # The identifier of the ACH Transfer associated with this return. This matches the
1878
+ # original Transaction's `source.ach_transfer_intention.transfer_id`.
1876
1879
  transfer_id:
1877
1880
  )
1878
1881
  end
@@ -2529,7 +2532,7 @@ module Increase
2529
2532
  # The transfer has been rejected.
2530
2533
  REJECTED = T.let(:rejected, Increase::ACHTransfer::Status::TaggedSymbol)
2531
2534
 
2532
- # The transfer is complete.
2535
+ # The transfer has been submitted to the Federal Reserve. When the transfer settles, the status remains `submitted` and the `settlement` sub-object is populated.
2533
2536
  SUBMITTED =
2534
2537
  T.let(:submitted, Increase::ACHTransfer::Status::TaggedSymbol)
2535
2538
 
@@ -30,15 +30,19 @@ module Increase
30
30
  sig { returns(String) }
31
31
  attr_accessor :statement_descriptor
32
32
 
33
- # The account number for the destination account.
33
+ # The receiver's account number. For credit transfers (positive `amount`) this is
34
+ # the account that funds will be sent to. For debit transfers (negative `amount`)
35
+ # this is the account that funds will be pulled from.
34
36
  sig { returns(T.nilable(String)) }
35
37
  attr_reader :account_number
36
38
 
37
39
  sig { params(account_number: String).void }
38
40
  attr_writer :account_number
39
41
 
40
- # Additional information that will be sent to the recipient. This is included in
41
- # the transfer data sent to the receiving bank.
42
+ # Additional information passed through to the receiving bank with the transfer.
43
+ # Most ACH transfers do not need this. Only set this if your recipient has asked
44
+ # for addendum data, typically unstructured remittance information. Corporate
45
+ # Trade Exchange (CTX) flows can carry structured X12 remittance advice instead.
42
46
  sig { returns(T.nilable(Increase::ACHTransferCreateParams::Addenda)) }
43
47
  attr_reader :addenda
44
48
 
@@ -47,41 +51,45 @@ module Increase
47
51
  end
48
52
  attr_writer :addenda
49
53
 
50
- # The description of the date of the transfer, usually in the format `YYMMDD`.
51
- # This is included in the transfer data sent to the receiving bank.
54
+ # A description of the transfer date (typically `YYMMDD`), sent in the company
55
+ # batch header. This value is informational and does not affect funds movement,
56
+ # settlement timing, or returns. Only set this if your recipient has asked for it.
52
57
  sig { returns(T.nilable(String)) }
53
58
  attr_reader :company_descriptive_date
54
59
 
55
60
  sig { params(company_descriptive_date: String).void }
56
61
  attr_writer :company_descriptive_date
57
62
 
58
- # The data you choose to associate with the transfer. This is included in the
59
- # transfer data sent to the receiving bank.
63
+ # Custom data sent in the company batch header. This value is informational and
64
+ # does not affect funds movement, settlement timing, or returns. Most ACH
65
+ # transfers do not need this. Only set this if your recipient has asked for it.
60
66
  sig { returns(T.nilable(String)) }
61
67
  attr_reader :company_discretionary_data
62
68
 
63
69
  sig { params(company_discretionary_data: String).void }
64
70
  attr_writer :company_discretionary_data
65
71
 
66
- # A description of the transfer, included in the transfer data sent to the
67
- # receiving bank. Standardized formatting may be required, for example `PAYROLL`
68
- # for payroll-related Prearranged Payments and Deposits (PPD) credit transfers.
72
+ # A short description sent in the company batch header. Most receivers do not
73
+ # surface this. Only set this if your recipient has asked for a specific value or
74
+ # if Nacha mandates one for your Standard Entry Class (SEC) code and use case. For
75
+ # example, Prearranged Payment and Deposit (PPD) payroll credits must use
76
+ # `PAYROLL`, and reversals must use `REVERSAL`.
69
77
  sig { returns(T.nilable(String)) }
70
78
  attr_reader :company_entry_description
71
79
 
72
80
  sig { params(company_entry_description: String).void }
73
81
  attr_writer :company_entry_description
74
82
 
75
- # The name by which the recipient knows you. This is included in the transfer data
76
- # sent to the receiving bank.
83
+ # The name by which the recipient knows you, sent in the company batch header. We
84
+ # recommend setting this on every transfer; if you do not, we fall back to the ACH
85
+ # company name configured on your account.
77
86
  sig { returns(T.nilable(String)) }
78
87
  attr_reader :company_name
79
88
 
80
89
  sig { params(company_name: String).void }
81
90
  attr_writer :company_name
82
91
 
83
- # The type of entity that owns the account to which the ACH Transfer is being
84
- # sent.
92
+ # The type of entity that owns the receiver's account.
85
93
  sig do
86
94
  returns(
87
95
  T.nilable(
@@ -107,7 +115,7 @@ module Increase
107
115
  sig { params(external_account_id: String).void }
108
116
  attr_writer :external_account_id
109
117
 
110
- # The type of the account to which the transfer will be sent.
118
+ # The type of the receiver's bank account.
111
119
  sig do
112
120
  returns(T.nilable(Increase::ACHTransferCreateParams::Funding::OrSymbol))
113
121
  end
@@ -120,7 +128,8 @@ module Increase
120
128
  end
121
129
  attr_writer :funding
122
130
 
123
- # Your identifier for the transfer recipient.
131
+ # Your internal identifier for the transfer recipient. This value is informational
132
+ # and not verified by the recipient's bank. Most callers can leave this unset.
124
133
  sig { returns(T.nilable(String)) }
125
134
  attr_reader :individual_id
126
135
 
@@ -161,8 +170,8 @@ module Increase
161
170
  sig { params(require_approval: T::Boolean).void }
162
171
  attr_writer :require_approval
163
172
 
164
- # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
165
- # destination account.
173
+ # The American Bankers' Association (ABA) Routing Transit Number (RTN) of the
174
+ # receiver's bank.
166
175
  sig { returns(T.nilable(String)) }
167
176
  attr_reader :routing_number
168
177
 
@@ -171,7 +180,8 @@ module Increase
171
180
 
172
181
  # The
173
182
  # [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
174
- # to use for the transfer.
183
+ # to use for the transfer. If not provided, the default is
184
+ # `corporate_credit_or_debit`.
175
185
  sig do
176
186
  returns(
177
187
  T.nilable(
@@ -249,33 +259,42 @@ module Increase
249
259
  # help the customer recognize the transfer. You are highly encouraged to pass
250
260
  # `individual_name` and `company_name` instead of relying on this fallback.
251
261
  statement_descriptor:,
252
- # The account number for the destination account.
262
+ # The receiver's account number. For credit transfers (positive `amount`) this is
263
+ # the account that funds will be sent to. For debit transfers (negative `amount`)
264
+ # this is the account that funds will be pulled from.
253
265
  account_number: nil,
254
- # Additional information that will be sent to the recipient. This is included in
255
- # the transfer data sent to the receiving bank.
266
+ # Additional information passed through to the receiving bank with the transfer.
267
+ # Most ACH transfers do not need this. Only set this if your recipient has asked
268
+ # for addendum data, typically unstructured remittance information. Corporate
269
+ # Trade Exchange (CTX) flows can carry structured X12 remittance advice instead.
256
270
  addenda: nil,
257
- # The description of the date of the transfer, usually in the format `YYMMDD`.
258
- # This is included in the transfer data sent to the receiving bank.
271
+ # A description of the transfer date (typically `YYMMDD`), sent in the company
272
+ # batch header. This value is informational and does not affect funds movement,
273
+ # settlement timing, or returns. Only set this if your recipient has asked for it.
259
274
  company_descriptive_date: nil,
260
- # The data you choose to associate with the transfer. This is included in the
261
- # transfer data sent to the receiving bank.
275
+ # Custom data sent in the company batch header. This value is informational and
276
+ # does not affect funds movement, settlement timing, or returns. Most ACH
277
+ # transfers do not need this. Only set this if your recipient has asked for it.
262
278
  company_discretionary_data: nil,
263
- # A description of the transfer, included in the transfer data sent to the
264
- # receiving bank. Standardized formatting may be required, for example `PAYROLL`
265
- # for payroll-related Prearranged Payments and Deposits (PPD) credit transfers.
279
+ # A short description sent in the company batch header. Most receivers do not
280
+ # surface this. Only set this if your recipient has asked for a specific value or
281
+ # if Nacha mandates one for your Standard Entry Class (SEC) code and use case. For
282
+ # example, Prearranged Payment and Deposit (PPD) payroll credits must use
283
+ # `PAYROLL`, and reversals must use `REVERSAL`.
266
284
  company_entry_description: nil,
267
- # The name by which the recipient knows you. This is included in the transfer data
268
- # sent to the receiving bank.
285
+ # The name by which the recipient knows you, sent in the company batch header. We
286
+ # recommend setting this on every transfer; if you do not, we fall back to the ACH
287
+ # company name configured on your account.
269
288
  company_name: nil,
270
- # The type of entity that owns the account to which the ACH Transfer is being
271
- # sent.
289
+ # The type of entity that owns the receiver's account.
272
290
  destination_account_holder: nil,
273
291
  # The ID of an External Account to initiate a transfer to. If this parameter is
274
292
  # provided, `account_number`, `routing_number`, and `funding` must be absent.
275
293
  external_account_id: nil,
276
- # The type of the account to which the transfer will be sent.
294
+ # The type of the receiver's bank account.
277
295
  funding: nil,
278
- # Your identifier for the transfer recipient.
296
+ # Your internal identifier for the transfer recipient. This value is informational
297
+ # and not verified by the recipient's bank. Most callers can leave this unset.
279
298
  individual_id: nil,
280
299
  # The name of the transfer recipient. This value is informational and not verified
281
300
  # by the recipient's bank.
@@ -287,12 +306,13 @@ module Increase
287
306
  preferred_effective_date: nil,
288
307
  # Whether the transfer requires explicit approval via the dashboard or API.
289
308
  require_approval: nil,
290
- # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
291
- # destination account.
309
+ # The American Bankers' Association (ABA) Routing Transit Number (RTN) of the
310
+ # receiver's bank.
292
311
  routing_number: nil,
293
312
  # The
294
313
  # [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
295
- # to use for the transfer.
314
+ # to use for the transfer. If not provided, the default is
315
+ # `corporate_credit_or_debit`.
296
316
  standard_entry_class_code: nil,
297
317
  # The timing of the transaction.
298
318
  transaction_timing: nil,
@@ -387,8 +407,10 @@ module Increase
387
407
  end
388
408
  attr_writer :payment_order_remittance_advice
389
409
 
390
- # Additional information that will be sent to the recipient. This is included in
391
- # the transfer data sent to the receiving bank.
410
+ # Additional information passed through to the receiving bank with the transfer.
411
+ # Most ACH transfers do not need this. Only set this if your recipient has asked
412
+ # for addendum data, typically unstructured remittance information. Corporate
413
+ # Trade Exchange (CTX) flows can carry structured X12 remittance advice instead.
392
414
  sig do
393
415
  params(
394
416
  category:
@@ -636,8 +658,7 @@ module Increase
636
658
  end
637
659
  end
638
660
 
639
- # The type of entity that owns the account to which the ACH Transfer is being
640
- # sent.
661
+ # The type of entity that owns the receiver's account.
641
662
  module DestinationAccountHolder
642
663
  extend Increase::Internal::Type::Enum
643
664
 
@@ -682,7 +703,7 @@ module Increase
682
703
  end
683
704
  end
684
705
 
685
- # The type of the account to which the transfer will be sent.
706
+ # The type of the receiver's bank account.
686
707
  module Funding
687
708
  extend Increase::Internal::Type::Enum
688
709
 
@@ -806,7 +827,7 @@ module Increase
806
827
  end
807
828
  OrSymbol = T.type_alias { T.any(Symbol, String) }
808
829
 
809
- # The chosen effective date will be the same as the ACH processing date on which the transfer is submitted. This is necessary, but not sufficient for the transfer to be settled same-day: it must also be submitted before the last same-day cutoff and be less than or equal to $1,000.000.00.
830
+ # The chosen effective date will be the same as the ACH processing date on which the transfer is submitted. This is necessary, but not sufficient for the transfer to be settled same-day: it must also be submitted before the last same-day cutoff and be less than or equal to $1,000,000.00.
810
831
  SAME_DAY =
811
832
  T.let(
812
833
  :same_day,
@@ -834,7 +855,8 @@ module Increase
834
855
 
835
856
  # The
836
857
  # [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
837
- # to use for the transfer.
858
+ # to use for the transfer. If not provided, the default is
859
+ # `corporate_credit_or_debit`.
838
860
  module StandardEntryClassCode
839
861
  extend Increase::Internal::Type::Enum
840
862
 
@@ -300,7 +300,7 @@ module Increase
300
300
  Increase::ACHTransferListParams::Status::In::TaggedSymbol
301
301
  )
302
302
 
303
- # The transfer is complete.
303
+ # The transfer has been submitted to the Federal Reserve. When the transfer settles, the status remains `submitted` and the `settlement` sub-object is populated.
304
304
  SUBMITTED =
305
305
  T.let(
306
306
  :submitted,
@@ -14,7 +14,8 @@ module Increase
14
14
  )
15
15
  end
16
16
 
17
- # The identifier of the Entity to associate with the new Beneficial Owner.
17
+ # The identifier of the Entity to associate with the new Beneficial Owner. Only
18
+ # `corporation` entities have beneficial owners.
18
19
  sig { returns(String) }
19
20
  attr_accessor :entity_id
20
21
 
@@ -57,7 +58,8 @@ module Increase
57
58
  ).returns(T.attached_class)
58
59
  end
59
60
  def self.new(
60
- # The identifier of the Entity to associate with the new Beneficial Owner.
61
+ # The identifier of the Entity to associate with the new Beneficial Owner. Only
62
+ # `corporation` entities have beneficial owners.
61
63
  entity_id:,
62
64
  # Personal details for the beneficial owner.
63
65
  individual:,
@@ -298,7 +300,8 @@ module Increase
298
300
  # An identification number that can be used to verify the individual's identity,
299
301
  # such as a social security number. For Social Security Numbers and Individual
300
302
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
301
- # separators.
303
+ # separators. When testing in sandbox, use one of our
304
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
302
305
  sig { returns(String) }
303
306
  attr_accessor :number
304
307
 
@@ -379,7 +382,8 @@ module Increase
379
382
  # An identification number that can be used to verify the individual's identity,
380
383
  # such as a social security number. For Social Security Numbers and Individual
381
384
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
382
- # separators.
385
+ # separators. When testing in sandbox, use one of our
386
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
383
387
  number:,
384
388
  # Information about the United States driver's license used for identification.
385
389
  # Required if `method` is equal to `drivers_license`.
@@ -247,7 +247,8 @@ module Increase
247
247
  # An identification number that can be used to verify the individual's identity,
248
248
  # such as a social security number. For Social Security Numbers and Individual
249
249
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
250
- # separators.
250
+ # separators. When testing in sandbox, use one of our
251
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
251
252
  sig { returns(String) }
252
253
  attr_accessor :number
253
254
 
@@ -328,7 +329,8 @@ module Increase
328
329
  # An identification number that can be used to verify the individual's identity,
329
330
  # such as a social security number. For Social Security Numbers and Individual
330
331
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
331
- # separators.
332
+ # separators. When testing in sandbox, use one of our
333
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
332
334
  number:,
333
335
  # Information about the United States driver's license used for identification.
334
336
  # Required if `method` is equal to `drivers_license`.
@@ -2725,6 +2725,13 @@ module Increase
2725
2725
  CANCELED =
2726
2726
  T.let(:canceled, Increase::CardPushTransfer::Status::TaggedSymbol)
2727
2727
 
2728
+ # The transfer is queued to be submitted to the card network.
2729
+ PENDING_SUBMISSION =
2730
+ T.let(
2731
+ :pending_submission,
2732
+ Increase::CardPushTransfer::Status::TaggedSymbol
2733
+ )
2734
+
2728
2735
  # The transfer is pending review by Increase.
2729
2736
  PENDING_REVIEWING =
2730
2737
  T.let(
@@ -2739,13 +2746,6 @@ module Increase
2739
2746
  Increase::CardPushTransfer::Status::TaggedSymbol
2740
2747
  )
2741
2748
 
2742
- # The transfer is queued to be submitted to the card network.
2743
- PENDING_SUBMISSION =
2744
- T.let(
2745
- :pending_submission,
2746
- Increase::CardPushTransfer::Status::TaggedSymbol
2747
- )
2748
-
2749
2749
  # The transfer has been submitted and is pending a response from the card network.
2750
2750
  SUBMITTED =
2751
2751
  T.let(:submitted, Increase::CardPushTransfer::Status::TaggedSymbol)
@@ -271,6 +271,13 @@ module Increase
271
271
  Increase::CardPushTransferListParams::Status::In::TaggedSymbol
272
272
  )
273
273
 
274
+ # The transfer is queued to be submitted to the card network.
275
+ PENDING_SUBMISSION =
276
+ T.let(
277
+ :pending_submission,
278
+ Increase::CardPushTransferListParams::Status::In::TaggedSymbol
279
+ )
280
+
274
281
  # The transfer is pending review by Increase.
275
282
  PENDING_REVIEWING =
276
283
  T.let(
@@ -285,13 +292,6 @@ module Increase
285
292
  Increase::CardPushTransferListParams::Status::In::TaggedSymbol
286
293
  )
287
294
 
288
- # The transfer is queued to be submitted to the card network.
289
- PENDING_SUBMISSION =
290
- T.let(
291
- :pending_submission,
292
- Increase::CardPushTransferListParams::Status::In::TaggedSymbol
293
- )
294
-
295
295
  # The transfer has been submitted and is pending a response from the card network.
296
296
  SUBMITTED =
297
297
  T.let(
@@ -1296,14 +1296,21 @@ module Increase
1296
1296
  Increase::CheckTransfer::PhysicalCheck::TrackingUpdate::Category::TaggedSymbol
1297
1297
  )
1298
1298
 
1299
- # There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the check will be returned to sender.
1299
+ # There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the check will be rerouted to the return address.
1300
1300
  DELIVERY_ISSUE =
1301
1301
  T.let(
1302
1302
  :delivery_issue,
1303
1303
  Increase::CheckTransfer::PhysicalCheck::TrackingUpdate::Category::TaggedSymbol
1304
1304
  )
1305
1305
 
1306
- # Delivery failed and the check was returned to sender.
1306
+ # The check has been rerouted to the return address.
1307
+ RETURNING_TO_SENDER =
1308
+ T.let(
1309
+ :returning_to_sender,
1310
+ Increase::CheckTransfer::PhysicalCheck::TrackingUpdate::Category::TaggedSymbol
1311
+ )
1312
+
1313
+ # The check has been delivered to the return address.
1307
1314
  RETURNED_TO_SENDER =
1308
1315
  T.let(
1309
1316
  :returned_to_sender,
@@ -1349,6 +1356,13 @@ module Increase
1349
1356
  Increase::CheckTransfer::Status::TaggedSymbol
1350
1357
  )
1351
1358
 
1359
+ # The transfer is pending review by Increase.
1360
+ PENDING_REVIEWING =
1361
+ T.let(
1362
+ :pending_reviewing,
1363
+ Increase::CheckTransfer::Status::TaggedSymbol
1364
+ )
1365
+
1352
1366
  # The transfer requires attention from an Increase operator.
1353
1367
  REQUIRES_ATTENTION =
1354
1368
  T.let(
@@ -267,6 +267,13 @@ module Increase
267
267
  Increase::CheckTransferListParams::Status::In::TaggedSymbol
268
268
  )
269
269
 
270
+ # The transfer is pending review by Increase.
271
+ PENDING_REVIEWING =
272
+ T.let(
273
+ :pending_reviewing,
274
+ Increase::CheckTransferListParams::Status::In::TaggedSymbol
275
+ )
276
+
270
277
  # The transfer requires attention from an Increase operator.
271
278
  REQUIRES_ATTENTION =
272
279
  T.let(