increase 0.2.0 → 0.3.0

package/dist/cjs/resources/simulations/wire-transfers.d.ts

@@ -26,6 +26,11 @@ export interface WireTransferSimulation {
   type: 'inbound_wire_transfer_simulation_result';
 }
 export declare namespace WireTransferSimulation {
+  /**
+   * If the Wire Transfer attempt succeeds, this will contain the resulting
+   * [Transaction](#transactions) object. The Transaction's `source` will be of
+   * `category: inbound_wire_transfer`.
+   */
   interface Transaction {
     /**
      * The identifier for the Account the Transaction belongs to.
@@ -65,7 +70,7 @@ export declare namespace WireTransferSimulation {
     /**
      * The type of the route this 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
      * Transaction. Note that for backwards compatibility reasons, additional
@@ -80,6 +85,12 @@ export declare namespace WireTransferSimulation {
     type: 'transaction';
   }
   namespace Transaction {
+    /**
+     * This is an object giving more details on the network-level event that caused the
+     * Transaction. 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.
+     */
     interface Source {
       /**
        * A Account Transfer Intention object. This field will be present in the JSON
@@ -121,6 +132,11 @@ export declare namespace WireTransferSimulation {
        * only if `category` is equal to `card_refund`.
        */
       card_refund: Source.CardRefund | null;
+      /**
+       * A Card Revenue Payment object. This field will be present in the JSON response
+       * if and only if `category` is equal to `card_revenue_payment`.
+       */
+      card_revenue_payment: Source.CardRevenuePayment | null;
       /**
        * A Deprecated Card Refund object. This field will be present in the JSON response
        * if and only if `category` is equal to `card_route_refund`.
@@ -151,6 +167,7 @@ export declare namespace WireTransferSimulation {
         | 'card_dispute_acceptance'
         | 'card_refund'
         | 'card_settlement'
+        | 'card_revenue_payment'
         | 'check_deposit_acceptance'
         | 'check_deposit_return'
         | 'check_transfer_intention'
@@ -159,6 +176,7 @@ export declare namespace WireTransferSimulation {
         | 'check_transfer_stop_payment_request'
         | 'dispute_resolution'
         | 'empyreal_cash_deposit'
+        | 'fee_payment'
         | 'inbound_ach_transfer'
         | 'inbound_ach_transfer_return_intention'
         | 'inbound_check'
@@ -221,6 +239,11 @@ export declare namespace WireTransferSimulation {
        * if and only if `category` is equal to `empyreal_cash_deposit`.
        */
       empyreal_cash_deposit: Source.EmpyrealCashDeposit | null;
+      /**
+       * A Fee Payment object. This field will be present in the JSON response if and
+       * only if `category` is equal to `fee_payment`.
+       */
+      fee_payment: Source.FeePayment | null;
       /**
        * A Inbound ACH Transfer object. This field will be present in the JSON response
        * if and only if `category` is equal to `inbound_ach_transfer`.
@@ -274,6 +297,12 @@ export declare namespace WireTransferSimulation {
        * only if `category` is equal to `internal_source`.
        */
       internal_source: Source.InternalSource | null;
+      /**
+       * A Real Time Payments Transfer Acknowledgement object. This field will be present
+       * in the JSON response if and only if `category` is equal to
+       * `real_time_payments_transfer_acknowledgement`.
+       */
+      real_time_payments_transfer_acknowledgement: Source.RealTimePaymentsTransferAcknowledgement | null;
       /**
        * A Sample Funds object. This field will be present in the JSON response if and
        * only if `category` is equal to `sample_funds`.
@@ -303,6 +332,10 @@ export declare namespace WireTransferSimulation {
       wire_transfer_rejection: Source.WireTransferRejection | null;
     }
     namespace Source {
+      /**
+       * A Account Transfer Intention object. This field will be present in the JSON
+       * response if and only if `category` is equal to `account_transfer_intention`.
+       */
       interface AccountTransferIntention {
         /**
          * The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -331,6 +364,10 @@ export declare namespace WireTransferSimulation {
          */
         transfer_id: string;
       }
+      /**
+       * A ACH Check Conversion Return object. This field will be present in the JSON
+       * response if and only if `category` is equal to `ach_check_conversion_return`.
+       */
       interface ACHCheckConversionReturn {
         /**
          * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -342,6 +379,10 @@ export declare namespace WireTransferSimulation {
          */
         return_reason_code: string;
       }
+      /**
+       * A ACH Check Conversion object. This field will be present in the JSON response
+       * if and only if `category` is equal to `ach_check_conversion`.
+       */
       interface ACHCheckConversion {
         /**
          * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -353,6 +394,10 @@ export declare namespace WireTransferSimulation {
          */
         file_id: string;
       }
+      /**
+       * A ACH Transfer Intention object. This field will be present in the JSON response
+       * if and only if `category` is equal to `ach_transfer_intention`.
+       */
       interface ACHTransferIntention {
         account_number: string;
         /**
@@ -367,12 +412,20 @@ export declare namespace WireTransferSimulation {
          */
         transfer_id: string;
       }
+      /**
+       * A ACH Transfer Rejection object. This field will be present in the JSON response
+       * if and only if `category` is equal to `ach_transfer_rejection`.
+       */
       interface ACHTransferRejection {
         /**
          * The identifier of the ACH Transfer that led to this Transaction.
          */
         transfer_id: string;
       }
+      /**
+       * A ACH Transfer Return object. This field will be present in the JSON response if
+       * and only if `category` is equal to `ach_transfer_return`.
+       */
       interface ACHTransferReturn {
         /**
          * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -415,6 +468,10 @@ export declare namespace WireTransferSimulation {
          */
         transfer_id: string;
       }
+      /**
+       * A Card Dispute Acceptance object. This field will be present in the JSON
+       * response if and only if `category` is equal to `card_dispute_acceptance`.
+       */
       interface CardDisputeAcceptance {
         /**
          * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -429,44 +486,106 @@ export declare namespace WireTransferSimulation {
          * The identifier of the Transaction that was created to return the disputed funds
          * to your account.
          */
-        transaction_id: string | null;
+        transaction_id: string;
       }
+      /**
+       * A Card Refund object. This field will be present in the JSON response if and
+       * only if `category` is equal to `card_refund`.
+       */
       interface CardRefund {
         /**
          * The pending amount in the minor unit of the transaction's currency. For dollars,
          * for example, this is cents.
          */
         amount: number;
-        /**
-         * The identifier for the Transaction this refunds, if any.
-         */
-        card_settlement_transaction_id: string | null;
         /**
          * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
          * transaction's currency.
          */
         currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+        /**
+         * The Card Refund identifier.
+         */
+        id: string;
+        /**
+         * The merchant identifier (commonly abbreviated as MID) of the merchant the card
+         * is transacting with.
+         */
+        merchant_acceptor_id: string | null;
+        /**
+         * The 4-digit MCC describing the merchant's business.
+         */
+        merchant_category_code: string;
+        /**
+         * The city the merchant resides in.
+         */
+        merchant_city: string | null;
+        /**
+         * The country the merchant resides in.
+         */
+        merchant_country: string;
+        /**
+         * The name of the merchant.
+         */
+        merchant_name: string | null;
+        /**
+         * The state the merchant resides in.
+         */
+        merchant_state: string | null;
         /**
          * A constant representing the object's type. For this resource it will always be
          * `card_refund`.
          */
         type: 'card_refund';
       }
+      /**
+       * A Card Settlement object. This field will be present in the JSON response if and
+       * only if `category` is equal to `card_settlement`.
+       */
       interface CardSettlement {
         /**
          * The amount in the minor unit of the transaction's settlement currency. For
          * dollars, for example, this is cents.
          */
         amount: number;
+        /**
+         * The Card Authorization that was created prior to this Card Settlement, if on
+         * exists.
+         */
+        card_authorization: string | null;
         /**
          * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
          * transaction's settlement currency.
          */
         currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+        /**
+         * The Card Settlement identifier.
+         */
+        id: string;
+        /**
+         * The merchant identifier (commonly abbreviated as MID) of the merchant the card
+         * is transacting with.
+         */
+        merchant_acceptor_id: string | null;
+        /**
+         * The 4-digit MCC describing the merchant's business.
+         */
         merchant_category_code: string;
+        /**
+         * The city the merchant resides in.
+         */
         merchant_city: string | null;
+        /**
+         * The country the merchant resides in.
+         */
         merchant_country: string;
+        /**
+         * The name of the merchant.
+         */
         merchant_name: string | null;
+        /**
+         * The state the merchant resides in.
+         */
         merchant_state: string | null;
         /**
          * The identifier of the Pending Transaction associated with this Transaction.
@@ -487,6 +606,38 @@ export declare namespace WireTransferSimulation {
          */
         type: 'card_settlement';
       }
+      /**
+       * A Card Revenue Payment object. This field will be present in the JSON response
+       * if and only if `category` is equal to `card_revenue_payment`.
+       */
+      interface CardRevenuePayment {
+        /**
+         * The amount in the minor unit of the transaction's currency. For dollars, for
+         * example, this is cents.
+         */
+        amount: number;
+        /**
+         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
+         * currency.
+         */
+        currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+        /**
+         * The end of the period for which this transaction paid interest.
+         */
+        period_end: string;
+        /**
+         * The start of the period for which this transaction paid interest.
+         */
+        period_start: string;
+        /**
+         * The account the card belonged to.
+         */
+        transacted_on_account_id: string | null;
+      }
+      /**
+       * A Check Deposit Acceptance object. This field will be present in the JSON
+       * response if and only if `category` is equal to `check_deposit_acceptance`.
+       */
       interface CheckDepositAcceptance {
         /**
          * The account number printed on the check.
@@ -521,6 +672,10 @@ export declare namespace WireTransferSimulation {
          */
         serial_number: string | null;
       }
+      /**
+       * A Check Deposit Return object. This field will be present in the JSON response
+       * if and only if `category` is equal to `check_deposit_return`.
+       */
       interface CheckDepositReturn {
         /**
          * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -559,6 +714,10 @@ export declare namespace WireTransferSimulation {
          */
         transaction_id: string;
       }
+      /**
+       * A Check Transfer Intention object. This field will be present in the JSON
+       * response if and only if `category` is equal to `check_transfer_intention`.
+       */
       interface CheckTransferIntention {
         /**
          * The city of the check's destination.
@@ -598,22 +757,49 @@ export declare namespace WireTransferSimulation {
          */
         transfer_id: string;
       }
+      /**
+       * A Check Transfer Return object. This field will be present in the JSON response
+       * if and only if `category` is equal to `check_transfer_return`.
+       */
       interface CheckTransferReturn {
         /**
          * If available, a document with additional information about the return.
          */
         file_id: string | null;
+        /**
+         * The reason why the check was returned.
+         */
+        reason: 'mail_delivery_failure' | 'refused_by_recipient' | 'returned_not_authorized';
+        /**
+         * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+         * the check was returned.
+         */
+        returned_at: string;
+        /**
+         * The identifier of the Transaction that was created to credit you for the
+         * returned check.
+         */
+        transaction_id: string | null;
         /**
          * The identifier of the returned Check Transfer.
          */
         transfer_id: string;
       }
+      /**
+       * A Check Transfer Rejection object. This field will be present in the JSON
+       * response if and only if `category` is equal to `check_transfer_rejection`.
+       */
       interface CheckTransferRejection {
         /**
          * The identifier of the Check Transfer that led to this Transaction.
          */
         transfer_id: string;
       }
+      /**
+       * A Check Transfer Stop Payment Request object. This field will be present in the
+       * JSON response if and only if `category` is equal to
+       * `check_transfer_stop_payment_request`.
+       */
       interface CheckTransferStopPaymentRequest {
         /**
          * The time the stop-payment was requested.
@@ -633,6 +819,10 @@ export declare namespace WireTransferSimulation {
          */
         type: 'check_transfer_stop_payment_request';
       }
+      /**
+       * A Dispute Resolution object. This field will be present in the JSON response if
+       * and only if `category` is equal to `dispute_resolution`.
+       */
       interface DisputeResolution {
         /**
          * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -649,6 +839,10 @@ export declare namespace WireTransferSimulation {
          */
         disputed_transaction_id: string;
       }
+      /**
+       * A Empyreal Cash Deposit object. This field will be present in the JSON response
+       * if and only if `category` is equal to `empyreal_cash_deposit`.
+       */
       interface EmpyrealCashDeposit {
         /**
          * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -658,6 +852,26 @@ export declare namespace WireTransferSimulation {
         bag_id: string;
         deposit_date: string;
       }
+      /**
+       * A Fee Payment object. This field will be present in the JSON response if and
+       * only if `category` is equal to `fee_payment`.
+       */
+      interface FeePayment {
+        /**
+         * The amount in the minor unit of the transaction's currency. For dollars, for
+         * example, this is cents.
+         */
+        amount: number;
+        /**
+         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
+         * currency.
+         */
+        currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+      }
+      /**
+       * A Inbound ACH Transfer object. This field will be present in the JSON response
+       * if and only if `category` is equal to `inbound_ach_transfer`.
+       */
       interface InboundACHTransfer {
         /**
          * The amount in the minor unit of the destination account currency. For dollars,
@@ -673,6 +887,10 @@ export declare namespace WireTransferSimulation {
         receiver_name: string | null;
         trace_number: string;
       }
+      /**
+       * A Inbound Check object. This field will be present in the JSON response if and
+       * only if `category` is equal to `inbound_check`.
+       */
       interface InboundCheck {
         /**
          * The amount in the minor unit of the destination account currency. For dollars,
@@ -688,6 +906,11 @@ export declare namespace WireTransferSimulation {
          */
         currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
       }
+      /**
+       * A Inbound International ACH Transfer object. This field will be present in the
+       * JSON response if and only if `category` is equal to
+       * `inbound_international_ach_transfer`.
+       */
       interface InboundInternationalACHTransfer {
         /**
          * The amount in the minor unit of the destination account currency. For dollars,
@@ -730,6 +953,11 @@ export declare namespace WireTransferSimulation {
         receiving_depository_financial_institution_name: string;
         trace_number: string;
       }
+      /**
+       * A Inbound Real Time Payments Transfer Confirmation object. This field will be
+       * present in the JSON response if and only if `category` is equal to
+       * `inbound_real_time_payments_transfer_confirmation`.
+       */
       interface InboundRealTimePaymentsTransferConfirmation {
         /**
          * The amount in the minor unit of the transfer's currency. For dollars, for
@@ -766,6 +994,11 @@ export declare namespace WireTransferSimulation {
          */
         transaction_identification: string;
       }
+      /**
+       * A Inbound Wire Drawdown Payment Reversal object. This field will be present in
+       * the JSON response if and only if `category` is equal to
+       * `inbound_wire_drawdown_payment_reversal`.
+       */
       interface InboundWireDrawdownPaymentReversal {
         /**
          * The amount that was reversed.
@@ -808,6 +1041,10 @@ export declare namespace WireTransferSimulation {
          */
         previous_message_input_source: string;
       }
+      /**
+       * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
+       * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
+       */
       interface InboundWireDrawdownPayment {
         /**
          * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -827,11 +1064,20 @@ export declare namespace WireTransferSimulation {
         originator_name: string | null;
         originator_to_beneficiary_information: string | null;
       }
+      /**
+       * A Inbound Wire Reversal object. This field will be present in the JSON response
+       * if and only if `category` is equal to `inbound_wire_reversal`.
+       */
       interface InboundWireReversal {
         /**
          * The amount that was reversed.
          */
         amount: number;
+        /**
+         * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+         * the reversal was created.
+         */
+        created_at: string;
         /**
          * The description on the reversal message from Fedwire.
          */
@@ -877,7 +1123,19 @@ export declare namespace WireTransferSimulation {
          * institution.
          */
         receiver_financial_institution_information: string | null;
+        /**
+         * The ID for the Transaction associated with the transfer reversal.
+         */
+        transaction_id: string | null;
+        /**
+         * The ID for the Wire Transfer that is being reversed.
+         */
+        wire_transfer_id: string;
       }
+      /**
+       * A Inbound Wire Transfer object. This field will be present in the JSON response
+       * if and only if `category` is equal to `inbound_wire_transfer`.
+       */
       interface InboundWireTransfer {
         /**
          * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -901,6 +1159,10 @@ export declare namespace WireTransferSimulation {
         originator_to_beneficiary_information_line3: string | null;
         originator_to_beneficiary_information_line4: string | null;
       }
+      /**
+       * A Interest Payment object. This field will be present in the JSON response if
+       * and only if `category` is equal to `interest_payment`.
+       */
       interface InterestPayment {
         /**
          * The account on which the interest was accrued.
@@ -925,6 +1187,10 @@ export declare namespace WireTransferSimulation {
          */
         period_start: string;
       }
+      /**
+       * A Internal Source object. This field will be present in the JSON response if and
+       * only if `category` is equal to `internal_source`.
+       */
       interface InternalSource {
         /**
          * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -939,14 +1205,20 @@ export declare namespace WireTransferSimulation {
         reason:
           | 'bank_migration'
           | 'cashback'
+          | 'collection_receivable'
           | 'empyreal_adjustment'
           | 'error'
           | 'error_correction'
           | 'fees'
           | 'interest'
+          | 'negative_balance_forgiveness'
           | 'sample_funds'
           | 'sample_funds_return';
       }
+      /**
+       * A Deprecated Card Refund object. This field will be present in the JSON response
+       * if and only if `category` is equal to `card_route_refund`.
+       */
       interface CardRouteRefund {
         /**
          * The refunded amount in the minor unit of the refunded currency. For dollars, for
@@ -965,6 +1237,10 @@ export declare namespace WireTransferSimulation {
         merchant_descriptor: string;
         merchant_state: string | null;
       }
+      /**
+       * A Deprecated Card Settlement object. This field will be present in the JSON
+       * response if and only if `category` is equal to `card_route_settlement`.
+       */
       interface CardRouteSettlement {
         /**
          * The settled amount in the minor unit of the settlement currency. For dollars,
@@ -983,12 +1259,48 @@ export declare namespace WireTransferSimulation {
         merchant_descriptor: string;
         merchant_state: string | null;
       }
+      /**
+       * A Real Time Payments Transfer Acknowledgement object. This field will be present
+       * in the JSON response if and only if `category` is equal to
+       * `real_time_payments_transfer_acknowledgement`.
+       */
+      interface RealTimePaymentsTransferAcknowledgement {
+        /**
+         * The transfer amount in USD cents.
+         */
+        amount: number;
+        /**
+         * The destination account number.
+         */
+        destination_account_number: string;
+        /**
+         * The American Bankers' Association (ABA) Routing Transit Number (RTN).
+         */
+        destination_routing_number: string;
+        /**
+         * Unstructured information that will show on the recipient's bank statement.
+         */
+        remittance_information: string;
+        /**
+         * The identifier of the Real Time Payments Transfer that led to this Transaction.
+         */
+        transfer_id: string;
+      }
+      /**
+       * A Sample Funds object. This field will be present in the JSON response if and
+       * only if `category` is equal to `sample_funds`.
+       */
       interface SampleFunds {
         /**
          * Where the sample funds came from.
          */
         originator: string;
       }
+      /**
+       * A Wire Drawdown Payment Intention object. This field will be present in the JSON
+       * response if and only if `category` is equal to
+       * `wire_drawdown_payment_intention`.
+       */
       interface WireDrawdownPaymentIntention {
         account_number: string;
         /**
@@ -999,9 +1311,18 @@ export declare namespace WireTransferSimulation {
         routing_number: string;
         transfer_id: string;
       }
+      /**
+       * A Wire Drawdown Payment Rejection object. This field will be present in the JSON
+       * response if and only if `category` is equal to
+       * `wire_drawdown_payment_rejection`.
+       */
       interface WireDrawdownPaymentRejection {
         transfer_id: string;
       }
+      /**
+       * A Wire Transfer Intention object. This field will be present in the JSON
+       * response if and only if `category` is equal to `wire_transfer_intention`.
+       */
       interface WireTransferIntention {
         /**
          * The destination account number.
@@ -1021,6 +1342,10 @@ export declare namespace WireTransferSimulation {
         routing_number: string;
         transfer_id: string;
       }
+      /**
+       * A Wire Transfer Rejection object. This field will be present in the JSON
+       * response if and only if `category` is equal to `wire_transfer_rejection`.
+       */
       interface WireTransferRejection {
         transfer_id: string;
       }
@@ -1102,3 +1427,4 @@ export interface WireTransferCreateInboundParams {
    */
   originator_to_beneficiary_information_line4?: string;
 }
+//# sourceMappingURL=wire-transfers.d.ts.map