increase 1.367.0 → 1.368.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 (39) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/models/card_payment.rb +30 -0
  4. data/lib/increase/models/declined_transaction.rb +3 -0
  5. data/lib/increase/models/export.rb +19 -5
  6. data/lib/increase/models/export_create_params.rb +36 -13
  7. data/lib/increase/models/inbound_check_deposit.rb +0 -3
  8. data/lib/increase/models/inbound_fednow_transfer.rb +3 -0
  9. data/lib/increase/models/pending_transaction.rb +76 -1
  10. data/lib/increase/models/pending_transaction_list_params.rb +3 -0
  11. data/lib/increase/models/simulations/card_refund_create_params.rb +2 -2
  12. data/lib/increase/models/transaction.rb +86 -1
  13. data/lib/increase/models/transaction_list_params.rb +3 -0
  14. data/lib/increase/resources/exports.rb +5 -1
  15. data/lib/increase/resources/simulations/card_refunds.rb +1 -1
  16. data/lib/increase/version.rb +1 -1
  17. data/rbi/increase/models/card_payment.rbi +70 -0
  18. data/rbi/increase/models/declined_transaction.rbi +7 -0
  19. data/rbi/increase/models/export.rbi +18 -6
  20. data/rbi/increase/models/export_create_params.rbi +44 -15
  21. data/rbi/increase/models/inbound_check_deposit.rbi +0 -3
  22. data/rbi/increase/models/inbound_fednow_transfer.rbi +7 -0
  23. data/rbi/increase/models/pending_transaction.rbi +162 -0
  24. data/rbi/increase/models/pending_transaction_list_params.rbi +7 -0
  25. data/rbi/increase/models/simulations/card_refund_create_params.rbi +2 -2
  26. data/rbi/increase/models/transaction.rbi +179 -0
  27. data/rbi/increase/models/transaction_list_params.rbi +7 -0
  28. data/rbi/increase/resources/exports.rbi +5 -1
  29. data/rbi/increase/resources/simulations/card_refunds.rbi +1 -1
  30. data/sig/increase/models/card_payment.rbs +40 -0
  31. data/sig/increase/models/declined_transaction.rbs +4 -0
  32. data/sig/increase/models/export.rbs +13 -4
  33. data/sig/increase/models/export_create_params.rbs +16 -5
  34. data/sig/increase/models/inbound_fednow_transfer.rbs +4 -0
  35. data/sig/increase/models/pending_transaction.rbs +63 -0
  36. data/sig/increase/models/pending_transaction_list_params.rbs +4 -0
  37. data/sig/increase/models/transaction.rbs +71 -0
  38. data/sig/increase/models/transaction_list_params.rbs +4 -0
  39. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 98e0ff963d3d275e9d524bc177b51d7d3367250d023e03ecb1297e047f6d91d9
4
- data.tar.gz: bd91efc473f5df56ffa23baa5cb7989e9cf2a415b0c7c20a427e122b242922f6
3
+ metadata.gz: 2eb420cf7c907a2aabca9035e068820cdf2130b924ccbedc01a826e19e026d32
4
+ data.tar.gz: 7c1685aa558d6e5afc62b44c11361344fabf80ce510048e70a2987311ce9a18a
5
5
  SHA512:
6
- metadata.gz: 6fcf7d6a933dd0d04acb9bee822fe14370a062f3d9ddf1bf57ec7c066b2c066a93dd5c6237dc81792988b05751a89da5e9cdd3e29d5ad04cf2bdd33d081dacfd
7
- data.tar.gz: 2097487a3b63b2661a217b04ea67c7902b134fd1730e68b7342e97d25f873ac4a842005452414cc7051558bc0f1a657687c714de4d6cf7e830a787cc21d08de4
6
+ metadata.gz: f59aa8a2914e7c6059a63ea6d0e0a6a4a0747226d83b526bb2784094305cc3996db3f64a927b878750e22d9f12ea055e41d2d3cd5b486be3322c4816972acf6c
7
+ data.tar.gz: f011957acc4ac145663988df319f87cf5872534423b6d97faf2180996dc9f14a4f850372a48a3a1e66bd70b521bf73ebbca9cc41d32c3921cf9a1993b5c29d03
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.367.0"
18
+ gem "increase", "~> 1.368.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -2793,6 +2793,9 @@ module Increase
2793
2793
  # Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network.
2794
2794
  PULSE_SWITCH_FEE = :pulse_switch_fee
2795
2795
 
2796
+ # Pulse Switch Fee Credit is a credit of the Pulse Switch Fee charged for an authorization that was subsequently reversed in full.
2797
+ PULSE_SWITCH_FEE_CREDIT = :pulse_switch_fee_credit
2798
+
2796
2799
  # Pulse Tokenization Fee is a fee charged by the Pulse network for processing tokenized transactions on its network.
2797
2800
  PULSE_TOKENIZATION_FEE = :pulse_tokenization_fee
2798
2801
 
@@ -4306,6 +4309,9 @@ module Increase
4306
4309
  # Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network.
4307
4310
  PULSE_SWITCH_FEE = :pulse_switch_fee
4308
4311
 
4312
+ # Pulse Switch Fee Credit is a credit of the Pulse Switch Fee charged for an authorization that was subsequently reversed in full.
4313
+ PULSE_SWITCH_FEE_CREDIT = :pulse_switch_fee_credit
4314
+
4309
4315
  # Pulse Tokenization Fee is a fee charged by the Pulse network for processing tokenized transactions on its network.
4310
4316
  PULSE_TOKENIZATION_FEE = :pulse_tokenization_fee
4311
4317
 
