increase 1.364.0 → 1.365.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 222a3a474a6fabf7445abcecbbe300845db445bc0d08b3bc399596cc760f24af
4
- data.tar.gz: 10425bbfc0580d4df9cacbe14d13fe6122cbca7f84786c4eaad54ece99260d5f
3
+ metadata.gz: ae30bf0558ef4dcd7f6c606fa989019600d19712f54440b0d03342e9cac5713b
4
+ data.tar.gz: 58ee46d1a2797d8baa5761e5ef95b5a08d57f3eff4fdcfe0e7878d73c6f38419
5
5
  SHA512:
6
- metadata.gz: 1a92736d94243d471c75cd7d4e0fb50294474808b2d69f09f746920916f9d05b0655404f50b1c0a0c311c61aa315c2586e81ea552e958063191c5524e25047dd
7
- data.tar.gz: d5cf59099d458e204f9942bfd3c4b05cd69ea5e494cb1e624dd7c0c376cdca60df686f89893fd525906b830e2c82f16ef1328099ddf736d098b35832aa08072c
6
+ metadata.gz: bcbe7bc136e89b0edb416519fcc4c0a7f76bc5f6fb07304d46f8ed6d1218a22c4ba84e66d614d14b3a30df9b17b26b735bc95ce6b0a1efaec1c97689c23f8567
7
+ data.tar.gz: 34364314be2e3ae7edaaabc5dcb19ded77072920dc628e28eb9a3a03c606cc953981f456c188b2ae068f6101ed502c78bccceb5145311d947f131ff1633e239c
data/README.md CHANGED
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "increase", "~> 1.364.0"
18
+ gem "increase", "~> 1.365.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -223,7 +223,10 @@ module Increase
223
223
  required :standard_entry_class_code, enum: -> { Increase::ACHTransfer::StandardEntryClassCode }
224
224
 
225
225
  # @!attribute statement_descriptor
226
- # The descriptor that will show on the recipient's bank statement.
226
+ # A description you chose to give the transfer. If `individual_name` and
227
+ # `company_name` were not explicitly set, the `statement_descriptor` will be sent
228
+ # in those fields to the receiving bank to help the customer recognize the
229
+ # transfer.
227
230
  #
228
231
  # @return [String, nil]
229
232
  required :statement_descriptor, String, nil?: true
@@ -379,7 +382,11 @@ module Increase
379
382
  # [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
380
383
  # to use for the transfer.
381
384
  #
382
- # @param statement_descriptor [String, nil] The descriptor that will show on the recipient's bank statement.
385
+ # @param statement_descriptor [String, nil]
386
+ # A description you chose to give the transfer. If `individual_name` and
387
+ # `company_name` were not explicitly set, the `statement_descriptor` will be sent
388
+ # in those fields to the receiving bank to help the customer recognize the
389
+ # transfer.
383
390
  #
384
391
  # @param status [Symbol, Increase::Models::ACHTransfer::Status] The lifecycle status of the transfer.
385
392
  #
@@ -26,16 +26,25 @@ module Increase
26
26
  # @return [Integer]
27
27
  required :amount, Integer
28
28
 
29
- # @!attribute statement_descriptor
30
- # A description you choose to give the transfer. This will be saved with the
31
- # transfer details, displayed in the dashboard, and returned by the API. If
32
- # `individual_name` and `company_name` are not explicitly set by this API, the
33
- # `statement_descriptor` will be sent in those fields to the receiving bank to
34
- # help the customer recognize the transfer. You are highly encouraged to pass
35
- # `individual_name` and `company_name` instead of relying on this fallback.
29
+ # @!attribute company_name
30
+ # The name by which the recipient knows the counterparty of this transaction. If
31
+ # you're processing payments on behalf of another party, use their name, not your
32
+ # own, so that it's more likely the recipient understands the context of the
33
+ # payment. This value is usually displayed to the recipient on their bank
34
+ # statement. We recommend setting this on every transfer; if you do not, we fall
35
+ # back to the `statement_descriptor`.
36
+ #
37
+ # @return [String]
38
+ required :company_name, String
39
+
40
+ # @!attribute individual_name
41
+ # The name of the transfer recipient. This value is informational and generally
42
+ # not verified by the recipient's bank. This value is usually displayed to the
43
+ # recipient on their bank statement. We recommend setting this on every transfer;
44
+ # if you do not, we fall back to the `statement_descriptor`.
36
45
  #
37
46
  # @return [String]
38
- required :statement_descriptor, String
47
+ required :individual_name, String
39
48
 
40
49
  # @!attribute account_number
41
50
  # The receiver's account number. For credit transfers (transfers with a positive
@@ -83,17 +92,6 @@ module Increase
83
92
  # @return [String, nil]
84
93
  optional :company_entry_description, String
85
94
 
86
- # @!attribute company_name
87
- # The name by which the recipient knows the counterparty of this transaction. If
88
- # you're processing payments on behalf of another party, use their name, not your
89
- # own, so that it's more likely the recipient understands the context of the
90
- # payment. This value is usually displayed to the recipient on their bank
91
- # statement. We recommend setting this on every transfer; if you do not, we fall
92
- # back to the `statement_descriptor`.
93
- #
94
- # @return [String, nil]
95
- optional :company_name, String
96
-
97
95
  # @!attribute destination_account_holder
98
96
  # The type of entity that owns the receiver's account.
99
97
  #
@@ -125,15 +123,6 @@ module Increase
125
123
  # @return [String, nil]
126
124
  optional :individual_id, String
127
125
 
128
- # @!attribute individual_name
129
- # The name of the transfer recipient. This value is informational and generally
130
- # not verified by the recipient's bank. This value is usually displayed to the
131
- # recipient on their bank statement. We recommend setting this on every transfer;
132
- # if you do not, we fall back to the `statement_descriptor`.
133
- #
134
- # @return [String, nil]
135
- optional :individual_name, String
136
-
137
126
  # @!attribute preferred_effective_date
138
127
  # Configuration for how the effective date of the transfer will be set. This
