increase 0.12.0 → 0.13.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 (52) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/core.d.ts.map +1 -1
  3. package/core.js +12 -10
  4. package/core.js.map +1 -1
  5. package/core.mjs +12 -10
  6. package/core.mjs.map +1 -1
  7. package/package.json +1 -1
  8. package/resources/card-payments.d.ts +275 -2
  9. package/resources/card-payments.d.ts.map +1 -1
  10. package/resources/card-payments.js.map +1 -1
  11. package/resources/card-payments.mjs.map +1 -1
  12. package/resources/declined-transactions.d.ts +76 -1
  13. package/resources/declined-transactions.d.ts.map +1 -1
  14. package/resources/declined-transactions.js.map +1 -1
  15. package/resources/declined-transactions.mjs.map +1 -1
  16. package/resources/inbound-ach-transfers.d.ts +8 -2
  17. package/resources/inbound-ach-transfers.d.ts.map +1 -1
  18. package/resources/inbound-ach-transfers.js.map +1 -1
  19. package/resources/inbound-ach-transfers.mjs.map +1 -1
  20. package/resources/pending-transactions.d.ts +73 -0
  21. package/resources/pending-transactions.d.ts.map +1 -1
  22. package/resources/pending-transactions.js.map +1 -1
  23. package/resources/pending-transactions.mjs.map +1 -1
  24. package/resources/real-time-decisions.d.ts +73 -0
  25. package/resources/real-time-decisions.d.ts.map +1 -1
  26. package/resources/real-time-decisions.js.map +1 -1
  27. package/resources/real-time-decisions.mjs.map +1 -1
  28. package/resources/simulations/ach-transfers.d.ts +80 -2
  29. package/resources/simulations/ach-transfers.d.ts.map +1 -1
  30. package/resources/simulations/ach-transfers.js.map +1 -1
  31. package/resources/simulations/ach-transfers.mjs.map +1 -1
  32. package/resources/simulations/cards.d.ts +149 -1
  33. package/resources/simulations/cards.d.ts.map +1 -1
  34. package/resources/simulations/cards.js.map +1 -1
  35. package/resources/simulations/cards.mjs.map +1 -1
  36. package/resources/simulations/real-time-payments-transfers.d.ts +76 -1
  37. package/resources/simulations/real-time-payments-transfers.d.ts.map +1 -1
  38. package/resources/simulations/real-time-payments-transfers.js.map +1 -1
  39. package/resources/simulations/real-time-payments-transfers.mjs.map +1 -1
  40. package/src/core.ts +13 -12
  41. package/src/resources/card-payments.ts +328 -1
  42. package/src/resources/declined-transactions.ts +92 -1
  43. package/src/resources/inbound-ach-transfers.ts +8 -0
  44. package/src/resources/pending-transactions.ts +88 -0
  45. package/src/resources/real-time-decisions.ts +88 -0
  46. package/src/resources/simulations/ach-transfers.ts +96 -1
  47. package/src/resources/simulations/cards.ts +180 -1
  48. package/src/resources/simulations/real-time-payments-transfers.ts +92 -1
  49. package/src/version.ts +1 -1
  50. package/version.d.ts +1 -1
  51. package/version.js +1 -1
  52. package/version.mjs +1 -1
@@ -418,6 +418,11 @@ export namespace DeclinedTransaction {
418
418
  | 'invalid_physical_card'
419
419
  | 'missing_original_authorization'
420
420
  | 'suspected_fraud';
421
+
422
+ /**
423
+ * Fields related to verification of cardholder-provided values.
424
+ */
425
+ verification: CardDecline.Verification;
421
426
  }
422
427
 
423
428
  export namespace CardDecline {
@@ -521,6 +526,89 @@ export namespace DeclinedTransaction {
521
526
  | null;
522
527
  }
523
528
  }
