increase 0.418.0 → 0.430.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.
Files changed (126) hide show
  1. package/CHANGELOG.md +114 -0
  2. package/client.d.mts +3 -2
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +3 -2
  5. package/client.d.ts.map +1 -1
  6. package/client.js +9 -2
  7. package/client.js.map +1 -1
  8. package/client.mjs +9 -2
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/account-transfers.d.mts +6 -6
  12. package/resources/account-transfers.d.mts.map +1 -1
  13. package/resources/account-transfers.d.ts +6 -6
  14. package/resources/account-transfers.d.ts.map +1 -1
  15. package/resources/ach-prenotifications.d.mts +45 -24
  16. package/resources/ach-prenotifications.d.mts.map +1 -1
  17. package/resources/ach-prenotifications.d.ts +45 -24
  18. package/resources/ach-prenotifications.d.ts.map +1 -1
  19. package/resources/ach-transfers.d.mts +56 -34
  20. package/resources/ach-transfers.d.mts.map +1 -1
  21. package/resources/ach-transfers.d.ts +56 -34
  22. package/resources/ach-transfers.d.ts.map +1 -1
  23. package/resources/card-disputes.d.mts +37 -37
  24. package/resources/card-disputes.d.mts.map +1 -1
  25. package/resources/card-disputes.d.ts +37 -37
  26. package/resources/card-disputes.d.ts.map +1 -1
  27. package/resources/card-payments.d.mts +48 -48
  28. package/resources/card-payments.d.mts.map +1 -1
  29. package/resources/card-payments.d.ts +48 -48
  30. package/resources/card-payments.d.ts.map +1 -1
  31. package/resources/card-push-transfers.d.mts +6 -6
  32. package/resources/card-push-transfers.d.mts.map +1 -1
  33. package/resources/card-push-transfers.d.ts +6 -6
  34. package/resources/card-push-transfers.d.ts.map +1 -1
  35. package/resources/card-validations.d.mts +6 -6
  36. package/resources/card-validations.d.mts.map +1 -1
  37. package/resources/card-validations.d.ts +6 -6
  38. package/resources/card-validations.d.ts.map +1 -1
  39. package/resources/check-transfers.d.mts +6 -6
  40. package/resources/check-transfers.d.mts.map +1 -1
  41. package/resources/check-transfers.d.ts +6 -6
  42. package/resources/check-transfers.d.ts.map +1 -1
  43. package/resources/declined-transactions.d.mts +16 -16
  44. package/resources/declined-transactions.d.mts.map +1 -1
  45. package/resources/declined-transactions.d.ts +16 -16
  46. package/resources/declined-transactions.d.ts.map +1 -1
  47. package/resources/digital-card-profiles.d.mts +1 -0
  48. package/resources/digital-card-profiles.d.mts.map +1 -1
  49. package/resources/digital-card-profiles.d.ts +1 -0
  50. package/resources/digital-card-profiles.d.ts.map +1 -1
  51. package/resources/entities.d.mts +3 -2
  52. package/resources/entities.d.mts.map +1 -1
  53. package/resources/entities.d.ts +3 -2
  54. package/resources/entities.d.ts.map +1 -1
  55. package/resources/exports.d.mts +327 -15
  56. package/resources/exports.d.mts.map +1 -1
  57. package/resources/exports.d.ts +327 -15
  58. package/resources/exports.d.ts.map +1 -1
  59. package/resources/fednow-transfers.d.mts +6 -6
  60. package/resources/fednow-transfers.d.mts.map +1 -1
  61. package/resources/fednow-transfers.d.ts +6 -6
  62. package/resources/fednow-transfers.d.ts.map +1 -1
  63. package/resources/inbound-ach-transfers.d.mts +1 -0
  64. package/resources/inbound-ach-transfers.d.mts.map +1 -1
  65. package/resources/inbound-ach-transfers.d.ts +1 -0
  66. package/resources/inbound-ach-transfers.d.ts.map +1 -1
  67. package/resources/lockboxes.d.mts +2 -0
  68. package/resources/lockboxes.d.mts.map +1 -1
  69. package/resources/lockboxes.d.ts +2 -0
  70. package/resources/lockboxes.d.ts.map +1 -1
  71. package/resources/pending-transactions.d.mts +52 -52
  72. package/resources/pending-transactions.d.mts.map +1 -1
  73. package/resources/pending-transactions.d.ts +52 -52
  74. package/resources/pending-transactions.d.ts.map +1 -1
  75. package/resources/real-time-payments-transfers.d.mts +6 -6
  76. package/resources/real-time-payments-transfers.d.mts.map +1 -1
  77. package/resources/real-time-payments-transfers.d.ts +6 -6
  78. package/resources/real-time-payments-transfers.d.ts.map +1 -1
  79. package/resources/simulations/ach-transfers.d.mts +17 -14
  80. package/resources/simulations/ach-transfers.d.mts.map +1 -1
  81. package/resources/simulations/ach-transfers.d.ts +17 -14
  82. package/resources/simulations/ach-transfers.d.ts.map +1 -1
  83. package/resources/simulations/programs.d.mts +1 -3
  84. package/resources/simulations/programs.d.mts.map +1 -1
  85. package/resources/simulations/programs.d.ts +1 -3
  86. package/resources/simulations/programs.d.ts.map +1 -1
  87. package/resources/swift-transfers.d.mts +6 -6
  88. package/resources/swift-transfers.d.mts.map +1 -1
  89. package/resources/swift-transfers.d.ts +6 -6
  90. package/resources/swift-transfers.d.ts.map +1 -1
  91. package/resources/transactions.d.mts +140 -137
  92. package/resources/transactions.d.mts.map +1 -1
  93. package/resources/transactions.d.ts +140 -137
  94. package/resources/transactions.d.ts.map +1 -1
  95. package/resources/wire-transfers.d.mts +8 -8
  96. package/resources/wire-transfers.d.mts.map +1 -1
  97. package/resources/wire-transfers.d.ts +8 -8
  98. package/resources/wire-transfers.d.ts.map +1 -1
  99. package/src/client.ts +15 -4
  100. package/src/resources/account-transfers.ts +7 -7
  101. package/src/resources/ach-prenotifications.ts +45 -24
  102. package/src/resources/ach-transfers.ts +57 -35
  103. package/src/resources/card-disputes.ts +41 -41
  104. package/src/resources/card-payments.ts +63 -63
  105. package/src/resources/card-push-transfers.ts +7 -7
  106. package/src/resources/card-validations.ts +7 -7
  107. package/src/resources/check-transfers.ts +7 -7
  108. package/src/resources/declined-transactions.ts +18 -18
  109. package/src/resources/digital-card-profiles.ts +2 -0
  110. package/src/resources/entities.ts +4 -2
  111. package/src/resources/exports.ts +385 -29
  112. package/src/resources/fednow-transfers.ts +7 -7
  113. package/src/resources/inbound-ach-transfers.ts +2 -0
  114. package/src/resources/lockboxes.ts +4 -0
  115. package/src/resources/pending-transactions.ts +58 -58
  116. package/src/resources/real-time-payments-transfers.ts +7 -7
  117. package/src/resources/simulations/ach-transfers.ts +17 -14
  118. package/src/resources/simulations/programs.ts +1 -9
  119. package/src/resources/swift-transfers.ts +7 -7
  120. package/src/resources/transactions.ts +164 -161
  121. package/src/resources/wire-transfers.ts +9 -9
  122. package/src/version.ts +1 -1
  123. package/version.d.mts +1 -1
  124. package/version.d.ts +1 -1
  125. package/version.js +1 -1
  126. package/version.mjs +1 -1