@@ -5973,6 +5979,9 @@ module Increase
5973
5979
  # Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network.
5974
5980
  PULSE_SWITCH_FEE = :pulse_switch_fee
5975
5981
 
5982
+ # Pulse Switch Fee Credit is a credit of the Pulse Switch Fee charged for an authorization that was subsequently reversed in full.
5983
+ PULSE_SWITCH_FEE_CREDIT = :pulse_switch_fee_credit
5984
+
5976
5985
  # Pulse Tokenization Fee is a fee charged by the Pulse network for processing tokenized transactions on its network.
5977
5986
  PULSE_TOKENIZATION_FEE = :pulse_tokenization_fee
5978
5987
 
@@ -7502,6 +7511,9 @@ module Increase
7502
7511
  # Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network.
7503
7512
  PULSE_SWITCH_FEE = :pulse_switch_fee
7504
7513
 
7514
+ # Pulse Switch Fee Credit is a credit of the Pulse Switch Fee charged for an authorization that was subsequently reversed in full.
7515
+ PULSE_SWITCH_FEE_CREDIT = :pulse_switch_fee_credit
7516
+
7505
7517
  # Pulse Tokenization Fee is a fee charged by the Pulse network for processing tokenized transactions on its network.
7506
7518
  PULSE_TOKENIZATION_FEE = :pulse_tokenization_fee
7507
7519
 
@@ -8076,6 +8088,9 @@ module Increase
8076
8088
  # Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network.
8077
8089
  PULSE_SWITCH_FEE = :pulse_switch_fee
8078
8090
 
8091
+ # Pulse Switch Fee Credit is a credit of the Pulse Switch Fee charged for an authorization that was subsequently reversed in full.
8092
+ PULSE_SWITCH_FEE_CREDIT = :pulse_switch_fee_credit
8093
+
8079
8094
  # Pulse Tokenization Fee is a fee charged by the Pulse network for processing tokenized transactions on its network.
8080
8095
  PULSE_TOKENIZATION_FEE = :pulse_tokenization_fee
8081
8096
 
@@ -8972,6 +8987,9 @@ module Increase
8972
8987
  # Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network.
8973
8988
  PULSE_SWITCH_FEE = :pulse_switch_fee
8974
8989
 
8990
+ # Pulse Switch Fee Credit is a credit of the Pulse Switch Fee charged for an authorization that was subsequently reversed in full.
8991
+ PULSE_SWITCH_FEE_CREDIT = :pulse_switch_fee_credit
8992
+
8975
8993
  # Pulse Tokenization Fee is a fee charged by the Pulse network for processing tokenized transactions on its network.
8976
8994
  PULSE_TOKENIZATION_FEE = :pulse_tokenization_fee
8977
8995
 
@@ -11294,6 +11312,9 @@ module Increase
11294
11312
  # Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network.
11295
11313
  PULSE_SWITCH_FEE = :pulse_switch_fee
11296
11314
 
11315
+ # Pulse Switch Fee Credit is a credit of the Pulse Switch Fee charged for an authorization that was subsequently reversed in full.
11316
+ PULSE_SWITCH_FEE_CREDIT = :pulse_switch_fee_credit
11317
+
11297
11318
  # Pulse Tokenization Fee is a fee charged by the Pulse network for processing tokenized transactions on its network.
11298
11319
  PULSE_TOKENIZATION_FEE = :pulse_tokenization_fee
11299
11320
 
@@ -11826,6 +11847,9 @@ module Increase
11826
11847
  # Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network.
11827
11848
  PULSE_SWITCH_FEE = :pulse_switch_fee
11828
11849
 
11850
+ # Pulse Switch Fee Credit is a credit of the Pulse Switch Fee charged for an authorization that was subsequently reversed in full.
11851
+ PULSE_SWITCH_FEE_CREDIT = :pulse_switch_fee_credit
11852
+
11829
11853
  # Pulse Tokenization Fee is a fee charged by the Pulse network for processing tokenized transactions on its network.
11830
11854
  PULSE_TOKENIZATION_FEE = :pulse_tokenization_fee
11831
11855
 
@@ -14181,6 +14205,9 @@ module Increase
14181
14205
  # Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network.
14182
14206
  PULSE_SWITCH_FEE = :pulse_switch_fee
14183
14207
 
14208
+ # Pulse Switch Fee Credit is a credit of the Pulse Switch Fee charged for an authorization that was subsequently reversed in full.
14209
+ PULSE_SWITCH_FEE_CREDIT = :pulse_switch_fee_credit
14210
+
14184
14211
  # Pulse Tokenization Fee is a fee charged by the Pulse network for processing tokenized transactions on its network.
14185
14212
  PULSE_TOKENIZATION_FEE = :pulse_tokenization_fee
14186
14213
 
@@ -15439,6 +15466,9 @@ module Increase
15439
15466
  # Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network.
15440
15467
  PULSE_SWITCH_FEE = :pulse_switch_fee
15441
15468
 
15469
+ # Pulse Switch Fee Credit is a credit of the Pulse Switch Fee charged for an authorization that was subsequently reversed in full.
15470
+ PULSE_SWITCH_FEE_CREDIT = :pulse_switch_fee_credit
15471
+
15442
15472
  # Pulse Tokenization Fee is a fee charged by the Pulse network for processing tokenized transactions on its network.
15443
15473
  PULSE_TOKENIZATION_FEE = :pulse_tokenization_fee
15444
15474
 
@@ -1946,6 +1946,9 @@ module Increase
1946
1946
  # Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network.
1947
1947
  PULSE_SWITCH_FEE = :pulse_switch_fee
1948
1948
 
