increase 0.2.0 → 0.4.0

package/resources/simulations/cards.ts

@@ -63,6 +63,11 @@ export interface CardAuthorizationSimulation {
 }
 
 export namespace CardAuthorizationSimulation {
+  /**
+   * If the authorization attempt succeeds, this will contain the resulting Pending
+   * Transaction object. The Pending Transaction's `source` will be of
+   * `category: card_authorization`.
+   */
   export interface PendingTransaction {
     /**
      * The identifier for the account this Pending Transaction belongs to.
@@ -75,6 +80,12 @@ export namespace CardAuthorizationSimulation {
      */
     amount: number;
 
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
+     * Transaction was completed.
+     */
+    completed_at: string | null;
+
     /**
      * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
      * Transaction occured.
@@ -109,7 +120,7 @@ export namespace CardAuthorizationSimulation {
     /**
      * The type of the route this Pending Transaction came through.
      */
-    route_type: string | null;
+    route_type: 'account_number' | 'card' | null;
 
     /**
      * This is an object giving more details on the network-level event that caused the
@@ -132,6 +143,11 @@ export namespace CardAuthorizationSimulation {
   }
 
   export namespace PendingTransaction {
+    /**
+     * This is an object giving more details on the network-level event that caused the
+     * Pending Transaction. For example, for a card transaction this lists the
+     * merchant's industry and location.
+     */
     export interface Source {
       /**
        * A Account Transfer Instruction object. This field will be present in the JSON
@@ -151,12 +167,6 @@ export namespace CardAuthorizationSimulation {
        */
       card_authorization: Source.CardAuthorization | null;
 
-      /**
-       * A Deprecated Card Authorization object. This field will be present in the JSON
-       * response if and only if `category` is equal to `card_route_authorization`.
-       */
-      card_route_authorization: Source.CardRouteAuthorization | null;
-
       /**
        * The type of transaction that took place. We may add additional possible values
        * for this enum over time; your application should be able to handle such
@@ -169,9 +179,7 @@ export namespace CardAuthorizationSimulation {
         | 'check_deposit_instruction'
         | 'check_transfer_instruction'
         | 'inbound_funds_hold'
-        | 'card_route_authorization'
         | 'real_time_payments_transfer_instruction'
-        | 'wire_drawdown_payment_instruction'
         | 'wire_transfer_instruction'
         | 'other';
 
@@ -194,11 +202,11 @@ export namespace CardAuthorizationSimulation {
       inbound_funds_hold: Source.InboundFundsHold | null;
 
       /**
-       * A Wire Drawdown Payment Instruction object. This field will be present in the
-       * JSON response if and only if `category` is equal to
-       * `wire_drawdown_payment_instruction`.
+       * A Real Time Payments Transfer Instruction object. This field will be present in
+       * the JSON response if and only if `category` is equal to
+       * `real_time_payments_transfer_instruction`.
        */
-      wire_drawdown_payment_instruction: Source.WireDrawdownPaymentInstruction | null;
+      real_time_payments_transfer_instruction: Source.RealTimePaymentsTransferInstruction | null;
 
       /**
        * A Wire Transfer Instruction object. This field will be present in the JSON
@@ -208,6 +216,10 @@ export namespace CardAuthorizationSimulation {
     }
 
     export namespace Source {
+      /**
+       * A Account Transfer Instruction object. This field will be present in the JSON
+       * response if and only if `category` is equal to `account_transfer_instruction`.
+       */
       export interface AccountTransferInstruction {
         /**
          * The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -227,6 +239,10 @@ export namespace CardAuthorizationSimulation {
         transfer_id: string;
       }
 
+      /**
+       * A ACH Transfer Instruction object. This field will be present in the JSON
+       * response if and only if `category` is equal to `ach_transfer_instruction`.
+       */
       export interface ACHTransferInstruction {
         /**
          * The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -240,6 +256,10 @@ export namespace CardAuthorizationSimulation {
         transfer_id: string;
       }
 
+      /**
+       * A Card Authorization object. This field will be present in the JSON response if
+       * and only if `category` is equal to `card_authorization`.
+       */
       export interface CardAuthorization {
         /**
          * The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -259,6 +279,17 @@ export namespace CardAuthorizationSimulation {
          */
         digital_wallet_token_id: string | null;
 
+        /**
+         * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization
+         * will expire and the pending transaction will be released.
+         */
+        expires_at: string;
+
+        /**
+         * The Card Authorization identifier.
+         */
+        id: string;
+
         /**
          * The merchant identifier (commonly abbreviated as MID) of the merchant the card
          * is transacting with.
@@ -296,14 +327,28 @@ export namespace CardAuthorizationSimulation {
          */
         network_details: CardAuthorization.NetworkDetails;
 
+        /**
+         * The identifier of the Pending Transaction associated with this Transaction.
+         */
+        pending_transaction_id: string | null;
+
         /**
          * The identifier of the Real-Time Decision sent to approve or decline this
          * transaction.
          */
         real_time_decision_id: string | null;
+
+        /**
+         * A constant representing the object's type. For this resource it will always be
+         * `card_authorization`.
+         */
+        type: 'card_authorization';
       }
 
       export namespace CardAuthorization {
+        /**
+         * Fields specific to the `network`
+         */
         export interface NetworkDetails {
           /**
            * Fields specific to the `visa` network
@@ -312,6 +357,9 @@ export namespace CardAuthorizationSimulation {
         }
 
         export namespace NetworkDetails {
+          /**
+           * Fields specific to the `visa` network
+           */
           export interface Visa {
             /**
              * For electronic commerce transactions, this identifies the level of security used
@@ -333,11 +381,15 @@ export namespace CardAuthorizationSimulation {
              * The method used to enter the cardholder's primary account number and card
              * expiration date
              */
-            point_of_service_entry_mode: Shared.PointOfServiceEntryMode;
+            point_of_service_entry_mode: Shared.PointOfServiceEntryMode | null;
           }
         }
       }
 
+      /**
+       * A Check Deposit Instruction object. This field will be present in the JSON
+       * response if and only if `category` is equal to `check_deposit_instruction`.
+       */
       export interface CheckDepositInstruction {
         /**
          * The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -369,6 +421,10 @@ export namespace CardAuthorizationSimulation {
         front_image_file_id: string;
       }
 
+      /**
+       * A Check Transfer Instruction object. This field will be present in the JSON
+       * response if and only if `category` is equal to `check_transfer_instruction`.
+       */
       export interface CheckTransferInstruction {
         /**
          * The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -388,6 +444,10 @@ export namespace CardAuthorizationSimulation {
         transfer_id: string;
       }
 
+      /**
+       * A Inbound Funds Hold object. This field will be present in the JSON response if
+       * and only if `category` is equal to `inbound_funds_hold`.
+       */
       export interface InboundFundsHold {
         /**
          * The held amount in the minor unit of the account's currency. For dollars, for
@@ -401,6 +461,12 @@ export namespace CardAuthorizationSimulation {
          */
         automatically_releases_at: string;
 
+        /**
+         * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold
+         * was created.
+         */
+        created_at: string;
+
         /**
          * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's
          * currency.
@@ -412,6 +478,11 @@ export namespace CardAuthorizationSimulation {
          */
         held_transaction_id: string | null;
 
+        /**
+         * The ID of the Pending Transaction representing the held funds.
+         */
+        pending_transaction_id: string | null;
+
         /**
          * When the hold was released (if it has been released).
          */
@@ -423,7 +494,12 @@ export namespace CardAuthorizationSimulation {
         status: 'held' | 'complete';
       }
 
-      export interface CardRouteAuthorization {
+      /**
+       * A Real Time Payments Transfer Instruction object. This field will be present in
+       * the JSON response if and only if `category` is equal to
+       * `real_time_payments_transfer_instruction`.
+       */
+      export interface RealTimePaymentsTransferInstruction {
         /**
          * The pending amount in the minor unit of the transaction's currency. For dollars,
          * for example, this is cents.
@@ -431,38 +507,16 @@ export namespace CardAuthorizationSimulation {
         amount: number;
 
         /**
-         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
-         * transaction's currency.
-         */
-        currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
-
-        merchant_acceptor_id: string;
-
-        merchant_category_code: string;
-
-        merchant_city: string | null;
-
-        merchant_country: string;
-
-        merchant_descriptor: string;
-
-        merchant_state: string | null;
-      }
-
-      export interface WireDrawdownPaymentInstruction {
-        account_number: string;
-
-        /**
-         * The pending amount in the minor unit of the transaction's currency. For dollars,
-         * for example, this is cents.
+         * The identifier of the Real Time Payments Transfer that led to this Pending
+         * Transaction.
          */
-        amount: number;
-
-        message_to_recipient: string;
-
-        routing_number: string;
+        transfer_id: string;
       }
 
+      /**
+       * A Wire Transfer Instruction object. This field will be present in the JSON
+       * response if and only if `category` is equal to `wire_transfer_instruction`.
+       */
       export interface WireTransferInstruction {
         account_number: string;
 
@@ -481,6 +535,11 @@ export namespace CardAuthorizationSimulation {
     }
   }
 
+  /**
+   * If the authorization attempt fails, this will contain the resulting
+   * [Declined Transaction](#declined-transactions) object. The Declined
+   * Transaction's `source` will be of `category: card_decline`.
+   */
   export interface DeclinedTransaction {
     /**
      * The identifier for the Account the Declined Transaction belongs to.
@@ -525,7 +584,7 @@ export namespace CardAuthorizationSimulation {
     /**
      * The type of the route this Declined Transaction came through.
      */
-    route_type: string | null;
+    route_type: 'account_number' | 'card' | null;
 
     /**
      * This is an object giving more details on the network-level event that caused the
@@ -544,6 +603,13 @@ export namespace CardAuthorizationSimulation {
   }
 
   export namespace DeclinedTransaction {
+    /**
+     * This is an object giving more details on the network-level event that caused the
+     * Declined Transaction. For example, for a card transaction this lists the
+     * merchant's industry and location. Note that for backwards compatibility reasons,
+     * additional undocumented keys may appear in this object. These should be treated
+     * as deprecated and will be removed in the future.
+     */
     export interface Source {
       /**
        * A ACH Decline object. This field will be present in the JSON response if and
@@ -557,12 +623,6 @@ export namespace CardAuthorizationSimulation {
        */
       card_decline: Source.CardDecline | null;
 
-      /**
-       * A Deprecated Card Decline object. This field will be present in the JSON
-       * response if and only if `category` is equal to `card_route_decline`.
-       */
-      card_route_decline: Source.CardRouteDecline | null;
-
       /**
        * The type of decline that took place. We may add additional possible values for
        * this enum over time; your application should be able to handle such additions
@@ -574,7 +634,7 @@ export namespace CardAuthorizationSimulation {
         | 'check_decline'
         | 'inbound_real_time_payments_transfer_decline'
         | 'international_ach_decline'
-        | 'card_route_decline'
+        | 'wire_decline'
         | 'other';
 
       /**
@@ -595,9 +655,19 @@ export namespace CardAuthorizationSimulation {
        * response if and only if `category` is equal to `international_ach_decline`.
        */
       international_ach_decline: Source.InternationalACHDecline | null;
+
+      /**
+       * A Wire Decline object. This field will be present in the JSON response if and
+       * only if `category` is equal to `wire_decline`.
+       */
+      wire_decline: Source.WireDecline | null;
     }
 
     export namespace Source {
+      /**
+       * A ACH Decline object. This field will be present in the JSON response if and
+       * only if `category` is equal to `ach_decline`.
+       */
       export interface ACHDecline {
         /**
          * The declined amount in the minor unit of the destination account currency. For
@@ -623,11 +693,12 @@ export namespace CardAuthorizationSimulation {
           | 'credit_entry_refused_by_receiver'
           | 'duplicate_return'
           | 'entity_not_active'
-          | 'transaction_not_allowed'
           | 'group_locked'
           | 'insufficient_funds'
+          | 'misrouted_return'
           | 'no_ach_route'
-          | 'originator_request';
+          | 'originator_request'
+          | 'transaction_not_allowed';
 
         receiver_id_number: string | null;
 
@@ -636,6 +707,10 @@ export namespace CardAuthorizationSimulation {
         trace_number: string;
       }
 
+      /**
+       * A Card Decline object. This field will be present in the JSON response if and
+       * only if `category` is equal to `card_decline`.
+       */
       export interface CardDecline {
         /**
          * The declined amount in the minor unit of the destination account currency. For
@@ -713,13 +788,19 @@ export namespace CardAuthorizationSimulation {
           | 'insufficient_funds'
           | 'cvv2_mismatch'
           | 'transaction_not_allowed'
+          | 'breaches_internal_limit'
           | 'breaches_limit'
           | 'webhook_declined'
           | 'webhook_timed_out'
-          | 'declined_by_stand_in_processing';
+          | 'declined_by_stand_in_processing'
+          | 'invalid_physical_card'
+          | 'missing_original_authorization';
       }
 
       export namespace CardDecline {
+        /**
+         * Fields specific to the `network`
+         */
         export interface NetworkDetails {
           /**
            * Fields specific to the `visa` network
@@ -728,6 +809,9 @@ export namespace CardAuthorizationSimulation {
         }
 
         export namespace NetworkDetails {
+          /**
+           * Fields specific to the `visa` network
+           */
           export interface Visa {
             /**
              * For electronic commerce transactions, this identifies the level of security used
@@ -749,11 +833,15 @@ export namespace CardAuthorizationSimulation {
              * The method used to enter the cardholder's primary account number and card
              * expiration date
              */
-            point_of_service_entry_mode: Shared.PointOfServiceEntryMode;
+            point_of_service_entry_mode: Shared.PointOfServiceEntryMode | null;
           }
         }
       }
 
+      /**
+       * A Check Decline object. This field will be present in the JSON response if and
+       * only if `category` is equal to `check_decline`.
+       */
       export interface CheckDecline {
         /**
          * The declined amount in the minor unit of the destination account currency. For
@@ -774,12 +862,21 @@ export namespace CardAuthorizationSimulation {
           | 'group_locked'
           | 'insufficient_funds'
           | 'unable_to_locate_account'
+          | 'not_our_item'
           | 'unable_to_process'
           | 'refer_to_image'
           | 'stop_payment_requested'
-          | 'returned';
+          | 'returned'
+          | 'duplicate_presentment'
+          | 'not_authorized'
+          | 'altered_or_fictitious';
       }
 
+      /**
+       * A Inbound Real Time Payments Transfer Decline object. This field will be present
+       * in the JSON response if and only if `category` is equal to
+       * `inbound_real_time_payments_transfer_decline`.
+       */
       export interface InboundRealTimePaymentsTransferDecline {
         /**
          * The declined amount in the minor unit of the destination account currency. For
@@ -820,6 +917,7 @@ export namespace CardAuthorizationSimulation {
         reason:
           | 'account_number_canceled'
           | 'account_number_disabled'
+          | 'account_restricted'
           | 'group_locked'
           | 'entity_not_active'
           | 'real_time_payments_not_enabled';
@@ -835,6 +933,10 @@ export namespace CardAuthorizationSimulation {
         transaction_identification: string;
       }
 
+      /**
+       * A International ACH Decline object. This field will be present in the JSON
+       * response if and only if `category` is equal to `international_ach_decline`.
+       */
       export interface InternationalACHDecline {
         /**
          * The declined amount in the minor unit of the destination account currency. For
@@ -913,30 +1015,57 @@ export namespace CardAuthorizationSimulation {
         trace_number: string;
       }
 
-      export interface CardRouteDecline {
+      /**
+       * A Wire Decline object. This field will be present in the JSON response if and
+       * only if `category` is equal to `wire_decline`.
+       */
+      export interface WireDecline {
         /**
          * The declined amount in the minor unit of the destination account currency. For
          * dollars, for example, this is cents.
          */
         amount: number;
 
-        /**
-         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
-         * account currency.
-         */
-        currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+        beneficiary_address_line1: string | null;
 
-        merchant_acceptor_id: string;
+        beneficiary_address_line2: string | null;
 
-        merchant_category_code: string | null;
+        beneficiary_address_line3: string | null;
 
-        merchant_city: string | null;
+        beneficiary_name: string | null;
 
-        merchant_country: string;
+        beneficiary_reference: string | null;
 
-        merchant_descriptor: string;
+        description: string;
 
-        merchant_state: string | null;
+        input_message_accountability_data: string | null;
+
+        originator_address_line1: string | null;
+
+        originator_address_line2: string | null;
+
+        originator_address_line3: string | null;
+
+        originator_name: string | null;
+
+        originator_to_beneficiary_information_line1: string | null;
+
+        originator_to_beneficiary_information_line2: string | null;
+
+        originator_to_beneficiary_information_line3: string | null;
+
+        originator_to_beneficiary_information_line4: string | null;
+
+        /**
+         * Why the wire transfer was declined.
+         */
+        reason:
+          | 'account_number_canceled'
+          | 'account_number_disabled'
+          | 'entity_not_active'
+          | 'group_locked'
+          | 'no_account_number'
+          | 'transaction_not_allowed';
       }
     }
   }
@@ -957,6 +1086,14 @@ export interface CardAuthorizeParams {
    * The identifier of the Digital Wallet Token to be authorized.
    */
   digital_wallet_token_id?: string;
+
+  /**
+   * The identifier of the Event Subscription to use. If provided, will override the
+   * default real time event subscription. Because you can only create one real time
+   * decision event subscription, you can use this field to route events to any
+   * specified event subscription for testing purposes.
+   */
+  event_subscription_id?: string;
 }
 
 export interface CardSettlementParams {

package/resources/simulations/check-transfers.ts

@@ -27,4 +27,23 @@ export class CheckTransfers extends APIResource {
   ): Promise<Core.APIResponse<CheckTransfers_.CheckTransfer>> {
     return this.post(`/simulations/check_transfers/${checkTransferId}/mail`, options);
   }
+
+  /**
+   * Simulates a [Check Transfer](#check-transfers) being returned via USPS to
+   * Increase. This transfer must first have a `status` of `mailed`.
+   */
+  return(
+    checkTransferId: string,
+    body: CheckTransferReturnParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<CheckTransfers_.CheckTransfer>> {
+    return this.post(`/simulations/check_transfers/${checkTransferId}/return`, { body, ...options });
+  }
+}
+
+export interface CheckTransferReturnParams {
+  /**
+   * The reason why the Check Transfer was returned to Increase.
+   */
+  reason: 'mail_delivery_failure' | 'refused_by_recipient' | 'returned_not_authorized';
 }

package/resources/simulations/index.ts

@@ -9,6 +9,7 @@ export { AccountStatementCreateParams } from './account-statements';
 export { CardAuthorizationSimulation, CardAuthorizeParams, CardSettlementParams } from './cards';
 export { CardDisputeActionParams } from './card-disputes';
 export { CardRefundCreateParams } from './card-refunds';
+export { CheckTransferReturnParams } from './check-transfers';
 export {
   DigitalWalletTokenRequestCreateResponse,
   DigitalWalletTokenRequestCreateParams,
@@ -16,7 +17,10 @@ export {
 export { DocumentCreateParams } from './documents';
 export {
   InboundRealTimePaymentsTransferSimulationResult,
+  RealTimePaymentsTransferCompleteParams,
   RealTimePaymentsTransferCreateInboundParams,
 } from './real-time-payments-transfers';
 export { InboundWireDrawdownRequestCreateParams } from './inbound-wire-drawdown-requests';
+export { InterestPaymentSimulationResult, InterestPaymentCreateParams } from './interest-payments';
+export { ProgramCreateParams } from './programs';
 export { WireTransferSimulation, WireTransferCreateInboundParams } from './wire-transfers';