increase 0.419.0 → 0.430.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (126) hide show
  1. package/CHANGELOG.md +106 -0
  2. package/client.d.mts +3 -2
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +3 -2
  5. package/client.d.ts.map +1 -1
  6. package/client.js +9 -2
  7. package/client.js.map +1 -1
  8. package/client.mjs +9 -2
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/account-transfers.d.mts +6 -6
  12. package/resources/account-transfers.d.mts.map +1 -1
  13. package/resources/account-transfers.d.ts +6 -6
  14. package/resources/account-transfers.d.ts.map +1 -1
  15. package/resources/ach-prenotifications.d.mts +45 -24
  16. package/resources/ach-prenotifications.d.mts.map +1 -1
  17. package/resources/ach-prenotifications.d.ts +45 -24
  18. package/resources/ach-prenotifications.d.ts.map +1 -1
  19. package/resources/ach-transfers.d.mts +56 -34
  20. package/resources/ach-transfers.d.mts.map +1 -1
  21. package/resources/ach-transfers.d.ts +56 -34
  22. package/resources/ach-transfers.d.ts.map +1 -1
  23. package/resources/card-disputes.d.mts +37 -37
  24. package/resources/card-disputes.d.mts.map +1 -1
  25. package/resources/card-disputes.d.ts +37 -37
  26. package/resources/card-disputes.d.ts.map +1 -1
  27. package/resources/card-payments.d.mts +48 -48
  28. package/resources/card-payments.d.mts.map +1 -1
  29. package/resources/card-payments.d.ts +48 -48
  30. package/resources/card-payments.d.ts.map +1 -1
  31. package/resources/card-push-transfers.d.mts +6 -6
  32. package/resources/card-push-transfers.d.mts.map +1 -1
  33. package/resources/card-push-transfers.d.ts +6 -6
  34. package/resources/card-push-transfers.d.ts.map +1 -1
  35. package/resources/card-validations.d.mts +6 -6
  36. package/resources/card-validations.d.mts.map +1 -1
  37. package/resources/card-validations.d.ts +6 -6
  38. package/resources/card-validations.d.ts.map +1 -1
  39. package/resources/check-transfers.d.mts +6 -6
  40. package/resources/check-transfers.d.mts.map +1 -1
  41. package/resources/check-transfers.d.ts +6 -6
  42. package/resources/check-transfers.d.ts.map +1 -1
  43. package/resources/declined-transactions.d.mts +16 -16
  44. package/resources/declined-transactions.d.mts.map +1 -1
  45. package/resources/declined-transactions.d.ts +16 -16
  46. package/resources/declined-transactions.d.ts.map +1 -1
  47. package/resources/digital-card-profiles.d.mts +1 -0
  48. package/resources/digital-card-profiles.d.mts.map +1 -1
  49. package/resources/digital-card-profiles.d.ts +1 -0
  50. package/resources/digital-card-profiles.d.ts.map +1 -1
  51. package/resources/entities.d.mts +3 -2
  52. package/resources/entities.d.mts.map +1 -1
  53. package/resources/entities.d.ts +3 -2
  54. package/resources/entities.d.ts.map +1 -1
  55. package/resources/exports.d.mts +53 -19
  56. package/resources/exports.d.mts.map +1 -1
  57. package/resources/exports.d.ts +53 -19
  58. package/resources/exports.d.ts.map +1 -1
  59. package/resources/fednow-transfers.d.mts +6 -6
  60. package/resources/fednow-transfers.d.mts.map +1 -1
  61. package/resources/fednow-transfers.d.ts +6 -6
  62. package/resources/fednow-transfers.d.ts.map +1 -1
  63. package/resources/inbound-ach-transfers.d.mts +1 -0
  64. package/resources/inbound-ach-transfers.d.mts.map +1 -1
  65. package/resources/inbound-ach-transfers.d.ts +1 -0
  66. package/resources/inbound-ach-transfers.d.ts.map +1 -1
  67. package/resources/lockboxes.d.mts +2 -0
  68. package/resources/lockboxes.d.mts.map +1 -1
  69. package/resources/lockboxes.d.ts +2 -0
  70. package/resources/lockboxes.d.ts.map +1 -1
  71. package/resources/pending-transactions.d.mts +52 -52
  72. package/resources/pending-transactions.d.mts.map +1 -1
  73. package/resources/pending-transactions.d.ts +52 -52
  74. package/resources/pending-transactions.d.ts.map +1 -1
  75. package/resources/real-time-payments-transfers.d.mts +6 -6
  76. package/resources/real-time-payments-transfers.d.mts.map +1 -1
  77. package/resources/real-time-payments-transfers.d.ts +6 -6
  78. package/resources/real-time-payments-transfers.d.ts.map +1 -1
  79. package/resources/simulations/ach-transfers.d.mts +17 -14
  80. package/resources/simulations/ach-transfers.d.mts.map +1 -1
  81. package/resources/simulations/ach-transfers.d.ts +17 -14
  82. package/resources/simulations/ach-transfers.d.ts.map +1 -1
  83. package/resources/simulations/programs.d.mts +1 -3
  84. package/resources/simulations/programs.d.mts.map +1 -1
  85. package/resources/simulations/programs.d.ts +1 -3
  86. package/resources/simulations/programs.d.ts.map +1 -1
  87. package/resources/swift-transfers.d.mts +6 -6
  88. package/resources/swift-transfers.d.mts.map +1 -1
  89. package/resources/swift-transfers.d.ts +6 -6
  90. package/resources/swift-transfers.d.ts.map +1 -1
  91. package/resources/transactions.d.mts +140 -137
  92. package/resources/transactions.d.mts.map +1 -1
  93. package/resources/transactions.d.ts +140 -137
  94. package/resources/transactions.d.ts.map +1 -1
  95. package/resources/wire-transfers.d.mts +8 -8
  96. package/resources/wire-transfers.d.mts.map +1 -1
  97. package/resources/wire-transfers.d.ts +8 -8
  98. package/resources/wire-transfers.d.ts.map +1 -1
  99. package/src/client.ts +15 -4
  100. package/src/resources/account-transfers.ts +7 -7
  101. package/src/resources/ach-prenotifications.ts +45 -24
  102. package/src/resources/ach-transfers.ts +57 -35
  103. package/src/resources/card-disputes.ts +41 -41
  104. package/src/resources/card-payments.ts +63 -63
  105. package/src/resources/card-push-transfers.ts +7 -7
  106. package/src/resources/card-validations.ts +7 -7
  107. package/src/resources/check-transfers.ts +7 -7
  108. package/src/resources/declined-transactions.ts +18 -18
  109. package/src/resources/digital-card-profiles.ts +2 -0
  110. package/src/resources/entities.ts +4 -2
  111. package/src/resources/exports.ts +72 -35
  112. package/src/resources/fednow-transfers.ts +7 -7
  113. package/src/resources/inbound-ach-transfers.ts +2 -0
  114. package/src/resources/lockboxes.ts +4 -0
  115. package/src/resources/pending-transactions.ts +58 -58
  116. package/src/resources/real-time-payments-transfers.ts +7 -7
  117. package/src/resources/simulations/ach-transfers.ts +17 -14
  118. package/src/resources/simulations/programs.ts +1 -9
  119. package/src/resources/swift-transfers.ts +7 -7
  120. package/src/resources/transactions.ts +164 -161
  121. package/src/resources/wire-transfers.ts +9 -9
  122. package/src/version.ts +1 -1
  123. package/version.d.mts +1 -1
  124. package/version.d.ts +1 -1
  125. package/version.js +1 -1
  126. package/version.mjs +1 -1