1949
+ # Pulse Switch Fee Credit is a credit of the Pulse Switch Fee charged for an authorization that was subsequently reversed in full.
1950
+ PULSE_SWITCH_FEE_CREDIT = :pulse_switch_fee_credit
1951
+
1949
1952
  # Pulse Tokenization Fee is a fee charged by the Pulse network for processing tokenized transactions on its network.
1950
1953
  PULSE_TOKENIZATION_FEE = :pulse_tokenization_fee
1951
1954
 
@@ -256,11 +256,19 @@ module Increase
256
256
  # @return [String, nil]
257
257
  required :account_id, String, nil?: true
258
258
 
259
- # @!attribute effective_date
260
- # The UTC date for which to retrieve the balance.
259
+ # @!attribute on_or_after_date
260
+ # The first as-of date (UTC) reported in the BAI2 file. If null, the report
261
+ # started from the earliest included Account.
262
+ #
263
+ # @return [Date, nil]
264
+ required :on_or_after_date, Date, nil?: true
265
+
266
+ # @!attribute on_or_before_date
267
+ # The last as-of date (UTC) reported in the BAI2 file. If null, the report ran
268
+ # through the date the Export was created.
261
269
  #
262
270
  # @return [Date, nil]
263
- required :effective_date, Date, nil?: true
271
+ required :on_or_before_date, Date, nil?: true
264
272
 
265
273
  # @!attribute program_id
266
274
  # Filter results by Program.
@@ -268,13 +276,19 @@ module Increase
268
276
  # @return [String, nil]
269
277
  required :program_id, String, nil?: true
270
278
 
271
- # @!method initialize(account_id:, effective_date:, program_id:)
279
+ # @!method initialize(account_id:, on_or_after_date:, on_or_before_date:, program_id:)
272
280
  # Details of the account statement BAI2 export. This field will be present when
273
281
  # the `category` is equal to `account_statement_bai2`.
274
282
  #
275
283
  # @param account_id [String, nil] Filter results by Account.
276
284
  #
277
- # @param effective_date [Date, nil] The UTC date for which to retrieve the balance.
285
+ # @param on_or_after_date [Date, nil]
286
+ # The first as-of date (UTC) reported in the BAI2 file. If null, the report
287
+ # started from the earliest included Account.
288
+ #
289
+ # @param on_or_before_date [Date, nil]
290
+ # The last as-of date (UTC) reported in the BAI2 file. If null, the report ran
291
+ # through the date the Export was created.
278
292
  #
279
293
  # @param program_id [String, nil] Filter results by Program.
280
294
  end
@@ -15,7 +15,11 @@ module Increase
15
15
 
16
16
  # @!attribute account_statement_bai2
17
17
  # Options for the created export. Required if `category` is equal to
18
- # `account_statement_bai2`.
18
+ # `account_statement_bai2`. Each as-of date from `on_or_after_date` through
19
+ # `on_or_before_date` gets its own BAI2 group (`02` record) in the file. If a
20
+ # group's as-of date is before the UTC date the Export was created, it has
21
+ # end-of-day balances. If it's the UTC date the Export was created, it has
22
+ # intraday balances as of the time the Export was created.
19
23
  #
20
24
  # @return [Increase::Models::ExportCreateParams::AccountStatementBai2, nil]
21
25
  optional :account_statement_bai2, -> { Increase::ExportCreateParams::AccountStatementBai2 }
@@ -93,7 +97,11 @@ module Increase
93
97
  #
94
98
  # @param account_statement_bai2 [Increase::Models::ExportCreateParams::AccountStatementBai2]
95
99
  # Options for the created export. Required if `category` is equal to
96
- # `account_statement_bai2`.
100
+ # `account_statement_bai2`. Each as-of date from `on_or_after_date` through
101
+ # `on_or_before_date` gets its own BAI2 group (`02` record) in the file. If a
102
+ # group's as-of date is before the UTC date the Export was created, it has
103
+ # end-of-day balances. If it's the UTC date the Export was created, it has
104
+ # intraday balances as of the time the Export was created.
97
105
  #
98
106
  # @param account_statement_ofx [Increase::Models::ExportCreateParams::AccountStatementOfx]
99
107
  # Options for the created export. Required if `category` is equal to
@@ -186,13 +194,20 @@ module Increase
186
194
  # @return [String, nil]
187
195
  optional :account_id, String
188
196
 
189
- # @!attribute effective_date
190
- # The UTC date to create a BAI2 report for. If not provided, the current date will
191
- # be used. If the current date is used, the report will include intraday balances,
192
- # otherwise it will include end-of-day balances for the provided date.
197
+ # @!attribute on_or_after_date
198
+ # The first as-of date (UTC) to report. Each as-of date gets its own group in the
199
+ # BAI2 file. If not provided, the report starts from the earliest included
200
+ # Account.
201
+ #
202
+ # @return [Date, nil]
203
+ optional :on_or_after_date, Date
204
+
205
+ # @!attribute on_or_before_date
206
+ # The last as-of date (UTC) to report. If not provided, the report runs through
207
+ # the current UTC date.
193
208
  #
194
209
  # @return [Date, nil]
195
- optional :effective_date, Date
210
+ optional :on_or_before_date, Date
196
211
 
197
212
  # @!attribute program_id
198
213
  # The Program to create a BAI2 report for. If not provided, all open accounts will
@@ -201,18 +216,26 @@ module Increase
201
216
  # @return [String, nil]
202
217
  optional :program_id, String
203
218
 
204
- # @!method initialize(account_id: nil, effective_date: nil, program_id: nil)
219
+ # @!method initialize(account_id: nil, on_or_after_date: nil, on_or_before_date: nil, program_id: nil)
205
220
  # Options for the created export. Required if `category` is equal to
