increase 1.338.0 → 1.340.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (109) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/models/account_create_params.rb +4 -3
  4. data/lib/increase/models/ach_transfer.rb +19 -18
  5. data/lib/increase/models/ach_transfer_create_params.rb +48 -36
  6. data/lib/increase/models/ach_transfer_list_params.rb +1 -1
  7. data/lib/increase/models/beneficial_owner_create_params.rb +5 -3
  8. data/lib/increase/models/beneficial_owner_update_params.rb +2 -1
  9. data/lib/increase/models/card_push_transfer.rb +3 -3
  10. data/lib/increase/models/card_push_transfer_list_params.rb +3 -3
  11. data/lib/increase/models/check_transfer.rb +8 -2
  12. data/lib/increase/models/check_transfer_list_params.rb +3 -0
  13. data/lib/increase/models/entity.rb +8 -6
  14. data/lib/increase/models/entity_create_params.rb +19 -10
  15. data/lib/increase/models/entity_supplemental_document.rb +1 -1
  16. data/lib/increase/models/entity_update_params.rb +5 -4
  17. data/lib/increase/models/fednow_transfer.rb +3 -3
  18. data/lib/increase/models/fednow_transfer_list_params.rb +3 -3
  19. data/lib/increase/models/inbound_mail_item.rb +3 -1
  20. data/lib/increase/models/inbound_real_time_payments_transfer.rb +1 -1
  21. data/lib/increase/models/lockbox_address.rb +5 -1
  22. data/lib/increase/models/lockbox_recipient_create_params.rb +3 -2
  23. data/lib/increase/models/pending_transaction.rb +5 -2
  24. data/lib/increase/models/pending_transaction_list_params.rb +1 -1
  25. data/lib/increase/models/physical_card.rb +5 -2
  26. data/lib/increase/models/real_time_payments_transfer.rb +3 -3
  27. data/lib/increase/models/real_time_payments_transfer_list_params.rb +3 -3
  28. data/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb +3 -2
  29. data/lib/increase/models/simulations/inbound_mail_item_create_params.rb +6 -4
  30. data/lib/increase/models/simulations/physical_card_create_params.rb +5 -2
  31. data/lib/increase/models/swift_transfer.rb +3 -3
  32. data/lib/increase/models/swift_transfer_list_params.rb +3 -3
  33. data/lib/increase/models/transaction.rb +7 -4
  34. data/lib/increase/models/wire_transfer.rb +3 -3
  35. data/lib/increase/models/wire_transfer_list_params.rb +3 -3
  36. data/lib/increase/resources/accounts.rb +1 -1
  37. data/lib/increase/resources/ach_transfers.rb +10 -10
  38. data/lib/increase/resources/beneficial_owners.rb +1 -1
  39. data/lib/increase/resources/inbound_mail_items.rb +3 -1
  40. data/lib/increase/resources/lockbox_addresses.rb +4 -1
  41. data/lib/increase/resources/lockbox_recipients.rb +1 -1
  42. data/lib/increase/resources/simulations/card_authorizations.rb +4 -1
  43. data/lib/increase/resources/simulations/inbound_ach_transfers.rb +1 -1
  44. data/lib/increase/resources/simulations/inbound_mail_items.rb +6 -3
  45. data/lib/increase/version.rb +1 -1
  46. data/rbi/increase/models/account_create_params.rbi +6 -4
  47. data/rbi/increase/models/ach_transfer.rbi +22 -19
  48. data/rbi/increase/models/ach_transfer_create_params.rbi +67 -45
  49. data/rbi/increase/models/ach_transfer_list_params.rbi +1 -1
  50. data/rbi/increase/models/beneficial_owner_create_params.rbi +8 -4
  51. data/rbi/increase/models/beneficial_owner_update_params.rbi +4 -2
  52. data/rbi/increase/models/card_push_transfer.rbi +7 -7
  53. data/rbi/increase/models/card_push_transfer_list_params.rbi +7 -7
  54. data/rbi/increase/models/check_transfer.rbi +16 -2
  55. data/rbi/increase/models/check_transfer_list_params.rbi +7 -0
  56. data/rbi/increase/models/entity.rbi +9 -6
  57. data/rbi/increase/models/entity_create_params.rbi +34 -17
  58. data/rbi/increase/models/entity_supplemental_document.rbi +1 -1
  59. data/rbi/increase/models/entity_update_params.rbi +8 -6
  60. data/rbi/increase/models/fednow_transfer.rbi +7 -7
  61. data/rbi/increase/models/fednow_transfer_list_params.rbi +7 -7
  62. data/rbi/increase/models/inbound_mail_item.rbi +3 -1
  63. data/rbi/increase/models/inbound_real_time_payments_transfer.rbi +1 -1
  64. data/rbi/increase/models/lockbox_address.rbi +5 -1
  65. data/rbi/increase/models/lockbox_recipient_create_params.rbi +4 -2
  66. data/rbi/increase/models/pending_transaction.rbi +9 -3
  67. data/rbi/increase/models/pending_transaction_list_params.rbi +1 -1
  68. data/rbi/increase/models/physical_card.rbi +9 -2
  69. data/rbi/increase/models/real_time_payments_transfer.rbi +7 -7
  70. data/rbi/increase/models/real_time_payments_transfer_list_params.rbi +7 -7
  71. data/rbi/increase/models/simulations/inbound_ach_transfer_create_params.rbi +4 -2
  72. data/rbi/increase/models/simulations/inbound_mail_item_create_params.rbi +8 -4
  73. data/rbi/increase/models/simulations/physical_card_create_params.rbi +9 -2
  74. data/rbi/increase/models/swift_transfer.rbi +7 -7
  75. data/rbi/increase/models/swift_transfer_list_params.rbi +7 -7
  76. data/rbi/increase/models/transaction.rbi +10 -5
  77. data/rbi/increase/models/wire_transfer.rbi +4 -4
  78. data/rbi/increase/models/wire_transfer_list_params.rbi +7 -7
  79. data/rbi/increase/resources/accounts.rbi +3 -2
  80. data/rbi/increase/resources/ach_transfers.rbi +29 -19
  81. data/rbi/increase/resources/beneficial_owners.rbi +2 -1
  82. data/rbi/increase/resources/inbound_mail_items.rbi +3 -1
  83. data/rbi/increase/resources/lockbox_addresses.rbi +4 -1
  84. data/rbi/increase/resources/lockbox_recipients.rbi +2 -1
  85. data/rbi/increase/resources/simulations/card_authorizations.rbi +4 -1
  86. data/rbi/increase/resources/simulations/inbound_ach_transfers.rbi +2 -1
  87. data/rbi/increase/resources/simulations/inbound_mail_items.rbi +8 -3
  88. data/sig/increase/models/ach_transfer.rbs +2 -2
  89. data/sig/increase/models/ach_transfer_create_params.rbs +1 -1
  90. data/sig/increase/models/ach_transfer_list_params.rbs +1 -1
  91. data/sig/increase/models/card_push_transfer.rbs +4 -4
  92. data/sig/increase/models/card_push_transfer_list_params.rbs +4 -4
  93. data/sig/increase/models/check_transfer.rbs +10 -2
  94. data/sig/increase/models/check_transfer_list_params.rbs +4 -0
  95. data/sig/increase/models/fednow_transfer.rbs +5 -5
  96. data/sig/increase/models/fednow_transfer_list_params.rbs +5 -5
  97. data/sig/increase/models/inbound_real_time_payments_transfer.rbs +1 -1
  98. data/sig/increase/models/pending_transaction.rbs +1 -1
  99. data/sig/increase/models/pending_transaction_list_params.rbs +1 -1
  100. data/sig/increase/models/physical_card.rbs +6 -2
  101. data/sig/increase/models/real_time_payments_transfer.rbs +4 -4
  102. data/sig/increase/models/real_time_payments_transfer_list_params.rbs +4 -4
  103. data/sig/increase/models/simulations/physical_card_create_params.rbs +6 -2
  104. data/sig/increase/models/swift_transfer.rbs +4 -4
  105. data/sig/increase/models/swift_transfer_list_params.rbs +4 -4
  106. data/sig/increase/models/wire_transfer.rbs +4 -4
  107. data/sig/increase/models/wire_transfer_list_params.rbs +4 -4
  108. metadata +2 -3
  109. data/CHANGELOG.md +0 -4541
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f2421d28be1ae99adb5ebd0f1d35ec9dc9bde67202bb9a603f87df09aceb1007
4
- data.tar.gz: 27edbc064aaac7181030d074f4afe519af357bb0b5b8345bc85529a780f6656f
3
+ metadata.gz: deae4b48118e89a25a1559893ff12bc9722e553b9eeba2ddaa76ed37f78f7d9c
4
+ data.tar.gz: 9bcd9d146a853046d5b901b3f0e42841865677558650431c2d24f31e33c052a9
5
5
  SHA512:
