increase 0.10.1 → 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 (162) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/core.d.ts +6 -3
  3. package/core.d.ts.map +1 -1
  4. package/core.js +13 -6
  5. package/core.js.map +1 -1
  6. package/core.mjs +13 -6
  7. package/core.mjs.map +1 -1
  8. package/index.d.mts +8 -4
  9. package/index.d.ts +8 -4
  10. package/index.d.ts.map +1 -1
  11. package/index.js +6 -3
  12. package/index.js.map +1 -1
  13. package/index.mjs +6 -3
  14. package/index.mjs.map +1 -1
  15. package/package.json +1 -1
  16. package/resources/account-transfers.d.ts +8 -1
  17. package/resources/account-transfers.d.ts.map +1 -1
  18. package/resources/account-transfers.js.map +1 -1
  19. package/resources/account-transfers.mjs.map +1 -1
  20. package/resources/ach-prenotifications.d.ts +2 -2
  21. package/resources/ach-transfers.d.ts +11 -4
  22. package/resources/ach-transfers.d.ts.map +1 -1
  23. package/resources/ach-transfers.js.map +1 -1
  24. package/resources/ach-transfers.mjs.map +1 -1
  25. package/resources/card-purchase-supplements.d.ts +1 -1
  26. package/resources/check-transfers.d.ts +6 -3
  27. package/resources/check-transfers.d.ts.map +1 -1
  28. package/resources/check-transfers.js.map +1 -1
  29. package/resources/check-transfers.mjs.map +1 -1
  30. package/resources/declined-transactions.d.ts +90 -16
  31. package/resources/declined-transactions.d.ts.map +1 -1
  32. package/resources/declined-transactions.js.map +1 -1
  33. package/resources/declined-transactions.mjs.map +1 -1
  34. package/resources/digital-wallet-tokens.d.ts +1 -1
  35. package/resources/entities/beneficial-owners.d.ts +24 -5
  36. package/resources/entities/beneficial-owners.d.ts.map +1 -1
  37. package/resources/entities/beneficial-owners.js +8 -2
  38. package/resources/entities/beneficial-owners.js.map +1 -1
  39. package/resources/entities/beneficial-owners.mjs +8 -2
  40. package/resources/entities/beneficial-owners.mjs.map +1 -1
  41. package/resources/entities/entities.d.ts +19 -14
  42. package/resources/entities/entities.d.ts.map +1 -1
  43. package/resources/entities/entities.js.map +1 -1
  44. package/resources/entities/entities.mjs.map +1 -1
  45. package/resources/entities/index.d.ts +5 -1
  46. package/resources/entities/index.d.ts.map +1 -1
  47. package/resources/entities/index.js.map +1 -1
  48. package/resources/entities/index.mjs.map +1 -1
  49. package/resources/entities/supplemental-documents.d.ts +1 -1
  50. package/resources/entities/supplemental-documents.js +1 -1
  51. package/resources/entities/supplemental-documents.mjs +1 -1
  52. package/resources/event-subscriptions.d.ts +22 -10
  53. package/resources/event-subscriptions.d.ts.map +1 -1
  54. package/resources/event-subscriptions.js.map +1 -1
  55. package/resources/event-subscriptions.mjs.map +1 -1
  56. package/resources/events.d.ts +13 -5
  57. package/resources/events.d.ts.map +1 -1
  58. package/resources/events.js.map +1 -1
  59. package/resources/events.mjs.map +1 -1
  60. package/resources/external-accounts.d.ts +2 -2
  61. package/resources/inbound-ach-transfer-returns.d.ts +1 -47
  62. package/resources/inbound-ach-transfer-returns.d.ts.map +1 -1
  63. package/resources/inbound-ach-transfer-returns.js +0 -6
  64. package/resources/inbound-ach-transfer-returns.js.map +1 -1
  65. package/resources/inbound-ach-transfer-returns.mjs +0 -6
  66. package/resources/inbound-ach-transfer-returns.mjs.map +1 -1
  67. package/resources/inbound-ach-transfers.d.ts +303 -0
  68. package/resources/inbound-ach-transfers.d.ts.map +1 -0
  69. package/resources/inbound-ach-transfers.js +40 -0
  70. package/resources/inbound-ach-transfers.js.map +1 -0
  71. package/resources/inbound-ach-transfers.mjs +33 -0
  72. package/resources/inbound-ach-transfers.mjs.map +1 -0
  73. package/resources/index.d.ts +7 -2
  74. package/resources/index.d.ts.map +1 -1
  75. package/resources/index.js +16 -29
  76. package/resources/index.js.map +1 -1
  77. package/resources/index.mjs +1 -1
  78. package/resources/index.mjs.map +1 -1
  79. package/resources/pending-transactions.d.ts +50 -8
  80. package/resources/pending-transactions.d.ts.map +1 -1
  81. package/resources/pending-transactions.js.map +1 -1
  82. package/resources/pending-transactions.mjs.map +1 -1
  83. package/resources/real-time-decisions.d.ts +28 -4
  84. package/resources/real-time-decisions.d.ts.map +1 -1
  85. package/resources/real-time-decisions.js.map +1 -1
  86. package/resources/real-time-decisions.mjs.map +1 -1
  87. package/resources/real-time-payments-transfers.d.ts +49 -42
  88. package/resources/real-time-payments-transfers.d.ts.map +1 -1
  89. package/resources/real-time-payments-transfers.js +2 -2
  90. package/resources/real-time-payments-transfers.js.map +1 -1
  91. package/resources/real-time-payments-transfers.mjs +2 -2
  92. package/resources/real-time-payments-transfers.mjs.map +1 -1
  93. package/resources/routing-numbers.d.ts +1 -1
  94. package/resources/simulations/ach-transfers.d.ts +91 -33
  95. package/resources/simulations/ach-transfers.d.ts.map +1 -1
  96. package/resources/simulations/ach-transfers.js.map +1 -1
  97. package/resources/simulations/ach-transfers.mjs.map +1 -1
  98. package/resources/simulations/cards.d.ts +106 -23
  99. package/resources/simulations/cards.d.ts.map +1 -1
  100. package/resources/simulations/cards.js.map +1 -1
  101. package/resources/simulations/cards.mjs.map +1 -1
  102. package/resources/simulations/inbound-wire-drawdown-requests.d.ts +1 -1
  103. package/resources/simulations/inbound-wire-drawdown-requests.js +1 -1
  104. package/resources/simulations/inbound-wire-drawdown-requests.mjs +1 -1
  105. package/resources/simulations/interest-payments.d.ts +16 -16
  106. package/resources/simulations/interest-payments.d.ts.map +1 -1
  107. package/resources/simulations/real-time-payments-transfers.d.ts +122 -64
  108. package/resources/simulations/real-time-payments-transfers.d.ts.map +1 -1
  109. package/resources/simulations/real-time-payments-transfers.js +2 -2
  110. package/resources/simulations/real-time-payments-transfers.js.map +1 -1
  111. package/resources/simulations/real-time-payments-transfers.mjs +2 -2
  112. package/resources/simulations/real-time-payments-transfers.mjs.map +1 -1
  113. package/resources/simulations/wire-transfers.d.ts +16 -16
  114. package/resources/simulations/wire-transfers.d.ts.map +1 -1
  115. package/resources/transactions.d.ts +16 -16
  116. package/resources/transactions.d.ts.map +1 -1
  117. package/resources/wire-transfers.d.ts +9 -2
  118. package/resources/wire-transfers.d.ts.map +1 -1
  119. package/resources/wire-transfers.js.map +1 -1
  120. package/resources/wire-transfers.mjs.map +1 -1
  121. package/src/core.ts +18 -6
  122. package/src/index.ts +10 -6
  123. package/src/resources/account-transfers.ts +9 -1
  124. package/src/resources/ach-prenotifications.ts +2 -2
  125. package/src/resources/ach-transfers.ts +12 -4
  126. package/src/resources/card-purchase-supplements.ts +1 -1
  127. package/src/resources/check-transfers.ts +6 -3
  128. package/src/resources/declined-transactions.ts +94 -16
  129. package/src/resources/digital-wallet-tokens.ts +1 -1
  130. package/src/resources/entities/beneficial-owners.ts +31 -6
  131. package/src/resources/entities/entities.ts +20 -14
  132. package/src/resources/entities/index.ts +5 -1
  133. package/src/resources/entities/supplemental-documents.ts +1 -1
  134. package/src/resources/event-subscriptions.ts +22 -10
  135. package/src/resources/events.ts +13 -5
  136. package/src/resources/external-accounts.ts +2 -2
  137. package/src/resources/inbound-ach-transfer-returns.ts +1 -52
  138. package/src/resources/inbound-ach-transfers.ts +359 -0
  139. package/src/resources/index.ts +7 -2
  140. package/src/resources/pending-transactions.ts +52 -8
  141. package/src/resources/real-time-decisions.ts +28 -4
  142. package/src/resources/real-time-payments-transfers.ts +50 -42
  143. package/src/resources/routing-numbers.ts +1 -1
  144. package/src/resources/simulations/ach-transfers.ts +93 -33
  145. package/src/resources/simulations/cards.ts +108 -23
  146. package/src/resources/simulations/inbound-wire-drawdown-requests.ts +1 -1
  147. package/src/resources/simulations/interest-payments.ts +16 -16
  148. package/src/resources/simulations/real-time-payments-transfers.ts +124 -64
  149. package/src/resources/simulations/wire-transfers.ts +16 -16
  150. package/src/resources/transactions.ts +16 -16
  151. package/src/resources/wire-transfers.ts +10 -2
  152. package/src/version.ts +1 -1
  153. package/version.d.ts +1 -1
  154. package/version.js +1 -1
  155. package/version.mjs +1 -1
  156. package/resources/shared.d.ts +0 -31
  157. package/resources/shared.d.ts.map +0 -1
  158. package/resources/shared.js +0 -4
  159. package/resources/shared.js.map +0 -1
  160. package/resources/shared.mjs +0 -3
  161. package/resources/shared.mjs.map +0 -1
  162. package/src/resources/shared.ts +0 -32