529
+
530
+ /**
531
+ * Fields related to verification of cardholder-provided values.
532
+ */
533
+ export interface Verification {
534
+ /**
535
+ * Fields related to verification of the Card Verification Code, a 3-digit code on
536
+ * the back of the card.
537
+ */
538
+ card_verification_code: Verification.CardVerificationCode;
539
+
540
+ /**
541
+ * Cardholder address provided in the authorization request and the address on file
542
+ * we verified it against.
543
+ */
544
+ cardholder_address: Verification.CardholderAddress;
545
+ }
546
+
547
+ export namespace Verification {
548
+ /**
549
+ * Fields related to verification of the Card Verification Code, a 3-digit code on
550
+ * the back of the card.
551
+ */
552
+ export interface CardVerificationCode {
553
+ /**
554
+ * The result of verifying the Card Verification Code.
555
+ *
556
+ * - `not_checked` - No card verification code was provided in the authorization
557
+ * request.
558
+ * - `match` - The card verification code matched the one on file.
559
+ * - `no_match` - The card verification code did not match the one on file.
560
+ */
561
+ result: 'not_checked' | 'match' | 'no_match';
562
+ }
563
+
564
+ /**
565
+ * Cardholder address provided in the authorization request and the address on file
566
+ * we verified it against.
567
+ */
568
+ export interface CardholderAddress {
569
+ /**
570
+ * Line 1 of the address on file for the cardholder.
571
+ */
572
+ actual_line1: string | null;
573
+
574
+ /**
575
+ * The postal code of the address on file for the cardholder.
576
+ */
577
+ actual_postal_code: string | null;
578
+
579
+ /**
580
+ * The cardholder address line 1 provided for verification in the authorization
581
+ * request.
582
+ */
583
+ provided_line1: string | null;
584
+
585
+ /**
586
+ * The postal code provided for verification in the authorization request.
587
+ */
588
+ provided_postal_code: string | null;
589
+
590
+ /**
591
+ * The address verification result returned to the card network.
592
+ *
593
+ * - `not_checked` - No adress was provided in the authorization request.
594
+ * - `postal_code_match_address_not_checked` - Postal code matches, but the street
595
+ * address was not verified.
596
+ * - `postal_code_match_address_no_match` - Postal code matches, but the street
597
+ * address does not match.
598
+ * - `postal_code_no_match_address_match` - Postal code does not match, but the
599
+ * street address matches.
600
+ * - `match` - Postal code and street address match.
601
+ * - `no_match` - Postal code and street address do not match.
602
+ */
603
+ result:
604
+ | 'not_checked'
605
+ | 'postal_code_match_address_not_checked'
606
+ | 'postal_code_match_address_no_match'
607
+ | 'postal_code_no_match_address_match'
608
+ | 'match'
609
+ | 'no_match';
610
+ }
611
+ }
524
612
  }
525
613
 
526
614
  /**
@@ -557,6 +645,8 @@ export namespace DeclinedTransaction {
557
645
  * does not match the amount on the check.
558
646
  * - `not_our_item` - The check attempting to be deposited does not belong to
559
647
  * Increase.
648
+ * - `no_account_number_found` - The account number on the check does not exist at
649
+ * Increase.
560
650
  */
561
651
  reason:
562
652
  | 'ach_route_disabled'
@@ -569,7 +659,8 @@ export namespace DeclinedTransaction {
569
659
  | 'duplicate_presentment'
570
660
  | 'not_authorized'
571
661
  | 'amount_mismatch'
572
- | 'not_our_item';
662
+ | 'not_our_item'
663
+ | 'no_account_number_found';
573
664
  }
574
665
 
575
666
  /**
@@ -323,6 +323,9 @@ export namespace InboundACHTransfer {
323
323
  /**
324
324
  * The reason for the transfer return.
325
325
  *
326
+ * - `returned_per_odfi_request` - The originating financial institution asked for
327
+ * this transfer to be returned. The receiving bank is complying with the
328
+ * request. The Nacha return code is R06.
326
329
  * - `authorization_revoked_by_customer` - The customer no longer authorizes this
327
330
  * transaction. The Nacha return code is R07.
328
331
  * - `payment_stopped` - The customer asked for the payment to be stopped. This
@@ -342,6 +345,7 @@ export namespace InboundACHTransfer {
342
345
  * authorizes this transaction. The Nacha return code is R29.
343
346
  */
344
347
  reason:
348
+ | 'returned_per_odfi_request'
345
349
  | 'authorization_revoked_by_customer'
346
350
  | 'payment_stopped'
347
351
  | 'customer_advised_unauthorized_improper_ineligible_or_incomplete'
