increase 1.361.0 → 1.363.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/client.rb +0 -16
- data/lib/increase/internal/transport/pooled_net_requester.rb +3 -0
- data/lib/increase/internal/util.rb +22 -17
- data/lib/increase/models/ach_transfer.rb +38 -23
- data/lib/increase/models/ach_transfer_create_params.rb +73 -42
- data/lib/increase/models/check_transfer.rb +58 -44
- data/lib/increase/models/check_transfer_create_params.rb +35 -21
- data/lib/increase/models/export.rb +12 -1
- data/lib/increase/models/export_create_params.rb +26 -4
- data/lib/increase/models/inbound_real_time_payments_transfer.rb +10 -1
- data/lib/increase/models/inbound_real_time_payments_transfer_return_params.rb +36 -0
- data/lib/increase/models/real_time_payments_transfer.rb +21 -1
- data/lib/increase/models/simulations/card_dispute_action_params.rb +26 -4
- data/lib/increase/models/simulations/wire_drawdown_request_refuse_params.rb +52 -1
- data/lib/increase/models/transaction.rb +3 -3
- data/lib/increase/models/wire_drawdown_request.rb +78 -1
- data/lib/increase/models.rb +3 -20
- data/lib/increase/resources/ach_transfers.rb +43 -22
- data/lib/increase/resources/inbound_real_time_payments_transfers.rb +28 -0
- data/lib/increase/resources/simulations/wire_drawdown_requests.rb +12 -2
- data/lib/increase/version.rb +1 -1
- data/lib/increase.rb +1 -14
- data/rbi/increase/client.rbi +0 -12
- data/rbi/increase/internal/util.rbi +3 -1
- data/rbi/increase/models/ach_transfer.rbi +35 -23
- data/rbi/increase/models/ach_transfer_create_params.rbi +72 -42
- data/rbi/increase/models/check_transfer.rbi +72 -54
- data/rbi/increase/models/check_transfer_create_params.rbi +55 -21
- data/rbi/increase/models/export.rbi +15 -3
- data/rbi/increase/models/export_create_params.rbi +27 -3
- data/rbi/increase/models/inbound_real_time_payments_transfer.rbi +8 -0
- data/rbi/increase/models/inbound_real_time_payments_transfer_return_params.rbi +61 -0
- data/rbi/increase/models/real_time_payments_transfer.rbi +18 -0
- data/rbi/increase/models/simulations/card_dispute_action_params.rbi +56 -3
- data/rbi/increase/models/simulations/wire_drawdown_request_refuse_params.rbi +107 -0
- data/rbi/increase/models/transaction.rbi +3 -3
- data/rbi/increase/models/wire_drawdown_request.rbi +146 -0
- data/rbi/increase/models.rbi +3 -22
- data/rbi/increase/resources/ach_transfers.rbi +42 -22
- data/rbi/increase/resources/inbound_real_time_payments_transfers.rbi +19 -0
- data/rbi/increase/resources/simulations/wire_drawdown_requests.rbi +9 -0
- data/sig/increase/client.rbs +0 -8
- data/sig/increase/internal/util.rbs +1 -1
- data/sig/increase/models/ach_transfer.rbs +4 -4
- data/sig/increase/models/check_transfer.rbs +59 -49
- data/sig/increase/models/check_transfer_create_params.rbs +20 -12
- data/sig/increase/models/export.rbs +13 -3
- data/sig/increase/models/export_create_params.rbs +7 -0
- data/sig/increase/models/inbound_real_time_payments_transfer.rbs +5 -0
- data/sig/increase/models/inbound_real_time_payments_transfer_return_params.rbs +30 -0
- data/sig/increase/models/real_time_payments_transfer.rbs +10 -0
- data/sig/increase/models/simulations/card_dispute_action_params.rbs +24 -3
- data/sig/increase/models/simulations/wire_drawdown_request_refuse_params.rbs +51 -1
- data/sig/increase/models/transaction.rbs +4 -4
- data/sig/increase/models/wire_drawdown_request.rbs +64 -0
- data/sig/increase/models.rbs +2 -20
- data/sig/increase/resources/inbound_real_time_payments_transfers.rbs +6 -0
- data/sig/increase/resources/simulations/wire_drawdown_requests.rbs +2 -0
- metadata +20 -45
- data/lib/increase/models/group.rb +0 -57
- data/lib/increase/models/group_retrieve_params.rb +0 -14
- data/lib/increase/models/oauth_application.rb +0 -111
- data/lib/increase/models/oauth_application_list_params.rb +0 -129
- data/lib/increase/models/oauth_application_retrieve_params.rb +0 -22
- data/lib/increase/models/oauth_connection.rb +0 -107
- data/lib/increase/models/oauth_connection_list_params.rb +0 -88
- data/lib/increase/models/oauth_connection_retrieve_params.rb +0 -22
- data/lib/increase/models/oauth_token.rb +0 -76
- data/lib/increase/models/oauth_token_create_params.rb +0 -85
- data/lib/increase/resources/groups.rb +0 -32
- data/lib/increase/resources/oauth_applications.rb +0 -68
- data/lib/increase/resources/oauth_connections.rb +0 -70
- data/lib/increase/resources/oauth_tokens.rb +0 -54
- data/rbi/increase/models/group.rbi +0 -74
- data/rbi/increase/models/group_retrieve_params.rbi +0 -27
- data/rbi/increase/models/oauth_application.rbi +0 -146
- data/rbi/increase/models/oauth_application_list_params.rbi +0 -263
- data/rbi/increase/models/oauth_application_retrieve_params.rbi +0 -46
- data/rbi/increase/models/oauth_connection.rbi +0 -142
- data/rbi/increase/models/oauth_connection_list_params.rbi +0 -187
- data/rbi/increase/models/oauth_connection_retrieve_params.rbi +0 -46
- data/rbi/increase/models/oauth_token.rbi +0 -106
- data/rbi/increase/models/oauth_token_create_params.rbi +0 -133
- data/rbi/increase/resources/groups.rbi +0 -21
- data/rbi/increase/resources/oauth_applications.rbi +0 -50
- data/rbi/increase/resources/oauth_connections.rbi +0 -52
- data/rbi/increase/resources/oauth_tokens.rbi +0 -44
- data/sig/increase/models/group.rbs +0 -36
- data/sig/increase/models/group_retrieve_params.rbs +0 -15
- data/sig/increase/models/oauth_application.rbs +0 -74
- data/sig/increase/models/oauth_application_list_params.rbs +0 -123
- data/sig/increase/models/oauth_application_retrieve_params.rbs +0 -24
- data/sig/increase/models/oauth_connection.rbs +0 -74
- data/sig/increase/models/oauth_connection_list_params.rbs +0 -86
- data/sig/increase/models/oauth_connection_retrieve_params.rbs +0 -24
- data/sig/increase/models/oauth_token.rbs +0 -55
- data/sig/increase/models/oauth_token_create_params.rbs +0 -68
- data/sig/increase/resources/groups.rbs +0 -11
- data/sig/increase/resources/oauth_applications.rbs +0 -20
- data/sig/increase/resources/oauth_connections.rbs +0 -20
- data/sig/increase/resources/oauth_tokens.rbs +0 -16
|
@@ -14,10 +14,61 @@ module Increase
|
|
|
14
14
|
# @return [String]
|
|
15
15
|
required :wire_drawdown_request_id, String
|
|
16
16
|
|
|
17
|
-
# @!
|
|
17
|
+
# @!attribute refusal_reason_additional_information
|
|
18
|
+
# Additional information about the refusal that the simulated refusal will have.
|
|
19
|
+
#
|
|
20
|
+
# @return [String, nil]
|
|
21
|
+
optional :refusal_reason_additional_information, String
|
|
22
|
+
|
|
23
|
+
# @!attribute refusal_reason_code
|
|
24
|
+
# The reason code that the simulated refusal will have.
|
|
25
|
+
#
|
|
26
|
+
# Defaults to `other`.
|
|
27
|
+
#
|
|
28
|
+
# @return [Symbol, Increase::Models::Simulations::WireDrawdownRequestRefuseParams::RefusalReasonCode, nil]
|
|
29
|
+
optional :refusal_reason_code,
|
|
30
|
+
enum: -> { Increase::Simulations::WireDrawdownRequestRefuseParams::RefusalReasonCode }
|
|
31
|
+
|
|
32
|
+
# @!method initialize(wire_drawdown_request_id:, refusal_reason_additional_information: nil, refusal_reason_code: nil, request_options: {})
|
|
18
33
|
# @param wire_drawdown_request_id [String] The identifier of the Wire Drawdown Request you wish to refuse.
|
|
19
34
|
#
|
|
35
|
+
# @param refusal_reason_additional_information [String]
|
|
36
|
+
# Additional information about the refusal that the simulated refusal will have.
|
|
37
|
+
#
|
|
38
|
+
# @param refusal_reason_code [Symbol, Increase::Models::Simulations::WireDrawdownRequestRefuseParams::RefusalReasonCode]
|
|
39
|
+
# The reason code that the simulated refusal will have.
|
|
40
|
+
#
|
|
41
|
+
# Defaults to `other`.
|
|
42
|
+
#
|
|
20
43
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
44
|
+
|
|
45
|
+
# The reason code that the simulated refusal will have.
|
|
46
|
+
#
|
|
47
|
+
# Defaults to `other`.
|
|
48
|
+
module RefusalReasonCode
|
|
49
|
+
extend Increase::Internal::Type::Enum
|
|
50
|
+
|
|
51
|
+
# The debtor's account number is invalid or missing. Corresponds to the Fedwire reason code `AC02`.
|
|
52
|
+
INVALID_DEBTOR_ACCOUNT_NUMBER = :invalid_debtor_account_number
|
|
53
|
+
|
|
54
|
+
# The debtor account does not allow drawdown requests. Corresponds to the Fedwire reason code `AG01`.
|
|
55
|
+
TRANSACTION_FORBIDDEN = :transaction_forbidden
|
|
56
|
+
|
|
57
|
+
# The debtor account cannot be debited for a generic reason. Corresponds to the Fedwire reason code `AG07`.
|
|
58
|
+
UNSUCCESSFUL_DIRECT_DEBIT = :unsuccessful_direct_debit
|
|
59
|
+
|
|
60
|
+
# The debtor's identification is inconsistent with the debtor account number. Corresponds to the Fedwire reason code `BE01`.
|
|
61
|
+
INCONSISTENT_WITH_END_CUSTOMER = :inconsistent_with_end_customer
|
|
62
|
+
|
|
63
|
+
# The reason is provided as narrative information in the additional information field. Corresponds to the Fedwire reason code `NARR`.
|
|
64
|
+
NARRATIVE = :narrative
|
|
65
|
+
|
|
66
|
+
# Some other error or issue has occurred.
|
|
67
|
+
OTHER = :other
|
|
68
|
+
|
|
69
|
+
# @!method self.values
|
|
70
|
+
# @return [Array<Symbol>]
|
|
71
|
+
end
|
|
21
72
|
end
|
|
22
73
|
end
|
|
23
74
|
end
|
|
@@ -1129,8 +1129,8 @@ module Increase
|
|
|
1129
1129
|
# @!attribute statement_descriptor
|
|
1130
1130
|
# A description set when the ACH Transfer was created.
|
|
1131
1131
|
#
|
|
1132
|
-
# @return [String]
|
|
1133
|
-
required :statement_descriptor, String
|
|
1132
|
+
# @return [String, nil]
|
|
1133
|
+
required :statement_descriptor, String, nil?: true
|
|
1134
1134
|
|
|
1135
1135
|
# @!attribute transfer_id
|
|
1136
1136
|
# The identifier of the ACH Transfer that led to this Transaction.
|
|
@@ -1154,7 +1154,7 @@ module Increase
|
|
|
1154
1154
|
# The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
|
|
1155
1155
|
# destination account.
|
|
1156
1156
|
#
|
|
1157
|
-
# @param statement_descriptor [String] A description set when the ACH Transfer was created.
|
|
1157
|
+
# @param statement_descriptor [String, nil] A description set when the ACH Transfer was created.
|
|
1158
1158
|
#
|
|
1159
1159
|
# @param transfer_id [String] The identifier of the ACH Transfer that led to this Transaction.
|
|
1160
1160
|
end
|
|
@@ -108,6 +108,13 @@ module Increase
|
|
|
108
108
|
# @return [String, nil]
|
|
109
109
|
required :idempotency_key, String, nil?: true
|
|
110
110
|
|
|
111
|
+
# @!attribute refusal
|
|
112
|
+
# If the debtor refuses the drawdown request, this will contain supplemental
|
|
113
|
+
# details.
|
|
114
|
+
#
|
|
115
|
+
# @return [Increase::Models::WireDrawdownRequest::Refusal, nil]
|
|
116
|
+
required :refusal, -> { Increase::WireDrawdownRequest::Refusal }, nil?: true
|
|
117
|
+
|
|
111
118
|
# @!attribute status
|
|
112
119
|
# The lifecycle status of the drawdown request.
|
|
113
120
|
#
|
|
@@ -142,7 +149,7 @@ module Increase
|
|
|
142
149
|
# @return [String]
|
|
143
150
|
required :unstructured_remittance_information, String
|
|
144
151
|
|
|
145
|
-
# @!method initialize(id:, account_id:, account_number_id:, amount:, created_at:, creditor_address:, creditor_name:, currency:, debtor_account_number:, debtor_address:, debtor_external_account_id:, debtor_name:, debtor_routing_number:, end_to_end_identification:, fulfillment_inbound_wire_transfer_id:, idempotency_key:, status:, submission:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
|
|
152
|
+
# @!method initialize(id:, account_id:, account_number_id:, amount:, created_at:, creditor_address:, creditor_name:, currency:, debtor_account_number:, debtor_address:, debtor_external_account_id:, debtor_name:, debtor_routing_number:, end_to_end_identification:, fulfillment_inbound_wire_transfer_id:, idempotency_key:, refusal:, status:, submission:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
|
|
146
153
|
# Wire drawdown requests enable you to request that someone else send you a wire.
|
|
147
154
|
# Because there is nuance to making sure your counterparty's bank processes these
|
|
148
155
|
# correctly, we ask that you reach out to
|
|
@@ -197,6 +204,10 @@ module Increase
|
|
|
197
204
|
# Increase and is used to ensure that a request is only processed once. Learn more
|
|
198
205
|
# about [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
199
206
|
#
|
|
207
|
+
# @param refusal [Increase::Models::WireDrawdownRequest::Refusal, nil]
|
|
208
|
+
# If the debtor refuses the drawdown request, this will contain supplemental
|
|
209
|
+
# details.
|
|
210
|
+
#
|
|
200
211
|
# @param status [Symbol, Increase::Models::WireDrawdownRequest::Status]
|
|
201
212
|
# The lifecycle status of the drawdown request.
|
|
202
213
|
#
|
|
@@ -334,6 +345,72 @@ module Increase
|
|
|
334
345
|
# @param state [String, nil] The address state.
|
|
335
346
|
end
|
|
336
347
|
|
|
348
|
+
# @see Increase::Models::WireDrawdownRequest#refusal
|
|
349
|
+
class Refusal < Increase::Internal::Type::BaseModel
|
|
350
|
+
# @!attribute refusal_reason_additional_information
|
|
351
|
+
# Additional information about the refusal provided by the debtor bank. This is
|
|
352
|
+
# typically present when the `refusal_reason_code` is `narrative`.
|
|
353
|
+
#
|
|
354
|
+
# @return [String, nil]
|
|
355
|
+
required :refusal_reason_additional_information, String, nil?: true
|
|
356
|
+
|
|
357
|
+
# @!attribute refusal_reason_code
|
|
358
|
+
# The reason the wire drawdown request was refused as provided by the debtor bank.
|
|
359
|
+
#
|
|
360
|
+
# @return [Symbol, Increase::Models::WireDrawdownRequest::Refusal::RefusalReasonCode]
|
|
361
|
+
required :refusal_reason_code, enum: -> { Increase::WireDrawdownRequest::Refusal::RefusalReasonCode }
|
|
362
|
+
|
|
363
|
+
# @!attribute refused_at
|
|
364
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
365
|
+
# the wire drawdown request was refused.
|
|
366
|
+
#
|
|
367
|
+
# @return [Time]
|
|
368
|
+
required :refused_at, Time
|
|
369
|
+
|
|
370
|
+
# @!method initialize(refusal_reason_additional_information:, refusal_reason_code:, refused_at:)
|
|
371
|
+
# If the debtor refuses the drawdown request, this will contain supplemental
|
|
372
|
+
# details.
|
|
373
|
+
#
|
|
374
|
+
# @param refusal_reason_additional_information [String, nil]
|
|
375
|
+
# Additional information about the refusal provided by the debtor bank. This is
|
|
376
|
+
# typically present when the `refusal_reason_code` is `narrative`.
|
|
377
|
+
#
|
|
378
|
+
# @param refusal_reason_code [Symbol, Increase::Models::WireDrawdownRequest::Refusal::RefusalReasonCode]
|
|
379
|
+
# The reason the wire drawdown request was refused as provided by the debtor bank.
|
|
380
|
+
#
|
|
381
|
+
# @param refused_at [Time]
|
|
382
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
383
|
+
# the wire drawdown request was refused.
|
|
384
|
+
|
|
385
|
+
# The reason the wire drawdown request was refused as provided by the debtor bank.
|
|
386
|
+
#
|
|
387
|
+
# @see Increase::Models::WireDrawdownRequest::Refusal#refusal_reason_code
|
|
388
|
+
module RefusalReasonCode
|
|
389
|
+
extend Increase::Internal::Type::Enum
|
|
390
|
+
|
|
391
|
+
# The debtor's account number is invalid or missing. Corresponds to the Fedwire reason code `AC02`.
|
|
392
|
+
INVALID_DEBTOR_ACCOUNT_NUMBER = :invalid_debtor_account_number
|
|
393
|
+
|
|
394
|
+
# The debtor account does not allow drawdown requests. Corresponds to the Fedwire reason code `AG01`.
|
|
395
|
+
TRANSACTION_FORBIDDEN = :transaction_forbidden
|
|
396
|
+
|
|
397
|
+
# The debtor account cannot be debited for a generic reason. Corresponds to the Fedwire reason code `AG07`.
|
|
398
|
+
UNSUCCESSFUL_DIRECT_DEBIT = :unsuccessful_direct_debit
|
|
399
|
+
|
|
400
|
+
# The debtor's identification is inconsistent with the debtor account number. Corresponds to the Fedwire reason code `BE01`.
|
|
401
|
+
INCONSISTENT_WITH_END_CUSTOMER = :inconsistent_with_end_customer
|
|
402
|
+
|
|
403
|
+
# The reason is provided as narrative information in the additional information field. Corresponds to the Fedwire reason code `NARR`.
|
|
404
|
+
NARRATIVE = :narrative
|
|
405
|
+
|
|
406
|
+
# Some other error or issue has occurred.
|
|
407
|
+
OTHER = :other
|
|
408
|
+
|
|
409
|
+
# @!method self.values
|
|
410
|
+
# @return [Array<Symbol>]
|
|
411
|
+
end
|
|
412
|
+
end
|
|
413
|
+
|
|
337
414
|
# The lifecycle status of the drawdown request.
|
|
338
415
|
#
|
|
339
416
|
# @see Increase::Models::WireDrawdownRequest#status
|
data/lib/increase/models.rb
CHANGED
|
@@ -335,10 +335,6 @@ module Increase
|
|
|
335
335
|
|
|
336
336
|
FileRetrieveParams = Increase::Models::FileRetrieveParams
|
|
337
337
|
|
|
338
|
-
Group = Increase::Models::Group
|
|
339
|
-
|
|
340
|
-
GroupRetrieveParams = Increase::Models::GroupRetrieveParams
|
|
341
|
-
|
|
342
338
|
InboundACHTransfer = Increase::Models::InboundACHTransfer
|
|
343
339
|
|
|
344
340
|
InboundACHTransferCreateNotificationOfChangeParams =
|
|
@@ -391,6 +387,9 @@ module Increase
|
|
|
391
387
|
InboundRealTimePaymentsTransferRetrieveParams =
|
|
392
388
|
Increase::Models::InboundRealTimePaymentsTransferRetrieveParams
|
|
393
389
|
|
|
390
|
+
InboundRealTimePaymentsTransferReturnParams =
|
|
391
|
+
Increase::Models::InboundRealTimePaymentsTransferReturnParams
|
|
392
|
+
|
|
394
393
|
InboundWireDrawdownRequest = Increase::Models::InboundWireDrawdownRequest
|
|
395
394
|
|
|
396
395
|
InboundWireDrawdownRequestListParams = Increase::Models::InboundWireDrawdownRequestListParams
|
|
@@ -449,22 +448,6 @@ module Increase
|
|
|
449
448
|
|
|
450
449
|
LockboxRecipientUpdateParams = Increase::Models::LockboxRecipientUpdateParams
|
|
451
450
|
|
|
452
|
-
OAuthApplication = Increase::Models::OAuthApplication
|
|
453
|
-
|
|
454
|
-
OAuthApplicationListParams = Increase::Models::OAuthApplicationListParams
|
|
455
|
-
|
|
456
|
-
OAuthApplicationRetrieveParams = Increase::Models::OAuthApplicationRetrieveParams
|
|
457
|
-
|
|
458
|
-
OAuthConnection = Increase::Models::OAuthConnection
|
|
459
|
-
|
|
460
|
-
OAuthConnectionListParams = Increase::Models::OAuthConnectionListParams
|
|
461
|
-
|
|
462
|
-
OAuthConnectionRetrieveParams = Increase::Models::OAuthConnectionRetrieveParams
|
|
463
|
-
|
|
464
|
-
OAuthToken = Increase::Models::OAuthToken
|
|
465
|
-
|
|
466
|
-
OAuthTokenCreateParams = Increase::Models::OAuthTokenCreateParams
|
|
467
|
-
|
|
468
451
|
PendingTransaction = Increase::Models::PendingTransaction
|
|
469
452
|
|
|
470
453
|
PendingTransactionCreateParams = Increase::Models::PendingTransactionCreateParams
|
|
@@ -3,16 +3,27 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class ACHTransfers
|
|
6
|
-
#
|
|
6
|
+
# An ACH Transfer has two primary descriptive fields:
|
|
7
|
+
# [`company_name`](/documentation/api/ach-transfers#create-an-ach-transfer.company_name)
|
|
8
|
+
# and
|
|
9
|
+
# [`individual_name`](/documentation/api/ach-transfers#create-an-ach-transfer.individual_name).
|
|
10
|
+
# You should set both of these, in addition to the required amount and account
|
|
11
|
+
# fields.
|
|
7
12
|
#
|
|
8
13
|
# @overload create(account_id:, amount:, statement_descriptor:, account_number: nil, addenda: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_name: nil, destination_account_holder: nil, external_account_id: nil, funding: nil, individual_id: nil, individual_name: nil, preferred_effective_date: nil, require_approval: nil, routing_number: nil, standard_entry_class_code: nil, request_options: {})
|
|
9
14
|
#
|
|
10
|
-
# @param account_id [String]
|
|
15
|
+
# @param account_id [String]
|
|
16
|
+
# The Increase identifier for the account that will originate the transfer. For
|
|
17
|
+
# credit transfers (transfers with a positive `amount`), this is the account that
|
|
18
|
+
# funds will be sent from. For debit transfers (transfers with a negative
|
|
19
|
+
# `amount`), this is the account that funds will be pulled into.
|
|
11
20
|
#
|
|
12
21
|
# @param amount [Integer]
|
|
13
22
|
# The transfer amount in USD cents. A positive amount originates a credit transfer
|
|
14
|
-
# pushing funds to the
|
|
15
|
-
# transfer pulling funds from the
|
|
23
|
+
# pushing funds from Increase to the account at the other bank. A negative amount
|
|
24
|
+
# originates a debit transfer pulling funds from the account at the other bank
|
|
25
|
+
# into Increase. Debit transfers
|
|
26
|
+
# [might result in a hold before funds are available](/documentation/sending-ach-debit-transfers).
|
|
16
27
|
#
|
|
17
28
|
# @param statement_descriptor [String]
|
|
18
29
|
# A description you choose to give the transfer. This will be saved with the
|
|
@@ -23,9 +34,10 @@ module Increase
|
|
|
23
34
|
# `individual_name` and `company_name` instead of relying on this fallback.
|
|
24
35
|
#
|
|
25
36
|
# @param account_number [String]
|
|
26
|
-
# The receiver's account number. For credit transfers (
|
|
27
|
-
# the account that funds will be sent to. For debit transfers
|
|
28
|
-
# this is the account that funds will be
|
|
37
|
+
# The receiver's account number. For credit transfers (transfers with a positive
|
|
38
|
+
# `amount`), this is the account that funds will be sent to. For debit transfers
|
|
39
|
+
# (transfers with a negative `amount`), this is the account that funds will be
|
|
40
|
+
# pulled from.
|
|
29
41
|
#
|
|
30
42
|
# @param addenda [Increase::Models::ACHTransferCreateParams::Addenda]
|
|
31
43
|
# Additional information passed through to the receiving bank with the transfer.
|
|
@@ -39,21 +51,26 @@ module Increase
|
|
|
39
51
|
# settlement timing, or returns. Only set this if your recipient has asked for it.
|
|
40
52
|
#
|
|
41
53
|
# @param company_discretionary_data [String]
|
|
42
|
-
# Custom data sent in the company batch header
|
|
43
|
-
# does not affect funds movement,
|
|
44
|
-
#
|
|
54
|
+
# Custom data sent in the company batch header, meant as metadata for the
|
|
55
|
+
# originator. This value is informational and does not affect funds movement,
|
|
56
|
+
# settlement timing, or returns. Most ACH transfers do not need this; we recommend
|
|
57
|
+
# storing metadata in your own application instead.
|
|
45
58
|
#
|
|
46
59
|
# @param company_entry_description [String]
|
|
47
|
-
# A short description sent in the company batch header
|
|
48
|
-
#
|
|
49
|
-
#
|
|
50
|
-
#
|
|
51
|
-
#
|
|
60
|
+
# A short description sent in the company batch header, meant to provide the
|
|
61
|
+
# receiver with a reason for the transfer. Many receivers do not surface this data
|
|
62
|
+
# on the receiver's bank statement. Only set this if your recipient has asked for
|
|
63
|
+
# a specific value or if Nacha mandates one for your Standard Entry Class (SEC)
|
|
64
|
+
# code and use case. For example, some use cases require constants like
|
|
65
|
+
# `ACCTVERIFY`, `PURCHASE`, `PAYROLL`, or `REVERSAL`.
|
|
52
66
|
#
|
|
53
67
|
# @param company_name [String]
|
|
54
|
-
# The name by which the recipient knows
|
|
55
|
-
#
|
|
56
|
-
#
|
|
68
|
+
# The name by which the recipient knows the counterparty of this transaction. If
|
|
69
|
+
# you're processing payments on behalf of another party, use their name, not your
|
|
70
|
+
# own, so that it's more likely the recipient understands the context of the
|
|
71
|
+
# payment. This value is usually displayed to the recipient on their bank
|
|
72
|
+
# statement. We recommend setting this on every transfer; if you do not, we fall
|
|
73
|
+
# back to the `statement_descriptor`.
|
|
57
74
|
#
|
|
58
75
|
# @param destination_account_holder [Symbol, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder]
|
|
59
76
|
# The type of entity that owns the receiver's account.
|
|
@@ -68,12 +85,16 @@ module Increase
|
|
|
68
85
|
# Defaults to `checking`.
|
|
69
86
|
#
|
|
70
87
|
# @param individual_id [String]
|
|
71
|
-
# Your internal identifier for the
|
|
72
|
-
#
|
|
88
|
+
# Your internal identifier for the recipient. This value is informational and
|
|
89
|
+
# generally not verified by the recipient's bank. Most callers can leave this
|
|
90
|
+
# unset. For the specific case of person-to-person credits with the WEB standard
|
|
91
|
+
# entry class code, this must include the name of the payer.
|
|
73
92
|
#
|
|
74
93
|
# @param individual_name [String]
|
|
75
|
-
# The name of the transfer recipient. This value is informational and
|
|
76
|
-
# by the recipient's bank.
|
|
94
|
+
# The name of the transfer recipient. This value is informational and generally
|
|
95
|
+
# not verified by the recipient's bank. This value is usually displayed to the
|
|
96
|
+
# recipient on their bank statement. We recommend setting this on every transfer;
|
|
97
|
+
# if you do not, we fall back to the `statement_descriptor`.
|
|
77
98
|
#
|
|
78
99
|
# @param preferred_effective_date [Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate]
|
|
79
100
|
# Configuration for how the effective date of the transfer will be set. This
|
|
@@ -64,6 +64,34 @@ module Increase
|
|
|
64
64
|
)
|
|
65
65
|
end
|
|
66
66
|
|
|
67
|
+
# Return an Inbound Real-Time Payments Transfer
|
|
68
|
+
#
|
|
69
|
+
# @overload return_(inbound_real_time_payments_transfer_id, amount: nil, request_options: {})
|
|
70
|
+
#
|
|
71
|
+
# @param inbound_real_time_payments_transfer_id [String]
|
|
72
|
+
# The identifier of the Inbound Real-Time Payments Transfer to return to its
|
|
73
|
+
# sender.
|
|
74
|
+
#
|
|
75
|
+
# @param amount [Integer]
|
|
76
|
+
# The amount to return, in USD cents. Defaults to the full amount of the Inbound
|
|
77
|
+
# Real-Time Payments Transfer, and can't be higher than it.
|
|
78
|
+
#
|
|
79
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
80
|
+
#
|
|
81
|
+
# @return [Increase::Models::RealTimePaymentsTransfer]
|
|
82
|
+
#
|
|
83
|
+
# @see Increase::Models::InboundRealTimePaymentsTransferReturnParams
|
|
84
|
+
def return_(inbound_real_time_payments_transfer_id, params = {})
|
|
85
|
+
parsed, options = Increase::InboundRealTimePaymentsTransferReturnParams.dump_request(params)
|
|
86
|
+
@client.request(
|
|
87
|
+
method: :post,
|
|
88
|
+
path: ["inbound_real_time_payments_transfers/%1$s/return", inbound_real_time_payments_transfer_id],
|
|
89
|
+
body: parsed,
|
|
90
|
+
model: Increase::RealTimePaymentsTransfer,
|
|
91
|
+
options: options
|
|
92
|
+
)
|
|
93
|
+
end
|
|
94
|
+
|
|
67
95
|
# @api private
|
|
68
96
|
#
|
|
69
97
|
# @param client [Increase::Client]
|
|
@@ -6,21 +6,31 @@ module Increase
|
|
|
6
6
|
class WireDrawdownRequests
|
|
7
7
|
# Simulates a Wire Drawdown Request being refused by the debtor.
|
|
8
8
|
#
|
|
9
|
-
# @overload refuse(wire_drawdown_request_id, request_options: {})
|
|
9
|
+
# @overload refuse(wire_drawdown_request_id, refusal_reason_additional_information: nil, refusal_reason_code: nil, request_options: {})
|
|
10
10
|
#
|
|
11
11
|
# @param wire_drawdown_request_id [String] The identifier of the Wire Drawdown Request you wish to refuse.
|
|
12
12
|
#
|
|
13
|
+
# @param refusal_reason_additional_information [String]
|
|
14
|
+
# Additional information about the refusal that the simulated refusal will have.
|
|
15
|
+
#
|
|
16
|
+
# @param refusal_reason_code [Symbol, Increase::Models::Simulations::WireDrawdownRequestRefuseParams::RefusalReasonCode]
|
|
17
|
+
# The reason code that the simulated refusal will have.
|
|
18
|
+
#
|
|
19
|
+
# Defaults to `other`.
|
|
20
|
+
#
|
|
13
21
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
14
22
|
#
|
|
15
23
|
# @return [Increase::Models::WireDrawdownRequest]
|
|
16
24
|
#
|
|
17
25
|
# @see Increase::Models::Simulations::WireDrawdownRequestRefuseParams
|
|
18
26
|
def refuse(wire_drawdown_request_id, params = {})
|
|
27
|
+
parsed, options = Increase::Simulations::WireDrawdownRequestRefuseParams.dump_request(params)
|
|
19
28
|
@client.request(
|
|
20
29
|
method: :post,
|
|
21
30
|
path: ["simulations/wire_drawdown_requests/%1$s/refuse", wire_drawdown_request_id],
|
|
31
|
+
body: parsed,
|
|
22
32
|
model: Increase::WireDrawdownRequest,
|
|
23
|
-
options:
|
|
33
|
+
options: options
|
|
24
34
|
)
|
|
25
35
|
end
|
|
26
36
|
|
data/lib/increase/version.rb
CHANGED
data/lib/increase.rb
CHANGED
|
@@ -202,8 +202,6 @@ require_relative "increase/models/file_link"
|
|
|
202
202
|
require_relative "increase/models/file_link_create_params"
|
|
203
203
|
require_relative "increase/models/file_list_params"
|
|
204
204
|
require_relative "increase/models/file_retrieve_params"
|
|
205
|
-
require_relative "increase/models/group"
|
|
206
|
-
require_relative "increase/models/group_retrieve_params"
|
|
207
205
|
require_relative "increase/models/inbound_ach_transfer"
|
|
208
206
|
require_relative "increase/models/inbound_ach_transfer_create_notification_of_change_params"
|
|
209
207
|
require_relative "increase/models/inbound_ach_transfer_decline_params"
|
|
@@ -228,6 +226,7 @@ require_relative "increase/models/inbound_real_time_payments_requests_for_paymen
|
|
|
228
226
|
require_relative "increase/models/inbound_real_time_payments_transfer"
|
|
229
227
|
require_relative "increase/models/inbound_real_time_payments_transfer_list_params"
|
|
230
228
|
require_relative "increase/models/inbound_real_time_payments_transfer_retrieve_params"
|
|
229
|
+
require_relative "increase/models/inbound_real_time_payments_transfer_return_params"
|
|
231
230
|
require_relative "increase/models/inbound_wire_drawdown_request"
|
|
232
231
|
require_relative "increase/models/inbound_wire_drawdown_request_list_params"
|
|
233
232
|
require_relative "increase/models/inbound_wire_drawdown_request_retrieve_params"
|
|
@@ -257,14 +256,6 @@ require_relative "increase/models/lockbox_recipient_create_params"
|
|
|
257
256
|
require_relative "increase/models/lockbox_recipient_list_params"
|
|
258
257
|
require_relative "increase/models/lockbox_recipient_retrieve_params"
|
|
259
258
|
require_relative "increase/models/lockbox_recipient_update_params"
|
|
260
|
-
require_relative "increase/models/oauth_application"
|
|
261
|
-
require_relative "increase/models/oauth_application_list_params"
|
|
262
|
-
require_relative "increase/models/oauth_application_retrieve_params"
|
|
263
|
-
require_relative "increase/models/oauth_connection"
|
|
264
|
-
require_relative "increase/models/oauth_connection_list_params"
|
|
265
|
-
require_relative "increase/models/oauth_connection_retrieve_params"
|
|
266
|
-
require_relative "increase/models/oauth_token"
|
|
267
|
-
require_relative "increase/models/oauth_token_create_params"
|
|
268
259
|
require_relative "increase/models/pending_transaction"
|
|
269
260
|
require_relative "increase/models/pending_transaction_create_params"
|
|
270
261
|
require_relative "increase/models/pending_transaction_list_params"
|
|
@@ -408,7 +399,6 @@ require_relative "increase/resources/external_accounts"
|
|
|
408
399
|
require_relative "increase/resources/fednow_transfers"
|
|
409
400
|
require_relative "increase/resources/file_links"
|
|
410
401
|
require_relative "increase/resources/files"
|
|
411
|
-
require_relative "increase/resources/groups"
|
|
412
402
|
require_relative "increase/resources/inbound_ach_transfers"
|
|
413
403
|
require_relative "increase/resources/inbound_check_deposits"
|
|
414
404
|
require_relative "increase/resources/inbound_fednow_transfers"
|
|
@@ -422,9 +412,6 @@ require_relative "increase/resources/intrafi_balances"
|
|
|
422
412
|
require_relative "increase/resources/intrafi_exclusions"
|
|
423
413
|
require_relative "increase/resources/lockbox_addresses"
|
|
424
414
|
require_relative "increase/resources/lockbox_recipients"
|
|
425
|
-
require_relative "increase/resources/oauth_applications"
|
|
426
|
-
require_relative "increase/resources/oauth_connections"
|
|
427
|
-
require_relative "increase/resources/oauth_tokens"
|
|
428
415
|
require_relative "increase/resources/pending_transactions"
|
|
429
416
|
require_relative "increase/resources/physical_card_profiles"
|
|
430
417
|
require_relative "increase/resources/physical_cards"
|
data/rbi/increase/client.rbi
CHANGED
|
@@ -174,18 +174,6 @@ module Increase
|
|
|
174
174
|
sig { returns(Increase::Resources::RealTimeDecisions) }
|
|
175
175
|
attr_reader :real_time_decisions
|
|
176
176
|
|
|
177
|
-
sig { returns(Increase::Resources::Groups) }
|
|
178
|
-
attr_reader :groups
|
|
179
|
-
|
|
180
|
-
sig { returns(Increase::Resources::OAuthApplications) }
|
|
181
|
-
attr_reader :oauth_applications
|
|
182
|
-
|
|
183
|
-
sig { returns(Increase::Resources::OAuthConnections) }
|
|
184
|
-
attr_reader :oauth_connections
|
|
185
|
-
|
|
186
|
-
sig { returns(Increase::Resources::OAuthTokens) }
|
|
187
|
-
attr_reader :oauth_tokens
|
|
188
|
-
|
|
189
177
|
sig { returns(Increase::Resources::IntrafiAccountEnrollments) }
|
|
190
178
|
attr_reader :intrafi_account_enrollments
|
|
191
179
|
|
|
@@ -363,7 +363,9 @@ module Increase
|
|
|
363
363
|
#
|
|
364
364
|
# https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#special-considerations-for-multipart-content
|
|
365
365
|
sig do
|
|
366
|
-
params(body: T.anything).returns(
|
|
366
|
+
params(body: T.anything).returns(
|
|
367
|
+
[String, T.proc.returns(T::Enumerable[String])]
|
|
368
|
+
)
|
|
367
369
|
end
|
|
368
370
|
private def encode_multipart_streaming(body)
|
|
369
371
|
end
|
|
@@ -73,19 +73,28 @@ module Increase
|
|
|
73
73
|
end
|
|
74
74
|
attr_writer :cancellation
|
|
75
75
|
|
|
76
|
-
#
|
|
76
|
+
# A description of the transfer date (typically `YYMMDD`), sent in the company
|
|
77
|
+
# batch header. This value is informational and does not affect funds movement,
|
|
78
|
+
# settlement timing, or returns.
|
|
77
79
|
sig { returns(T.nilable(String)) }
|
|
78
80
|
attr_accessor :company_descriptive_date
|
|
79
81
|
|
|
80
|
-
#
|
|
82
|
+
# Custom data sent in the company batch header, meant as metadata for the
|
|
83
|
+
# originator. This value is informational and does not affect funds movement,
|
|
84
|
+
# settlement timing, or returns.
|
|
81
85
|
sig { returns(T.nilable(String)) }
|
|
82
86
|
attr_accessor :company_discretionary_data
|
|
83
87
|
|
|
84
|
-
#
|
|
88
|
+
# A short description sent in the company batch header, meant to provide the
|
|
89
|
+
# receiver with a reason for the transfer. Many receivers do not surface this data
|
|
90
|
+
# on the receiver's bank statement.
|
|
85
91
|
sig { returns(T.nilable(String)) }
|
|
86
92
|
attr_accessor :company_entry_description
|
|
87
93
|
|
|
88
|
-
# The
|
|
94
|
+
# The Company ID sent in the batch header, which identifies the originator to the
|
|
95
|
+
# receiving bank. Businesses use this value to allowlist the companies permitted
|
|
96
|
+
# to debit their accounts. This value is configured by Increase and will be the
|
|
97
|
+
# same for all your transfers.
|
|
89
98
|
sig { returns(String) }
|
|
90
99
|
attr_accessor :company_id
|
|
91
100
|
|
|
@@ -173,10 +182,8 @@ module Increase
|
|
|
173
182
|
sig { returns(T.nilable(String)) }
|
|
174
183
|
attr_accessor :pending_transaction_id
|
|
175
184
|
|
|
176
|
-
# Configuration for how the effective date of the transfer
|
|
177
|
-
# determines same-day vs future-dated settlement timing.
|
|
178
|
-
# `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
|
|
179
|
-
# must be set.
|
|
185
|
+
# Configuration for how the effective date of the transfer was set. This
|
|
186
|
+
# determines same-day vs future-dated settlement timing.
|
|
180
187
|
sig { returns(Increase::ACHTransfer::PreferredEffectiveDate) }
|
|
181
188
|
attr_reader :preferred_effective_date
|
|
182
189
|
|
|
@@ -223,7 +230,7 @@ module Increase
|
|
|
223
230
|
attr_accessor :standard_entry_class_code
|
|
224
231
|
|
|
225
232
|
# The descriptor that will show on the recipient's bank statement.
|
|
226
|
-
sig { returns(String) }
|
|
233
|
+
sig { returns(T.nilable(String)) }
|
|
227
234
|
attr_accessor :statement_descriptor
|
|
228
235
|
|
|
229
236
|
# The lifecycle status of the transfer.
|
|
@@ -295,7 +302,7 @@ module Increase
|
|
|
295
302
|
settlement: T.nilable(Increase::ACHTransfer::Settlement::OrHash),
|
|
296
303
|
standard_entry_class_code:
|
|
297
304
|
Increase::ACHTransfer::StandardEntryClassCode::OrSymbol,
|
|
298
|
-
statement_descriptor: String,
|
|
305
|
+
statement_descriptor: T.nilable(String),
|
|
299
306
|
status: Increase::ACHTransfer::Status::OrSymbol,
|
|
300
307
|
submission: T.nilable(Increase::ACHTransfer::Submission::OrHash),
|
|
301
308
|
transaction_id: T.nilable(String),
|
|
@@ -325,13 +332,22 @@ module Increase
|
|
|
325
332
|
# If your account requires approvals for transfers and the transfer was not
|
|
326
333
|
# approved, this will contain details of the cancellation.
|
|
327
334
|
cancellation:,
|
|
328
|
-
#
|
|
335
|
+
# A description of the transfer date (typically `YYMMDD`), sent in the company
|
|
336
|
+
# batch header. This value is informational and does not affect funds movement,
|
|
337
|
+
# settlement timing, or returns.
|
|
329
338
|
company_descriptive_date:,
|
|
330
|
-
#
|
|
339
|
+
# Custom data sent in the company batch header, meant as metadata for the
|
|
340
|
+
# originator. This value is informational and does not affect funds movement,
|
|
341
|
+
# settlement timing, or returns.
|
|
331
342
|
company_discretionary_data:,
|
|
332
|
-
#
|
|
343
|
+
# A short description sent in the company batch header, meant to provide the
|
|
344
|
+
# receiver with a reason for the transfer. Many receivers do not surface this data
|
|
345
|
+
# on the receiver's bank statement.
|
|
333
346
|
company_entry_description:,
|
|
334
|
-
# The
|
|
347
|
+
# The Company ID sent in the batch header, which identifies the originator to the
|
|
348
|
+
# receiving bank. Businesses use this value to allowlist the companies permitted
|
|
349
|
+
# to debit their accounts. This value is configured by Increase and will be the
|
|
350
|
+
# same for all your transfers.
|
|
335
351
|
company_id:,
|
|
336
352
|
# The name by which the recipient knows you.
|
|
337
353
|
company_name:,
|
|
@@ -372,10 +388,8 @@ module Increase
|
|
|
372
388
|
# [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
|
|
373
389
|
# by someone else in your organization.
|
|
374
390
|
pending_transaction_id:,
|
|
375
|
-
# Configuration for how the effective date of the transfer
|
|
376
|
-
# determines same-day vs future-dated settlement timing.
|
|
377
|
-
# `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
|
|
378
|
-
# must be set.
|
|
391
|
+
# Configuration for how the effective date of the transfer was set. This
|
|
392
|
+
# determines same-day vs future-dated settlement timing.
|
|
379
393
|
preferred_effective_date:,
|
|
380
394
|
# If your transfer is returned, this will contain details of the return.
|
|
381
395
|
return_:,
|
|
@@ -446,7 +460,7 @@ module Increase
|
|
|
446
460
|
settlement: T.nilable(Increase::ACHTransfer::Settlement),
|
|
447
461
|
standard_entry_class_code:
|
|
448
462
|
Increase::ACHTransfer::StandardEntryClassCode::TaggedSymbol,
|
|
449
|
-
statement_descriptor: String,
|
|
463
|
+
statement_descriptor: T.nilable(String),
|
|
450
464
|
status: Increase::ACHTransfer::Status::TaggedSymbol,
|
|
451
465
|
submission: T.nilable(Increase::ACHTransfer::Submission),
|
|
452
466
|
transaction_id: T.nilable(String),
|
|
@@ -1730,10 +1744,8 @@ module Increase
|
|
|
1730
1744
|
end
|
|
1731
1745
|
attr_accessor :settlement_schedule
|
|
1732
1746
|
|
|
1733
|
-
# Configuration for how the effective date of the transfer
|
|
1734
|
-
# determines same-day vs future-dated settlement timing.
|
|
1735
|
-
# `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
|
|
1736
|
-
# must be set.
|
|
1747
|
+
# Configuration for how the effective date of the transfer was set. This
|
|
1748
|
+
# determines same-day vs future-dated settlement timing.
|
|
1737
1749
|
sig do
|
|
1738
1750
|
params(
|
|
1739
1751
|
date: T.nilable(Date),
|