@@ -3,12 +3,11 @@
3
3
  import * as Core from '../../core';
4
4
  import { APIResource } from '../../resource';
5
5
  import * as RealTimePaymentsTransfers_ from '../real-time-payments-transfers';
6
- import * as Shared from '../shared';
7
6
  import * as API from './index';
8
7
 
9
8
  export class RealTimePaymentsTransfers extends APIResource {
10
9
  /**
11
- * Simulates submission of a Real Time Payments transfer and handling the response
10
+ * Simulates submission of a Real-Time Payments transfer and handling the response
12
11
  * from the destination financial institution. This transfer must first have a
13
12
  * `status` of `pending_submission`.
14
13
  */
@@ -24,7 +23,7 @@ export class RealTimePaymentsTransfers extends APIResource {
24
23
  }
25
24
 
26
25
  /**
27
- * Simulates an inbound Real Time Payments transfer to your account. Real Time
26
+ * Simulates an inbound Real-Time Payments transfer to your account. Real-Time
28
27
  * Payments are a beta feature.
29
28
  */
30
29
  createInbound(
@@ -36,11 +35,11 @@ export class RealTimePaymentsTransfers extends APIResource {
36
35
  }
37
36
 
38
37
  /**
39
- * The results of an inbound Real Time Payments Transfer simulation.
38
+ * The results of an inbound Real-Time Payments Transfer simulation.
40
39
  */
41
40
  export interface InboundRealTimePaymentsTransferSimulationResult {
42
41
  /**
43
- * If the Real Time Payments Transfer attempt fails, this will contain the
42
+ * If the Real-Time Payments Transfer attempt fails, this will contain the
44
43
  * resulting [Declined Transaction](#declined-transactions) object. The Declined
45
44
  * Transaction's `source` will be of
46
45
  * `category: inbound_real_time_payments_transfer_decline`.
@@ -48,7 +47,7 @@ export interface InboundRealTimePaymentsTransferSimulationResult {
48
47
  declined_transaction: InboundRealTimePaymentsTransferSimulationResult.DeclinedTransaction | null;
49
48
 
50
49
  /**
51
- * If the Real Time Payments Transfer attempt succeeds, this will contain the
50
+ * If the Real-Time Payments Transfer attempt succeeds, this will contain the
52
51
  * resulting [Transaction](#transactions) object. The Transaction's `source` will
53
52
  * be of `category: inbound_real_time_payments_transfer_confirmation`.
54
53
  */
@@ -63,7 +62,7 @@ export interface InboundRealTimePaymentsTransferSimulationResult {
63
62
 
64
63
  export namespace InboundRealTimePaymentsTransferSimulationResult {
65
64
  /**
66
- * If the Real Time Payments Transfer attempt fails, this will contain the
65
+ * If the Real-Time Payments Transfer attempt fails, this will contain the
67
66
  * resulting [Declined Transaction](#declined-transactions) object. The Declined
68
67
  * Transaction's `source` will be of
69
68
  * `category: inbound_real_time_payments_transfer_decline`.
@@ -87,14 +86,14 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
87
86
 
88
87
  /**
89
88
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
90
- * Transaction occured.
89
+ * Transaction occurred.
91
90
  */
92
91
  created_at: string;
93
92
 
94
93
  /**
95
94
  * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined
96
95
  * Transaction's currency. This will match the currency on the Declined
97
- * Transcation's Account.
96
+ * Transaction's Account.
98
97
  *
99
98
  * - `CAD` - Canadian Dollar (CAD)
100
99
  * - `CHF` - Swiss Franc (CHF)
@@ -170,7 +169,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
170
169
  * object.
171
170
  * - `check_decline` - Check Decline: details will be under the `check_decline`
172
171
  * object.
173
- * - `inbound_real_time_payments_transfer_decline` - Inbound Real Time Payments
172
+ * - `inbound_real_time_payments_transfer_decline` - Inbound Real-Time Payments
174
173
  * Transfer Decline: details will be under the
175
174
  * `inbound_real_time_payments_transfer_decline` object.
176
175
  * - `international_ach_decline` - International ACH Decline: details will be under
@@ -196,7 +195,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
196
195
  check_decline: Source.CheckDecline | null;
197
196
 
198
197
  /**
199
- * An Inbound Real Time Payments Transfer Decline object. This field will be
198
+ * An Inbound Real-Time Payments Transfer Decline object. This field will be
200
199
  * present in the JSON response if and only if `category` is equal to
201
200
  * `inbound_real_time_payments_transfer_decline`.
202
201
  */
@@ -221,18 +220,35 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
221
220
  * only if `category` is equal to `ach_decline`.
222
221
  */
223
222
  export interface ACHDecline {
223
+ /**
224
+ * The ACH Decline's identifier.
225
+ */
226
+ id: string;
227
+
224
228
  /**
225
229
  * The declined amount in the minor unit of the destination account currency. For
226
230
  * dollars, for example, this is cents.
227
231
  */
228
232
  amount: number;
229
233
 
234
+ /**
235
+ * The descriptive date of the transfer.
236
+ */
230
237
  originator_company_descriptive_date: string | null;
231
238
 
239
+ /**
240
+ * The additional information included with the transfer.
241
+ */
232
242
  originator_company_discretionary_data: string | null;
233
243
 
244
+ /**
245
+ * The identifier of the company that initiated the transfer.
246
+ */
234
247
  originator_company_id: string;
235
248
 
249
+ /**
250
+ * The name of the company that initiated the transfer.
251
+ */
236
252
  originator_company_name: string;
237
253
 
238
254
  /**
@@ -252,6 +268,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
252
268
  * - `originator_request` - Other.
253
269
  * - `transaction_not_allowed` - The transaction is not allowed per Increase's
254
270
  * terms.
271
+ * - `user_initiated` - The user initiated the decline.
255
272
  */
256
273
  reason:
257
274
  | 'ach_route_canceled'
@@ -266,13 +283,29 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
266
283
  | 'return_of_erroneous_or_reversing_debit'
267
284
  | 'no_ach_route'
268
285
  | 'originator_request'
269
- | 'transaction_not_allowed';
286
+ | 'transaction_not_allowed'
287
+ | 'user_initiated';
270
288
 
289
+ /**
290
+ * The id of the receiver of the transfer.
291
+ */
271
292
  receiver_id_number: string | null;
272
293
 
294
+ /**
295
+ * The name of the receiver of the transfer.
296
+ */
273
297
  receiver_name: string | null;
274
298
 
299
+ /**
300
+ * The trace number of the transfer.
301
+ */
275
302
  trace_number: string;
303
+
304
+ /**
305
+ * A constant representing the object's type. For this resource it will always be
306
+ * `ach_decline`.
307
+ */
308
+ type: 'ach_decline';
276
309
  }
277
310
 
278
311
  /**
@@ -358,6 +391,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
358
391
  * Why the transaction was declined.
359
392
  *
360
393
  * - `card_not_active` - The Card was not active.
394
+ * - `physical_card_not_active` - The Physical Card was not active.
361
395
  * - `entity_not_active` - The account's entity was not active.
362
396
  * - `group_locked` - The account was inactive.
363
397
  * - `insufficient_funds` - The Card's Account did not have a sufficient available
@@ -365,8 +399,6 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
365
399
  * - `cvv2_mismatch` - The given CVV2 did not match the card's value.
366
400
  * - `transaction_not_allowed` - The attempted card transaction is not allowed per
367
401
  * Increase's terms.
368
- * - `breaches_internal_limit` - The transaction was blocked by an internal limit
369
- * for new Increase accounts.
370
402
  * - `breaches_limit` - The transaction was blocked by a Limit.
371
403
  * - `webhook_declined` - Your application declined the transaction via webhook.
372
404
  * - `webhook_timed_out` - Your application webhook did not respond without the
@@ -376,21 +408,24 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
376
408
  * authorization request cryptogram.
377
409
  * - `missing_original_authorization` - The original card authorization for this
378
410
  * incremental authorization does not exist.
411
+ * - `suspected_fraud` - The transaction was suspected to be fraudulent. Please
412
+ * reach out to support@increase.com for more information.
379
413
  */
380
414
  reason:
381
415
  | 'card_not_active'
416
+ | 'physical_card_not_active'
382
417
  | 'entity_not_active'
383
418
  | 'group_locked'
384
419
  | 'insufficient_funds'
385
420
  | 'cvv2_mismatch'
386
421
  | 'transaction_not_allowed'
387
- | 'breaches_internal_limit'
388
422
  | 'breaches_limit'
389
423
  | 'webhook_declined'
390
424
  | 'webhook_timed_out'
391
425
  | 'declined_by_stand_in_processing'
392
426
  | 'invalid_physical_card'
393
- | 'missing_original_authorization';
427
+ | 'missing_original_authorization'
428
+ | 'suspected_fraud';
394
429
  }
395
430
 
396
431
  export namespace CardDecline {
@@ -465,8 +500,33 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
465
500
  /**
466
501
  * The method used to enter the cardholder's primary account number and card
467
502
  * expiration date
468
- */
469
- point_of_service_entry_mode: Shared.PointOfServiceEntryMode | null;
503
+ *
504
+ * - `unknown` - Unknown
505
+ * - `manual` - Manual key entry
506
+ * - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
507
+ * value
508
+ * - `optical_code` - Optical code
509
+ * - `integrated_circuit_card` - Contact chip card
510
+ * - `contactless` - Contactless read of chip card
511
+ * - `credential_on_file` - Transaction initiated using a credential that has
512
+ * previously been stored on file
513
+ * - `magnetic_stripe` - Magnetic stripe read
514
+ * - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
515
+ * - `integrated_circuit_card_no_cvv` - Contact chip card, without card
516
+ * verification value
517
+ */
518
+ point_of_service_entry_mode:
519
+ | 'unknown'
520
+ | 'manual'
521
+ | 'magnetic_stripe_no_cvv'
522
+ | 'optical_code'
523
+ | 'integrated_circuit_card'
524
+ | 'contactless'
525
+ | 'credential_on_file'
526
+ | 'magnetic_stripe'
527
+ | 'contactless_magnetic_stripe'
528
+ | 'integrated_circuit_card_no_cvv'
529
+ | null;
470
530
  }
471
531
  }
472
532
  }
@@ -522,7 +582,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
522
582
  }
523
583
 
524
584
  /**
525
- * An Inbound Real Time Payments Transfer Decline object. This field will be
585
+ * An Inbound Real-Time Payments Transfer Decline object. This field will be
526
586
  * present in the JSON response if and only if `category` is equal to
527
587
  * `inbound_real_time_payments_transfer_decline`.
528
588
  */
@@ -540,7 +600,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
540
600
 
541
601
  /**
542
602
  * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined
543
- * transfer's currency. This will always be "USD" for a Real Time Payments
603
+ * transfer's currency. This will always be "USD" for a Real-Time Payments
544
604
  * transfer.
545
605
  *
546
606
  * - `CAD` - Canadian Dollar (CAD)
@@ -575,8 +635,8 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
575
635
  * - `account_restricted` - Your account is restricted.
576
636
  * - `group_locked` - Your account is inactive.
577
637
  * - `entity_not_active` - The account's entity is not active.
578
- * - `real_time_payments_not_enabled` - Your account is not enabled to receive Real
579
- * Time Payments transfers.
638
+ * - `real_time_payments_not_enabled` - Your account is not enabled to receive
639
+ * Real-Time Payments transfers.
580
640
  */
581
641
  reason:
582
642
  | 'account_number_canceled'
@@ -592,7 +652,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
592
652
  remittance_information: string | null;
593
653
 
594
654
  /**
595
- * The Real Time Payments network identification of the declined transfer.
655
+ * The Real-Time Payments network identification of the declined transfer.
596
656
  */
597
657
  transaction_identification: string;
598
658
  }