6
- metadata.gz: 1a2ad5882a85fa5f919c3042f8b55a16a093fac9200d4c081f49797a43003dfc5a942548d558fa615a82c303a93d3293942ab392bb39490cd6deb27ad5468f64
7
- data.tar.gz: 304c56360d05c83059b3905d2883dfea6d0a41e90dc81023f54121e187ac09d11d3dab40926fc438c07341c5d41d3a606fa950ed4e38fa64ff57b8bb403f7b71
6
+ metadata.gz: b6e84bfe78d5de6423532cbbf4556010c4bd0e4696ba8a31840465d4b36d9fb6820b5015a5ce8d7dbf4c68a24658e19b70dc8b9a69f393e2dae8f46e9e1d5206
7
+ data.tar.gz: 9f081ff4b25b781f9dbe47ffc12cc81856e1ab58a3cd47e937d5d85e27cd1e40ea310d664543d74ef8a378cc40a26bca2da6a866ae758c122130f07e795dde51
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.338.0"
18
+ gem "increase", "~> 1.340.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -39,8 +39,9 @@ module Increase
39
39
  optional :loan, -> { Increase::AccountCreateParams::Loan }
40
40
 
41
41
  # @!attribute program_id
42
- # The identifier for the Program that this Account falls under. Required if you
43
- # operate more than one Program.
42
+ # The identifier for the Program that this Account falls under. Required if your
43
+ # Group operates more than one Program. List your [Programs](#programs) to find
44
+ # their identifiers.
44
45
  #
