increase 0.2.0 → 0.4.0

package/dist/cjs/resources/simulations/real-time-payments-transfers.d.ts

@@ -1,7 +1,18 @@
 import * as Core from '../../core';
 import { APIResource } from '../../resource';
+import * as RealTimePaymentsTransfers_ from '../../resources/real-time-payments-transfers';
 import * as Shared from '../../resources/shared';
 export declare class RealTimePaymentsTransfers extends APIResource {
+  /**
+   * Simulates submission of a Real Time Payments transfer and handling the response
+   * from the destination financial institution. This transfer must first have a
+   * `status` of `pending_submission`.
+   */
+  complete(
+    realTimePaymentsTransferId: string,
+    body: RealTimePaymentsTransferCompleteParams,
+    options?: Core.RequestOptions,
+  ): Promise<Core.APIResponse<RealTimePaymentsTransfers_.RealTimePaymentsTransfer>>;
   /**
    * Simulates an inbound Real Time Payments transfer to your account. Real Time
    * Payments are a beta feature.
@@ -35,6 +46,11 @@ export interface InboundRealTimePaymentsTransferSimulationResult {
   type: 'inbound_real_time_payments_transfer_simulation_result';
 }
 export declare namespace InboundRealTimePaymentsTransferSimulationResult {
+  /**
+   * If the Real Time Payments Transfer attempt succeeds, this will contain the
+   * resulting [Transaction](#transactions) object. The Transaction's `source` will
+   * be of `category: inbound_real_time_payments_transfer_confirmation`.
+   */
   interface Transaction {
     /**
      * The identifier for the Account the Transaction belongs to.
@@ -74,7 +90,7 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
     /**
      * 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
@@ -89,22 +105,18 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
     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
        * response if and only if `category` is equal to `account_transfer_intention`.
        */
       account_transfer_intention: Source.AccountTransferIntention | null;
-      /**
-       * 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`.
-       */
-      ach_check_conversion: Source.ACHCheckConversion | null;
-      /**
-       * 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`.
-       */
-      ach_check_conversion_return: Source.ACHCheckConversionReturn | null;
       /**
        * 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`.
@@ -131,15 +143,10 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
        */
       card_refund: Source.CardRefund | 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`.
-       */
-      card_route_refund: Source.CardRouteRefund | 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`.
+       * 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_route_settlement: Source.CardRouteSettlement | null;
+      card_revenue_payment: Source.CardRevenuePayment | null;
       /**
        * A Card Settlement object. This field will be present in the JSON response if and
        * only if `category` is equal to `card_settlement`.
@@ -152,22 +159,20 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
        */
       category:
         | 'account_transfer_intention'
-        | 'ach_check_conversion_return'
-        | 'ach_check_conversion'
         | 'ach_transfer_intention'
         | 'ach_transfer_rejection'
         | 'ach_transfer_return'
         | 'card_dispute_acceptance'
         | 'card_refund'
         | 'card_settlement'
+        | 'card_revenue_payment'
         | 'check_deposit_acceptance'
         | 'check_deposit_return'
         | 'check_transfer_intention'
         | 'check_transfer_return'
         | 'check_transfer_rejection'
         | 'check_transfer_stop_payment_request'
-        | 'dispute_resolution'
-        | 'empyreal_cash_deposit'
+        | 'fee_payment'
         | 'inbound_ach_transfer'
         | 'inbound_ach_transfer_return_intention'
         | 'inbound_check'
@@ -178,14 +183,9 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
         | 'inbound_wire_reversal'
         | 'inbound_wire_transfer'
         | 'interest_payment'
-        | 'internal_general_ledger_transaction'
         | 'internal_source'
-        | 'card_route_refund'
-        | 'card_route_settlement'
         | 'real_time_payments_transfer_acknowledgement'
         | 'sample_funds'
-        | 'wire_drawdown_payment_intention'
-        | 'wire_drawdown_payment_rejection'
         | 'wire_transfer_intention'
         | 'wire_transfer_rejection'
         | 'other';
@@ -221,15 +221,10 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
        */
       check_transfer_stop_payment_request: Source.CheckTransferStopPaymentRequest | null;
       /**
-       * A Dispute Resolution object. This field will be present in the JSON response if
-       * and only if `category` is equal to `dispute_resolution`.
-       */
-      dispute_resolution: Source.DisputeResolution | null;
-      /**
-       * 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`.
+       * A Fee Payment object. This field will be present in the JSON response if and
+       * only if `category` is equal to `fee_payment`.
        */
-      empyreal_cash_deposit: Source.EmpyrealCashDeposit | null;
+      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`.
@@ -283,23 +278,17 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
        * 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`.
        */
       sample_funds: Source.SampleFunds | null;
-      /**
-       * 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`.
-       */
-      wire_drawdown_payment_intention: Source.WireDrawdownPaymentIntention | null;
-      /**
-       * 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`.
-       */
-      wire_drawdown_payment_rejection: Source.WireDrawdownPaymentRejection | null;
       /**
        * 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`.
@@ -312,6 +301,10 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
       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,
@@ -340,28 +333,10 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
          */
         transfer_id: string;
       }
-      interface ACHCheckConversionReturn {
-        /**
-         * The amount in the minor unit of the transaction's currency. For dollars, for
-         * example, this is cents.
-         */
-        amount: number;
-        /**
-         * Why the transfer was returned.
-         */
-        return_reason_code: string;
-      }
-      interface ACHCheckConversion {
-        /**
-         * The amount in the minor unit of the transaction's currency. For dollars, for
-         * example, this is cents.
-         */
-        amount: number;
-        /**
-         * The identifier of the File containing an image of the returned check.
-         */
-        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;
         /**
@@ -376,18 +351,30 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
          */
         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
          * the transfer was created.
          */
         created_at: string;
+        /**
+         * The three character ACH return code, in the range R01 to R85.
+         */
+        raw_return_reason_code: string;
         /**
          * Why the ACH Transfer was returned.
          */
@@ -411,10 +398,58 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
           | 'file_record_edit_criteria'
           | 'enr_invalid_individual_name'
           | 'returned_per_odfi_request'
-          | 'addenda_error'
           | 'limited_participation_dfi'
           | 'incorrectly_coded_outbound_international_payment'
-          | 'other';
+          | 'other'
+          | 'account_sold_to_another_dfi'
+          | 'addenda_error'
+          | 'beneficiary_or_account_holder_deceased'
+          | 'customer_advised_not_within_authorization_terms'
+          | 'corrected_return'
+          | 'duplicate_entry'
+          | 'duplicate_return'
+          | 'enr_duplicate_enrollment'
+          | 'enr_invalid_dfi_account_number'
+          | 'enr_invalid_individual_id_number'
+          | 'enr_invalid_representative_payee_indicator'
+          | 'enr_invalid_transaction_code'
+          | 'enr_return_of_enr_entry'
+          | 'enr_routing_number_check_digit_error'
+          | 'entry_not_processed_by_gateway'
+          | 'field_error'
+          | 'foreign_receiving_dfi_unable_to_settle'
+          | 'iat_entry_coding_error'
+          | 'improper_effective_entry_date'
+          | 'improper_source_document_source_document_presented'
+          | 'invalid_company_id'
+          | 'invalid_foreign_receiving_dfi_identification'
+          | 'invalid_individual_id_number'
+          | 'item_and_rck_entry_presented_for_payment'
+          | 'item_related_to_rck_entry_is_ineligible'
+          | 'mandatory_field_error'
+          | 'misrouted_dishonored_return'
+          | 'misrouted_return'
+          | 'no_errors_found'
+          | 'non_acceptance_of_r62_dishonored_return'
+          | 'non_participant_in_iat_program'
+          | 'permissible_return_entry'
+          | 'permissible_return_entry_not_accepted'
+          | 'rdfi_non_settlement'
+          | 'rdfi_participant_in_check_truncation_program'
+          | 'representative_payee_deceased_or_unable_to_continue_in_that_capacity'
+          | 'return_not_a_duplicate'
+          | 'return_of_erroneous_or_reversing_debit'
+          | 'return_of_improper_credit_entry'
+          | 'return_of_improper_debit_entry'
+          | 'return_of_xck_entry'
+          | 'source_document_presented_for_payment'
+          | 'state_law_affecting_rck_acceptance'
+          | 'stop_payment_on_item_related_to_rck_entry'
+          | 'stop_payment_on_source_document'
+          | 'timely_original_return'
+          | 'trace_number_error'
+          | 'untimely_dishonored_return'
+          | 'untimely_return';
         /**
          * The identifier of the Tranasaction associated with this return.
          */
@@ -424,6 +459,10 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
          */
         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
@@ -438,44 +477,106 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
          * 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.
@@ -496,6 +597,38 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
          */
         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.
@@ -530,6 +663,10 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
          */
         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
@@ -556,7 +693,8 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
           | 'stop_payment'
           | 'unknown_reason'
           | 'unmatched_details'
-          | 'unreadable_image';
+          | 'unreadable_image'
+          | 'endorsement_irregular';
         /**
          * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
          * the check deposit was returned.
@@ -568,6 +706,10 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
          */
         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.
@@ -607,22 +749,49 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
          */
         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.
@@ -642,31 +811,26 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
          */
         type: 'check_transfer_stop_payment_request';
       }
-      interface DisputeResolution {
+      /**
+       * 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's currency.
+         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
+         * currency.
          */
         currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
-        /**
-         * The identifier of the Transaction that was disputed.
-         */
-        disputed_transaction_id: string;
-      }
-      interface EmpyrealCashDeposit {
-        /**
-         * The amount in the minor unit of the transaction's currency. For dollars, for
-         * example, this is cents.
-         */
-        amount: number;
-        bag_id: string;
-        deposit_date: string;
       }
+      /**
+       * 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,
@@ -682,6 +846,10 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
         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,
@@ -697,6 +865,11 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
          */
         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,
@@ -739,6 +912,11 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
         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
@@ -775,6 +953,11 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
          */
         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.
@@ -817,6 +1000,10 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
          */
         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
@@ -836,11 +1023,20 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
         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.
          */
@@ -886,7 +1082,19 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
          * 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
@@ -910,6 +1118,10 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
         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.
@@ -934,6 +1146,10 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
          */
         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
@@ -946,71 +1162,60 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
          */
         currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
         reason:
+          | 'account_closure'
           | 'bank_migration'
           | 'cashback'
+          | 'collection_receivable'
           | 'empyreal_adjustment'
           | 'error'
           | 'error_correction'
           | 'fees'
           | 'interest'
+          | 'negative_balance_forgiveness'
           | 'sample_funds'
           | 'sample_funds_return';
       }