@@ -743,7 +803,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
743
803
  }
744
804
 
745
805
  /**
746
- * If the Real Time Payments Transfer attempt succeeds, this will contain the
806
+ * If the Real-Time Payments Transfer attempt succeeds, this will contain the
747
807
  * resulting [Transaction](#transactions) object. The Transaction's `source` will
748
808
  * be of `category: inbound_real_time_payments_transfer_confirmation`.
749
809
  */
@@ -766,13 +826,13 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
766
826
 
767
827
  /**
768
828
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
769
- * Transaction occured.
829
+ * Transaction occurred.
770
830
  */
771
831
  created_at: string;
772
832
 
773
833
  /**
774
834
  * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
775
- * Transaction's currency. This will match the currency on the Transcation's
835
+ * Transaction's currency. This will match the currency on the Transaction's
776
836
  * Account.
777
837
  *
778
838
  * - `CAD` - Canadian Dollar (CAD)
@@ -915,7 +975,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
915
975
  * object.
916
976
  * - `inbound_international_ach_transfer` - Inbound International ACH Transfer:
917
977
  * details will be under the `inbound_international_ach_transfer` object.
918
- * - `inbound_real_time_payments_transfer_confirmation` - Inbound Real Time
978
+ * - `inbound_real_time_payments_transfer_confirmation` - Inbound Real-Time
919
979
  * Payments Transfer Confirmation: details will be under the
920
980
  * `inbound_real_time_payments_transfer_confirmation` object.
921
981
  * - `inbound_wire_drawdown_payment` - Inbound Wire Drawdown Payment: details will
@@ -931,7 +991,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
931
991
  * `interest_payment` object.
932
992
  * - `internal_source` - Internal Source: details will be under the
933
993
  * `internal_source` object.
934
- * - `real_time_payments_transfer_acknowledgement` - Real Time Payments Transfer
994
+ * - `real_time_payments_transfer_acknowledgement` - Real-Time Payments Transfer
935
995
  * Acknowledgement: details will be under the
936
996
  * `real_time_payments_transfer_acknowledgement` object.
937
997
  * - `sample_funds` - Sample Funds: details will be under the `sample_funds`
@@ -1031,7 +1091,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
1031
1091
  inbound_international_ach_transfer: Source.InboundInternationalACHTransfer | null;
1032
1092
 
1033
1093
  /**
1034
- * An Inbound Real Time Payments Transfer Confirmation object. This field will be
1094
+ * An Inbound Real-Time Payments Transfer Confirmation object. This field will be
1035
1095
  * present in the JSON response if and only if `category` is equal to
1036
1096
  * `inbound_real_time_payments_transfer_confirmation`.
1037
1097
  */
