increase 0.11.8 → 0.13.0

package/src/resources/real-time-decisions.ts

@@ -189,6 +189,11 @@ export namespace RealTimeDecision {
      * transaction will be settled in.
      */
     settlement_currency: string;
+
+    /**
+     * Fields related to verification of cardholder-provided values.
+     */
+    verification: CardAuthorization.Verification;
   }
 
   export namespace CardAuthorization {
@@ -335,6 +340,89 @@ export namespace RealTimeDecision {
         original_card_authorization_id: string;
       }
     }
+
+    /**
+     * Fields related to verification of cardholder-provided values.
+     */
+    export interface Verification {
+      /**
+       * Fields related to verification of the Card Verification Code, a 3-digit code on
+       * the back of the card.
+       */
+      card_verification_code: Verification.CardVerificationCode;
+
+      /**
+       * Cardholder address provided in the authorization request and the address on file
+       * we verified it against.
+       */
+      cardholder_address: Verification.CardholderAddress;
+    }
+
+    export namespace Verification {
+      /**
+       * Fields related to verification of the Card Verification Code, a 3-digit code on
+       * the back of the card.
+       */
+      export interface CardVerificationCode {
+        /**
+         * The result of verifying the Card Verification Code.
+         *
+         * - `not_checked` - No card verification code was provided in the authorization
+         *   request.
+         * - `match` - The card verification code matched the one on file.
+         * - `no_match` - The card verification code did not match the one on file.
+         */
+        result: 'not_checked' | 'match' | 'no_match';
+      }
+
+      /**
+       * Cardholder address provided in the authorization request and the address on file
+       * we verified it against.
+       */
+      export interface CardholderAddress {
+        /**
+         * Line 1 of the address on file for the cardholder.
+         */
+        actual_line1: string | null;
+
+        /**
+         * The postal code of the address on file for the cardholder.
+         */
+        actual_postal_code: string | null;
+
+        /**
+         * The cardholder address line 1 provided for verification in the authorization
+         * request.
+         */
+        provided_line1: string | null;
+
+        /**
+         * The postal code provided for verification in the authorization request.
+         */
+        provided_postal_code: string | null;
+
+        /**
+         * The address verification result returned to the card network.
+         *
+         * - `not_checked` - No adress was provided in the authorization request.
+         * - `postal_code_match_address_not_checked` - Postal code matches, but the street
+         *   address was not verified.
+         * - `postal_code_match_address_no_match` - Postal code matches, but the street
+         *   address does not match.
+         * - `postal_code_no_match_address_match` - Postal code does not match, but the
+         *   street address matches.
+         * - `match` - Postal code and street address match.
+         * - `no_match` - Postal code and street address do not match.
+         */
+        result:
+          | 'not_checked'
+          | 'postal_code_match_address_not_checked'
+          | 'postal_code_match_address_no_match'
+          | 'postal_code_no_match_address_match'
+          | 'match'
+          | 'no_match';
+      }
+    }
   }
 
   /**
@@ -534,6 +622,6 @@ export namespace RealTimeDecisionActionParams {
 }
 
 export namespace RealTimeDecisions {
-  export type RealTimeDecision = RealTimeDecisionsAPI.RealTimeDecision;
-  export type RealTimeDecisionActionParams = RealTimeDecisionsAPI.RealTimeDecisionActionParams;
+  export import RealTimeDecision = RealTimeDecisionsAPI.RealTimeDecision;
+  export import RealTimeDecisionActionParams = RealTimeDecisionsAPI.RealTimeDecisionActionParams;
 }

package/src/resources/real-time-payments-transfers.ts

@@ -446,10 +446,8 @@ export namespace RealTimePaymentsTransferListParams {
 }
 
 export namespace RealTimePaymentsTransfers {
-  export type RealTimePaymentsTransfer = RealTimePaymentsTransfersAPI.RealTimePaymentsTransfer;
+  export import RealTimePaymentsTransfer = RealTimePaymentsTransfersAPI.RealTimePaymentsTransfer;
   export import RealTimePaymentsTransfersPage = RealTimePaymentsTransfersAPI.RealTimePaymentsTransfersPage;
-  export type RealTimePaymentsTransferCreateParams =
-    RealTimePaymentsTransfersAPI.RealTimePaymentsTransferCreateParams;
-  export type RealTimePaymentsTransferListParams =
-    RealTimePaymentsTransfersAPI.RealTimePaymentsTransferListParams;
+  export import RealTimePaymentsTransferCreateParams = RealTimePaymentsTransfersAPI.RealTimePaymentsTransferCreateParams;
+  export import RealTimePaymentsTransferListParams = RealTimePaymentsTransfersAPI.RealTimePaymentsTransferListParams;
 }

package/src/resources/routing-numbers.ts

@@ -75,7 +75,7 @@ export interface RoutingNumberListParams extends PageParams {
 }
 
 export namespace RoutingNumbers {
-  export type RoutingNumber = RoutingNumbersAPI.RoutingNumber;
+  export import RoutingNumber = RoutingNumbersAPI.RoutingNumber;
   export import RoutingNumbersPage = RoutingNumbersAPI.RoutingNumbersPage;
-  export type RoutingNumberListParams = RoutingNumbersAPI.RoutingNumberListParams;
+  export import RoutingNumberListParams = RoutingNumbersAPI.RoutingNumberListParams;
 }

package/src/resources/simulations/account-statements.ts

@@ -26,5 +26,5 @@ export interface AccountStatementCreateParams {
 }
 
 export namespace AccountStatements {
-  export type AccountStatementCreateParams = SimulationsAccountStatementsAPI.AccountStatementCreateParams;
+  export import AccountStatementCreateParams = SimulationsAccountStatementsAPI.AccountStatementCreateParams;
 }

package/src/resources/simulations/ach-transfers.ts

@@ -462,6 +462,11 @@ export namespace ACHTransferSimulation {
           | 'invalid_physical_card'
           | 'missing_original_authorization'
           | 'suspected_fraud';
+
+        /**
+         * Fields related to verification of cardholder-provided values.
+         */
+        verification: CardDecline.Verification;
       }
 
       export namespace CardDecline {
@@ -565,6 +570,89 @@ export namespace ACHTransferSimulation {
               | null;
           }
         }