139
128
  # determines same-day vs future-dated settlement timing. If not set, defaults to a
@@ -166,7 +155,7 @@ module Increase
166
155
  optional :standard_entry_class_code,
167
156
  enum: -> { Increase::ACHTransferCreateParams::StandardEntryClassCode }
168
157
 
169
- # @!method initialize(account_id:, amount:, statement_descriptor:, account_number: nil, addenda: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_name: nil, destination_account_holder: nil, external_account_id: nil, funding: nil, individual_id: nil, individual_name: nil, preferred_effective_date: nil, require_approval: nil, routing_number: nil, standard_entry_class_code: nil, request_options: {})
158
+ # @!method initialize(account_id:, amount:, company_name:, individual_name:, account_number: nil, addenda: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, destination_account_holder: nil, external_account_id: nil, funding: nil, individual_id: nil, preferred_effective_date: nil, require_approval: nil, routing_number: nil, standard_entry_class_code: nil, request_options: {})
170
159
  # @param account_id [String]
171
160
  # The Increase identifier for the account that will originate the transfer. For
172
161
  # credit transfers (transfers with a positive `amount`), this is the account that
@@ -180,13 +169,19 @@ module Increase
180
169
  # into Increase. Debit transfers
181
170
  # [might result in a hold before funds are available](/documentation/sending-ach-debit-transfers).
182
171
  #
183
- # @param statement_descriptor [String]
184
- # A description you choose to give the transfer. This will be saved with the
185
- # transfer details, displayed in the dashboard, and returned by the API. If
186
- # `individual_name` and `company_name` are not explicitly set by this API, the
187
- # `statement_descriptor` will be sent in those fields to the receiving bank to
188
- # help the customer recognize the transfer. You are highly encouraged to pass
189
- # `individual_name` and `company_name` instead of relying on this fallback.
172
+ # @param company_name [String]
173
+ # The name by which the recipient knows the counterparty of this transaction. If
174
+ # you're processing payments on behalf of another party, use their name, not your
175
+ # own, so that it's more likely the recipient understands the context of the
176
+ # payment. This value is usually displayed to the recipient on their bank
177
+ # statement. We recommend setting this on every transfer; if you do not, we fall
178
+ # back to the `statement_descriptor`.
179
+ #
180
+ # @param individual_name [String]
181
+ # The name of the transfer recipient. This value is informational and generally
182
+ # not verified by the recipient's bank. This value is usually displayed to the
183
+ # recipient on their bank statement. We recommend setting this on every transfer;
184
+ # if you do not, we fall back to the `statement_descriptor`.
190
185
  #
191
186
  # @param account_number [String]
192
187
  # The receiver's account number. For credit transfers (transfers with a positive
@@ -219,14 +214,6 @@ module Increase
219
214
  # code and use case. For example, some use cases require constants like
220
215
  # `ACCTVERIFY`, `PURCHASE`, `PAYROLL`, or `REVERSAL`.
221
216
  #
222
- # @param company_name [String]
223
- # The name by which the recipient knows the counterparty of this transaction. If
224
- # you're processing payments on behalf of another party, use their name, not your
225
- # own, so that it's more likely the recipient understands the context of the
226
- # payment. This value is usually displayed to the recipient on their bank
227
- # statement. We recommend setting this on every transfer; if you do not, we fall
228
- # back to the `statement_descriptor`.
229
- #
230
217
  # @param destination_account_holder [Symbol, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder]
231
218
  # The type of entity that owns the receiver's account.
232
219
  #
@@ -245,12 +232,6 @@ module Increase
245
232
  # unset. For the specific case of person-to-person credits with the WEB standard
246
233
  # entry class code, this must include the name of the payer.
247
234
  #
248
- # @param individual_name [String]
249
- # The name of the transfer recipient. This value is informational and generally
250
- # not verified by the recipient's bank. This value is usually displayed to the
251
- # recipient on their bank statement. We recommend setting this on every transfer;
252
- # if you do not, we fall back to the `statement_descriptor`.
253
- #
254
235
  # @param preferred_effective_date [Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate]
255
236
  # Configuration for how the effective date of the transfer will be set. This
256
237
  # determines same-day vs future-dated settlement timing. If not set, defaults to a
@@ -20,7 +20,9 @@ module Increase
20
20
  optional :authorization_controls, -> { Increase::CardCreateParams::AuthorizationControls }
21
21
 
22
22
  # @!attribute billing_address
23
- # The card's billing address.
23
+ # The card's billing address. This is used in card authorizations to
24
+ # [validate the address provided by the acquirer](/documentation/address-verification-system-codes-and-overrides).
25
+ # If not provided, the address associated with the account's entity will be used.
24
26
  #
25
27
  # @return [Increase::Models::CardCreateParams::BillingAddress, nil]
26
28
  optional :billing_address, -> { Increase::CardCreateParams::BillingAddress }
@@ -68,7 +70,10 @@ module Increase
68
70
  # @param authorization_controls [Increase::Models::CardCreateParams::AuthorizationControls]
69
71
  # Controls that restrict how this card can be used.
70
72
  #
71
- # @param billing_address [Increase::Models::CardCreateParams::BillingAddress] The card's billing address.
73
+ # @param billing_address [Increase::Models::CardCreateParams::BillingAddress]
74
+ # The card's billing address. This is used in card authorizations to
75
+ # [validate the address provided by the acquirer](/documentation/address-verification-system-codes-and-overrides).
76
+ # If not provided, the address associated with the account's entity will be used.
72
77
  #
73
78
  # @param cardholder_name [Increase::Models::CardCreateParams::CardholderName]
74
79
  # The name of the cardholder. Used to respond to Account Name Inquiry requests
@@ -528,7 +533,9 @@ module Increase
528
533
  optional :line2, String
529
534
 
530
535
  # @!method initialize(city:, line1:, postal_code:, state:, line2: nil)