@@ -1075,7 +1135,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
1075
1135
  internal_source: Source.InternalSource | null;
1076
1136
 
1077
1137
  /**
1078
- * A Real Time Payments Transfer Acknowledgement object. This field will be present
1138
+ * A Real-Time Payments Transfer Acknowledgement object. This field will be present
1079
1139
  * in the JSON response if and only if `category` is equal to
1080
1140
  * `real_time_payments_transfer_acknowledgement`.
1081
1141
  */
@@ -1417,7 +1477,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
1417
1477
  | 'untimely_return';
1418
1478
 
1419
1479
  /**
1420
- * The identifier of the Tranasaction associated with this return.
1480
+ * The identifier of the Transaction associated with this return.
1421
1481
  */
1422
1482
  transaction_id: string;
1423
1483
 
@@ -1768,7 +1828,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
1768
1828
  food_beverage_charges_amount: number | null;
1769
1829
 
1770
1830
  /**
1771
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
1831
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
1772
1832
  * beverage charges.
1773
1833
  */
1774
1834
  food_beverage_charges_currency: string | null;
@@ -2437,7 +2497,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
2437
2497
  food_beverage_charges_amount: number | null;
2438
2498
 
2439
2499
  /**
2440
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
2500
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
2441
2501
  * beverage charges.
2442
2502
  */