-      interface CardRouteRefund {
+      /**
+       * 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 refunded amount in the minor unit of the refunded currency. For dollars, for
-         * example, this is cents.
+         * The transfer amount in USD cents.
          */
         amount: number;
         /**
-         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the refund
-         * currency.
+         * The destination account number.
          */
-        currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
-        merchant_acceptor_id: string;
-        merchant_category_code: string | null;
-        merchant_city: string | null;
-        merchant_country: string;
-        merchant_descriptor: string;
-        merchant_state: string | null;
-      }
-      interface CardRouteSettlement {
+        destination_account_number: string;
         /**
-         * The settled amount in the minor unit of the settlement currency. For dollars,
-         * for example, this is cents.
+         * The American Bankers' Association (ABA) Routing Transit Number (RTN).
          */
-        amount: number;
+        destination_routing_number: string;
         /**
-         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the settlement
-         * currency.
+         * Unstructured information that will show on the recipient's bank statement.
          */
-        currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
-        merchant_acceptor_id: string;
-        merchant_category_code: string | null;
-        merchant_city: string | null;
-        merchant_country: string | null;
-        merchant_descriptor: string;
-        merchant_state: string | null;
+        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;
       }
-      interface WireDrawdownPaymentIntention {
-        account_number: string;
-        /**
-         * The transfer amount in USD cents.
-         */
-        amount: number;
-        message_to_recipient: string;
-        routing_number: string;
-        transfer_id: string;
-      }
-      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.
@@ -1030,11 +1235,21 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
         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;
       }
     }
   }