531
- # The card's billing address.
536
+ # The card's billing address. This is used in card authorizations to
537
+ # [validate the address provided by the acquirer](/documentation/address-verification-system-codes-and-overrides).
538
+ # If not provided, the address associated with the account's entity will be used.
532
539
  #
533
540
  # @param city [String] The city of the billing address.
534
541
  #
@@ -20,7 +20,9 @@ module Increase
20
20
  optional :authorization_controls, -> { Increase::CardUpdateParams::AuthorizationControls }
21
21
 
22
22
  # @!attribute billing_address
23
- # The card's updated billing address.
23
+ # The card's billing address. This is used in card authorizations to
24
+ # [validate the address provided by the acquirer](/documentation/address-verification-system-codes-and-overrides).
25
+ # If not provided, the address associated with the account's entity will be used.
24
26
  #
25
27
  # @return [Increase::Models::CardUpdateParams::BillingAddress, nil]
26
28
  optional :billing_address, -> { Increase::CardUpdateParams::BillingAddress }
@@ -59,7 +61,9 @@ module Increase
59
61
  # Controls that restrict how this card can be used.
60
62
  #
61
63
  # @param billing_address [Increase::Models::CardUpdateParams::BillingAddress]
62
- # The card's updated billing address.
64
+ # The card's billing address. This is used in card authorizations to
65
+ # [validate the address provided by the acquirer](/documentation/address-verification-system-codes-and-overrides).
66
+ # If not provided, the address associated with the account's entity will be used.
63
67
  #
64
68
  # @param description [String] The description you choose to give the card.
65
69
  #
@@ -511,7 +515,9 @@ module Increase
511
515
  optional :line2, String
512
516
 
513
517
  # @!method initialize(city:, line1:, postal_code:, state:, line2: nil)
514
- # The card's updated billing address.
518
+ # The card's billing address. This is used in card authorizations to
519
+ # [validate the address provided by the acquirer](/documentation/address-verification-system-codes-and-overrides).
520
+ # If not provided, the address associated with the account's entity will be used.
515
521
  #
516
522
  # @param city [String] The city of the billing address.
517
523
  #
@@ -81,6 +81,12 @@ module Increase
81
81
  # @return [String]
82
82
  required :debtor_name, String
83
83
 
84
+ # @!attribute end_to_end_identification
85
+ # A free-form reference string set by the sender, to help identify the transfer.
86
+ #
87
+ # @return [String, nil]
88
+ required :end_to_end_identification, String, nil?: true
89
+
84
90
  # @!attribute external_account_id
85
91
  # The identifier of the External Account the transfer was made to, if any.
86
92
  #
@@ -169,7 +175,7 @@ module Increase
169
175
  # @return [String]
170
176
  required :unstructured_remittance_information, String
171
177
 
172
- # @!method initialize(id:, account_id:, account_number:, acknowledgement:, amount:, created_at:, created_by:, creditor_address:, creditor_name:, currency:, debtor_address:, debtor_name:, external_account_id:, idempotency_key:, pending_transaction_id:, rejection:, returns:, routing_number:, source_account_number_id:, status:, submission:, transaction_id:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
178
+ # @!method initialize(id:, account_id:, account_number:, acknowledgement:, amount:, created_at:, created_by:, creditor_address:, creditor_name:, currency:, debtor_address:, debtor_name:, end_to_end_identification:, external_account_id:, idempotency_key:, pending_transaction_id:, rejection:, returns:, routing_number:, source_account_number_id:, status:, submission:, transaction_id:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
173
179
  # FedNow transfers move funds, within seconds, between your Increase account and
174
180
  # any other account supporting FedNow.
175
181
  #
@@ -208,6 +214,9 @@ module Increase
208
214
  # The name of the transfer's sender. If not provided, defaults to the name of the
209
215
  # account's entity.
210
216
  #
217
+ # @param end_to_end_identification [String, nil]
218
+ # A free-form reference string set by the sender, to help identify the transfer.
219
+ #
211
220
  # @param external_account_id [String, nil]
212
221
  # The identifier of the External Account the transfer was made to, if any.
213
222
  #
@@ -10,7 +10,7 @@ module Increase
10
10
  # You should set both of these, in addition to the required amount and account
11
11
  # fields.
12
12
  #
13
- # @overload create(account_id:, amount:, statement_descriptor:, account_number: nil, addenda: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_name: nil, destination_account_holder: nil, external_account_id: nil, funding: nil, individual_id: nil, individual_name: nil, preferred_effective_date: nil, require_approval: nil, routing_number: nil, standard_entry_class_code: nil, request_options: {})
13
+ # @overload create(account_id:, amount:, company_name:, individual_name:, account_number: nil, addenda: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, destination_account_holder: nil, external_account_id: nil, funding: nil, individual_id: nil, preferred_effective_date: nil, require_approval: nil, routing_number: nil, standard_entry_class_code: nil, request_options: {})
14
14
  #
15
15
  # @param account_id [String]
16
16
  # The Increase identifier for the account that will originate the transfer. For
@@ -25,13 +25,19 @@ module Increase
25
25
  # into Increase. Debit transfers
26
26
  # [might result in a hold before funds are available](/documentation/sending-ach-debit-transfers).
27
27
  #
28
- # @param statement_descriptor [String]
29
- # A description you choose to give the transfer. This will be saved with the
30
- # transfer details, displayed in the dashboard, and returned by the API. If
31
- # `individual_name` and `company_name` are not explicitly set by this API, the
32
- # `statement_descriptor` will be sent in those fields to the receiving bank to
33
- # help the customer recognize the transfer. You are highly encouraged to pass
34
- # `individual_name` and `company_name` instead of relying on this fallback.
28
+ # @param company_name [String]
29
+ # The name by which the recipient knows the counterparty of this transaction. If
30
+ # you're processing payments on behalf of another party, use their name, not your
31
+ # own, so that it's more likely the recipient understands the context of the
32
+ # payment. This value is usually displayed to the recipient on their bank
33
+ # statement. We recommend setting this on every transfer; if you do not, we fall
34
+ # back to the `statement_descriptor`.
35
+ #
36
+ # @param individual_name [String]
37
+ # The name of the transfer recipient. This value is informational and generally
38
+ # not verified by the recipient's bank. This value is usually displayed to the
39
+ # recipient on their bank statement. We recommend setting this on every transfer;
40
+ # if you do not, we fall back to the `statement_descriptor`.
35
41
  #
