increase 0.10.0 → 0.10.2

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 (166) hide show
  1. package/CHANGELOG.md +32 -0
  2. package/_shims/fetch.d.ts +1 -0
  3. package/_shims/fetch.node.d.ts +1 -0
  4. package/core.d.ts +6 -3
  5. package/core.d.ts.map +1 -1
  6. package/core.js +14 -7
  7. package/core.js.map +1 -1
  8. package/core.mjs +14 -7
  9. package/core.mjs.map +1 -1
  10. package/index.d.mts +9 -4
  11. package/index.d.ts +9 -4
  12. package/index.d.ts.map +1 -1
  13. package/index.js +6 -3
  14. package/index.js.map +1 -1
  15. package/index.mjs +6 -3
  16. package/index.mjs.map +1 -1
  17. package/package.json +1 -1
  18. package/resources/account-transfers.d.ts +8 -1
  19. package/resources/account-transfers.d.ts.map +1 -1
  20. package/resources/account-transfers.js.map +1 -1
  21. package/resources/account-transfers.mjs.map +1 -1
  22. package/resources/ach-prenotifications.d.ts +2 -2
  23. package/resources/ach-transfers.d.ts +11 -4
  24. package/resources/ach-transfers.d.ts.map +1 -1
  25. package/resources/ach-transfers.js.map +1 -1
  26. package/resources/ach-transfers.mjs.map +1 -1
  27. package/resources/card-purchase-supplements.d.ts +1 -1
  28. package/resources/check-transfers.d.ts +6 -3
  29. package/resources/check-transfers.d.ts.map +1 -1
  30. package/resources/check-transfers.js.map +1 -1
  31. package/resources/check-transfers.mjs.map +1 -1
  32. package/resources/declined-transactions.d.ts +90 -16
  33. package/resources/declined-transactions.d.ts.map +1 -1
  34. package/resources/declined-transactions.js.map +1 -1
  35. package/resources/declined-transactions.mjs.map +1 -1
  36. package/resources/digital-wallet-tokens.d.ts +1 -1
  37. package/resources/entities/beneficial-owners.d.ts +24 -5
  38. package/resources/entities/beneficial-owners.d.ts.map +1 -1
  39. package/resources/entities/beneficial-owners.js +8 -2
  40. package/resources/entities/beneficial-owners.js.map +1 -1
  41. package/resources/entities/beneficial-owners.mjs +8 -2
  42. package/resources/entities/beneficial-owners.mjs.map +1 -1
  43. package/resources/entities/entities.d.ts +19 -14
  44. package/resources/entities/entities.d.ts.map +1 -1
  45. package/resources/entities/entities.js.map +1 -1
  46. package/resources/entities/entities.mjs.map +1 -1
  47. package/resources/entities/index.d.ts +5 -1
  48. package/resources/entities/index.d.ts.map +1 -1
  49. package/resources/entities/index.js.map +1 -1
  50. package/resources/entities/index.mjs.map +1 -1
  51. package/resources/entities/supplemental-documents.d.ts +1 -1
  52. package/resources/entities/supplemental-documents.js +1 -1
  53. package/resources/entities/supplemental-documents.mjs +1 -1
  54. package/resources/event-subscriptions.d.ts +22 -10
  55. package/resources/event-subscriptions.d.ts.map +1 -1
  56. package/resources/event-subscriptions.js.map +1 -1
  57. package/resources/event-subscriptions.mjs.map +1 -1
  58. package/resources/events.d.ts +13 -5
  59. package/resources/events.d.ts.map +1 -1
  60. package/resources/events.js.map +1 -1
  61. package/resources/events.mjs.map +1 -1
  62. package/resources/external-accounts.d.ts +2 -2
  63. package/resources/inbound-ach-transfer-returns.d.ts +1 -47
  64. package/resources/inbound-ach-transfer-returns.d.ts.map +1 -1
  65. package/resources/inbound-ach-transfer-returns.js +0 -6
  66. package/resources/inbound-ach-transfer-returns.js.map +1 -1
  67. package/resources/inbound-ach-transfer-returns.mjs +0 -6
  68. package/resources/inbound-ach-transfer-returns.mjs.map +1 -1
  69. package/resources/inbound-ach-transfers.d.ts +303 -0
  70. package/resources/inbound-ach-transfers.d.ts.map +1 -0
  71. package/resources/inbound-ach-transfers.js +40 -0
  72. package/resources/inbound-ach-transfers.js.map +1 -0
  73. package/resources/inbound-ach-transfers.mjs +33 -0
  74. package/resources/inbound-ach-transfers.mjs.map +1 -0
  75. package/resources/index.d.ts +7 -2
  76. package/resources/index.d.ts.map +1 -1
  77. package/resources/index.js +16 -29
  78. package/resources/index.js.map +1 -1
  79. package/resources/index.mjs +1 -1
  80. package/resources/index.mjs.map +1 -1
  81. package/resources/pending-transactions.d.ts +50 -8
  82. package/resources/pending-transactions.d.ts.map +1 -1
  83. package/resources/pending-transactions.js.map +1 -1
  84. package/resources/pending-transactions.mjs.map +1 -1
  85. package/resources/real-time-decisions.d.ts +28 -4
  86. package/resources/real-time-decisions.d.ts.map +1 -1
  87. package/resources/real-time-decisions.js.map +1 -1
  88. package/resources/real-time-decisions.mjs.map +1 -1
  89. package/resources/real-time-payments-transfers.d.ts +49 -42
  90. package/resources/real-time-payments-transfers.d.ts.map +1 -1
  91. package/resources/real-time-payments-transfers.js +2 -2
  92. package/resources/real-time-payments-transfers.js.map +1 -1
  93. package/resources/real-time-payments-transfers.mjs +2 -2
  94. package/resources/real-time-payments-transfers.mjs.map +1 -1
  95. package/resources/routing-numbers.d.ts +1 -1
  96. package/resources/simulations/ach-transfers.d.ts +91 -33
  97. package/resources/simulations/ach-transfers.d.ts.map +1 -1
  98. package/resources/simulations/ach-transfers.js.map +1 -1
  99. package/resources/simulations/ach-transfers.mjs.map +1 -1
  100. package/resources/simulations/cards.d.ts +106 -23
  101. package/resources/simulations/cards.d.ts.map +1 -1
  102. package/resources/simulations/cards.js.map +1 -1
  103. package/resources/simulations/cards.mjs.map +1 -1
  104. package/resources/simulations/inbound-wire-drawdown-requests.d.ts +1 -1
  105. package/resources/simulations/inbound-wire-drawdown-requests.js +1 -1
  106. package/resources/simulations/inbound-wire-drawdown-requests.mjs +1 -1
  107. package/resources/simulations/interest-payments.d.ts +16 -16
  108. package/resources/simulations/interest-payments.d.ts.map +1 -1
  109. package/resources/simulations/real-time-payments-transfers.d.ts +122 -64
  110. package/resources/simulations/real-time-payments-transfers.d.ts.map +1 -1
  111. package/resources/simulations/real-time-payments-transfers.js +2 -2
  112. package/resources/simulations/real-time-payments-transfers.js.map +1 -1
  113. package/resources/simulations/real-time-payments-transfers.mjs +2 -2
  114. package/resources/simulations/real-time-payments-transfers.mjs.map +1 -1
  115. package/resources/simulations/wire-transfers.d.ts +16 -16
  116. package/resources/simulations/wire-transfers.d.ts.map +1 -1
  117. package/resources/transactions.d.ts +16 -16
  118. package/resources/transactions.d.ts.map +1 -1
  119. package/resources/wire-transfers.d.ts +9 -2
  120. package/resources/wire-transfers.d.ts.map +1 -1
  121. package/resources/wire-transfers.js.map +1 -1
  122. package/resources/wire-transfers.mjs.map +1 -1
  123. package/src/_shims/fetch.d.ts +1 -0
  124. package/src/_shims/fetch.node.d.ts +1 -0
  125. package/src/core.ts +19 -7
  126. package/src/index.ts +12 -6
  127. package/src/resources/account-transfers.ts +9 -1
  128. package/src/resources/ach-prenotifications.ts +2 -2
  129. package/src/resources/ach-transfers.ts +12 -4
  130. package/src/resources/card-purchase-supplements.ts +1 -1
  131. package/src/resources/check-transfers.ts +6 -3
  132. package/src/resources/declined-transactions.ts +94 -16
  133. package/src/resources/digital-wallet-tokens.ts +1 -1
  134. package/src/resources/entities/beneficial-owners.ts +31 -6
  135. package/src/resources/entities/entities.ts +20 -14
  136. package/src/resources/entities/index.ts +5 -1
  137. package/src/resources/entities/supplemental-documents.ts +1 -1
  138. package/src/resources/event-subscriptions.ts +22 -10
  139. package/src/resources/events.ts +13 -5
  140. package/src/resources/external-accounts.ts +2 -2
  141. package/src/resources/inbound-ach-transfer-returns.ts +1 -52
  142. package/src/resources/inbound-ach-transfers.ts +359 -0
  143. package/src/resources/index.ts +7 -2
  144. package/src/resources/pending-transactions.ts +52 -8
  145. package/src/resources/real-time-decisions.ts +28 -4
  146. package/src/resources/real-time-payments-transfers.ts +50 -42
  147. package/src/resources/routing-numbers.ts +1 -1
  148. package/src/resources/simulations/ach-transfers.ts +93 -33
  149. package/src/resources/simulations/cards.ts +108 -23
  150. package/src/resources/simulations/inbound-wire-drawdown-requests.ts +1 -1
  151. package/src/resources/simulations/interest-payments.ts +16 -16
  152. package/src/resources/simulations/real-time-payments-transfers.ts +124 -64
  153. package/src/resources/simulations/wire-transfers.ts +16 -16
  154. package/src/resources/transactions.ts +16 -16
  155. package/src/resources/wire-transfers.ts +10 -2
  156. package/src/version.ts +1 -1
  157. package/version.d.ts +1 -1
  158. package/version.js +1 -1
  159. package/version.mjs +1 -1
  160. package/resources/shared.d.ts +0 -31
  161. package/resources/shared.d.ts.map +0 -1
  162. package/resources/shared.js +0 -4
  163. package/resources/shared.js.map +0 -1
  164. package/resources/shared.mjs +0 -3
  165. package/resources/shared.mjs.map +0 -1
  166. package/src/resources/shared.ts +0 -32