45
46
  # @return [String, nil]
46
47
  optional :program_id, String
@@ -59,7 +60,7 @@ module Increase
59
60
  #
60
61
  # @param loan [Increase::Models::AccountCreateParams::Loan] The loan details for the account.
61
62
  #
62
- # @param program_id [String] The identifier for the Program that this Account falls under. Required if you op
63
+ # @param program_id [String] The identifier for the Program that this Account falls under. Required if your G
63
64
  #
64
65
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
65
66
 
@@ -17,7 +17,7 @@ module Increase
17
17
  required :account_id, String
18
18
 
19
19
  # @!attribute account_number
20
- # The destination account number.
20
+ # The receiver's account number.
21
21
  #
22
22
  # @return [String]
23
23
  required :account_number, String
@@ -109,8 +109,7 @@ module Increase
109
109
  required :currency, enum: -> { Increase::ACHTransfer::Currency }
110
110
 
111
111
  # @!attribute destination_account_holder
112
- # The type of entity that owns the account to which the ACH Transfer is being
113
- # sent.
112
+ # The type of entity that owns the receiver's account.
114
113
  #
115
114
  # @return [Symbol, Increase::Models::ACHTransfer::DestinationAccountHolder]
116
115
  required :destination_account_holder, enum: -> { Increase::ACHTransfer::DestinationAccountHolder }
@@ -122,7 +121,7 @@ module Increase
122
121
  required :external_account_id, String, nil?: true
123
122
 
124
123
  # @!attribute funding
125
- # The type of the account to which the transfer will be sent.
124
+ # The type of the receiver's bank account.
126
125
  #
127
126
  # @return [Symbol, Increase::Models::ACHTransfer::Funding]
128
127
  required :funding, enum: -> { Increase::ACHTransfer::Funding }
@@ -143,7 +142,8 @@ module Increase
143
142
  required :inbound_funds_hold, -> { Increase::ACHTransfer::InboundFundsHold }, nil?: true
144
143
 
145
144
  # @!attribute individual_id
146
- # Your identifier for the transfer recipient.
145
+ # Your internal identifier for the transfer recipient. This value is informational
146
+ # and not verified by the recipient's bank.
147
147
  #
148
148
  # @return [String, nil]
149
149
  required :individual_id, String, nil?: true
@@ -194,7 +194,8 @@ module Increase
194
194
  required :return_, -> { Increase::ACHTransfer::Return }, api_name: :return, nil?: true
195
195
 
196
196
  # @!attribute routing_number
197
- # The American Bankers' Association (ABA) Routing Transit Number (RTN).
197
+ # The American Bankers' Association (ABA) Routing Transit Number (RTN) of the
198
+ # receiver's bank.
198
199
  #
199
200
  # @return [String]
200
201
  required :routing_number, String
@@ -260,7 +261,7 @@ module Increase
260
261
  #
261
262
  # @param account_id [String] The Account to which the transfer belongs.
262
263
  #
263
- # @param account_number [String] The destination account number.
264
+ # @param account_number [String] The receiver's account number.
264
265
  #
265
266
  # @param acknowledgement [Increase::Models::ACHTransfer::Acknowledgement, nil] After the transfer is acknowledged by FedACH, this will contain supplemental det
266
267
  #
@@ -288,17 +289,17 @@ module Increase
288
289
  #
289
290
  # @param currency [Symbol, Increase::Models::ACHTransfer::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's c
290
291
  #