36
42
  # @param account_number [String]
37
43
  # The receiver's account number. For credit transfers (transfers with a positive
@@ -64,14 +70,6 @@ module Increase
64
70
  # code and use case. For example, some use cases require constants like
65
71
  # `ACCTVERIFY`, `PURCHASE`, `PAYROLL`, or `REVERSAL`.
66
72
  #
67
- # @param company_name [String]
68
- # The name by which the recipient knows the counterparty of this transaction. If
69
- # you're processing payments on behalf of another party, use their name, not your
70
- # own, so that it's more likely the recipient understands the context of the
71
- # payment. This value is usually displayed to the recipient on their bank
72
- # statement. We recommend setting this on every transfer; if you do not, we fall
73
- # back to the `statement_descriptor`.
74
- #
75
73
  # @param destination_account_holder [Symbol, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder]
76
74
  # The type of entity that owns the receiver's account.
77
75
  #
@@ -90,12 +88,6 @@ module Increase
90
88
  # unset. For the specific case of person-to-person credits with the WEB standard
91
89
  # entry class code, this must include the name of the payer.
92
90
  #
93
- # @param individual_name [String]
94
- # The name of the transfer recipient. This value is informational and generally
95
- # not verified by the recipient's bank. This value is usually displayed to the
96
- # recipient on their bank statement. We recommend setting this on every transfer;
97
- # if you do not, we fall back to the `statement_descriptor`.
98
- #
99
91
  # @param preferred_effective_date [Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate]
100
92
  # Configuration for how the effective date of the transfer will be set. This
101
93
  # determines same-day vs future-dated settlement timing. If not set, defaults to a
@@ -12,7 +12,10 @@ module Increase
12
12
  # @param authorization_controls [Increase::Models::CardCreateParams::AuthorizationControls]
13
13
  # Controls that restrict how this card can be used.
14
14
  #
15
- # @param billing_address [Increase::Models::CardCreateParams::BillingAddress] The card's billing address.
15
+ # @param billing_address [Increase::Models::CardCreateParams::BillingAddress]
16
+ # The card's billing address. This is used in card authorizations to
17
+ # [validate the address provided by the acquirer](/documentation/address-verification-system-codes-and-overrides).
18
+ # If not provided, the address associated with the account's entity will be used.
16
19
  #
17
20
  # @param cardholder_name [Increase::Models::CardCreateParams::CardholderName]
18
21
  # The name of the cardholder. Used to respond to Account Name Inquiry requests
@@ -75,7 +78,9 @@ module Increase
75
78
  # Controls that restrict how this card can be used.
76
79
  #
77
80
  # @param billing_address [Increase::Models::CardUpdateParams::BillingAddress]
78
- # The card's updated billing address.
81
+ # The card's billing address. This is used in card authorizations to
82
+ # [validate the address provided by the acquirer](/documentation/address-verification-system-codes-and-overrides).
83
+ # If not provided, the address associated with the account's entity will be used.
79
84
  #
80
85
  # @param description [String] The description you choose to give the card.
81
86
  #
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.364.0"
4
+ VERSION = "1.365.0"
5
5
  end
@@ -229,7 +229,10 @@ module Increase
229
229
  end
230
230
  attr_accessor :standard_entry_class_code
231
231
 
232
- # The descriptor that will show on the recipient's bank statement.
232
+ # A description you chose to give the transfer. If `individual_name` and
233
+ # `company_name` were not explicitly set, the `statement_descriptor` will be sent
234
+ # in those fields to the receiving bank to help the customer recognize the
235
+ # transfer.
233
236
  sig { returns(T.nilable(String)) }
234
237
  attr_accessor :statement_descriptor
235
238
 
@@ -403,7 +406,10 @@ module Increase
403
406
  # [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
404
407
  # to use for the transfer.
405
408
  standard_entry_class_code:,
406
- # The descriptor that will show on the recipient's bank statement.
409
+ # A description you chose to give the transfer. If `individual_name` and
410
+ # `company_name` were not explicitly set, the `statement_descriptor` will be sent
411
+ # in those fields to the receiving bank to help the customer recognize the
412
+ # transfer.
407
413
  statement_descriptor:,
408
414
  # The lifecycle status of the transfer.
409
415
  status:,
@@ -26,14 +26,21 @@ module Increase
26
26
  sig { returns(Integer) }
27
27
  attr_accessor :amount
28
28
 
29
- # A description you choose to give the transfer. This will be saved with the
30
- # transfer details, displayed in the dashboard, and returned by the API. If
31
- # `individual_name` and `company_name` are not explicitly set by this API, the
32
- # `statement_descriptor` will be sent in those fields to the receiving bank to
33
- # help the customer recognize the transfer. You are highly encouraged to pass
34
- # `individual_name` and `company_name` instead of relying on this fallback.
29
+ # The name by which the recipient knows the counterparty of this transaction. If
30
+ # you're processing payments on behalf of another party, use their name, not your
31
+ # own, so that it's more likely the recipient understands the context of the
32
+ # payment. This value is usually displayed to the recipient on their bank
33
+ # statement. We recommend setting this on every transfer; if you do not, we fall
34
+ # back to the `statement_descriptor`.
35
+ sig { returns(String) }
36
+ attr_accessor :company_name
37
+
38
+ # The name of the transfer recipient. This value is informational and generally
39
+ # not verified by the recipient's bank. This value is usually displayed to the
40
+ # recipient on their bank statement. We recommend setting this on every transfer;
41
+ # if you do not, we fall back to the `statement_descriptor`.
35
42
  sig { returns(String) }
36
- attr_accessor :statement_descriptor
43
+ attr_accessor :individual_name
37
44
 