2443
2503
  food_beverage_charges_currency: string | null;
@@ -2951,7 +3011,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
2951
3011
  * The reason why this transfer was stopped.
2952
3012
  *
2953
3013
  * - `mail_delivery_failed` - The check could not be delivered.
2954
- * - `rejected_by_increase` - The check was cancelled by an Increase operator who
3014
+ * - `rejected_by_increase` - The check was canceled by an Increase operator who
2955
3015
  * will provide details out-of-band.
2956
3016
  * - `unknown` - The check was stopped for another reason.
2957
3017
  */
@@ -3147,7 +3207,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
3147
3207
  }
3148
3208
 
3149
3209
  /**
3150
- * An Inbound Real Time Payments Transfer Confirmation object. This field will be
3210
+ * An Inbound Real-Time Payments Transfer Confirmation object. This field will be
3151
3211
  * present in the JSON response if and only if `category` is equal to
3152
3212
  * `inbound_real_time_payments_transfer_confirmation`.
3153
3213
  */
@@ -3165,7 +3225,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
3165
3225
 
3166
3226
  /**
3167
3227
  * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's
3168
- * currency. This will always be "USD" for a Real Time Payments transfer.
3228
+ * currency. This will always be "USD" for a Real-Time Payments transfer.
3169
3229
  *
3170
3230
  * - `CAD` - Canadian Dollar (CAD)
3171
3231
  * - `CHF` - Swiss Franc (CHF)
@@ -3197,7 +3257,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
3197
3257
  remittance_information: string | null;
3198
3258
 
3199
3259
  /**
3200
- * The Real Time Payments network identification of the transfer
3260
+ * The Real-Time Payments network identification of the transfer
3201
3261
  */