+
+        /**
+         * Fields related to verification of cardholder-provided values.
+         */
+        export interface Verification {
+          /**
+           * Fields related to verification of the Card Verification Code, a 3-digit code on
+           * the back of the card.
+           */
+          card_verification_code: Verification.CardVerificationCode;
+
+          /**
+           * Cardholder address provided in the authorization request and the address on file
+           * we verified it against.
+           */
+          cardholder_address: Verification.CardholderAddress;
+        }
+
+        export namespace Verification {
+          /**
+           * Fields related to verification of the Card Verification Code, a 3-digit code on
+           * the back of the card.
+           */
+          export interface CardVerificationCode {
+            /**
+             * The result of verifying the Card Verification Code.
+             *
+             * - `not_checked` - No card verification code was provided in the authorization
+             *   request.
+             * - `match` - The card verification code matched the one on file.
+             * - `no_match` - The card verification code did not match the one on file.
+             */
+            result: 'not_checked' | 'match' | 'no_match';
+          }
+
+          /**
+           * Cardholder address provided in the authorization request and the address on file
+           * we verified it against.
+           */
+          export interface CardholderAddress {
+            /**
+             * Line 1 of the address on file for the cardholder.
+             */
+            actual_line1: string | null;
+
+            /**
+             * The postal code of the address on file for the cardholder.
+             */
+            actual_postal_code: string | null;
+
+            /**
+             * The cardholder address line 1 provided for verification in the authorization
+             * request.
+             */
+            provided_line1: string | null;
+
+            /**
+             * The postal code provided for verification in the authorization request.
+             */
+            provided_postal_code: string | null;
+
+            /**
+             * The address verification result returned to the card network.
+             *
+             * - `not_checked` - No adress was provided in the authorization request.
+             * - `postal_code_match_address_not_checked` - Postal code matches, but the street
+             *   address was not verified.
+             * - `postal_code_match_address_no_match` - Postal code matches, but the street
+             *   address does not match.
+             * - `postal_code_no_match_address_match` - Postal code does not match, but the
+             *   street address matches.
+             * - `match` - Postal code and street address match.
+             * - `no_match` - Postal code and street address do not match.
+             */
+            result:
+              | 'not_checked'
+              | 'postal_code_match_address_not_checked'
+              | 'postal_code_match_address_no_match'
+              | 'postal_code_no_match_address_match'
+              | 'match'
+              | 'no_match';
+          }
+        }
       }
 
       /**
@@ -601,6 +689,8 @@ export namespace ACHTransferSimulation {
          *   does not match the amount on the check.
          * - `not_our_item` - The check attempting to be deposited does not belong to
          *   Increase.
+         * - `no_account_number_found` - The account number on the check does not exist at
+         *   Increase.
          */
         reason:
           | 'ach_route_disabled'