38
45
  # The receiver's account number. For credit transfers (transfers with a positive
39
46
  # `amount`), this is the account that funds will be sent to. For debit transfers
@@ -88,18 +95,6 @@ module Increase
88
95
  sig { params(company_entry_description: String).void }
89
96
  attr_writer :company_entry_description
90
97
 
91
- # The name by which the recipient knows the counterparty of this transaction. If
92
- # you're processing payments on behalf of another party, use their name, not your
93
- # own, so that it's more likely the recipient understands the context of the
94
- # payment. This value is usually displayed to the recipient on their bank
95
- # statement. We recommend setting this on every transfer; if you do not, we fall
96
- # back to the `statement_descriptor`.
97
- sig { returns(T.nilable(String)) }
98
- attr_reader :company_name
99
-
100
- sig { params(company_name: String).void }
101
- attr_writer :company_name
102
-
103
98
  # The type of entity that owns the receiver's account.
104
99
  sig do
105
100
  returns(
@@ -151,16 +146,6 @@ module Increase
151
146
  sig { params(individual_id: String).void }
152
147
  attr_writer :individual_id
153
148
 
154
- # The name of the transfer recipient. This value is informational and generally
155
- # not verified by the recipient's bank. This value is usually displayed to the
156
- # recipient on their bank statement. We recommend setting this on every transfer;
157
- # if you do not, we fall back to the `statement_descriptor`.
158
- sig { returns(T.nilable(String)) }
159
- attr_reader :individual_name
160
-
161
- sig { params(individual_name: String).void }
162
- attr_writer :individual_name
163
-
164
149
  # Configuration for how the effective date of the transfer will be set. This
165
150
  # determines same-day vs future-dated settlement timing. If not set, defaults to a
166
151
  # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
@@ -220,19 +205,18 @@ module Increase
220
205
  params(
221
206
  account_id: String,
222
207
  amount: Integer,
223
- statement_descriptor: String,
208
+ company_name: String,
209
+ individual_name: String,
224
210
  account_number: String,
225
211
  addenda: Increase::ACHTransferCreateParams::Addenda::OrHash,
226
212
  company_descriptive_date: String,
227
213
  company_discretionary_data: String,
228
214
  company_entry_description: String,
229
- company_name: String,
230
215
  destination_account_holder:
231
216
  Increase::ACHTransferCreateParams::DestinationAccountHolder::OrSymbol,
232
217
  external_account_id: String,
233
218
  funding: Increase::ACHTransferCreateParams::Funding::OrSymbol,
234
219
  individual_id: String,
235
- individual_name: String,
236
220
  preferred_effective_date:
237
221
  Increase::ACHTransferCreateParams::PreferredEffectiveDate::OrHash,
238
222
  require_approval: T::Boolean,
@@ -254,13 +238,18 @@ module Increase
254
238
  # into Increase. Debit transfers
255
239
  # [might result in a hold before funds are available](/documentation/sending-ach-debit-transfers).
256
240
  amount:,
257
- # A description you choose to give the transfer. This will be saved with the
258
- # transfer details, displayed in the dashboard, and returned by the API. If
259
- # `individual_name` and `company_name` are not explicitly set by this API, the
260
- # `statement_descriptor` will be sent in those fields to the receiving bank to
261
- # help the customer recognize the transfer. You are highly encouraged to pass
262
- # `individual_name` and `company_name` instead of relying on this fallback.
263
- statement_descriptor:,
241
+ # The name by which the recipient knows the counterparty of this transaction. If
242
+ # you're processing payments on behalf of another party, use their name, not your
243
+ # own, so that it's more likely the recipient understands the context of the
244
+ # payment. This value is usually displayed to the recipient on their bank
245
+ # statement. We recommend setting this on every transfer; if you do not, we fall
246
+ # back to the `statement_descriptor`.
247
+ company_name:,
248
+ # The name of the transfer recipient. This value is informational and generally
249
+ # not verified by the recipient's bank. This value is usually displayed to the
250
+ # recipient on their bank statement. We recommend setting this on every transfer;
251
+ # if you do not, we fall back to the `statement_descriptor`.
252
+ individual_name:,
264
253
  # The receiver's account number. For credit transfers (transfers with a positive
265
254
  # `amount`), this is the account that funds will be sent to. For debit transfers
266
255
  # (transfers with a negative `amount`), this is the account that funds will be
@@ -287,13 +276,6 @@ module Increase
287
276
  # code and use case. For example, some use cases require constants like
288
277
  # `ACCTVERIFY`, `PURCHASE`, `PAYROLL`, or `REVERSAL`.
289
278
  company_entry_description: nil,
290
- # The name by which the recipient knows the counterparty of this transaction. If
291
- # you're processing payments on behalf of another party, use their name, not your
292
- # own, so that it's more likely the recipient understands the context of the
293
- # payment. This value is usually displayed to the recipient on their bank
294
- # statement. We recommend setting this on every transfer; if you do not, we fall
295
- # back to the `statement_descriptor`.
296
- company_name: nil,
297
279
  # The type of entity that owns the receiver's account.
298
280
  destination_account_holder: nil,
299
281
  # The ID of an External Account to initiate a transfer to. If this parameter is
@@ -308,11 +290,6 @@ module Increase
308
290
  # unset. For the specific case of person-to-person credits with the WEB standard
309
291
  # entry class code, this must include the name of the payer.
310
292
  individual_id: nil,
311
- # The name of the transfer recipient. This value is informational and generally
312
- # not verified by the recipient's bank. This value is usually displayed to the
313
- # recipient on their bank statement. We recommend setting this on every transfer;
314
- # if you do not, we fall back to the `statement_descriptor`.
315
- individual_name: nil,
316
293
  # Configuration for how the effective date of the transfer will be set. This
317
294
  # determines same-day vs future-dated settlement timing. If not set, defaults to a
318
295
  # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
@@ -337,19 +314,18 @@ module Increase
337
314
  {
338
315
  account_id: String,
339
316
  amount: Integer,
340
- statement_descriptor: String,
317
+ company_name: String,
318
+ individual_name: String,
341
319
  account_number: String,
342
320
  addenda: Increase::ACHTransferCreateParams::Addenda,
343
321
  company_descriptive_date: String,
344
322
  company_discretionary_data: String,
345
323
  company_entry_description: String,
346
- company_name: String,
347
324
  destination_account_holder:
348
325
  Increase::ACHTransferCreateParams::DestinationAccountHolder::OrSymbol,
349
326
  external_account_id: String,
350
327
  funding: Increase::ACHTransferCreateParams::Funding::OrSymbol,
351
328
  individual_id: String,
352
- individual_name: String,
353
329
  preferred_effective_date:
354
330
  Increase::ACHTransferCreateParams::PreferredEffectiveDate,
355
331
  require_approval: T::Boolean,
@@ -29,7 +29,9 @@ module Increase
29
29
  end
30
30
  attr_writer :authorization_controls
31
31
 
32
- # The card's billing address.
32
+ # The card's billing address. This is used in card authorizations to
33
+ # [validate the address provided by the acquirer](/documentation/address-verification-system-codes-and-overrides).
34
+ # If not provided, the address associated with the account's entity will be used.
33
35
  sig { returns(T.nilable(Increase::CardCreateParams::BillingAddress)) }
34
36
  attr_reader :billing_address
35
37
 
@@ -113,7 +115,9 @@ module Increase
113
115
  account_id:,
114
116
  # Controls that restrict how this card can be used.
115
117
  authorization_controls: nil,
116
- # The card's billing address.
118
+ # The card's billing address. This is used in card authorizations to
119
+ # [validate the address provided by the acquirer](/documentation/address-verification-system-codes-and-overrides).
120
+ # If not provided, the address associated with the account's entity will be used.
117
121
  billing_address: nil,
118
122
  # The name of the cardholder. Used to respond to Account Name Inquiry requests
119
123
  # from acquirers in Card Validations.
@@ -1253,7 +1257,9 @@ module Increase
1253
1257
  sig { params(line2: String).void }
1254
1258
  attr_writer :line2
1255
1259
 
1256
- # The card's billing address.
1260
+ # The card's billing address. This is used in card authorizations to
1261
+ # [validate the address provided by the acquirer](/documentation/address-verification-system-codes-and-overrides).
1262
+ # If not provided, the address associated with the account's entity will be used.
1257
1263
  sig do
1258
1264
  params(
1259
1265
  city: String,
@@ -29,7 +29,9 @@ module Increase
29
29
  end
30
30
  attr_writer :authorization_controls
31
31
 
32
- # The card's updated billing address.
32
+ # The card's billing address. This is used in card authorizations to
33
+ # [validate the address provided by the acquirer](/documentation/address-verification-system-codes-and-overrides).
34
+ # If not provided, the address associated with the account's entity will be used.
33
35
  sig { returns(T.nilable(Increase::CardUpdateParams::BillingAddress)) }
34
36
  attr_reader :billing_address
35
37
 
@@ -93,7 +95,9 @@ module Increase
93
95
  card_id:,
94
96
  # Controls that restrict how this card can be used.
95
97
  authorization_controls: nil,
96
- # The card's updated billing address.
98
+ # The card's billing address. This is used in card authorizations to
99
+ # [validate the address provided by the acquirer](/documentation/address-verification-system-codes-and-overrides).
100
+ # If not provided, the address associated with the account's entity will be used.
97
101
  billing_address: nil,
98
102
  # The description you choose to give the card.
99
103
  description: nil,
@@ -1226,7 +1230,9 @@ module Increase
1226
1230
  sig { params(line2: String).void }
1227
1231
  attr_writer :line2
1228
1232
 
1229
- # The card's updated billing address.
1233
+ # The card's billing address. This is used in card authorizations to
1234
+ # [validate the address provided by the acquirer](/documentation/address-verification-system-codes-and-overrides).
1235
+ # If not provided, the address associated with the account's entity will be used.
1230
1236
  sig do
1231
1237
  params(
1232
1238
  city: String,
@@ -92,6 +92,10 @@ module Increase
92
92
  sig { returns(String) }
93
93
  attr_accessor :debtor_name
94
94
 
95
+ # A free-form reference string set by the sender, to help identify the transfer.
96
+ sig { returns(T.nilable(String)) }
97
+ attr_accessor :end_to_end_identification
98
+
95
99
  # The identifier of the External Account the transfer was made to, if any.
96
100
  sig { returns(T.nilable(String)) }
97
101
  attr_accessor :external_account_id
@@ -187,6 +191,7 @@ module Increase
187
191
  debtor_address:
188
192
  T.nilable(Increase::FednowTransfer::DebtorAddress::OrHash),
189
193
  debtor_name: String,
194
+ end_to_end_identification: T.nilable(String),
190
195
  external_account_id: T.nilable(String),
191
196
  idempotency_key: T.nilable(String),
192
197
  pending_transaction_id: T.nilable(String),
@@ -232,6 +237,8 @@ module Increase
232
237
  # The name of the transfer's sender. If not provided, defaults to the name of the
233
238
  # account's entity.
234
239
  debtor_name:,
240
+ # A free-form reference string set by the sender, to help identify the transfer.
241
+ end_to_end_identification:,
235
242
  # The identifier of the External Account the transfer was made to, if any.
236
243
  external_account_id:,
237
244
  # The idempotency key you chose for this object. This value is unique across
@@ -288,6 +295,7 @@ module Increase
288
295
  currency: Increase::FednowTransfer::Currency::TaggedSymbol,
289
296
  debtor_address: T.nilable(Increase::FednowTransfer::DebtorAddress),
290
297
  debtor_name: String,
298
+ end_to_end_identification: T.nilable(String),
291
299
  external_account_id: T.nilable(String),
292
300
  idempotency_key: T.nilable(String),
293
301
  pending_transaction_id: T.nilable(String),
@@ -13,19 +13,18 @@ module Increase
13
13
  params(
14
14
  account_id: String,
15
15
  amount: Integer,
16
- statement_descriptor: String,
16
+ company_name: String,
17
+ individual_name: String,
17
18
  account_number: String,
18
19
  addenda: Increase::ACHTransferCreateParams::Addenda::OrHash,
19
20
  company_descriptive_date: String,
20
21
  company_discretionary_data: String,
21
22
  company_entry_description: String,
22
- company_name: String,
23
23
  destination_account_holder:
24
24
  Increase::ACHTransferCreateParams::DestinationAccountHolder::OrSymbol,
25
25
  external_account_id: String,
26
26
  funding: Increase::ACHTransferCreateParams::Funding::OrSymbol,
27
27
  individual_id: String,
28
- individual_name: String,
29
28
  preferred_effective_date:
30
29
  Increase::ACHTransferCreateParams::PreferredEffectiveDate::OrHash,
31
30
  require_approval: T::Boolean,
@@ -47,13 +46,18 @@ module Increase
47
46
  # into Increase. Debit transfers
48
47
  # [might result in a hold before funds are available](/documentation/sending-ach-debit-transfers).
49
48
  amount:,
50
- # A description you choose to give the transfer. This will be saved with the
51
- # transfer details, displayed in the dashboard, and returned by the API. If
52
- # `individual_name` and `company_name` are not explicitly set by this API, the
53
- # `statement_descriptor` will be sent in those fields to the receiving bank to
54
- # help the customer recognize the transfer. You are highly encouraged to pass
55
- # `individual_name` and `company_name` instead of relying on this fallback.
56
- statement_descriptor:,
49
+ # The name by which the recipient knows the counterparty of this transaction. If
50
+ # you're processing payments on behalf of another party, use their name, not your
51
+ # own, so that it's more likely the recipient understands the context of the
52
+ # payment. This value is usually displayed to the recipient on their bank
53
+ # statement. We recommend setting this on every transfer; if you do not, we fall
54
+ # back to the `statement_descriptor`.
55
+ company_name:,
56
+ # The name of the transfer recipient. This value is informational and generally
57
+ # not verified by the recipient's bank. This value is usually displayed to the
58
+ # recipient on their bank statement. We recommend setting this on every transfer;
59
+ # if you do not, we fall back to the `statement_descriptor`.
60
+ individual_name:,
57
61
  # The receiver's account number. For credit transfers (transfers with a positive
58
62
  # `amount`), this is the account that funds will be sent to. For debit transfers
59
63
  # (transfers with a negative `amount`), this is the account that funds will be
@@ -80,13 +84,6 @@ module Increase
80
84
  # code and use case. For example, some use cases require constants like
81
85
  # `ACCTVERIFY`, `PURCHASE`, `PAYROLL`, or `REVERSAL`.
82
86
  company_entry_description: nil,
83
- # The name by which the recipient knows the counterparty of this transaction. If
84
- # you're processing payments on behalf of another party, use their name, not your
85
- # own, so that it's more likely the recipient understands the context of the
86
- # payment. This value is usually displayed to the recipient on their bank
87
- # statement. We recommend setting this on every transfer; if you do not, we fall
88
- # back to the `statement_descriptor`.
89
- company_name: nil,
90
87
  # The type of entity that owns the receiver's account.
91
88
  destination_account_holder: nil,
92
89
  # The ID of an External Account to initiate a transfer to. If this parameter is
@@ -101,11 +98,6 @@ module Increase
101
98
  # unset. For the specific case of person-to-person credits with the WEB standard
102
99
  # entry class code, this must include the name of the payer.
103
100
  individual_id: nil,
104
- # The name of the transfer recipient. This value is informational and generally
105
- # not verified by the recipient's bank. This value is usually displayed to the
106
- # recipient on their bank statement. We recommend setting this on every transfer;
107
- # if you do not, we fall back to the `statement_descriptor`.
108
- individual_name: nil,
109
101
  # Configuration for how the effective date of the transfer will be set. This
110
102
  # determines same-day vs future-dated settlement timing. If not set, defaults to a
111
103
  # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
@@ -23,7 +23,9 @@ module Increase
23
23
  account_id:,
24
24
  # Controls that restrict how this card can be used.
25
25
  authorization_controls: nil,
26
- # The card's billing address.
26
+ # The card's billing address. This is used in card authorizations to
27
+ # [validate the address provided by the acquirer](/documentation/address-verification-system-codes-and-overrides).
28
+ # If not provided, the address associated with the account's entity will be used.
27
29
  billing_address: nil,
28
30
  # The name of the cardholder. Used to respond to Account Name Inquiry requests
29
31
  # from acquirers in Card Validations.
@@ -79,7 +81,9 @@ module Increase
79
81
  card_id,
80
82
  # Controls that restrict how this card can be used.
81
83
  authorization_controls: nil,
82
- # The card's updated billing address.
84
+ # The card's billing address. This is used in card authorizations to
85
+ # [validate the address provided by the acquirer](/documentation/address-verification-system-codes-and-overrides).
86
+ # If not provided, the address associated with the account's entity will be used.
83
87
  billing_address: nil,
84
88
  # The description you choose to give the card.
85
89
  description: nil,
@@ -4,18 +4,17 @@ module Increase
4
4
  {
5
5
  account_id: String,
6
6
  amount: Integer,
7
- statement_descriptor: String,
7
+ company_name: String,
8
+ individual_name: String,
8
9
  account_number: String,
9
10
  addenda: Increase::ACHTransferCreateParams::Addenda,
10
11
  company_descriptive_date: String,
11
12
  company_discretionary_data: String,
12
13
  company_entry_description: String,
13
- company_name: String,
14
14
  destination_account_holder: Increase::Models::ACHTransferCreateParams::destination_account_holder,
15
15
  external_account_id: String,
16
16
  funding: Increase::Models::ACHTransferCreateParams::funding,
17
17
  individual_id: String,
18
- individual_name: String,
19
18
  preferred_effective_date: Increase::ACHTransferCreateParams::PreferredEffectiveDate,
20
19
  require_approval: bool,
21
20
  routing_number: String,
@@ -31,7 +30,9 @@ module Increase
31
30
 
32
31
  attr_accessor amount: Integer
33
32
 
34
- attr_accessor statement_descriptor: String
33
+ attr_accessor company_name: String
34
+
35
+ attr_accessor individual_name: String
35
36
 
36
37
  attr_reader account_number: String?
37
38
 
@@ -55,10 +56,6 @@ module Increase
55
56
 
56
57
  def company_entry_description=: (String) -> String
57
58
 
58
- attr_reader company_name: String?
59
-
60
- def company_name=: (String) -> String
61
-
62
59
  attr_reader destination_account_holder: Increase::Models::ACHTransferCreateParams::destination_account_holder?
63
60
 
64
61
  def destination_account_holder=: (
@@ -79,10 +76,6 @@ module Increase
79
76
 
80
77
  def individual_id=: (String) -> String
81
78
 
82
- attr_reader individual_name: String?
83
-
84
- def individual_name=: (String) -> String
85
-
86
79
  attr_reader preferred_effective_date: Increase::ACHTransferCreateParams::PreferredEffectiveDate?
87
80
 
88
81
  def preferred_effective_date=: (
@@ -106,18 +99,17 @@ module Increase
106
99
  def initialize: (
107
100
  account_id: String,
108
101
  amount: Integer,
109
- statement_descriptor: String,
102
+ company_name: String,
103
+ individual_name: String,
110
104
  ?account_number: String,
111
105
  ?addenda: Increase::ACHTransferCreateParams::Addenda,
112
106
  ?company_descriptive_date: String,
113
107
  ?company_discretionary_data: String,
114
108
  ?company_entry_description: String,
115
- ?company_name: String,
116
109
  ?destination_account_holder: Increase::Models::ACHTransferCreateParams::destination_account_holder,
117
110
  ?external_account_id: String,
118
111
  ?funding: Increase::Models::ACHTransferCreateParams::funding,
119
112
  ?individual_id: String,
120
- ?individual_name: String,
121
113
  ?preferred_effective_date: Increase::ACHTransferCreateParams::PreferredEffectiveDate,
122
114
  ?require_approval: bool,
123
115
  ?routing_number: String,
@@ -128,18 +120,17 @@ module Increase
128
120
  def to_hash: -> {
129
121
  account_id: String,
130
122
  amount: Integer,
131
- statement_descriptor: String,
123
+ company_name: String,
124
+ individual_name: String,
132
125
  account_number: String,
133
126
  addenda: Increase::ACHTransferCreateParams::Addenda,
134
127
  company_descriptive_date: String,
135
128
  company_discretionary_data: String,
136
129
  company_entry_description: String,
137
- company_name: String,
138
130
  destination_account_holder: Increase::Models::ACHTransferCreateParams::destination_account_holder,
139
131
  external_account_id: String,
140
132
  funding: Increase::Models::ACHTransferCreateParams::funding,
141
133
  individual_id: String,
142
- individual_name: String,
143
134
  preferred_effective_date: Increase::ACHTransferCreateParams::PreferredEffectiveDate,
144
135
  require_approval: bool,
145
136
  routing_number: String,
@@ -14,6 +14,7 @@ module Increase
14
14
  currency: Increase::Models::FednowTransfer::currency,
15
15
  debtor_address: Increase::FednowTransfer::DebtorAddress?,
16
16
  debtor_name: String,
17
+ end_to_end_identification: String?,
17
18
  external_account_id: String?,
18
19
  idempotency_key: String?,
19
20
  pending_transaction_id: String?,
@@ -54,6 +55,8 @@ module Increase
54
55
 
55
56
  attr_accessor debtor_name: String
56
57
 
58
+ attr_accessor end_to_end_identification: String?
59
+
57
60
  attr_accessor external_account_id: String?
58
61
 
59
62
  attr_accessor idempotency_key: String?
@@ -93,6 +96,7 @@ module Increase
93
96
  currency: Increase::Models::FednowTransfer::currency,
94
97
  debtor_address: Increase::FednowTransfer::DebtorAddress?,
95
98
  debtor_name: String,
99
+ end_to_end_identification: String?,
96
100
  external_account_id: String?,
97
101
  idempotency_key: String?,
98
102
  pending_transaction_id: String?,
@@ -121,6 +125,7 @@ module Increase
121
125
  currency: Increase::Models::FednowTransfer::currency,
122
126
  debtor_address: Increase::FednowTransfer::DebtorAddress?,
123
127
  debtor_name: String,
128
+ end_to_end_identification: String?,
124
129
  external_account_id: String?,
125
130
  idempotency_key: String?,
126
131
  pending_transaction_id: String?,
@@ -4,18 +4,17 @@ module Increase
4
4
  def create: (
5
5
  account_id: String,
6
6
  amount: Integer,
7
- statement_descriptor: String,
7
+ company_name: String,
8
+ individual_name: String,
8
9
  ?account_number: String,
9
10
  ?addenda: Increase::ACHTransferCreateParams::Addenda,
10
11
  ?company_descriptive_date: String,
11
12
  ?company_discretionary_data: String,
12
13
  ?company_entry_description: String,
13
- ?company_name: String,
14
14
  ?destination_account_holder: Increase::Models::ACHTransferCreateParams::destination_account_holder,
15
15
  ?external_account_id: String,
16
16
  ?funding: Increase::Models::ACHTransferCreateParams::funding,
17
17
  ?individual_id: String,
18
- ?individual_name: String,
19
18
  ?preferred_effective_date: Increase::ACHTransferCreateParams::PreferredEffectiveDate,
20
19
  ?require_approval: bool,
21
20
  ?routing_number: String,
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: increase
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.364.0
4
+ version: 1.365.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Increase
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-11-09 00:00:00.000000000 Z
11
+ date: 2026-11-10 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: base64