206
- # `account_statement_bai2`.
221
+ # `account_statement_bai2`. Each as-of date from `on_or_after_date` through
222
+ # `on_or_before_date` gets its own BAI2 group (`02` record) in the file. If a
223
+ # group's as-of date is before the UTC date the Export was created, it has
224
+ # end-of-day balances. If it's the UTC date the Export was created, it has
225
+ # intraday balances as of the time the Export was created.
207
226
  #
208
227
  # @param account_id [String]
209
228
  # The Account to create a BAI2 report for. If not provided, all open accounts will
210
229
  # be included.
211
230
  #
212
- # @param effective_date [Date]
213
- # The UTC date to create a BAI2 report for. If not provided, the current date will
214
- # be used. If the current date is used, the report will include intraday balances,
215
- # otherwise it will include end-of-day balances for the provided date.
231
+ # @param on_or_after_date [Date]
232
+ # The first as-of date (UTC) to report. Each as-of date gets its own group in the
233
+ # BAI2 file. If not provided, the report starts from the earliest included
234
+ # Account.
235
+ #
236
+ # @param on_or_before_date [Date]
237
+ # The last as-of date (UTC) to report. If not provided, the report runs through
238
+ # the current UTC date.
216
239
  #
217
240
  # @param program_id [String]
218
241
  # The Program to create a BAI2 report for. If not provided, all open accounts will
@@ -128,7 +128,6 @@ module Increase
128
128
 
129
129
  # @!attribute payee_name_analysis
130
130
  # Whether the details on the check match the recipient name of the check transfer.
131
- # This is an optional feature, contact sales to enable.
132
131
  #
133
132
  # @return [Symbol, Increase::Models::InboundCheckDeposit::PayeeNameAnalysis]
134
133
  required :payee_name_analysis, enum: -> { Increase::InboundCheckDeposit::PayeeNameAnalysis }
@@ -220,7 +219,6 @@ module Increase
220
219
  #
221
220
  # @param payee_name_analysis [Symbol, Increase::Models::InboundCheckDeposit::PayeeNameAnalysis]
222
221
  # Whether the details on the check match the recipient name of the check transfer.
223
- # This is an optional feature, contact sales to enable.
224
222
  #
225
223
  # @param status [Symbol, Increase::Models::InboundCheckDeposit::Status]
226
224
  # The status of the Inbound Check Deposit.
@@ -365,7 +363,6 @@ module Increase
365
363
  end
366
364
 
367
365
  # Whether the details on the check match the recipient name of the check transfer.
368
- # This is an optional feature, contact sales to enable.
369
366
  #
370
367
  # @see Increase::Models::InboundCheckDeposit#payee_name_analysis
371
368
  module PayeeNameAnalysis
@@ -292,6 +292,9 @@ module Increase
292
292
  # The transfer has been declined.
293
293
  DECLINED = :declined
294
294
 
295
+ # The transfer has been returned, in full or in part, to its sender.
296
+ RETURNED = :returned
297
+
295
298
  # The transfer requires attention from an Increase operator.
296
299
  REQUIRES_ATTENTION = :requires_attention
297
300
 
@@ -290,6 +290,17 @@ module Increase
290
290
  -> { Increase::PendingTransaction::Source::FednowTransferInstruction },
291
291
  nil?: true
292
292
 
293
+ # @!attribute inbound_fednow_transfer_return
294
+ # An Inbound FedNow Transfer Return object. This field will be present in the JSON
295
+ # response if and only if `category` is equal to `inbound_fednow_transfer_return`.
296
+ # An Inbound FedNow Transfer Return is created when Increase has received a FedNow
297
+ # transfer and the User requests that it be returned.
298
+ #
299
+ # @return [Increase::Models::PendingTransaction::Source::InboundFednowTransferReturn, nil]
300
+ optional :inbound_fednow_transfer_return,
301
+ -> { Increase::PendingTransaction::Source::InboundFednowTransferReturn },
302
+ nil?: true
303
+
293
304
  # @!attribute inbound_funds_hold
294
305
  # An Inbound Funds Hold object. This field will be present in the JSON response if
295
306
  # and only if `category` is equal to `inbound_funds_hold`. We hold funds for
@@ -379,7 +390,7 @@ module Increase
379
390
  -> { Increase::PendingTransaction::Source::WireTransferInstruction },
380
391
  nil?: true
381
392
 
382
- # @!method initialize(category:, account_transfer_instruction: nil, ach_transfer_instruction: nil, blockchain_offramp_transfer: nil, blockchain_onramp_transfer_instruction: nil, card_authorization: nil, card_push_transfer_instruction: nil, check_deposit_instruction: nil, check_transfer_instruction: nil, fednow_transfer_instruction: nil, inbound_funds_hold: nil, inbound_wire_transfer_reversal: nil, other: nil, real_time_payments_transfer_instruction: nil, sepa_instant_transfer_instruction: nil, swift_transfer_instruction: nil, uk_faster_payment_system_transfer_instruction: nil, user_initiated_hold: nil, wire_transfer_instruction: nil)
393
+ # @!method initialize(category:, account_transfer_instruction: nil, ach_transfer_instruction: nil, blockchain_offramp_transfer: nil, blockchain_onramp_transfer_instruction: nil, card_authorization: nil, card_push_transfer_instruction: nil, check_deposit_instruction: nil, check_transfer_instruction: nil, fednow_transfer_instruction: nil, inbound_fednow_transfer_return: nil, inbound_funds_hold: nil, inbound_wire_transfer_reversal: nil, other: nil, real_time_payments_transfer_instruction: nil, sepa_instant_transfer_instruction: nil, swift_transfer_instruction: nil, uk_faster_payment_system_transfer_instruction: nil, user_initiated_hold: nil, wire_transfer_instruction: nil)
383
394
  # This is an object giving more details on the network-level event that caused the