@@ -613,7 +703,8 @@ export namespace ACHTransferSimulation {
           | 'duplicate_presentment'
           | 'not_authorized'
           | 'amount_mismatch'
-          | 'not_our_item';
+          | 'not_our_item'
+          | 'no_account_number_found';
       }
 
       /**
@@ -3262,6 +3353,11 @@ export namespace ACHTransferSimulation {
          */
         transaction_id: string | null;
 
+        /**
+         * The identifier of the Check Transfer object that was deposited.
+         */
+        transfer_id: string;
+
         /**
          * A constant representing the object's type. For this resource it will always be
          * `check_transfer_deposit`.
@@ -4403,6 +4499,11 @@ export namespace ACHTransferSimulation {
      */
     account_number_id: string;
 
+    /**
+     * Additional information sent from the originator.
+     */
+    addenda: Transfer.Addenda | null;
+
     /**
      * The transfer amount in USD cents.
      */
@@ -4517,6 +4618,44 @@ export namespace ACHTransferSimulation {
       transaction_id: string;
     }
 
+    /**
+     * Additional information sent from the originator.
+     */
+    export interface Addenda {
+      /**
+       * The type of addendum.
+       *
+       * - `freeform` - Unstructured addendum.
+       */
+      category: 'freeform';
+
+      /**
+       * Unstructured `payment_related_information` passed through by the originator.
+       */
+      freeform: Addenda.Freeform | null;
+    }
+
+    export namespace Addenda {
+      /**
+       * Unstructured `payment_related_information` passed through by the originator.
+       */
+      export interface Freeform {
+        /**
+         * Each entry represents an addendum received from the originator.
+         */
+        entries: Array<Freeform.Entry>;
+      }
+
+      export namespace Freeform {
+        export interface Entry {
+          /**
+           * The payment related information passed in the addendum.
+           */
+          payment_related_information: string;
+        }
+      }
+    }
+
     /**
      * If your transfer is declined, this will contain details of the decline.
      */