291
- # @param destination_account_holder [Symbol, Increase::Models::ACHTransfer::DestinationAccountHolder] The type of entity that owns the account to which the ACH Transfer is being sent
292
+ # @param destination_account_holder [Symbol, Increase::Models::ACHTransfer::DestinationAccountHolder] The type of entity that owns the receiver's account.
292
293
  #
293
294
  # @param external_account_id [String, nil] The identifier of the External Account the transfer was made to, if any.
294
295
  #
295
- # @param funding [Symbol, Increase::Models::ACHTransfer::Funding] The type of the account to which the transfer will be sent.
296
+ # @param funding [Symbol, Increase::Models::ACHTransfer::Funding] The type of the receiver's bank account.
296
297
  #
297
298
  # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
298
299
  #
299
300
  # @param inbound_funds_hold [Increase::Models::ACHTransfer::InboundFundsHold, nil] Increase will sometimes hold the funds for ACH debit transfers. If funds are hel
300
301
  #
301
- # @param individual_id [String, nil] Your identifier for the transfer recipient.
302
+ # @param individual_id [String, nil] Your internal identifier for the transfer recipient. This value is informational
302
303
  #
303
304
  # @param individual_name [String, nil] The name of the transfer recipient. This value is informational and not verified
304
305
  #
@@ -312,7 +313,7 @@ module Increase
312
313
  #
313
314
  # @param return_ [Increase::Models::ACHTransfer::Return, nil] If your transfer is returned, this will contain details of the return.
314
315
  #
315
- # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN).
316
+ # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) of the rece
316
317
  #
317
318
  # @param settlement [Increase::Models::ACHTransfer::Settlement, nil] A subhash containing information about when and how the transfer settled at the
318
319
  #
@@ -640,8 +641,7 @@ module Increase
640
641
  # @return [Array<Symbol>]
641
642
  end
642
643
 
643
- # The type of entity that owns the account to which the ACH Transfer is being
644
- # sent.
644
+ # The type of entity that owns the receiver's account.
645
645
  #
646
646
  # @see Increase::Models::ACHTransfer#destination_account_holder
647
647
  module DestinationAccountHolder
@@ -660,7 +660,7 @@ module Increase
660
660
  # @return [Array<Symbol>]
661
661
  end
662
662
 
663
- # The type of the account to which the transfer will be sent.
663
+ # The type of the receiver's bank account.
664
664
  #
665
665
  # @see Increase::Models::ACHTransfer#funding
666
666
  module Funding
@@ -1019,7 +1019,7 @@ module Increase
1019
1019
  # The chosen effective date will be the same as the ACH processing date on which the transfer is submitted.
1020
1020
  # This is necessary, but not sufficient for the transfer to be settled same-day:
1021
1021
  # it must also be submitted before the last same-day cutoff
1022
- # and be less than or equal to $1,000.000.00.
1022
+ # and be less than or equal to $1,000,000.00.
1023
1023
  SAME_DAY = :same_day
1024
1024
 
1025
1025
  # The chosen effective date will be the business day following the ACH processing date on which the transfer is submitted. The transfer will be settled on that future day.
@@ -1068,7 +1068,8 @@ module Increase
1068
1068
  required :transaction_id, String
1069
1069
 
1070
1070
  # @!attribute transfer_id
1071
- # The identifier of the ACH Transfer associated with this return.
1071
+ # The identifier of the ACH Transfer associated with this return. This matches the
1072
+ # original Transaction's `source.ach_transfer_intention.transfer_id`.
1072
1073
  #
1073
1074
  # @return [String]
1074
1075
  required :transfer_id, String
@@ -1089,7 +1090,7 @@ module Increase
1089
1090
  #
1090
1091
  # @param transaction_id [String] The identifier of the Transaction associated with this return.
1091
1092
  #
1092
- # @param transfer_id [String] The identifier of the ACH Transfer associated with this return.
1093
+ # @param transfer_id [String] The identifier of the ACH Transfer associated with this return. This matches the
1093
1094
 
1094
1095
  # Why the ACH Transfer was returned. This reason code is sent by the receiving
1095
1096
  # bank back to Increase.
@@ -1386,7 +1387,7 @@ module Increase
1386
1387
  # The transfer has been rejected.
1387
1388
  REJECTED = :rejected
1388
1389
 
1389
- # The transfer is complete.
1390
+ # The transfer has been submitted to the Federal Reserve. When the transfer settles, the status remains `submitted` and the `settlement` sub-object is populated.
1390
1391
  SUBMITTED = :submitted
1391
1392
 
1392
1393
  # The transfer has been returned.
@@ -33,50 +33,58 @@ module Increase
33
33
  required :statement_descriptor, String
34
34
 
35
35
  # @!attribute account_number