@@ -273,12 +273,21 @@ export interface ACHTransfer {
273
273
  settlement: ACHTransfer.Settlement | null;
274
274
 
275
275
  /**
276
- * The Standard Entry Class (SEC) code to use for the transfer.
276
+ * The
277
+ * [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
278
+ * to use for the transfer.
277
279
  *
278
- * - `corporate_credit_or_debit` - Corporate Credit and Debit (CCD).
279
- * - `corporate_trade_exchange` - Corporate Trade Exchange (CTX).
280
- * - `prearranged_payments_and_deposit` - Prearranged Payments and Deposits (PPD).
281
- * - `internet_initiated` - Internet Initiated (WEB).
280
+ * - `corporate_credit_or_debit` - Corporate Credit and Debit (CCD) is used for
281
+ * business-to-business payments.
282
+ * - `corporate_trade_exchange` - Corporate Trade Exchange (CTX) allows for
283
+ * including extensive remittance information with business-to-business payments.
284
+ * - `prearranged_payments_and_deposit` - Prearranged Payments and Deposits (PPD)
285
+ * is used for credits or debits originated by an organization to a consumer,
286
+ * such as payroll direct deposits.
287
+ * - `internet_initiated` - Internet Initiated (WEB) is used for consumer payments
288
+ * initiated or authorized via the Internet. Debits can only be initiated by
289
+ * non-consumers to debit a consumer’s account. Credits can only be used for
290
+ * consumer to consumer transactions.
282
291
  */
283
292
  standard_entry_class_code:
284
293
  | 'corporate_credit_or_debit'
@@ -375,13 +384,13 @@ export namespace ACHTransfer {
375
384
  /**
376
385
  * Unstructured `payment_related_information` passed through with the transfer.
377
386
  */
378
- freeform: Addenda.Freeform | null;
387
+ freeform?: Addenda.Freeform | null;
379
388
 
380
389
  /**
381
390
  * Structured ASC X12 820 remittance advice records. Please reach out to
382
391
  * [support@increase.com](mailto:support@increase.com) for more information.
383
392
  */
384
- payment_order_remittance_advice: Addenda.PaymentOrderRemittanceAdvice | null;
393
+ payment_order_remittance_advice?: Addenda.PaymentOrderRemittanceAdvice | null;
385
394
  }
386
395
 
387
396
  export namespace Addenda {
@@ -471,11 +480,6 @@ export namespace ACHTransfer {
471
480
  * What object created the transfer, either via the API or the dashboard.
472
481
  */
473
482
  export interface CreatedBy {
474
- /**
475
- * If present, details about the API key that created the transfer.
476
- */
477
- api_key: CreatedBy.APIKey | null;
478
-
479
483
  /**
480
484
  * The type of object that created this transfer.
481
485
  *
@@ -487,15 +491,20 @@ export namespace ACHTransfer {
487
491
  */
488
492
  category: 'api_key' | 'oauth_application' | 'user';
489
493
 
494
+ /**
495
+ * If present, details about the API key that created the transfer.
496
+ */
497
+ api_key?: CreatedBy.APIKey | null;
498
+
490
499
  /**
491
500
  * If present, details about the OAuth Application that created the transfer.
492
501
  */
493
- oauth_application: CreatedBy.OAuthApplication | null;
502
+ oauth_application?: CreatedBy.OAuthApplication | null;
494
503
 
495
504
  /**
496
505
  * If present, details about the User that created the transfer.
497
506
  */
498
- user: CreatedBy.User | null;
507
+ user?: CreatedBy.User | null;
499
508
  }
500
509
 
501
510
  export namespace CreatedBy {
@@ -717,24 +726,28 @@ export namespace ACHTransfer {
717
726
  * bank back to Increase.
718
727
  *
719
728
  * - `insufficient_fund` - Code R01. Insufficient funds in the receiving account.
720
- * Sometimes abbreviated to NSF.
729
+ * Sometimes abbreviated to "NSF."
721
730
  * - `no_account` - Code R03. The account does not exist or the receiving bank was
722
731
  * unable to locate it.
723
732
  * - `account_closed` - Code R02. The account is closed at the receiving bank.
724
733
  * - `invalid_account_number_structure` - Code R04. The account number is invalid
725
734
  * at the receiving bank.
726
- * - `account_frozen_entry_returned_per_ofac_instruction` - Code R16. The account
727
- * at the receiving bank was frozen per the Office of Foreign Assets Control.
728
- * - `credit_entry_refused_by_receiver` - Code R23. The receiving bank account
729
- * refused a credit transfer.
735
+ * - `account_frozen_entry_returned_per_ofac_instruction` - Code R16. This return
736
+ * code has two separate meanings. (1) The receiving bank froze the account or
737
+ * (2) the Office of Foreign Assets Control (OFAC) instructed the receiving bank
738
+ * to return the entry.
739
+ * - `credit_entry_refused_by_receiver` - Code R23. The receiving bank refused the
740
+ * credit transfer.
730
741
  * - `unauthorized_debit_to_consumer_account_using_corporate_sec_code` - Code R05.
731
742
  * The receiving bank rejected because of an incorrect Standard Entry Class code.
743
+ * Consumer accounts cannot be debited as `corporate_credit_or_debit` or
744
+ * `corporate_trade_exchange`.
732
745
  * - `corporate_customer_advised_not_authorized` - Code R29. The corporate customer
733
746
  * at the receiving bank reversed the transfer.
734
747
  * - `payment_stopped` - Code R08. The receiving bank stopped payment on this
735
748
  * transfer.
736
- * - `non_transaction_account` - Code R20. The receiving bank account does not
737
- * perform transfers.
749
+ * - `non_transaction_account` - Code R20. The account is not eligible for ACH,
750
+ * such as a savings account with transaction limits.
738
751
  * - `uncollected_funds` - Code R09. The receiving bank account does not have
739
752
  * enough available balance for the transfer.
740
753
  * - `routing_number_check_digit_error` - Code R28. The routing number is
@@ -742,14 +755,13 @@ export namespace ACHTransfer {
742
755
  * - `customer_advised_unauthorized_improper_ineligible_or_incomplete` - Code R10.
743
756
  * The customer at the receiving bank reversed the transfer.
744
757
  * - `amount_field_error` - Code R19. The amount field is incorrect or too large.
745
- * - `authorization_revoked_by_customer` - Code R07. The customer at the receiving
746
- * institution informed their bank that they have revoked authorization for a
747
- * previously authorized transfer.
758
+ * - `authorization_revoked_by_customer` - Code R07. The customer revoked their
759
+ * authorization for a previously authorized transfer.
748
760
  * - `invalid_ach_routing_number` - Code R13. The routing number is invalid.
749
761
  * - `file_record_edit_criteria` - Code R17. The receiving bank is unable to
750
762
  * process a field in the transfer.
751
- * - `enr_invalid_individual_name` - Code R45. The individual name field was
752
- * invalid.
763
+ * - `enr_invalid_individual_name` - Code R45. A rare return reason. The individual
764
+ * name field was invalid.
753
765
  * - `returned_per_odfi_request` - Code R06. The originating financial institution
754
766
  * asked for this transfer to be returned. The receiving bank is complying with
755
767
  * the request.
@@ -844,8 +856,8 @@ export namespace ACHTransfer {
844
856
  * a malformed credit entry.
845
857
  * - `return_of_improper_debit_entry` - Code R35. A rare return reason. Return of a
846
858
  * malformed debit entry.
847
- * - `return_of_xck_entry` - Code R33. A rare return reason. Return of a Destroyed
848
- * Check ("XKC") entry.
859
+ * - `return_of_xck_entry` - Code R33. A rare return reason. Return of a destroyed
860
+ * check ("XCK") entry.
849
861
  * - `source_document_presented_for_payment` - Code R37. A rare return reason. The
850
862
  * source document related to this ACH, usually an ACH check conversion, was
851
863
  * presented to the bank.
@@ -1076,8 +1088,9 @@ export interface ACHTransferCreateParams {
1076
1088
  company_discretionary_data?: string;
1077
1089
 
1078
1090
  /**
1079
- * A description of the transfer. This is included in the transfer data sent to the
1080
- * receiving bank.
1091
+ * A description of the transfer, included in the transfer data sent to the
1092
+ * receiving bank. Standardized formatting may be required, for example `PAYROLL`
1093
+ * for payroll-related Prearranged Payments and Deposits (PPD) credit transfers.
1081
1094
  */
1082
1095
  company_entry_description?: string;
1083
1096
 
@@ -1143,12 +1156,21 @@ export interface ACHTransferCreateParams {
1143
1156
  routing_number?: string;
1144
1157
 
1145
1158
  /**
1146
- * The Standard Entry Class (SEC) code to use for the transfer.
1159
+ * The
1160
+ * [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
1161
+ * to use for the transfer.
1147
1162
  *
1148
- * - `corporate_credit_or_debit` - Corporate Credit and Debit (CCD).
1149
- * - `corporate_trade_exchange` - Corporate Trade Exchange (CTX).
1150
- * - `prearranged_payments_and_deposit` - Prearranged Payments and Deposits (PPD).
1151
- * - `internet_initiated` - Internet Initiated (WEB).
1163
+ * - `corporate_credit_or_debit` - Corporate Credit and Debit (CCD) is used for
1164
+ * business-to-business payments.
1165
+ * - `corporate_trade_exchange` - Corporate Trade Exchange (CTX) allows for
1166
+ * including extensive remittance information with business-to-business payments.
1167
+ * - `prearranged_payments_and_deposit` - Prearranged Payments and Deposits (PPD)
1168
+ * is used for credits or debits originated by an organization to a consumer,
1169
+ * such as payroll direct deposits.
1170
+ * - `internet_initiated` - Internet Initiated (WEB) is used for consumer payments
1171
+ * initiated or authorized via the Internet. Debits can only be initiated by
1172
+ * non-consumers to debit a consumer’s account. Credits can only be used for
1173
+ * consumer to consumer transactions.
1152
1174
  */
1153
1175
  standard_entry_class_code?:
1154
1176
  | 'corporate_credit_or_debit'
@@ -326,6 +326,17 @@ export namespace CardDispute {
326
326
  | 'user_prearbitration_timed_out'
327
327
  | 'user_withdrawal_submitted';
328
328
 
329
+ /**
330
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
331
+ * the Visa Card Dispute Network Event was created.
332
+ */
333
+ created_at: string;
334
+
335
+ /**
336
+ * The dispute financial transaction that resulted from the network event, if any.
337
+ */
338
+ dispute_financial_transaction_id: string | null;
339
+
329
340
  /**
330
341
  * A Card Dispute Chargeback Accepted Visa Network Event object. This field will be
331
342
  * present in the JSON response if and only if `category` is equal to
@@ -333,7 +344,7 @@ export namespace CardDispute {
333
344
  * Visa Card Dispute Network Event, which represents that a chargeback has been
334
345
  * accepted by the merchant.
335
346
  */
336
- chargeback_accepted: NetworkEvent.ChargebackAccepted | null;
347
+ chargeback_accepted?: NetworkEvent.ChargebackAccepted | null;
337
348
 
338
349
  /**
339
350
  * A Card Dispute Chargeback Submitted Visa Network Event object. This field will
@@ -342,7 +353,7 @@ export namespace CardDispute {
342
353
  * Visa Card Dispute Network Event, which represents that a chargeback has been
343
354
  * submitted to the network.
344
355
  */
345
- chargeback_submitted: NetworkEvent.ChargebackSubmitted | null;
356
+ chargeback_submitted?: NetworkEvent.ChargebackSubmitted | null;
346
357
 
347
358
  /**
348
359
  * A Card Dispute Chargeback Timed Out Visa Network Event object. This field will
@@ -351,18 +362,7 @@ export namespace CardDispute {
351
362
  * Visa Card Dispute Network Event, which represents that the chargeback has timed
352
363
  * out in the user's favor.
353
364
  */
354
- chargeback_timed_out: NetworkEvent.ChargebackTimedOut | null;
355
-
356
- /**
357
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
358
- * the Visa Card Dispute Network Event was created.
359
- */
360
- created_at: string;
361
-
362
- /**
363
- * The dispute financial transaction that resulted from the network event, if any.
364
- */
365
- dispute_financial_transaction_id: string | null;
365
+ chargeback_timed_out?: NetworkEvent.ChargebackTimedOut | null;
366
366
 
367
367
  /**
368
368
  * A Card Dispute Merchant Pre-Arbitration Decline Submitted Visa Network Event
@@ -372,7 +372,7 @@ export namespace CardDispute {
372
372
  * Dispute Network Event, which represents that the user has declined the
373
373
  * merchant's request for a prearbitration request decision in their favor.
374
374
  */
375
- merchant_prearbitration_decline_submitted: NetworkEvent.MerchantPrearbitrationDeclineSubmitted | null;
375
+ merchant_prearbitration_decline_submitted?: NetworkEvent.MerchantPrearbitrationDeclineSubmitted | null;
376
376
 
377
377
  /**
378
378
  * A Card Dispute Merchant Pre-Arbitration Received Visa Network Event object. This
@@ -381,7 +381,7 @@ export namespace CardDispute {
381
381
  * prearbitration received Visa Card Dispute Network Event, which represents that
382
382
  * the merchant has issued a prearbitration request in the user's favor.
383
383
  */
384
- merchant_prearbitration_received: NetworkEvent.MerchantPrearbitrationReceived | null;
384
+ merchant_prearbitration_received?: NetworkEvent.MerchantPrearbitrationReceived | null;
385
385
 
386
386
  /**
387
387
  * A Card Dispute Merchant Pre-Arbitration Timed Out Visa Network Event object.
@@ -391,7 +391,7 @@ export namespace CardDispute {
391
391
  * represents that the user has timed out responding to the merchant's
392
392
  * prearbitration request.
393
393
  */
394
- merchant_prearbitration_timed_out: NetworkEvent.MerchantPrearbitrationTimedOut | null;
394
+ merchant_prearbitration_timed_out?: NetworkEvent.MerchantPrearbitrationTimedOut | null;
395
395
 
396
396
  /**
397
397
  * A Card Dispute Re-presented Visa Network Event object. This field will be
@@ -400,7 +400,7 @@ export namespace CardDispute {
400
400
  * Network Event, which represents that the merchant has declined the user's
401
401
  * chargeback and has re-presented the payment.
402
402
  */
403
- represented: NetworkEvent.Represented | null;
403
+ represented?: NetworkEvent.Represented | null;
404
404
 
405
405
  /**
406
406
  * A Card Dispute Re-presentment Timed Out Visa Network Event object. This field
@@ -409,7 +409,7 @@ export namespace CardDispute {
409
409
  * time-out Visa Card Dispute Network Event, which represents that the user did not
410
410
  * respond to the re-presentment by the merchant within the time limit.
411
411
  */
412
- representment_timed_out: NetworkEvent.RepresentmentTimedOut | null;
412
+ representment_timed_out?: NetworkEvent.RepresentmentTimedOut | null;
413
413
 
414
414
  /**
415
415
  * A Card Dispute User Pre-Arbitration Accepted Visa Network Event object. This
@@ -418,7 +418,7 @@ export namespace CardDispute {
418
418
  * prearbitration accepted Visa Card Dispute Network Event, which represents that
419
419
  * the merchant has accepted the user's prearbitration request in the user's favor.
420
420
  */
421
- user_prearbitration_accepted: NetworkEvent.UserPrearbitrationAccepted | null;
421
+ user_prearbitration_accepted?: NetworkEvent.UserPrearbitrationAccepted | null;
422
422
 
423
423
  /**
424
424
  * A Card Dispute User Pre-Arbitration Declined Visa Network Event object. This
@@ -427,7 +427,7 @@ export namespace CardDispute {
427
427
  * prearbitration declined Visa Card Dispute Network Event, which represents that
428
428
  * the merchant has declined the user's prearbitration request.
429
429
  */
430
- user_prearbitration_declined: NetworkEvent.UserPrearbitrationDeclined | null;
430
+ user_prearbitration_declined?: NetworkEvent.UserPrearbitrationDeclined | null;
431
431
 
432
432
  /**
433
433
  * A Card Dispute User Pre-Arbitration Submitted Visa Network Event object. This
@@ -436,7 +436,7 @@ export namespace CardDispute {
436
436
  * prearbitration submitted Visa Card Dispute Network Event, which represents that
437
437
  * the user's request for prearbitration has been submitted to the network.
438
438
  */
439
- user_prearbitration_submitted: NetworkEvent.UserPrearbitrationSubmitted | null;
439
+ user_prearbitration_submitted?: NetworkEvent.UserPrearbitrationSubmitted | null;
440
440
 
441
441
  /**
442
442
  * A Card Dispute User Pre-Arbitration Timed Out Visa Network Event object. This
@@ -445,7 +445,7 @@ export namespace CardDispute {
445
445
  * prearbitration timed out Visa Card Dispute Network Event, which represents that
446
446
  * the merchant has timed out responding to the user's prearbitration request.
447
447
  */
448
- user_prearbitration_timed_out: NetworkEvent.UserPrearbitrationTimedOut | null;
448
+ user_prearbitration_timed_out?: NetworkEvent.UserPrearbitrationTimedOut | null;
449
449
 
450
450
  /**
451
451
  * A Card Dispute User Withdrawal Submitted Visa Network Event object. This field
@@ -454,7 +454,7 @@ export namespace CardDispute {
454
454
  * submitted Visa Card Dispute Network Event, which represents that the user's
455
455
  * request to withdraw the dispute has been submitted to the network.
456
456
  */
457
- user_withdrawal_submitted: NetworkEvent.UserWithdrawalSubmitted | null;
457
+ user_withdrawal_submitted?: NetworkEvent.UserWithdrawalSubmitted | null;
458
458
  }
459
459
 
460
460
  export namespace NetworkEvent {
@@ -1129,14 +1129,6 @@ export namespace CardDispute {
1129
1129
  */
1130
1130
  category: 'chargeback' | 'merchant_prearbitration_decline' | 'user_prearbitration';
1131
1131
 
1132
- /**
1133
- * A Visa Card Dispute Chargeback User Submission Chargeback Details object. This
1134
- * field will be present in the JSON response if and only if `category` is equal to
1135
- * `chargeback`. Contains the details specific to a Visa chargeback User Submission
1136
- * for a Card Dispute.
1137
- */
1138
- chargeback: UserSubmission.Chargeback | null;
1139
-
1140
1132
  /**
1141
1133
  * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1142
1134
  * the Visa Card Dispute User Submission was created.
@@ -1161,14 +1153,6 @@ export namespace CardDispute {
1161
1153
  */
1162
1154
  further_information_requested_reason: string | null;
1163
1155
 
1164
- /**
1165
- * A Visa Card Dispute Merchant Pre-Arbitration Decline User Submission object.
1166
- * This field will be present in the JSON response if and only if `category` is
1167
- * equal to `merchant_prearbitration_decline`. Contains the details specific to a
1168
- * merchant prearbitration decline Visa Card Dispute User Submission.
1169
- */
1170
- merchant_prearbitration_decline: UserSubmission.MerchantPrearbitrationDecline | null;
1171
-
1172
1156
  /**
1173
1157
  * The status of the Visa Card Dispute User Submission.
1174
1158
  *
@@ -1186,13 +1170,29 @@ export namespace CardDispute {
1186
1170
  */
1187
1171
  updated_at: string;
1188
1172
 
1173
+ /**
1174
+ * A Visa Card Dispute Chargeback User Submission Chargeback Details object. This
1175
+ * field will be present in the JSON response if and only if `category` is equal to
1176
+ * `chargeback`. Contains the details specific to a Visa chargeback User Submission
1177
+ * for a Card Dispute.
1178
+ */
1179
+ chargeback?: UserSubmission.Chargeback | null;
1180
+
1181
+ /**
1182
+ * A Visa Card Dispute Merchant Pre-Arbitration Decline User Submission object.
1183
+ * This field will be present in the JSON response if and only if `category` is
1184
+ * equal to `merchant_prearbitration_decline`. Contains the details specific to a
1185
+ * merchant prearbitration decline Visa Card Dispute User Submission.
1186
+ */
1187
+ merchant_prearbitration_decline?: UserSubmission.MerchantPrearbitrationDecline | null;
1188
+
1189
1189
  /**
1190
1190
  * A Visa Card Dispute User-Initiated Pre-Arbitration User Submission object. This
1191
1191
  * field will be present in the JSON response if and only if `category` is equal to
1192
1192
  * `user_prearbitration`. Contains the details specific to a user-initiated
1193
1193
  * pre-arbitration Visa Card Dispute User Submission.
1194
1194
  */
1195
- user_prearbitration: UserSubmission.UserPrearbitration | null;
1195
+ user_prearbitration?: UserSubmission.UserPrearbitration | null;
1196
1196
  }
1197
1197
 
1198
1198
  export namespace UserSubmission {
@@ -97,12 +97,62 @@ export interface CardPayment {
97
97
 
98
98
  export namespace CardPayment {
99
99
  export interface Element {
100
+ /**
101
+ * The type of the resource. We may add additional possible values for this enum
102
+ * over time; your application should be able to handle such additions gracefully.
103
+ *
104
+ * - `card_authorization` - Card Authorization: details will be under the
105
+ * `card_authorization` object.
106
+ * - `card_authentication` - Card Authentication: details will be under the
107
+ * `card_authentication` object.
108
+ * - `card_balance_inquiry` - Card Balance Inquiry: details will be under the
109
+ * `card_balance_inquiry` object.
110
+ * - `card_validation` - Inbound Card Validation: details will be under the
111
+ * `card_validation` object.
112
+ * - `card_decline` - Card Decline: details will be under the `card_decline`
113
+ * object.
114
+ * - `card_reversal` - Card Reversal: details will be under the `card_reversal`
115
+ * object.
116
+ * - `card_authorization_expiration` - Card Authorization Expiration: details will
117
+ * be under the `card_authorization_expiration` object.
118
+ * - `card_increment` - Card Increment: details will be under the `card_increment`
119
+ * object.
120
+ * - `card_settlement` - Card Settlement: details will be under the
121
+ * `card_settlement` object.
122
+ * - `card_refund` - Card Refund: details will be under the `card_refund` object.
123
+ * - `card_fuel_confirmation` - Card Fuel Confirmation: details will be under the
124
+ * `card_fuel_confirmation` object.
125
+ * - `card_financial` - Card Financial: details will be under the `card_financial`
126
+ * object.
127
+ * - `other` - Unknown card payment element.
128
+ */
129
+ category:
130
+ | 'card_authorization'
131
+ | 'card_authentication'
132
+ | 'card_balance_inquiry'
133
+ | 'card_validation'
134
+ | 'card_decline'
135
+ | 'card_reversal'
136
+ | 'card_authorization_expiration'
137
+ | 'card_increment'
138
+ | 'card_settlement'
139
+ | 'card_refund'
140
+ | 'card_fuel_confirmation'
141
+ | 'card_financial'
142
+ | 'other';
143
+
144
+ /**
145
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
146
+ * the card payment element was created.
147
+ */
148
+ created_at: string;
149
+
100
150
  /**
101
151
  * A Card Authentication object. This field will be present in the JSON response if
102
152
  * and only if `category` is equal to `card_authentication`. Card Authentications
103
153
  * are attempts to authenticate a transaction or a card with 3DS.
104
154
  */
105
- card_authentication: Element.CardAuthentication | null;
155
+ card_authentication?: Element.CardAuthentication | null;
106
156
 
107
157
  /**
108
158
  * A Card Authorization object. This field will be present in the JSON response if
@@ -110,7 +160,7 @@ export namespace CardPayment {
110
160
  * temporary holds placed on a customers funds with the intent to later clear a
111
161
  * transaction.
112
162
  */
113
- card_authorization: Element.CardAuthorization | null;
163
+ card_authorization?: Element.CardAuthorization | null;
114
164
 
115
165
  /**
116
166
  * A Card Authorization Expiration object. This field will be present in the JSON
@@ -118,7 +168,7 @@ export namespace CardPayment {
118
168
  * Card Authorization Expirations are cancellations of authorizations that were
119
169
  * never settled by the acquirer.
120
170
  */
121
- card_authorization_expiration: Element.CardAuthorizationExpiration | null;
171
+ card_authorization_expiration?: Element.CardAuthorizationExpiration | null;
122
172
 
123
173
  /**
124
174
  * A Card Balance Inquiry object. This field will be present in the JSON response
@@ -127,20 +177,20 @@ export namespace CardPayment {
127
177
  * on a card without placing a hold on funds, commonly used when a customer
128
178
  * requests their balance at an ATM.
129
179
  */
130
- card_balance_inquiry: Element.CardBalanceInquiry | null;
180
+ card_balance_inquiry?: Element.CardBalanceInquiry | null;
131
181
 
132
182
  /**
133
183
  * A Card Decline object. This field will be present in the JSON response if and
134
184
  * only if `category` is equal to `card_decline`.
135
185
  */
136
- card_decline: Element.CardDecline | null;
186
+ card_decline?: Element.CardDecline | null;
137
187
 
138
188
  /**
139
189
  * A Card Financial object. This field will be present in the JSON response if and
140
190
  * only if `category` is equal to `card_financial`. Card Financials are temporary
141
191
  * holds placed on a customers funds with the intent to later clear a transaction.
142
192
  */
143
- card_financial: Element.CardFinancial | null;
193
+ card_financial?: Element.CardFinancial | null;
144
194
 
145
195
  /**
146
196
  * A Card Fuel Confirmation object. This field will be present in the JSON response
@@ -148,14 +198,14 @@ export namespace CardPayment {
148
198
  * Confirmations update the amount of a Card Authorization after a fuel pump
149
199
  * transaction is completed.
150
200
  */
151
- card_fuel_confirmation: Element.CardFuelConfirmation | null;
201
+ card_fuel_confirmation?: Element.CardFuelConfirmation | null;
152
202
 
153
203
  /**
154
204
  * A Card Increment object. This field will be present in the JSON response if and
155
205
  * only if `category` is equal to `card_increment`. Card Increments increase the
156
206
  * pending amount of an authorized transaction.
157
207
  */
158
- card_increment: Element.CardIncrement | null;
208
+ card_increment?: Element.CardIncrement | null;
159
209
 
160
210
  /**
161
211
  * A Card Refund object. This field will be present in the JSON response if and
@@ -164,14 +214,14 @@ export namespace CardPayment {
164
214
  * acquirer can also refund money directly to a card without relation to a
165
215
  * transaction.
166
216
  */
167
- card_refund: Element.CardRefund | null;
217
+ card_refund?: Element.CardRefund | null;
168
218
 
169
219
  /**
170
220
  * A Card Reversal object. This field will be present in the JSON response if and
171
221
  * only if `category` is equal to `card_reversal`. Card Reversals cancel parts of
172
222
  * or the entirety of an existing Card Authorization.
173
223
  */
174
- card_reversal: Element.CardReversal | null;
224
+ card_reversal?: Element.CardReversal | null;
175
225
 
176
226
  /**
177
227
  * A Card Settlement object. This field will be present in the JSON response if and
@@ -180,7 +230,7 @@ export namespace CardPayment {
180
230
  * preceded by an authorization, an acquirer can also directly clear a transaction
181
231
  * without first authorizing it.
182
232
  */
183
- card_settlement: Element.CardSettlement | null;
233
+ card_settlement?: Element.CardSettlement | null;
184
234
 
185
235
  /**
186
236
  * An Inbound Card Validation object. This field will be present in the JSON
@@ -188,63 +238,13 @@ export namespace CardPayment {
188
238
  * Validations are requests from a merchant to verify that a card number and
189
239
  * optionally its address and/or Card Verification Value are valid.
190
240
  */
191
- card_validation: Element.CardValidation | null;
192
-
193
- /**
194
- * The type of the resource. We may add additional possible values for this enum
195
- * over time; your application should be able to handle such additions gracefully.
196
- *
197
- * - `card_authorization` - Card Authorization: details will be under the
198
- * `card_authorization` object.
199
- * - `card_authentication` - Card Authentication: details will be under the
200
- * `card_authentication` object.
201
- * - `card_balance_inquiry` - Card Balance Inquiry: details will be under the
202
- * `card_balance_inquiry` object.
203
- * - `card_validation` - Inbound Card Validation: details will be under the
204
- * `card_validation` object.
205
- * - `card_decline` - Card Decline: details will be under the `card_decline`
206
- * object.
207
- * - `card_reversal` - Card Reversal: details will be under the `card_reversal`
208
- * object.
209
- * - `card_authorization_expiration` - Card Authorization Expiration: details will
210
- * be under the `card_authorization_expiration` object.
211
- * - `card_increment` - Card Increment: details will be under the `card_increment`
212
- * object.
213
- * - `card_settlement` - Card Settlement: details will be under the
214
- * `card_settlement` object.
215
- * - `card_refund` - Card Refund: details will be under the `card_refund` object.
216
- * - `card_fuel_confirmation` - Card Fuel Confirmation: details will be under the
217
- * `card_fuel_confirmation` object.
218
- * - `card_financial` - Card Financial: details will be under the `card_financial`
219
- * object.
220
- * - `other` - Unknown card payment element.
221
- */
222
- category:
223
- | 'card_authorization'
224
- | 'card_authentication'
225
- | 'card_balance_inquiry'
226
- | 'card_validation'
227
- | 'card_decline'
228
- | 'card_reversal'
229
- | 'card_authorization_expiration'
230
- | 'card_increment'
231
- | 'card_settlement'
232
- | 'card_refund'
233
- | 'card_fuel_confirmation'
234
- | 'card_financial'
235
- | 'other';
236
-
237
- /**
238
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
239
- * the card payment element was created.
240
- */
241
- created_at: string;
241
+ card_validation?: Element.CardValidation | null;
242
242
 
243
243
  /**
244
244
  * If the category of this Transaction source is equal to `other`, this field will
245
245
  * contain an empty object, otherwise it will contain null.
246
246
  */
247
- other: Element.Other | null;
247
+ other?: Element.Other | null;
248
248
  }
249
249
 
250
250
  export namespace Element {
@@ -395,11 +395,6 @@ export namespace CardPushTransfer {
395
395
  * What object created the transfer, either via the API or the dashboard.
396
396
  */
397
397
  export interface CreatedBy {
398
- /**
399
- * If present, details about the API key that created the transfer.
400
- */
401
- api_key: CreatedBy.APIKey | null;
402
-
403
398
  /**
404
399
  * The type of object that created this transfer.
405
400
  *
@@ -411,15 +406,20 @@ export namespace CardPushTransfer {
411
406
  */
412
407
  category: 'api_key' | 'oauth_application' | 'user';
413
408
 
409
+ /**
410
+ * If present, details about the API key that created the transfer.
411
+ */
412
+ api_key?: CreatedBy.APIKey | null;
413
+
414
414
  /**
415
415
  * If present, details about the OAuth Application that created the transfer.
416
416
  */
417
- oauth_application: CreatedBy.OAuthApplication | null;
417
+ oauth_application?: CreatedBy.OAuthApplication | null;
418
418
 
419
419
  /**
420
420
  * If present, details about the User that created the transfer.
421
421
  */
422
- user: CreatedBy.User | null;
422
+ user?: CreatedBy.User | null;
423
423
  }
424
424
 
425
425
  export namespace CreatedBy {
@@ -289,11 +289,6 @@ export namespace CardValidation {
289
289
  * What object created the validation, either via the API or the dashboard.
290
290
  */
291
291
  export interface CreatedBy {
292
- /**
293
- * If present, details about the API key that created the transfer.
294
- */
295
- api_key: CreatedBy.APIKey | null;
296
-
297
292
  /**
298
293
  * The type of object that created this transfer.
299
294
  *
@@ -305,15 +300,20 @@ export namespace CardValidation {
305
300
  */
306
301
  category: 'api_key' | 'oauth_application' | 'user';
307
302
 
303
+ /**
304
+ * If present, details about the API key that created the transfer.
305
+ */
306
+ api_key?: CreatedBy.APIKey | null;
307
+
308
308
  /**
309
309
  * If present, details about the OAuth Application that created the transfer.
310
310
  */
311
- oauth_application: CreatedBy.OAuthApplication | null;
311
+ oauth_application?: CreatedBy.OAuthApplication | null;
312
312
 
313
313
  /**
314
314
  * If present, details about the User that created the transfer.
315
315
  */
316
- user: CreatedBy.User | null;
316
+ user?: CreatedBy.User | null;
317
317
  }
318
318
 
319
319
  export namespace CreatedBy {