384
395
  # Pending Transaction. For example, for a card transaction this lists the
385
396
  # merchant's industry and location.
@@ -429,6 +440,12 @@ module Increase
429
440
  # A FedNow Transfer Instruction object. This field will be present in the JSON
430
441
  # response if and only if `category` is equal to `fednow_transfer_instruction`.
431
442
  #
443
+ # @param inbound_fednow_transfer_return [Increase::Models::PendingTransaction::Source::InboundFednowTransferReturn, nil]
444
+ # An Inbound FedNow Transfer Return object. This field will be present in the JSON
445
+ # response if and only if `category` is equal to `inbound_fednow_transfer_return`.
446
+ # An Inbound FedNow Transfer Return is created when Increase has received a FedNow
447
+ # transfer and the User requests that it be returned.
448
+ #
432
449
  # @param inbound_funds_hold [Increase::Models::PendingTransaction::Source::InboundFundsHold, nil]
433
450
  # An Inbound Funds Hold object. This field will be present in the JSON response if
434
451
  # and only if `category` is equal to `inbound_funds_hold`. We hold funds for
@@ -498,6 +515,9 @@ module Increase
498
515
  # FedNow Transfer Instruction: details will be under the `fednow_transfer_instruction` object.
499
516
  FEDNOW_TRANSFER_INSTRUCTION = :fednow_transfer_instruction
500
517
 
518
+ # Inbound FedNow Transfer Return: details will be under the `inbound_fednow_transfer_return` object.
519
+ INBOUND_FEDNOW_TRANSFER_RETURN = :inbound_fednow_transfer_return
520
+
501
521
  # Inbound Funds Hold: details will be under the `inbound_funds_hold` object.
502
522
  INBOUND_FUNDS_HOLD = :inbound_funds_hold
503
523
 
@@ -2221,6 +2241,9 @@ module Increase
2221
2241
  # Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network.
2222
2242
  PULSE_SWITCH_FEE = :pulse_switch_fee
2223
2243
 
2244
+ # Pulse Switch Fee Credit is a credit of the Pulse Switch Fee charged for an authorization that was subsequently reversed in full.
2245
+ PULSE_SWITCH_FEE_CREDIT = :pulse_switch_fee_credit
2246
+
2224
2247
  # Pulse Tokenization Fee is a fee charged by the Pulse network for processing tokenized transactions on its network.
2225
2248
  PULSE_TOKENIZATION_FEE = :pulse_tokenization_fee
2226
2249
 
@@ -2592,6 +2615,58 @@ module Increase
2592
2615
  # @param transfer_id [String] The identifier of the FedNow Transfer that led to this Pending Transaction.
2593
2616
  end
2594
2617
 
2618
+ # @see Increase::Models::PendingTransaction::Source#inbound_fednow_transfer_return
2619
+ class InboundFednowTransferReturn < Increase::Internal::Type::BaseModel
2620
+ # @!attribute inbound_fednow_transfer_id
2621
+ # The identifier of the Inbound FedNow Transfer that is being returned.
2622
+ #
2623
+ # @return [String]
2624
+ required :inbound_fednow_transfer_id, String
2625
+
2626
+ # @!attribute reason
2627
+ # The reason for the return.
2628
+ #
2629
+ # @return [Symbol, Increase::Models::PendingTransaction::Source::InboundFednowTransferReturn::Reason]
2630
+ required :reason, enum: -> { Increase::PendingTransaction::Source::InboundFednowTransferReturn::Reason }
2631
+
2632
+ # @!method initialize(inbound_fednow_transfer_id:, reason:)
2633
+ # An Inbound FedNow Transfer Return object. This field will be present in the JSON
2634
+ # response if and only if `category` is equal to `inbound_fednow_transfer_return`.
2635
+ # An Inbound FedNow Transfer Return is created when Increase has received a FedNow
2636
+ # transfer and the User requests that it be returned.
2637
+ #
2638
+ # @param inbound_fednow_transfer_id [String]
2639
+ # The identifier of the Inbound FedNow Transfer that is being returned.
2640
+ #
2641
+ # @param reason [Symbol, Increase::Models::PendingTransaction::Source::InboundFednowTransferReturn::Reason]
2642
+ # The reason for the return.
2643
+
2644
+ # The reason for the return.
2645
+ #
2646
+ # @see Increase::Models::PendingTransaction::Source::InboundFednowTransferReturn#reason
2647
+ module Reason
2648
+ extend Increase::Internal::Type::Enum
2649
+
2650
+ # The inbound FedNow transfer was a duplicate. Corresponds to the FedNow reason code `DUPL`.
2651
+ DUPLICATE = :duplicate
2652
+
2653
+ # The recipient of the inbound FedNow transfer requested the funds be returned to the sender. Corresponds to the FedNow reason code `CUST`.
2654
+ CREDITOR_REQUEST = :creditor_request
2655
+
2656
+ # The inbound FedNow transfer was for the wrong amount. Corresponds to the FedNow reason code `AM09`.
2657
+ WRONG_AMOUNT = :wrong_amount
2658
+
2659
+ # The recipient of the inbound FedNow transfer was not owed the funds. Corresponds to the FedNow reason code `UPAY`.
2660
+ UNDUE_PAYMENT = :undue_payment
2661
+
2662
+ # The inbound FedNow transfer was determined to be fraudulent. Corresponds to the FedNow reason code `FR01`, and reports the fraud to the Federal Reserve and the sending bank.
2663
+ FRAUD = :fraud
2664
+
2665
+ # @!method self.values
2666
+ # @return [Array<Symbol>]
2667
+ end
2668
+ end
2669
+
2595
2670
  # @see Increase::Models::PendingTransaction::Source#inbound_funds_hold