36
- # The account number for the destination account.
36
+ # The receiver's account number. For credit transfers (positive `amount`) this is
37
+ # the account that funds will be sent to. For debit transfers (negative `amount`)
38
+ # this is the account that funds will be pulled from.
37
39
  #
38
40
  # @return [String, nil]
39
41
  optional :account_number, String
40
42
 
41
43
  # @!attribute addenda
42
- # Additional information that will be sent to the recipient. This is included in
43
- # the transfer data sent to the receiving bank.
44
+ # Additional information passed through to the receiving bank with the transfer.
45
+ # Most ACH transfers do not need this. Only set this if your recipient has asked
46
+ # for addendum data, typically unstructured remittance information. Corporate
47
+ # Trade Exchange (CTX) flows can carry structured X12 remittance advice instead.
44
48
  #
45
49
  # @return [Increase::Models::ACHTransferCreateParams::Addenda, nil]
46
50
  optional :addenda, -> { Increase::ACHTransferCreateParams::Addenda }
47
51
 
48
52
  # @!attribute company_descriptive_date
49
- # The description of the date of the transfer, usually in the format `YYMMDD`.
50
- # This is included in the transfer data sent to the receiving bank.
53
+ # A description of the transfer date (typically `YYMMDD`), sent in the company
54
+ # batch header. This value is informational and does not affect funds movement,
55
+ # settlement timing, or returns. Only set this if your recipient has asked for it.
51
56
  #
52
57
  # @return [String, nil]
53
58
  optional :company_descriptive_date, String
54
59
 
55
60
  # @!attribute company_discretionary_data
56
- # The data you choose to associate with the transfer. This is included in the
57
- # transfer data sent to the receiving bank.
61
+ # Custom data sent in the company batch header. This value is informational and
62
+ # does not affect funds movement, settlement timing, or returns. Most ACH
63
+ # transfers do not need this. Only set this if your recipient has asked for it.
58
64
  #
59
65
  # @return [String, nil]
60
66
  optional :company_discretionary_data, String
61
67
 
62
68
  # @!attribute company_entry_description
63
- # A description of the transfer, included in the transfer data sent to the
64
- # receiving bank. Standardized formatting may be required, for example `PAYROLL`
65
- # for payroll-related Prearranged Payments and Deposits (PPD) credit transfers.
69
+ # A short description sent in the company batch header. Most receivers do not
70
+ # surface this. Only set this if your recipient has asked for a specific value or
71
+ # if Nacha mandates one for your Standard Entry Class (SEC) code and use case. For
72
+ # example, Prearranged Payment and Deposit (PPD) payroll credits must use
73
+ # `PAYROLL`, and reversals must use `REVERSAL`.
66
74
  #
67
75
  # @return [String, nil]
68
76
  optional :company_entry_description, String
69
77
 
70
78
  # @!attribute company_name
71
- # The name by which the recipient knows you. This is included in the transfer data
72
- # sent to the receiving bank.
79
+ # The name by which the recipient knows you, sent in the company batch header. We
80
+ # recommend setting this on every transfer; if you do not, we fall back to the ACH
81
+ # company name configured on your account.
73
82
  #
74
83
  # @return [String, nil]
75
84
  optional :company_name, String
76
85
 
77
86
  # @!attribute destination_account_holder
78
- # The type of entity that owns the account to which the ACH Transfer is being
79
- # sent.
87
+ # The type of entity that owns the receiver's account.
80
88
  #
81
89
  # @return [Symbol, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder, nil]
82
90
  optional :destination_account_holder,
@@ -90,13 +98,14 @@ module Increase
90
98
  optional :external_account_id, String
91
99
 
92
100
  # @!attribute funding
93
- # The type of the account to which the transfer will be sent.
101
+ # The type of the receiver's bank account.
94
102
  #
95
103
  # @return [Symbol, Increase::Models::ACHTransferCreateParams::Funding, nil]
96
104
  optional :funding, enum: -> { Increase::ACHTransferCreateParams::Funding }
97
105
 
98
106
  # @!attribute individual_id
99
- # Your identifier for the transfer recipient.
107
+ # Your internal identifier for the transfer recipient. This value is informational
108
+ # and not verified by the recipient's bank. Most callers can leave this unset.
100
109
  #
101
110
  # @return [String, nil]
102
111
  optional :individual_id, String
@@ -124,8 +133,8 @@ module Increase
124
133
  optional :require_approval, Increase::Internal::Type::Boolean
125
134
 
126
135
  # @!attribute routing_number
127
- # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
128
- # destination account.
136
+ # The American Bankers' Association (ABA) Routing Transit Number (RTN) of the
137
+ # receiver's bank.
129
138
  #