@@ -428,6 +432,9 @@ export interface InboundACHTransferTransferReturnParams {
428
432
  * The reason why this transfer will be returned. The most usual return codes are
429
433
  * `payment_stopped` for debits and `credit_entry_refused_by_receiver` for credits.
430
434
  *
435
+ * - `returned_per_odfi_request` - The originating financial institution asked for
436
+ * this transfer to be returned. The receiving bank is complying with the
437
+ * request. The Nacha return code is R06.
431
438
  * - `authorization_revoked_by_customer` - The customer no longer authorizes this
432
439
  * transaction. The Nacha return code is R07.
433
440
  * - `payment_stopped` - The customer asked for the payment to be stopped. This
@@ -447,6 +454,7 @@ export interface InboundACHTransferTransferReturnParams {
447
454
  * authorizes this transaction. The Nacha return code is R29.
448
455
  */
449
456
  reason:
457
+ | 'returned_per_odfi_request'
450
458
  | 'authorization_revoked_by_customer'
451
459
  | 'payment_stopped'
452
460
  | 'customer_advised_unauthorized_improper_ineligible_or_incomplete'
@@ -379,6 +379,11 @@ export namespace PendingTransaction {
379
379
  * `card_authorization`.
380
380
  */
381
381
  type: 'card_authorization';
382
+
383
+ /**
384
+ * Fields related to verification of cardholder-provided values.
385
+ */
386
+ verification: CardAuthorization.Verification;
382
387
  }
383
388
 
384
389
  export namespace CardAuthorization {
@@ -482,6 +487,89 @@ export namespace PendingTransaction {
482
487
  | null;
483
488
  }
484
489
  }
490
+
491
+ /**
492
+ * Fields related to verification of cardholder-provided values.
493
+ */
494
+ export interface Verification {
495
+ /**
496
+ * Fields related to verification of the Card Verification Code, a 3-digit code on
497
+ * the back of the card.
498
+ */
499
+ card_verification_code: Verification.CardVerificationCode;
500
+
501
+ /**
502
+ * Cardholder address provided in the authorization request and the address on file
503
+ * we verified it against.
504
+ */
505
+ cardholder_address: Verification.CardholderAddress;
506
+ }
507
+
508
+ export namespace Verification {
509
+ /**
510
+ * Fields related to verification of the Card Verification Code, a 3-digit code on
511
+ * the back of the card.
512
+ */
513
+ export interface CardVerificationCode {
514
+ /**
515
+ * The result of verifying the Card Verification Code.
516
+ *
517
+ * - `not_checked` - No card verification code was provided in the authorization
518
+ * request.
519
+ * - `match` - The card verification code matched the one on file.
520
+ * - `no_match` - The card verification code did not match the one on file.
521
+ */
522
+ result: 'not_checked' | 'match' | 'no_match';
523
+ }
524
+
525
+ /**
526
+ * Cardholder address provided in the authorization request and the address on file
527
+ * we verified it against.
528
+ */
529
+ export interface CardholderAddress {
530
+ /**
531
+ * Line 1 of the address on file for the cardholder.
532
+ */
533
+ actual_line1: string | null;
534
+
535
+ /**
536
+ * The postal code of the address on file for the cardholder.
537
+ */
538
+ actual_postal_code: string | null;
539
+
540
+ /**
541
+ * The cardholder address line 1 provided for verification in the authorization
542
+ * request.
543
+ */
544
+ provided_line1: string | null;
545
+
546
+ /**
547
+ * The postal code provided for verification in the authorization request.
548
+ */
549
+ provided_postal_code: string | null;
550
+
551
+ /**
552
+ * The address verification result returned to the card network.
553
+ *
554
+ * - `not_checked` - No adress was provided in the authorization request.
555
+ * - `postal_code_match_address_not_checked` - Postal code matches, but the street
556
+ * address was not verified.
557
+ * - `postal_code_match_address_no_match` - Postal code matches, but the street
558
+ * address does not match.
559
+ * - `postal_code_no_match_address_match` - Postal code does not match, but the
560
+ * street address matches.
561
+ * - `match` - Postal code and street address match.
562
+ * - `no_match` - Postal code and street address do not match.
563
+ */
564
+ result:
565
+ | 'not_checked'
566
+ | 'postal_code_match_address_not_checked'
567
+ | 'postal_code_match_address_no_match'
568
+ | 'postal_code_no_match_address_match'
569
+ | 'match'
570
+ | 'no_match';
571
+ }
572
+ }
485
573
  }
486
574
 
487
575
  /**
@@ -189,6 +189,11 @@ export namespace RealTimeDecision {
189
189
  * transaction will be settled in.
190
190
  */
191
191
  settlement_currency: string;
192
+
193
+ /**
194
+ * Fields related to verification of cardholder-provided values.
195
+ */
196
+ verification: CardAuthorization.Verification;
192
197
  }
