increase 0.568.1 → 0.569.0

package/src/resources/digital-wallet-tokens.ts

@@ -70,6 +70,12 @@ export interface DigitalWalletToken {
    */
   created_at: string;
 
+  /**
+   * If the Digital Wallet Token was declined during provisioning, details about the
+   * decline.
+   */
+  decline: DigitalWalletToken.Decline | null;
+
   /**
    * The device that was used to create the Digital Wallet Token.
    */
@@ -88,8 +94,9 @@ export interface DigitalWalletToken {
    *   activated via two-factor authentication yet.
    * - `suspended` - The digital wallet token has been temporarily paused.
    * - `deactivated` - The digital wallet token has been permanently canceled.
+   * - `declined` - The digital wallet token was declined during provisioning.
    */
-  status: 'active' | 'inactive' | 'suspended' | 'deactivated';
+  status: 'active' | 'inactive' | 'suspended' | 'deactivated' | 'declined';
 
   /**
    * The digital wallet app being used.
@@ -124,6 +131,34 @@ export namespace DigitalWalletToken {
     name: string | null;
   }
 
+  /**
+   * If the Digital Wallet Token was declined during provisioning, details about the
+   * decline.
+   */
+  export interface Decline {
+    /**
+     * The reason the token provisioning was declined.
+     *
+     * - `card_not_active` - The card is not active.
+     * - `no_verification_method` - The card does not have a two-factor authentication
+     *   method.
+     * - `webhook_timed_out` - Your webhook timed out when evaluating the token
+     *   provisioning attempt.
+     * - `webhook_declined` - Your webhook declined the token provisioning attempt.
+     * - `incorrect_card_verification_code` - The tokenization attempt failed because
+     *   the Card Verification Code (CVC) was incorrect.
+     * - `declined_by_token_requestor` - The tokenization attempt was declined by the
+     *   token requestor.
+     */
+    reason:
+      | 'card_not_active'
+      | 'no_verification_method'
+      | 'webhook_timed_out'
+      | 'webhook_declined'
+      | 'incorrect_card_verification_code'
+      | 'declined_by_token_requestor';
+  }
+
   /**
    * The device that was used to create the Digital Wallet Token.
    */
@@ -193,8 +228,9 @@ export namespace DigitalWalletToken {
      *   activated via two-factor authentication yet.
      * - `suspended` - The digital wallet token has been temporarily paused.
      * - `deactivated` - The digital wallet token has been permanently canceled.
+     * - `declined` - The digital wallet token was declined during provisioning.
      */
-    status: 'active' | 'inactive' | 'suspended' | 'deactivated';
+    status: 'active' | 'inactive' | 'suspended' | 'deactivated' | 'declined';
 
     /**
      * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which

package/src/resources/entities.ts

@@ -1147,7 +1147,7 @@ export namespace Entity {
        * The type of issue. We may add additional possible values for this enum over
        * time; your application should be able to handle such additions gracefully.
        *
-       * - `entity_tax_identifier` - The entity's tax identifier could not be validated.
+       * - `entity_tax_identifier` - The entity's tax identifier could not be verified.
        *   Update the tax ID with the
        *   [update an entity API](/documentation/api/entities#update-an-entity.corporation.legal_identifier).
        * - `entity_address` - The entity's address could not be validated. Update the

package/src/resources/event-subscriptions.ts

@@ -252,6 +252,10 @@ export namespace EventSubscription {
      *   Enrollment is updated.
      * - `intrafi_exclusion.created` - Occurs whenever an IntraFi Exclusion is created.
      * - `intrafi_exclusion.updated` - Occurs whenever an IntraFi Exclusion is updated.
+     * - `loan_application.created` - Occurs whenever a Loan Application is created.
+     * - `loan_application.updated` - Occurs whenever a Loan Application is updated.
+     * - `loan_offer.created` - Occurs whenever a Loan Offer is created.
+     * - `loan_offer.updated` - Occurs whenever a Loan Offer is updated.
      * - `lockbox.created` - Occurs whenever a Lockbox is created.
      * - `lockbox.updated` - Occurs whenever a Lockbox is updated.
      * - `oauth_connection.created` - Occurs whenever an OAuth Connection is created.
@@ -384,6 +388,10 @@ export namespace EventSubscription {
       | 'intrafi_account_enrollment.updated'
       | 'intrafi_exclusion.created'
       | 'intrafi_exclusion.updated'
+      | 'loan_application.created'
+      | 'loan_application.updated'
+      | 'loan_offer.created'
+      | 'loan_offer.updated'
       | 'lockbox.created'
       | 'lockbox.updated'
       | 'oauth_connection.created'
@@ -572,6 +580,10 @@ export namespace EventSubscriptionCreateParams {
      *   Enrollment is updated.
      * - `intrafi_exclusion.created` - Occurs whenever an IntraFi Exclusion is created.
      * - `intrafi_exclusion.updated` - Occurs whenever an IntraFi Exclusion is updated.
+     * - `loan_application.created` - Occurs whenever a Loan Application is created.
+     * - `loan_application.updated` - Occurs whenever a Loan Application is updated.
+     * - `loan_offer.created` - Occurs whenever a Loan Offer is created.
+     * - `loan_offer.updated` - Occurs whenever a Loan Offer is updated.
      * - `lockbox.created` - Occurs whenever a Lockbox is created.
      * - `lockbox.updated` - Occurs whenever a Lockbox is updated.
      * - `oauth_connection.created` - Occurs whenever an OAuth Connection is created.
@@ -704,6 +716,10 @@ export namespace EventSubscriptionCreateParams {
       | 'intrafi_account_enrollment.updated'
       | 'intrafi_exclusion.created'
       | 'intrafi_exclusion.updated'
+      | 'loan_application.created'
+      | 'loan_application.updated'
+      | 'loan_offer.created'
+      | 'loan_offer.updated'
       | 'lockbox.created'
       | 'lockbox.updated'
       | 'oauth_connection.created'

package/src/resources/events.ts

@@ -188,6 +188,10 @@ export interface Event {
    *   Enrollment is updated.
    * - `intrafi_exclusion.created` - Occurs whenever an IntraFi Exclusion is created.
    * - `intrafi_exclusion.updated` - Occurs whenever an IntraFi Exclusion is updated.
+   * - `loan_application.created` - Occurs whenever a Loan Application is created.
+   * - `loan_application.updated` - Occurs whenever a Loan Application is updated.
+   * - `loan_offer.created` - Occurs whenever a Loan Offer is created.
+   * - `loan_offer.updated` - Occurs whenever a Loan Offer is updated.
    * - `lockbox.created` - Occurs whenever a Lockbox is created.
    * - `lockbox.updated` - Occurs whenever a Lockbox is updated.
    * - `oauth_connection.created` - Occurs whenever an OAuth Connection is created.
@@ -320,6 +324,10 @@ export interface Event {
     | 'intrafi_account_enrollment.updated'
     | 'intrafi_exclusion.created'
     | 'intrafi_exclusion.updated'
+    | 'loan_application.created'
+    | 'loan_application.updated'
+    | 'loan_offer.created'
+    | 'loan_offer.updated'
     | 'lockbox.created'
     | 'lockbox.updated'
     | 'oauth_connection.created'
@@ -501,6 +509,10 @@ export interface UnwrapWebhookEvent {
    *   Enrollment is updated.
    * - `intrafi_exclusion.created` - Occurs whenever an IntraFi Exclusion is created.
    * - `intrafi_exclusion.updated` - Occurs whenever an IntraFi Exclusion is updated.
+   * - `loan_application.created` - Occurs whenever a Loan Application is created.
+   * - `loan_application.updated` - Occurs whenever a Loan Application is updated.
+   * - `loan_offer.created` - Occurs whenever a Loan Offer is created.
+   * - `loan_offer.updated` - Occurs whenever a Loan Offer is updated.
    * - `lockbox.created` - Occurs whenever a Lockbox is created.
    * - `lockbox.updated` - Occurs whenever a Lockbox is updated.
    * - `oauth_connection.created` - Occurs whenever an OAuth Connection is created.
@@ -633,6 +645,10 @@ export interface UnwrapWebhookEvent {
     | 'intrafi_account_enrollment.updated'
     | 'intrafi_exclusion.created'
     | 'intrafi_exclusion.updated'
+    | 'loan_application.created'
+    | 'loan_application.updated'
+    | 'loan_offer.created'
+    | 'loan_offer.updated'
     | 'lockbox.created'
     | 'lockbox.updated'
     | 'oauth_connection.created'
@@ -774,6 +790,10 @@ export namespace EventListParams {
       | 'intrafi_account_enrollment.updated'
       | 'intrafi_exclusion.created'
       | 'intrafi_exclusion.updated'
+      | 'loan_application.created'
+      | 'loan_application.updated'
+      | 'loan_offer.created'
+      | 'loan_offer.updated'
       | 'lockbox.created'
       | 'lockbox.updated'
       | 'oauth_connection.created'

package/src/resources/exports.ts

@@ -426,6 +426,16 @@ export namespace Export {
        * Filter fees created before this time.
        */
       before: string | null;
+
+      /**
+       * Filter fees created on or after this time.
+       */
+      on_or_after: string | null;
+
+      /**
+       * Filter fees created on or before this time.
+       */
+      on_or_before: string | null;
     }
   }
 
@@ -581,6 +591,8 @@ export interface ExportCreateParams {
    *   management dashboard.
    * - `account_verification_letter` - A PDF of an account verification letter.
    * - `funding_instructions` - A PDF of funding instructions.
+   * - `fee_csv` - Export a CSV of fees. The time range must not include any fees
+   *   that are part of an open fee statement.
    * - `voided_check` - A PDF of a voided check.
    * - `daily_account_balance_csv` - Export a CSV of daily account balances with
    *   starting and ending balances for a given date range.
@@ -595,6 +607,7 @@ export interface ExportCreateParams {
     | 'vendor_csv'
     | 'account_verification_letter'
     | 'funding_instructions'
+    | 'fee_csv'
     | 'voided_check'
     | 'daily_account_balance_csv';
 
@@ -633,6 +646,11 @@ export interface ExportCreateParams {
    */
   entity_csv?: ExportCreateParams.EntityCsv;
 
+  /**
+   * Options for the created export. Required if `category` is equal to `fee_csv`.
+   */
+  fee_csv?: ExportCreateParams.FeeCsv;
+
   /**
    * Options for the created export. Required if `category` is equal to
    * `funding_instructions`.
@@ -785,6 +803,52 @@ export namespace ExportCreateParams {
    */
   export interface EntityCsv {}
 
+  /**
+   * Options for the created export. Required if `category` is equal to `fee_csv`.
+   */
+  export interface FeeCsv {
+    /**
+     * Filter results by time range on the `created_at` attribute.
+     */
+    created_at?: FeeCsv.CreatedAt;
+
+    /**
+     * Filter exported Fees to the specified Program.
+     */
+    program_id?: string;
+  }
+
+  export namespace FeeCsv {
+    /**
+     * Filter results by time range on the `created_at` attribute.
+     */
+    export interface CreatedAt {
+      /**
+       * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+       * timestamp.
+       */
+      after?: string;
+
+      /**
+       * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+       * timestamp.
+       */
+      before?: string;
+
+      /**
+       * Return results on or after this
+       * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+       */
+      on_or_after?: string;
+
+      /**
+       * Return results on or before this
+       * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+       */
+      on_or_before?: string;
+    }
+  }
+
   /**
    * Options for the created export. Required if `category` is equal to
    * `funding_instructions`.

package/src/resources/fednow-transfers.ts

@@ -151,6 +151,11 @@ export interface FednowTransfer {
    */
   currency: 'USD';
 
+  /**
+   * The debtor's address.
+   */
+  debtor_address: FednowTransfer.DebtorAddress | null;
+
   /**
    * The name of the transfer's sender. If not provided, defaults to the name of the
    * account's entity.
@@ -347,6 +352,31 @@ export namespace FednowTransfer {
     state: string | null;
   }
 
+  /**
+   * The debtor's address.
+   */
+  export interface DebtorAddress {
+    /**
+     * The city, district, town, or village of the address.
+     */
+    city: string | null;
+
+    /**
+     * The first line of the address.
+     */
+    line1: string | null;
+
+    /**
+     * The ZIP code of the address.
+     */
+    postal_code: string | null;
+
+    /**
+     * The address state.
+     */
+    state: string | null;
+  }
+
   /**
    * If the transfer is rejected by FedNow or the destination financial institution,
    * this will contain supplemental details.

package/src/resources/inbound-wire-transfers.ts

@@ -173,6 +173,11 @@ export interface InboundWireTransfer {
    */
   instruction_identification: string | null;
 
+  /**
+   * The reason for the wire transfer, as set by the sender.
+   */
+  purpose: string | null;
+
   /**
    * If the transfer is reversed, this will contain details of the reversal.
    */

package/src/resources/intrafi-balances.ts

@@ -60,8 +60,6 @@ export interface IntrafiBalance {
    * `intrafi_balance`.
    */
   type: 'intrafi_balance';
-
-  [k: string]: unknown;
 }
 
 export namespace IntrafiBalance {
@@ -87,8 +85,6 @@ export namespace IntrafiBalance {
      * identify the institution.
      */
     fdic_certificate_number: string;
-
-    [k: string]: unknown;
   }
 
   export namespace Balance {

package/src/resources/pending-transactions.ts

@@ -561,6 +561,12 @@ export namespace PendingTransaction {
        */
       expires_at: string;
 
+      /**
+       * The healthcare-related fields for this authorization. Only present for specific
+       * programs.
+       */
+      healthcare: CardAuthorization.Healthcare | null;
+
       /**
        * The merchant identifier (commonly abbreviated as MID) of the merchant the card
        * is transacting with.
@@ -945,6 +951,24 @@ export namespace PendingTransaction {
         }
       }
 
+      /**
+       * The healthcare-related fields for this authorization. Only present for specific
+       * programs.
+       */
+      export interface Healthcare {
+        /**
+         * The merchant's eligibility under the Internal Revenue Service's 90% Rule for
+         * Flexible Spending Account (FSA) and Health Savings Account (HSA) eligible
+         * products. The eligibility is determined based on the list of merchants
+         * maintained by the Special Interest Group for IIAS Standards (SIGIS).
+         *
+         * - `eligible` - The merchant is eligible for treatment under the 90% rule.
+         * - `not_eligible` - The merchant is not eligible for treatment under the 90%
+         *   rule.
+         */
+        merchant_ninety_percent_eligibility: 'eligible' | 'not_eligible';
+      }
+
       /**
        * Fields specific to the `network`.
        */

package/src/resources/physical-card-profiles.ts

@@ -155,6 +155,12 @@ export interface PhysicalCardProfile {
    */
   front_image_file_id: string | null;
 
+  /**
+   * Text printed on the front of the card. Reach out to
+   * [support@increase.com](mailto:support@increase.com) for more information.
+   */
+  front_text: PhysicalCardProfile.FrontText | null;
+
   /**
    * The idempotency key you chose for this object. This value is unique across
    * Increase and is used to ensure that a request is only processed once. Learn more
@@ -199,8 +205,26 @@ export interface PhysicalCardProfile {
    * `physical_card_profile`.
    */
   type: 'physical_card_profile';
+}
 
-  [k: string]: unknown;
+export namespace PhysicalCardProfile {
+  /**
+   * Text printed on the front of the card. Reach out to
+   * [support@increase.com](mailto:support@increase.com) for more information.
+   */
+  export interface FrontText {
+    /**
+     * The first line of text on the front of the card.
+     */
+    line1: string;
+
+    /**
+     * The second line of text on the front of the card. Providing a second line moves
+     * the first line slightly higher and prints the second line in the spot where the
+     * first line would have otherwise been printed.
+     */
+    line2: string | null;
+  }
 }
 
 export interface PhysicalCardProfileCreateParams {

package/src/resources/physical-cards.ts

@@ -323,7 +323,10 @@ export namespace PhysicalCard {
          *
          * - `in_transit` - The physical card is in transit.
          * - `processed_for_delivery` - The physical card has been processed for delivery.
-         * - `delivered` - The physical card has been delivered.
+         * - `delivered` - The physical card has been delivered. Note that some couriers
+         *   track delivery status based on driver location data rather than an explicit
+         *   scan. While uncommon, a single physical card may have more than one delivered
+         *   event.
          * - `delivery_issue` - There is an issue preventing delivery. The delivery will be
          *   attempted again if possible. If the issue cannot be resolved, the physical
          *   card will be returned to sender.

package/src/resources/programs.ts

@@ -118,6 +118,8 @@ export namespace Program {
      * The maximum extendable credit of the program.
      */
     maximum_extendable_credit: number;
+
+    [k: string]: unknown;
   }
 }
 

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

@@ -647,6 +647,12 @@ export namespace RealTimeDecision {
      */
     direction: 'settlement' | 'refund';
 
+    /**
+     * The healthcare-related fields for this authorization. Only present for specific
+     * programs.
+     */
+    healthcare: CardAuthorization.Healthcare | null;
+
     /**
      * The merchant identifier (commonly abbreviated as MID) of the merchant the card
      * is transacting with.
@@ -1084,6 +1090,24 @@ export namespace RealTimeDecision {
         | 'other';
     }
 
+    /**
+     * The healthcare-related fields for this authorization. Only present for specific
+     * programs.
+     */
+    export interface Healthcare {
+      /**
+       * The merchant's eligibility under the Internal Revenue Service's 90% Rule for
+       * Flexible Spending Account (FSA) and Health Savings Account (HSA) eligible
+       * products. The eligibility is determined based on the list of merchants
+       * maintained by the Special Interest Group for IIAS Standards (SIGIS).
+       *
+       * - `eligible` - The merchant is eligible for treatment under the 90% rule.
+       * - `not_eligible` - The merchant is not eligible for treatment under the 90%
+       *   rule.
+       */
+      merchant_ninety_percent_eligibility: 'eligible' | 'not_eligible';
+    }
+
     /**
      * Fields specific to the `network`.
      */

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

@@ -125,9 +125,10 @@ export interface ACHTransferCreateNotificationOfChangeParams {
    *
    * - `checking` - A checking account.
    * - `savings` - A savings account.
+   * - `loan` - A loan account used in a lender-borrower relationship. Uncommon.
    * - `general_ledger` - A bank's general ledger. Uncommon.
    */
-  corrected_account_funding?: 'checking' | 'savings' | 'general_ledger';
+  corrected_account_funding?: 'checking' | 'savings' | 'loan' | 'general_ledger';
 
   /**
    * The corrected account number.

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

@@ -92,7 +92,8 @@ export interface CardAuthorizationCreateParams {
    *   card's value. Only applies when a CVV2 is present.
    * - `transaction_not_allowed` - The attempted card transaction is not allowed per
    *   Increase's terms.
-   * - `breaches_limit` - The transaction was blocked by a Limit.
+   * - `breaches_limit` - The transaction was blocked by a limit or an authorization
+   *   control.
    * - `webhook_declined` - Your application declined the transaction via webhook.
    * - `webhook_timed_out` - Your application webhook did not respond without the
    *   required timeout.

package/src/resources/simulations/card-balance-inquiries.ts

@@ -52,7 +52,8 @@ export interface CardBalanceInquiryCreateParams {
    *   card's value. Only applies when a CVV2 is present.
    * - `transaction_not_allowed` - The attempted card transaction is not allowed per
    *   Increase's terms.
-   * - `breaches_limit` - The transaction was blocked by a Limit.
+   * - `breaches_limit` - The transaction was blocked by a limit or an authorization
+   *   control.
    * - `webhook_declined` - Your application declined the transaction via webhook.
    * - `webhook_timed_out` - Your application webhook did not respond without the
    *   required timeout.

package/src/resources/simulations/check-deposits.ts

@@ -119,6 +119,7 @@ export interface CheckDepositAdjustmentParams {
 export interface CheckDepositSubmitParams {
   /**
    * If set, the simulation will use these values for the check's scanned MICR data.
+   * If not set, the simulation will use random values.
    */
   scan?: CheckDepositSubmitParams.Scan;
 }
@@ -126,6 +127,7 @@ export interface CheckDepositSubmitParams {
 export namespace CheckDepositSubmitParams {
   /**
    * If set, the simulation will use these values for the check's scanned MICR data.
+   * If not set, the simulation will use random values.
    */
   export interface Scan {
     /**
@@ -140,8 +142,15 @@ export namespace CheckDepositSubmitParams {
 
     /**
      * The auxiliary on-us data to be returned in the check deposit's scan data.
+     * Auxiliary on-us is typically the check number for business checks.
      */
     auxiliary_on_us?: string;
+
+    /**
+     * The serial number to be returned in the check deposit's scan data. Serial number
+     * is typically the check number for consumer checks.
+     */
+    serial_number?: string;
   }
 }
 

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

@@ -39,12 +39,18 @@ export interface DigitalWalletTokenRequestCreateResponse {
    * - `webhook_timed_out` - Your webhook timed out when evaluating the token
    *   provisioning attempt.
    * - `webhook_declined` - Your webhook declined the token provisioning attempt.
+   * - `incorrect_card_verification_code` - The tokenization attempt failed because
+   *   the Card Verification Code (CVC) was incorrect.
+   * - `declined_by_token_requestor` - The tokenization attempt was declined by the
+   *   token requestor.
    */
   decline_reason:
     | 'card_not_active'
     | 'no_verification_method'
     | 'webhook_timed_out'
     | 'webhook_declined'
+    | 'incorrect_card_verification_code'
+    | 'declined_by_token_requestor'
     | null;
 
   /**

package/src/resources/simulations/entities.ts

@@ -46,7 +46,7 @@ export namespace EntityUpdateValidationParams {
     /**
      * The type of issue.
      *
-     * - `entity_tax_identifier` - The entity's tax identifier could not be validated.
+     * - `entity_tax_identifier` - The entity's tax identifier could not be verified.
      *   Update the tax ID with the
      *   [update an entity API](/documentation/api/entities#update-an-entity.corporation.legal_identifier).
      * - `entity_address` - The entity's address could not be validated. Update the

package/src/resources/simulations/inbound-wire-transfers.ts

@@ -104,6 +104,12 @@ export interface InboundWireTransferCreateParams {
    */
   instruction_identification?: string;
 
+  /**
+   * The sending bank will set purpose in production. You can simulate any value
+   * here.
+   */
+  purpose?: string;
+
   /**
    * The sending bank will set unique_end_to_end_transaction_reference in production.
    * You can simulate any value here.

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

@@ -63,7 +63,10 @@ export interface PhysicalCardCreateParams {
    *
    * - `in_transit` - The physical card is in transit.
    * - `processed_for_delivery` - The physical card has been processed for delivery.
-   * - `delivered` - The physical card has been delivered.
+   * - `delivered` - The physical card has been delivered. Note that some couriers
+   *   track delivery status based on driver location data rather than an explicit
+   *   scan. While uncommon, a single physical card may have more than one delivered
+   *   event.
    * - `delivery_issue` - There is an issue preventing delivery. The delivery will be
    *   attempted again if possible. If the issue cannot be resolved, the physical
    *   card will be returned to sender.

package/src/resources/simulations/programs.ts

@@ -49,6 +49,8 @@ export interface ProgramCreateParams {
    * The identifier of the Account the Program should be added to is for.
    */
   reserve_account_id?: string;
+
+  [k: string]: unknown;
 }
 
 export declare namespace Programs {

package/src/resources/swift-transfers.ts

@@ -15,7 +15,7 @@ export class SwiftTransfers extends APIResource {
    * const swiftTransfer = await client.swiftTransfers.create({
    *   account_id: 'account_in71c4amph0vgo2qllky',
    *   account_number: '987654321',
-   *   bank_identification_code: 'ECBFDEFFTPP',
+   *   bank_identification_code: 'FRNYUS33XXX',
    *   creditor_address: {
    *     city: 'Frankfurt',
    *     country: 'DE',