increase 1.338.0 → 1.339.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 +4 -4
- data/README.md +1 -1
- data/lib/increase/models/account_create_params.rb +4 -3
- data/lib/increase/models/ach_transfer.rb +19 -18
- data/lib/increase/models/ach_transfer_create_params.rb +48 -36
- data/lib/increase/models/ach_transfer_list_params.rb +1 -1
- data/lib/increase/models/beneficial_owner_create_params.rb +2 -1
- data/lib/increase/models/beneficial_owner_update_params.rb +2 -1
- data/lib/increase/models/card_push_transfer.rb +3 -3
- data/lib/increase/models/card_push_transfer_list_params.rb +3 -3
- data/lib/increase/models/check_transfer.rb +5 -2
- data/lib/increase/models/entity_create_params.rb +16 -8
- data/lib/increase/models/entity_update_params.rb +2 -1
- data/lib/increase/models/fednow_transfer.rb +3 -3
- data/lib/increase/models/fednow_transfer_list_params.rb +3 -3
- data/lib/increase/models/inbound_mail_item.rb +3 -1
- data/lib/increase/models/inbound_real_time_payments_transfer.rb +1 -1
- data/lib/increase/models/lockbox_address.rb +5 -1
- data/lib/increase/models/lockbox_recipient_create_params.rb +3 -2
- data/lib/increase/models/pending_transaction.rb +5 -2
- data/lib/increase/models/pending_transaction_list_params.rb +1 -1
- data/lib/increase/models/physical_card.rb +5 -2
- data/lib/increase/models/real_time_payments_transfer.rb +3 -3
- data/lib/increase/models/real_time_payments_transfer_list_params.rb +3 -3
- data/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb +3 -2
- data/lib/increase/models/simulations/inbound_mail_item_create_params.rb +6 -4
- data/lib/increase/models/simulations/physical_card_create_params.rb +5 -2
- data/lib/increase/models/swift_transfer.rb +3 -3
- data/lib/increase/models/swift_transfer_list_params.rb +3 -3
- data/lib/increase/models/transaction.rb +7 -4
- data/lib/increase/models/wire_transfer.rb +3 -3
- data/lib/increase/models/wire_transfer_list_params.rb +3 -3
- data/lib/increase/resources/accounts.rb +1 -1
- data/lib/increase/resources/ach_transfers.rb +10 -10
- data/lib/increase/resources/inbound_mail_items.rb +3 -1
- data/lib/increase/resources/lockbox_addresses.rb +4 -1
- data/lib/increase/resources/lockbox_recipients.rb +1 -1
- data/lib/increase/resources/simulations/card_authorizations.rb +4 -1
- data/lib/increase/resources/simulations/inbound_ach_transfers.rb +1 -1
- data/lib/increase/resources/simulations/inbound_mail_items.rb +6 -3
- data/lib/increase/version.rb +1 -1
- data/rbi/increase/models/account_create_params.rbi +6 -4
- data/rbi/increase/models/ach_transfer.rbi +22 -19
- data/rbi/increase/models/ach_transfer_create_params.rbi +67 -45
- data/rbi/increase/models/ach_transfer_list_params.rbi +1 -1
- data/rbi/increase/models/beneficial_owner_create_params.rbi +4 -2
- data/rbi/increase/models/beneficial_owner_update_params.rbi +4 -2
- data/rbi/increase/models/card_push_transfer.rbi +7 -7
- data/rbi/increase/models/card_push_transfer_list_params.rbi +7 -7
- data/rbi/increase/models/check_transfer.rbi +9 -2
- data/rbi/increase/models/entity_create_params.rbi +30 -15
- data/rbi/increase/models/entity_update_params.rbi +4 -2
- data/rbi/increase/models/fednow_transfer.rbi +7 -7
- data/rbi/increase/models/fednow_transfer_list_params.rbi +7 -7
- data/rbi/increase/models/inbound_mail_item.rbi +3 -1
- data/rbi/increase/models/inbound_real_time_payments_transfer.rbi +1 -1
- data/rbi/increase/models/lockbox_address.rbi +5 -1
- data/rbi/increase/models/lockbox_recipient_create_params.rbi +4 -2
- data/rbi/increase/models/pending_transaction.rbi +9 -3
- data/rbi/increase/models/pending_transaction_list_params.rbi +1 -1
- data/rbi/increase/models/physical_card.rbi +9 -2
- data/rbi/increase/models/real_time_payments_transfer.rbi +7 -7
- data/rbi/increase/models/real_time_payments_transfer_list_params.rbi +7 -7
- data/rbi/increase/models/simulations/inbound_ach_transfer_create_params.rbi +4 -2
- data/rbi/increase/models/simulations/inbound_mail_item_create_params.rbi +8 -4
- data/rbi/increase/models/simulations/physical_card_create_params.rbi +9 -2
- data/rbi/increase/models/swift_transfer.rbi +7 -7
- data/rbi/increase/models/swift_transfer_list_params.rbi +7 -7
- data/rbi/increase/models/transaction.rbi +10 -5
- data/rbi/increase/models/wire_transfer.rbi +4 -4
- data/rbi/increase/models/wire_transfer_list_params.rbi +7 -7
- data/rbi/increase/resources/accounts.rbi +3 -2
- data/rbi/increase/resources/ach_transfers.rbi +29 -19
- data/rbi/increase/resources/inbound_mail_items.rbi +3 -1
- data/rbi/increase/resources/lockbox_addresses.rbi +4 -1
- data/rbi/increase/resources/lockbox_recipients.rbi +2 -1
- data/rbi/increase/resources/simulations/card_authorizations.rbi +4 -1
- data/rbi/increase/resources/simulations/inbound_ach_transfers.rbi +2 -1
- data/rbi/increase/resources/simulations/inbound_mail_items.rbi +8 -3
- data/sig/increase/models/ach_transfer.rbs +2 -2
- data/sig/increase/models/ach_transfer_create_params.rbs +1 -1
- data/sig/increase/models/ach_transfer_list_params.rbs +1 -1
- data/sig/increase/models/card_push_transfer.rbs +4 -4
- data/sig/increase/models/card_push_transfer_list_params.rbs +4 -4
- data/sig/increase/models/check_transfer.rbs +6 -2
- data/sig/increase/models/fednow_transfer.rbs +5 -5
- data/sig/increase/models/fednow_transfer_list_params.rbs +5 -5
- data/sig/increase/models/inbound_real_time_payments_transfer.rbs +1 -1
- data/sig/increase/models/pending_transaction.rbs +1 -1
- data/sig/increase/models/pending_transaction_list_params.rbs +1 -1
- data/sig/increase/models/physical_card.rbs +6 -2
- data/sig/increase/models/real_time_payments_transfer.rbs +4 -4
- data/sig/increase/models/real_time_payments_transfer_list_params.rbs +4 -4
- data/sig/increase/models/simulations/physical_card_create_params.rbs +6 -2
- data/sig/increase/models/swift_transfer.rbs +4 -4
- data/sig/increase/models/swift_transfer_list_params.rbs +4 -4
- data/sig/increase/models/wire_transfer.rbs +4 -4
- data/sig/increase/models/wire_transfer_list_params.rbs +4 -4
- metadata +2 -3
- data/CHANGELOG.md +0 -4541
|
@@ -18,7 +18,8 @@ module Increase
|
|
|
18
18
|
sig { returns(String) }
|
|
19
19
|
attr_accessor :account_id
|
|
20
20
|
|
|
21
|
-
# The Lockbox Address where this Lockbox Recipient may receive mail.
|
|
21
|
+
# The Lockbox Address where this Lockbox Recipient may receive mail. The Lockbox
|
|
22
|
+
# Address must have a `status` of `active`.
|
|
22
23
|
sig { returns(String) }
|
|
23
24
|
attr_accessor :lockbox_address_id
|
|
24
25
|
|
|
@@ -48,7 +49,8 @@ module Increase
|
|
|
48
49
|
def self.new(
|
|
49
50
|
# The Account that checks sent to this Lockbox Recipient should be deposited into.
|
|
50
51
|
account_id:,
|
|
51
|
-
# The Lockbox Address where this Lockbox Recipient may receive mail.
|
|
52
|
+
# The Lockbox Address where this Lockbox Recipient may receive mail. The Lockbox
|
|
53
|
+
# Address must have a `status` of `active`.
|
|
52
54
|
lockbox_address_id:,
|
|
53
55
|
# The description you choose for the Lockbox Recipient.
|
|
54
56
|
description: nil,
|
|
@@ -17,7 +17,10 @@ module Increase
|
|
|
17
17
|
attr_accessor :account_id
|
|
18
18
|
|
|
19
19
|
# The Pending Transaction amount in the minor unit of its currency. For dollars,
|
|
20
|
-
# for example, this is cents.
|
|
20
|
+
# for example, this is cents. This amount does not change after the Pending
|
|
21
|
+
# Transaction is created. If a card authorization settles for a different amount,
|
|
22
|
+
# the settled amount is available on the resulting Transaction and on the Card
|
|
23
|
+
# Payment's `state.settled_amount`.
|
|
21
24
|
sig { returns(Integer) }
|
|
22
25
|
attr_accessor :amount
|
|
23
26
|
|
|
@@ -109,7 +112,10 @@ module Increase
|
|
|
109
112
|
# The identifier for the account this Pending Transaction belongs to.
|
|
110
113
|
account_id:,
|
|
111
114
|
# The Pending Transaction amount in the minor unit of its currency. For dollars,
|
|
112
|
-
# for example, this is cents.
|
|
115
|
+
# for example, this is cents. This amount does not change after the Pending
|
|
116
|
+
# Transaction is created. If a card authorization settles for a different amount,
|
|
117
|
+
# the settled amount is available on the resulting Transaction and on the Card
|
|
118
|
+
# Payment's `state.settled_amount`.
|
|
113
119
|
amount:,
|
|
114
120
|
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
|
|
115
121
|
# Transaction was completed.
|
|
@@ -4982,7 +4988,7 @@ module Increase
|
|
|
4982
4988
|
PENDING =
|
|
4983
4989
|
T.let(:pending, Increase::PendingTransaction::Status::TaggedSymbol)
|
|
4984
4990
|
|
|
4985
|
-
# The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc.
|
|
4991
|
+
# The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is not updated if the associated Transaction settles for a different amount.
|
|
4986
4992
|
COMPLETE =
|
|
4987
4993
|
T.let(:complete, Increase::PendingTransaction::Status::TaggedSymbol)
|
|
4988
4994
|
|
|
@@ -473,7 +473,7 @@ module Increase
|
|
|
473
473
|
Increase::PendingTransactionListParams::Status::In::TaggedSymbol
|
|
474
474
|
)
|
|
475
475
|
|
|
476
|
-
# The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc.
|
|
476
|
+
# The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. The Pending Transaction's `amount` is not updated if the associated Transaction settles for a different amount.
|
|
477
477
|
COMPLETE =
|
|
478
478
|
T.let(
|
|
479
479
|
:complete,
|
|
@@ -690,14 +690,21 @@ module Increase
|
|
|
690
690
|
Increase::PhysicalCard::Shipment::Tracking::Update::Category::TaggedSymbol
|
|
691
691
|
)
|
|
692
692
|
|
|
693
|
-
# There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the physical card will be
|
|
693
|
+
# There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the physical card will be rerouted to the return address.
|
|
694
694
|
DELIVERY_ISSUE =
|
|
695
695
|
T.let(
|
|
696
696
|
:delivery_issue,
|
|
697
697
|
Increase::PhysicalCard::Shipment::Tracking::Update::Category::TaggedSymbol
|
|
698
698
|
)
|
|
699
699
|
|
|
700
|
-
#
|
|
700
|
+
# The physical card has been rerouted to the return address.
|
|
701
|
+
RETURNING_TO_SENDER =
|
|
702
|
+
T.let(
|
|
703
|
+
:returning_to_sender,
|
|
704
|
+
Increase::PhysicalCard::Shipment::Tracking::Update::Category::TaggedSymbol
|
|
705
|
+
)
|
|
706
|
+
|
|
707
|
+
# The physical card has been delivered to the return address.
|
|
701
708
|
RETURNED_TO_SENDER =
|
|
702
709
|
T.let(
|
|
703
710
|
:returned_to_sender,
|
|
@@ -988,6 +988,13 @@ module Increase
|
|
|
988
988
|
Increase::RealTimePaymentsTransfer::Status::TaggedSymbol
|
|
989
989
|
)
|
|
990
990
|
|
|
991
|
+
# The transfer is queued to be submitted to Real-Time Payments.
|
|
992
|
+
PENDING_SUBMISSION =
|
|
993
|
+
T.let(
|
|
994
|
+
:pending_submission,
|
|
995
|
+
Increase::RealTimePaymentsTransfer::Status::TaggedSymbol
|
|
996
|
+
)
|
|
997
|
+
|
|
991
998
|
# The transfer is pending review by Increase.
|
|
992
999
|
PENDING_REVIEWING =
|
|
993
1000
|
T.let(
|
|
@@ -1009,13 +1016,6 @@ module Increase
|
|
|
1009
1016
|
Increase::RealTimePaymentsTransfer::Status::TaggedSymbol
|
|
1010
1017
|
)
|
|
1011
1018
|
|
|
1012
|
-
# The transfer is queued to be submitted to Real-Time Payments.
|
|
1013
|
-
PENDING_SUBMISSION =
|
|
1014
|
-
T.let(
|
|
1015
|
-
:pending_submission,
|
|
1016
|
-
Increase::RealTimePaymentsTransfer::Status::TaggedSymbol
|
|
1017
|
-
)
|
|
1018
|
-
|
|
1019
1019
|
# The transfer has been submitted and is pending a response from Real-Time Payments.
|
|
1020
1020
|
SUBMITTED =
|
|
1021
1021
|
T.let(
|
|
@@ -293,6 +293,13 @@ module Increase
|
|
|
293
293
|
Increase::RealTimePaymentsTransferListParams::Status::In::TaggedSymbol
|
|
294
294
|
)
|
|
295
295
|
|
|
296
|
+
# The transfer is queued to be submitted to Real-Time Payments.
|
|
297
|
+
PENDING_SUBMISSION =
|
|
298
|
+
T.let(
|
|
299
|
+
:pending_submission,
|
|
300
|
+
Increase::RealTimePaymentsTransferListParams::Status::In::TaggedSymbol
|
|
301
|
+
)
|
|
302
|
+
|
|
296
303
|
# The transfer is pending review by Increase.
|
|
297
304
|
PENDING_REVIEWING =
|
|
298
305
|
T.let(
|
|
@@ -314,13 +321,6 @@ module Increase
|
|
|
314
321
|
Increase::RealTimePaymentsTransferListParams::Status::In::TaggedSymbol
|
|
315
322
|
)
|
|
316
323
|
|
|
317
|
-
# The transfer is queued to be submitted to Real-Time Payments.
|
|
318
|
-
PENDING_SUBMISSION =
|
|
319
|
-
T.let(
|
|
320
|
-
:pending_submission,
|
|
321
|
-
Increase::RealTimePaymentsTransferListParams::Status::In::TaggedSymbol
|
|
322
|
-
)
|
|
323
|
-
|
|
324
324
|
# The transfer has been submitted and is pending a response from Real-Time Payments.
|
|
325
325
|
SUBMITTED =
|
|
326
326
|
T.let(
|
|
@@ -71,7 +71,8 @@ module Increase
|
|
|
71
71
|
sig { params(company_id: String).void }
|
|
72
72
|
attr_writer :company_id
|
|
73
73
|
|
|
74
|
-
# The name of the sender.
|
|
74
|
+
# The name of the sender. This corresponds to the `originator_company_name` field
|
|
75
|
+
# on the resulting Inbound ACH Transfer.
|
|
75
76
|
sig { returns(T.nilable(String)) }
|
|
76
77
|
attr_reader :company_name
|
|
77
78
|
|
|
@@ -154,7 +155,8 @@ module Increase
|
|
|
154
155
|
company_entry_description: nil,
|
|
155
156
|
# The sender's company ID.
|
|
156
157
|
company_id: nil,
|
|
157
|
-
# The name of the sender.
|
|
158
|
+
# The name of the sender. This corresponds to the `originator_company_name` field
|
|
159
|
+
# on the resulting Inbound ACH Transfer.
|
|
158
160
|
company_name: nil,
|
|
159
161
|
# The ID of the receiver of the transfer.
|
|
160
162
|
receiver_id_number: nil,
|
|
@@ -27,14 +27,16 @@ module Increase
|
|
|
27
27
|
sig { params(contents_file_id: String).void }
|
|
28
28
|
attr_writer :contents_file_id
|
|
29
29
|
|
|
30
|
-
# The identifier of the Lockbox Address to simulate inbound mail to.
|
|
30
|
+
# The identifier of the Lockbox Address to simulate inbound mail to. Exactly one
|
|
31
|
+
# lockbox identifier parameter must be provided.
|
|
31
32
|
sig { returns(T.nilable(String)) }
|
|
32
33
|
attr_reader :lockbox_address_id
|
|
33
34
|
|
|
34
35
|
sig { params(lockbox_address_id: String).void }
|
|
35
36
|
attr_writer :lockbox_address_id
|
|
36
37
|
|
|
37
|
-
# The identifier of the Lockbox Recipient to simulate inbound mail to.
|
|
38
|
+
# The identifier of the Lockbox Recipient to simulate inbound mail to. Exactly one
|
|
39
|
+
# lockbox identifier parameter must be provided.
|
|
38
40
|
sig { returns(T.nilable(String)) }
|
|
39
41
|
attr_reader :lockbox_recipient_id
|
|
40
42
|
|
|
@@ -56,9 +58,11 @@ module Increase
|
|
|
56
58
|
# The file containing the PDF contents. If not present, a default check image file
|
|
57
59
|
# will be used.
|
|
58
60
|
contents_file_id: nil,
|
|
59
|
-
# The identifier of the Lockbox Address to simulate inbound mail to.
|
|
61
|
+
# The identifier of the Lockbox Address to simulate inbound mail to. Exactly one
|
|
62
|
+
# lockbox identifier parameter must be provided.
|
|
60
63
|
lockbox_address_id: nil,
|
|
61
|
-
# The identifier of the Lockbox Recipient to simulate inbound mail to.
|
|
64
|
+
# The identifier of the Lockbox Recipient to simulate inbound mail to. Exactly one
|
|
65
|
+
# lockbox identifier parameter must be provided.
|
|
62
66
|
lockbox_recipient_id: nil,
|
|
63
67
|
request_options: {}
|
|
64
68
|
)
|
|
@@ -137,14 +137,21 @@ module Increase
|
|
|
137
137
|
Increase::Simulations::PhysicalCardCreateParams::Category::TaggedSymbol
|
|
138
138
|
)
|
|
139
139
|
|
|
140
|
-
# There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the physical card will be
|
|
140
|
+
# There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the physical card will be rerouted to the return address.
|
|
141
141
|
DELIVERY_ISSUE =
|
|
142
142
|
T.let(
|
|
143
143
|
:delivery_issue,
|
|
144
144
|
Increase::Simulations::PhysicalCardCreateParams::Category::TaggedSymbol
|
|
145
145
|
)
|
|
146
146
|
|
|
147
|
-
#
|
|
147
|
+
# The physical card has been rerouted to the return address.
|
|
148
|
+
RETURNING_TO_SENDER =
|
|
149
|
+
T.let(
|
|
150
|
+
:returning_to_sender,
|
|
151
|
+
Increase::Simulations::PhysicalCardCreateParams::Category::TaggedSymbol
|
|
152
|
+
)
|
|
153
|
+
|
|
154
|
+
# The physical card has been delivered to the return address.
|
|
148
155
|
RETURNED_TO_SENDER =
|
|
149
156
|
T.let(
|
|
150
157
|
:returned_to_sender,
|
|
@@ -665,6 +665,13 @@ module Increase
|
|
|
665
665
|
CANCELED =
|
|
666
666
|
T.let(:canceled, Increase::SwiftTransfer::Status::TaggedSymbol)
|
|
667
667
|
|
|
668
|
+
# The transfer is pending initiation.
|
|
669
|
+
PENDING_INITIATING =
|
|
670
|
+
T.let(
|
|
671
|
+
:pending_initiating,
|
|
672
|
+
Increase::SwiftTransfer::Status::TaggedSymbol
|
|
673
|
+
)
|
|
674
|
+
|
|
668
675
|
# The transfer is pending review by Increase.
|
|
669
676
|
PENDING_REVIEWING =
|
|
670
677
|
T.let(
|
|
@@ -679,13 +686,6 @@ module Increase
|
|
|
679
686
|
Increase::SwiftTransfer::Status::TaggedSymbol
|
|
680
687
|
)
|
|
681
688
|
|
|
682
|
-
# The transfer is pending initiation.
|
|
683
|
-
PENDING_INITIATING =
|
|
684
|
-
T.let(
|
|
685
|
-
:pending_initiating,
|
|
686
|
-
Increase::SwiftTransfer::Status::TaggedSymbol
|
|
687
|
-
)
|
|
688
|
-
|
|
689
689
|
# The transfer has been initiated.
|
|
690
690
|
INITIATED =
|
|
691
691
|
T.let(:initiated, Increase::SwiftTransfer::Status::TaggedSymbol)
|
|
@@ -258,6 +258,13 @@ module Increase
|
|
|
258
258
|
Increase::SwiftTransferListParams::Status::In::TaggedSymbol
|
|
259
259
|
)
|
|
260
260
|
|
|
261
|
+
# The transfer is pending initiation.
|
|
262
|
+
PENDING_INITIATING =
|
|
263
|
+
T.let(
|
|
264
|
+
:pending_initiating,
|
|
265
|
+
Increase::SwiftTransferListParams::Status::In::TaggedSymbol
|
|
266
|
+
)
|
|
267
|
+
|
|
261
268
|
# The transfer is pending review by Increase.
|
|
262
269
|
PENDING_REVIEWING =
|
|
263
270
|
T.let(
|
|
@@ -272,13 +279,6 @@ module Increase
|
|
|
272
279
|
Increase::SwiftTransferListParams::Status::In::TaggedSymbol
|
|
273
280
|
)
|
|
274
281
|
|
|
275
|
-
# The transfer is pending initiation.
|
|
276
|
-
PENDING_INITIATING =
|
|
277
|
-
T.let(
|
|
278
|
-
:pending_initiating,
|
|
279
|
-
Increase::SwiftTransferListParams::Status::In::TaggedSymbol
|
|
280
|
-
)
|
|
281
|
-
|
|
282
282
|
# The transfer has been initiated.
|
|
283
283
|
INITIATED =
|
|
284
284
|
T.let(
|
|
@@ -284,7 +284,8 @@ module Increase
|
|
|
284
284
|
# Return is created when an ACH Transfer is returned by the receiving bank. It
|
|
285
285
|
# offsets the ACH Transfer Intention. ACH Transfer Returns usually occur within
|
|
286
286
|
# the first two business days after the transfer is initiated, but can occur much
|
|
287
|
-
# later.
|
|
287
|
+
# later. The return appears as a new posted Transaction; no Pending Transaction is
|
|
288
|
+
# created.
|
|
288
289
|
sig do
|
|
289
290
|
returns(T.nilable(Increase::Transaction::Source::ACHTransferReturn))
|
|
290
291
|
end
|
|
@@ -1116,7 +1117,8 @@ module Increase
|
|
|
1116
1117
|
# Return is created when an ACH Transfer is returned by the receiving bank. It
|
|
1117
1118
|
# offsets the ACH Transfer Intention. ACH Transfer Returns usually occur within
|
|
1118
1119
|
# the first two business days after the transfer is initiated, but can occur much
|
|
1119
|
-
# later.
|
|
1120
|
+
# later. The return appears as a new posted Transaction; no Pending Transaction is
|
|
1121
|
+
# created.
|
|
1120
1122
|
ach_transfer_return: nil,
|
|
1121
1123
|
# A Blockchain Off-Ramp Transfer Settlement object. This field will be present in
|
|
1122
1124
|
# the JSON response if and only if `category` is equal to
|
|
@@ -1997,7 +1999,8 @@ module Increase
|
|
|
1997
1999
|
sig { returns(String) }
|
|
1998
2000
|
attr_accessor :transaction_id
|
|
1999
2001
|
|
|
2000
|
-
# The identifier of the ACH Transfer associated with this return.
|
|
2002
|
+
# The identifier of the ACH Transfer associated with this return. This matches the
|
|
2003
|
+
# original Transaction's `source.ach_transfer_intention.transfer_id`.
|
|
2001
2004
|
sig { returns(String) }
|
|
2002
2005
|
attr_accessor :transfer_id
|
|
2003
2006
|
|
|
@@ -2006,7 +2009,8 @@ module Increase
|
|
|
2006
2009
|
# Return is created when an ACH Transfer is returned by the receiving bank. It
|
|
2007
2010
|
# offsets the ACH Transfer Intention. ACH Transfer Returns usually occur within
|
|
2008
2011
|
# the first two business days after the transfer is initiated, but can occur much
|
|
2009
|
-
# later.
|
|
2012
|
+
# later. The return appears as a new posted Transaction; no Pending Transaction is
|
|
2013
|
+
# created.
|
|
2010
2014
|
sig do
|
|
2011
2015
|
params(
|
|
2012
2016
|
created_at: Time,
|
|
@@ -2034,7 +2038,8 @@ module Increase
|
|
|
2034
2038
|
trace_number:,
|
|
2035
2039
|
# The identifier of the Transaction associated with this return.
|
|
2036
2040
|
transaction_id:,
|
|
2037
|
-
# The identifier of the ACH Transfer associated with this return.
|
|
2041
|
+
# The identifier of the ACH Transfer associated with this return. This matches the
|
|
2042
|
+
# original Transaction's `source.ach_transfer_intention.transfer_id`.
|
|
2038
2043
|
transfer_id:
|
|
2039
2044
|
)
|
|
2040
2045
|
end
|
|
@@ -1327,6 +1327,10 @@ module Increase
|
|
|
1327
1327
|
CANCELED =
|
|
1328
1328
|
T.let(:canceled, Increase::WireTransfer::Status::TaggedSymbol)
|
|
1329
1329
|
|
|
1330
|
+
# The transfer is pending creation.
|
|
1331
|
+
PENDING_CREATING =
|
|
1332
|
+
T.let(:pending_creating, Increase::WireTransfer::Status::TaggedSymbol)
|
|
1333
|
+
|
|
1330
1334
|
# The transfer is pending review by Increase.
|
|
1331
1335
|
PENDING_REVIEWING =
|
|
1332
1336
|
T.let(
|
|
@@ -1345,10 +1349,6 @@ module Increase
|
|
|
1345
1349
|
Increase::WireTransfer::Status::TaggedSymbol
|
|
1346
1350
|
)
|
|
1347
1351
|
|
|
1348
|
-
# The transfer is pending creation.
|
|
1349
|
-
PENDING_CREATING =
|
|
1350
|
-
T.let(:pending_creating, Increase::WireTransfer::Status::TaggedSymbol)
|
|
1351
|
-
|
|
1352
1352
|
# The transfer has been reversed.
|
|
1353
1353
|
REVERSED =
|
|
1354
1354
|
T.let(:reversed, Increase::WireTransfer::Status::TaggedSymbol)
|
|
@@ -267,6 +267,13 @@ module Increase
|
|
|
267
267
|
Increase::WireTransferListParams::Status::In::TaggedSymbol
|
|
268
268
|
)
|
|
269
269
|
|
|
270
|
+
# The transfer is pending creation.
|
|
271
|
+
PENDING_CREATING =
|
|
272
|
+
T.let(
|
|
273
|
+
:pending_creating,
|
|
274
|
+
Increase::WireTransferListParams::Status::In::TaggedSymbol
|
|
275
|
+
)
|
|
276
|
+
|
|
270
277
|
# The transfer is pending review by Increase.
|
|
271
278
|
PENDING_REVIEWING =
|
|
272
279
|
T.let(
|
|
@@ -288,13 +295,6 @@ module Increase
|
|
|
288
295
|
Increase::WireTransferListParams::Status::In::TaggedSymbol
|
|
289
296
|
)
|
|
290
297
|
|
|
291
|
-
# The transfer is pending creation.
|
|
292
|
-
PENDING_CREATING =
|
|
293
|
-
T.let(
|
|
294
|
-
:pending_creating,
|
|
295
|
-
Increase::WireTransferListParams::Status::In::TaggedSymbol
|
|
296
|
-
)
|
|
297
|
-
|
|
298
298
|
# The transfer has been reversed.
|
|
299
299
|
REVERSED =
|
|
300
300
|
T.let(
|
|
@@ -27,8 +27,9 @@ module Increase
|
|
|
27
27
|
informational_entity_id: nil,
|
|
28
28
|
# The loan details for the account.
|
|
29
29
|
loan: nil,
|
|
30
|
-
# The identifier for the Program that this Account falls under. Required if
|
|
31
|
-
#
|
|
30
|
+
# The identifier for the Program that this Account falls under. Required if your
|
|
31
|
+
# Group operates more than one Program. List your [Programs](#programs) to find
|
|
32
|
+
# their identifiers.
|
|
32
33
|
program_id: nil,
|
|
33
34
|
request_options: {}
|
|
34
35
|
)
|
|
@@ -46,33 +46,42 @@ module Increase
|
|
|
46
46
|
# help the customer recognize the transfer. You are highly encouraged to pass
|
|
47
47
|
# `individual_name` and `company_name` instead of relying on this fallback.
|
|
48
48
|
statement_descriptor:,
|
|
49
|
-
# The account number
|
|
49
|
+
# The receiver's account number. For credit transfers (positive `amount`) this is
|
|
50
|
+
# the account that funds will be sent to. For debit transfers (negative `amount`)
|
|
51
|
+
# this is the account that funds will be pulled from.
|
|
50
52
|
account_number: nil,
|
|
51
|
-
# Additional information
|
|
52
|
-
#
|
|
53
|
+
# Additional information passed through to the receiving bank with the transfer.
|
|
54
|
+
# Most ACH transfers do not need this. Only set this if your recipient has asked
|
|
55
|
+
# for addendum data, typically unstructured remittance information. Corporate
|
|
56
|
+
# Trade Exchange (CTX) flows can carry structured X12 remittance advice instead.
|
|
53
57
|
addenda: nil,
|
|
54
|
-
#
|
|
55
|
-
#
|
|
58
|
+
# A description of the transfer date (typically `YYMMDD`), sent in the company
|
|
59
|
+
# batch header. This value is informational and does not affect funds movement,
|
|
60
|
+
# settlement timing, or returns. Only set this if your recipient has asked for it.
|
|
56
61
|
company_descriptive_date: nil,
|
|
57
|
-
#
|
|
58
|
-
#
|
|
62
|
+
# Custom data sent in the company batch header. This value is informational and
|
|
63
|
+
# does not affect funds movement, settlement timing, or returns. Most ACH
|
|
64
|
+
# transfers do not need this. Only set this if your recipient has asked for it.
|
|
59
65
|
company_discretionary_data: nil,
|
|
60
|
-
# A description
|
|
61
|
-
#
|
|
62
|
-
# for
|
|
66
|
+
# A short description sent in the company batch header. Most receivers do not
|
|
67
|
+
# surface this. Only set this if your recipient has asked for a specific value or
|
|
68
|
+
# if Nacha mandates one for your Standard Entry Class (SEC) code and use case. For
|
|
69
|
+
# example, Prearranged Payment and Deposit (PPD) payroll credits must use
|
|
70
|
+
# `PAYROLL`, and reversals must use `REVERSAL`.
|
|
63
71
|
company_entry_description: nil,
|
|
64
|
-
# The name by which the recipient knows you
|
|
65
|
-
#
|
|
72
|
+
# The name by which the recipient knows you, sent in the company batch header. We
|
|
73
|
+
# recommend setting this on every transfer; if you do not, we fall back to the ACH
|
|
74
|
+
# company name configured on your account.
|
|
66
75
|
company_name: nil,
|
|
67
|
-
# The type of entity that owns the account
|
|
68
|
-
# sent.
|
|
76
|
+
# The type of entity that owns the receiver's account.
|
|
69
77
|
destination_account_holder: nil,
|
|
70
78
|
# The ID of an External Account to initiate a transfer to. If this parameter is
|
|
71
79
|
# provided, `account_number`, `routing_number`, and `funding` must be absent.
|
|
72
80
|
external_account_id: nil,
|
|
73
|
-
# The type of the
|
|
81
|
+
# The type of the receiver's bank account.
|
|
74
82
|
funding: nil,
|
|
75
|
-
# Your identifier for the transfer recipient.
|
|
83
|
+
# Your internal identifier for the transfer recipient. This value is informational
|
|
84
|
+
# and not verified by the recipient's bank. Most callers can leave this unset.
|
|
76
85
|
individual_id: nil,
|
|
77
86
|
# The name of the transfer recipient. This value is informational and not verified
|
|
78
87
|
# by the recipient's bank.
|
|
@@ -84,12 +93,13 @@ module Increase
|
|
|
84
93
|
preferred_effective_date: nil,
|
|
85
94
|
# Whether the transfer requires explicit approval via the dashboard or API.
|
|
86
95
|
require_approval: nil,
|
|
87
|
-
# The American Bankers' Association (ABA) Routing Transit Number (RTN)
|
|
88
|
-
#
|
|
96
|
+
# The American Bankers' Association (ABA) Routing Transit Number (RTN) of the
|
|
97
|
+
# receiver's bank.
|
|
89
98
|
routing_number: nil,
|
|
90
99
|
# The
|
|
91
100
|
# [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
|
|
92
|
-
# to use for the transfer.
|
|
101
|
+
# to use for the transfer. If not provided, the default is
|
|
102
|
+
# `corporate_credit_or_debit`.
|
|
93
103
|
standard_entry_class_code: nil,
|
|
94
104
|
# The timing of the transaction.
|
|
95
105
|
transaction_timing: nil,
|
|
@@ -43,7 +43,9 @@ module Increase
|
|
|
43
43
|
)
|
|
44
44
|
end
|
|
45
45
|
|
|
46
|
-
#
|
|
46
|
+
# Deposits or ignores each check contained in a pending Inbound Mail Item.
|
|
47
|
+
# Depositing a check creates a [Check Deposit](#check-deposits) into the Account
|
|
48
|
+
# you specify.
|
|
47
49
|
sig do
|
|
48
50
|
params(
|
|
49
51
|
inbound_mail_item_id: String,
|
|
@@ -3,7 +3,10 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class LockboxAddresses
|
|
6
|
-
#
|
|
6
|
+
# The Lockbox Address starts with a `pending` status and a null `address`. Shortly
|
|
7
|
+
# after creation, Increase generates the mailing address and the status becomes
|
|
8
|
+
# `active`. You can only create Lockbox Recipients for an `active` Lockbox
|
|
9
|
+
# Address.
|
|
7
10
|
sig do
|
|
8
11
|
params(
|
|
9
12
|
description: String,
|
|
@@ -16,7 +16,8 @@ module Increase
|
|
|
16
16
|
def create(
|
|
17
17
|
# The Account that checks sent to this Lockbox Recipient should be deposited into.
|
|
18
18
|
account_id:,
|
|
19
|
-
# The Lockbox Address where this Lockbox Recipient may receive mail.
|
|
19
|
+
# The Lockbox Address where this Lockbox Recipient may receive mail. The Lockbox
|
|
20
|
+
# Address must have a `status` of `active`.
|
|
20
21
|
lockbox_address_id:,
|
|
21
22
|
# The description you choose for the Lockbox Recipient.
|
|
22
23
|
description: nil,
|
|
@@ -10,7 +10,10 @@ module Increase
|
|
|
10
10
|
# `card_authorization` or a [Declined Transaction](#declined-transactions) of type
|
|
11
11
|
# `card_decline`. You can pass either a Card id or a
|
|
12
12
|
# [Digital Wallet Token](#digital-wallet-tokens) id to simulate the two different
|
|
13
|
-
# ways purchases can be made.
|
|
13
|
+
# ways purchases can be made. The response will contain either a
|
|
14
|
+
# `pending_transaction` or a `declined_transaction`; the other attribute will be
|
|
15
|
+
# null. If the authorization is declined, the reason is available on the Declined
|
|
16
|
+
# Transaction at `source.card_decline.reason`.
|
|
14
17
|
sig do
|
|
15
18
|
params(
|
|
16
19
|
amount: Integer,
|
|
@@ -50,7 +50,8 @@ module Increase
|
|
|
50
50
|
company_entry_description: nil,
|
|
51
51
|
# The sender's company ID.
|
|
52
52
|
company_id: nil,
|
|
53
|
-
# The name of the sender.
|
|
53
|
+
# The name of the sender. This corresponds to the `originator_company_name` field
|
|
54
|
+
# on the resulting Inbound ACH Transfer.
|
|
54
55
|
company_name: nil,
|
|
55
56
|
# The ID of the receiver of the transfer.
|
|
56
57
|
receiver_id_number: nil,
|
|
@@ -5,7 +5,10 @@ module Increase
|
|
|
5
5
|
class Simulations
|
|
6
6
|
class InboundMailItems
|
|
7
7
|
# Simulates an Inbound Mail Item to one of your Lockbox Addresses or Lockbox
|
|
8
|
-
# Recipients, as if someone had mailed a physical check.
|
|
8
|
+
# Recipients, as if someone had mailed a physical check. Increase automatically
|
|
9
|
+
# deposits a check mailed to a Lockbox Recipient into the recipient's Account. A
|
|
10
|
+
# check mailed to a Lockbox Address must be deposited or ignored with the
|
|
11
|
+
# [Action an Inbound Mail Item](#inbound-mail-items) endpoint.
|
|
9
12
|
sig do
|
|
10
13
|
params(
|
|
11
14
|
amount: Integer,
|
|
@@ -21,9 +24,11 @@ module Increase
|
|
|
21
24
|
# The file containing the PDF contents. If not present, a default check image file
|
|
22
25
|
# will be used.
|
|
23
26
|
contents_file_id: nil,
|
|
24
|
-
# The identifier of the Lockbox Address to simulate inbound mail to.
|
|
27
|
+
# The identifier of the Lockbox Address to simulate inbound mail to. Exactly one
|
|
28
|
+
# lockbox identifier parameter must be provided.
|
|
25
29
|
lockbox_address_id: nil,
|
|
26
|
-
# The identifier of the Lockbox Recipient to simulate inbound mail to.
|
|
30
|
+
# The identifier of the Lockbox Recipient to simulate inbound mail to. Exactly one
|
|
31
|
+
# lockbox identifier parameter must be provided.
|
|
27
32
|
lockbox_recipient_id: nil,
|
|
28
33
|
request_options: {}
|
|
29
34
|
)
|
|
@@ -731,7 +731,7 @@ module Increase
|
|
|
731
731
|
# The chosen effective date will be the same as the ACH processing date on which the transfer is submitted.
|
|
732
732
|
# This is necessary, but not sufficient for the transfer to be settled same-day:
|
|
733
733
|
# it must also be submitted before the last same-day cutoff
|
|
734
|
-
# and be less than or equal to $1,000
|
|
734
|
+
# and be less than or equal to $1,000,000.00.
|
|
735
735
|
SAME_DAY: :same_day
|
|
736
736
|
|
|
737
737
|
# 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.
|
|
@@ -1140,7 +1140,7 @@ module Increase
|
|
|
1140
1140
|
# The transfer has been rejected.
|
|
1141
1141
|
REJECTED: :rejected
|
|
1142
1142
|
|
|
1143
|
-
# The transfer is
|
|
1143
|
+
# The transfer has been submitted to the Federal Reserve. When the transfer settles, the status remains `submitted` and the `settlement` sub-object is populated.
|
|
1144
1144
|
SUBMITTED: :submitted
|
|
1145
1145
|
|
|
1146
1146
|
# The transfer has been returned.
|
|
@@ -333,7 +333,7 @@ module Increase
|
|
|
333
333
|
module SettlementSchedule
|
|
334
334
|
extend Increase::Internal::Type::Enum
|
|
335
335
|
|
|
336
|
-
# 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
|
|
336
|
+
# 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.
|
|
337
337
|
SAME_DAY: :same_day
|
|
338
338
|
|
|
339
339
|
# 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.
|
|
@@ -158,7 +158,7 @@ module Increase
|
|
|
158
158
|
# The transfer has been rejected.
|
|
159
159
|
REJECTED: :rejected
|
|
160
160
|
|
|
161
|
-
# The transfer is
|
|
161
|
+
# The transfer has been submitted to the Federal Reserve. When the transfer settles, the status remains `submitted` and the `settlement` sub-object is populated.
|
|
162
162
|
SUBMITTED: :submitted
|
|
163
163
|
|
|
164
164
|
# The transfer has been returned.
|
|
@@ -1377,9 +1377,9 @@ module Increase
|
|
|
1377
1377
|
type status =
|
|
1378
1378
|
:pending_approval
|
|
1379
1379
|
| :canceled
|
|
1380
|
+
| :pending_submission
|
|
1380
1381
|
| :pending_reviewing
|
|
1381
1382
|
| :requires_attention
|
|
1382
|
-
| :pending_submission
|
|
1383
1383
|
| :submitted
|
|
1384
1384
|
| :complete
|
|
1385
1385
|
| :declined
|
|
@@ -1393,15 +1393,15 @@ module Increase
|
|
|
1393
1393
|
# The transfer has been canceled.
|
|
1394
1394
|
CANCELED: :canceled
|
|
1395
1395
|
|
|
1396
|
+
# The transfer is queued to be submitted to the card network.
|
|
1397
|
+
PENDING_SUBMISSION: :pending_submission
|
|
1398
|
+
|
|
1396
1399
|
# The transfer is pending review by Increase.
|
|
1397
1400
|
PENDING_REVIEWING: :pending_reviewing
|
|
1398
1401
|
|
|
1399
1402
|
# The transfer requires attention from an Increase operator.
|
|
1400
1403
|
REQUIRES_ATTENTION: :requires_attention
|
|
1401
1404
|
|
|
1402
|
-
# The transfer is queued to be submitted to the card network.
|
|
1403
|
-
PENDING_SUBMISSION: :pending_submission
|
|
1404
|
-
|
|
1405
1405
|
# The transfer has been submitted and is pending a response from the card network.
|
|
1406
1406
|
SUBMITTED: :submitted
|
|
1407
1407
|
|