193
198
 
194
199
  export namespace CardAuthorization {
@@ -335,6 +340,89 @@ export namespace RealTimeDecision {
335
340
  original_card_authorization_id: string;
336
341
  }
337
342
  }
343
+
344
+ /**
345
+ * Fields related to verification of cardholder-provided values.
346
+ */
347
+ export interface Verification {
348
+ /**
349
+ * Fields related to verification of the Card Verification Code, a 3-digit code on
350
+ * the back of the card.
351
+ */
352
+ card_verification_code: Verification.CardVerificationCode;
353
+
354
+ /**
355
+ * Cardholder address provided in the authorization request and the address on file
356
+ * we verified it against.
357
+ */
358
+ cardholder_address: Verification.CardholderAddress;
359
+ }
360
+
361
+ export namespace Verification {
362
+ /**
363
+ * Fields related to verification of the Card Verification Code, a 3-digit code on
364
+ * the back of the card.
365
+ */
366
+ export interface CardVerificationCode {
367
+ /**
368
+ * The result of verifying the Card Verification Code.
369
+ *
370
+ * - `not_checked` - No card verification code was provided in the authorization
371
+ * request.
372
+ * - `match` - The card verification code matched the one on file.
373
+ * - `no_match` - The card verification code did not match the one on file.
374
+ */
375
+ result: 'not_checked' | 'match' | 'no_match';
376
+ }
377
+
378
+ /**
379
+ * Cardholder address provided in the authorization request and the address on file
380
+ * we verified it against.
381
+ */
382
+ export interface CardholderAddress {
383
+ /**
384
+ * Line 1 of the address on file for the cardholder.
385
+ */
386
+ actual_line1: string | null;
387
+
388
+ /**
389
+ * The postal code of the address on file for the cardholder.
390
+ */
391
+ actual_postal_code: string | null;
392
+
393
+ /**
394
+ * The cardholder address line 1 provided for verification in the authorization
395
+ * request.
396
+ */
397
+ provided_line1: string | null;
398
+
399
+ /**
400
+ * The postal code provided for verification in the authorization request.
401
+ */
402
+ provided_postal_code: string | null;
403
+
404
+ /**
405
+ * The address verification result returned to the card network.
406
+ *
407
+ * - `not_checked` - No adress was provided in the authorization request.
408
+ * - `postal_code_match_address_not_checked` - Postal code matches, but the street
409
+ * address was not verified.
410
+ * - `postal_code_match_address_no_match` - Postal code matches, but the street
411
+ * address does not match.
412
+ * - `postal_code_no_match_address_match` - Postal code does not match, but the
413
+ * street address matches.
414
+ * - `match` - Postal code and street address match.
415
+ * - `no_match` - Postal code and street address do not match.
416
+ */
417
+ result:
418
+ | 'not_checked'
419
+ | 'postal_code_match_address_not_checked'
420
+ | 'postal_code_match_address_no_match'
421
+ | 'postal_code_no_match_address_match'
422
+ | 'match'
423
+ | 'no_match';
424
+ }
425
+ }
338
426
  }
339
427
 
340
428
  /**
@@ -462,6 +462,11 @@ export namespace ACHTransferSimulation {
462
462
  | 'invalid_physical_card'
463
463
  | 'missing_original_authorization'
464
464
  | 'suspected_fraud';
465
+
466
+ /**
467
+ * Fields related to verification of cardholder-provided values.
468
+ */
469
+ verification: CardDecline.Verification;
465
470
  }
466
471
 
467
472
  export namespace CardDecline {
@@ -565,6 +570,89 @@ export namespace ACHTransferSimulation {
565
570
  | null;
566
571
  }
567
572
  }