130
139
  # @return [String, nil]
131
140
  optional :routing_number, String
@@ -133,7 +142,8 @@ module Increase
133
142
  # @!attribute standard_entry_class_code
134
143
  # The
135
144
  # [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
136
- # to use for the transfer.
145
+ # to use for the transfer. If not provided, the default is
146
+ # `corporate_credit_or_debit`.
137
147
  #
138
148
  # @return [Symbol, Increase::Models::ACHTransferCreateParams::StandardEntryClassCode, nil]
139
149
  optional :standard_entry_class_code,
@@ -155,25 +165,25 @@ module Increase
155
165
  #
156
166
  # @param statement_descriptor [String] A description you choose to give the transfer. This will be saved with the trans
157
167
  #
158
- # @param account_number [String] The account number for the destination account.
168
+ # @param account_number [String] The receiver's account number. For credit transfers (positive `amount`) this is
159
169
  #
160
- # @param addenda [Increase::Models::ACHTransferCreateParams::Addenda] Additional information that will be sent to the recipient. This is included in t
170
+ # @param addenda [Increase::Models::ACHTransferCreateParams::Addenda] Additional information passed through to the receiving bank with the transfer. M
161
171
  #
162
- # @param company_descriptive_date [String] The description of the date of the transfer, usually in the format `YYMMDD`. Thi
172
+ # @param company_descriptive_date [String] A description of the transfer date (typically `YYMMDD`), sent in the company bat
163
173
  #
164
- # @param company_discretionary_data [String] The data you choose to associate with the transfer. This is included in the tran
174
+ # @param company_discretionary_data [String] Custom data sent in the company batch header. This value is informational and do
165
175
  #
166
- # @param company_entry_description [String] A description of the transfer, included in the transfer data sent to the receivi
176
+ # @param company_entry_description [String] A short description sent in the company batch header. Most receivers do not surf
167
177
  #
168
- # @param company_name [String] The name by which the recipient knows you. This is included in the transfer data
178
+ # @param company_name [String] The name by which the recipient knows you, sent in the company batch header. We
169
179
  #
170
- # @param destination_account_holder [Symbol, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder] The type of entity that owns the account to which the ACH Transfer is being sent
180
+ # @param destination_account_holder [Symbol, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder] The type of entity that owns the receiver's account.
171
181
  #
172
182
  # @param external_account_id [String] The ID of an External Account to initiate a transfer to. If this parameter is pr
173
183
  #
174
- # @param funding [Symbol, Increase::Models::ACHTransferCreateParams::Funding] The type of the account to which the transfer will be sent.
184
+ # @param funding [Symbol, Increase::Models::ACHTransferCreateParams::Funding] The type of the receiver's bank account.
175
185
  #
176
- # @param individual_id [String] Your identifier for the transfer recipient.
186
+ # @param individual_id [String] Your internal identifier for the transfer recipient. This value is informational
177
187
  #
178
188
  # @param individual_name [String] The name of the transfer recipient. This value is informational and not verified
179
189
  #
@@ -181,7 +191,7 @@ module Increase
181
191
  #
182
192
  # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
183
193
  #
184
- # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des
194
+ # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) of the rece
185
195
  #
186
196
  # @param standard_entry_class_code [Symbol, Increase::Models::ACHTransferCreateParams::StandardEntryClassCode] The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-co
187
197
  #
@@ -216,8 +226,10 @@ module Increase
216
226
  # Some parameter documentations has been truncated, see
217
227
  # {Increase::Models::ACHTransferCreateParams::Addenda} for more details.
218
228
  #
219
- # Additional information that will be sent to the recipient. This is included in
220
- # the transfer data sent to the receiving bank.
229
+ # Additional information passed through to the receiving bank with the transfer.
230
+ # Most ACH transfers do not need this. Only set this if your recipient has asked
231
+ # for addendum data, typically unstructured remittance information. Corporate
232
+ # Trade Exchange (CTX) flows can carry structured X12 remittance advice instead.
221
233
  #
222
234
  # @param category [Symbol, Increase::Models::ACHTransferCreateParams::Addenda::Category] The type of addenda to pass with the transfer.
223
235
  #
@@ -315,8 +327,7 @@ module Increase
315
327
  end
316
328
  end
317
329
 
318
- # The type of entity that owns the account to which the ACH Transfer is being
319
- # sent.
330
+ # The type of entity that owns the receiver's account.
320
331
  module DestinationAccountHolder
321
332
  extend Increase::Internal::Type::Enum
322
333
 
@@ -333,7 +344,7 @@ module Increase
333
344
  # @return [Array<Symbol>]
334
345
  end
