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.
@@ -122,61 +122,82 @@ export namespace Transaction {
122
122
  export interface Source {
123
123
  /**
124
124
  * An Account Transfer Intention object. This field will be present in the JSON
125
- * response if and only if `category` is equal to `account_transfer_intention`.
125
+ * response if and only if `category` is equal to `account_transfer_intention`. Two
126
+ * Account Transfer Intentions are created from each Account Transfer. One
127
+ * decrements the source account, and the other increments the destination account.
126
128
  */
127
129
  account_transfer_intention: Source.AccountTransferIntention | null;
128
130
 
129
131
  /**
130
132
  * An ACH Transfer Intention object. This field will be present in the JSON
131
- * response if and only if `category` is equal to `ach_transfer_intention`.
133
+ * response if and only if `category` is equal to `ach_transfer_intention`. An ACH
134
+ * Transfer Intention is created from an ACH Transfer. It reflects the intention to
135
+ * move money into or out of an Increase account via the ACH network.
132
136
  */
133
137
  ach_transfer_intention: Source.ACHTransferIntention | null;
134
138
 
135
139
  /**
136
140
  * An ACH Transfer Rejection object. This field will be present in the JSON
137
- * response if and only if `category` is equal to `ach_transfer_rejection`.
141
+ * response if and only if `category` is equal to `ach_transfer_rejection`. An ACH
142
+ * Transfer Rejection is created when an ACH Transfer is rejected by Increase. It
143
+ * offsets the ACH Transfer Intention. These rejections are rare.
138
144
  */
139
145
  ach_transfer_rejection: Source.ACHTransferRejection | null;
140
146
 
141
147
  /**
142
148
  * An ACH Transfer Return object. This field will be present in the JSON response
143
- * if and only if `category` is equal to `ach_transfer_return`.
149
+ * if and only if `category` is equal to `ach_transfer_return`. An ACH Transfer
150
+ * Return is created when an ACH Transfer is returned by the receiving bank. It
151
+ * offsets the ACH Transfer Intention. ACH Transfer Returns usually occur within
152
+ * the first two business days after the transfer is initiated, but can occur much
153
+ * later.
144
154
  */
145
155
  ach_transfer_return: Source.ACHTransferReturn | null;
146
156
 
147
157
  /**
148
158
  * A Card Dispute Acceptance object. This field will be present in the JSON
149
159
  * response if and only if `category` is equal to `card_dispute_acceptance`.
160
+ * Contains the details of a successful Card Dispute.
150
161
  */
151
162
  card_dispute_acceptance: Source.CardDisputeAcceptance | null;
152
163
 
153
164
  /**
154
165
  * A Card Dispute Loss object. This field will be present in the JSON response if
155
- * and only if `category` is equal to `card_dispute_loss`.
166
+ * and only if `category` is equal to `card_dispute_loss`. Contains the details of
167
+ * a lost Card Dispute.
156
168
  */
157
169
  card_dispute_loss: Source.CardDisputeLoss | null;
158
170
 
159
171
  /**
160
172
  * A Card Refund object. This field will be present in the JSON response if and
161
- * only if `category` is equal to `card_refund`.
173
+ * only if `category` is equal to `card_refund`. Card Refunds move money back to
174
+ * the cardholder. While they are usually connected to a Card Settlement an
175
+ * acquirer can also refund money directly to a card without relation to a
176
+ * transaction.
162
177
  */
163
178
  card_refund: Source.CardRefund | null;
164
179
 
165
180
  /**
166
181
  * A Card Revenue Payment object. This field will be present in the JSON response
167
- * if and only if `category` is equal to `card_revenue_payment`.
182
+ * if and only if `category` is equal to `card_revenue_payment`. Card Revenue
183
+ * Payments reflect earnings from fees on card transactions.
168
184
  */
169
185
  card_revenue_payment: Source.CardRevenuePayment | null;
170
186
 
171
187
  /**
172
188
  * A Card Settlement object. This field will be present in the JSON response if and
173
- * only if `category` is equal to `card_settlement`.
189
+ * only if `category` is equal to `card_settlement`. Card Settlements are card
190
+ * transactions that have cleared and settled. While a settlement is usually
191
+ * preceded by an authorization, an acquirer can also directly clear a transaction
192
+ * without first authorizing it.
174
193
  */
175
194
  card_settlement: Source.CardSettlement | null;
176
195
 
177
196
  /**
178
197
  * A Cashback Payment object. This field will be present in the JSON response if
179
- * and only if `category` is equal to `cashback_payment`.
198
+ * and only if `category` is equal to `cashback_payment`. A Cashback Payment
199
+ * represents the cashback paid to a cardholder for a given period. Cashback is
200
+ * usually paid monthly for the prior month's transactions.
180
201
  */
181
202
  cashback_payment: Source.CashbackPayment | null;
182
203
 
@@ -278,38 +299,78 @@ export namespace Transaction {
278
299
 
279
300
  /**
280
301
  * A Check Deposit Acceptance object. This field will be present in the JSON
281
- * response if and only if `category` is equal to `check_deposit_acceptance`.
302
+ * response if and only if `category` is equal to `check_deposit_acceptance`. A
303
+ * Check Deposit Acceptance is created when a Check Deposit is processed and its
304
+ * details confirmed. Check Deposits may be returned by the receiving bank, which
305
+ * will appear as a Check Deposit Return.
282
306
  */
283
307
  check_deposit_acceptance: Source.CheckDepositAcceptance | null;
284
308
 
285
309
  /**
286
310
  * A Check Deposit Return object. This field will be present in the JSON response
287
- * if and only if `category` is equal to `check_deposit_return`.
311
+ * if and only if `category` is equal to `check_deposit_return`. A Check Deposit
312
+ * Return is created when a Check Deposit is returned by the bank holding the
313
+ * account it was drawn against. Check Deposits may be returned for a variety of
314
+ * reasons, including insufficient funds or a mismatched account number. Usually,
315
+ * checks are returned within the first 7 days after the deposit is made.
288
316
  */
289
317
  check_deposit_return: Source.CheckDepositReturn | null;
290
318
 
291
319
  /**
292
320
  * A Check Transfer Deposit object. This field will be present in the JSON response
293
- * if and only if `category` is equal to `check_transfer_deposit`.
321
+ * if and only if `category` is equal to `check_transfer_deposit`. An Inbound Check
322
+ * is a check drawn on an Increase account that has been deposited by an external
323
+ * bank account. These types of checks are not pre-registered.
294
324
  */
295
325
  check_transfer_deposit: Source.CheckTransferDeposit | null;
296
326
 
297
327
  /**
298
328
  * A Fee Payment object. This field will be present in the JSON response if and
299
- * only if `category` is equal to `fee_payment`.
329
+ * only if `category` is equal to `fee_payment`. A Fee Payment represents a payment
330
+ * made to Increase.
300
331
  */
301
332
  fee_payment: Source.FeePayment | null;
302
333
 
303
334
  /**
304
335
  * An Inbound ACH Transfer Intention object. This field will be present in the JSON
305
- * response if and only if `category` is equal to `inbound_ach_transfer`.
336
+ * response if and only if `category` is equal to `inbound_ach_transfer`. An
337
+ * Inbound ACH Transfer Intention is created when an ACH transfer is initiated at
338
+ * another bank and received by Increase.
306
339
  */
307
340
  inbound_ach_transfer: Source.InboundACHTransfer | null;
308
341
 
342
+ /**
343
+ * An Inbound ACH Transfer Return Intention object. This field will be present in
344
+ * the JSON response if and only if `category` is equal to
345
+ * `inbound_ach_transfer_return_intention`. An Inbound ACH Transfer Return
346
+ * Intention is created when an ACH transfer is initiated at another bank and
347
+ * returned by Increase.
348
+ */
349
+ inbound_ach_transfer_return_intention: Source.InboundACHTransferReturnIntention | null;
350
+
351
+ /**
352
+ * An Inbound Check Adjustment object. This field will be present in the JSON
353
+ * response if and only if `category` is equal to `inbound_check_adjustment`. An
354
+ * Inbound Check Adjustment is created when Increase receives an adjustment for a
355
+ * check or return deposited through Check21.
356
+ */
357
+ inbound_check_adjustment: Source.InboundCheckAdjustment | null;
358
+
359
+ /**
360
+ * An Inbound Check Deposit Return Intention object. This field will be present in
361
+ * the JSON response if and only if `category` is equal to
362
+ * `inbound_check_deposit_return_intention`. An Inbound Check Deposit Return
363
+ * Intention is created when Increase receives an Inbound Check and the User
364
+ * requests that it be returned.
365
+ */
366
+ inbound_check_deposit_return_intention: Source.InboundCheckDepositReturnIntention | null;
367
+
309
368
  /**
310
369
  * An Inbound Real-Time Payments Transfer Confirmation object. This field will be
311
370
  * present in the JSON response if and only if `category` is equal to
312
- * `inbound_real_time_payments_transfer_confirmation`.
371
+ * `inbound_real_time_payments_transfer_confirmation`. An Inbound Real-Time
372
+ * Payments Transfer Confirmation is created when a Real-Time Payments transfer is
373
+ * initiated at another bank and received by Increase.
313
374
  */
314
375
  inbound_real_time_payments_transfer_confirmation: Source.InboundRealTimePaymentsTransferConfirmation | null;
315
376
 
@@ -322,25 +383,42 @@ export namespace Transaction {
322
383
 
323
384
  /**
324
385
  * An Inbound Wire Reversal object. This field will be present in the JSON response
325
- * if and only if `category` is equal to `inbound_wire_reversal`.
386
+ * if and only if `category` is equal to `inbound_wire_reversal`. An Inbound Wire
387
+ * Reversal represents a reversal of a wire transfer that was initiated via
388
+ * Increase. The other bank is sending the money back. This most often happens when
389
+ * the original destination account details were incorrect.
326
390
  */
327
391
  inbound_wire_reversal: Source.InboundWireReversal | null;
328
392
 
329
393
  /**
330
394
  * An Inbound Wire Transfer Intention object. This field will be present in the
331
- * JSON response if and only if `category` is equal to `inbound_wire_transfer`.
395
+ * JSON response if and only if `category` is equal to `inbound_wire_transfer`. An
396
+ * Inbound Wire Transfer Intention is created when a wire transfer is initiated at
397
+ * another bank and received by Increase.
332
398
  */
333
399
  inbound_wire_transfer: Source.InboundWireTransfer | null;
334
400
 
401
+ /**
402
+ * An Inbound Wire Transfer Reversal Intention object. This field will be present
403
+ * in the JSON response if and only if `category` is equal to
404
+ * `inbound_wire_transfer_reversal`. An Inbound Wire Transfer Reversal Intention is
405
+ * created when Increase has received a wire and the User requests that it be
406
+ * reversed.
407
+ */
408
+ inbound_wire_transfer_reversal: Source.InboundWireTransferReversal | null;
409
+
335
410
  /**
336
411
  * An Interest Payment object. This field will be present in the JSON response if
337
- * and only if `category` is equal to `interest_payment`.
412
+ * and only if `category` is equal to `interest_payment`. An Interest Payment
413
+ * represents a payment of interest on an account. Interest is usually paid
414
+ * monthly.
338
415
  */
339
416
  interest_payment: Source.InterestPayment | null;
340
417
 
341
418
  /**
342
419
  * An Internal Source object. This field will be present in the JSON response if
343
- * and only if `category` is equal to `internal_source`.
420
+ * and only if `category` is equal to `internal_source`. A transaction between the
421
+ * user and Increase. See the `reason` attribute for more information.
344
422
  */
345
423
  internal_source: Source.InternalSource | null;
346
424
 
@@ -353,19 +431,23 @@ export namespace Transaction {
353
431
  /**
354
432
  * A Real-Time Payments Transfer Acknowledgement object. This field will be present
355
433
  * in the JSON response if and only if `category` is equal to
356
- * `real_time_payments_transfer_acknowledgement`.
434
+ * `real_time_payments_transfer_acknowledgement`. A Real-Time Payments Transfer
435
+ * Acknowledgement is created when a Real-Time Payments Transfer sent from Increase
436
+ * is acknowledged by the receiving bank.
357
437
  */
358
438
  real_time_payments_transfer_acknowledgement: Source.RealTimePaymentsTransferAcknowledgement | null;
359
439
 
360
440
  /**
361
441
  * A Sample Funds object. This field will be present in the JSON response if and
362
- * only if `category` is equal to `sample_funds`.
442
+ * only if `category` is equal to `sample_funds`. Sample funds for testing
443
+ * purposes.
363
444
  */
364
445
  sample_funds: Source.SampleFunds | null;
365
446
 
366
447
  /**
367
448
  * A Wire Transfer Intention object. This field will be present in the JSON
368
- * response if and only if `category` is equal to `wire_transfer_intention`.
449
+ * response if and only if `category` is equal to `wire_transfer_intention`. A Wire
450
+ * Transfer initiated via Increase and sent to a different bank.
369
451
  */
370
452
  wire_transfer_intention: Source.WireTransferIntention | null;
371
453
  }
@@ -373,7 +455,9 @@ export namespace Transaction {
373
455
  export namespace Source {
374
456
  /**
375
457
  * An Account Transfer Intention object. This field will be present in the JSON
376
- * response if and only if `category` is equal to `account_transfer_intention`.
458
+ * response if and only if `category` is equal to `account_transfer_intention`. Two
459
+ * Account Transfer Intentions are created from each Account Transfer. One
460
+ * decrements the source account, and the other increments the destination account.
377
461
  */
378
462
  export interface AccountTransferIntention {
379
463
  /**
@@ -418,7 +502,9 @@ export namespace Transaction {
418
502
 
419
503
  /**
420
504
  * An ACH Transfer Intention object. This field will be present in the JSON
421
- * response if and only if `category` is equal to `ach_transfer_intention`.
505
+ * response if and only if `category` is equal to `ach_transfer_intention`. An ACH
506
+ * Transfer Intention is created from an ACH Transfer. It reflects the intention to
507
+ * move money into or out of an Increase account via the ACH network.
422
508
  */
423
509
  export interface ACHTransferIntention {
424
510
  /**
@@ -451,7 +537,9 @@ export namespace Transaction {
451
537
 
452
538
  /**
453
539
  * An ACH Transfer Rejection object. This field will be present in the JSON
454
- * response if and only if `category` is equal to `ach_transfer_rejection`.
540
+ * response if and only if `category` is equal to `ach_transfer_rejection`. An ACH
541
+ * Transfer Rejection is created when an ACH Transfer is rejected by Increase. It
542
+ * offsets the ACH Transfer Intention. These rejections are rare.
455
543
  */
456
544
  export interface ACHTransferRejection {
457
545
  /**
@@ -462,7 +550,11 @@ export namespace Transaction {
462
550
 
463
551
  /**
464
552
  * An ACH Transfer Return object. This field will be present in the JSON response
465
- * if and only if `category` is equal to `ach_transfer_return`.
553
+ * if and only if `category` is equal to `ach_transfer_return`. An ACH Transfer
554
+ * Return is created when an ACH Transfer is returned by the receiving bank. It
555
+ * offsets the ACH Transfer Intention. ACH Transfer Returns usually occur within
556
+ * the first two business days after the transfer is initiated, but can occur much
557
+ * later.
466
558
  */
467
559
  export interface ACHTransferReturn {
468
560
  /**
@@ -722,6 +814,7 @@ export namespace Transaction {
722
814
  /**
723
815
  * A Card Dispute Acceptance object. This field will be present in the JSON
724
816
  * response if and only if `category` is equal to `card_dispute_acceptance`.
817
+ * Contains the details of a successful Card Dispute.
725
818
  */
726
819
  export interface CardDisputeAcceptance {
727
820
  /**
@@ -744,7 +837,8 @@ export namespace Transaction {
744
837
 
745
838
  /**
746
839
  * A Card Dispute Loss object. This field will be present in the JSON response if
747
- * and only if `category` is equal to `card_dispute_loss`.
840
+ * and only if `category` is equal to `card_dispute_loss`. Contains the details of
841
+ * a lost Card Dispute.
748
842
  */
749
843
  export interface CardDisputeLoss {
750
844
  /**
@@ -772,7 +866,10 @@ export namespace Transaction {
772
866
 
773
867
  /**
774
868
  * A Card Refund object. This field will be present in the JSON response if and
775
- * only if `category` is equal to `card_refund`.
869
+ * only if `category` is equal to `card_refund`. Card Refunds move money back to
870
+ * the cardholder. While they are usually connected to a Card Settlement an
871
+ * acquirer can also refund money directly to a card without relation to a
872
+ * transaction.
776
873
  */
777
874
  export interface CardRefund {
778
875
  /**
@@ -1493,7 +1590,8 @@ export namespace Transaction {
1493
1590
 
1494
1591
  /**
1495
1592
  * A Card Revenue Payment object. This field will be present in the JSON response
1496
- * if and only if `category` is equal to `card_revenue_payment`.
1593
+ * if and only if `category` is equal to `card_revenue_payment`. Card Revenue
1594
+ * Payments reflect earnings from fees on card transactions.
1497
1595
  */
1498
1596
  export interface CardRevenuePayment {
1499
1597
  /**
@@ -1533,7 +1631,10 @@ export namespace Transaction {
1533
1631
 
1534
1632
  /**
1535
1633
  * A Card Settlement object. This field will be present in the JSON response if and
1536
- * only if `category` is equal to `card_settlement`.
1634
+ * only if `category` is equal to `card_settlement`. Card Settlements are card
1635
+ * transactions that have cleared and settled. While a settlement is usually
1636
+ * preceded by an authorization, an acquirer can also directly clear a transaction
1637
+ * without first authorizing it.
1537
1638
  */
1538
1639
  export interface CardSettlement {
1539
1640
  /**
@@ -2265,7 +2366,9 @@ export namespace Transaction {
2265
2366
 
2266
2367
  /**
2267
2368
  * A Cashback Payment object. This field will be present in the JSON response if
2268
- * and only if `category` is equal to `cashback_payment`.
2369
+ * and only if `category` is equal to `cashback_payment`. A Cashback Payment
2370
+ * represents the cashback paid to a cardholder for a given period. Cashback is
2371
+ * usually paid monthly for the prior month's transactions.
2269
2372
  */
2270
2373
  export interface CashbackPayment {
2271
2374
  /**
@@ -2305,7 +2408,10 @@ export namespace Transaction {
2305
2408
 
2306
2409
  /**
2307
2410
  * A Check Deposit Acceptance object. This field will be present in the JSON
2308
- * response if and only if `category` is equal to `check_deposit_acceptance`.
2411
+ * response if and only if `category` is equal to `check_deposit_acceptance`. A
2412
+ * Check Deposit Acceptance is created when a Check Deposit is processed and its
2413
+ * details confirmed. Check Deposits may be returned by the receiving bank, which
2414
+ * will appear as a Check Deposit Return.
2309
2415
  */
2310
2416
  export interface CheckDepositAcceptance {
2311
2417
  /**
@@ -2357,7 +2463,11 @@ export namespace Transaction {
2357
2463
 
2358
2464
  /**
2359
2465
  * A Check Deposit Return object. This field will be present in the JSON response
2360
- * if and only if `category` is equal to `check_deposit_return`.
2466
+ * if and only if `category` is equal to `check_deposit_return`. A Check Deposit
2467
+ * Return is created when a Check Deposit is returned by the bank holding the
2468
+ * account it was drawn against. Check Deposits may be returned for a variety of
2469
+ * reasons, including insufficient funds or a mismatched account number. Usually,
2470
+ * checks are returned within the first 7 days after the deposit is made.
2361
2471
  */
2362
2472
  export interface CheckDepositReturn {
2363
2473
  /**
@@ -2460,7 +2570,9 @@ export namespace Transaction {
2460
2570
 
2461
2571
  /**
2462
2572
  * A Check Transfer Deposit object. This field will be present in the JSON response
2463
- * if and only if `category` is equal to `check_transfer_deposit`.
2573
+ * if and only if `category` is equal to `check_transfer_deposit`. An Inbound Check
2574
+ * is a check drawn on an Increase account that has been deposited by an external
2575
+ * bank account. These types of checks are not pre-registered.
2464
2576
  */
2465
2577
  export interface CheckTransferDeposit {
2466
2578
  /**
@@ -2512,7 +2624,8 @@ export namespace Transaction {
2512
2624
 
2513
2625
  /**
2514
2626
  * A Fee Payment object. This field will be present in the JSON response if and
2515
- * only if `category` is equal to `fee_payment`.
2627
+ * only if `category` is equal to `fee_payment`. A Fee Payment represents a payment
2628
+ * made to Increase.
2516
2629
  */
2517
2630
  export interface FeePayment {
2518
2631
  /**
@@ -2547,7 +2660,9 @@ export namespace Transaction {
2547
2660
 
2548
2661
  /**
2549
2662
  * An Inbound ACH Transfer Intention object. This field will be present in the JSON
2550
- * response if and only if `category` is equal to `inbound_ach_transfer`.
2663
+ * response if and only if `category` is equal to `inbound_ach_transfer`. An
2664
+ * Inbound ACH Transfer Intention is created when an ACH transfer is initiated at
2665
+ * another bank and received by Increase.
2551
2666
  */
2552
2667
  export interface InboundACHTransfer {
2553
2668
  /**
@@ -2652,10 +2767,75 @@ export namespace Transaction {
2652
2767
  }
2653
2768
  }
2654
2769
 
2770
+ /**
2771
+ * An Inbound ACH Transfer Return Intention object. This field will be present in
2772
+ * the JSON response if and only if `category` is equal to
2773
+ * `inbound_ach_transfer_return_intention`. An Inbound ACH Transfer Return
2774
+ * Intention is created when an ACH transfer is initiated at another bank and
2775
+ * returned by Increase.
2776
+ */
2777
+ export interface InboundACHTransferReturnIntention {
2778
+ /**
2779
+ * The ID of the Inbound ACH Transfer that is being returned.
2780
+ */
2781
+ inbound_ach_transfer_id: string;
2782
+ }
2783
+
2784
+ /**
2785
+ * An Inbound Check Adjustment object. This field will be present in the JSON
2786
+ * response if and only if `category` is equal to `inbound_check_adjustment`. An
2787
+ * Inbound Check Adjustment is created when Increase receives an adjustment for a
2788
+ * check or return deposited through Check21.
2789
+ */
2790
+ export interface InboundCheckAdjustment {
2791
+ /**
2792
+ * The ID of the transaction that was adjusted.
2793
+ */
2794
+ adjusted_transaction_id: string;
2795
+
2796
+ /**
2797
+ * The amount of the check adjustment.
2798
+ */
2799
+ amount: number;
2800
+
2801
+ /**
2802
+ * The reason for the adjustment.
2803
+ *
2804
+ * - `late_return` - The return was initiated too late and the receiving
2805
+ * institution has responded with a Late Return Claim.
2806
+ * - `wrong_payee_credit` - The check was deposited to the wrong payee and the
2807
+ * depositing institution has reimbursed the funds with a Wrong Payee Credit.
2808
+ * - `adjusted_amount` - The check was deposited with a different amount than what
2809
+ * was written on the check.
2810
+ */
2811
+ reason: 'late_return' | 'wrong_payee_credit' | 'adjusted_amount';
2812
+ }
2813
+
2814
+ /**
2815
+ * An Inbound Check Deposit Return Intention object. This field will be present in
2816
+ * the JSON response if and only if `category` is equal to
2817
+ * `inbound_check_deposit_return_intention`. An Inbound Check Deposit Return
2818
+ * Intention is created when Increase receives an Inbound Check and the User
2819
+ * requests that it be returned.
2820
+ */
2821
+ export interface InboundCheckDepositReturnIntention {
2822
+ /**
2823
+ * The ID of the Inbound Check Deposit that is being returned.
2824
+ */
2825
+ inbound_check_deposit_id: string;
2826
+
2827
+ /**
2828
+ * The identifier of the Check Transfer object that was deposited.
2829
+ */
2830
+ transfer_id: string | null;
2831
+ }
2832
+
2655
2833
  /**
2656
2834
  * An Inbound Real-Time Payments Transfer Confirmation object. This field will be
2657
2835
  * present in the JSON response if and only if `category` is equal to
2658
- * `inbound_real_time_payments_transfer_confirmation`.
2836
+ * `inbound_real_time_payments_transfer_confirmation`. An Inbound Real-Time
2837
+ * Payments Transfer Confirmation is created when a Real-Time Payments transfer is
2838
+ * initiated at another bank and received by Increase.
2659
2839
  */
2660
2840
  export interface InboundRealTimePaymentsTransferConfirmation {
2661
2841
  /**
@@ -2796,7 +2976,10 @@ export namespace Transaction {
2796
2976
 
2797
2977
  /**
2798
2978
  * An Inbound Wire Reversal object. This field will be present in the JSON response
2799
- * if and only if `category` is equal to `inbound_wire_reversal`.
2979
+ * if and only if `category` is equal to `inbound_wire_reversal`. An Inbound Wire
2980
+ * Reversal represents a reversal of a wire transfer that was initiated via
2981
+ * Increase. The other bank is sending the money back. This most often happens when
2982
+ * the original destination account details were incorrect.
2800
2983
  */
2801
2984
  export interface InboundWireReversal {
2802
2985
  /**
@@ -2892,7 +3075,9 @@ export namespace Transaction {
2892
3075
 
2893
3076
  /**
2894
3077
  * An Inbound Wire Transfer Intention object. This field will be present in the
2895
- * JSON response if and only if `category` is equal to `inbound_wire_transfer`.
3078
+ * JSON response if and only if `category` is equal to `inbound_wire_transfer`. An
3079
+ * Inbound Wire Transfer Intention is created when a wire transfer is initiated at
3080
+ * another bank and received by Increase.
2896
3081
  */
2897
3082
  export interface InboundWireTransfer {
2898
3083
  /**
@@ -2994,9 +3179,25 @@ export namespace Transaction {
2994
3179
  transfer_id: string;
2995
3180
  }
2996
3181
 
3182
+ /**
3183
+ * An Inbound Wire Transfer Reversal Intention object. This field will be present
3184
+ * in the JSON response if and only if `category` is equal to
3185
+ * `inbound_wire_transfer_reversal`. An Inbound Wire Transfer Reversal Intention is
3186
+ * created when Increase has received a wire and the User requests that it be
3187
+ * reversed.
3188
+ */
3189
+ export interface InboundWireTransferReversal {
3190
+ /**
3191
+ * The ID of the Inbound Wire Transfer that is being reversed.
3192
+ */
3193
+ inbound_wire_transfer_id: string;
3194
+ }
3195
+
2997
3196
  /**
2998
3197
  * An Interest Payment object. This field will be present in the JSON response if
2999
- * and only if `category` is equal to `interest_payment`.
3198
+ * and only if `category` is equal to `interest_payment`. An Interest Payment
3199
+ * represents a payment of interest on an account. Interest is usually paid
3200
+ * monthly.
3000
3201
  */
3001
3202
  export interface InterestPayment {
3002
3203
  /**
@@ -3036,7 +3237,8 @@ export namespace Transaction {
3036
3237
 
3037
3238
  /**
3038
3239
  * An Internal Source object. This field will be present in the JSON response if
3039
- * and only if `category` is equal to `internal_source`.
3240
+ * and only if `category` is equal to `internal_source`. A transaction between the
3241
+ * user and Increase. See the `reason` attribute for more information.
3040
3242
  */
3041
3243
  export interface InternalSource {
3042
3244
  /**
@@ -3099,7 +3301,9 @@ export namespace Transaction {
3099
3301
  /**
3100
3302
  * A Real-Time Payments Transfer Acknowledgement object. This field will be present
3101
3303
  * in the JSON response if and only if `category` is equal to
3102
- * `real_time_payments_transfer_acknowledgement`.
3304
+ * `real_time_payments_transfer_acknowledgement`. A Real-Time Payments Transfer
3305
+ * Acknowledgement is created when a Real-Time Payments Transfer sent from Increase
3306
+ * is acknowledged by the receiving bank.
3103
3307
  */
3104
3308
  export interface RealTimePaymentsTransferAcknowledgement {
3105
3309
  /**
@@ -3130,7 +3334,8 @@ export namespace Transaction {
3130
3334
 
3131
3335
  /**
3132
3336
  * A Sample Funds object. This field will be present in the JSON response if and
3133
- * only if `category` is equal to `sample_funds`.
3337
+ * only if `category` is equal to `sample_funds`. Sample funds for testing
3338
+ * purposes.
3134
3339
  */
3135
3340
  export interface SampleFunds {
3136
3341
  /**
@@ -3141,7 +3346,8 @@ export namespace Transaction {
3141
3346
 
3142
3347
  /**
3143
3348
  * A Wire Transfer Intention object. This field will be present in the JSON
3144
- * response if and only if `category` is equal to `wire_transfer_intention`.
3349
+ * response if and only if `category` is equal to `wire_transfer_intention`. A Wire
3350
+ * Transfer initiated via Increase and sent to a different bank.
3145
3351
  */
3146
3352
  export interface WireTransferIntention {
3147
3353
  /**
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.165.0'; // x-release-please-version
1
+ export const VERSION = '0.167.0'; // x-release-please-version
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.165.0";
1
+ export declare const VERSION = "0.167.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '0.165.0'; // x-release-please-version
4
+ exports.VERSION = '0.167.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.165.0'; // x-release-please-version
1
+ export const VERSION = '0.167.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map