573
+
574
+ /**
575
+ * Fields related to verification of cardholder-provided values.
576
+ */
577
+ export interface Verification {
578
+ /**
579
+ * Fields related to verification of the Card Verification Code, a 3-digit code on
580
+ * the back of the card.
581
+ */
582
+ card_verification_code: Verification.CardVerificationCode;
583
+
584
+ /**
585
+ * Cardholder address provided in the authorization request and the address on file
586
+ * we verified it against.
587
+ */
588
+ cardholder_address: Verification.CardholderAddress;
589
+ }
590
+
591
+ export namespace Verification {
592
+ /**
593
+ * Fields related to verification of the Card Verification Code, a 3-digit code on
594
+ * the back of the card.
595
+ */
596
+ export interface CardVerificationCode {
597
+ /**
598
+ * The result of verifying the Card Verification Code.
599
+ *
600
+ * - `not_checked` - No card verification code was provided in the authorization
601
+ * request.
602
+ * - `match` - The card verification code matched the one on file.
603
+ * - `no_match` - The card verification code did not match the one on file.
604
+ */
605
+ result: 'not_checked' | 'match' | 'no_match';
606
+ }
607
+
608
+ /**
609
+ * Cardholder address provided in the authorization request and the address on file
610
+ * we verified it against.
611
+ */
612
+ export interface CardholderAddress {
613
+ /**
614
+ * Line 1 of the address on file for the cardholder.
615
+ */
616
+ actual_line1: string | null;
617
+
618
+ /**
619
+ * The postal code of the address on file for the cardholder.
620
+ */
621
+ actual_postal_code: string | null;
622
+
623
+ /**
624
+ * The cardholder address line 1 provided for verification in the authorization
625
+ * request.
626
+ */
627
+ provided_line1: string | null;
628
+
629
+ /**
630
+ * The postal code provided for verification in the authorization request.
631
+ */
632
+ provided_postal_code: string | null;
633
+
634
+ /**
635
+ * The address verification result returned to the card network.
636
+ *
637
+ * - `not_checked` - No adress was provided in the authorization request.
638
+ * - `postal_code_match_address_not_checked` - Postal code matches, but the street
639
+ * address was not verified.
640
+ * - `postal_code_match_address_no_match` - Postal code matches, but the street
641
+ * address does not match.
642
+ * - `postal_code_no_match_address_match` - Postal code does not match, but the
643
+ * street address matches.
644
+ * - `match` - Postal code and street address match.
645
+ * - `no_match` - Postal code and street address do not match.
646
+ */
647
+ result:
648
+ | 'not_checked'
649
+ | 'postal_code_match_address_not_checked'
650
+ | 'postal_code_match_address_no_match'
651
+ | 'postal_code_no_match_address_match'
652
+ | 'match'
653
+ | 'no_match';
654
+ }
655
+ }
568
656
  }
569
657
 
570
658
  /**
@@ -601,6 +689,8 @@ export namespace ACHTransferSimulation {
601
689
  * does not match the amount on the check.
602
690
  * - `not_our_item` - The check attempting to be deposited does not belong to
603
691
  * Increase.
692
+ * - `no_account_number_found` - The account number on the check does not exist at
693
+ * Increase.
604
694
  */
605
695
  reason:
606
696
  | 'ach_route_disabled'
@@ -613,7 +703,8 @@ export namespace ACHTransferSimulation {
613
703
  | 'duplicate_presentment'
614
704
  | 'not_authorized'
615
705
  | 'amount_mismatch'
616
- | 'not_our_item';
706
+ | 'not_our_item'
707
+ | 'no_account_number_found';
617
708
  }
618
709
 
619
710
  /**
@@ -4644,6 +4735,9 @@ export namespace ACHTransferSimulation {
4644
4735
  /**
4645
4736
  * The reason for the transfer return.
4646
4737
  *
4738
+ * - `returned_per_odfi_request` - The originating financial institution asked for
4739
+ * this transfer to be returned. The receiving bank is complying with the
4740
+ * request. The Nacha return code is R06.
4647
4741
  * - `authorization_revoked_by_customer` - The customer no longer authorizes this
4648
4742
  * transaction. The Nacha return code is R07.
4649
4743
  * - `payment_stopped` - The customer asked for the payment to be stopped. This
@@ -4663,6 +4757,7 @@ export namespace ACHTransferSimulation {
4663
4757
  * authorizes this transaction. The Nacha return code is R29.
4664
4758
  */
4665
4759
  reason:
4760
+ | 'returned_per_odfi_request'
4666
4761
  | 'authorization_revoked_by_customer'
4667
4762
  | 'payment_stopped'
4668
4763
  | 'customer_advised_unauthorized_improper_ineligible_or_incomplete'