increase 0.568.2 → 0.570.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 (178) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +17 -0
  3. package/core/error.d.mts +5 -0
  4. package/core/error.d.mts.map +1 -1
  5. package/core/error.d.ts +5 -0
  6. package/core/error.d.ts.map +1 -1
  7. package/core/error.js +1 -0
  8. package/core/error.js.map +1 -1
  9. package/core/error.mjs +1 -0
  10. package/core/error.mjs.map +1 -1
  11. package/package.json +9 -15
  12. package/resources/ach-prenotifications.d.mts +6 -5
  13. package/resources/ach-prenotifications.d.mts.map +1 -1
  14. package/resources/ach-prenotifications.d.ts +6 -5
  15. package/resources/ach-prenotifications.d.ts.map +1 -1
  16. package/resources/ach-transfers.d.mts +8 -5
  17. package/resources/ach-transfers.d.mts.map +1 -1
  18. package/resources/ach-transfers.d.ts +8 -5
  19. package/resources/ach-transfers.d.ts.map +1 -1
  20. package/resources/card-disputes.d.mts +24 -2
  21. package/resources/card-disputes.d.mts.map +1 -1
  22. package/resources/card-disputes.d.ts +24 -2
  23. package/resources/card-disputes.d.ts.map +1 -1
  24. package/resources/card-payments.d.mts +41 -8
  25. package/resources/card-payments.d.mts.map +1 -1
  26. package/resources/card-payments.d.ts +41 -8
  27. package/resources/card-payments.d.ts.map +1 -1
  28. package/resources/card-push-transfers.d.mts +28 -0
  29. package/resources/card-push-transfers.d.mts.map +1 -1
  30. package/resources/card-push-transfers.d.ts +28 -0
  31. package/resources/card-push-transfers.d.ts.map +1 -1
  32. package/resources/cards.d.mts +4 -0
  33. package/resources/cards.d.mts.map +1 -1
  34. package/resources/cards.d.ts +4 -0
  35. package/resources/cards.d.ts.map +1 -1
  36. package/resources/check-transfers.d.mts +4 -2
  37. package/resources/check-transfers.d.mts.map +1 -1
  38. package/resources/check-transfers.d.ts +4 -2
  39. package/resources/check-transfers.d.ts.map +1 -1
  40. package/resources/declined-transactions.d.mts +5 -2
  41. package/resources/declined-transactions.d.mts.map +1 -1
  42. package/resources/declined-transactions.d.ts +5 -2
  43. package/resources/declined-transactions.d.ts.map +1 -1
  44. package/resources/digital-wallet-tokens.d.mts +30 -2
  45. package/resources/digital-wallet-tokens.d.mts.map +1 -1
  46. package/resources/digital-wallet-tokens.d.ts +30 -2
  47. package/resources/digital-wallet-tokens.d.ts.map +1 -1
  48. package/resources/entities.d.mts +1 -1
  49. package/resources/entities.d.ts +1 -1
  50. package/resources/event-subscriptions.d.mts +10 -2
  51. package/resources/event-subscriptions.d.mts.map +1 -1
  52. package/resources/event-subscriptions.d.ts +10 -2
  53. package/resources/event-subscriptions.d.ts.map +1 -1
  54. package/resources/events.d.mts +11 -3
  55. package/resources/events.d.mts.map +1 -1
  56. package/resources/events.d.ts +11 -3
  57. package/resources/events.d.ts.map +1 -1
  58. package/resources/exports.d.mts +55 -1
  59. package/resources/exports.d.mts.map +1 -1
  60. package/resources/exports.d.ts +55 -1
  61. package/resources/exports.d.ts.map +1 -1
  62. package/resources/fednow-transfers.d.mts +25 -0
  63. package/resources/fednow-transfers.d.mts.map +1 -1
  64. package/resources/fednow-transfers.d.ts +25 -0
  65. package/resources/fednow-transfers.d.ts.map +1 -1
  66. package/resources/inbound-wire-transfers.d.mts +4 -0
  67. package/resources/inbound-wire-transfers.d.mts.map +1 -1
  68. package/resources/inbound-wire-transfers.d.ts +4 -0
  69. package/resources/inbound-wire-transfers.d.ts.map +1 -1
  70. package/resources/intrafi-balances.d.mts +0 -2
  71. package/resources/intrafi-balances.d.mts.map +1 -1
  72. package/resources/intrafi-balances.d.ts +0 -2
  73. package/resources/intrafi-balances.d.ts.map +1 -1
  74. package/resources/pending-transactions.d.mts +25 -1
  75. package/resources/pending-transactions.d.mts.map +1 -1
  76. package/resources/pending-transactions.d.ts +25 -1
  77. package/resources/pending-transactions.d.ts.map +1 -1
  78. package/resources/physical-card-profiles.d.mts +23 -1
  79. package/resources/physical-card-profiles.d.mts.map +1 -1
  80. package/resources/physical-card-profiles.d.ts +23 -1
  81. package/resources/physical-card-profiles.d.ts.map +1 -1
  82. package/resources/physical-cards.d.mts +4 -1
  83. package/resources/physical-cards.d.mts.map +1 -1
  84. package/resources/physical-cards.d.ts +4 -1
  85. package/resources/physical-cards.d.ts.map +1 -1
  86. package/resources/programs.d.mts +1 -0
  87. package/resources/programs.d.mts.map +1 -1
  88. package/resources/programs.d.ts +1 -0
  89. package/resources/programs.d.ts.map +1 -1
  90. package/resources/real-time-decisions.d.mts +25 -1
  91. package/resources/real-time-decisions.d.mts.map +1 -1
  92. package/resources/real-time-decisions.d.ts +25 -1
  93. package/resources/real-time-decisions.d.ts.map +1 -1
  94. package/resources/simulations/ach-transfers.d.mts +2 -1
  95. package/resources/simulations/ach-transfers.d.mts.map +1 -1
  96. package/resources/simulations/ach-transfers.d.ts +2 -1
  97. package/resources/simulations/ach-transfers.d.ts.map +1 -1
  98. package/resources/simulations/card-authorizations.d.mts +5 -2
  99. package/resources/simulations/card-authorizations.d.mts.map +1 -1
  100. package/resources/simulations/card-authorizations.d.ts +5 -2
  101. package/resources/simulations/card-authorizations.d.ts.map +1 -1
  102. package/resources/simulations/card-balance-inquiries.d.mts +2 -1
  103. package/resources/simulations/card-balance-inquiries.d.mts.map +1 -1
  104. package/resources/simulations/card-balance-inquiries.d.ts +2 -1
  105. package/resources/simulations/card-balance-inquiries.d.ts.map +1 -1
  106. package/resources/simulations/check-deposits.d.mts +8 -0
  107. package/resources/simulations/check-deposits.d.mts.map +1 -1
  108. package/resources/simulations/check-deposits.d.ts +8 -0
  109. package/resources/simulations/check-deposits.d.ts.map +1 -1
  110. package/resources/simulations/digital-wallet-token-requests.d.mts +5 -1
  111. package/resources/simulations/digital-wallet-token-requests.d.mts.map +1 -1
  112. package/resources/simulations/digital-wallet-token-requests.d.ts +5 -1
  113. package/resources/simulations/digital-wallet-token-requests.d.ts.map +1 -1
  114. package/resources/simulations/entities.d.mts +1 -1
  115. package/resources/simulations/entities.d.ts +1 -1
  116. package/resources/simulations/inbound-wire-transfers.d.mts +5 -0
  117. package/resources/simulations/inbound-wire-transfers.d.mts.map +1 -1
  118. package/resources/simulations/inbound-wire-transfers.d.ts +5 -0
  119. package/resources/simulations/inbound-wire-transfers.d.ts.map +1 -1
  120. package/resources/simulations/physical-cards.d.mts +4 -1
  121. package/resources/simulations/physical-cards.d.mts.map +1 -1
  122. package/resources/simulations/physical-cards.d.ts +4 -1
  123. package/resources/simulations/physical-cards.d.ts.map +1 -1
  124. package/resources/simulations/programs.d.mts +1 -0
  125. package/resources/simulations/programs.d.mts.map +1 -1
  126. package/resources/simulations/programs.d.ts +1 -0
  127. package/resources/simulations/programs.d.ts.map +1 -1
  128. package/resources/swift-transfers.d.mts +1 -1
  129. package/resources/swift-transfers.d.ts +1 -1
  130. package/resources/swift-transfers.js +1 -1
  131. package/resources/swift-transfers.mjs +1 -1
  132. package/resources/transactions.d.mts +17 -7
  133. package/resources/transactions.d.mts.map +1 -1
  134. package/resources/transactions.d.ts +17 -7
  135. package/resources/transactions.d.ts.map +1 -1
  136. package/resources/wire-drawdown-requests.d.mts +11 -0
  137. package/resources/wire-drawdown-requests.d.mts.map +1 -1
  138. package/resources/wire-drawdown-requests.d.ts +11 -0
  139. package/resources/wire-drawdown-requests.d.ts.map +1 -1
  140. package/src/core/error.ts +7 -0
  141. package/src/resources/ach-prenotifications.ts +6 -5
  142. package/src/resources/ach-transfers.ts +8 -5
  143. package/src/resources/card-disputes.ts +28 -1
  144. package/src/resources/card-payments.ts +43 -5
  145. package/src/resources/card-push-transfers.ts +34 -0
  146. package/src/resources/cards.ts +5 -0
  147. package/src/resources/check-transfers.ts +4 -2
  148. package/src/resources/declined-transactions.ts +5 -1
  149. package/src/resources/digital-wallet-tokens.ts +38 -2
  150. package/src/resources/entities.ts +1 -1
  151. package/src/resources/event-subscriptions.ts +16 -0
  152. package/src/resources/events.ts +20 -0
  153. package/src/resources/exports.ts +64 -0
  154. package/src/resources/fednow-transfers.ts +30 -0
  155. package/src/resources/inbound-wire-transfers.ts +5 -0
  156. package/src/resources/intrafi-balances.ts +0 -4
  157. package/src/resources/pending-transactions.ts +27 -0
  158. package/src/resources/physical-card-profiles.ts +25 -1
  159. package/src/resources/physical-cards.ts +4 -1
  160. package/src/resources/programs.ts +2 -0
  161. package/src/resources/real-time-decisions.ts +27 -0
  162. package/src/resources/simulations/ach-transfers.ts +2 -1
  163. package/src/resources/simulations/card-authorizations.ts +5 -1
  164. package/src/resources/simulations/card-balance-inquiries.ts +2 -1
  165. package/src/resources/simulations/check-deposits.ts +9 -0
  166. package/src/resources/simulations/digital-wallet-token-requests.ts +6 -0
  167. package/src/resources/simulations/entities.ts +1 -1
  168. package/src/resources/simulations/inbound-wire-transfers.ts +6 -0
  169. package/src/resources/simulations/physical-cards.ts +4 -1
  170. package/src/resources/simulations/programs.ts +2 -0
  171. package/src/resources/swift-transfers.ts +1 -1
  172. package/src/resources/transactions.ts +18 -6
  173. package/src/resources/wire-drawdown-requests.ts +13 -0
  174. package/src/version.ts +1 -1
  175. package/version.d.mts +1 -1
  176. package/version.d.ts +1 -1
  177. package/version.js +1 -1
  178. package/version.mjs +1 -1