@@ -101,34 +101,119 @@ export declare namespace Transaction {
101
101
  * deprecated and will be removed in the future.
102
102
  */
103
103
  interface Source {
104
+ /**
105
+ * The type of the resource. We may add additional possible values for this enum
106
+ * over time; your application should be able to handle such additions gracefully.
107
+ *
108
+ * - `account_transfer_intention` - Account Transfer Intention: details will be
109
+ * under the `account_transfer_intention` object.
110
+ * - `ach_transfer_intention` - ACH Transfer Intention: details will be under the
111
+ * `ach_transfer_intention` object.
112
+ * - `ach_transfer_rejection` - ACH Transfer Rejection: details will be under the
113
+ * `ach_transfer_rejection` object.
114
+ * - `ach_transfer_return` - ACH Transfer Return: details will be under the
115
+ * `ach_transfer_return` object.
116
+ * - `cashback_payment` - Cashback Payment: details will be under the
117
+ * `cashback_payment` object.
118
+ * - `card_dispute_acceptance` - Legacy Card Dispute Acceptance: details will be
119
+ * under the `card_dispute_acceptance` object.
120
+ * - `card_dispute_financial` - Card Dispute Financial: details will be under the
121
+ * `card_dispute_financial` object.
122
+ * - `card_dispute_loss` - Legacy Card Dispute Loss: details will be under the
123
+ * `card_dispute_loss` object.
124
+ * - `card_refund` - Card Refund: details will be under the `card_refund` object.
125
+ * - `card_settlement` - Card Settlement: details will be under the
126
+ * `card_settlement` object.
127
+ * - `card_financial` - Card Financial: details will be under the `card_financial`
128
+ * object.
129
+ * - `card_revenue_payment` - Card Revenue Payment: details will be under the
130
+ * `card_revenue_payment` object.
131
+ * - `check_deposit_acceptance` - Check Deposit Acceptance: details will be under
132
+ * the `check_deposit_acceptance` object.
133
+ * - `check_deposit_return` - Check Deposit Return: details will be under the
134
+ * `check_deposit_return` object.
135
+ * - `fednow_transfer_acknowledgement` - FedNow Transfer Acknowledgement: details
136
+ * will be under the `fednow_transfer_acknowledgement` object.
137
+ * - `check_transfer_deposit` - Check Transfer Deposit: details will be under the
138
+ * `check_transfer_deposit` object.
139
+ * - `fee_payment` - Fee Payment: details will be under the `fee_payment` object.
140
+ * - `inbound_ach_transfer` - Inbound ACH Transfer Intention: details will be under
141
+ * the `inbound_ach_transfer` object.
142
+ * - `inbound_ach_transfer_return_intention` - Inbound ACH Transfer Return
143
+ * Intention: details will be under the `inbound_ach_transfer_return_intention`
144
+ * object.
145
+ * - `inbound_check_deposit_return_intention` - Inbound Check Deposit Return
146
+ * Intention: details will be under the `inbound_check_deposit_return_intention`
147
+ * object.
148
+ * - `inbound_check_adjustment` - Inbound Check Adjustment: details will be under
149
+ * the `inbound_check_adjustment` object.
150
+ * - `inbound_fednow_transfer_confirmation` - Inbound FedNow Transfer Confirmation:
151
+ * details will be under the `inbound_fednow_transfer_confirmation` object.
152
+ * - `inbound_real_time_payments_transfer_confirmation` - Inbound Real-Time
153
+ * Payments Transfer Confirmation: details will be under the
154
+ * `inbound_real_time_payments_transfer_confirmation` object.
155
+ * - `inbound_wire_reversal` - Inbound Wire Reversal: details will be under the
156
+ * `inbound_wire_reversal` object.
157
+ * - `inbound_wire_transfer` - Inbound Wire Transfer Intention: details will be
158
+ * under the `inbound_wire_transfer` object.
159
+ * - `inbound_wire_transfer_reversal` - Inbound Wire Transfer Reversal Intention:
160
+ * details will be under the `inbound_wire_transfer_reversal` object.
161
+ * - `interest_payment` - Interest Payment: details will be under the
162
+ * `interest_payment` object.
163
+ * - `internal_source` - Internal Source: details will be under the
164
+ * `internal_source` object.
165
+ * - `real_time_payments_transfer_acknowledgement` - Real-Time Payments Transfer
166
+ * Acknowledgement: details will be under the
167
+ * `real_time_payments_transfer_acknowledgement` object.
168
+ * - `sample_funds` - Sample Funds: details will be under the `sample_funds`
169
+ * object.
170
+ * - `wire_transfer_intention` - Wire Transfer Intention: details will be under the
171
+ * `wire_transfer_intention` object.
172
+ * - `swift_transfer_intention` - Swift Transfer Intention: details will be under
173
+ * the `swift_transfer_intention` object.
174
+ * - `swift_transfer_return` - Swift Transfer Return: details will be under the
175
+ * `swift_transfer_return` object.
176
+ * - `card_push_transfer_acceptance` - Card Push Transfer Acceptance: details will
177
+ * be under the `card_push_transfer_acceptance` object.
178
+ * - `account_revenue_payment` - Account Revenue Payment: details will be under the
179
+ * `account_revenue_payment` object.
180
+ * - `blockchain_onramp_transfer_intention` - Blockchain On-Ramp Transfer
181
+ * Intention: details will be under the `blockchain_onramp_transfer_intention`
182
+ * object.
183
+ * - `blockchain_offramp_transfer_settlement` - Blockchain Off-Ramp Transfer
184
+ * Settlement: details will be under the `blockchain_offramp_transfer_settlement`
185
+ * object.
186
+ * - `other` - The Transaction was made for an undocumented or deprecated reason.
187
+ */
188
+ category: 'account_transfer_intention' | 'ach_transfer_intention' | 'ach_transfer_rejection' | 'ach_transfer_return' | 'cashback_payment' | 'card_dispute_acceptance' | 'card_dispute_financial' | 'card_dispute_loss' | 'card_refund' | 'card_settlement' | 'card_financial' | 'card_revenue_payment' | 'check_deposit_acceptance' | 'check_deposit_return' | 'fednow_transfer_acknowledgement' | 'check_transfer_deposit' | 'fee_payment' | 'inbound_ach_transfer' | 'inbound_ach_transfer_return_intention' | 'inbound_check_deposit_return_intention' | 'inbound_check_adjustment' | 'inbound_fednow_transfer_confirmation' | 'inbound_real_time_payments_transfer_confirmation' | 'inbound_wire_reversal' | 'inbound_wire_transfer' | 'inbound_wire_transfer_reversal' | 'interest_payment' | 'internal_source' | 'real_time_payments_transfer_acknowledgement' | 'sample_funds' | 'wire_transfer_intention' | 'swift_transfer_intention' | 'swift_transfer_return' | 'card_push_transfer_acceptance' | 'account_revenue_payment' | 'blockchain_onramp_transfer_intention' | 'blockchain_offramp_transfer_settlement' | 'other';
104
189
  /**
105
190
  * An Account Revenue Payment object. This field will be present in the JSON
106
191
  * response if and only if `category` is equal to `account_revenue_payment`. An
107
192
  * Account Revenue Payment represents a payment made to an account from the bank.
108
193
  * Account revenue is a type of non-interest income.
109
194
  */
110
- account_revenue_payment: Source.AccountRevenuePayment | null;
195
+ account_revenue_payment?: Source.AccountRevenuePayment | null;
111
196
  /**
112
197
  * An Account Transfer Intention object. This field will be present in the JSON
113
198
  * response if and only if `category` is equal to `account_transfer_intention`. Two
114
199
  * Account Transfer Intentions are created from each Account Transfer. One
115
200
  * decrements the source account, and the other increments the destination account.
116
201
  */
117
- account_transfer_intention: Source.AccountTransferIntention | null;
202
+ account_transfer_intention?: Source.AccountTransferIntention | null;
118
203
  /**
119
204
  * An ACH Transfer Intention object. This field will be present in the JSON
120
205
  * response if and only if `category` is equal to `ach_transfer_intention`. An ACH
121
206
  * Transfer Intention is created from an ACH Transfer. It reflects the intention to
122
207
  * move money into or out of an Increase account via the ACH network.
123
208
  */
124
- ach_transfer_intention: Source.ACHTransferIntention | null;
209
+ ach_transfer_intention?: Source.ACHTransferIntention | null;
125
210
  /**
126
211
  * An ACH Transfer Rejection object. This field will be present in the JSON
127
212
  * response if and only if `category` is equal to `ach_transfer_rejection`. An ACH
128
213
  * Transfer Rejection is created when an ACH Transfer is rejected by Increase. It
129
214
  * offsets the ACH Transfer Intention. These rejections are rare.
130
215
  */
131
- ach_transfer_rejection: Source.ACHTransferRejection | null;
216
+ ach_transfer_rejection?: Source.ACHTransferRejection | null;
132
217
  /**
133
218
  * An ACH Transfer Return object. This field will be present in the JSON response
134
219
  * if and only if `category` is equal to `ach_transfer_return`. An ACH Transfer
@@ -137,50 +222,50 @@ export declare namespace Transaction {
137
222
  * the first two business days after the transfer is initiated, but can occur much
138
223
  * later.
139
224
  */
140
- ach_transfer_return: Source.ACHTransferReturn | null;
225
+ ach_transfer_return?: Source.ACHTransferReturn | null;
141
226
  /**
142
227
  * A Blockchain Off-Ramp Transfer Settlement object. This field will be present in
143
228
  * the JSON response if and only if `category` is equal to
144
229
  * `blockchain_offramp_transfer_settlement`.
145
230
  */
146
- blockchain_offramp_transfer_settlement: Source.BlockchainOfframpTransferSettlement | null;
231
+ blockchain_offramp_transfer_settlement?: Source.BlockchainOfframpTransferSettlement | null;
147
232
  /**
148
233
  * A Blockchain On-Ramp Transfer Intention object. This field will be present in
149
234
  * the JSON response if and only if `category` is equal to
150
235
  * `blockchain_onramp_transfer_intention`.
151
236
  */
152
- blockchain_onramp_transfer_intention: Source.BlockchainOnrampTransferIntention | null;
237
+ blockchain_onramp_transfer_intention?: Source.BlockchainOnrampTransferIntention | null;
153
238
  /**
154
239
  * A Legacy Card Dispute Acceptance object. This field will be present in the JSON
155
240
  * response if and only if `category` is equal to `card_dispute_acceptance`.
156
241
  * Contains the details of a successful Card Dispute.
157
242
  */
158
- card_dispute_acceptance: Source.CardDisputeAcceptance | null;
243
+ card_dispute_acceptance?: Source.CardDisputeAcceptance | null;
159
244
  /**
160
245
  * A Card Dispute Financial object. This field will be present in the JSON response
161
246
  * if and only if `category` is equal to `card_dispute_financial`. Financial event
162
247
  * related to a Card Dispute.
163
248
  */
164
- card_dispute_financial: Source.CardDisputeFinancial | null;
249
+ card_dispute_financial?: Source.CardDisputeFinancial | null;
165
250
  /**
166
251
  * A Legacy Card Dispute Loss object. This field will be present in the JSON
167
252
  * response if and only if `category` is equal to `card_dispute_loss`. Contains the
168
253
  * details of a lost Card Dispute.
169
254
  */
170
- card_dispute_loss: Source.CardDisputeLoss | null;
255
+ card_dispute_loss?: Source.CardDisputeLoss | null;
171
256
  /**
172
257
  * A Card Financial object. This field will be present in the JSON response if and
173
258
  * only if `category` is equal to `card_financial`. Card Financials are temporary
174
259
  * holds placed on a customers funds with the intent to later clear a transaction.
175
260
  */
176
- card_financial: Source.CardFinancial | null;
261
+ card_financial?: Source.CardFinancial | null;
177
262
  /**
178
263
  * A Card Push Transfer Acceptance object. This field will be present in the JSON
179
264
  * response if and only if `category` is equal to `card_push_transfer_acceptance`.
180
265
  * A Card Push Transfer Acceptance is created when an Outbound Card Push Transfer
181
266
  * sent from Increase is accepted by the receiving bank.
182
267
  */
183
- card_push_transfer_acceptance: Source.CardPushTransferAcceptance | null;
268
+ card_push_transfer_acceptance?: Source.CardPushTransferAcceptance | null;
184
269
  /**
185
270
  * A Card Refund object. This field will be present in the JSON response if and
186
271
  * only if `category` is equal to `card_refund`. Card Refunds move money back to
@@ -188,13 +273,13 @@ export declare namespace Transaction {
188
273
  * acquirer can also refund money directly to a card without relation to a
189
274
  * transaction.
190
275
  */
191
- card_refund: Source.CardRefund | null;
276
+ card_refund?: Source.CardRefund | null;
192
277
  /**
193
278
  * A Card Revenue Payment object. This field will be present in the JSON response
194
279
  * if and only if `category` is equal to `card_revenue_payment`. Card Revenue
195
280
  * Payments reflect earnings from fees on card transactions.
196
281
  */
197
- card_revenue_payment: Source.CardRevenuePayment | null;
282
+ card_revenue_payment?: Source.CardRevenuePayment | null;
198
283
  /**
199
284
  * A Card Settlement object. This field will be present in the JSON response if and
200
285
  * only if `category` is equal to `card_settlement`. Card Settlements are card
@@ -202,99 +287,14 @@ export declare namespace Transaction {
202
287
  * preceded by an authorization, an acquirer can also directly clear a transaction
203
288
  * without first authorizing it.
204
289
  */
205
- card_settlement: Source.CardSettlement | null;
290
+ card_settlement?: Source.CardSettlement | null;
206
291
  /**
207
292
  * A Cashback Payment object. This field will be present in the JSON response if
208
293
  * and only if `category` is equal to `cashback_payment`. A Cashback Payment
209
294
  * represents the cashback paid to a cardholder for a given period. Cashback is
210
295
  * usually paid monthly for the prior month's transactions.
211
296
  */
212
- cashback_payment: Source.CashbackPayment | null;
213
- /**
214
- * The type of the resource. We may add additional possible values for this enum
215
- * over time; your application should be able to handle such additions gracefully.
216
- *
217
- * - `account_transfer_intention` - Account Transfer Intention: details will be
218
- * under the `account_transfer_intention` object.
219
- * - `ach_transfer_intention` - ACH Transfer Intention: details will be under the
220
- * `ach_transfer_intention` object.
221
- * - `ach_transfer_rejection` - ACH Transfer Rejection: details will be under the
222
- * `ach_transfer_rejection` object.
223
- * - `ach_transfer_return` - ACH Transfer Return: details will be under the
224
- * `ach_transfer_return` object.
225
- * - `cashback_payment` - Cashback Payment: details will be under the
226
- * `cashback_payment` object.
227
- * - `card_dispute_acceptance` - Legacy Card Dispute Acceptance: details will be
228
- * under the `card_dispute_acceptance` object.
229
- * - `card_dispute_financial` - Card Dispute Financial: details will be under the
230
- * `card_dispute_financial` object.
231
- * - `card_dispute_loss` - Legacy Card Dispute Loss: details will be under the
232
- * `card_dispute_loss` object.
233
- * - `card_refund` - Card Refund: details will be under the `card_refund` object.
234
- * - `card_settlement` - Card Settlement: details will be under the
235
- * `card_settlement` object.
236
- * - `card_financial` - Card Financial: details will be under the `card_financial`
237
- * object.
238
- * - `card_revenue_payment` - Card Revenue Payment: details will be under the
239
- * `card_revenue_payment` object.
240
- * - `check_deposit_acceptance` - Check Deposit Acceptance: details will be under
241
- * the `check_deposit_acceptance` object.
242
- * - `check_deposit_return` - Check Deposit Return: details will be under the
243
- * `check_deposit_return` object.
244
- * - `fednow_transfer_acknowledgement` - FedNow Transfer Acknowledgement: details
245
- * will be under the `fednow_transfer_acknowledgement` object.
246
- * - `check_transfer_deposit` - Check Transfer Deposit: details will be under the
247
- * `check_transfer_deposit` object.
248
- * - `fee_payment` - Fee Payment: details will be under the `fee_payment` object.
249
- * - `inbound_ach_transfer` - Inbound ACH Transfer Intention: details will be under
250
- * the `inbound_ach_transfer` object.
251
- * - `inbound_ach_transfer_return_intention` - Inbound ACH Transfer Return
252
- * Intention: details will be under the `inbound_ach_transfer_return_intention`
253
- * object.
254
- * - `inbound_check_deposit_return_intention` - Inbound Check Deposit Return
255
- * Intention: details will be under the `inbound_check_deposit_return_intention`
256
- * object.
257
- * - `inbound_check_adjustment` - Inbound Check Adjustment: details will be under
258
- * the `inbound_check_adjustment` object.
259
- * - `inbound_fednow_transfer_confirmation` - Inbound FedNow Transfer Confirmation:
260
- * details will be under the `inbound_fednow_transfer_confirmation` object.
261
- * - `inbound_real_time_payments_transfer_confirmation` - Inbound Real-Time
262
- * Payments Transfer Confirmation: details will be under the
263
- * `inbound_real_time_payments_transfer_confirmation` object.
264
- * - `inbound_wire_reversal` - Inbound Wire Reversal: details will be under the
265
- * `inbound_wire_reversal` object.
266
- * - `inbound_wire_transfer` - Inbound Wire Transfer Intention: details will be
267
- * under the `inbound_wire_transfer` object.
268
- * - `inbound_wire_transfer_reversal` - Inbound Wire Transfer Reversal Intention:
269
- * details will be under the `inbound_wire_transfer_reversal` object.
270
- * - `interest_payment` - Interest Payment: details will be under the
271
- * `interest_payment` object.
272
- * - `internal_source` - Internal Source: details will be under the
273
- * `internal_source` object.
274
- * - `real_time_payments_transfer_acknowledgement` - Real-Time Payments Transfer
275
- * Acknowledgement: details will be under the
276
- * `real_time_payments_transfer_acknowledgement` object.
277
- * - `sample_funds` - Sample Funds: details will be under the `sample_funds`
278
- * object.
279
- * - `wire_transfer_intention` - Wire Transfer Intention: details will be under the
280
- * `wire_transfer_intention` object.
281
- * - `swift_transfer_intention` - Swift Transfer Intention: details will be under
282
- * the `swift_transfer_intention` object.
283
- * - `swift_transfer_return` - Swift Transfer Return: details will be under the
284
- * `swift_transfer_return` object.
285
- * - `card_push_transfer_acceptance` - Card Push Transfer Acceptance: details will
286
- * be under the `card_push_transfer_acceptance` object.
287
- * - `account_revenue_payment` - Account Revenue Payment: details will be under the
288
- * `account_revenue_payment` object.
289
- * - `blockchain_onramp_transfer_intention` - Blockchain On-Ramp Transfer
290
- * Intention: details will be under the `blockchain_onramp_transfer_intention`
291
- * object.
292
- * - `blockchain_offramp_transfer_settlement` - Blockchain Off-Ramp Transfer
293
- * Settlement: details will be under the `blockchain_offramp_transfer_settlement`
294
- * object.
295
- * - `other` - The Transaction was made for an undocumented or deprecated reason.
296
- */
297
- category: 'account_transfer_intention' | 'ach_transfer_intention' | 'ach_transfer_rejection' | 'ach_transfer_return' | 'cashback_payment' | 'card_dispute_acceptance' | 'card_dispute_financial' | 'card_dispute_loss' | 'card_refund' | 'card_settlement' | 'card_financial' | 'card_revenue_payment' | 'check_deposit_acceptance' | 'check_deposit_return' | 'fednow_transfer_acknowledgement' | 'check_transfer_deposit' | 'fee_payment' | 'inbound_ach_transfer' | 'inbound_ach_transfer_return_intention' | 'inbound_check_deposit_return_intention' | 'inbound_check_adjustment' | 'inbound_fednow_transfer_confirmation' | 'inbound_real_time_payments_transfer_confirmation' | 'inbound_wire_reversal' | 'inbound_wire_transfer' | 'inbound_wire_transfer_reversal' | 'interest_payment' | 'internal_source' | 'real_time_payments_transfer_acknowledgement' | 'sample_funds' | 'wire_transfer_intention' | 'swift_transfer_intention' | 'swift_transfer_return' | 'card_push_transfer_acceptance' | 'account_revenue_payment' | 'blockchain_onramp_transfer_intention' | 'blockchain_offramp_transfer_settlement' | 'other';
297
+ cashback_payment?: Source.CashbackPayment | null;
298
298
  /**
299
299
  * A Check Deposit Acceptance object. This field will be present in the JSON
300
300
  * response if and only if `category` is equal to `check_deposit_acceptance`. A
@@ -302,7 +302,7 @@ export declare namespace Transaction {
302
302
  * details confirmed. Check Deposits may be returned by the receiving bank, which
303
303
  * will appear as a Check Deposit Return.
304
304
  */
305
- check_deposit_acceptance: Source.CheckDepositAcceptance | null;
305
+ check_deposit_acceptance?: Source.CheckDepositAcceptance | null;
306
306
  /**
307
307
  * A Check Deposit Return object. This field will be present in the JSON response
308
308
  * if and only if `category` is equal to `check_deposit_return`. A Check Deposit
@@ -311,34 +311,34 @@ export declare namespace Transaction {
311
311
  * reasons, including insufficient funds or a mismatched account number. Usually,
312
312
  * checks are returned within the first 7 days after the deposit is made.
313
313
  */
314
- check_deposit_return: Source.CheckDepositReturn | null;
314
+ check_deposit_return?: Source.CheckDepositReturn | null;
315
315
  /**
316
316
  * A Check Transfer Deposit object. This field will be present in the JSON response
317
317
  * if and only if `category` is equal to `check_transfer_deposit`. An Inbound Check
318
318
  * is a check drawn on an Increase account that has been deposited by an external
319
319
  * bank account. These types of checks are not pre-registered.
320
320
  */
321
- check_transfer_deposit: Source.CheckTransferDeposit | null;
321
+ check_transfer_deposit?: Source.CheckTransferDeposit | null;
322
322
  /**
323
323
  * A FedNow Transfer Acknowledgement object. This field will be present in the JSON
324
324
  * response if and only if `category` is equal to
325
325
  * `fednow_transfer_acknowledgement`. A FedNow Transfer Acknowledgement is created
326
326
  * when a FedNow Transfer sent from Increase is acknowledged by the receiving bank.
327
327
  */
328
- fednow_transfer_acknowledgement: Source.FednowTransferAcknowledgement | null;
328
+ fednow_transfer_acknowledgement?: Source.FednowTransferAcknowledgement | null;
329
329
  /**
330
330
  * A Fee Payment object. This field will be present in the JSON response if and
331
331
  * only if `category` is equal to `fee_payment`. A Fee Payment represents a payment
332
332
  * made to Increase.
333
333
  */
334
- fee_payment: Source.FeePayment | null;
334
+ fee_payment?: Source.FeePayment | null;
335
335
  /**
336
336
  * An Inbound ACH Transfer Intention object. This field will be present in the JSON
337
337
  * response if and only if `category` is equal to `inbound_ach_transfer`. An
338
338
  * Inbound ACH Transfer Intention is created when an ACH transfer is initiated at
339
339
  * another bank and received by Increase.
340
340
  */
341
- inbound_ach_transfer: Source.InboundACHTransfer | null;
341
+ inbound_ach_transfer?: Source.InboundACHTransfer | null;
342
342
  /**
343
343
  * An Inbound ACH Transfer Return Intention object. This field will be present in
344
344
  * the JSON response if and only if `category` is equal to
@@ -346,14 +346,14 @@ export declare namespace Transaction {
346
346
  * Intention is created when an ACH transfer is initiated at another bank and
347
347
  * returned by Increase.
348
348
  */
349
- inbound_ach_transfer_return_intention: Source.InboundACHTransferReturnIntention | null;
349
+ inbound_ach_transfer_return_intention?: Source.InboundACHTransferReturnIntention | null;
350
350
  /**
351
351
  * An Inbound Check Adjustment object. This field will be present in the JSON
352
352
  * response if and only if `category` is equal to `inbound_check_adjustment`. An
353
353
  * Inbound Check Adjustment is created when Increase receives an adjustment for a
354
354
  * check or return deposited through Check21.
355
355
  */
356
- inbound_check_adjustment: Source.InboundCheckAdjustment | null;
356
+ inbound_check_adjustment?: Source.InboundCheckAdjustment | null;
357
357
  /**
358
358
  * An Inbound Check Deposit Return Intention object. This field will be present in
359
359
  * the JSON response if and only if `category` is equal to
@@ -361,7 +361,7 @@ export declare namespace Transaction {
361
361
  * Intention is created when Increase receives an Inbound Check and the User
362
362
  * requests that it be returned.
363
363
  */
364
- inbound_check_deposit_return_intention: Source.InboundCheckDepositReturnIntention | null;
364
+ inbound_check_deposit_return_intention?: Source.InboundCheckDepositReturnIntention | null;
365
365
  /**
366
366
  * An Inbound FedNow Transfer Confirmation object. This field will be present in
367
367
  * the JSON response if and only if `category` is equal to
@@ -369,7 +369,7 @@ export declare namespace Transaction {
369
369
  * is created when a FedNow transfer is initiated at another bank and received by
370
370
  * Increase.
371
371
  */
372
- inbound_fednow_transfer_confirmation: Source.InboundFednowTransferConfirmation | null;
372
+ inbound_fednow_transfer_confirmation?: Source.InboundFednowTransferConfirmation | null;
373
373
  /**
374
374
  * An Inbound Real-Time Payments Transfer Confirmation object. This field will be
375
375
  * present in the JSON response if and only if `category` is equal to
@@ -377,7 +377,7 @@ export declare namespace Transaction {
377
377
  * Payments Transfer Confirmation is created when a Real-Time Payments transfer is
378
378
  * initiated at another bank and received by Increase.
379
379
  */
380
- inbound_real_time_payments_transfer_confirmation: Source.InboundRealTimePaymentsTransferConfirmation | null;
380
+ inbound_real_time_payments_transfer_confirmation?: Source.InboundRealTimePaymentsTransferConfirmation | null;
381
381
  /**
382
382
  * An Inbound Wire Reversal object. This field will be present in the JSON response
383
383
  * if and only if `category` is equal to `inbound_wire_reversal`. An Inbound Wire
@@ -385,14 +385,14 @@ export declare namespace Transaction {
385
385
  * Increase. The other bank is sending the money back. This most often happens when
386
386
  * the original destination account details were incorrect.
387
387
  */
388
- inbound_wire_reversal: Source.InboundWireReversal | null;
388
+ inbound_wire_reversal?: Source.InboundWireReversal | null;
389
389
  /**
390
390
  * An Inbound Wire Transfer Intention object. This field will be present in the
391
391
  * JSON response if and only if `category` is equal to `inbound_wire_transfer`. An
392
392
  * Inbound Wire Transfer Intention is created when a wire transfer is initiated at
393
393
  * another bank and received by Increase.
394
394
  */
395
- inbound_wire_transfer: Source.InboundWireTransfer | null;
395
+ inbound_wire_transfer?: Source.InboundWireTransfer | null;
396
396
  /**
397
397
  * An Inbound Wire Transfer Reversal Intention object. This field will be present
398
398
  * in the JSON response if and only if `category` is equal to
@@ -400,25 +400,25 @@ export declare namespace Transaction {
400
400
  * created when Increase has received a wire and the User requests that it be
401
401
  * reversed.
402
402
  */
403
- inbound_wire_transfer_reversal: Source.InboundWireTransferReversal | null;
403
+ inbound_wire_transfer_reversal?: Source.InboundWireTransferReversal | null;
404
404
  /**
405
405
  * An Interest Payment object. This field will be present in the JSON response if
406
406
  * and only if `category` is equal to `interest_payment`. An Interest Payment
407
407
  * represents a payment of interest on an account. Interest is usually paid
408
408
  * monthly.
409
409
  */
410
- interest_payment: Source.InterestPayment | null;
410
+ interest_payment?: Source.InterestPayment | null;
411
411
  /**
412
412
  * An Internal Source object. This field will be present in the JSON response if
413
413
  * and only if `category` is equal to `internal_source`. A transaction between the
414
414
  * user and Increase. See the `reason` attribute for more information.
415
415
  */
416
- internal_source: Source.InternalSource | null;
416
+ internal_source?: Source.InternalSource | null;
417
417
  /**
418
418
  * If the category of this Transaction source is equal to `other`, this field will
419
419
  * contain an empty object, otherwise it will contain null.
420
420
  */
421
- other: Source.Other | null;
421
+ other?: Source.Other | null;
422
422
  /**
423
423
  * A Real-Time Payments Transfer Acknowledgement object. This field will be present
424
424
  * in the JSON response if and only if `category` is equal to
@@ -426,31 +426,31 @@ export declare namespace Transaction {
426
426
  * Acknowledgement is created when a Real-Time Payments Transfer sent from Increase
427
427
  * is acknowledged by the receiving bank.
428
428
  */
429
- real_time_payments_transfer_acknowledgement: Source.RealTimePaymentsTransferAcknowledgement | null;
429
+ real_time_payments_transfer_acknowledgement?: Source.RealTimePaymentsTransferAcknowledgement | null;
430
430
  /**
431
431
  * A Sample Funds object. This field will be present in the JSON response if and
432
432
  * only if `category` is equal to `sample_funds`. Sample funds for testing
433
433
  * purposes.
434
434
  */
435
- sample_funds: Source.SampleFunds | null;
435
+ sample_funds?: Source.SampleFunds | null;
436
436
  /**
437
437
  * A Swift Transfer Intention object. This field will be present in the JSON
438
438
  * response if and only if `category` is equal to `swift_transfer_intention`. A
439
439
  * Swift Transfer initiated via Increase.
440
440
  */
441
- swift_transfer_intention: Source.SwiftTransferIntention | null;
441
+ swift_transfer_intention?: Source.SwiftTransferIntention | null;
442
442
  /**
443
443
  * A Swift Transfer Return object. This field will be present in the JSON response
444
444
  * if and only if `category` is equal to `swift_transfer_return`. A Swift Transfer
445
445
  * Return is created when a Swift Transfer is returned by the receiving bank.
446
446
  */
447
- swift_transfer_return: Source.SwiftTransferReturn | null;
447
+ swift_transfer_return?: Source.SwiftTransferReturn | null;
448
448
  /**
449
449
  * A Wire Transfer Intention object. This field will be present in the JSON
450
450
  * response if and only if `category` is equal to `wire_transfer_intention`. A Wire
451
451
  * Transfer initiated via Increase and sent to a different bank.
452
452
  */
453
- wire_transfer_intention: Source.WireTransferIntention | null;
453
+ wire_transfer_intention?: Source.WireTransferIntention | null;
454
454
  [k: string]: unknown;
455
455
  }
456
456
  namespace Source {
@@ -579,24 +579,28 @@ export declare namespace Transaction {
579
579
  * bank back to Increase.
580
580
  *
581
581
  * - `insufficient_fund` - Code R01. Insufficient funds in the receiving account.
582
- * Sometimes abbreviated to NSF.
582
+ * Sometimes abbreviated to "NSF."
583
583
  * - `no_account` - Code R03. The account does not exist or the receiving bank was
584
584
  * unable to locate it.
585
585
  * - `account_closed` - Code R02. The account is closed at the receiving bank.
586
586
  * - `invalid_account_number_structure` - Code R04. The account number is invalid
587
587
  * at the receiving bank.
588
- * - `account_frozen_entry_returned_per_ofac_instruction` - Code R16. The account
589
- * at the receiving bank was frozen per the Office of Foreign Assets Control.
590
- * - `credit_entry_refused_by_receiver` - Code R23. The receiving bank account
591
- * refused a credit transfer.
588
+ * - `account_frozen_entry_returned_per_ofac_instruction` - Code R16. This return
589
+ * code has two separate meanings. (1) The receiving bank froze the account or
590
+ * (2) the Office of Foreign Assets Control (OFAC) instructed the receiving bank
591
+ * to return the entry.
592
+ * - `credit_entry_refused_by_receiver` - Code R23. The receiving bank refused the
593
+ * credit transfer.
592
594
  * - `unauthorized_debit_to_consumer_account_using_corporate_sec_code` - Code R05.
593
595
  * The receiving bank rejected because of an incorrect Standard Entry Class code.
596
+ * Consumer accounts cannot be debited as `corporate_credit_or_debit` or
597
+ * `corporate_trade_exchange`.
594
598
  * - `corporate_customer_advised_not_authorized` - Code R29. The corporate customer
595
599
  * at the receiving bank reversed the transfer.
596
600
  * - `payment_stopped` - Code R08. The receiving bank stopped payment on this
597
601
  * transfer.
598
- * - `non_transaction_account` - Code R20. The receiving bank account does not
599
- * perform transfers.
602
+ * - `non_transaction_account` - Code R20. The account is not eligible for ACH,
603
+ * such as a savings account with transaction limits.
600
604
  * - `uncollected_funds` - Code R09. The receiving bank account does not have
601
605
  * enough available balance for the transfer.
602
606
  * - `routing_number_check_digit_error` - Code R28. The routing number is
@@ -604,14 +608,13 @@ export declare namespace Transaction {
604
608
  * - `customer_advised_unauthorized_improper_ineligible_or_incomplete` - Code R10.
605
609
  * The customer at the receiving bank reversed the transfer.
606
610
  * - `amount_field_error` - Code R19. The amount field is incorrect or too large.
607
- * - `authorization_revoked_by_customer` - Code R07. The customer at the receiving
608
- * institution informed their bank that they have revoked authorization for a
609
- * previously authorized transfer.
611
+ * - `authorization_revoked_by_customer` - Code R07. The customer revoked their
612
+ * authorization for a previously authorized transfer.
610
613
  * - `invalid_ach_routing_number` - Code R13. The routing number is invalid.
611
614
  * - `file_record_edit_criteria` - Code R17. The receiving bank is unable to
612
615
  * process a field in the transfer.
613
- * - `enr_invalid_individual_name` - Code R45. The individual name field was
614
- * invalid.
616
+ * - `enr_invalid_individual_name` - Code R45. A rare return reason. The individual
617
+ * name field was invalid.
615
618
  * - `returned_per_odfi_request` - Code R06. The originating financial institution
616
619
  * asked for this transfer to be returned. The receiving bank is complying with
617
620
  * the request.
@@ -706,8 +709,8 @@ export declare namespace Transaction {
706
709
  * a malformed credit entry.
707
710
  * - `return_of_improper_debit_entry` - Code R35. A rare return reason. Return of a
708
711
  * malformed debit entry.
709
- * - `return_of_xck_entry` - Code R33. A rare return reason. Return of a Destroyed
710
- * Check ("XKC") entry.
712
+ * - `return_of_xck_entry` - Code R33. A rare return reason. Return of a destroyed
713
+ * check ("XCK") entry.
711
714
  * - `source_document_presented_for_payment` - Code R37. A rare return reason. The
712
715
  * source document related to this ACH, usually an ACH check conversion, was
713
716
  * presented to the bank.