2596
2671
  class InboundFundsHold < Increase::Internal::Type::BaseModel
2597
2672
  # @!attribute amount
@@ -108,6 +108,9 @@ module Increase
108
108
  # FedNow Transfer Instruction: details will be under the `fednow_transfer_instruction` object.
109
109
  FEDNOW_TRANSFER_INSTRUCTION = :fednow_transfer_instruction
110
110
 
111
+ # Inbound FedNow Transfer Return: details will be under the `inbound_fednow_transfer_return` object.
112
+ INBOUND_FEDNOW_TRANSFER_RETURN = :inbound_fednow_transfer_return
113
+
111
114
  # Inbound Funds Hold: details will be under the `inbound_funds_hold` object.
112
115
  INBOUND_FUNDS_HOLD = :inbound_funds_hold
113
116
 
@@ -18,7 +18,7 @@ module Increase
18
18
  # @!attribute pending_transaction_id
19
19
  # The identifier of the Pending Transaction for the refund or original credit
20
20
  # authorization. If this is provided, `transaction` must not be provided as a
21
- # refund with a refund authorized can not be linked to a regular transaction.
21
+ # refund with a refund authorization can not be linked to a regular transaction.
22
22
  #
23
23
  # @return [String, nil]
24
24
  optional :pending_transaction_id, String
@@ -38,7 +38,7 @@ module Increase
38
38
  # @param pending_transaction_id [String]
39
39
  # The identifier of the Pending Transaction for the refund or original credit
40
40
  # authorization. If this is provided, `transaction` must not be provided as a
41
- # refund with a refund authorized can not be linked to a regular transaction.
41
+ # refund with a refund authorization can not be linked to a regular transaction.
42
42
  #
43
43
  # @param transaction_id [String]
44
44
  # The identifier for the Transaction to refund. The Transaction's source must have
@@ -471,6 +471,18 @@ module Increase
471
471
  -> { Increase::Transaction::Source::InboundFednowTransferConfirmation },
472
472
  nil?: true
473
473
 
474
+ # @!attribute inbound_fednow_transfer_return_acknowledgement
475
+ # An Inbound FedNow Transfer Return Acknowledgement object. This field will be
476
+ # present in the JSON response if and only if `category` is equal to
477
+ # `inbound_fednow_transfer_return_acknowledgement`. An Inbound FedNow Transfer
478
+ # Return Acknowledgement is created when a return of an Inbound FedNow Transfer
479
+ # has been accepted and settled by the FedNow Service.
480
+ #
481
+ # @return [Increase::Models::Transaction::Source::InboundFednowTransferReturnAcknowledgement, nil]
482
+ optional :inbound_fednow_transfer_return_acknowledgement,
483
+ -> { Increase::Transaction::Source::InboundFednowTransferReturnAcknowledgement },
484
+ nil?: true
485
+
474
486
  # @!attribute inbound_real_time_payments_transfer_confirmation
475
487
  # An Inbound Real-Time Payments Transfer Confirmation object. This field will be
476
488
  # present in the JSON response if and only if `category` is equal to
@@ -612,7 +624,7 @@ module Increase
612
624
  },
613
625
  nil?: true
614
626
 
615
- # @!method initialize(category:, account_revenue_payment: nil, account_transfer_intention: nil, ach_transfer_intention: nil, ach_transfer_rejection: nil, ach_transfer_return: nil, blockchain_offramp_transfer_settlement: nil, blockchain_onramp_transfer_intention: nil, card_dispute_acceptance: nil, card_dispute_financial: nil, card_dispute_loss: nil, card_dispute_provisional_credit: nil, card_financial: nil, card_push_transfer_acceptance: nil, card_refund: nil, card_revenue_payment: nil, card_settlement: nil, cashback_payment: nil, check_deposit_acceptance: nil, check_deposit_return: nil, check_transfer_deposit: nil, fednow_transfer_acknowledgement: nil, fednow_transfer_return: nil, fee_payment: nil, inbound_ach_transfer: nil, inbound_ach_transfer_return_intention: nil, inbound_check_adjustment: nil, inbound_check_deposit_return_intention: nil, inbound_fednow_transfer_confirmation: nil, inbound_real_time_payments_transfer_confirmation: nil, inbound_wire_reversal: nil, inbound_wire_transfer: nil, inbound_wire_transfer_reversal: nil, interest_payment: nil, internal_source: nil, other: nil, real_time_payments_transfer_acknowledgement: nil, sample_funds: nil, sepa_instant_transfer_acceptance: nil, swift_transfer_intention: nil, swift_transfer_return: nil, uk_faster_payment_system_transfer_acceptance: nil, wire_transfer_intention: nil)
627
+ # @!method initialize(category:, account_revenue_payment: nil, account_transfer_intention: nil, ach_transfer_intention: nil, ach_transfer_rejection: nil, ach_transfer_return: nil, blockchain_offramp_transfer_settlement: nil, blockchain_onramp_transfer_intention: nil, card_dispute_acceptance: nil, card_dispute_financial: nil, card_dispute_loss: nil, card_dispute_provisional_credit: nil, card_financial: nil, card_push_transfer_acceptance: nil, card_refund: nil, card_revenue_payment: nil, card_settlement: nil, cashback_payment: nil, check_deposit_acceptance: nil, check_deposit_return: nil, check_transfer_deposit: nil, fednow_transfer_acknowledgement: nil, fednow_transfer_return: nil, fee_payment: nil, inbound_ach_transfer: nil, inbound_ach_transfer_return_intention: nil, inbound_check_adjustment: nil, inbound_check_deposit_return_intention: nil, inbound_fednow_transfer_confirmation: nil, inbound_fednow_transfer_return_acknowledgement: nil, inbound_real_time_payments_transfer_confirmation: nil, inbound_wire_reversal: nil, inbound_wire_transfer: nil, inbound_wire_transfer_reversal: nil, interest_payment: nil, internal_source: nil, other: nil, real_time_payments_transfer_acknowledgement: nil, sample_funds: nil, sepa_instant_transfer_acceptance: nil, swift_transfer_intention: nil, swift_transfer_return: nil, uk_faster_payment_system_transfer_acceptance: nil, wire_transfer_intention: nil)
616
628
  # This is an object giving more details on the network-level event that caused the