@@ -4596,6 +4735,9 @@ export namespace ACHTransferSimulation {
       /**
        * The reason for the transfer return.
        *
+       * - `returned_per_odfi_request` - The originating financial institution asked for
+       *   this transfer to be returned. The receiving bank is complying with the
+       *   request. The Nacha return code is R06.
        * - `authorization_revoked_by_customer` - The customer no longer authorizes this
        *   transaction. The Nacha return code is R07.
        * - `payment_stopped` - The customer asked for the payment to be stopped. This
@@ -4615,6 +4757,7 @@ export namespace ACHTransferSimulation {
        *   authorizes this transaction. The Nacha return code is R29.
        */
       reason:
+        | 'returned_per_odfi_request'
         | 'authorization_revoked_by_customer'
         | 'payment_stopped'
         | 'customer_advised_unauthorized_improper_ineligible_or_incomplete'
@@ -4909,7 +5052,7 @@ export interface ACHTransferReturnParams {
 }
 
 export namespace ACHTransfers {
-  export type ACHTransferSimulation = SimulationsACHTransfersAPI.ACHTransferSimulation;
-  export type ACHTransferCreateInboundParams = SimulationsACHTransfersAPI.ACHTransferCreateInboundParams;
-  export type ACHTransferReturnParams = SimulationsACHTransfersAPI.ACHTransferReturnParams;
+  export import ACHTransferSimulation = SimulationsACHTransfersAPI.ACHTransferSimulation;
+  export import ACHTransferCreateInboundParams = SimulationsACHTransfersAPI.ACHTransferCreateInboundParams;
+  export import ACHTransferReturnParams = SimulationsACHTransfersAPI.ACHTransferReturnParams;
 }

package/src/resources/simulations/card-disputes.ts

@@ -38,5 +38,5 @@ export interface CardDisputeActionParams {
 }
 
 export namespace CardDisputes {
-  export type CardDisputeActionParams = SimulationsCardDisputesAPI.CardDisputeActionParams;
+  export import CardDisputeActionParams = SimulationsCardDisputesAPI.CardDisputeActionParams;
 }

package/src/resources/simulations/card-refunds.ts

@@ -27,5 +27,5 @@ export interface CardRefundCreateParams {
 }
 
 export namespace CardRefunds {
-  export type CardRefundCreateParams = CardRefundsAPI.CardRefundCreateParams;
+  export import CardRefundCreateParams = CardRefundsAPI.CardRefundCreateParams;
 }

package/src/resources/simulations/cards.ts

@@ -443,6 +443,11 @@ export namespace CardAuthorizationSimulation {
           | 'invalid_physical_card'
           | 'missing_original_authorization'
           | 'suspected_fraud';
+
+        /**
+         * Fields related to verification of cardholder-provided values.
+         */
+        verification: CardDecline.Verification;
       }
 
       export namespace CardDecline {
@@ -546,6 +551,89 @@ export namespace CardAuthorizationSimulation {
               | null;
           }
         }
+
+        /**
+         * Fields related to verification of cardholder-provided values.
+         */
+        export interface Verification {
+          /**
+           * Fields related to verification of the Card Verification Code, a 3-digit code on
+           * the back of the card.
+           */
+          card_verification_code: Verification.CardVerificationCode;
+
+          /**
+           * Cardholder address provided in the authorization request and the address on file
+           * we verified it against.
+           */
+          cardholder_address: Verification.CardholderAddress;
+        }
+
+        export namespace Verification {
+          /**
+           * Fields related to verification of the Card Verification Code, a 3-digit code on
+           * the back of the card.
+           */
+          export interface CardVerificationCode {
+            /**
+             * The result of verifying the Card Verification Code.
+             *
+             * - `not_checked` - No card verification code was provided in the authorization
+             *   request.
+             * - `match` - The card verification code matched the one on file.
+             * - `no_match` - The card verification code did not match the one on file.
+             */
+            result: 'not_checked' | 'match' | 'no_match';
+          }
+
+          /**
+           * Cardholder address provided in the authorization request and the address on file
+           * we verified it against.
+           */
+          export interface CardholderAddress {
+            /**
+             * Line 1 of the address on file for the cardholder.
+             */
+            actual_line1: string | null;
+
+            /**
+             * The postal code of the address on file for the cardholder.
+             */
+            actual_postal_code: string | null;
+
+            /**
+             * The cardholder address line 1 provided for verification in the authorization
+             * request.
+             */
+            provided_line1: string | null;
+
+            /**
+             * The postal code provided for verification in the authorization request.
+             */
+            provided_postal_code: string | null;
+
+            /**
+             * The address verification result returned to the card network.
+             *
+             * - `not_checked` - No adress was provided in the authorization request.
+             * - `postal_code_match_address_not_checked` - Postal code matches, but the street
+             *   address was not verified.
+             * - `postal_code_match_address_no_match` - Postal code matches, but the street
+             *   address does not match.
+             * - `postal_code_no_match_address_match` - Postal code does not match, but the
+             *   street address matches.
+             * - `match` - Postal code and street address match.
+             * - `no_match` - Postal code and street address do not match.
+             */
+            result:
+              | 'not_checked'
+              | 'postal_code_match_address_not_checked'
+              | 'postal_code_match_address_no_match'
+              | 'postal_code_no_match_address_match'
+              | 'match'
+              | 'no_match';
+          }
+        }
       }
 
       /**
@@ -582,6 +670,8 @@ export namespace CardAuthorizationSimulation {
          *   does not match the amount on the check.
          * - `not_our_item` - The check attempting to be deposited does not belong to
          *   Increase.
+         * - `no_account_number_found` - The account number on the check does not exist at
+         *   Increase.
          */
         reason:
           | 'ach_route_disabled'