+  /**
+   * If the Real Time Payments Transfer attempt fails, this will contain the
+   * resulting [Declined Transaction](#declined-transactions) object. The Declined
+   * Transaction's `source` will be of
+   * `category: inbound_real_time_payments_transfer_decline`.
+   */
   interface DeclinedTransaction {
     /**
      * The identifier for the Account the Declined Transaction belongs to.
@@ -1072,7 +1287,7 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
     /**
      * 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
      * Declined Transaction. For example, for a card transaction this lists the
@@ -1088,6 +1303,13 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
     type: 'declined_transaction';
   }
   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.
+     */
     interface Source {
       /**
        * A ACH Decline object. This field will be present in the JSON response if and
@@ -1099,11 +1321,6 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
        * only if `category` is equal to `card_decline`.
        */
       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
@@ -1115,7 +1332,7 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
         | 'check_decline'
         | 'inbound_real_time_payments_transfer_decline'
         | 'international_ach_decline'
-        | 'card_route_decline'
+        | 'wire_decline'
         | 'other';
       /**
        * A Check Decline object. This field will be present in the JSON response if and
@@ -1133,8 +1350,17 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
        * 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;
     }
     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`.
+       */
       interface ACHDecline {
         /**
          * The declined amount in the minor unit of the destination account currency. For
@@ -1155,15 +1381,20 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
           | '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;
         receiver_name: string | null;
         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`.
+       */
       interface CardDecline {
         /**
          * The declined amount in the minor unit of the destination account currency. For
@@ -1229,12 +1460,18 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
           | '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';
       }
       namespace CardDecline {
+        /**
+         * Fields specific to the `network`
+         */
         interface NetworkDetails {
           /**
            * Fields specific to the `visa` network
@@ -1242,6 +1479,9 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
           visa: NetworkDetails.Visa;
         }
         namespace NetworkDetails {
+          /**
+           * Fields specific to the `visa` network
+           */
           interface Visa {
             /**
              * For electronic commerce transactions, this identifies the level of security used
@@ -1262,10 +1502,14 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
              * 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`.
+       */
       interface CheckDecline {
         /**
          * The declined amount in the minor unit of the destination account currency. For
@@ -1284,11 +1528,20 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
           | '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`.
+       */
       interface InboundRealTimePaymentsTransferDecline {
         /**
          * The declined amount in the minor unit of the destination account currency. For
@@ -1323,6 +1576,7 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
         reason:
           | 'account_number_canceled'
           | 'account_number_disabled'
+          | 'account_restricted'
           | 'group_locked'
           | 'entity_not_active'
           | 'real_time_payments_not_enabled';
@@ -1335,6 +1589,10 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
          */
         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`.
+       */
       interface InternationalACHDecline {
         /**
          * The declined amount in the minor unit of the destination account currency. For
@@ -1377,27 +1635,83 @@ export declare namespace InboundRealTimePaymentsTransferSimulationResult {
         receiving_depository_financial_institution_name: string;
         trace_number: string;
       }
-      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`.
+       */
+      interface WireDecline {
         /**
          * The declined amount in the minor unit of the destination account currency. For
          * dollars, for example, this is cents.
          */
         amount: number;
+        beneficiary_address_line1: string | null;
+        beneficiary_address_line2: string | null;
+        beneficiary_address_line3: string | null;
+        beneficiary_name: string | null;
+        beneficiary_reference: string | null;
+        description: string;
+        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;
         /**
-         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
-         * account currency.
+         * Why the wire transfer was declined.
          */
-        currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
-        merchant_acceptor_id: string;
-        merchant_category_code: string | null;
-        merchant_city: string | null;
-        merchant_country: string;
-        merchant_descriptor: string;
-        merchant_state: string | null;
+        reason:
+          | 'account_number_canceled'
+          | 'account_number_disabled'
+          | 'entity_not_active'
+          | 'group_locked'
+          | 'no_account_number'
+          | 'transaction_not_allowed';
       }
     }
   }
 }
+export interface RealTimePaymentsTransferCompleteParams {
+  /**
+   * If set, the simulation will reject the transfer.
+   */
+  rejection?: RealTimePaymentsTransferCompleteParams.Rejection;
+}
+export declare namespace RealTimePaymentsTransferCompleteParams {
+  /**
+   * If set, the simulation will reject the transfer.
+   */
+  interface Rejection {
+    /**
+     * The reason code that the simulated rejection will have.
+     */
+    reject_reason_code:
+      | 'account_closed'
+      | 'account_blocked'
+      | 'invalid_creditor_account_type'
+      | 'invalid_creditor_account_number'
+      | 'invalid_creditor_financial_institution_identifier'
+      | 'end_customer_deceased'
+      | 'narrative'
+      | 'transaction_forbidden'
+      | 'transaction_type_not_supported'
+      | 'unexpected_amount'
+      | 'amount_exceeds_bank_limits'
+      | 'invalid_creditor_address'
+      | 'unknown_end_customer'
+      | 'invalid_debtor_address'
+      | 'timeout'
+      | 'unsupported_message_for_recipient'
+      | 'recipient_connection_not_available'
+      | 'real_time_payments_suspended'
+      | 'instructed_agent_signed_off'
+      | 'processing_error'
+      | 'other';
+  }
+}
 export interface RealTimePaymentsTransferCreateInboundParams {
   /**
    * The identifier of the Account Number the inbound Real Time Payments Transfer is
@@ -1429,3 +1743,4 @@ export interface RealTimePaymentsTransferCreateInboundParams {
    */
   request_for_payment_id?: string;
 }
+//# sourceMappingURL=real-time-payments-transfers.d.ts.map