335
346
 
336
- # The type of the account to which the transfer will be sent.
347
+ # The type of the receiver's bank account.
337
348
  module Funding
338
349
  extend Increase::Internal::Type::Enum
339
350
 
@@ -388,7 +399,7 @@ module Increase
388
399
  module SettlementSchedule
389
400
  extend Increase::Internal::Type::Enum
390
401
 
391
- # The chosen effective date will be the same as the ACH processing date on which the transfer is submitted. This is necessary, but not sufficient for the transfer to be settled same-day: it must also be submitted before the last same-day cutoff and be less than or equal to $1,000.000.00.
402
+ # The chosen effective date will be the same as the ACH processing date on which the transfer is submitted. This is necessary, but not sufficient for the transfer to be settled same-day: it must also be submitted before the last same-day cutoff and be less than or equal to $1,000,000.00.
392
403
  SAME_DAY = :same_day
393
404
 
394
405
  # The chosen effective date will be the business day following the ACH processing date on which the transfer is submitted. The transfer will be settled on that future day.
@@ -401,7 +412,8 @@ module Increase
401
412
 
402
413
  # The
403
414
  # [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
404
- # to use for the transfer.
415
+ # to use for the transfer. If not provided, the default is
416
+ # `corporate_credit_or_debit`.
405
417
  module StandardEntryClassCode
406
418
  extend Increase::Internal::Type::Enum
407
419
 
@@ -153,7 +153,7 @@ module Increase
153
153
  # The transfer has been rejected.
154
154
  REJECTED = :rejected
155
155
 
156
- # The transfer is complete.
156
+ # The transfer has been submitted to the Federal Reserve. When the transfer settles, the status remains `submitted` and the `settlement` sub-object is populated.
157
157
  SUBMITTED = :submitted
158
158
 
159
159
  # The transfer has been returned.
@@ -8,7 +8,8 @@ module Increase
8
8
  include Increase::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute entity_id
11
- # The identifier of the Entity to associate with the new Beneficial Owner.
11
+ # The identifier of the Entity to associate with the new Beneficial Owner. Only
12
+ # `corporation` entities have beneficial owners.
12
13
  #
13
14
  # @return [String]
14
15
  required :entity_id, String
@@ -38,7 +39,7 @@ module Increase
38
39
  # Some parameter documentations has been truncated, see
39
40
  # {Increase::Models::BeneficialOwnerCreateParams} for more details.
40
41
  #
41
- # @param entity_id [String] The identifier of the Entity to associate with the new Beneficial Owner.
42
+ # @param entity_id [String] The identifier of the Entity to associate with the new Beneficial Owner. Only `c
42
43
  #
43
44
  # @param individual [Increase::Models::BeneficialOwnerCreateParams::Individual] Personal details for the beneficial owner.
44
45
  #
@@ -173,7 +174,8 @@ module Increase
173
174
  # An identification number that can be used to verify the individual's identity,
174
175
  # such as a social security number. For Social Security Numbers and Individual
175
176
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
176
- # separators.
177
+ # separators. When testing in sandbox, use one of our
178
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
177
179
  #
178
180
  # @return [String]
179
181
  required :number, String
@@ -140,7 +140,8 @@ module Increase
140
140
  # An identification number that can be used to verify the individual's identity,
141
141
  # such as a social security number. For Social Security Numbers and Individual
142
142
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
143
- # separators.
143
+ # separators. When testing in sandbox, use one of our
144
+ # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
144
145
  #
145
146
  # @return [String]
146
147
  required :number, String
@@ -1380,15 +1380,15 @@ module Increase
1380
1380
  # The transfer has been canceled.
1381
1381
  CANCELED = :canceled
1382
1382
 
1383
+ # The transfer is queued to be submitted to the card network.
1384
+ PENDING_SUBMISSION = :pending_submission
1385
+
1383
1386
  # The transfer is pending review by Increase.
1384
1387
  PENDING_REVIEWING = :pending_reviewing
1385
1388
 
1386
1389
  # The transfer requires attention from an Increase operator.
1387
1390
  REQUIRES_ATTENTION = :requires_attention
1388
1391
 
1389
- # The transfer is queued to be submitted to the card network.
1390
- PENDING_SUBMISSION = :pending_submission
1391
-
1392
1392
  # The transfer has been submitted and is pending a response from the card network.
1393
1393
  SUBMITTED = :submitted
1394
1394
 
@@ -132,15 +132,15 @@ module Increase
132
132
  # The transfer has been canceled.
133
133
  CANCELED = :canceled
134
134
 
135
+ # The transfer is queued to be submitted to the card network.
136
+ PENDING_SUBMISSION = :pending_submission
137
+
135
138
  # The transfer is pending review by Increase.