617
629
  # Transaction. Note that for backwards compatibility reasons, additional
618
630
  # undocumented keys may appear in this object. These should be treated as
@@ -797,6 +809,13 @@ module Increase
797
809
  # is created when a FedNow transfer is initiated at another bank and received by
798
810
  # Increase.
799
811
  #
812
+ # @param inbound_fednow_transfer_return_acknowledgement [Increase::Models::Transaction::Source::InboundFednowTransferReturnAcknowledgement, nil]
813
+ # An Inbound FedNow Transfer Return Acknowledgement object. This field will be
814
+ # present in the JSON response if and only if `category` is equal to
815
+ # `inbound_fednow_transfer_return_acknowledgement`. An Inbound FedNow Transfer
816
+ # Return Acknowledgement is created when a return of an Inbound FedNow Transfer
817
+ # has been accepted and settled by the FedNow Service.
818
+ #
800
819
  # @param inbound_real_time_payments_transfer_confirmation [Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferConfirmation, nil]
801
820
  # An Inbound Real-Time Payments Transfer Confirmation object. This field will be
802
821
  # present in the JSON response if and only if `category` is equal to
@@ -959,6 +978,9 @@ module Increase
959
978
  # Inbound FedNow Transfer Confirmation: details will be under the `inbound_fednow_transfer_confirmation` object.
960
979
  INBOUND_FEDNOW_TRANSFER_CONFIRMATION = :inbound_fednow_transfer_confirmation
961
980
 
981
+ # Inbound FedNow Transfer Return Acknowledgement: details will be under the `inbound_fednow_transfer_return_acknowledgement` object.
982
+ INBOUND_FEDNOW_TRANSFER_RETURN_ACKNOWLEDGEMENT = :inbound_fednow_transfer_return_acknowledgement
983
+
962
984
  # Inbound Real-Time Payments Transfer Confirmation: details will be under the `inbound_real_time_payments_transfer_confirmation` object.
963
985
  INBOUND_REAL_TIME_PAYMENTS_TRANSFER_CONFIRMATION = :inbound_real_time_payments_transfer_confirmation
964
986
 
@@ -3191,6 +3213,9 @@ module Increase
3191
3213
  # Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network.
3192
3214
  PULSE_SWITCH_FEE = :pulse_switch_fee
3193
3215
 
3216
+ # Pulse Switch Fee Credit is a credit of the Pulse Switch Fee charged for an authorization that was subsequently reversed in full.
3217
+ PULSE_SWITCH_FEE_CREDIT = :pulse_switch_fee_credit
3218
+
3194
3219
  # Pulse Tokenization Fee is a fee charged by the Pulse network for processing tokenized transactions on its network.
3195
3220
  PULSE_TOKENIZATION_FEE = :pulse_tokenization_fee
3196
3221
 
@@ -5729,6 +5754,9 @@ module Increase
5729
5754
  # Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network.
5730
5755
  PULSE_SWITCH_FEE = :pulse_switch_fee
5731
5756
 
5757
+ # Pulse Switch Fee Credit is a credit of the Pulse Switch Fee charged for an authorization that was subsequently reversed in full.
5758
+ PULSE_SWITCH_FEE_CREDIT = :pulse_switch_fee_credit
5759
+
5732
5760
  # Pulse Tokenization Fee is a fee charged by the Pulse network for processing tokenized transactions on its network.
5733
5761
  PULSE_TOKENIZATION_FEE = :pulse_tokenization_fee
5734
5762
 
@@ -8148,6 +8176,9 @@ module Increase
8148
8176
  # Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network.
8149
8177
  PULSE_SWITCH_FEE = :pulse_switch_fee
8150
8178
 
8179
+ # Pulse Switch Fee Credit is a credit of the Pulse Switch Fee charged for an authorization that was subsequently reversed in full.
8180
+ PULSE_SWITCH_FEE_CREDIT = :pulse_switch_fee_credit
8181
+
8151
8182
  # Pulse Tokenization Fee is a fee charged by the Pulse network for processing tokenized transactions on its network.
8152
8183
  PULSE_TOKENIZATION_FEE = :pulse_tokenization_fee
8153
8184
 
@@ -9144,6 +9175,60 @@ module Increase
9144
9175
  # @param transfer_id [String] The identifier of the FedNow Transfer that led to this Transaction.
9145
9176
  end
9146
9177
 
