increase 1.341.0 → 1.342.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/ach_prenotification.rb +1 -1
- data/lib/increase/models/ach_transfer.rb +21 -2
- data/lib/increase/models/beneficial_owner_create_params.rb +12 -9
- data/lib/increase/models/beneficial_owner_update_params.rb +12 -9
- data/lib/increase/models/check_transfer.rb +4 -2
- data/lib/increase/models/entity_create_params.rb +72 -54
- data/lib/increase/models/entity_update_params.rb +24 -18
- data/lib/increase/models/event.rb +8 -0
- data/lib/increase/models/event_list_params.rb +8 -0
- data/lib/increase/models/event_subscription.rb +8 -0
- data/lib/increase/models/event_subscription_create_params.rb +8 -0
- data/lib/increase/models/inbound_wire_transfer.rb +18 -1
- data/lib/increase/models/simulations/ach_transfer_return_params.rb +15 -2
- data/lib/increase/models/simulations/card_settlement_create_params.rb +16 -14
- data/lib/increase/models/simulations/program_create_params.rb +0 -3
- data/lib/increase/models/swift_transfer.rb +12 -1
- data/lib/increase/models/swift_transfer_create_params.rb +12 -1
- data/lib/increase/models/transaction.rb +21 -2
- data/lib/increase/models/unwrap_webhook_event.rb +8 -0
- data/lib/increase/resources/simulations/ach_transfers.rb +6 -1
- data/lib/increase/resources/simulations/card_settlements.rb +7 -6
- data/lib/increase/resources/swift_transfers.rb +5 -1
- data/lib/increase/version.rb +1 -1
- data/rbi/increase/models/ach_prenotification.rbi +1 -1
- data/rbi/increase/models/ach_transfer.rbi +19 -1
- data/rbi/increase/models/beneficial_owner_create_params.rbi +13 -8
- data/rbi/increase/models/beneficial_owner_update_params.rbi +13 -8
- data/rbi/increase/models/check_transfer.rbi +4 -2
- data/rbi/increase/models/entity_create_params.rbi +78 -48
- data/rbi/increase/models/entity_update_params.rbi +26 -16
- data/rbi/increase/models/event.rbi +14 -0
- data/rbi/increase/models/event_list_params.rbi +14 -0
- data/rbi/increase/models/event_subscription.rbi +14 -0
- data/rbi/increase/models/event_subscription_create_params.rbi +14 -0
- data/rbi/increase/models/inbound_wire_transfer.rbi +16 -0
- data/rbi/increase/models/simulations/ach_transfer_return_params.rbi +16 -1
- data/rbi/increase/models/simulations/card_settlement_create_params.rbi +17 -12
- data/rbi/increase/models/simulations/program_create_params.rbi +0 -7
- data/rbi/increase/models/swift_transfer.rbi +10 -0
- data/rbi/increase/models/swift_transfer_create_params.rbi +13 -0
- data/rbi/increase/models/transaction.rbi +19 -1
- data/rbi/increase/models/unwrap_webhook_event.rbi +14 -0
- data/rbi/increase/resources/simulations/ach_transfers.rbi +5 -0
- data/rbi/increase/resources/simulations/card_settlements.rbi +6 -5
- data/rbi/increase/resources/swift_transfers.rbi +4 -0
- data/sig/increase/models/ach_prenotification.rbs +1 -1
- data/sig/increase/models/ach_transfer.rbs +6 -1
- data/sig/increase/models/beneficial_owner_create_params.rbs +7 -5
- data/sig/increase/models/beneficial_owner_update_params.rbs +7 -5
- data/sig/increase/models/entity_create_params.rbs +42 -30
- data/sig/increase/models/entity_update_params.rbs +14 -10
- data/sig/increase/models/event.rbs +8 -0
- data/sig/increase/models/event_list_params.rbs +8 -0
- data/sig/increase/models/event_subscription.rbs +8 -0
- data/sig/increase/models/event_subscription_create_params.rbs +8 -0
- data/sig/increase/models/inbound_wire_transfer.rbs +10 -0
- data/sig/increase/models/simulations/ach_transfer_return_params.rbs +8 -1
- data/sig/increase/models/simulations/card_settlement_create_params.rbs +7 -5
- data/sig/increase/models/simulations/program_create_params.rbs +1 -8
- data/sig/increase/models/swift_transfer.rbs +5 -0
- data/sig/increase/models/swift_transfer_create_params.rbs +7 -0
- data/sig/increase/models/transaction.rbs +6 -1
- data/sig/increase/models/unwrap_webhook_event.rbs +8 -0
- data/sig/increase/resources/simulations/ach_transfers.rbs +1 -0
- data/sig/increase/resources/simulations/card_settlements.rbs +1 -1
- data/sig/increase/resources/swift_transfers.rbs +1 -0
- metadata +2 -2
|
@@ -65,6 +65,12 @@ module Increase
|
|
|
65
65
|
# @return [String, nil]
|
|
66
66
|
required :creditor_name, String, nil?: true
|
|
67
67
|
|
|
68
|
+
# @!attribute debtor_account_number
|
|
69
|
+
# The account number of the sender.
|
|
70
|
+
#
|
|
71
|
+
# @return [String, nil]
|
|
72
|
+
required :debtor_account_number, String, nil?: true
|
|
73
|
+
|
|
68
74
|
# @!attribute debtor_address_line1
|
|
69
75
|
# A free-form address field set by the sender.
|
|
70
76
|
#
|
|
@@ -89,6 +95,12 @@ module Increase
|
|
|
89
95
|
# @return [String, nil]
|
|
90
96
|
required :debtor_name, String, nil?: true
|
|
91
97
|
|
|
98
|
+
# @!attribute debtor_routing_number
|
|
99
|
+
# The American Banking Association (ABA) routing number of the sender.
|
|
100
|
+
#
|
|
101
|
+
# @return [String, nil]
|
|
102
|
+
required :debtor_routing_number, String, nil?: true
|
|
103
|
+
|
|
92
104
|
# @!attribute description
|
|
93
105
|
# An Increase-constructed description of the transfer.
|
|
94
106
|
#
|
|
@@ -167,7 +179,7 @@ module Increase
|
|
|
167
179
|
# @return [String, nil]
|
|
168
180
|
required :wire_drawdown_request_id, String, nil?: true
|
|
169
181
|
|
|
170
|
-
# @!method initialize(id:, acceptance:, account_id:, account_number_id:, amount:, created_at:, creditor_address_line1:, creditor_address_line2:, creditor_address_line3:, creditor_name:, debtor_address_line1:, debtor_address_line2:, debtor_address_line3:, debtor_name:, description:, end_to_end_identification:, input_message_accountability_data:, instructing_agent_routing_number:, instruction_identification:, purpose:, reversal:, status:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:, wire_drawdown_request_id:)
|
|
182
|
+
# @!method initialize(id:, acceptance:, account_id:, account_number_id:, amount:, created_at:, creditor_address_line1:, creditor_address_line2:, creditor_address_line3:, creditor_name:, debtor_account_number:, debtor_address_line1:, debtor_address_line2:, debtor_address_line3:, debtor_name:, debtor_routing_number:, description:, end_to_end_identification:, input_message_accountability_data:, instructing_agent_routing_number:, instruction_identification:, purpose:, reversal:, status:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:, wire_drawdown_request_id:)
|
|
171
183
|
# An Inbound Wire Transfer is a wire transfer initiated outside of Increase to
|
|
172
184
|
# your account.
|
|
173
185
|
#
|
|
@@ -194,6 +206,8 @@ module Increase
|
|
|
194
206
|
#
|
|
195
207
|
# @param creditor_name [String, nil] A name set by the sender.
|
|
196
208
|
#
|
|
209
|
+
# @param debtor_account_number [String, nil] The account number of the sender.
|
|
210
|
+
#
|
|
197
211
|
# @param debtor_address_line1 [String, nil] A free-form address field set by the sender.
|
|
198
212
|
#
|
|
199
213
|
# @param debtor_address_line2 [String, nil] A free-form address field set by the sender.
|
|
@@ -202,6 +216,9 @@ module Increase
|
|
|
202
216
|
#
|
|
203
217
|
# @param debtor_name [String, nil] A name set by the sender.
|
|
204
218
|
#
|
|
219
|
+
# @param debtor_routing_number [String, nil]
|
|
220
|
+
# The American Banking Association (ABA) routing number of the sender.
|
|
221
|
+
#
|
|
205
222
|
# @param description [String] An Increase-constructed description of the transfer.
|
|
206
223
|
#
|
|
207
224
|
# @param end_to_end_identification [String, nil]
|
|
@@ -14,6 +14,14 @@ module Increase
|
|
|
14
14
|
# @return [String]
|
|
15
15
|
required :ach_transfer_id, String
|
|
16
16
|
|
|
17
|
+
# @!attribute addenda_information
|
|
18
|
+
# Free-form information the returning bank includes in the return addenda. For a
|
|
19
|
+
# `file_record_edit_criteria` (R17) return, set this to `QUESTIONABLE` to simulate
|
|
20
|
+
# a return the bank believes was initiated under questionable circumstances.
|
|
21
|
+
#
|
|
22
|
+
# @return [String, nil]
|
|
23
|
+
optional :addenda_information, String
|
|
24
|
+
|
|
17
25
|
# @!attribute reason
|
|
18
26
|
# The reason why the Federal Reserve or destination bank returned this transfer.
|
|
19
27
|
# Defaults to `no_account`.
|
|
@@ -21,9 +29,14 @@ module Increase
|
|
|
21
29
|
# @return [Symbol, Increase::Models::Simulations::ACHTransferReturnParams::Reason, nil]
|
|
22
30
|
optional :reason, enum: -> { Increase::Simulations::ACHTransferReturnParams::Reason }
|
|
23
31
|
|
|
24
|
-
# @!method initialize(ach_transfer_id:, reason: nil, request_options: {})
|
|
32
|
+
# @!method initialize(ach_transfer_id:, addenda_information: nil, reason: nil, request_options: {})
|
|
25
33
|
# @param ach_transfer_id [String] The identifier of the ACH Transfer you wish to return.
|
|
26
34
|
#
|
|
35
|
+
# @param addenda_information [String]
|
|
36
|
+
# Free-form information the returning bank includes in the return addenda. For a
|
|
37
|
+
# `file_record_edit_criteria` (R17) return, set this to `QUESTIONABLE` to simulate
|
|
38
|
+
# a return the bank believes was initiated under questionable circumstances.
|
|
39
|
+
#
|
|
27
40
|
# @param reason [Symbol, Increase::Models::Simulations::ACHTransferReturnParams::Reason]
|
|
28
41
|
# The reason why the Federal Reserve or destination bank returned this transfer.
|
|
29
42
|
# Defaults to `no_account`.
|
|
@@ -85,7 +98,7 @@ module Increase
|
|
|
85
98
|
# Code R13. The routing number is invalid.
|
|
86
99
|
INVALID_ACH_ROUTING_NUMBER = :invalid_ach_routing_number
|
|
87
100
|
|
|
88
|
-
# Code R17. The receiving bank
|
|
101
|
+
# Code R17. This return code has multiple meanings. The receiving bank was either unable to process a field in the transfer, or believes the transfer was initiated under questionable circumstances (such as fraud), or identified an improperly-initiated reversing entry.
|
|
89
102
|
FILE_RECORD_EDIT_CRITERIA = :file_record_edit_criteria
|
|
90
103
|
|
|
91
104
|
# Code R45. A rare return reason. The individual name field was invalid.
|
|
@@ -14,30 +14,32 @@ module Increase
|
|
|
14
14
|
# @return [String]
|
|
15
15
|
required :card_id, String
|
|
16
16
|
|
|
17
|
-
# @!attribute pending_transaction_id
|
|
18
|
-
# The identifier of the Pending Transaction for the Card Authorization you wish to
|
|
19
|
-
# settle.
|
|
20
|
-
#
|
|
21
|
-
# @return [String]
|
|
22
|
-
required :pending_transaction_id, String
|
|
23
|
-
|
|
24
17
|
# @!attribute amount
|
|
25
18
|
# The amount to be settled. This defaults to the amount of the Pending Transaction
|
|
26
|
-
# being settled.
|
|
19
|
+
# being settled, or a random amount if `pending_transaction_id` is not provided.
|
|
27
20
|
#
|
|
28
21
|
# @return [Integer, nil]
|
|
29
22
|
optional :amount, Integer
|
|
30
23
|
|
|
31
|
-
# @!
|
|
32
|
-
#
|
|
24
|
+
# @!attribute pending_transaction_id
|
|
25
|
+
# The identifier of the Pending Transaction for the Card Authorization you wish to
|
|
26
|
+
# settle. If not provided, the settlement will be force posted without a Card
|
|
27
|
+
# Authorization.
|
|
33
28
|
#
|
|
34
|
-
# @
|
|
35
|
-
|
|
36
|
-
|
|
29
|
+
# @return [String, nil]
|
|
30
|
+
optional :pending_transaction_id, String
|
|
31
|
+
|
|
32
|
+
# @!method initialize(card_id:, amount: nil, pending_transaction_id: nil, request_options: {})
|
|
33
|
+
# @param card_id [String] The identifier of the Card to create a settlement on.
|
|
37
34
|
#
|
|
38
35
|
# @param amount [Integer]
|
|
39
36
|
# The amount to be settled. This defaults to the amount of the Pending Transaction
|
|
40
|
-
# being settled.
|
|
37
|
+
# being settled, or a random amount if `pending_transaction_id` is not provided.
|
|
38
|
+
#
|
|
39
|
+
# @param pending_transaction_id [String]
|
|
40
|
+
# The identifier of the Pending Transaction for the Card Authorization you wish to
|
|
41
|
+
# settle. If not provided, the settlement will be force posted without a Card
|
|
42
|
+
# Authorization.
|
|
41
43
|
#
|
|
42
44
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
43
45
|
end
|
|
@@ -93,6 +93,13 @@ module Increase
|
|
|
93
93
|
# @return [Symbol, Increase::Models::SwiftTransfer::InstructedCurrency]
|
|
94
94
|
required :instructed_currency, enum: -> { Increase::SwiftTransfer::InstructedCurrency }
|
|
95
95
|
|
|
96
|
+
# @!attribute intermediary_bank_identification_code
|
|
97
|
+
# The bank identification code (BIC) of the intermediary bank, if the transfer is
|
|
98
|
+
# routed through one.
|
|
99
|
+
#
|
|
100
|
+
# @return [String, nil]
|
|
101
|
+
required :intermediary_bank_identification_code, String, nil?: true
|
|
102
|
+
|
|
96
103
|
# @!attribute pending_transaction_id
|
|
97
104
|
# The ID for the pending transaction representing the transfer.
|
|
98
105
|
#
|
|
@@ -146,7 +153,7 @@ module Increase
|
|
|
146
153
|
# @return [String]
|
|
147
154
|
required :unstructured_remittance_information, String
|
|
148
155
|
|
|
149
|
-
# @!method initialize(id:, account_id:, account_number:, amount:, bank_identification_code:, created_at:, created_by:, creditor_address:, creditor_name:, debtor_address:, debtor_name:, idempotency_key:, instructed_amount:, instructed_currency:, pending_transaction_id:, routing_number:, source_account_number_id:, status:, transaction_id:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
|
|
156
|
+
# @!method initialize(id:, account_id:, account_number:, amount:, bank_identification_code:, created_at:, created_by:, creditor_address:, creditor_name:, debtor_address:, debtor_name:, idempotency_key:, instructed_amount:, instructed_currency:, intermediary_bank_identification_code:, pending_transaction_id:, routing_number:, source_account_number_id:, status:, transaction_id:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
|
|
150
157
|
# Swift Transfers send funds internationally.
|
|
151
158
|
#
|
|
152
159
|
# @param id [String] The Swift transfer's identifier.
|
|
@@ -187,6 +194,10 @@ module Increase
|
|
|
187
194
|
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the
|
|
188
195
|
# instructed amount.
|
|
189
196
|
#
|
|
197
|
+
# @param intermediary_bank_identification_code [String, nil]
|
|
198
|
+
# The bank identification code (BIC) of the intermediary bank, if the transfer is
|
|
199
|
+
# routed through one.
|
|
200
|
+
#
|
|
190
201
|
# @param pending_transaction_id [String, nil] The ID for the pending transaction representing the transfer.
|
|
191
202
|
#
|
|
192
203
|
# @param routing_number [String, nil]
|
|
@@ -76,6 +76,13 @@ module Increase
|
|
|
76
76
|
# @return [String]
|
|
77
77
|
required :unstructured_remittance_information, String
|
|
78
78
|
|
|
79
|
+
# @!attribute intermediary_bank_identification_code
|
|
80
|
+
# The bank identification code (BIC) of the intermediary bank, if the transfer
|
|
81
|
+
# should be routed through one.
|
|
82
|
+
#
|
|
83
|
+
# @return [String, nil]
|
|
84
|
+
optional :intermediary_bank_identification_code, String
|
|
85
|
+
|
|
79
86
|
# @!attribute require_approval
|
|
80
87
|
# Whether the transfer requires explicit approval via the dashboard or API.
|
|
81
88
|
#
|
|
@@ -89,7 +96,7 @@ module Increase
|
|
|
89
96
|
# @return [String, nil]
|
|
90
97
|
optional :routing_number, String
|
|
91
98
|
|
|
92
|
-
# @!method initialize(account_id:, account_number:, bank_identification_code:, creditor_address:, creditor_name:, debtor_address:, debtor_name:, instructed_amount:, instructed_currency:, source_account_number_id:, unstructured_remittance_information:, require_approval: nil, routing_number: nil, request_options: {})
|
|
99
|
+
# @!method initialize(account_id:, account_number:, bank_identification_code:, creditor_address:, creditor_name:, debtor_address:, debtor_name:, instructed_amount:, instructed_currency:, source_account_number_id:, unstructured_remittance_information:, intermediary_bank_identification_code: nil, require_approval: nil, routing_number: nil, request_options: {})
|
|
93
100
|
# @param account_id [String] The identifier for the account that will send the transfer.
|
|
94
101
|
#
|
|
95
102
|
# @param account_number [String] The creditor's account number.
|
|
@@ -121,6 +128,10 @@ module Increase
|
|
|
121
128
|
# @param unstructured_remittance_information [String]
|
|
122
129
|
# Unstructured remittance information to include in the transfer.
|
|
123
130
|
#
|
|
131
|
+
# @param intermediary_bank_identification_code [String]
|
|
132
|
+
# The bank identification code (BIC) of the intermediary bank, if the transfer
|
|
133
|
+
# should be routed through one.
|
|
134
|
+
#
|
|
124
135
|
# @param require_approval [Boolean]
|
|
125
136
|
# Whether the transfer requires explicit approval via the dashboard or API.
|
|
126
137
|
#
|
|
@@ -1112,6 +1112,17 @@ module Increase
|
|
|
1112
1112
|
|
|
1113
1113
|
# @see Increase::Models::Transaction::Source#ach_transfer_return
|
|
1114
1114
|
class ACHTransferReturn < Increase::Internal::Type::BaseModel
|
|
1115
|
+
# @!attribute addenda_information
|
|
1116
|
+
# Additional free-form information included by the receiving bank in the return's
|
|
1117
|
+
# addenda record. This is raw, uninterpreted text whose presence and format are
|
|
1118
|
+
# not guaranteed. For a `file_record_edit_criteria` (R17) return the receiving
|
|
1119
|
+
# bank may set this to `QUESTIONABLE` (optionally followed by more text) to
|
|
1120
|
+
# indicate it believes the transfer was initiated under questionable
|
|
1121
|
+
# circumstances.
|
|
1122
|
+
#
|
|
1123
|
+
# @return [String, nil]
|
|
1124
|
+
required :addenda_information, String, nil?: true
|
|
1125
|
+
|
|
1115
1126
|
# @!attribute created_at
|
|
1116
1127
|
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
1117
1128
|
# the transfer was created.
|
|
@@ -1155,7 +1166,7 @@ module Increase
|
|
|
1155
1166
|
# @return [String]
|
|
1156
1167
|
required :transfer_id, String
|
|
1157
1168
|
|
|
1158
|
-
# @!method initialize(created_at:, raw_return_reason_code:, return_reason_code:, trace_number:, transaction_id:, transfer_id:)
|
|
1169
|
+
# @!method initialize(addenda_information:, created_at:, raw_return_reason_code:, return_reason_code:, trace_number:, transaction_id:, transfer_id:)
|
|
1159
1170
|
# An ACH Transfer Return object. This field will be present in the JSON response
|
|
1160
1171
|
# if and only if `category` is equal to `ach_transfer_return`. An ACH Transfer
|
|
1161
1172
|
# Return is created when an ACH Transfer is returned by the receiving bank. It
|
|
@@ -1164,6 +1175,14 @@ module Increase
|
|
|
1164
1175
|
# later. The return appears as a new posted Transaction; no Pending Transaction is
|
|
1165
1176
|
# created.
|
|
1166
1177
|
#
|
|
1178
|
+
# @param addenda_information [String, nil]
|
|
1179
|
+
# Additional free-form information included by the receiving bank in the return's
|
|
1180
|
+
# addenda record. This is raw, uninterpreted text whose presence and format are
|
|
1181
|
+
# not guaranteed. For a `file_record_edit_criteria` (R17) return the receiving
|
|
1182
|
+
# bank may set this to `QUESTIONABLE` (optionally followed by more text) to
|
|
1183
|
+
# indicate it believes the transfer was initiated under questionable
|
|
1184
|
+
# circumstances.
|
|
1185
|
+
#
|
|
1167
1186
|
# @param created_at [Time]
|
|
1168
1187
|
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
1169
1188
|
# the transfer was created.
|
|
@@ -1243,7 +1262,7 @@ module Increase
|
|
|
1243
1262
|
# Code R13. The routing number is invalid.
|
|
1244
1263
|
INVALID_ACH_ROUTING_NUMBER = :invalid_ach_routing_number
|
|
1245
1264
|
|
|
1246
|
-
# Code R17. The receiving bank
|
|
1265
|
+
# Code R17. This return code has multiple meanings. The receiving bank was either unable to process a field in the transfer, or believes the transfer was initiated under questionable circumstances (such as fraud), or identified an improperly-initiated reversing entry.
|
|
1247
1266
|
FILE_RECORD_EDIT_CRITERIA = :file_record_edit_criteria
|
|
1248
1267
|
|
|
1249
1268
|
# Code R45. A rare return reason. The individual name field was invalid.
|
|
@@ -253,6 +253,14 @@ module Increase
|
|
|
253
253
|
# Occurs whenever an Inbound Mail Item is updated.
|
|
254
254
|
INBOUND_MAIL_ITEM_UPDATED = :"inbound_mail_item.updated"
|
|
255
255
|
|
|
256
|
+
# Occurs whenever an Inbound Real-Time Payments Request for Payment is created.
|
|
257
|
+
INBOUND_REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_CREATED =
|
|
258
|
+
:"inbound_real_time_payments_request_for_payment.created"
|
|
259
|
+
|
|
260
|
+
# Occurs whenever an Inbound Real-Time Payments Request for Payment is updated.
|
|
261
|
+
INBOUND_REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_UPDATED =
|
|
262
|
+
:"inbound_real_time_payments_request_for_payment.updated"
|
|
263
|
+
|
|
256
264
|
# Occurs whenever an Inbound Real-Time Payments Transfer is created.
|
|
257
265
|
INBOUND_REAL_TIME_PAYMENTS_TRANSFER_CREATED = :"inbound_real_time_payments_transfer.created"
|
|
258
266
|
|
|
@@ -67,10 +67,15 @@ module Increase
|
|
|
67
67
|
# due to an error condition. This will also create a Transaction to account for
|
|
68
68
|
# the returned funds. This transfer must first have a `status` of `submitted`.
|
|
69
69
|
#
|
|
70
|
-
# @overload return_(ach_transfer_id, reason: nil, request_options: {})
|
|
70
|
+
# @overload return_(ach_transfer_id, addenda_information: nil, reason: nil, request_options: {})
|
|
71
71
|
#
|
|
72
72
|
# @param ach_transfer_id [String] The identifier of the ACH Transfer you wish to return.
|
|
73
73
|
#
|
|
74
|
+
# @param addenda_information [String]
|
|
75
|
+
# Free-form information the returning bank includes in the return addenda. For a
|
|
76
|
+
# `file_record_edit_criteria` (R17) return, set this to `QUESTIONABLE` to simulate
|
|
77
|
+
# a return the bank believes was initiated under questionable circumstances.
|
|
78
|
+
#
|
|
74
79
|
# @param reason [Symbol, Increase::Models::Simulations::ACHTransferReturnParams::Reason]
|
|
75
80
|
# The reason why the Federal Reserve or destination bank returned this transfer.
|
|
76
81
|
# Defaults to `no_account`.
|
|
@@ -10,17 +10,18 @@ module Increase
|
|
|
10
10
|
# production. The amount settled can be different from the amount originally
|
|
11
11
|
# authorized, for example, when adding a tip to a restaurant bill.
|
|
12
12
|
#
|
|
13
|
-
# @overload create(card_id:,
|
|
13
|
+
# @overload create(card_id:, amount: nil, pending_transaction_id: nil, request_options: {})
|
|
14
14
|
#
|
|
15
15
|
# @param card_id [String] The identifier of the Card to create a settlement on.
|
|
16
16
|
#
|
|
17
|
-
# @param pending_transaction_id [String]
|
|
18
|
-
# The identifier of the Pending Transaction for the Card Authorization you wish to
|
|
19
|
-
# settle.
|
|
20
|
-
#
|
|
21
17
|
# @param amount [Integer]
|
|
22
18
|
# The amount to be settled. This defaults to the amount of the Pending Transaction
|
|
23
|
-
# being settled.
|
|
19
|
+
# being settled, or a random amount if `pending_transaction_id` is not provided.
|
|
20
|
+
#
|
|
21
|
+
# @param pending_transaction_id [String]
|
|
22
|
+
# The identifier of the Pending Transaction for the Card Authorization you wish to
|
|
23
|
+
# settle. If not provided, the settlement will be force posted without a Card
|
|
24
|
+
# Authorization.
|
|
24
25
|
#
|
|
25
26
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
26
27
|
#
|
|
@@ -5,7 +5,7 @@ module Increase
|
|
|
5
5
|
class SwiftTransfers
|
|
6
6
|
# Create a Swift Transfer
|
|
7
7
|
#
|
|
8
|
-
# @overload create(account_id:, account_number:, bank_identification_code:, creditor_address:, creditor_name:, debtor_address:, debtor_name:, instructed_amount:, instructed_currency:, source_account_number_id:, unstructured_remittance_information:, require_approval: nil, routing_number: nil, request_options: {})
|
|
8
|
+
# @overload create(account_id:, account_number:, bank_identification_code:, creditor_address:, creditor_name:, debtor_address:, debtor_name:, instructed_amount:, instructed_currency:, source_account_number_id:, unstructured_remittance_information:, intermediary_bank_identification_code: nil, require_approval: nil, routing_number: nil, request_options: {})
|
|
9
9
|
#
|
|
10
10
|
# @param account_id [String] The identifier for the account that will send the transfer.
|
|
11
11
|
#
|
|
@@ -38,6 +38,10 @@ module Increase
|
|
|
38
38
|
# @param unstructured_remittance_information [String]
|
|
39
39
|
# Unstructured remittance information to include in the transfer.
|
|
40
40
|
#
|
|
41
|
+
# @param intermediary_bank_identification_code [String]
|
|
42
|
+
# The bank identification code (BIC) of the intermediary bank, if the transfer
|
|
43
|
+
# should be routed through one.
|
|
44
|
+
#
|
|
41
45
|
# @param require_approval [Boolean]
|
|
42
46
|
# Whether the transfer requires explicit approval via the dashboard or API.
|
|
43
47
|
#
|
data/lib/increase/version.rb
CHANGED
|
@@ -770,7 +770,7 @@ module Increase
|
|
|
770
770
|
Increase::ACHPrenotification::PrenotificationReturn::ReturnReasonCode::TaggedSymbol
|
|
771
771
|
)
|
|
772
772
|
|
|
773
|
-
# Code R17. The receiving bank
|
|
773
|
+
# Code R17. This return code has multiple meanings. The receiving bank was either unable to process a field in the transfer, or believes the transfer was initiated under questionable circumstances (such as fraud), or identified an improperly-initiated reversing entry.
|
|
774
774
|
FILE_RECORD_EDIT_CRITERIA =
|
|
775
775
|
T.let(
|
|
776
776
|
:file_record_edit_criteria,
|
|
@@ -1814,6 +1814,15 @@ module Increase
|
|
|
1814
1814
|
T.any(Increase::ACHTransfer::Return, Increase::Internal::AnyHash)
|
|
1815
1815
|
end
|
|
1816
1816
|
|
|
1817
|
+
# Additional free-form information included by the receiving bank in the return's
|
|
1818
|
+
# addenda record. This is raw, uninterpreted text whose presence and format are
|
|
1819
|
+
# not guaranteed. For a `file_record_edit_criteria` (R17) return the receiving
|
|
1820
|
+
# bank may set this to `QUESTIONABLE` (optionally followed by more text) to
|
|
1821
|
+
# indicate it believes the transfer was initiated under questionable
|
|
1822
|
+
# circumstances.
|
|
1823
|
+
sig { returns(T.nilable(String)) }
|
|
1824
|
+
attr_accessor :addenda_information
|
|
1825
|
+
|
|
1817
1826
|
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
1818
1827
|
# the transfer was created.
|
|
1819
1828
|
sig { returns(Time) }
|
|
@@ -1849,6 +1858,7 @@ module Increase
|
|
|
1849
1858
|
# If your transfer is returned, this will contain details of the return.
|
|
1850
1859
|
sig do
|
|
1851
1860
|
params(
|
|
1861
|
+
addenda_information: T.nilable(String),
|
|
1852
1862
|
created_at: Time,
|
|
1853
1863
|
raw_return_reason_code: String,
|
|
1854
1864
|
return_reason_code:
|
|
@@ -1859,6 +1869,13 @@ module Increase
|
|
|
1859
1869
|
).returns(T.attached_class)
|
|
1860
1870
|
end
|
|
1861
1871
|
def self.new(
|
|
1872
|
+
# Additional free-form information included by the receiving bank in the return's
|
|
1873
|
+
# addenda record. This is raw, uninterpreted text whose presence and format are
|
|
1874
|
+
# not guaranteed. For a `file_record_edit_criteria` (R17) return the receiving
|
|
1875
|
+
# bank may set this to `QUESTIONABLE` (optionally followed by more text) to
|
|
1876
|
+
# indicate it believes the transfer was initiated under questionable
|
|
1877
|
+
# circumstances.
|
|
1878
|
+
addenda_information:,
|
|
1862
1879
|
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
1863
1880
|
# the transfer was created.
|
|
1864
1881
|
created_at:,
|
|
@@ -1883,6 +1900,7 @@ module Increase
|
|
|
1883
1900
|
sig do
|
|
1884
1901
|
override.returns(
|
|
1885
1902
|
{
|
|
1903
|
+
addenda_information: T.nilable(String),
|
|
1886
1904
|
created_at: Time,
|
|
1887
1905
|
raw_return_reason_code: String,
|
|
1888
1906
|
return_reason_code:
|
|
@@ -2019,7 +2037,7 @@ module Increase
|
|
|
2019
2037
|
Increase::ACHTransfer::Return::ReturnReasonCode::TaggedSymbol
|
|
2020
2038
|
)
|
|
2021
2039
|
|
|
2022
|
-
# Code R17. The receiving bank
|
|
2040
|
+
# Code R17. This return code has multiple meanings. The receiving bank was either unable to process a field in the transfer, or believes the transfer was initiated under questionable circumstances (such as fraud), or identified an improperly-initiated reversing entry.
|
|
2023
2041
|
FILE_RECORD_EDIT_CRITERIA =
|
|
2024
2042
|
T.let(
|
|
2025
2043
|
:file_record_edit_criteria,
|
|
@@ -205,14 +205,18 @@ module Increase
|
|
|
205
205
|
sig { returns(String) }
|
|
206
206
|
attr_accessor :city
|
|
207
207
|
|
|
208
|
-
# The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
|
209
|
-
sig { returns(String) }
|
|
210
|
-
attr_accessor :country
|
|
211
|
-
|
|
212
208
|
# The first line of the address. This is usually the street number and street.
|
|
213
209
|
sig { returns(String) }
|
|
214
210
|
attr_accessor :line1
|
|
215
211
|
|
|
212
|
+
# The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
|
|
213
|
+
# to `US`.
|
|
214
|
+
sig { returns(T.nilable(String)) }
|
|
215
|
+
attr_reader :country
|
|
216
|
+
|
|
217
|
+
sig { params(country: String).void }
|
|
218
|
+
attr_writer :country
|
|
219
|
+
|
|
216
220
|
# The second line of the address. This might be the floor or room number.
|
|
217
221
|
sig { returns(T.nilable(String)) }
|
|
218
222
|
attr_reader :line2
|
|
@@ -240,8 +244,8 @@ module Increase
|
|
|
240
244
|
sig do
|
|
241
245
|
params(
|
|
242
246
|
city: String,
|
|
243
|
-
country: String,
|
|
244
247
|
line1: String,
|
|
248
|
+
country: String,
|
|
245
249
|
line2: String,
|
|
246
250
|
state: String,
|
|
247
251
|
zip: String
|
|
@@ -250,10 +254,11 @@ module Increase
|
|
|
250
254
|
def self.new(
|
|
251
255
|
# The city, district, town, or village of the address.
|
|
252
256
|
city:,
|
|
253
|
-
# The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
|
254
|
-
country:,
|
|
255
257
|
# The first line of the address. This is usually the street number and street.
|
|
256
258
|
line1:,
|
|
259
|
+
# The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
|
|
260
|
+
# to `US`.
|
|
261
|
+
country: nil,
|
|
257
262
|
# The second line of the address. This might be the floor or room number.
|
|
258
263
|
line2: nil,
|
|
259
264
|
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
@@ -268,8 +273,8 @@ module Increase
|
|
|
268
273
|
override.returns(
|
|
269
274
|
{
|
|
270
275
|
city: String,
|
|
271
|
-
country: String,
|
|
272
276
|
line1: String,
|
|
277
|
+
country: String,
|
|
273
278
|
line2: String,
|
|
274
279
|
state: String,
|
|
275
280
|
zip: String
|
|
@@ -152,14 +152,18 @@ module Increase
|
|
|
152
152
|
sig { returns(String) }
|
|
153
153
|
attr_accessor :city
|
|
154
154
|
|
|
155
|
-
# The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
|
156
|
-
sig { returns(String) }
|
|
157
|
-
attr_accessor :country
|
|
158
|
-
|
|
159
155
|
# The first line of the address. This is usually the street number and street.
|
|
160
156
|
sig { returns(String) }
|
|
161
157
|
attr_accessor :line1
|
|
162
158
|
|
|
159
|
+
# The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
|
|
160
|
+
# to `US`.
|
|
161
|
+
sig { returns(T.nilable(String)) }
|
|
162
|
+
attr_reader :country
|
|
163
|
+
|
|
164
|
+
sig { params(country: String).void }
|
|
165
|
+
attr_writer :country
|
|
166
|
+
|
|
163
167
|
# The second line of the address. This might be the floor or room number.
|
|
164
168
|
sig { returns(T.nilable(String)) }
|
|
165
169
|
attr_reader :line2
|
|
@@ -187,8 +191,8 @@ module Increase
|
|
|
187
191
|
sig do
|
|
188
192
|
params(
|
|
189
193
|
city: String,
|
|
190
|
-
country: String,
|
|
191
194
|
line1: String,
|
|
195
|
+
country: String,
|
|
192
196
|
line2: String,
|
|
193
197
|
state: String,
|
|
194
198
|
zip: String
|
|
@@ -197,10 +201,11 @@ module Increase
|
|
|
197
201
|
def self.new(
|
|
198
202
|
# The city, district, town, or village of the address.
|
|
199
203
|
city:,
|
|
200
|
-
# The two-letter ISO 3166-1 alpha-2 code for the country of the address.
|
|
201
|
-
country:,
|
|
202
204
|
# The first line of the address. This is usually the street number and street.
|
|
203
205
|
line1:,
|
|
206
|
+
# The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
|
|
207
|
+
# to `US`.
|
|
208
|
+
country: nil,
|
|
204
209
|
# The second line of the address. This might be the floor or room number.
|
|
205
210
|
line2: nil,
|
|
206
211
|
# The two-letter United States Postal Service (USPS) abbreviation for the US
|
|
@@ -215,8 +220,8 @@ module Increase
|
|
|
215
220
|
override.returns(
|
|
216
221
|
{
|
|
217
222
|
city: String,
|
|
218
|
-
country: String,
|
|
219
223
|
line1: String,
|
|
224
|
+
country: String,
|
|
220
225
|
line2: String,
|
|
221
226
|
state: String,
|
|
222
227
|
zip: String
|
|
@@ -836,7 +836,8 @@ module Increase
|
|
|
836
836
|
end
|
|
837
837
|
attr_writer :signature
|
|
838
838
|
|
|
839
|
-
# Tracking updates relating to the physical check's delivery.
|
|
839
|
+
# Tracking updates relating to the physical check's delivery. Sorted by
|
|
840
|
+
# `created_at` in ascending order.
|
|
840
841
|
sig do
|
|
841
842
|
returns(
|
|
842
843
|
T::Array[Increase::CheckTransfer::PhysicalCheck::TrackingUpdate]
|
|
@@ -896,7 +897,8 @@ module Increase
|
|
|
896
897
|
shipping_method:,
|
|
897
898
|
# The signature that will appear on the check.
|
|
898
899
|
signature:,
|
|
899
|
-
# Tracking updates relating to the physical check's delivery.
|
|
900
|
+
# Tracking updates relating to the physical check's delivery. Sorted by
|
|
901
|
+
# `created_at` in ascending order.
|
|
900
902
|
tracking_updates:
|
|
901
903
|
)
|
|
902
904
|
end
|