@@ -594,7 +684,8 @@ export namespace CardAuthorizationSimulation {
           | 'duplicate_presentment'
           | 'not_authorized'
           | 'amount_mismatch'
-          | 'not_our_item';
+          | 'not_our_item'
+          | 'no_account_number_found';
       }
 
       /**
@@ -1421,6 +1512,11 @@ export namespace CardAuthorizationSimulation {
          * `card_authorization`.
          */
         type: 'card_authorization';
+
+        /**
+         * Fields related to verification of cardholder-provided values.
+         */
+        verification: CardAuthorization.Verification;
       }
 
       export namespace CardAuthorization {
@@ -1524,6 +1620,89 @@ export namespace CardAuthorizationSimulation {
               | null;
           }
         }
+
+        /**
+         * Fields related to verification of cardholder-provided values.
+         */
+        export interface Verification {
+          /**
+           * Fields related to verification of the Card Verification Code, a 3-digit code on
+           * the back of the card.
+           */
+          card_verification_code: Verification.CardVerificationCode;
+
+          /**
+           * Cardholder address provided in the authorization request and the address on file
+           * we verified it against.
+           */
+          cardholder_address: Verification.CardholderAddress;
+        }
+
+        export namespace Verification {
+          /**
+           * Fields related to verification of the Card Verification Code, a 3-digit code on
+           * the back of the card.
+           */
+          export interface CardVerificationCode {
+            /**
+             * The result of verifying the Card Verification Code.
+             *
+             * - `not_checked` - No card verification code was provided in the authorization
+             *   request.
+             * - `match` - The card verification code matched the one on file.
+             * - `no_match` - The card verification code did not match the one on file.
+             */
+            result: 'not_checked' | 'match' | 'no_match';
+          }
+
+          /**
+           * Cardholder address provided in the authorization request and the address on file
+           * we verified it against.
+           */
+          export interface CardholderAddress {
+            /**
+             * Line 1 of the address on file for the cardholder.
+             */
+            actual_line1: string | null;
+
+            /**
+             * The postal code of the address on file for the cardholder.
+             */
+            actual_postal_code: string | null;
+
+            /**
+             * The cardholder address line 1 provided for verification in the authorization
+             * request.
+             */
+            provided_line1: string | null;
+
+            /**
+             * The postal code provided for verification in the authorization request.
+             */
+            provided_postal_code: string | null;
+
+            /**
+             * The address verification result returned to the card network.
+             *
+             * - `not_checked` - No adress was provided in the authorization request.
+             * - `postal_code_match_address_not_checked` - Postal code matches, but the street
+             *   address was not verified.
+             * - `postal_code_match_address_no_match` - Postal code matches, but the street
+             *   address does not match.
+             * - `postal_code_no_match_address_match` - Postal code does not match, but the
+             *   street address matches.
+             * - `match` - Postal code and street address match.
+             * - `no_match` - Postal code and street address do not match.
+             */
+            result:
+              | 'not_checked'
+              | 'postal_code_match_address_not_checked'
+              | 'postal_code_match_address_no_match'
+              | 'postal_code_no_match_address_match'
+              | 'match'
+              | 'no_match';
+          }
+        }
       }
 
       /**
@@ -1774,7 +1953,7 @@ export interface CardSettlementParams {
 }
 
 export namespace Cards {
-  export type CardAuthorizationSimulation = CardsAPI.CardAuthorizationSimulation;
-  export type CardAuthorizeParams = CardsAPI.CardAuthorizeParams;
-  export type CardSettlementParams = CardsAPI.CardSettlementParams;
+  export import CardAuthorizationSimulation = CardsAPI.CardAuthorizationSimulation;
+  export import CardAuthorizeParams = CardsAPI.CardAuthorizeParams;
+  export import CardSettlementParams = CardsAPI.CardSettlementParams;
 }

package/src/resources/simulations/digital-wallet-token-requests.ts

@@ -60,8 +60,6 @@ export interface DigitalWalletTokenRequestCreateParams {
 }
 
 export namespace DigitalWalletTokenRequests {
-  export type DigitalWalletTokenRequestCreateResponse =
-    DigitalWalletTokenRequestsAPI.DigitalWalletTokenRequestCreateResponse;
-  export type DigitalWalletTokenRequestCreateParams =
-    DigitalWalletTokenRequestsAPI.DigitalWalletTokenRequestCreateParams;
+  export import DigitalWalletTokenRequestCreateResponse = DigitalWalletTokenRequestsAPI.DigitalWalletTokenRequestCreateResponse;
+  export import DigitalWalletTokenRequestCreateParams = DigitalWalletTokenRequestsAPI.DigitalWalletTokenRequestCreateParams;
 }

package/src/resources/simulations/documents.ts

@@ -22,5 +22,5 @@ export interface DocumentCreateParams {
 }
 
 export namespace Documents {
-  export type DocumentCreateParams = SimulationsDocumentsAPI.DocumentCreateParams;
+  export import DocumentCreateParams = SimulationsDocumentsAPI.DocumentCreateParams;
 }

package/src/resources/simulations/inbound-funds-holds.ts

@@ -89,5 +89,5 @@ export interface InboundFundsHoldReleaseResponse {
 }
 
 export namespace InboundFundsHolds {
-  export type InboundFundsHoldReleaseResponse = InboundFundsHoldsAPI.InboundFundsHoldReleaseResponse;
+  export import InboundFundsHoldReleaseResponse = InboundFundsHoldsAPI.InboundFundsHoldReleaseResponse;
 }

package/src/resources/simulations/inbound-wire-drawdown-requests.ts

@@ -127,6 +127,5 @@ export interface InboundWireDrawdownRequestCreateParams {
 }
 
 export namespace InboundWireDrawdownRequests {
-  export type InboundWireDrawdownRequestCreateParams =
-    SimulationsInboundWireDrawdownRequestsAPI.InboundWireDrawdownRequestCreateParams;
+  export import InboundWireDrawdownRequestCreateParams = SimulationsInboundWireDrawdownRequestsAPI.InboundWireDrawdownRequestCreateParams;
 }

package/src/resources/simulations/interest-payments.ts

@@ -2201,6 +2201,11 @@ export namespace InterestPaymentSimulationResult {
          */
         transaction_id: string | null;
 
