increase 0.2.0 → 0.3.0

package/resources/simulations/wire-transfers.ts

@@ -34,6 +34,11 @@ export interface WireTransferSimulation {
 }
 
 export 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`.
+   */
   export interface Transaction {
     /**
      * The identifier for the Account the Transaction belongs to.
@@ -80,7 +85,7 @@ export 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
@@ -98,6 +103,12 @@ export namespace WireTransferSimulation {
   }
 
   export 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.
+     */
     export interface Source {
       /**
        * A Account Transfer Intention object. This field will be present in the JSON
@@ -147,6 +158,12 @@ export namespace WireTransferSimulation {
        */
       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`.
@@ -180,6 +197,7 @@ export namespace WireTransferSimulation {
         | 'card_dispute_acceptance'
         | 'card_refund'
         | 'card_settlement'
+        | 'card_revenue_payment'
         | 'check_deposit_acceptance'
         | 'check_deposit_return'
         | 'check_transfer_intention'
@@ -188,6 +206,7 @@ export namespace WireTransferSimulation {
         | 'check_transfer_stop_payment_request'
         | 'dispute_resolution'
         | 'empyreal_cash_deposit'
+        | 'fee_payment'
         | 'inbound_ach_transfer'
         | 'inbound_ach_transfer_return_intention'
         | 'inbound_check'
@@ -259,6 +278,12 @@ export namespace WireTransferSimulation {
        */
       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`.
@@ -322,6 +347,13 @@ export namespace WireTransferSimulation {
        */
       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`.
@@ -356,6 +388,10 @@ export namespace WireTransferSimulation {
     }
 
     export 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`.
+       */
       export interface AccountTransferIntention {
         /**
          * The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -390,6 +426,10 @@ export 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`.
+       */
       export interface ACHCheckConversionReturn {
         /**
          * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -403,6 +443,10 @@ export 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`.
+       */
       export interface ACHCheckConversion {
         /**
          * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -416,6 +460,10 @@ export 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`.
+       */
       export interface ACHTransferIntention {
         account_number: string;
 
@@ -435,6 +483,10 @@ export 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`.
+       */
       export interface ACHTransferRejection {
         /**
          * The identifier of the ACH Transfer that led to this Transaction.
@@ -442,6 +494,10 @@ export namespace WireTransferSimulation {
         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`.
+       */
       export interface ACHTransferReturn {
         /**
          * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -488,6 +544,10 @@ export 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`.
+       */
       export interface CardDisputeAcceptance {
         /**
          * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -504,9 +564,13 @@ export 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`.
+       */
       export interface CardRefund {
         /**
          * The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -514,17 +578,48 @@ export namespace WireTransferSimulation {
          */
         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`.
@@ -532,6 +627,10 @@ export namespace WireTransferSimulation {
         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`.
+       */
       export interface CardSettlement {
         /**
          * The amount in the minor unit of the transaction's settlement currency. For
@@ -539,20 +638,52 @@ export namespace WireTransferSimulation {
          */
         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;
 
         /**
@@ -578,6 +709,43 @@ export 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`.
+       */
+      export 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`.
+       */
       export interface CheckDepositAcceptance {
         /**
          * The account number printed on the check.
@@ -619,6 +787,10 @@ export 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`.
+       */
       export interface CheckDepositReturn {
         /**
          * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -663,6 +835,10 @@ export 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`.
+       */
       export interface CheckTransferIntention {
         /**
          * The city of the check's destination.
@@ -711,18 +887,43 @@ export 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`.
+       */
       export 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`.
+       */
       export interface CheckTransferRejection {
         /**
          * The identifier of the Check Transfer that led to this Transaction.
@@ -730,6 +931,11 @@ export namespace WireTransferSimulation {
         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`.
+       */
       export interface CheckTransferStopPaymentRequest {
         /**
          * The time the stop-payment was requested.
@@ -753,6 +959,10 @@ export 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`.
+       */
       export interface DisputeResolution {
         /**
          * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -772,6 +982,10 @@ export 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`.
+       */
       export interface EmpyrealCashDeposit {
         /**
          * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -784,6 +998,28 @@ export namespace WireTransferSimulation {
         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`.
+       */
+      export 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`.
+       */
       export interface InboundACHTransfer {
         /**
          * The amount in the minor unit of the destination account currency. For dollars,
@@ -808,6 +1044,10 @@ export namespace WireTransferSimulation {
         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`.
+       */
       export interface InboundCheck {
         /**
          * The amount in the minor unit of the destination account currency. For dollars,
@@ -828,6 +1068,11 @@ export 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`.
+       */
       export interface InboundInternationalACHTransfer {
         /**
          * The amount in the minor unit of the destination account currency. For dollars,
@@ -906,6 +1151,11 @@ export namespace WireTransferSimulation {
         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`.
+       */
       export interface InboundRealTimePaymentsTransferConfirmation {
         /**
          * The amount in the minor unit of the transfer's currency. For dollars, for
@@ -950,6 +1200,11 @@ export 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`.
+       */
       export interface InboundWireDrawdownPaymentReversal {
         /**
          * The amount that was reversed.
@@ -1002,6 +1257,10 @@ export 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`.
+       */
       export interface InboundWireDrawdownPayment {
         /**
          * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -1034,12 +1293,22 @@ export namespace WireTransferSimulation {
         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`.
+       */
       export 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.
          */
@@ -1095,8 +1364,22 @@ export 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`.
+       */
       export interface InboundWireTransfer {
         /**
          * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -1137,6 +1420,10 @@ export namespace WireTransferSimulation {
         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`.
+       */
       export interface InterestPayment {
         /**
          * The account on which the interest was accrued.
@@ -1166,6 +1453,10 @@ export 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`.
+       */
       export interface InternalSource {
         /**
          * The amount in the minor unit of the transaction's currency. For dollars, for
@@ -1182,15 +1473,21 @@ export 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`.
+       */
       export interface CardRouteRefund {
         /**
          * The refunded amount in the minor unit of the refunded currency. For dollars, for
@@ -1217,6 +1514,10 @@ export namespace WireTransferSimulation {
         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`.
+       */
       export interface CardRouteSettlement {
         /**
          * The settled amount in the minor unit of the settlement currency. For dollars,
@@ -1243,6 +1544,42 @@ export namespace WireTransferSimulation {
         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`.
+       */
+      export 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`.
+       */
       export interface SampleFunds {
         /**
          * Where the sample funds came from.
@@ -1250,6 +1587,11 @@ export namespace WireTransferSimulation {
         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`.
+       */
       export interface WireDrawdownPaymentIntention {
         account_number: string;
 
@@ -1265,10 +1607,19 @@ export namespace WireTransferSimulation {
         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`.
+       */
       export 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`.
+       */
       export interface WireTransferIntention {
         /**
          * The destination account number.
@@ -1293,6 +1644,10 @@ export namespace WireTransferSimulation {
         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`.
+       */
       export interface WireTransferRejection {
         transfer_id: string;
       }