increase 0.165.0 → 0.167.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.
- package/CHANGELOG.md +16 -0
- package/package.json +1 -1
- package/resources/card-payments.d.ts +212 -14
- package/resources/card-payments.d.ts.map +1 -1
- package/resources/card-payments.js.map +1 -1
- package/resources/card-payments.mjs.map +1 -1
- package/resources/pending-transactions.d.ts +31 -4
- package/resources/pending-transactions.d.ts.map +1 -1
- package/resources/pending-transactions.js.map +1 -1
- package/resources/pending-transactions.mjs.map +1 -1
- package/resources/transactions.d.ts +239 -44
- package/resources/transactions.d.ts.map +1 -1
- package/resources/transactions.js.map +1 -1
- package/resources/transactions.mjs.map +1 -1
- package/src/resources/card-payments.ts +253 -14
- package/src/resources/pending-transactions.ts +33 -4
- package/src/resources/transactions.ts +250 -44
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -92,52 +92,73 @@ export declare namespace Transaction {
|
|
|
92
92
|
interface Source {
|
|
93
93
|
/**
|
|
94
94
|
* An Account Transfer Intention object. This field will be present in the JSON
|
|
95
|
-
* response if and only if `category` is equal to `account_transfer_intention`.
|
|
95
|
+
* response if and only if `category` is equal to `account_transfer_intention`. Two
|
|
96
|
+
* Account Transfer Intentions are created from each Account Transfer. One
|
|
97
|
+
* decrements the source account, and the other increments the destination account.
|
|
96
98
|
*/
|
|
97
99
|
account_transfer_intention: Source.AccountTransferIntention | null;
|
|
98
100
|
/**
|
|
99
101
|
* An ACH Transfer Intention object. This field will be present in the JSON
|
|
100
|
-
* response if and only if `category` is equal to `ach_transfer_intention`.
|
|
102
|
+
* response if and only if `category` is equal to `ach_transfer_intention`. An ACH
|
|
103
|
+
* Transfer Intention is created from an ACH Transfer. It reflects the intention to
|
|
104
|
+
* move money into or out of an Increase account via the ACH network.
|
|
101
105
|
*/
|
|
102
106
|
ach_transfer_intention: Source.ACHTransferIntention | null;
|
|
103
107
|
/**
|
|
104
108
|
* An ACH Transfer Rejection object. This field will be present in the JSON
|
|
105
|
-
* response if and only if `category` is equal to `ach_transfer_rejection`.
|
|
109
|
+
* response if and only if `category` is equal to `ach_transfer_rejection`. An ACH
|
|
110
|
+
* Transfer Rejection is created when an ACH Transfer is rejected by Increase. It
|
|
111
|
+
* offsets the ACH Transfer Intention. These rejections are rare.
|
|
106
112
|
*/
|
|
107
113
|
ach_transfer_rejection: Source.ACHTransferRejection | null;
|
|
108
114
|
/**
|
|
109
115
|
* An ACH Transfer Return object. This field will be present in the JSON response
|
|
110
|
-
* if and only if `category` is equal to `ach_transfer_return`.
|
|
116
|
+
* if and only if `category` is equal to `ach_transfer_return`. An ACH Transfer
|
|
117
|
+
* Return is created when an ACH Transfer is returned by the receiving bank. It
|
|
118
|
+
* offsets the ACH Transfer Intention. ACH Transfer Returns usually occur within
|
|
119
|
+
* the first two business days after the transfer is initiated, but can occur much
|
|
120
|
+
* later.
|
|
111
121
|
*/
|
|
112
122
|
ach_transfer_return: Source.ACHTransferReturn | null;
|
|
113
123
|
/**
|
|
114
124
|
* A Card Dispute Acceptance object. This field will be present in the JSON
|
|
115
125
|
* response if and only if `category` is equal to `card_dispute_acceptance`.
|
|
126
|
+
* Contains the details of a successful Card Dispute.
|
|
116
127
|
*/
|
|
117
128
|
card_dispute_acceptance: Source.CardDisputeAcceptance | null;
|
|
118
129
|
/**
|
|
119
130
|
* A Card Dispute Loss object. This field will be present in the JSON response if
|
|
120
|
-
* and only if `category` is equal to `card_dispute_loss`.
|
|
131
|
+
* and only if `category` is equal to `card_dispute_loss`. Contains the details of
|
|
132
|
+
* a lost Card Dispute.
|
|
121
133
|
*/
|
|
122
134
|
card_dispute_loss: Source.CardDisputeLoss | null;
|
|
123
135
|
/**
|
|
124
136
|
* A Card Refund object. This field will be present in the JSON response if and
|
|
125
|
-
* only if `category` is equal to `card_refund`.
|
|
137
|
+
* only if `category` is equal to `card_refund`. Card Refunds move money back to
|
|
138
|
+
* the cardholder. While they are usually connected to a Card Settlement an
|
|
139
|
+
* acquirer can also refund money directly to a card without relation to a
|
|
140
|
+
* transaction.
|
|
126
141
|
*/
|
|
127
142
|
card_refund: Source.CardRefund | null;
|
|
128
143
|
/**
|
|
129
144
|
* A Card Revenue Payment object. This field will be present in the JSON response
|
|
130
|
-
* if and only if `category` is equal to `card_revenue_payment`.
|
|
145
|
+
* if and only if `category` is equal to `card_revenue_payment`. Card Revenue
|
|
146
|
+
* Payments reflect earnings from fees on card transactions.
|
|
131
147
|
*/
|
|
132
148
|
card_revenue_payment: Source.CardRevenuePayment | null;
|
|
133
149
|
/**
|
|
134
150
|
* A Card Settlement object. This field will be present in the JSON response if and
|
|
135
|
-
* only if `category` is equal to `card_settlement`.
|
|
151
|
+
* only if `category` is equal to `card_settlement`. Card Settlements are card
|
|
152
|
+
* transactions that have cleared and settled. While a settlement is usually
|
|
153
|
+
* preceded by an authorization, an acquirer can also directly clear a transaction
|
|
154
|
+
* without first authorizing it.
|
|
136
155
|
*/
|
|
137
156
|
card_settlement: Source.CardSettlement | null;
|
|
138
157
|
/**
|
|
139
158
|
* A Cashback Payment object. This field will be present in the JSON response if
|
|
140
|
-
* and only if `category` is equal to `cashback_payment`.
|
|
159
|
+
* and only if `category` is equal to `cashback_payment`. A Cashback Payment
|
|
160
|
+
* represents the cashback paid to a cardholder for a given period. Cashback is
|
|
161
|
+
* usually paid monthly for the prior month's transactions.
|
|
141
162
|
*/
|
|
142
163
|
cashback_payment: Source.CashbackPayment | null;
|
|
143
164
|
/**
|
|
@@ -208,33 +229,70 @@ export declare namespace Transaction {
|
|
|
208
229
|
category: 'account_transfer_intention' | 'ach_transfer_intention' | 'ach_transfer_rejection' | 'ach_transfer_return' | 'cashback_payment' | 'card_dispute_acceptance' | 'card_dispute_loss' | 'card_refund' | 'card_settlement' | 'card_revenue_payment' | 'check_deposit_acceptance' | 'check_deposit_return' | 'check_transfer_deposit' | 'fee_payment' | 'inbound_ach_transfer' | 'inbound_ach_transfer_return_intention' | 'inbound_check_deposit_return_intention' | 'inbound_check_adjustment' | 'inbound_real_time_payments_transfer_confirmation' | 'inbound_real_time_payments_transfer_decline' | 'inbound_wire_reversal' | 'inbound_wire_transfer' | 'inbound_wire_transfer_reversal' | 'interest_payment' | 'internal_source' | 'real_time_payments_transfer_acknowledgement' | 'sample_funds' | 'wire_transfer_intention' | 'other';
|
|
209
230
|
/**
|
|
210
231
|
* A Check Deposit Acceptance object. This field will be present in the JSON
|
|
211
|
-
* response if and only if `category` is equal to `check_deposit_acceptance`.
|
|
232
|
+
* response if and only if `category` is equal to `check_deposit_acceptance`. A
|
|
233
|
+
* Check Deposit Acceptance is created when a Check Deposit is processed and its
|
|
234
|
+
* details confirmed. Check Deposits may be returned by the receiving bank, which
|
|
235
|
+
* will appear as a Check Deposit Return.
|
|
212
236
|
*/
|
|
213
237
|
check_deposit_acceptance: Source.CheckDepositAcceptance | null;
|
|
214
238
|
/**
|
|
215
239
|
* A Check Deposit Return object. This field will be present in the JSON response
|
|
216
|
-
* if and only if `category` is equal to `check_deposit_return`.
|
|
240
|
+
* if and only if `category` is equal to `check_deposit_return`. A Check Deposit
|
|
241
|
+
* Return is created when a Check Deposit is returned by the bank holding the
|
|
242
|
+
* account it was drawn against. Check Deposits may be returned for a variety of
|
|
243
|
+
* reasons, including insufficient funds or a mismatched account number. Usually,
|
|
244
|
+
* checks are returned within the first 7 days after the deposit is made.
|
|
217
245
|
*/
|
|
218
246
|
check_deposit_return: Source.CheckDepositReturn | null;
|
|
219
247
|
/**
|
|
220
248
|
* A Check Transfer Deposit object. This field will be present in the JSON response
|
|
221
|
-
* if and only if `category` is equal to `check_transfer_deposit`.
|
|
249
|
+
* if and only if `category` is equal to `check_transfer_deposit`. An Inbound Check
|
|
250
|
+
* is a check drawn on an Increase account that has been deposited by an external
|
|
251
|
+
* bank account. These types of checks are not pre-registered.
|
|
222
252
|
*/
|
|
223
253
|
check_transfer_deposit: Source.CheckTransferDeposit | null;
|
|
224
254
|
/**
|
|
225
255
|
* A Fee Payment object. This field will be present in the JSON response if and
|
|
226
|
-
* only if `category` is equal to `fee_payment`.
|
|
256
|
+
* only if `category` is equal to `fee_payment`. A Fee Payment represents a payment
|
|
257
|
+
* made to Increase.
|
|
227
258
|
*/
|
|
228
259
|
fee_payment: Source.FeePayment | null;
|
|
229
260
|
/**
|
|
230
261
|
* An Inbound ACH Transfer Intention object. This field will be present in the JSON
|
|
231
|
-
* response if and only if `category` is equal to `inbound_ach_transfer`.
|
|
262
|
+
* response if and only if `category` is equal to `inbound_ach_transfer`. An
|
|
263
|
+
* Inbound ACH Transfer Intention is created when an ACH transfer is initiated at
|
|
264
|
+
* another bank and received by Increase.
|
|
232
265
|
*/
|
|
233
266
|
inbound_ach_transfer: Source.InboundACHTransfer | null;
|
|
267
|
+
/**
|
|
268
|
+
* An Inbound ACH Transfer Return Intention object. This field will be present in
|
|
269
|
+
* the JSON response if and only if `category` is equal to
|
|
270
|
+
* `inbound_ach_transfer_return_intention`. An Inbound ACH Transfer Return
|
|
271
|
+
* Intention is created when an ACH transfer is initiated at another bank and
|
|
272
|
+
* returned by Increase.
|
|
273
|
+
*/
|
|
274
|
+
inbound_ach_transfer_return_intention: Source.InboundACHTransferReturnIntention | null;
|
|
275
|
+
/**
|
|
276
|
+
* An Inbound Check Adjustment object. This field will be present in the JSON
|
|
277
|
+
* response if and only if `category` is equal to `inbound_check_adjustment`. An
|
|
278
|
+
* Inbound Check Adjustment is created when Increase receives an adjustment for a
|
|
279
|
+
* check or return deposited through Check21.
|
|
280
|
+
*/
|
|
281
|
+
inbound_check_adjustment: Source.InboundCheckAdjustment | null;
|
|
282
|
+
/**
|
|
283
|
+
* An Inbound Check Deposit Return Intention object. This field will be present in
|
|
284
|
+
* the JSON response if and only if `category` is equal to
|
|
285
|
+
* `inbound_check_deposit_return_intention`. An Inbound Check Deposit Return
|
|
286
|
+
* Intention is created when Increase receives an Inbound Check and the User
|
|
287
|
+
* requests that it be returned.
|
|
288
|
+
*/
|
|
289
|
+
inbound_check_deposit_return_intention: Source.InboundCheckDepositReturnIntention | null;
|
|
234
290
|
/**
|
|
235
291
|
* An Inbound Real-Time Payments Transfer Confirmation object. This field will be
|
|
236
292
|
* present in the JSON response if and only if `category` is equal to
|
|
237
|
-
* `inbound_real_time_payments_transfer_confirmation`.
|
|
293
|
+
* `inbound_real_time_payments_transfer_confirmation`. An Inbound Real-Time
|
|
294
|
+
* Payments Transfer Confirmation is created when a Real-Time Payments transfer is
|
|
295
|
+
* initiated at another bank and received by Increase.
|
|
238
296
|
*/
|
|
239
297
|
inbound_real_time_payments_transfer_confirmation: Source.InboundRealTimePaymentsTransferConfirmation | null;
|
|
240
298
|
/**
|
|
@@ -245,22 +303,38 @@ export declare namespace Transaction {
|
|
|
245
303
|
inbound_real_time_payments_transfer_decline: Source.InboundRealTimePaymentsTransferDecline | null;
|
|
246
304
|
/**
|
|
247
305
|
* An Inbound Wire Reversal object. This field will be present in the JSON response
|
|
248
|
-
* if and only if `category` is equal to `inbound_wire_reversal`.
|
|
306
|
+
* if and only if `category` is equal to `inbound_wire_reversal`. An Inbound Wire
|
|
307
|
+
* Reversal represents a reversal of a wire transfer that was initiated via
|
|
308
|
+
* Increase. The other bank is sending the money back. This most often happens when
|
|
309
|
+
* the original destination account details were incorrect.
|
|
249
310
|
*/
|
|
250
311
|
inbound_wire_reversal: Source.InboundWireReversal | null;
|
|
251
312
|
/**
|
|
252
313
|
* An Inbound Wire Transfer Intention object. This field will be present in the
|
|
253
|
-
* JSON response if and only if `category` is equal to `inbound_wire_transfer`.
|
|
314
|
+
* JSON response if and only if `category` is equal to `inbound_wire_transfer`. An
|
|
315
|
+
* Inbound Wire Transfer Intention is created when a wire transfer is initiated at
|
|
316
|
+
* another bank and received by Increase.
|
|
254
317
|
*/
|
|
255
318
|
inbound_wire_transfer: Source.InboundWireTransfer | null;
|
|
319
|
+
/**
|
|
320
|
+
* An Inbound Wire Transfer Reversal Intention object. This field will be present
|
|
321
|
+
* in the JSON response if and only if `category` is equal to
|
|
322
|
+
* `inbound_wire_transfer_reversal`. An Inbound Wire Transfer Reversal Intention is
|
|
323
|
+
* created when Increase has received a wire and the User requests that it be
|
|
324
|
+
* reversed.
|
|
325
|
+
*/
|
|
326
|
+
inbound_wire_transfer_reversal: Source.InboundWireTransferReversal | null;
|
|
256
327
|
/**
|
|
257
328
|
* An Interest Payment object. This field will be present in the JSON response if
|
|
258
|
-
* and only if `category` is equal to `interest_payment`.
|
|
329
|
+
* and only if `category` is equal to `interest_payment`. An Interest Payment
|
|
330
|
+
* represents a payment of interest on an account. Interest is usually paid
|
|
331
|
+
* monthly.
|
|
259
332
|
*/
|
|
260
333
|
interest_payment: Source.InterestPayment | null;
|
|
261
334
|
/**
|
|
262
335
|
* An Internal Source object. This field will be present in the JSON response if
|
|
263
|
-
* and only if `category` is equal to `internal_source`.
|
|
336
|
+
* and only if `category` is equal to `internal_source`. A transaction between the
|
|
337
|
+
* user and Increase. See the `reason` attribute for more information.
|
|
264
338
|
*/
|
|
265
339
|
internal_source: Source.InternalSource | null;
|
|
266
340
|
/**
|
|
@@ -271,24 +345,30 @@ export declare namespace Transaction {
|
|
|
271
345
|
/**
|
|
272
346
|
* A Real-Time Payments Transfer Acknowledgement object. This field will be present
|
|
273
347
|
* in the JSON response if and only if `category` is equal to
|
|
274
|
-
* `real_time_payments_transfer_acknowledgement`.
|
|
348
|
+
* `real_time_payments_transfer_acknowledgement`. A Real-Time Payments Transfer
|
|
349
|
+
* Acknowledgement is created when a Real-Time Payments Transfer sent from Increase
|
|
350
|
+
* is acknowledged by the receiving bank.
|
|
275
351
|
*/
|
|
276
352
|
real_time_payments_transfer_acknowledgement: Source.RealTimePaymentsTransferAcknowledgement | null;
|
|
277
353
|
/**
|
|
278
354
|
* A Sample Funds object. This field will be present in the JSON response if and
|
|
279
|
-
* only if `category` is equal to `sample_funds`.
|
|
355
|
+
* only if `category` is equal to `sample_funds`. Sample funds for testing
|
|
356
|
+
* purposes.
|
|
280
357
|
*/
|
|
281
358
|
sample_funds: Source.SampleFunds | null;
|
|
282
359
|
/**
|
|
283
360
|
* A Wire Transfer Intention object. This field will be present in the JSON
|
|
284
|
-
* response if and only if `category` is equal to `wire_transfer_intention`.
|
|
361
|
+
* response if and only if `category` is equal to `wire_transfer_intention`. A Wire
|
|
362
|
+
* Transfer initiated via Increase and sent to a different bank.
|
|
285
363
|
*/
|
|
286
364
|
wire_transfer_intention: Source.WireTransferIntention | null;
|
|
287
365
|
}
|
|
288
366
|
namespace Source {
|
|
289
367
|
/**
|
|
290
368
|
* An Account Transfer Intention object. This field will be present in the JSON
|
|
291
|
-
* response if and only if `category` is equal to `account_transfer_intention`.
|
|
369
|
+
* response if and only if `category` is equal to `account_transfer_intention`. Two
|
|
370
|
+
* Account Transfer Intentions are created from each Account Transfer. One
|
|
371
|
+
* decrements the source account, and the other increments the destination account.
|
|
292
372
|
*/
|
|
293
373
|
interface AccountTransferIntention {
|
|
294
374
|
/**
|
|
@@ -327,7 +407,9 @@ export declare namespace Transaction {
|
|
|
327
407
|
}
|
|
328
408
|
/**
|
|
329
409
|
* An ACH Transfer Intention object. This field will be present in the JSON
|
|
330
|
-
* response if and only if `category` is equal to `ach_transfer_intention`.
|
|
410
|
+
* response if and only if `category` is equal to `ach_transfer_intention`. An ACH
|
|
411
|
+
* Transfer Intention is created from an ACH Transfer. It reflects the intention to
|
|
412
|
+
* move money into or out of an Increase account via the ACH network.
|
|
331
413
|
*/
|
|
332
414
|
interface ACHTransferIntention {
|
|
333
415
|
/**
|
|
@@ -355,7 +437,9 @@ export declare namespace Transaction {
|
|
|
355
437
|
}
|
|
356
438
|
/**
|
|
357
439
|
* An ACH Transfer Rejection object. This field will be present in the JSON
|
|
358
|
-
* response if and only if `category` is equal to `ach_transfer_rejection`.
|
|
440
|
+
* response if and only if `category` is equal to `ach_transfer_rejection`. An ACH
|
|
441
|
+
* Transfer Rejection is created when an ACH Transfer is rejected by Increase. It
|
|
442
|
+
* offsets the ACH Transfer Intention. These rejections are rare.
|
|
359
443
|
*/
|
|
360
444
|
interface ACHTransferRejection {
|
|
361
445
|
/**
|
|
@@ -365,7 +449,11 @@ export declare namespace Transaction {
|
|
|
365
449
|
}
|
|
366
450
|
/**
|
|
367
451
|
* An ACH Transfer Return object. This field will be present in the JSON response
|
|
368
|
-
* if and only if `category` is equal to `ach_transfer_return`.
|
|
452
|
+
* if and only if `category` is equal to `ach_transfer_return`. An ACH Transfer
|
|
453
|
+
* Return is created when an ACH Transfer is returned by the receiving bank. It
|
|
454
|
+
* offsets the ACH Transfer Intention. ACH Transfer Returns usually occur within
|
|
455
|
+
* the first two business days after the transfer is initiated, but can occur much
|
|
456
|
+
* later.
|
|
369
457
|
*/
|
|
370
458
|
interface ACHTransferReturn {
|
|
371
459
|
/**
|
|
@@ -549,6 +637,7 @@ export declare namespace Transaction {
|
|
|
549
637
|
/**
|
|
550
638
|
* A Card Dispute Acceptance object. This field will be present in the JSON
|
|
551
639
|
* response if and only if `category` is equal to `card_dispute_acceptance`.
|
|
640
|
+
* Contains the details of a successful Card Dispute.
|
|
552
641
|
*/
|
|
553
642
|
interface CardDisputeAcceptance {
|
|
554
643
|
/**
|
|
@@ -568,7 +657,8 @@ export declare namespace Transaction {
|
|
|
568
657
|
}
|
|
569
658
|
/**
|
|
570
659
|
* A Card Dispute Loss object. This field will be present in the JSON response if
|
|
571
|
-
* and only if `category` is equal to `card_dispute_loss`.
|
|
660
|
+
* and only if `category` is equal to `card_dispute_loss`. Contains the details of
|
|
661
|
+
* a lost Card Dispute.
|
|
572
662
|
*/
|
|
573
663
|
interface CardDisputeLoss {
|
|
574
664
|
/**
|
|
@@ -592,7 +682,10 @@ export declare namespace Transaction {
|
|
|
592
682
|
}
|
|
593
683
|
/**
|
|
594
684
|
* A Card Refund object. This field will be present in the JSON response if and
|
|
595
|
-
* only if `category` is equal to `card_refund`.
|
|
685
|
+
* only if `category` is equal to `card_refund`. Card Refunds move money back to
|
|
686
|
+
* the cardholder. While they are usually connected to a Card Settlement an
|
|
687
|
+
* acquirer can also refund money directly to a card without relation to a
|
|
688
|
+
* transaction.
|
|
596
689
|
*/
|
|
597
690
|
interface CardRefund {
|
|
598
691
|
/**
|
|
@@ -1161,7 +1254,8 @@ export declare namespace Transaction {
|
|
|
1161
1254
|
}
|
|
1162
1255
|
/**
|
|
1163
1256
|
* A Card Revenue Payment object. This field will be present in the JSON response
|
|
1164
|
-
* if and only if `category` is equal to `card_revenue_payment`.
|
|
1257
|
+
* if and only if `category` is equal to `card_revenue_payment`. Card Revenue
|
|
1258
|
+
* Payments reflect earnings from fees on card transactions.
|
|
1165
1259
|
*/
|
|
1166
1260
|
interface CardRevenuePayment {
|
|
1167
1261
|
/**
|
|
@@ -1196,7 +1290,10 @@ export declare namespace Transaction {
|
|
|
1196
1290
|
}
|
|
1197
1291
|
/**
|
|
1198
1292
|
* A Card Settlement object. This field will be present in the JSON response if and
|
|
1199
|
-
* only if `category` is equal to `card_settlement`.
|
|
1293
|
+
* only if `category` is equal to `card_settlement`. Card Settlements are card
|
|
1294
|
+
* transactions that have cleared and settled. While a settlement is usually
|
|
1295
|
+
* preceded by an authorization, an acquirer can also directly clear a transaction
|
|
1296
|
+
* without first authorizing it.
|
|
1200
1297
|
*/
|
|
1201
1298
|
interface CardSettlement {
|
|
1202
1299
|
/**
|
|
@@ -1774,7 +1871,9 @@ export declare namespace Transaction {
|
|
|
1774
1871
|
}
|
|
1775
1872
|
/**
|
|
1776
1873
|
* A Cashback Payment object. This field will be present in the JSON response if
|
|
1777
|
-
* and only if `category` is equal to `cashback_payment`.
|
|
1874
|
+
* and only if `category` is equal to `cashback_payment`. A Cashback Payment
|
|
1875
|
+
* represents the cashback paid to a cardholder for a given period. Cashback is
|
|
1876
|
+
* usually paid monthly for the prior month's transactions.
|
|
1778
1877
|
*/
|
|
1779
1878
|
interface CashbackPayment {
|
|
1780
1879
|
/**
|
|
@@ -1809,7 +1908,10 @@ export declare namespace Transaction {
|
|
|
1809
1908
|
}
|
|
1810
1909
|
/**
|
|
1811
1910
|
* A Check Deposit Acceptance object. This field will be present in the JSON
|
|
1812
|
-
* response if and only if `category` is equal to `check_deposit_acceptance`.
|
|
1911
|
+
* response if and only if `category` is equal to `check_deposit_acceptance`. A
|
|
1912
|
+
* Check Deposit Acceptance is created when a Check Deposit is processed and its
|
|
1913
|
+
* details confirmed. Check Deposits may be returned by the receiving bank, which
|
|
1914
|
+
* will appear as a Check Deposit Return.
|
|
1813
1915
|
*/
|
|
1814
1916
|
interface CheckDepositAcceptance {
|
|
1815
1917
|
/**
|
|
@@ -1854,7 +1956,11 @@ export declare namespace Transaction {
|
|
|
1854
1956
|
}
|
|
1855
1957
|
/**
|
|
1856
1958
|
* A Check Deposit Return object. This field will be present in the JSON response
|
|
1857
|
-
* if and only if `category` is equal to `check_deposit_return`.
|
|
1959
|
+
* if and only if `category` is equal to `check_deposit_return`. A Check Deposit
|
|
1960
|
+
* Return is created when a Check Deposit is returned by the bank holding the
|
|
1961
|
+
* account it was drawn against. Check Deposits may be returned for a variety of
|
|
1962
|
+
* reasons, including insufficient funds or a mismatched account number. Usually,
|
|
1963
|
+
* checks are returned within the first 7 days after the deposit is made.
|
|
1858
1964
|
*/
|
|
1859
1965
|
interface CheckDepositReturn {
|
|
1860
1966
|
/**
|
|
@@ -1925,7 +2031,9 @@ export declare namespace Transaction {
|
|
|
1925
2031
|
}
|
|
1926
2032
|
/**
|
|
1927
2033
|
* A Check Transfer Deposit object. This field will be present in the JSON response
|
|
1928
|
-
* if and only if `category` is equal to `check_transfer_deposit`.
|
|
2034
|
+
* if and only if `category` is equal to `check_transfer_deposit`. An Inbound Check
|
|
2035
|
+
* is a check drawn on an Increase account that has been deposited by an external
|
|
2036
|
+
* bank account. These types of checks are not pre-registered.
|
|
1929
2037
|
*/
|
|
1930
2038
|
interface CheckTransferDeposit {
|
|
1931
2039
|
/**
|
|
@@ -1969,7 +2077,8 @@ export declare namespace Transaction {
|
|
|
1969
2077
|
}
|
|
1970
2078
|
/**
|
|
1971
2079
|
* A Fee Payment object. This field will be present in the JSON response if and
|
|
1972
|
-
* only if `category` is equal to `fee_payment`.
|
|
2080
|
+
* only if `category` is equal to `fee_payment`. A Fee Payment represents a payment
|
|
2081
|
+
* made to Increase.
|
|
1973
2082
|
*/
|
|
1974
2083
|
interface FeePayment {
|
|
1975
2084
|
/**
|
|
@@ -2000,7 +2109,9 @@ export declare namespace Transaction {
|
|
|
2000
2109
|
}
|
|
2001
2110
|
/**
|
|
2002
2111
|
* An Inbound ACH Transfer Intention object. This field will be present in the JSON
|
|
2003
|
-
* response if and only if `category` is equal to `inbound_ach_transfer`.
|
|
2112
|
+
* response if and only if `category` is equal to `inbound_ach_transfer`. An
|
|
2113
|
+
* Inbound ACH Transfer Intention is created when an ACH transfer is initiated at
|
|
2114
|
+
* another bank and received by Increase.
|
|
2004
2115
|
*/
|
|
2005
2116
|
interface InboundACHTransfer {
|
|
2006
2117
|
/**
|
|
@@ -2090,10 +2201,69 @@ export declare namespace Transaction {
|
|
|
2090
2201
|
}
|
|
2091
2202
|
}
|
|
2092
2203
|
}
|
|
2204
|
+
/**
|
|
2205
|
+
* An Inbound ACH Transfer Return Intention object. This field will be present in
|
|
2206
|
+
* the JSON response if and only if `category` is equal to
|
|
2207
|
+
* `inbound_ach_transfer_return_intention`. An Inbound ACH Transfer Return
|
|
2208
|
+
* Intention is created when an ACH transfer is initiated at another bank and
|
|
2209
|
+
* returned by Increase.
|
|
2210
|
+
*/
|
|
2211
|
+
interface InboundACHTransferReturnIntention {
|
|
2212
|
+
/**
|
|
2213
|
+
* The ID of the Inbound ACH Transfer that is being returned.
|
|
2214
|
+
*/
|
|
2215
|
+
inbound_ach_transfer_id: string;
|
|
2216
|
+
}
|
|
2217
|
+
/**
|
|
2218
|
+
* An Inbound Check Adjustment object. This field will be present in the JSON
|
|
2219
|
+
* response if and only if `category` is equal to `inbound_check_adjustment`. An
|
|
2220
|
+
* Inbound Check Adjustment is created when Increase receives an adjustment for a
|
|
2221
|
+
* check or return deposited through Check21.
|
|
2222
|
+
*/
|
|
2223
|
+
interface InboundCheckAdjustment {
|
|
2224
|
+
/**
|
|
2225
|
+
* The ID of the transaction that was adjusted.
|
|
2226
|
+
*/
|
|
2227
|
+
adjusted_transaction_id: string;
|
|
2228
|
+
/**
|
|
2229
|
+
* The amount of the check adjustment.
|
|
2230
|
+
*/
|
|
2231
|
+
amount: number;
|
|
2232
|
+
/**
|
|
2233
|
+
* The reason for the adjustment.
|
|
2234
|
+
*
|
|
2235
|
+
* - `late_return` - The return was initiated too late and the receiving
|
|
2236
|
+
* institution has responded with a Late Return Claim.
|
|
2237
|
+
* - `wrong_payee_credit` - The check was deposited to the wrong payee and the
|
|
2238
|
+
* depositing institution has reimbursed the funds with a Wrong Payee Credit.
|
|
2239
|
+
* - `adjusted_amount` - The check was deposited with a different amount than what
|
|
2240
|
+
* was written on the check.
|
|
2241
|
+
*/
|
|
2242
|
+
reason: 'late_return' | 'wrong_payee_credit' | 'adjusted_amount';
|
|
2243
|
+
}
|
|
2244
|
+
/**
|
|
2245
|
+
* An Inbound Check Deposit Return Intention object. This field will be present in
|
|
2246
|
+
* the JSON response if and only if `category` is equal to
|
|
2247
|
+
* `inbound_check_deposit_return_intention`. An Inbound Check Deposit Return
|
|
2248
|
+
* Intention is created when Increase receives an Inbound Check and the User
|
|
2249
|
+
* requests that it be returned.
|
|
2250
|
+
*/
|
|
2251
|
+
interface InboundCheckDepositReturnIntention {
|
|
2252
|
+
/**
|
|
2253
|
+
* The ID of the Inbound Check Deposit that is being returned.
|
|
2254
|
+
*/
|
|
2255
|
+
inbound_check_deposit_id: string;
|
|
2256
|
+
/**
|
|
2257
|
+
* The identifier of the Check Transfer object that was deposited.
|
|
2258
|
+
*/
|
|
2259
|
+
transfer_id: string | null;
|
|
2260
|
+
}
|
|
2093
2261
|
/**
|
|
2094
2262
|
* An Inbound Real-Time Payments Transfer Confirmation object. This field will be
|
|
2095
2263
|
* present in the JSON response if and only if `category` is equal to
|
|
2096
|
-
* `inbound_real_time_payments_transfer_confirmation`.
|
|
2264
|
+
* `inbound_real_time_payments_transfer_confirmation`. An Inbound Real-Time
|
|
2265
|
+
* Payments Transfer Confirmation is created when a Real-Time Payments transfer is
|
|
2266
|
+
* initiated at another bank and received by Increase.
|
|
2097
2267
|
*/
|
|
2098
2268
|
interface InboundRealTimePaymentsTransferConfirmation {
|
|
2099
2269
|
/**
|
|
@@ -2209,7 +2379,10 @@ export declare namespace Transaction {
|
|
|
2209
2379
|
}
|
|
2210
2380
|
/**
|
|
2211
2381
|
* An Inbound Wire Reversal object. This field will be present in the JSON response
|
|
2212
|
-
* if and only if `category` is equal to `inbound_wire_reversal`.
|
|
2382
|
+
* if and only if `category` is equal to `inbound_wire_reversal`. An Inbound Wire
|
|
2383
|
+
* Reversal represents a reversal of a wire transfer that was initiated via
|
|
2384
|
+
* Increase. The other bank is sending the money back. This most often happens when
|
|
2385
|
+
* the original destination account details were incorrect.
|
|
2213
2386
|
*/
|
|
2214
2387
|
interface InboundWireReversal {
|
|
2215
2388
|
/**
|
|
@@ -2288,7 +2461,9 @@ export declare namespace Transaction {
|
|
|
2288
2461
|
}
|
|
2289
2462
|
/**
|
|
2290
2463
|
* An Inbound Wire Transfer Intention object. This field will be present in the
|
|
2291
|
-
* JSON response if and only if `category` is equal to `inbound_wire_transfer`.
|
|
2464
|
+
* JSON response if and only if `category` is equal to `inbound_wire_transfer`. An
|
|
2465
|
+
* Inbound Wire Transfer Intention is created when a wire transfer is initiated at
|
|
2466
|
+
* another bank and received by Increase.
|
|
2292
2467
|
*/
|
|
2293
2468
|
interface InboundWireTransfer {
|
|
2294
2469
|
/**
|
|
@@ -2371,9 +2546,24 @@ export declare namespace Transaction {
|
|
|
2371
2546
|
*/
|
|
2372
2547
|
transfer_id: string;
|
|
2373
2548
|
}
|
|
2549
|
+
/**
|
|
2550
|
+
* An Inbound Wire Transfer Reversal Intention object. This field will be present
|
|
2551
|
+
* in the JSON response if and only if `category` is equal to
|
|
2552
|
+
* `inbound_wire_transfer_reversal`. An Inbound Wire Transfer Reversal Intention is
|
|
2553
|
+
* created when Increase has received a wire and the User requests that it be
|
|
2554
|
+
* reversed.
|
|
2555
|
+
*/
|
|
2556
|
+
interface InboundWireTransferReversal {
|
|
2557
|
+
/**
|
|
2558
|
+
* The ID of the Inbound Wire Transfer that is being reversed.
|
|
2559
|
+
*/
|
|
2560
|
+
inbound_wire_transfer_id: string;
|
|
2561
|
+
}
|
|
2374
2562
|
/**
|
|
2375
2563
|
* An Interest Payment object. This field will be present in the JSON response if
|
|
2376
|
-
* and only if `category` is equal to `interest_payment`.
|
|
2564
|
+
* and only if `category` is equal to `interest_payment`. An Interest Payment
|
|
2565
|
+
* represents a payment of interest on an account. Interest is usually paid
|
|
2566
|
+
* monthly.
|
|
2377
2567
|
*/
|
|
2378
2568
|
interface InterestPayment {
|
|
2379
2569
|
/**
|
|
@@ -2408,7 +2598,8 @@ export declare namespace Transaction {
|
|
|
2408
2598
|
}
|
|
2409
2599
|
/**
|
|
2410
2600
|
* An Internal Source object. This field will be present in the JSON response if
|
|
2411
|
-
* and only if `category` is equal to `internal_source`.
|
|
2601
|
+
* and only if `category` is equal to `internal_source`. A transaction between the
|
|
2602
|
+
* user and Increase. See the `reason` attribute for more information.
|
|
2412
2603
|
*/
|
|
2413
2604
|
interface InternalSource {
|
|
2414
2605
|
/**
|
|
@@ -2453,7 +2644,9 @@ export declare namespace Transaction {
|
|
|
2453
2644
|
/**
|
|
2454
2645
|
* A Real-Time Payments Transfer Acknowledgement object. This field will be present
|
|
2455
2646
|
* in the JSON response if and only if `category` is equal to
|
|
2456
|
-
* `real_time_payments_transfer_acknowledgement`.
|
|
2647
|
+
* `real_time_payments_transfer_acknowledgement`. A Real-Time Payments Transfer
|
|
2648
|
+
* Acknowledgement is created when a Real-Time Payments Transfer sent from Increase
|
|
2649
|
+
* is acknowledged by the receiving bank.
|
|
2457
2650
|
*/
|
|
2458
2651
|
interface RealTimePaymentsTransferAcknowledgement {
|
|
2459
2652
|
/**
|
|
@@ -2479,7 +2672,8 @@ export declare namespace Transaction {
|
|
|
2479
2672
|
}
|
|
2480
2673
|
/**
|
|
2481
2674
|
* A Sample Funds object. This field will be present in the JSON response if and
|
|
2482
|
-
* only if `category` is equal to `sample_funds`.
|
|
2675
|
+
* only if `category` is equal to `sample_funds`. Sample funds for testing
|
|
2676
|
+
* purposes.
|
|
2483
2677
|
*/
|
|
2484
2678
|
interface SampleFunds {
|
|
2485
2679
|
/**
|
|
@@ -2489,7 +2683,8 @@ export declare namespace Transaction {
|
|
|
2489
2683
|
}
|
|
2490
2684
|
/**
|
|
2491
2685
|
* A Wire Transfer Intention object. This field will be present in the JSON
|
|
2492
|
-
* response if and only if `category` is equal to `wire_transfer_intention`.
|
|
2686
|
+
* response if and only if `category` is equal to `wire_transfer_intention`. A Wire
|
|
2687
|
+
* Transfer initiated via Increase and sent to a different bank.
|
|
2493
2688
|
*/
|
|
2494
2689
|
interface WireTransferIntention {
|
|
2495
2690
|
/**
|