136
139
  PENDING_REVIEWING = :pending_reviewing
137
140
 
138
141
  # The transfer requires attention from an Increase operator.
139
142
  REQUIRES_ATTENTION = :requires_attention
140
143
 
141
- # The transfer is queued to be submitted to the card network.
142
- PENDING_SUBMISSION = :pending_submission
143
-
144
144
  # The transfer has been submitted and is pending a response from the card network.
145
145
  SUBMITTED = :submitted
146
146
 
@@ -788,10 +788,13 @@ module Increase
788
788
  # The check has been delivered. Note that some couriers track delivery status based on driver location data rather than an explicit scan. While uncommon, a single check may have more than one delivered event.
789
789
  DELIVERED = :delivered
790
790
 
791
- # There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the check will be returned to sender.
791
+ # There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the check will be rerouted to the return address.
792
792
  DELIVERY_ISSUE = :delivery_issue
793
793
 
794
- # Delivery failed and the check was returned to sender.
794
+ # The check has been rerouted to the return address.
795
+ RETURNING_TO_SENDER = :returning_to_sender
796
+
797
+ # The check has been delivered to the return address.
795
798
  RETURNED_TO_SENDER = :returned_to_sender
796
799
 
797
800
  # @!method self.values
@@ -815,6 +818,9 @@ module Increase
815
818
  # The transfer is pending submission.
816
819
  PENDING_SUBMISSION = :pending_submission
817
820
 
821
+ # The transfer is pending review by Increase.
822
+ PENDING_REVIEWING = :pending_reviewing
823
+
818
824
  # The transfer requires attention from an Increase operator.
819
825
  REQUIRES_ATTENTION = :requires_attention
820
826
 
@@ -136,6 +136,9 @@ module Increase
136
136
  # The transfer is pending submission.
137
137
  PENDING_SUBMISSION = :pending_submission
138
138
 
139
+ # The transfer is pending review by Increase.
140
+ PENDING_REVIEWING = :pending_reviewing
141
+
139
142
  # The transfer requires attention from an Increase operator.
140
143
  REQUIRES_ATTENTION = :requires_attention
141
144
 
@@ -140,7 +140,7 @@ module Increase
140
140
  # for more details.
141
141
  #
142
142
  # Entities are the legal entities that own accounts. They can be people,
143
- # corporations, partnerships, government authorities, or trusts. To learn more,
143
+ # corporations, joint accounts, trusts, or government authorities. To learn more,
144
144
  # see [Entities](/documentation/entities).
145
145
  #
146
146
  # @param id [String] The entity's identifier.
@@ -227,7 +227,8 @@ module Increase
227
227
  required :industry_code, String, nil?: true
228
228
 
229
229
  # @!attribute legal_identifier
230
- # The legal identifier of the corporation.
230
+ # The legal identifier of the corporation, like an Employer Identification Number
231
+ # (EIN).
231
232
  #
232
233
  # @return [Increase::Models::Entity::Corporation::LegalIdentifier, nil]
233
234
  required :legal_identifier, -> { Increase::Entity::Corporation::LegalIdentifier }, nil?: true
@@ -263,7 +264,7 @@ module Increase
263
264
  #
264
265
  # @param industry_code [String, nil] The numeric North American Industry Classification System (NAICS) code submitted
265
266
  #
266
- # @param legal_identifier [Increase::Models::Entity::Corporation::LegalIdentifier, nil] The legal identifier of the corporation.
267
+ # @param legal_identifier [Increase::Models::Entity::Corporation::LegalIdentifier, nil] The legal identifier of the corporation, like an Employer Identification Number
267
268
  #
268
269
  # @param name [String] The legal name of the corporation.
269
270
  #
@@ -563,17 +564,18 @@ module Increase
563
564
  required :category, enum: -> { Increase::Entity::Corporation::LegalIdentifier::Category }
564
565
 
565
566
  # @!attribute value
566
- # The identifier of the legal identifier.
567
+ # The legal identifier itself.
567
568
  #
568
569
  # @return [String]
569
570
  required :value, String
570
571
 
571
572
  # @!method initialize(category:, value:)
572
- # The legal identifier of the corporation.
573
+ # The legal identifier of the corporation, like an Employer Identification Number
574
+ # (EIN).
573
575
  #
574
576
  # @param category [Symbol, Increase::Models::Entity::Corporation::LegalIdentifier::Category] The category of the legal identifier.
575
577
  #
576
- # @param value [String] The identifier of the legal identifier.
578
+ # @param value [String] The legal identifier itself.
577
579
 
578
580
  # The category of the legal identifier.
579
581
  #