9178
+ # @see Increase::Models::Transaction::Source#inbound_fednow_transfer_return_acknowledgement
9179
+ class InboundFednowTransferReturnAcknowledgement < Increase::Internal::Type::BaseModel
9180
+ # @!attribute inbound_fednow_transfer_id
9181
+ # The identifier of the Inbound FedNow Transfer that was returned.
9182
+ #
9183
+ # @return [String]
9184
+ required :inbound_fednow_transfer_id, String
9185
+
9186
+ # @!attribute reason
9187
+ # The reason for the return.
9188
+ #
9189
+ # @return [Symbol, Increase::Models::Transaction::Source::InboundFednowTransferReturnAcknowledgement::Reason]
9190
+ required :reason,
9191
+ enum: -> { Increase::Transaction::Source::InboundFednowTransferReturnAcknowledgement::Reason }
9192
+
9193
+ # @!method initialize(inbound_fednow_transfer_id:, reason:)
9194
+ # An Inbound FedNow Transfer Return Acknowledgement object. This field will be
9195
+ # present in the JSON response if and only if `category` is equal to
9196
+ # `inbound_fednow_transfer_return_acknowledgement`. An Inbound FedNow Transfer
9197
+ # Return Acknowledgement is created when a return of an Inbound FedNow Transfer
9198
+ # has been accepted and settled by the FedNow Service.
9199
+ #
9200
+ # @param inbound_fednow_transfer_id [String]
9201
+ # The identifier of the Inbound FedNow Transfer that was returned.
9202
+ #
9203
+ # @param reason [Symbol, Increase::Models::Transaction::Source::InboundFednowTransferReturnAcknowledgement::Reason]
9204
+ # The reason for the return.
9205
+
9206
+ # The reason for the return.
9207
+ #
9208
+ # @see Increase::Models::Transaction::Source::InboundFednowTransferReturnAcknowledgement#reason
9209
+ module Reason
9210
+ extend Increase::Internal::Type::Enum
9211
+
9212
+ # The inbound FedNow transfer was a duplicate. Corresponds to the FedNow reason code `DUPL`.
9213
+ DUPLICATE = :duplicate
9214
+
9215
+ # The recipient of the inbound FedNow transfer requested the funds be returned to the sender. Corresponds to the FedNow reason code `CUST`.
9216
+ CREDITOR_REQUEST = :creditor_request
9217
+
9218
+ # The inbound FedNow transfer was for the wrong amount. Corresponds to the FedNow reason code `AM09`.
9219
+ WRONG_AMOUNT = :wrong_amount
9220
+
9221
+ # The recipient of the inbound FedNow transfer was not owed the funds. Corresponds to the FedNow reason code `UPAY`.
9222
+ UNDUE_PAYMENT = :undue_payment
9223
+
9224
+ # The inbound FedNow transfer was determined to be fraudulent. Corresponds to the FedNow reason code `FR01`, and reports the fraud to the Federal Reserve and the sending bank.
9225
+ FRAUD = :fraud
9226
+
9227
+ # @!method self.values
9228
+ # @return [Array<Symbol>]
9229
+ end
9230
+ end
9231
+
9147
9232
  # @see Increase::Models::Transaction::Source#inbound_real_time_payments_transfer_confirmation
9148
9233
  class InboundRealTimePaymentsTransferConfirmation < Increase::Internal::Type::BaseModel
9149
9234
  # @!attribute amount
@@ -158,6 +158,9 @@ module Increase
158
158
  # Inbound FedNow Transfer Confirmation: details will be under the `inbound_fednow_transfer_confirmation` object.
159
159
  INBOUND_FEDNOW_TRANSFER_CONFIRMATION = :inbound_fednow_transfer_confirmation
160
160
 
161
+ # Inbound FedNow Transfer Return Acknowledgement: details will be under the `inbound_fednow_transfer_return_acknowledgement` object.
162
+ INBOUND_FEDNOW_TRANSFER_RETURN_ACKNOWLEDGEMENT = :inbound_fednow_transfer_return_acknowledgement
163
+
161
164
  # Inbound Real-Time Payments Transfer Confirmation: details will be under the `inbound_real_time_payments_transfer_confirmation` object.
162
165
  INBOUND_REAL_TIME_PAYMENTS_TRANSFER_CONFIRMATION = :inbound_real_time_payments_transfer_confirmation
163
166
 
@@ -11,7 +11,11 @@ module Increase
11
11
  #
12
12
  # @param account_statement_bai2 [Increase::Models::ExportCreateParams::AccountStatementBai2]
13
13
  # Options for the created export. Required if `category` is equal to
14
- # `account_statement_bai2`.
14
+ # `account_statement_bai2`. Each as-of date from `on_or_after_date` through
15
+ # `on_or_before_date` gets its own BAI2 group (`02` record) in the file. If a
16
+ # group's as-of date is before the UTC date the Export was created, it has
17
+ # end-of-day balances. If it's the UTC date the Export was created, it has
18
+ # intraday balances as of the time the Export was created.
15
19
  #
16
20
  # @param account_statement_ofx [Increase::Models::ExportCreateParams::AccountStatementOfx]
17
21
  # Options for the created export. Required if `category` is equal to
@@ -16,7 +16,7 @@ module Increase
16
16
  # @param pending_transaction_id [String]
17
17
  # The identifier of the Pending Transaction for the refund or original credit
18
18
  # authorization. If this is provided, `transaction` must not be provided as a
19
- # refund with a refund authorized can not be linked to a regular transaction.
19
+ # refund with a refund authorization can not be linked to a regular transaction.
20
20
  #
21
21
  # @param transaction_id [String]
22
22
  # The identifier for the Transaction to refund. The Transaction's source must have
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.367.0"
4
+ VERSION = "1.368.0"
5
5
  end