+        /**
+         * The identifier of the Check Transfer object that was deposited.
+         */
+        transfer_id: string;
+
         /**
          * A constant representing the object's type. For this resource it will always be
          * `check_transfer_deposit`.
@@ -3347,6 +3352,6 @@ export interface InterestPaymentCreateParams {
 }
 
 export namespace InterestPayments {
-  export type InterestPaymentSimulationResult = InterestPaymentsAPI.InterestPaymentSimulationResult;
-  export type InterestPaymentCreateParams = InterestPaymentsAPI.InterestPaymentCreateParams;
+  export import InterestPaymentSimulationResult = InterestPaymentsAPI.InterestPaymentSimulationResult;
+  export import InterestPaymentCreateParams = InterestPaymentsAPI.InterestPaymentCreateParams;
 }

package/src/resources/simulations/physical-cards.ts

@@ -47,6 +47,5 @@ export interface PhysicalCardShipmentAdvanceParams {
 }
 
 export namespace PhysicalCards {
-  export type PhysicalCardShipmentAdvanceParams =
-    SimulationsPhysicalCardsAPI.PhysicalCardShipmentAdvanceParams;
+  export import PhysicalCardShipmentAdvanceParams = SimulationsPhysicalCardsAPI.PhysicalCardShipmentAdvanceParams;
 }

package/src/resources/simulations/programs.ts

@@ -24,5 +24,5 @@ export interface ProgramCreateParams {
 }
 
 export namespace Programs {
-  export type ProgramCreateParams = SimulationsProgramsAPI.ProgramCreateParams;
+  export import ProgramCreateParams = SimulationsProgramsAPI.ProgramCreateParams;
 }