3202
3262
  transaction_identification: string;
3203
3263
  }
@@ -3370,7 +3430,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
3370
3430
  /**
3371
3431
  * The ID for the Transaction associated with the transfer reversal.
3372
3432
  */
3373
- transaction_id: string | null;
3433
+ transaction_id: string;
3374
3434
 
3375
3435
  /**
3376
3436
  * The ID for the Wire Transfer that is being reversed.
@@ -3518,7 +3578,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
3518
3578
  }
3519
3579
 
3520
3580
  /**
3521
- * A Real Time Payments Transfer Acknowledgement object. This field will be present
3581
+ * A Real-Time Payments Transfer Acknowledgement object. This field will be present
3522
3582
  * in the JSON response if and only if `category` is equal to
3523
3583
  * `real_time_payments_transfer_acknowledgement`.
3524
3584
  */
@@ -3544,7 +3604,7 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
3544
3604
  remittance_information: string;
3545
3605
 
3546
3606
  /**
3547
- * The identifier of the Real Time Payments Transfer that led to this Transaction.
3607
+ * The identifier of the Real-Time Payments Transfer that led to this Transaction.
3548
3608
  */
3549
3609
  transfer_id: string;
3550
3610
  }
@@ -3614,50 +3674,50 @@ export namespace RealTimePaymentsTransferCompleteParams {
3614
3674
  /**
3615
3675
  * The reason code that the simulated rejection will have.
3616
3676
  *
3617
- * - `account_closed` - The destination account is closed. Corresponds to the Real
3618
- * Time Payments reason code `AC04`.
3677
+ * - `account_closed` - The destination account is closed. Corresponds to the
3678
+ * Real-Time Payments reason code `AC04`.
3619
3679
  * - `account_blocked` - The destination account is currently blocked from
3620
- * receiving transactions. Corresponds to the Real Time Payments reason code
3680
+ * receiving transactions. Corresponds to the Real-Time Payments reason code
3621
3681
  * `AC06`.
3622
3682
  * - `invalid_creditor_account_type` - The destination account is ineligible to
3623
- * receive Real Time Payments transfers. Corresponds to the Real Time Payments
3683
+ * receive Real-Time Payments transfers. Corresponds to the Real-Time Payments
3624
3684
  * reason code `AC14`.
3625
3685
  * - `invalid_creditor_account_number` - The destination account does not exist.
3626
- * Corresponds to the Real Time Payments reason code `AC03`.
3686
+ * Corresponds to the Real-Time Payments reason code `AC03`.
3627
3687
  * - `invalid_creditor_financial_institution_identifier` - The destination routing
3628
- * number is invalid. Corresponds to the Real Time Payments reason code `RC04`.
3688
+ * number is invalid. Corresponds to the Real-Time Payments reason code `RC04`.
3629
3689
  * - `end_customer_deceased` - The destination account holder is deceased.
3630
- * Corresponds to the Real Time Payments reason code `MD07`.
3690
+ * Corresponds to the Real-Time Payments reason code `MD07`.
3631
3691
  * - `narrative` - The reason is provided as narrative information in the
3632
3692
  * additional information field.
3633
- * - `transaction_forbidden` - Real Time Payments transfers are not allowed to the
3634
- * destination account. Corresponds to the Real Time Payments reason code `AG01`.
3635
- * - `transaction_type_not_supported` - Real Time Payments transfers are not
3636
- * enabled for the destination account. Corresponds to the Real Time Payments
3693
+ * - `transaction_forbidden` - Real-Time Payments transfers are not allowed to the
3694
+ * destination account. Corresponds to the Real-Time Payments reason code `AG01`.
3695
+ * - `transaction_type_not_supported` - Real-Time Payments transfers are not
3696
+ * enabled for the destination account. Corresponds to the Real-Time Payments
3637
3697
  * reason code `AG03`.
3638
3698
  * - `unexpected_amount` - The amount of the transfer is different than expected by
3639
- * the recipient. Corresponds to the Real Time Payments reason code `AM09`.
3699
+ * the recipient. Corresponds to the Real-Time Payments reason code `AM09`.
3640
3700
  * - `amount_exceeds_bank_limits` - The amount is higher than the recipient is
3641
- * authorized to send or receive. Corresponds to the Real Time Payments reason
3701
+ * authorized to send or receive. Corresponds to the Real-Time Payments reason
3642
3702
  * code `AM14`.
3643
3703
  * - `invalid_creditor_address` - The creditor's address is required, but missing
3644
- * or invalid. Corresponds to the Real Time Payments reason code `BE04`.
3704
+ * or invalid. Corresponds to the Real-Time Payments reason code `BE04`.
3645
3705
  * - `unknown_end_customer` - The specified creditor is unknown. Corresponds to the
3646
- * Real Time Payments reason code `BE06`.
3706
+ * Real-Time Payments reason code `BE06`.
3647
3707
  * - `invalid_debtor_address` - The debtor's address is required, but missing or
3648
- * invalid. Corresponds to the Real Time Payments reason code `BE07`.
3708
+ * invalid. Corresponds to the Real-Time Payments reason code `BE07`.
3649
3709
  * - `timeout` - There was a timeout processing the transfer. Corresponds to the
3650
- * Real Time Payments reason code `DS24`.
3651
- * - `unsupported_message_for_recipient` - Real Time Payments transfers are not
3652
- * enabled for the destination account. Corresponds to the Real Time Payments
3710
+ * Real-Time Payments reason code `DS24`.
3711
+ * - `unsupported_message_for_recipient` - Real-Time Payments transfers are not
3712
+ * enabled for the destination account. Corresponds to the Real-Time Payments
3653
3713
  * reason code `NOAT`.
3654
3714
  * - `recipient_connection_not_available` - The destination financial institution
3655
- * is currently not connected to Real Time Payments. Corresponds to the Real Time
3715
+ * is currently not connected to Real-Time Payments. Corresponds to the Real-Time
3656
3716
  * Payments reason code `9912`.
3657
- * - `real_time_payments_suspended` - Real Time Payments is currently unavailable.
3658
- * Corresponds to the Real Time Payments reason code `9948`.
3717
+ * - `real_time_payments_suspended` - Real-Time Payments is currently unavailable.
3718
+ * Corresponds to the Real-Time Payments reason code `9948`.
3659
3719
  * - `instructed_agent_signed_off` - The destination financial institution is
3660
- * currently signed off of Real Time Payments. Corresponds to the Real Time
3720
+ * currently signed off of Real-Time Payments. Corresponds to the Real-Time
3661
3721
  * Payments reason code `9910`.
3662
3722
  * - `processing_error` - The transfer was rejected due to an internal Increase
3663
3723
  * issue. We have been notified.
@@ -3690,7 +3750,7 @@ export namespace RealTimePaymentsTransferCompleteParams {
3690
3750
 
3691
3751
  export interface RealTimePaymentsTransferCreateInboundParams {
3692
3752
  /**
3693
- * The identifier of the Account Number the inbound Real Time Payments Transfer is
3753
+ * The identifier of the Account Number the inbound Real-Time Payments Transfer is
3694
3754
  * for.
3695
3755
  */
3696
3756
  account_number_id: string;
@@ -59,13 +59,13 @@ export namespace WireTransferSimulation {
59
59
 
60
60
  /**
61
61
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
62
- * Transaction occured.
62
+ * Transaction occurred.
63
63
  */
64
64
  created_at: string;
65
65
 
66
66
  /**
67
67
  * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
68
- * Transaction's currency. This will match the currency on the Transcation's
68
+ * Transaction's currency. This will match the currency on the Transaction's
69
69
  * Account.
70
70
  *
71
71
  * - `CAD` - Canadian Dollar (CAD)
@@ -208,7 +208,7 @@ export namespace WireTransferSimulation {
208
208
  * object.
209
209
  * - `inbound_international_ach_transfer` - Inbound International ACH Transfer:
210
210
  * details will be under the `inbound_international_ach_transfer` object.
211
- * - `inbound_real_time_payments_transfer_confirmation` - Inbound Real Time
211
+ * - `inbound_real_time_payments_transfer_confirmation` - Inbound Real-Time
212
212
  * Payments Transfer Confirmation: details will be under the
213
213
  * `inbound_real_time_payments_transfer_confirmation` object.
214
214
  * - `inbound_wire_drawdown_payment` - Inbound Wire Drawdown Payment: details will
@@ -224,7 +224,7 @@ export namespace WireTransferSimulation {
224
224
  * `interest_payment` object.
225
225
  * - `internal_source` - Internal Source: details will be under the
226
226
  * `internal_source` object.
227
- * - `real_time_payments_transfer_acknowledgement` - Real Time Payments Transfer
227
+ * - `real_time_payments_transfer_acknowledgement` - Real-Time Payments Transfer
228
228
  * Acknowledgement: details will be under the
229
229
  * `real_time_payments_transfer_acknowledgement` object.
230
230
  * - `sample_funds` - Sample Funds: details will be under the `sample_funds`
@@ -324,7 +324,7 @@ export namespace WireTransferSimulation {
324
324
  inbound_international_ach_transfer: Source.InboundInternationalACHTransfer | null;
325
325
 
326
326
  /**
327
- * An Inbound Real Time Payments Transfer Confirmation object. This field will be
327
+ * An Inbound Real-Time Payments Transfer Confirmation object. This field will be
328
328
  * present in the JSON response if and only if `category` is equal to
329
329
  * `inbound_real_time_payments_transfer_confirmation`.
330
330
  */
@@ -368,7 +368,7 @@ export namespace WireTransferSimulation {
368
368
  internal_source: Source.InternalSource | null;
369
369
 
370
370
  /**
371
- * A Real Time Payments Transfer Acknowledgement object. This field will be present
371
+ * A Real-Time Payments Transfer Acknowledgement object. This field will be present
372
372
  * in the JSON response if and only if `category` is equal to
373
373
  * `real_time_payments_transfer_acknowledgement`.
374
374
  */
@@ -710,7 +710,7 @@ export namespace WireTransferSimulation {
710
710
  | 'untimely_return';
711
711
 
712
712
  /**
713
- * The identifier of the Tranasaction associated with this return.
713
+ * The identifier of the Transaction associated with this return.
714
714
  */
715
715
  transaction_id: string;
716
716
 
@@ -1061,7 +1061,7 @@ export namespace WireTransferSimulation {
1061
1061
  food_beverage_charges_amount: number | null;
1062
1062
 
1063
1063
  /**
1064
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
1064
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
1065
1065
  * beverage charges.
1066
1066
  */
1067
1067
  food_beverage_charges_currency: string | null;
@@ -1730,7 +1730,7 @@ export namespace WireTransferSimulation {
1730
1730
  food_beverage_charges_amount: number | null;
1731
1731
 
1732
1732
  /**
1733
- * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
1733
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
1734
1734
  * beverage charges.
1735
1735
  */
1736
1736
  food_beverage_charges_currency: string | null;
@@ -2244,7 +2244,7 @@ export namespace WireTransferSimulation {
2244
2244
  * The reason why this transfer was stopped.
2245
2245
  *
2246
2246
  * - `mail_delivery_failed` - The check could not be delivered.
2247
- * - `rejected_by_increase` - The check was cancelled by an Increase operator who
2247
+ * - `rejected_by_increase` - The check was canceled by an Increase operator who
2248
2248
  * will provide details out-of-band.
2249
2249
  * - `unknown` - The check was stopped for another reason.
2250
2250
  */
@@ -2440,7 +2440,7 @@ export namespace WireTransferSimulation {
2440
2440
  }
2441
2441
 
2442
2442
  /**
2443
- * An Inbound Real Time Payments Transfer Confirmation object. This field will be
2443
+ * An Inbound Real-Time Payments Transfer Confirmation object. This field will be
2444
2444
  * present in the JSON response if and only if `category` is equal to
2445
2445
  * `inbound_real_time_payments_transfer_confirmation`.
2446
2446
  */
@@ -2458,7 +2458,7 @@ export namespace WireTransferSimulation {
2458
2458
 
2459
2459
  /**
2460
2460
  * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's
2461
- * currency. This will always be "USD" for a Real Time Payments transfer.
2461
+ * currency. This will always be "USD" for a Real-Time Payments transfer.
2462
2462
  *
2463
2463
  * - `CAD` - Canadian Dollar (CAD)
2464
2464
  * - `CHF` - Swiss Franc (CHF)
@@ -2490,7 +2490,7 @@ export namespace WireTransferSimulation {
2490
2490
  remittance_information: string | null;
2491
2491
 
2492
2492
  /**
2493
- * The Real Time Payments network identification of the transfer
2493
+ * The Real-Time Payments network identification of the transfer
2494
2494
  */
2495
2495
  transaction_identification: string;
2496
2496
  }
@@ -2663,7 +2663,7 @@ export namespace WireTransferSimulation {
2663
2663
  /**
2664
2664
  * The ID for the Transaction associated with the transfer reversal.
2665
2665
  */
2666
- transaction_id: string | null;
2666
+ transaction_id: string;
2667
2667
 
2668
2668
  /**
2669
2669
  * The ID for the Wire Transfer that is being reversed.
@@ -2811,7 +2811,7 @@ export namespace WireTransferSimulation {
2811
2811
  }
2812
2812
 
2813
2813
  /**
2814
- * A Real Time Payments Transfer Acknowledgement object. This field will be present
2814
+ * A Real-Time Payments Transfer Acknowledgement object. This field will be present
2815
2815
  * in the JSON response if and only if `category` is equal to
2816
2816
  * `real_time_payments_transfer_acknowledgement`.
2817
2817
  */
@@ -2837,7 +2837,7 @@ export namespace WireTransferSimulation {
2837
2837
  remittance_information: string;
2838
2838
 
2839
2839
  /**
2840
- * The identifier of the Real Time Payments Transfer that led to this Transaction.
2840
+ * The identifier of the Real-Time Payments Transfer that led to this Transaction.
2841
2841
  */
2842
2842
  transfer_id: string;
2843
2843
  }