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
@@ -561,6 +561,12 @@ export namespace PendingTransaction {
561
561
  */
562
562
  expires_at: string;
563
563
 
564
+ /**
565
+ * The healthcare-related fields for this authorization. Only present for specific
566
+ * programs.
567
+ */
568
+ healthcare: CardAuthorization.Healthcare | null;
569
+
564
570
  /**
565
571
  * The merchant identifier (commonly abbreviated as MID) of the merchant the card
566
572
  * is transacting with.
@@ -658,6 +664,8 @@ export namespace PendingTransaction {
658
664
  * voucher authorization, where funds are credited to the cardholder.
659
665
  * - `cash_disbursement` - Cash disbursement transactions are used to withdraw cash
660
666
  * from an ATM or a point of sale.
667
+ * - `cash_deposit` - Cash deposit transactions are used to deposit cash at an ATM
668
+ * or a point of sale.
661
669
  * - `balance_inquiry` - A balance inquiry transaction is used to check the balance
662
670
  * of an account associated with a card.
663
671
  * - `unknown` - The processing category is unknown.
@@ -671,6 +679,7 @@ export namespace PendingTransaction {
671
679
  | 'quasi_cash'
672
680
  | 'refund'
673
681
  | 'cash_disbursement'
682
+ | 'cash_deposit'
674
683
  | 'balance_inquiry'
675
684
  | 'unknown';
676
685
 
@@ -945,6 +954,24 @@ export namespace PendingTransaction {
945
954
  }
946
955
  }
947
956
 
957
+ /**
958
+ * The healthcare-related fields for this authorization. Only present for specific
959
+ * programs.
960
+ */
961
+ export interface Healthcare {
962
+ /**
963
+ * The merchant's eligibility under the Internal Revenue Service's 90% Rule for
964
+ * Flexible Spending Account (FSA) and Health Savings Account (HSA) eligible
965
+ * products. The eligibility is determined based on the list of merchants
966
+ * maintained by the Special Interest Group for IIAS Standards (SIGIS).
967
+ *
968
+ * - `eligible` - The merchant is eligible for treatment under the 90% rule.
969
+ * - `not_eligible` - The merchant is not eligible for treatment under the 90%
970
+ * rule.
971
+ */
972
+ merchant_ninety_percent_eligibility: 'eligible' | 'not_eligible';
973
+ }
974
+
948
975
  /**
949
976
  * Fields specific to the `network`.
950
977
  */
@@ -155,6 +155,12 @@ export interface PhysicalCardProfile {
155
155
  */
156
156
  front_image_file_id: string | null;
157
157
 
158
+ /**
159
+ * Text printed on the front of the card. Reach out to
160
+ * [support@increase.com](mailto:support@increase.com) for more information.
161
+ */
162
+ front_text: PhysicalCardProfile.FrontText | null;
163
+
158
164
  /**
159
165
  * The idempotency key you chose for this object. This value is unique across
160
166
  * Increase and is used to ensure that a request is only processed once. Learn more
@@ -199,8 +205,26 @@ export interface PhysicalCardProfile {
199
205
  * `physical_card_profile`.
200
206
  */
201
207
  type: 'physical_card_profile';
208
+ }
202
209
 
203
- [k: string]: unknown;
210
+ export namespace PhysicalCardProfile {
211
+ /**
212
+ * Text printed on the front of the card. Reach out to
213
+ * [support@increase.com](mailto:support@increase.com) for more information.
214
+ */
215
+ export interface FrontText {
216
+ /**
217
+ * The first line of text on the front of the card.
218
+ */
219
+ line1: string;
220
+
221
+ /**
222
+ * The second line of text on the front of the card. Providing a second line moves
223
+ * the first line slightly higher and prints the second line in the spot where the
224
+ * first line would have otherwise been printed.
225
+ */
226
+ line2: string | null;
227
+ }
204
228
  }
205
229
 
206
230
  export interface PhysicalCardProfileCreateParams {
@@ -323,7 +323,10 @@ export namespace PhysicalCard {
323
323
  *
324
324
  * - `in_transit` - The physical card is in transit.
325
325
  * - `processed_for_delivery` - The physical card has been processed for delivery.
326
- * - `delivered` - The physical card has been delivered.
326
+ * - `delivered` - The physical card has been delivered. Note that some couriers
327
+ * track delivery status based on driver location data rather than an explicit
328
+ * scan. While uncommon, a single physical card may have more than one delivered
329
+ * event.
327
330
  * - `delivery_issue` - There is an issue preventing delivery. The delivery will be
328
331
  * attempted again if possible. If the issue cannot be resolved, the physical
329
332
  * card will be returned to sender.
@@ -118,6 +118,8 @@ export namespace Program {
118
118
  * The maximum extendable credit of the program.
119
119
  */
120
120
  maximum_extendable_credit: number;
121
+
122
+ [k: string]: unknown;
121
123
  }
122
124
  }
123
125
 
@@ -647,6 +647,12 @@ export namespace RealTimeDecision {
647
647
  */
648
648
  direction: 'settlement' | 'refund';
649
649
 
650
+ /**
651
+ * The healthcare-related fields for this authorization. Only present for specific
652
+ * programs.
653
+ */
654
+ healthcare: CardAuthorization.Healthcare | null;
655
+
650
656
  /**
651
657
  * The merchant identifier (commonly abbreviated as MID) of the merchant the card
652
658
  * is transacting with.
@@ -749,6 +755,8 @@ export namespace RealTimeDecision {
749
755
  * voucher authorization, where funds are credited to the cardholder.
750
756
  * - `cash_disbursement` - Cash disbursement transactions are used to withdraw cash
751
757
  * from an ATM or a point of sale.
758
+ * - `cash_deposit` - Cash deposit transactions are used to deposit cash at an ATM
759
+ * or a point of sale.
752
760
  * - `balance_inquiry` - A balance inquiry transaction is used to check the balance
753
761
  * of an account associated with a card.
754
762
  * - `unknown` - The processing category is unknown.
@@ -762,6 +770,7 @@ export namespace RealTimeDecision {
762
770
  | 'quasi_cash'
763
771
  | 'refund'
764
772
  | 'cash_disbursement'
773
+ | 'cash_deposit'
765
774
  | 'balance_inquiry'
766
775
  | 'unknown';
767
776
 
@@ -1084,6 +1093,24 @@ export namespace RealTimeDecision {
1084
1093
  | 'other';
1085
1094
  }
1086
1095
 
1096
+ /**
1097
+ * The healthcare-related fields for this authorization. Only present for specific
1098
+ * programs.
1099
+ */
1100
+ export interface Healthcare {
1101
+ /**
1102
+ * The merchant's eligibility under the Internal Revenue Service's 90% Rule for
1103
+ * Flexible Spending Account (FSA) and Health Savings Account (HSA) eligible
1104
+ * products. The eligibility is determined based on the list of merchants
1105
+ * maintained by the Special Interest Group for IIAS Standards (SIGIS).
1106
+ *
1107
+ * - `eligible` - The merchant is eligible for treatment under the 90% rule.
1108
+ * - `not_eligible` - The merchant is not eligible for treatment under the 90%
1109
+ * rule.
1110
+ */
1111
+ merchant_ninety_percent_eligibility: 'eligible' | 'not_eligible';
1112
+ }
1113
+
1087
1114
  /**
1088
1115
  * Fields specific to the `network`.
1089
1116
  */
@@ -125,9 +125,10 @@ export interface ACHTransferCreateNotificationOfChangeParams {
125
125
  *
126
126
  * - `checking` - A checking account.
127
127
  * - `savings` - A savings account.
128
+ * - `loan` - A loan account used in a lender-borrower relationship. Uncommon.
128
129
  * - `general_ledger` - A bank's general ledger. Uncommon.
129
130
  */
130
- corrected_account_funding?: 'checking' | 'savings' | 'general_ledger';
131
+ corrected_account_funding?: 'checking' | 'savings' | 'loan' | 'general_ledger';
131
132
 
132
133
  /**
133
134
  * The corrected account number.
@@ -92,7 +92,8 @@ export interface CardAuthorizationCreateParams {
92
92
  * card's value. Only applies when a CVV2 is present.
93
93
  * - `transaction_not_allowed` - The attempted card transaction is not allowed per
94
94
  * Increase's terms.
95
- * - `breaches_limit` - The transaction was blocked by a Limit.
95
+ * - `breaches_limit` - The transaction was blocked by a limit or an authorization
96
+ * control.
96
97
  * - `webhook_declined` - Your application declined the transaction via webhook.
97
98
  * - `webhook_timed_out` - Your application webhook did not respond without the
98
99
  * required timeout.
@@ -283,6 +284,8 @@ export namespace CardAuthorizationCreateParams {
283
284
  * voucher authorization, where funds are credited to the cardholder.
284
285
  * - `cash_disbursement` - Cash disbursement transactions are used to withdraw cash
285
286
  * from an ATM or a point of sale.
287
+ * - `cash_deposit` - Cash deposit transactions are used to deposit cash at an ATM
288
+ * or a point of sale.
286
289
  * - `balance_inquiry` - A balance inquiry transaction is used to check the balance
287
290
  * of an account associated with a card.
288
291
  */
@@ -295,6 +298,7 @@ export namespace CardAuthorizationCreateParams {
295
298
  | 'quasi_cash'
296
299
  | 'refund'
297
300
  | 'cash_disbursement'
301
+ | 'cash_deposit'
298
302
  | 'balance_inquiry';
299
303
 
300
304
  /**
@@ -52,7 +52,8 @@ export interface CardBalanceInquiryCreateParams {
52
52
  * card's value. Only applies when a CVV2 is present.
53
53
  * - `transaction_not_allowed` - The attempted card transaction is not allowed per
54
54
  * Increase's terms.
55
- * - `breaches_limit` - The transaction was blocked by a Limit.
55
+ * - `breaches_limit` - The transaction was blocked by a limit or an authorization
56
+ * control.
56
57
  * - `webhook_declined` - Your application declined the transaction via webhook.
57
58
  * - `webhook_timed_out` - Your application webhook did not respond without the
58
59
  * required timeout.
@@ -119,6 +119,7 @@ export interface CheckDepositAdjustmentParams {
119
119
  export interface CheckDepositSubmitParams {
120
120
  /**
121
121
  * If set, the simulation will use these values for the check's scanned MICR data.
122
+ * If not set, the simulation will use random values.
122
123
  */
123
124
  scan?: CheckDepositSubmitParams.Scan;
124
125
  }
@@ -126,6 +127,7 @@ export interface CheckDepositSubmitParams {
126
127
  export namespace CheckDepositSubmitParams {
127
128
  /**
128
129
  * If set, the simulation will use these values for the check's scanned MICR data.
130
+ * If not set, the simulation will use random values.
129
131
  */
130
132
  export interface Scan {
131
133
  /**
@@ -140,8 +142,15 @@ export namespace CheckDepositSubmitParams {
140
142
 
141
143
  /**
142
144
  * The auxiliary on-us data to be returned in the check deposit's scan data.
145
+ * Auxiliary on-us is typically the check number for business checks.
143
146
  */
144
147
  auxiliary_on_us?: string;
148
+
149
+ /**
150
+ * The serial number to be returned in the check deposit's scan data. Serial number
151
+ * is typically the check number for consumer checks.
152
+ */
153
+ serial_number?: string;
145
154
  }
146
155
  }
147
156
 
@@ -39,12 +39,18 @@ export interface DigitalWalletTokenRequestCreateResponse {
39
39
  * - `webhook_timed_out` - Your webhook timed out when evaluating the token
40
40
  * provisioning attempt.
41
41
  * - `webhook_declined` - Your webhook declined the token provisioning attempt.
42
+ * - `incorrect_card_verification_code` - The tokenization attempt failed because
43
+ * the Card Verification Code (CVC) was incorrect.
44
+ * - `declined_by_token_requestor` - The tokenization attempt was declined by the
45
+ * token requestor.
42
46
  */
43
47
  decline_reason:
44
48
  | 'card_not_active'
45
49
  | 'no_verification_method'
46
50
  | 'webhook_timed_out'
47
51
  | 'webhook_declined'
52
+ | 'incorrect_card_verification_code'
53
+ | 'declined_by_token_requestor'
48
54
  | null;
49
55
 
50
56
  /**
@@ -46,7 +46,7 @@ export namespace EntityUpdateValidationParams {
46
46
  /**
47
47
  * The type of issue.
48
48
  *
49
- * - `entity_tax_identifier` - The entity's tax identifier could not be validated.
49
+ * - `entity_tax_identifier` - The entity's tax identifier could not be verified.
50
50
  * Update the tax ID with the
51
51
  * [update an entity API](/documentation/api/entities#update-an-entity.corporation.legal_identifier).
52
52
  * - `entity_address` - The entity's address could not be validated. Update the
@@ -104,6 +104,12 @@ export interface InboundWireTransferCreateParams {
104
104
  */
105
105
  instruction_identification?: string;
106
106
 
107
+ /**
108
+ * The sending bank will set purpose in production. You can simulate any value
109
+ * here.
110
+ */
111
+ purpose?: string;
112
+
107
113
  /**
108
114
  * The sending bank will set unique_end_to_end_transaction_reference in production.
109
115
  * You can simulate any value here.
@@ -63,7 +63,10 @@ export interface PhysicalCardCreateParams {
63
63
  *
64
64
  * - `in_transit` - The physical card is in transit.
65
65
  * - `processed_for_delivery` - The physical card has been processed for delivery.
66
- * - `delivered` - The physical card has been delivered.
66
+ * - `delivered` - The physical card has been delivered. Note that some couriers
67
+ * track delivery status based on driver location data rather than an explicit
68
+ * scan. While uncommon, a single physical card may have more than one delivered
69
+ * event.
67
70
  * - `delivery_issue` - There is an issue preventing delivery. The delivery will be
68
71
  * attempted again if possible. If the issue cannot be resolved, the physical
69
72
  * card will be returned to sender.
@@ -49,6 +49,8 @@ export interface ProgramCreateParams {
49
49
  * The identifier of the Account the Program should be added to is for.
50
50
  */
51
51
  reserve_account_id?: string;
52
+
53
+ [k: string]: unknown;
52
54
  }
53
55
 
54
56
  export declare namespace Programs {
@@ -15,7 +15,7 @@ export class SwiftTransfers extends APIResource {
15
15
  * const swiftTransfer = await client.swiftTransfers.create({
16
16
  * account_id: 'account_in71c4amph0vgo2qllky',
17
17
  * account_number: '987654321',
18
- * bank_identification_code: 'ECBFDEFFTPP',
18
+ * bank_identification_code: 'FRNYUS33XXX',
19
19
  * creditor_address: {
20
20
  * city: 'Frankfurt',
21
21
  * country: 'DE',
@@ -65,8 +65,8 @@ export interface Transaction {
65
65
  amount: number;
66
66
 
67
67
  /**
68
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
69
- * Transaction occurred.
68
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
69
+ * the Transaction occurred.
70
70
  */
71
71
  created_at: string;
72
72
 
@@ -329,8 +329,10 @@ export namespace Transaction {
329
329
 
330
330
  /**
331
331
  * A Card Financial object. This field will be present in the JSON response if and
332
- * only if `category` is equal to `card_financial`. Card Financials are temporary
333
- * holds placed on a customer's funds with the intent to later clear a transaction.
332
+ * only if `category` is equal to `card_financial`. Card Financials are card
333
+ * transactions that have cleared and settled. Unlike a Card Settlement, which
334
+ * clears a previous authorization, a Card Financial is authorized and cleared in a
335
+ * single message.
334
336
  */
335
337
  card_financial?: Source.CardFinancial | null;
336
338
 
@@ -1100,8 +1102,10 @@ export namespace Transaction {
1100
1102
 
1101
1103
  /**
1102
1104
  * A Card Financial object. This field will be present in the JSON response if and
1103
- * only if `category` is equal to `card_financial`. Card Financials are temporary
1104
- * holds placed on a customer's funds with the intent to later clear a transaction.
1105
+ * only if `category` is equal to `card_financial`. Card Financials are card
1106
+ * transactions that have cleared and settled. Unlike a Card Settlement, which
1107
+ * clears a previous authorization, a Card Financial is authorized and cleared in a
1108
+ * single message.
1105
1109
  */
1106
1110
  export interface CardFinancial {
1107
1111
  /**
@@ -1255,6 +1259,8 @@ export namespace Transaction {
1255
1259
  * voucher authorization, where funds are credited to the cardholder.
1256
1260
  * - `cash_disbursement` - Cash disbursement transactions are used to withdraw cash
1257
1261
  * from an ATM or a point of sale.
1262
+ * - `cash_deposit` - Cash deposit transactions are used to deposit cash at an ATM
1263
+ * or a point of sale.
1258
1264
  * - `balance_inquiry` - A balance inquiry transaction is used to check the balance
1259
1265
  * of an account associated with a card.
1260
1266
  * - `unknown` - The processing category is unknown.
@@ -1268,6 +1274,7 @@ export namespace Transaction {
1268
1274
  | 'quasi_cash'
1269
1275
  | 'refund'
1270
1276
  | 'cash_disbursement'
1277
+ | 'cash_deposit'
1271
1278
  | 'balance_inquiry'
1272
1279
  | 'unknown';
1273
1280
 
@@ -4615,6 +4622,11 @@ export namespace Transaction {
4615
4622
  */
4616
4623
  instruction_identification: string | null;
4617
4624
 
4625
+ /**
4626
+ * The reason for the wire transfer, as set by the sender.
4627
+ */
4628
+ purpose: string | null;
4629
+
4618
4630
  /**
4619
4631
  * The ID of the Inbound Wire Transfer object that resulted in this Transaction.
4620
4632
  */
@@ -148,6 +148,12 @@ export interface WireDrawdownRequest {
148
148
  */
149
149
  debtor_routing_number: string;
150
150
 
151
+ /**
152
+ * A free-form reference string set by the sender, to be mirrored back in the
153
+ * subsequent wire transfer.
154
+ */
155
+ end_to_end_identification: string | null;
156
+
151
157
  /**
152
158
  * If the recipient fulfills the drawdown request by sending funds, then this will
153
159
  * be the identifier of the corresponding Transaction.
@@ -185,6 +191,13 @@ export interface WireDrawdownRequest {
185
191
  */
186
192
  type: 'wire_drawdown_request';
187
193
 
194
+ /**
195
+ * The unique end-to-end transaction reference
196
+ * ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
197
+ * of the drawdown request.
198
+ */
199
+ unique_end_to_end_transaction_reference: string | null;
200
+
188
201
  /**
189
202
  * Remittance information the debtor will see as part of the drawdown request.
190
203
  */
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.568.2'; // x-release-please-version
1
+ export const VERSION = '0.570.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.568.2";
1
+ export declare const VERSION = "0.570.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.568.2";
1
+ export declare const VERSION = "0.570.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.568.2'; // x-release-please-version
4
+ exports.VERSION = '0.570.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.568.2'; // x-release-please-version
1
+ export const VERSION = '0.570.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map