@@ -8,7 +8,7 @@ import { Page, PageParams } from '../pagination';
8
8
 
9
9
  export class RealTimePaymentsTransfers extends APIResource {
10
10
  /**
11
- * Create a Real Time Payments Transfer
11
+ * Create a Real-Time Payments Transfer
12
12
  */
13
13
  create(
14
14
  body: RealTimePaymentsTransferCreateParams,
@@ -18,7 +18,7 @@ export class RealTimePaymentsTransfers extends APIResource {
18
18
  }
19
19
 
20
20
  /**
21
- * Retrieve a Real Time Payments Transfer
21
+ * Retrieve a Real-Time Payments Transfer
22
22
  */
23
23
  retrieve(
24
24
  realTimePaymentsTransferId: string,
@@ -28,7 +28,7 @@ export class RealTimePaymentsTransfers extends APIResource {
28
28
  }
29
29
 
30
30
  /**
31
- * List Real Time Payments Transfers
31
+ * List Real-Time Payments Transfers
32
32
  */
33
33
  list(
34
34
  query?: RealTimePaymentsTransferListParams,
@@ -56,12 +56,12 @@ export class RealTimePaymentsTransfersPage extends Page<RealTimePaymentsTransfer
56
56
  type _RealTimePaymentsTransfersPage = RealTimePaymentsTransfersPage;
57
57
 
58
58
  /**
59
- * Real Time Payments transfers move funds, within seconds, between your Increase
60
- * account and any other account on the Real Time Payments network.
59
+ * Real-Time Payments transfers move funds, within seconds, between your Increase
60
+ * account and any other account on the Real-Time Payments network.
61
61
  */
62
62
  export interface RealTimePaymentsTransfer {
63
63
  /**
64
- * The Real Time Payments Transfer's identifier.
64
+ * The Real-Time Payments Transfer's identifier.
65
65
  */
66
66
  id: string;
67
67
 
@@ -100,7 +100,7 @@ export interface RealTimePaymentsTransfer {
100
100
 
101
101
  /**
102
102
  * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
103
- * currency. For real time payments transfers this is always equal to `USD`.
103
+ * currency. For real-time payments transfers this is always equal to `USD`.
104
104
  *
105
105
  * - `CAD` - Canadian Dollar (CAD)
106
106
  * - `CHF` - Swiss Franc (CHF)
@@ -128,7 +128,15 @@ export interface RealTimePaymentsTransfer {
128
128
  external_account_id: string | null;
129
129
 
130
130
  /**
131
- * If the transfer is rejected by Real Time Payments or the destination financial
131
+ * The ID for the pending transaction representing the transfer. A pending
132
+ * transaction is created when the transfer
133
+ * [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
134
+ * by someone else in your organization.
135
+ */
136
+ pending_transaction_id: string | null;
137
+
138
+ /**
139
+ * If the transfer is rejected by Real-Time Payments or the destination financial
132
140
  * institution, this will contain supplemental details.
133
141
  */
134
142
  rejection: RealTimePaymentsTransfer.Rejection | null;
@@ -148,10 +156,10 @@ export interface RealTimePaymentsTransfer {
148
156
  *
149
157
  * - `pending_approval` - The transfer is pending approval.
150
158
  * - `canceled` - The transfer has been canceled.
151
- * - `pending_submission` - The transfer is queued to be submitted to Real Time
159
+ * - `pending_submission` - The transfer is queued to be submitted to Real-Time
152
160
  * Payments.
153
161
  * - `submitted` - The transfer has been submitted and is pending a response from
154
- * Real Time Payments.
162
+ * Real-Time Payments.
155
163
  * - `complete` - The transfer has been sent successfully and is complete.
156
164
  * - `rejected` - The transfer was rejected by the network or the recipient's bank.
157
165
  * - `requires_attention` - The transfer requires attention from an Increase
@@ -167,7 +175,7 @@ export interface RealTimePaymentsTransfer {
167
175
  | 'requires_attention';
168
176
 
169
177
  /**
170
- * After the transfer is submitted to Real Time Payments, this will contain
178
+ * After the transfer is submitted to Real-Time Payments, this will contain
171
179
  * supplemental details.
172
180
  */
173
181
  submission: RealTimePaymentsTransfer.Submission | null;
@@ -227,7 +235,7 @@ export namespace RealTimePaymentsTransfer {
227
235
  }
228
236
 
229
237
  /**
230
- * If the transfer is rejected by Real Time Payments or the destination financial
238
+ * If the transfer is rejected by Real-Time Payments or the destination financial
231
239
  * institution, this will contain supplemental details.
232
240
  */
233
241
  export interface Rejection {
@@ -239,52 +247,52 @@ export namespace RealTimePaymentsTransfer {
239
247
 
240
248
  /**
241
249
  * The reason the transfer was rejected as provided by the recipient bank or the
242
- * Real Time Payments network.
250
+ * Real-Time Payments network.
243
251
  *
244
- * - `account_closed` - The destination account is closed. Corresponds to the Real
245
- * Time Payments reason code `AC04`.
252
+ * - `account_closed` - The destination account is closed. Corresponds to the
253
+ * Real-Time Payments reason code `AC04`.
246
254
  * - `account_blocked` - The destination account is currently blocked from
247
- * receiving transactions. Corresponds to the Real Time Payments reason code
255
+ * receiving transactions. Corresponds to the Real-Time Payments reason code
248
256
  * `AC06`.
249
257
  * - `invalid_creditor_account_type` - The destination account is ineligible to
250
- * receive Real Time Payments transfers. Corresponds to the Real Time Payments
258
+ * receive Real-Time Payments transfers. Corresponds to the Real-Time Payments
251
259
  * reason code `AC14`.
252
260
  * - `invalid_creditor_account_number` - The destination account does not exist.
253
- * Corresponds to the Real Time Payments reason code `AC03`.
261
+ * Corresponds to the Real-Time Payments reason code `AC03`.
254
262
  * - `invalid_creditor_financial_institution_identifier` - The destination routing
255
- * number is invalid. Corresponds to the Real Time Payments reason code `RC04`.
263
+ * number is invalid. Corresponds to the Real-Time Payments reason code `RC04`.
256
264
  * - `end_customer_deceased` - The destination account holder is deceased.
257
- * Corresponds to the Real Time Payments reason code `MD07`.
265
+ * Corresponds to the Real-Time Payments reason code `MD07`.
258
266
  * - `narrative` - The reason is provided as narrative information in the
259
267
  * additional information field.
260
- * - `transaction_forbidden` - Real Time Payments transfers are not allowed to the
261
- * destination account. Corresponds to the Real Time Payments reason code `AG01`.
262
- * - `transaction_type_not_supported` - Real Time Payments transfers are not
263
- * enabled for the destination account. Corresponds to the Real Time Payments
268
+ * - `transaction_forbidden` - Real-Time Payments transfers are not allowed to the
269
+ * destination account. Corresponds to the Real-Time Payments reason code `AG01`.
270
+ * - `transaction_type_not_supported` - Real-Time Payments transfers are not
271
+ * enabled for the destination account. Corresponds to the Real-Time Payments
264
272
  * reason code `AG03`.
265
273
  * - `unexpected_amount` - The amount of the transfer is different than expected by
266
- * the recipient. Corresponds to the Real Time Payments reason code `AM09`.
274
+ * the recipient. Corresponds to the Real-Time Payments reason code `AM09`.
267
275
  * - `amount_exceeds_bank_limits` - The amount is higher than the recipient is
268
- * authorized to send or receive. Corresponds to the Real Time Payments reason
276
+ * authorized to send or receive. Corresponds to the Real-Time Payments reason
269
277
  * code `AM14`.
270
278
  * - `invalid_creditor_address` - The creditor's address is required, but missing
271
- * or invalid. Corresponds to the Real Time Payments reason code `BE04`.
279
+ * or invalid. Corresponds to the Real-Time Payments reason code `BE04`.
272
280
  * - `unknown_end_customer` - The specified creditor is unknown. Corresponds to the
273
- * Real Time Payments reason code `BE06`.
281
+ * Real-Time Payments reason code `BE06`.
274
282
  * - `invalid_debtor_address` - The debtor's address is required, but missing or
275
- * invalid. Corresponds to the Real Time Payments reason code `BE07`.
283
+ * invalid. Corresponds to the Real-Time Payments reason code `BE07`.
276
284
  * - `timeout` - There was a timeout processing the transfer. Corresponds to the
277
- * Real Time Payments reason code `DS24`.
278
- * - `unsupported_message_for_recipient` - Real Time Payments transfers are not
279
- * enabled for the destination account. Corresponds to the Real Time Payments
285
+ * Real-Time Payments reason code `DS24`.
286
+ * - `unsupported_message_for_recipient` - Real-Time Payments transfers are not
287
+ * enabled for the destination account. Corresponds to the Real-Time Payments
280
288
  * reason code `NOAT`.
281
289
  * - `recipient_connection_not_available` - The destination financial institution
282
- * is currently not connected to Real Time Payments. Corresponds to the Real Time
290
+ * is currently not connected to Real-Time Payments. Corresponds to the Real-Time
283
291
  * Payments reason code `9912`.
284
- * - `real_time_payments_suspended` - Real Time Payments is currently unavailable.
285
- * Corresponds to the Real Time Payments reason code `9948`.
292
+ * - `real_time_payments_suspended` - Real-Time Payments is currently unavailable.
293
+ * Corresponds to the Real-Time Payments reason code `9948`.
286
294
  * - `instructed_agent_signed_off` - The destination financial institution is
287
- * currently signed off of Real Time Payments. Corresponds to the Real Time
295
+ * currently signed off of Real-Time Payments. Corresponds to the Real-Time
288
296
  * Payments reason code `9910`.
289
297
  * - `processing_error` - The transfer was rejected due to an internal Increase
290
298
  * issue. We have been notified.
@@ -321,7 +329,7 @@ export namespace RealTimePaymentsTransfer {
321
329
  }
322
330
 
323
331
  /**
324
- * After the transfer is submitted to Real Time Payments, this will contain
332
+ * After the transfer is submitted to Real-Time Payments, this will contain
325
333
  * supplemental details.
326
334
  */
327
335
  export interface Submission {
@@ -332,7 +340,7 @@ export namespace RealTimePaymentsTransfer {
332
340
  submitted_at: string | null;
333
341
 
334
342
  /**
335
- * The Real Time Payments network identification of the transfer.
343
+ * The Real-Time Payments network identification of the transfer.
336
344
  */
337
345
  transaction_identification: string;
338
346
  }
@@ -340,7 +348,7 @@ export namespace RealTimePaymentsTransfer {
340
348
 
341
349
  export interface RealTimePaymentsTransferCreateParams {
342
350
  /**
343
- * The transfer amount in USD cents. For Real Time Payments transfers, must be
351
+ * The transfer amount in USD cents. For Real-Time Payments transfers, must be
344
352
  * positive.
345
353
  */
346
354
  amount: number;
@@ -384,7 +392,7 @@ export interface RealTimePaymentsTransferCreateParams {
384
392
  require_approval?: boolean;
385
393
 
386
394
  /**
387
- * A unique identifier you choose for the transfer. Reusing this identifer for
395
+ * A unique identifier you choose for the transfer. Reusing this identifier for
388
396
  * another transfer will result in an error. You can query for the transfer
389
397
  * associated with this identifier using the List endpoint.
390
398
  */
@@ -393,14 +401,14 @@ export interface RealTimePaymentsTransferCreateParams {
393
401
 
394
402
  export interface RealTimePaymentsTransferListParams extends PageParams {
395
403
  /**
396
- * Filter Real Time Payments Transfers to those belonging to the specified Account.
404
+ * Filter Real-Time Payments Transfers to those belonging to the specified Account.
397
405
  */
398
406
  account_id?: string;
399
407
 
400
408
  created_at?: RealTimePaymentsTransferListParams.CreatedAt;
401
409
 
402
410
  /**
403
- * Filter Real Time Payments Transfers to those made to the specified External
411
+ * Filter Real-Time Payments Transfers to those made to the specified External
404
412
  * Account.
405
413
  */
406
414
  external_account_id?: string;
@@ -42,7 +42,7 @@ export interface RoutingNumber {
42
42
  name: string;
43
43
 
44
44
  /**
45
- * This routing number's support for Real Time Payments Transfers.
45
+ * This routing number's support for Real-Time Payments Transfers.
46
46
  *
47
47
  * - `supported` - The routing number can receive this transfer type.
48
48
  * - `not_supported` - The routing number cannot receive this transfer type.
@@ -3,7 +3,6 @@
3
3
  import * as Core from '../../core';
4
4
  import { APIResource } from '../../resource';
5
5
  import * as ACHTransfers_ from '../ach-transfers';
6
- import * as Shared from '../shared';
7
6
  import * as API from './index';
8
7
 
9
8
  export class ACHTransfers extends APIResource {
@@ -98,14 +97,14 @@ export namespace ACHTransferSimulation {
98
97
 
99
98
  /**
100
99
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
101
- * Transaction occured.
100
+ * Transaction occurred.
102
101
  */
103
102
  created_at: string;
104
103
 
105
104
  /**
106
105
  * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined
107
106
  * Transaction's currency. This will match the currency on the Declined
108
- * Transcation's Account.
107
+ * Transaction's Account.
109
108
  *
110
109
  * - `CAD` - Canadian Dollar (CAD)
111
110
  * - `CHF` - Swiss Franc (CHF)
@@ -181,7 +180,7 @@ export namespace ACHTransferSimulation {
181
180
  * object.
182
181
  * - `check_decline` - Check Decline: details will be under the `check_decline`
183
182
  * object.
184
- * - `inbound_real_time_payments_transfer_decline` - Inbound Real Time Payments
183
+ * - `inbound_real_time_payments_transfer_decline` - Inbound Real-Time Payments
185
184
  * Transfer Decline: details will be under the
186
185
  * `inbound_real_time_payments_transfer_decline` object.
187
186
  * - `international_ach_decline` - International ACH Decline: details will be under
@@ -207,7 +206,7 @@ export namespace ACHTransferSimulation {
207
206
  check_decline: Source.CheckDecline | null;
208
207
 
209
208
  /**
210
- * An Inbound Real Time Payments Transfer Decline object. This field will be
209
+ * An Inbound Real-Time Payments Transfer Decline object. This field will be
211
210
  * present in the JSON response if and only if `category` is equal to
212
211
  * `inbound_real_time_payments_transfer_decline`.
213
212
  */
@@ -232,18 +231,35 @@ export namespace ACHTransferSimulation {
232
231
  * only if `category` is equal to `ach_decline`.
233
232
  */
234
233
  export interface ACHDecline {
234
+ /**
235
+ * The ACH Decline's identifier.
236
+ */
237
+ id: string;
238
+
235
239
  /**
236
240
  * The declined amount in the minor unit of the destination account currency. For
237
241
  * dollars, for example, this is cents.
238
242
  */
239
243
  amount: number;
240
244
 
245
+ /**
246
+ * The descriptive date of the transfer.
247
+ */
241
248
  originator_company_descriptive_date: string | null;
242
249
 
250
+ /**
251
+ * The additional information included with the transfer.
252
+ */
243
253
  originator_company_discretionary_data: string | null;
244
254
 
255
+ /**
256
+ * The identifier of the company that initiated the transfer.
257
+ */
245
258
  originator_company_id: string;
246
259
 
260
+ /**
261
+ * The name of the company that initiated the transfer.
262
+ */
247
263
  originator_company_name: string;
248
264
 
249
265
  /**
@@ -263,6 +279,7 @@ export namespace ACHTransferSimulation {
263
279
  * - `originator_request` - Other.
264
280
  * - `transaction_not_allowed` - The transaction is not allowed per Increase's
265
281
  * terms.
282
+ * - `user_initiated` - The user initiated the decline.
266
283
  */
267
284
  reason:
268
285
  | 'ach_route_canceled'
@@ -277,13 +294,29 @@ export namespace ACHTransferSimulation {
277
294
  | 'return_of_erroneous_or_reversing_debit'
278
295
  | 'no_ach_route'
279
296
  | 'originator_request'
280
- | 'transaction_not_allowed';
297
+ | 'transaction_not_allowed'
298
+ | 'user_initiated';
281
299
 
300
+ /**
301
+ * The id of the receiver of the transfer.
302
+ */
282
303
  receiver_id_number: string | null;
283
304
 
305
+ /**
306
+ * The name of the receiver of the transfer.
307
+ */
284
308
  receiver_name: string | null;
285
309
 
310
+ /**
311
+ * The trace number of the transfer.
312
+ */
286
313
  trace_number: string;
314
+
315
+ /**
316
+ * A constant representing the object's type. For this resource it will always be
317
+ * `ach_decline`.
318
+ */
319
+ type: 'ach_decline';
287
320
  }
288
321
 
289
322
  /**
@@ -369,6 +402,7 @@ export namespace ACHTransferSimulation {
369
402
  * Why the transaction was declined.
370
403
  *
371
404
  * - `card_not_active` - The Card was not active.
405
+ * - `physical_card_not_active` - The Physical Card was not active.
372
406
  * - `entity_not_active` - The account's entity was not active.
373
407
  * - `group_locked` - The account was inactive.
374
408
  * - `insufficient_funds` - The Card's Account did not have a sufficient available
@@ -376,8 +410,6 @@ export namespace ACHTransferSimulation {
376
410
  * - `cvv2_mismatch` - The given CVV2 did not match the card's value.
377
411
  * - `transaction_not_allowed` - The attempted card transaction is not allowed per
378
412
  * Increase's terms.
379
- * - `breaches_internal_limit` - The transaction was blocked by an internal limit
380
- * for new Increase accounts.
381
413
  * - `breaches_limit` - The transaction was blocked by a Limit.
382
414
  * - `webhook_declined` - Your application declined the transaction via webhook.
383
415
  * - `webhook_timed_out` - Your application webhook did not respond without the
@@ -387,21 +419,24 @@ export namespace ACHTransferSimulation {
387
419
  * authorization request cryptogram.
388
420
  * - `missing_original_authorization` - The original card authorization for this
389
421
  * incremental authorization does not exist.
422
+ * - `suspected_fraud` - The transaction was suspected to be fraudulent. Please
423
+ * reach out to support@increase.com for more information.
390
424
  */
391
425
  reason:
392
426
  | 'card_not_active'
427
+ | 'physical_card_not_active'
393
428
  | 'entity_not_active'
394
429
  | 'group_locked'
395
430
  | 'insufficient_funds'
396
431
  | 'cvv2_mismatch'
397
432
  | 'transaction_not_allowed'
398
- | 'breaches_internal_limit'
399
433
  | 'breaches_limit'
400
434
  | 'webhook_declined'
401
435
  | 'webhook_timed_out'
402
436
  | 'declined_by_stand_in_processing'
403
437
  | 'invalid_physical_card'
404
- | 'missing_original_authorization';
438
+ | 'missing_original_authorization'
439
+ | 'suspected_fraud';
405
440
  }
406
441
 
407
442
  export namespace CardDecline {
@@ -476,8 +511,33 @@ export namespace ACHTransferSimulation {
476
511
  /**
477
512
  * The method used to enter the cardholder's primary account number and card
478
513
  * expiration date
479
- */
480
- point_of_service_entry_mode: Shared.PointOfServiceEntryMode | null;
514
+ *
515
+ * - `unknown` - Unknown
516
+ * - `manual` - Manual key entry
517
+ * - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
518
+ * value
519
+ * - `optical_code` - Optical code
520
+ * - `integrated_circuit_card` - Contact chip card
521
+ * - `contactless` - Contactless read of chip card
522
+ * - `credential_on_file` - Transaction initiated using a credential that has
523
+ * previously been stored on file
524
+ * - `magnetic_stripe` - Magnetic stripe read
525
+ * - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
526
+ * - `integrated_circuit_card_no_cvv` - Contact chip card, without card
527
+ * verification value
528
+ */
529
+ point_of_service_entry_mode:
530
+ | 'unknown'
531
+ | 'manual'
532
+ | 'magnetic_stripe_no_cvv'
533
+ | 'optical_code'
534
+ | 'integrated_circuit_card'
535
+ | 'contactless'
536
+ | 'credential_on_file'
537
+ | 'magnetic_stripe'
538
+ | 'contactless_magnetic_stripe'
539
+ | 'integrated_circuit_card_no_cvv'
540
+ | null;
481
541
  }
482
542
  }
483
543
  }
@@ -533,7 +593,7 @@ export namespace ACHTransferSimulation {
533
593
  }
534
594
 
535
595
  /**
536
- * An Inbound Real Time Payments Transfer Decline object. This field will be
596
+ * An Inbound Real-Time Payments Transfer Decline object. This field will be
537
597
  * present in the JSON response if and only if `category` is equal to
538
598
  * `inbound_real_time_payments_transfer_decline`.
539
599
  */
@@ -551,7 +611,7 @@ export namespace ACHTransferSimulation {
551
611
 
552
612
  /**
553
613
  * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined
554
- * transfer's currency. This will always be "USD" for a Real Time Payments
614
+ * transfer's currency. This will always be "USD" for a Real-Time Payments
555
615
  * transfer.
556
616
  *
557
617
  * - `CAD` - Canadian Dollar (CAD)
@@ -586,8 +646,8 @@ export namespace ACHTransferSimulation {
586
646
  * - `account_restricted` - Your account is restricted.
587
647
  * - `group_locked` - Your account is inactive.
588
648
  * - `entity_not_active` - The account's entity is not active.
589
- * - `real_time_payments_not_enabled` - Your account is not enabled to receive Real
590
- * Time Payments transfers.
649
+ * - `real_time_payments_not_enabled` - Your account is not enabled to receive
650
+ * Real-Time Payments transfers.
591
651
  */
592
652
  reason:
593
653
  | 'account_number_canceled'
@@ -603,7 +663,7 @@ export namespace ACHTransferSimulation {
603
663
  remittance_information: string | null;
604
664
 
605
665
  /**
606
- * The Real Time Payments network identification of the declined transfer.
666
+ * The Real-Time Payments network identification of the declined transfer.
607
667
  */
608
668
  transaction_identification: string;
609
669
  }
@@ -777,13 +837,13 @@ export namespace ACHTransferSimulation {
777
837
 
778
838
  /**
779
839
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
780
- * Transaction occured.
840
+ * Transaction occurred.
781
841
  */
782
842
  created_at: string;
783
843
 
784
844
  /**
785
845
  * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
786
- * Transaction's currency. This will match the currency on the Transcation's
846
+ * Transaction's currency. This will match the currency on the Transaction's
787
847
  * Account.
788
848
  *
789
849
  * - `CAD` - Canadian Dollar (CAD)
@@ -926,7 +986,7 @@ export namespace ACHTransferSimulation {
926
986
  * object.
927
987
  * - `inbound_international_ach_transfer` - Inbound International ACH Transfer:
928
988
  * details will be under the `inbound_international_ach_transfer` object.
929
- * - `inbound_real_time_payments_transfer_confirmation` - Inbound Real Time
989
+ * - `inbound_real_time_payments_transfer_confirmation` - Inbound Real-Time
930
990
  * Payments Transfer Confirmation: details will be under the
931
991
  * `inbound_real_time_payments_transfer_confirmation` object.
932
992
  * - `inbound_wire_drawdown_payment` - Inbound Wire Drawdown Payment: details will
@@ -942,7 +1002,7 @@ export namespace ACHTransferSimulation {
942
1002
  * `interest_payment` object.
943
1003
  * - `internal_source` - Internal Source: details will be under the
944
1004
  * `internal_source` object.
945
- * - `real_time_payments_transfer_acknowledgement` - Real Time Payments Transfer
1005
+ * - `real_time_payments_transfer_acknowledgement` - Real-Time Payments Transfer
946
1006
  * Acknowledgement: details will be under the
947
1007
  * `real_time_payments_transfer_acknowledgement` object.
948
1008
  * - `sample_funds` - Sample Funds: details will be under the `sample_funds`
@@ -1042,7 +1102,7 @@ export namespace ACHTransferSimulation {
1042
1102
  inbound_international_ach_transfer: Source.InboundInternationalACHTransfer | null;
1043
1103
 
1044
1104
  /**
1045
- * An Inbound Real Time Payments Transfer Confirmation object. This field will be
1105
+ * An Inbound Real-Time Payments Transfer Confirmation object. This field will be
1046
1106
  * present in the JSON response if and only if `category` is equal to
1047
1107
  * `inbound_real_time_payments_transfer_confirmation`.
1048
1108
  */
@@ -1086,7 +1146,7 @@ export namespace ACHTransferSimulation {
1086
1146
  internal_source: Source.InternalSource | null;
1087
1147
 
1088
1148
  /**
1089
- * A Real Time Payments Transfer Acknowledgement object. This field will be present
1149
+ * A Real-Time Payments Transfer Acknowledgement object. This field will be present
1090
1150
  * in the JSON response if and only if `category` is equal to
1091
1151
  * `real_time_payments_transfer_acknowledgement`.
1092
1152
  */
@@ -1428,7 +1488,7 @@ export namespace ACHTransferSimulation {
1428
1488
  | 'untimely_return';
1429
1489
 
1430
1490
  /**
1431
- * The identifier of the Tranasaction associated with this return.
1491
+ * The identifier of the Transaction associated with this return.
1432
1492
  */
1433
1493
  transaction_id: string;
1434
1494
 
@@ -1779,7 +1839,7 @@ export namespace ACHTransferSimulation {
1779
1839
  food_beverage_charges_amount: number | null;
1780
1840
 
1781
1841
  /**
1782
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
1842
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
1783
1843
  * beverage charges.
1784
1844
  */
1785
1845
  food_beverage_charges_currency: string | null;
@@ -2448,7 +2508,7 @@ export namespace ACHTransferSimulation {
2448
2508
  food_beverage_charges_amount: number | null;
2449
2509
 
2450
2510
  /**
2451
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
2511
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
2452
2512
  * beverage charges.
2453
2513
  */
2454
2514
  food_beverage_charges_currency: string | null;
@@ -2962,7 +3022,7 @@ export namespace ACHTransferSimulation {
2962
3022
  * The reason why this transfer was stopped.
2963
3023
  *
2964
3024
  * - `mail_delivery_failed` - The check could not be delivered.
2965
- * - `rejected_by_increase` - The check was cancelled by an Increase operator who
3025
+ * - `rejected_by_increase` - The check was canceled by an Increase operator who
2966
3026
  * will provide details out-of-band.
2967
3027
  * - `unknown` - The check was stopped for another reason.
2968
3028
  */
@@ -3158,7 +3218,7 @@ export namespace ACHTransferSimulation {
3158
3218
  }
3159
3219
 
3160
3220
  /**
3161
- * An Inbound Real Time Payments Transfer Confirmation object. This field will be
3221
+ * An Inbound Real-Time Payments Transfer Confirmation object. This field will be
3162
3222
  * present in the JSON response if and only if `category` is equal to
3163
3223
  * `inbound_real_time_payments_transfer_confirmation`.
3164
3224
  */
@@ -3176,7 +3236,7 @@ export namespace ACHTransferSimulation {
3176
3236
 
3177
3237
  /**
3178
3238
  * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's
3179
- * currency. This will always be "USD" for a Real Time Payments transfer.
3239
+ * currency. This will always be "USD" for a Real-Time Payments transfer.
3180
3240
  *
3181
3241
  * - `CAD` - Canadian Dollar (CAD)
3182
3242
  * - `CHF` - Swiss Franc (CHF)
@@ -3208,7 +3268,7 @@ export namespace ACHTransferSimulation {
3208
3268
  remittance_information: string | null;
3209
3269
 
3210
3270
  /**
3211
- * The Real Time Payments network identification of the transfer
3271
+ * The Real-Time Payments network identification of the transfer
3212
3272
  */
3213
3273
  transaction_identification: string;
3214
3274
  }
@@ -3381,7 +3441,7 @@ export namespace ACHTransferSimulation {
3381
3441
  /**
3382
3442
  * The ID for the Transaction associated with the transfer reversal.
3383
3443
  */
3384
- transaction_id: string | null;
3444
+ transaction_id: string;
3385
3445
 
3386
3446
  /**
3387
3447
  * The ID for the Wire Transfer that is being reversed.
@@ -3529,7 +3589,7 @@ export namespace ACHTransferSimulation {
3529
3589
  }
3530
3590
 
3531
3591
  /**
3532
- * A Real Time Payments Transfer Acknowledgement object. This field will be present
3592
+ * A Real-Time Payments Transfer Acknowledgement object. This field will be present
3533
3593
  * in the JSON response if and only if `category` is equal to
3534
3594
  * `real_time_payments_transfer_acknowledgement`.
3535
3595
  */
@@ -3555,7 +3615,7 @@ export namespace ACHTransferSimulation {
3555
3615
  remittance_information: string;
3556
3616
 
3557
3617
  /**
3558
- * The identifier of the Real Time Payments Transfer that led to this Transaction.
3618
+ * The identifier of the Real-Time Payments Transfer that led to this Transaction.
3559
3619
  */
3560
3620
  transfer_id: string;
3561
3621
  }