@@ -151,6 +151,12 @@ export interface CardDispute {
151
151
  */
152
152
  network: 'visa' | 'pulse';
153
153
 
154
+ /**
155
+ * If the Card Dispute has been rejected, this will contain details of the
156
+ * rejection.
157
+ */
158
+ rejection: CardDispute.Rejection | null;
159
+
154
160
  /**
155
161
  * The status of the Card Dispute.
156
162
  *
@@ -166,6 +172,8 @@ export interface CardDispute {
166
172
  * - `lost` - The Card Dispute has been lost and funds previously credited from the
167
173
  * acceptance have been debited.
168
174
  * - `won` - The Card Dispute has been won and no further action can be taken.
175
+ * - `rejected` - The Card Dispute has been reviewed and rejected, please review
176
+ * the explanation for more details.
169
177
  */
170
178
  status:
171
179
  | 'user_submission_required'
@@ -174,7 +182,8 @@ export interface CardDispute {
174
182
  | 'pending_user_withdrawal_submitting'
175
183
  | 'pending_response'
176
184
  | 'lost'
177
- | 'won';
185
+ | 'won'
186
+ | 'rejected';
178
187
 
179
188
  /**
180
189
  * A constant representing the object's type. For this resource it will always be
@@ -231,6 +240,23 @@ export namespace CardDispute {
231
240
  reason: 'user_withdrawn' | 'loss';
232
241
  }
233
242
 
243
+ /**
244
+ * If the Card Dispute has been rejected, this will contain details of the
245
+ * rejection.
246
+ */
247
+ export interface Rejection {
248
+ /**
249
+ * Why the Card Dispute was rejected.
250
+ */
251
+ explanation: string;
252
+
253
+ /**
254
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
255
+ * the Card Dispute was rejected.
256
+ */
257
+ rejected_at: string;
258
+ }
259
+
234
260
  /**
235
261
  * Card Dispute information for card payments processed over Visa's network. This
236
262
  * field will be present in the JSON response if and only if `network` is equal to
@@ -4917,6 +4943,7 @@ export namespace CardDisputeListParams {
4917
4943
  | 'pending_response'
4918
4944
  | 'lost'
4919
4945
  | 'won'
4946
+ | 'rejected'
4920
4947
  >;
4921
4948
  }
4922
4949
  }
@@ -187,8 +187,10 @@ export namespace CardPayment {
187
187
 
188
188
  /**
189
189
  * A Card Financial object. This field will be present in the JSON response if and
190
- * only if `category` is equal to `card_financial`. Card Financials are temporary
191
- * holds placed on a customer's funds with the intent to later clear a transaction.
190
+ * only if `category` is equal to `card_financial`. Card Financials are card
191
+ * transactions that have cleared and settled. Unlike a Card Settlement, which
192
+ * clears a previous authorization, a Card Financial is authorized and cleared in a
193
+ * single message.
192
194
  */
193
195
  card_financial?: Element.CardFinancial | null;
194
196
 
@@ -862,6 +864,12 @@ export namespace CardPayment {
862
864
  */
863
865
  expires_at: string;
864
866
 
867
+ /**
868
+ * The healthcare-related fields for this authorization. Only present for specific
869
+ * programs.
870
+ */
871
+ healthcare: CardAuthorization.Healthcare | null;
872
+
865
873
  /**
866
874
  * The merchant identifier (commonly abbreviated as MID) of the merchant the card
867
875
  * is transacting with.
@@ -959,6 +967,8 @@ export namespace CardPayment {
959
967
  * voucher authorization, where funds are credited to the cardholder.
960
968
  * - `cash_disbursement` - Cash disbursement transactions are used to withdraw cash
961
969
  * from an ATM or a point of sale.
970
+ * - `cash_deposit` - Cash deposit transactions are used to deposit cash at an ATM
971
+ * or a point of sale.
962
972
  * - `balance_inquiry` - A balance inquiry transaction is used to check the balance
963
973
  * of an account associated with a card.
964
974
  * - `unknown` - The processing category is unknown.
@@ -972,6 +982,7 @@ export namespace CardPayment {
972
982
  | 'quasi_cash'
973
983
  | 'refund'
974
984
  | 'cash_disbursement'
985
+ | 'cash_deposit'
975
986
  | 'balance_inquiry'
976
987
  | 'unknown';
977
988
 
@@ -1246,6 +1257,24 @@ export namespace CardPayment {
1246
1257
  }
1247
1258
  }
1248
1259
 
1260
+ /**
1261
+ * The healthcare-related fields for this authorization. Only present for specific
1262
+ * programs.
1263
+ */
1264
+ export interface Healthcare {
1265
+ /**
1266
+ * The merchant's eligibility under the Internal Revenue Service's 90% Rule for
1267
+ * Flexible Spending Account (FSA) and Health Savings Account (HSA) eligible
1268
+ * products. The eligibility is determined based on the list of merchants
1269
+ * maintained by the Special Interest Group for IIAS Standards (SIGIS).
1270
+ *
1271
+ * - `eligible` - The merchant is eligible for treatment under the 90% rule.
1272
+ * - `not_eligible` - The merchant is not eligible for treatment under the 90%
1273
+ * rule.
1274
+ */
1275
+ merchant_ninety_percent_eligibility: 'eligible' | 'not_eligible';
1276
+ }
1277
+
1249
1278
  /**
1250
1279
  * Fields specific to the `network`.
1251
1280
  */
@@ -2786,6 +2815,8 @@ export namespace CardPayment {
2786
2815
  * voucher authorization, where funds are credited to the cardholder.
2787
2816
  * - `cash_disbursement` - Cash disbursement transactions are used to withdraw cash
2788
2817
  * from an ATM or a point of sale.
2818
+ * - `cash_deposit` - Cash deposit transactions are used to deposit cash at an ATM
2819
+ * or a point of sale.
2789
2820
  * - `balance_inquiry` - A balance inquiry transaction is used to check the balance
2790
2821
  * of an account associated with a card.
2791
2822
  * - `unknown` - The processing category is unknown.
@@ -2799,6 +2830,7 @@ export namespace CardPayment {
2799
2830
  | 'quasi_cash'
2800
2831
  | 'refund'
2801
2832
  | 'cash_disbursement'
2833
+ | 'cash_deposit'
2802
2834
  | 'balance_inquiry'
2803
2835
  | 'unknown';
2804
2836
 
@@ -2851,7 +2883,8 @@ export namespace CardPayment {
2851
2883
  * card's value. Only applies when a CVV2 is present.
2852
2884
  * - `transaction_not_allowed` - The attempted card transaction is not allowed per
2853
2885
  * Increase's terms.
2854
- * - `breaches_limit` - The transaction was blocked by a Limit.
2886
+ * - `breaches_limit` - The transaction was blocked by a limit or an authorization
2887
+ * control.
2855
2888
  * - `webhook_declined` - Your application declined the transaction via webhook.
2856
2889
  * - `webhook_timed_out` - Your application webhook did not respond without the
2857
2890
  * required timeout.
@@ -3627,8 +3660,10 @@ export namespace CardPayment {
3627
3660
 
3628
3661
  /**
3629
3662
  * A Card Financial object. This field will be present in the JSON response if and
3630
- * only if `category` is equal to `card_financial`. Card Financials are temporary
3631
- * holds placed on a customer's funds with the intent to later clear a transaction.
3663
+ * only if `category` is equal to `card_financial`. Card Financials are card
3664
+ * transactions that have cleared and settled. Unlike a Card Settlement, which
3665
+ * clears a previous authorization, a Card Financial is authorized and cleared in a
3666
+ * single message.
3632
3667
  */
3633
3668
  export interface CardFinancial {
3634
3669
  /**
@@ -3782,6 +3817,8 @@ export namespace CardPayment {
3782
3817
  * voucher authorization, where funds are credited to the cardholder.
3783
3818
  * - `cash_disbursement` - Cash disbursement transactions are used to withdraw cash
3784
3819
  * from an ATM or a point of sale.
3820
+ * - `cash_deposit` - Cash deposit transactions are used to deposit cash at an ATM
3821
+ * or a point of sale.
3785
3822
  * - `balance_inquiry` - A balance inquiry transaction is used to check the balance
3786
3823
  * of an account associated with a card.
3787
3824
  * - `unknown` - The processing category is unknown.
@@ -3795,6 +3832,7 @@ export namespace CardPayment {
3795
3832
  | 'quasi_cash'
3796
3833
  | 'refund'
3797
3834
  | 'cash_disbursement'
3835
+ | 'cash_deposit'
3798
3836
  | 'balance_inquiry'
3799
3837
  | 'unknown';
3800
3838
 
@@ -218,6 +218,12 @@ export interface CardPushTransfer {
218
218
  */
219
219
  merchant_city_name: string;
220
220
 
221
+ /**
222
+ * The legal business name of the merchant (generally your business) sending the
223
+ * transfer.
224
+ */
225
+ merchant_legal_business_name: string | null;
226
+
221
227
  /**
222
228
  * The merchant name shows up as the statement descriptor for the transfer. This is
223
229
  * typically the name of your business or organization.
@@ -241,6 +247,12 @@ export interface CardPushTransfer {
241
247
  */
242
248
  merchant_state: string;
243
249
 
250
+ /**
251
+ * The street address of the merchant (generally your business) sending the
252
+ * transfer.
253
+ */
254
+ merchant_street_address: string | null;
255
+
244
256
  /**
245
257
  * The amount that was transferred. The receiving bank will have converted this to
246
258
  * the cardholder's currency. The amount that is applied to your Increase account
@@ -248,6 +260,28 @@ export interface CardPushTransfer {
248
260
  */
249
261
  presentment_amount: CardPushTransfer.PresentmentAmount;
250
262
 
263
+ /**
264
+ * The city of the recipient. Required if the card is issued in Canada.
265
+ */
266
+ recipient_address_city: string | null;
267
+
268
+ /**
269
+ * The first line of the recipient's address. Required if the card is issued in
270
+ * Canada.
271
+ */
272
+ recipient_address_line1: string | null;
273
+
274
+ /**
275
+ * The postal code of the recipient. Required if the card is issued in Canada.
276
+ */
277
+ recipient_address_postal_code: string | null;
278
+
279
+ /**
280
+ * The state or province of the recipient. Required if the card is issued in
281
+ * Canada.
282
+ */
283
+ recipient_address_state: string | null;
284
+
251
285
  /**
252
286
  * The name of the funds recipient.
253
287
  */
@@ -149,6 +149,11 @@ export interface Card {
149
149
  */
150
150
  billing_address: Card.BillingAddress;
151
151
 
152
+ /**
153
+ * The Bank Identification Number (BIN) of the Card.
154
+ */
155
+ bin: string;
156
+
152
157
  /**
153
158
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
154
159
  * the Card was created.
@@ -464,7 +464,7 @@ export namespace CheckTransfer {
464
464
  * - `usps_first_class` - USPS First Class
465
465
  * - `fedex_overnight` - FedEx Overnight
466
466
  */
467
- shipping_method: 'usps_first_class' | 'fedex_overnight' | null;
467
+ shipping_method: 'usps_first_class' | 'fedex_overnight';
468
468
 
469
469
  /**
470
470
  * The signature that will appear on the check.
@@ -590,7 +590,9 @@ export namespace CheckTransfer {
590
590
  *
591
591
  * - `in_transit` - The check is in transit.
592
592
  * - `processed_for_delivery` - The check has been processed for delivery.
593
- * - `delivered` - The check has been delivered.
593
+ * - `delivered` - The check has been delivered. Note that some couriers track
594
+ * delivery status based on driver location data rather than an explicit scan.
595
+ * While uncommon, a single check may have more than one delivered event.
594
596
  * - `delivery_issue` - There is an issue preventing delivery. The delivery will be
595
597
  * attempted again if possible. If the issue cannot be resolved, the check will
596
598
  * be returned to sender.
@@ -495,6 +495,8 @@ export namespace DeclinedTransaction {
495
495
  * voucher authorization, where funds are credited to the cardholder.
496
496
  * - `cash_disbursement` - Cash disbursement transactions are used to withdraw cash
497
497
  * from an ATM or a point of sale.
498
+ * - `cash_deposit` - Cash deposit transactions are used to deposit cash at an ATM
499
+ * or a point of sale.
498
500
  * - `balance_inquiry` - A balance inquiry transaction is used to check the balance
499
501
  * of an account associated with a card.
500
502
  * - `unknown` - The processing category is unknown.
@@ -508,6 +510,7 @@ export namespace DeclinedTransaction {
508
510
  | 'quasi_cash'
509
511
  | 'refund'
510
512
  | 'cash_disbursement'
513
+ | 'cash_deposit'
511
514
  | 'balance_inquiry'
512
515
  | 'unknown';
513
516
 
@@ -560,7 +563,8 @@ export namespace DeclinedTransaction {
560
563
  * card's value. Only applies when a CVV2 is present.
561
564
  * - `transaction_not_allowed` - The attempted card transaction is not allowed per
562
565
  * Increase's terms.
563
- * - `breaches_limit` - The transaction was blocked by a Limit.
566
+ * - `breaches_limit` - The transaction was blocked by a limit or an authorization
567
+ * control.
564
568
  * - `webhook_declined` - Your application declined the transaction via webhook.
565
569
  * - `webhook_timed_out` - Your application webhook did not respond without the
566
570
  * required timeout.
@@ -70,6 +70,12 @@ export interface DigitalWalletToken {
70
70
  */
71
71
  created_at: string;
72
72
 
73
+ /**
74
+ * If the Digital Wallet Token was declined during provisioning, details about the
75
+ * decline.
76
+ */
77
+ decline: DigitalWalletToken.Decline | null;
78
+
73
79
  /**
74
80
  * The device that was used to create the Digital Wallet Token.
75
81
  */
@@ -88,8 +94,9 @@ export interface DigitalWalletToken {
88
94
  * activated via two-factor authentication yet.
89
95
  * - `suspended` - The digital wallet token has been temporarily paused.
90
96
  * - `deactivated` - The digital wallet token has been permanently canceled.
97
+ * - `declined` - The digital wallet token was declined during provisioning.
91
98
  */
92
- status: 'active' | 'inactive' | 'suspended' | 'deactivated';
99
+ status: 'active' | 'inactive' | 'suspended' | 'deactivated' | 'declined';
93
100
 
94
101
  /**
95
102
  * The digital wallet app being used.
@@ -124,6 +131,34 @@ export namespace DigitalWalletToken {
124
131
  name: string | null;
125
132
  }
126
133
 
134
+ /**
135
+ * If the Digital Wallet Token was declined during provisioning, details about the
136
+ * decline.
137
+ */
138
+ export interface Decline {
139
+ /**
140
+ * The reason the token provisioning was declined.
141
+ *
142
+ * - `card_not_active` - The card is not active.
143
+ * - `no_verification_method` - The card does not have a two-factor authentication
144
+ * method.
145
+ * - `webhook_timed_out` - Your webhook timed out when evaluating the token
146
+ * provisioning attempt.
147
+ * - `webhook_declined` - Your webhook declined the token provisioning attempt.
148
+ * - `incorrect_card_verification_code` - The tokenization attempt failed because
149
+ * the Card Verification Code (CVC) was incorrect.
150
+ * - `declined_by_token_requestor` - The tokenization attempt was declined by the
151
+ * token requestor.
152
+ */
153
+ reason:
154
+ | 'card_not_active'
155
+ | 'no_verification_method'
156
+ | 'webhook_timed_out'
157
+ | 'webhook_declined'
158
+ | 'incorrect_card_verification_code'
159
+ | 'declined_by_token_requestor';
160
+ }
161
+
127
162
  /**
128
163
  * The device that was used to create the Digital Wallet Token.
129
164
  */
@@ -193,8 +228,9 @@ export namespace DigitalWalletToken {
193
228
  * activated via two-factor authentication yet.
194
229
  * - `suspended` - The digital wallet token has been temporarily paused.
195
230
  * - `deactivated` - The digital wallet token has been permanently canceled.
231
+ * - `declined` - The digital wallet token was declined during provisioning.
196
232
  */
197
- status: 'active' | 'inactive' | 'suspended' | 'deactivated';
233
+ status: 'active' | 'inactive' | 'suspended' | 'deactivated' | 'declined';
198
234
 
199
235
  /**
200
236
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -1147,7 +1147,7 @@ export namespace Entity {
1147
1147
  * The type of issue. We may add additional possible values for this enum over
1148
1148
  * time; your application should be able to handle such additions gracefully.
1149
1149
  *
1150
- * - `entity_tax_identifier` - The entity's tax identifier could not be validated.
1150
+ * - `entity_tax_identifier` - The entity's tax identifier could not be verified.
1151
1151
  * Update the tax ID with the
1152
1152
  * [update an entity API](/documentation/api/entities#update-an-entity.corporation.legal_identifier).
1153
1153
  * - `entity_address` - The entity's address could not be validated. Update the
@@ -252,6 +252,10 @@ export namespace EventSubscription {
252
252
  * Enrollment is updated.
253
253
  * - `intrafi_exclusion.created` - Occurs whenever an IntraFi Exclusion is created.
254
254
  * - `intrafi_exclusion.updated` - Occurs whenever an IntraFi Exclusion is updated.
255
+ * - `loan_application.created` - Occurs whenever a Loan Application is created.
256
+ * - `loan_application.updated` - Occurs whenever a Loan Application is updated.
257
+ * - `loan_offer.created` - Occurs whenever a Loan Offer is created.
258
+ * - `loan_offer.updated` - Occurs whenever a Loan Offer is updated.
255
259
  * - `lockbox.created` - Occurs whenever a Lockbox is created.
256
260
  * - `lockbox.updated` - Occurs whenever a Lockbox is updated.
257
261
  * - `oauth_connection.created` - Occurs whenever an OAuth Connection is created.
@@ -384,6 +388,10 @@ export namespace EventSubscription {
384
388
  | 'intrafi_account_enrollment.updated'
385
389
  | 'intrafi_exclusion.created'
386
390
  | 'intrafi_exclusion.updated'
391
+ | 'loan_application.created'
392
+ | 'loan_application.updated'
393
+ | 'loan_offer.created'
394
+ | 'loan_offer.updated'
387
395
  | 'lockbox.created'
388
396
  | 'lockbox.updated'
389
397
  | 'oauth_connection.created'
@@ -572,6 +580,10 @@ export namespace EventSubscriptionCreateParams {
572
580
  * Enrollment is updated.
573
581
  * - `intrafi_exclusion.created` - Occurs whenever an IntraFi Exclusion is created.
574
582
  * - `intrafi_exclusion.updated` - Occurs whenever an IntraFi Exclusion is updated.
583
+ * - `loan_application.created` - Occurs whenever a Loan Application is created.
584
+ * - `loan_application.updated` - Occurs whenever a Loan Application is updated.
585
+ * - `loan_offer.created` - Occurs whenever a Loan Offer is created.
586
+ * - `loan_offer.updated` - Occurs whenever a Loan Offer is updated.
575
587
  * - `lockbox.created` - Occurs whenever a Lockbox is created.
576
588
  * - `lockbox.updated` - Occurs whenever a Lockbox is updated.
577
589
  * - `oauth_connection.created` - Occurs whenever an OAuth Connection is created.
@@ -704,6 +716,10 @@ export namespace EventSubscriptionCreateParams {
704
716
  | 'intrafi_account_enrollment.updated'
705
717
  | 'intrafi_exclusion.created'
706
718
  | 'intrafi_exclusion.updated'
719
+ | 'loan_application.created'
720
+ | 'loan_application.updated'
721
+ | 'loan_offer.created'
722
+ | 'loan_offer.updated'
707
723
  | 'lockbox.created'
708
724
  | 'lockbox.updated'
709
725
  | 'oauth_connection.created'
@@ -188,6 +188,10 @@ export interface Event {
188
188
  * Enrollment is updated.
189
189
  * - `intrafi_exclusion.created` - Occurs whenever an IntraFi Exclusion is created.
190
190
  * - `intrafi_exclusion.updated` - Occurs whenever an IntraFi Exclusion is updated.
191
+ * - `loan_application.created` - Occurs whenever a Loan Application is created.
192
+ * - `loan_application.updated` - Occurs whenever a Loan Application is updated.
193
+ * - `loan_offer.created` - Occurs whenever a Loan Offer is created.
194
+ * - `loan_offer.updated` - Occurs whenever a Loan Offer is updated.
191
195
  * - `lockbox.created` - Occurs whenever a Lockbox is created.
192
196
  * - `lockbox.updated` - Occurs whenever a Lockbox is updated.
193
197
  * - `oauth_connection.created` - Occurs whenever an OAuth Connection is created.
@@ -320,6 +324,10 @@ export interface Event {
320
324
  | 'intrafi_account_enrollment.updated'
321
325
  | 'intrafi_exclusion.created'
322
326
  | 'intrafi_exclusion.updated'
327
+ | 'loan_application.created'
328
+ | 'loan_application.updated'
329
+ | 'loan_offer.created'
330
+ | 'loan_offer.updated'
323
331
  | 'lockbox.created'
324
332
  | 'lockbox.updated'
325
333
  | 'oauth_connection.created'
@@ -501,6 +509,10 @@ export interface UnwrapWebhookEvent {
501
509
  * Enrollment is updated.
502
510
  * - `intrafi_exclusion.created` - Occurs whenever an IntraFi Exclusion is created.
503
511
  * - `intrafi_exclusion.updated` - Occurs whenever an IntraFi Exclusion is updated.
512
+ * - `loan_application.created` - Occurs whenever a Loan Application is created.
513
+ * - `loan_application.updated` - Occurs whenever a Loan Application is updated.
514
+ * - `loan_offer.created` - Occurs whenever a Loan Offer is created.
515
+ * - `loan_offer.updated` - Occurs whenever a Loan Offer is updated.
504
516
  * - `lockbox.created` - Occurs whenever a Lockbox is created.
505
517
  * - `lockbox.updated` - Occurs whenever a Lockbox is updated.
506
518
  * - `oauth_connection.created` - Occurs whenever an OAuth Connection is created.
@@ -633,6 +645,10 @@ export interface UnwrapWebhookEvent {
633
645
  | 'intrafi_account_enrollment.updated'
634
646
  | 'intrafi_exclusion.created'
635
647
  | 'intrafi_exclusion.updated'
648
+ | 'loan_application.created'
649
+ | 'loan_application.updated'
650
+ | 'loan_offer.created'
651
+ | 'loan_offer.updated'
636
652
  | 'lockbox.created'
637
653
  | 'lockbox.updated'
638
654
  | 'oauth_connection.created'
@@ -774,6 +790,10 @@ export namespace EventListParams {
774
790
  | 'intrafi_account_enrollment.updated'
775
791
  | 'intrafi_exclusion.created'
776
792
  | 'intrafi_exclusion.updated'
793
+ | 'loan_application.created'
794
+ | 'loan_application.updated'
795
+ | 'loan_offer.created'
796
+ | 'loan_offer.updated'
777
797
  | 'lockbox.created'
778
798
  | 'lockbox.updated'
779
799
  | 'oauth_connection.created'
@@ -426,6 +426,16 @@ export namespace Export {
426
426
  * Filter fees created before this time.
427
427
  */
428
428
  before: string | null;
429
+
430
+ /**
431
+ * Filter fees created on or after this time.
432
+ */
433
+ on_or_after: string | null;
434
+
435
+ /**
436
+ * Filter fees created on or before this time.
437
+ */
438
+ on_or_before: string | null;
429
439
  }
430
440
  }
431
441
 
@@ -581,6 +591,8 @@ export interface ExportCreateParams {
581
591
  * management dashboard.
582
592
  * - `account_verification_letter` - A PDF of an account verification letter.
583
593
  * - `funding_instructions` - A PDF of funding instructions.
594
+ * - `fee_csv` - Export a CSV of fees. The time range must not include any fees
595
+ * that are part of an open fee statement.
584
596
  * - `voided_check` - A PDF of a voided check.
585
597
  * - `daily_account_balance_csv` - Export a CSV of daily account balances with
586
598
  * starting and ending balances for a given date range.
@@ -595,6 +607,7 @@ export interface ExportCreateParams {
595
607
  | 'vendor_csv'
596
608
  | 'account_verification_letter'
597
609
  | 'funding_instructions'
610
+ | 'fee_csv'
598
611
  | 'voided_check'
599
612
  | 'daily_account_balance_csv';
600
613
 
@@ -633,6 +646,11 @@ export interface ExportCreateParams {
633
646
  */
634
647
  entity_csv?: ExportCreateParams.EntityCsv;
635
648
 
649
+ /**
650
+ * Options for the created export. Required if `category` is equal to `fee_csv`.
651
+ */
652
+ fee_csv?: ExportCreateParams.FeeCsv;
653
+
636
654
  /**
637
655
  * Options for the created export. Required if `category` is equal to
638
656
  * `funding_instructions`.
@@ -785,6 +803,52 @@ export namespace ExportCreateParams {
785
803
  */
786
804
  export interface EntityCsv {}
787
805
 
806
+ /**
807
+ * Options for the created export. Required if `category` is equal to `fee_csv`.
808
+ */
809
+ export interface FeeCsv {
810
+ /**
811
+ * Filter results by time range on the `created_at` attribute.
812
+ */
813
+ created_at?: FeeCsv.CreatedAt;
814
+
815
+ /**
816
+ * Filter exported Fees to the specified Program.
817
+ */
818
+ program_id?: string;
819
+ }
820
+
821
+ export namespace FeeCsv {
822
+ /**
823
+ * Filter results by time range on the `created_at` attribute.
824
+ */
825
+ export interface CreatedAt {
826
+ /**
827
+ * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
828
+ * timestamp.
829
+ */
830
+ after?: string;
831
+
832
+ /**
833
+ * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
834
+ * timestamp.
835
+ */
836
+ before?: string;
837
+
838
+ /**
839
+ * Return results on or after this
840
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
841
+ */
842
+ on_or_after?: string;
843
+
844
+ /**
845
+ * Return results on or before this
846
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
847
+ */
848
+ on_or_before?: string;
849
+ }
850
+ }
851
+
788
852
  /**
789
853
  * Options for the created export. Required if `category` is equal to
790
854
  * `funding_instructions`.
@@ -151,6 +151,11 @@ export interface FednowTransfer {
151
151
  */
152
152
  currency: 'USD';
153
153
 
154
+ /**
155
+ * The debtor's address.
156
+ */
157
+ debtor_address: FednowTransfer.DebtorAddress | null;
158
+
154
159
  /**
155
160
  * The name of the transfer's sender. If not provided, defaults to the name of the
156
161
  * account's entity.
@@ -347,6 +352,31 @@ export namespace FednowTransfer {
347
352
  state: string | null;
348
353
  }
349
354
 
355
+ /**
356
+ * The debtor's address.
357
+ */
358
+ export interface DebtorAddress {
359
+ /**
360
+ * The city, district, town, or village of the address.
361
+ */
362
+ city: string | null;
363
+
364
+ /**
365
+ * The first line of the address.
366
+ */
367
+ line1: string | null;
368
+
369
+ /**
370
+ * The ZIP code of the address.
371
+ */
372
+ postal_code: string | null;
373
+
374
+ /**
375
+ * The address state.
376
+ */
377
+ state: string | null;
378
+ }
379
+
350
380
  /**
351
381
  * If the transfer is rejected by FedNow or the destination financial institution,
352
382
  * this will contain supplemental details.
@@ -173,6 +173,11 @@ export interface InboundWireTransfer {
173
173
  */
174
174
  instruction_identification: string | null;
175
175
 
176
+ /**
177
+ * The reason for the wire transfer, as set by the sender.
178
+ */
179
+ purpose: string | null;
180
+
176
181
  /**
177
182
  * If the transfer is reversed, this will contain details of the reversal.
178
183
  */
@@ -60,8 +60,6 @@ export interface IntrafiBalance {
60
60
  * `intrafi_balance`.
61
61
  */
62
62
  type: 'intrafi_balance';
63
-
64
- [k: string]: unknown;
65
63
  }
66
64
 
67
65
  export namespace IntrafiBalance {
@@ -87,8 +85,6 @@ export namespace IntrafiBalance {
87
85
  * identify the institution.
88
86
  */
89
87
  fdic_certificate_number: string;
90
-
91
- [k: string]: unknown;
92
88
  }
93
89
 
94
90
  export namespace Balance {