increase 0.4.0 → 0.5.0

package/resources/simulations/cards.ts

@@ -4,6 +4,7 @@ import * as Core from '~/core';
 import { APIResource } from '~/resource';
 import * as Transactions from '~/resources/transactions';
 import * as Shared from '~/resources/shared';
+import * as API from './';
 
 export class Cards extends APIResource {
   /**
@@ -64,232 +65,200 @@ export interface CardAuthorizationSimulation {
 
 export namespace CardAuthorizationSimulation {
   /**
-   * If the authorization attempt succeeds, this will contain the resulting Pending
-   * Transaction object. The Pending Transaction's `source` will be of
-   * `category: card_authorization`.
+   * If the authorization attempt fails, this will contain the resulting
+   * [Declined Transaction](#declined-transactions) object. The Declined
+   * Transaction's `source` will be of `category: card_decline`.
    */
-  export interface PendingTransaction {
+  export interface DeclinedTransaction {
     /**
-     * The identifier for the account this Pending Transaction belongs to.
+     * The Declined Transaction identifier.
      */
-    account_id: string;
+    id: string;
 
     /**
-     * The Pending Transaction amount in the minor unit of its currency. For dollars,
-     * for example, this is cents.
+     * The identifier for the Account the Declined Transaction belongs to.
      */
-    amount: number;
+    account_id: string;
 
     /**
-     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
-     * Transaction was completed.
+     * The Declined Transaction amount in the minor unit of its currency. For dollars,
+     * for example, this is cents.
      */
-    completed_at: string | null;
+    amount: number;
 
     /**
-     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
      * Transaction occured.
      */
     created_at: string;
 
     /**
-     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending
-     * Transaction's currency. This will match the currency on the Pending
+     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined
+     * Transaction's currency. This will match the currency on the Declined
      * Transcation's Account.
      */
     currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
 
     /**
-     * For a Pending Transaction related to a transfer, this is the description you
-     * provide. For a Pending Transaction related to a payment, this is the description
-     * the vendor provides.
+     * This is the description the vendor provides.
      */
     description: string;
 
     /**
-     * The Pending Transaction identifier.
-     */
-    id: string;
-
-    /**
-     * The identifier for the route this Pending Transaction came through. Routes are
+     * The identifier for the route this Declined Transaction came through. Routes are
      * things like cards and ACH details.
      */
     route_id: string | null;
 
     /**
-     * The type of the route this Pending Transaction came through.
+     * The type of the route this Declined Transaction came through.
      */
     route_type: 'account_number' | 'card' | null;
 
     /**
      * This is an object giving more details on the network-level event that caused the
-     * Pending Transaction. For example, for a card transaction this lists the
-     * merchant's industry and location.
-     */
-    source: PendingTransaction.Source;
-
-    /**
-     * Whether the Pending Transaction has been confirmed and has an associated
-     * Transaction.
+     * 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.
      */
-    status: 'pending' | 'complete';
+    source: DeclinedTransaction.Source;
 
     /**
      * A constant representing the object's type. For this resource it will always be
-     * `pending_transaction`.
+     * `declined_transaction`.
      */
-    type: 'pending_transaction';
+    type: 'declined_transaction';
   }
 
-  export namespace PendingTransaction {
+  export namespace DeclinedTransaction {
     /**
      * This is an object giving more details on the network-level event that caused the
-     * Pending Transaction. For example, for a card transaction this lists the
-     * merchant's industry and location.
+     * Declined Transaction. For example, for a card transaction this lists the
+     * merchant's industry and location. Note that for backwards compatibility reasons,
+     * additional undocumented keys may appear in this object. These should be treated
+     * as deprecated and will be removed in the future.
      */
     export interface Source {
       /**
-       * A Account Transfer Instruction object. This field will be present in the JSON
-       * response if and only if `category` is equal to `account_transfer_instruction`.
-       */
-      account_transfer_instruction: Source.AccountTransferInstruction | null;
-
-      /**
-       * A ACH Transfer Instruction object. This field will be present in the JSON
-       * response if and only if `category` is equal to `ach_transfer_instruction`.
+       * A ACH Decline object. This field will be present in the JSON response if and
+       * only if `category` is equal to `ach_decline`.
        */
-      ach_transfer_instruction: Source.ACHTransferInstruction | null;
+      ach_decline: Source.ACHDecline | null;
 
       /**
-       * A Card Authorization object. This field will be present in the JSON response if
-       * and only if `category` is equal to `card_authorization`.
+       * A Card Decline object. This field will be present in the JSON response if and
+       * only if `category` is equal to `card_decline`.
        */
-      card_authorization: Source.CardAuthorization | null;
+      card_decline: Source.CardDecline | null;
 
       /**
-       * The type of transaction that took place. We may add additional possible values
-       * for this enum over time; your application should be able to handle such
-       * additions gracefully.
+       * 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
+       * gracefully.
        */
       category:
-        | 'account_transfer_instruction'
-        | 'ach_transfer_instruction'
-        | 'card_authorization'
-        | 'check_deposit_instruction'
-        | 'check_transfer_instruction'
-        | 'inbound_funds_hold'
-        | 'real_time_payments_transfer_instruction'
-        | 'wire_transfer_instruction'
+        | 'ach_decline'
+        | 'card_decline'
+        | 'check_decline'
+        | 'inbound_real_time_payments_transfer_decline'
+        | 'international_ach_decline'
+        | 'wire_decline'
         | 'other';
 
       /**
-       * A Check Deposit Instruction object. This field will be present in the JSON
-       * response if and only if `category` is equal to `check_deposit_instruction`.
-       */
-      check_deposit_instruction: Source.CheckDepositInstruction | null;
-
-      /**
-       * A Check Transfer Instruction object. This field will be present in the JSON
-       * response if and only if `category` is equal to `check_transfer_instruction`.
+       * A Check Decline object. This field will be present in the JSON response if and
+       * only if `category` is equal to `check_decline`.
        */
-      check_transfer_instruction: Source.CheckTransferInstruction | null;
+      check_decline: Source.CheckDecline | null;
 
       /**
-       * A Inbound Funds Hold object. This field will be present in the JSON response if
-       * and only if `category` is equal to `inbound_funds_hold`.
+       * 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`.
        */
-      inbound_funds_hold: Source.InboundFundsHold | null;
+      inbound_real_time_payments_transfer_decline: Source.InboundRealTimePaymentsTransferDecline | null;
 
       /**
-       * A Real Time Payments Transfer Instruction object. This field will be present in
-       * the JSON response if and only if `category` is equal to
-       * `real_time_payments_transfer_instruction`.
+       * 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`.
        */
-      real_time_payments_transfer_instruction: Source.RealTimePaymentsTransferInstruction | null;
+      international_ach_decline: Source.InternationalACHDecline | null;
 
       /**
-       * A Wire Transfer Instruction object. This field will be present in the JSON
-       * response if and only if `category` is equal to `wire_transfer_instruction`.
+       * A Wire Decline object. This field will be present in the JSON response if and
+       * only if `category` is equal to `wire_decline`.
        */
-      wire_transfer_instruction: Source.WireTransferInstruction | null;
+      wire_decline: Source.WireDecline | null;
     }
 
     export namespace Source {
       /**
-       * A Account Transfer Instruction object. This field will be present in the JSON
-       * response if and only if `category` is equal to `account_transfer_instruction`.
+       * A ACH Decline object. This field will be present in the JSON response if and
+       * only if `category` is equal to `ach_decline`.
        */
-      export interface AccountTransferInstruction {
+      export interface ACHDecline {
         /**
-         * The pending amount in the minor unit of the transaction's currency. For dollars,
-         * for example, this is cents.
+         * The declined amount in the minor unit of the destination account currency. For
+         * dollars, for example, this is cents.
          */
         amount: number;
 
-        /**
-         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
-         * account currency.
-         */
-        currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+        originator_company_descriptive_date: string | null;
 
-        /**
-         * The identifier of the Account Transfer that led to this Pending Transaction.
-         */
-        transfer_id: string;
-      }
+        originator_company_discretionary_data: string | null;
 
-      /**
-       * A ACH Transfer Instruction object. This field will be present in the JSON
-       * response if and only if `category` is equal to `ach_transfer_instruction`.
-       */
-      export interface ACHTransferInstruction {
-        /**
-         * The pending amount in the minor unit of the transaction's currency. For dollars,
-         * for example, this is cents.
-         */
-        amount: number;
+        originator_company_id: string;
+
+        originator_company_name: string;
 
         /**
-         * The identifier of the ACH Transfer that led to this Pending Transaction.
+         * Why the ACH transfer was declined.
          */
-        transfer_id: string;
+        reason:
+          | 'ach_route_canceled'
+          | 'ach_route_disabled'
+          | 'breaches_limit'
+          | 'credit_entry_refused_by_receiver'
+          | 'duplicate_return'
+          | 'entity_not_active'
+          | 'group_locked'
+          | 'insufficient_funds'
+          | 'misrouted_return'
+          | 'no_ach_route'
+          | 'originator_request'
+          | 'transaction_not_allowed';
+
+        receiver_id_number: string | null;
+
+        receiver_name: string | null;
+
+        trace_number: string;
       }
 
       /**
-       * A Card Authorization object. This field will be present in the JSON response if
-       * and only if `category` is equal to `card_authorization`.
+       * A Card Decline object. This field will be present in the JSON response if and
+       * only if `category` is equal to `card_decline`.
        */
-      export interface CardAuthorization {
+      export interface CardDecline {
         /**
-         * The pending amount in the minor unit of the transaction's currency. For dollars,
-         * for example, this is cents.
+         * The declined amount in the minor unit of the destination account currency. For
+         * dollars, for example, this is cents.
          */
         amount: number;
 
         /**
-         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
-         * transaction's currency.
+         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
+         * account currency.
          */
         currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
 
         /**
-         * If the authorization was made via a Digital Wallet Token (such as an Apple Pay
-         * purchase), the identifier of the token that was used.
+         * If the authorization was attempted using a Digital Wallet Token (such as an
+         * Apple Pay purchase), the identifier of the token that was used.
          */
         digital_wallet_token_id: string | null;
 
-        /**
-         * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization
-         * will expire and the pending transaction will be released.
-         */
-        expires_at: string;
-
-        /**
-         * The Card Authorization identifier.
-         */
-        id: string;
-
         /**
          * The merchant identifier (commonly abbreviated as MID) of the merchant the card
          * is transacting with.
@@ -318,19 +287,19 @@ export namespace CardAuthorizationSimulation {
         merchant_descriptor: string;
 
         /**
-         * The payment network used to process this card authorization
+         * The state the merchant resides in.
          */
-        network: 'visa';
+        merchant_state: string | null;
 
         /**
-         * Fields specific to the `network`
+         * The payment network used to process this card authorization
          */
-        network_details: CardAuthorization.NetworkDetails;
+        network: 'visa';
 
         /**
-         * The identifier of the Pending Transaction associated with this Transaction.
+         * Fields specific to the `network`
          */
-        pending_transaction_id: string | null;
+        network_details: CardDecline.NetworkDetails;
 
         /**
          * The identifier of the Real-Time Decision sent to approve or decline this
@@ -339,13 +308,25 @@ export namespace CardAuthorizationSimulation {
         real_time_decision_id: string | null;
 
         /**
-         * A constant representing the object's type. For this resource it will always be
-         * `card_authorization`.
+         * Why the transaction was declined.
          */
-        type: 'card_authorization';
+        reason:
+          | 'card_not_active'
+          | 'entity_not_active'
+          | 'group_locked'
+          | 'insufficient_funds'
+          | 'cvv2_mismatch'
+          | 'transaction_not_allowed'
+          | 'breaches_internal_limit'
+          | 'breaches_limit'
+          | 'webhook_declined'
+          | 'webhook_timed_out'
+          | 'declined_by_stand_in_processing'
+          | 'invalid_physical_card'
+          | 'missing_original_authorization';
       }
 
-      export namespace CardAuthorization {
+      export namespace CardDecline {
         /**
          * Fields specific to the `network`
          */
@@ -387,349 +368,464 @@ export namespace CardAuthorizationSimulation {
       }
 
       /**
-       * A Check Deposit Instruction object. This field will be present in the JSON
-       * response if and only if `category` is equal to `check_deposit_instruction`.
+       * A Check Decline object. This field will be present in the JSON response if and
+       * only if `category` is equal to `check_decline`.
        */
-      export interface CheckDepositInstruction {
+      export interface CheckDecline {
         /**
-         * The pending amount in the minor unit of the transaction's currency. For dollars,
-         * for example, this is cents.
+         * The declined amount in the minor unit of the destination account currency. For
+         * dollars, for example, this is cents.
          */
         amount: number;
 
-        /**
-         * The identifier of the File containing the image of the back of the check that
-         * was deposited.
-         */
-        back_image_file_id: string | null;
-
-        /**
-         * The identifier of the Check Deposit.
-         */
-        check_deposit_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';
+        auxiliary_on_us: string | null;
 
         /**
-         * The identifier of the File containing the image of the front of the check that
-         * was deposited.
+         * Why the check was declined.
          */
-        front_image_file_id: string;
+        reason:
+          | 'ach_route_canceled'
+          | 'ach_route_disabled'
+          | 'breaches_limit'
+          | 'entity_not_active'
+          | 'group_locked'
+          | 'insufficient_funds'
+          | 'unable_to_locate_account'
+          | 'not_our_item'
+          | 'unable_to_process'
+          | 'refer_to_image'
+          | 'stop_payment_requested'
+          | 'returned'
+          | 'duplicate_presentment'
+          | 'not_authorized'
+          | 'altered_or_fictitious';
       }
 
       /**
-       * A Check Transfer Instruction object. This field will be present in the JSON
-       * response if and only if `category` is equal to `check_transfer_instruction`.
+       * A Inbound Real Time Payments Transfer Decline object. This field will be present
+       * in the JSON response if and only if `category` is equal to
+       * `inbound_real_time_payments_transfer_decline`.
        */
-      export interface CheckTransferInstruction {
+      export interface InboundRealTimePaymentsTransferDecline {
         /**
-         * The pending amount in the minor unit of the transaction's currency. For dollars,
-         * for example, this is cents.
+         * The declined amount in the minor unit of the destination account currency. For
+         * dollars, for example, this is cents.
          */
         amount: number;
 
         /**
-         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
-         * currency.
-         */
-        currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
-
-        /**
-         * The identifier of the Check Transfer that led to this Pending Transaction.
-         */
-        transfer_id: string;
-      }
-
-      /**
-       * A Inbound Funds Hold object. This field will be present in the JSON response if
-       * and only if `category` is equal to `inbound_funds_hold`.
-       */
-      export interface InboundFundsHold {
-        /**
-         * The held amount in the minor unit of the account's currency. For dollars, for
-         * example, this is cents.
+         * The name the sender of the transfer specified as the recipient of the transfer.
          */
-        amount: number;
+        creditor_name: string;
 
         /**
-         * When the hold will be released automatically. Certain conditions may cause it to
-         * be released before this time.
+         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined
+         * transfer's currency. This will always be "USD" for a Real Time Payments
+         * transfer.
          */
-        automatically_releases_at: string;
+        currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
 
         /**
-         * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold
-         * was created.
+         * The account number of the account that sent the transfer.
          */
-        created_at: string;
+        debtor_account_number: string;
 
         /**
-         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's
-         * currency.
+         * The name provided by the sender of the transfer.
          */
-        currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+        debtor_name: string;
 
         /**
-         * The ID of the Transaction for which funds were held.
+         * The routing number of the account that sent the transfer.
          */
-        held_transaction_id: string | null;
+        debtor_routing_number: string;
 
         /**
-         * The ID of the Pending Transaction representing the held funds.
+         * Why the transfer was declined.
          */
-        pending_transaction_id: string | null;
+        reason:
+          | 'account_number_canceled'
+          | 'account_number_disabled'
+          | 'account_restricted'
+          | 'group_locked'
+          | 'entity_not_active'
+          | 'real_time_payments_not_enabled';
 
         /**
-         * When the hold was released (if it has been released).
+         * Additional information included with the transfer.
          */
-        released_at: string | null;
+        remittance_information: string | null;
 
         /**
-         * The status of the hold.
+         * The Real Time Payments network identification of the declined transfer.
          */
-        status: 'held' | 'complete';
+        transaction_identification: string;
       }
 
       /**
-       * A Real Time Payments Transfer Instruction object. This field will be present in
-       * the JSON response if and only if `category` is equal to
-       * `real_time_payments_transfer_instruction`.
+       * A International ACH Decline object. This field will be present in the JSON
+       * response if and only if `category` is equal to `international_ach_decline`.
        */
-      export interface RealTimePaymentsTransferInstruction {
+      export interface InternationalACHDecline {
         /**
-         * The pending amount in the minor unit of the transaction's currency. For dollars,
-         * for example, this is cents.
+         * The declined amount in the minor unit of the destination account currency. For
+         * dollars, for example, this is cents.
          */
         amount: number;
 
-        /**
-         * The identifier of the Real Time Payments Transfer that led to this Pending
-         * Transaction.
-         */
-        transfer_id: string;
+        destination_country_code: string;
+
+        destination_currency_code: string;
+
+        foreign_exchange_indicator: string;
+
+        foreign_exchange_reference: string | null;
+
+        foreign_exchange_reference_indicator: string;
+
+        foreign_payment_amount: number;
+
+        foreign_trace_number: string | null;
+
+        international_transaction_type_code: string;
+
+        originating_currency_code: string;
+
+        originating_depository_financial_institution_branch_country: string;
+
+        originating_depository_financial_institution_id: string;
+
+        originating_depository_financial_institution_id_qualifier: string;
+
+        originating_depository_financial_institution_name: string;
+
+        originator_city: string;
+
+        originator_company_entry_description: string;
+
+        originator_country: string;
+
+        originator_identification: string;
+
+        originator_name: string;
+
+        originator_postal_code: string | null;
+
+        originator_state_or_province: string | null;
+
+        originator_street_address: string;
+
+        payment_related_information: string | null;
+
+        payment_related_information2: string | null;
+
+        receiver_city: string;
+
+        receiver_country: string;
+
+        receiver_identification_number: string | null;
+
+        receiver_postal_code: string | null;
+
+        receiver_state_or_province: string | null;
+
+        receiver_street_address: string;
+
+        receiving_company_or_individual_name: string;
+
+        receiving_depository_financial_institution_country: string;
+
+        receiving_depository_financial_institution_id: string;
+
+        receiving_depository_financial_institution_id_qualifier: string;
+
+        receiving_depository_financial_institution_name: string;
+
+        trace_number: string;
       }
 
       /**
-       * A Wire Transfer Instruction object. This field will be present in the JSON
-       * response if and only if `category` is equal to `wire_transfer_instruction`.
+       * A Wire Decline object. This field will be present in the JSON response if and
+       * only if `category` is equal to `wire_decline`.
        */
-      export interface WireTransferInstruction {
-        account_number: string;
-
+      export interface WireDecline {
         /**
-         * The pending amount in the minor unit of the transaction's currency. For dollars,
-         * for example, this is cents.
+         * The declined amount in the minor unit of the destination account currency. For
+         * dollars, for example, this is cents.
          */
         amount: number;
 
-        message_to_recipient: string;
+        beneficiary_address_line1: string | null;
 
-        routing_number: string;
+        beneficiary_address_line2: string | null;
 
-        transfer_id: string;
+        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;
+
+        /**
+         * Why the wire transfer was declined.
+         */
+        reason:
+          | 'account_number_canceled'
+          | 'account_number_disabled'
+          | 'entity_not_active'
+          | 'group_locked'
+          | 'no_account_number'
+          | 'transaction_not_allowed';
       }
     }
   }
 
   /**
-   * If the authorization attempt fails, this will contain the resulting
-   * [Declined Transaction](#declined-transactions) object. The Declined
-   * Transaction's `source` will be of `category: card_decline`.
+   * If the authorization attempt succeeds, this will contain the resulting Pending
+   * Transaction object. The Pending Transaction's `source` will be of
+   * `category: card_authorization`.
    */
-  export interface DeclinedTransaction {
+  export interface PendingTransaction {
     /**
-     * The identifier for the Account the Declined Transaction belongs to.
+     * The Pending Transaction identifier.
+     */
+    id: string;
+
+    /**
+     * The identifier for the account this Pending Transaction belongs to.
      */
     account_id: string;
 
     /**
-     * The Declined Transaction amount in the minor unit of its currency. For dollars,
+     * The Pending Transaction amount in the minor unit of its currency. For dollars,
      * for example, this is cents.
      */
     amount: number;
 
     /**
-     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
+     * Transaction was completed.
+     */
+    completed_at: string | null;
+
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
      * Transaction occured.
      */
     created_at: string;
 
     /**
-     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined
-     * Transaction's currency. This will match the currency on the Declined
+     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending
+     * Transaction's currency. This will match the currency on the Pending
      * Transcation's Account.
      */
     currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
 
     /**
-     * This is the description the vendor provides.
+     * For a Pending Transaction related to a transfer, this is the description you
+     * provide. For a Pending Transaction related to a payment, this is the description
+     * the vendor provides.
      */
     description: string;
 
     /**
-     * The Declined Transaction identifier.
-     */
-    id: string;
-
-    /**
-     * The identifier for the route this Declined Transaction came through. Routes are
+     * The identifier for the route this Pending Transaction came through. Routes are
      * things like cards and ACH details.
      */
     route_id: string | null;
 
     /**
-     * The type of the route this Declined Transaction came through.
+     * The type of the route this Pending Transaction came through.
      */
     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
-     * 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.
+     * Pending Transaction. For example, for a card transaction this lists the
+     * merchant's industry and location.
      */
-    source: DeclinedTransaction.Source;
+    source: PendingTransaction.Source;
+
+    /**
+     * Whether the Pending Transaction has been confirmed and has an associated
+     * Transaction.
+     */
+    status: 'pending' | 'complete';
 
     /**
      * A constant representing the object's type. For this resource it will always be
-     * `declined_transaction`.
+     * `pending_transaction`.
      */
-    type: 'declined_transaction';
+    type: 'pending_transaction';
   }
 
-  export namespace DeclinedTransaction {
+  export namespace PendingTransaction {
     /**
      * 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.
+     * Pending Transaction. For example, for a card transaction this lists the
+     * merchant's industry and location.
      */
     export interface Source {
       /**
-       * A ACH Decline object. This field will be present in the JSON response if and
-       * only if `category` is equal to `ach_decline`.
+       * A Account Transfer Instruction object. This field will be present in the JSON
+       * response if and only if `category` is equal to `account_transfer_instruction`.
        */
-      ach_decline: Source.ACHDecline | null;
+      account_transfer_instruction: Source.AccountTransferInstruction | null;
 
       /**
-       * A Card Decline object. This field will be present in the JSON response if and
-       * only if `category` is equal to `card_decline`.
+       * A ACH Transfer Instruction object. This field will be present in the JSON
+       * response if and only if `category` is equal to `ach_transfer_instruction`.
        */
-      card_decline: Source.CardDecline | null;
+      ach_transfer_instruction: Source.ACHTransferInstruction | 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
-       * gracefully.
+       * A Card Authorization object. This field will be present in the JSON response if
+       * and only if `category` is equal to `card_authorization`.
+       */
+      card_authorization: Source.CardAuthorization | null;
+
+      /**
+       * The type of transaction that took place. We may add additional possible values
+       * for this enum over time; your application should be able to handle such
+       * additions gracefully.
        */
       category:
-        | 'ach_decline'
-        | 'card_decline'
-        | 'check_decline'
-        | 'inbound_real_time_payments_transfer_decline'
-        | 'international_ach_decline'
-        | 'wire_decline'
+        | 'account_transfer_instruction'
+        | 'ach_transfer_instruction'
+        | 'card_authorization'
+        | 'check_deposit_instruction'
+        | 'check_transfer_instruction'
+        | 'inbound_funds_hold'
+        | 'real_time_payments_transfer_instruction'
+        | 'wire_transfer_instruction'
         | 'other';
 
       /**
-       * A Check Decline object. This field will be present in the JSON response if and
-       * only if `category` is equal to `check_decline`.
+       * A Check Deposit Instruction object. This field will be present in the JSON
+       * response if and only if `category` is equal to `check_deposit_instruction`.
        */
-      check_decline: Source.CheckDecline | null;
+      check_deposit_instruction: Source.CheckDepositInstruction | null;
 
       /**
-       * 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`.
+       * A Check Transfer Instruction object. This field will be present in the JSON
+       * response if and only if `category` is equal to `check_transfer_instruction`.
        */
-      inbound_real_time_payments_transfer_decline: Source.InboundRealTimePaymentsTransferDecline | null;
+      check_transfer_instruction: Source.CheckTransferInstruction | null;
 
       /**
-       * 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`.
+       * A Inbound Funds Hold object. This field will be present in the JSON response if
+       * and only if `category` is equal to `inbound_funds_hold`.
        */
-      international_ach_decline: Source.InternationalACHDecline | null;
+      inbound_funds_hold: Source.InboundFundsHold | null;
 
       /**
-       * A Wire Decline object. This field will be present in the JSON response if and
-       * only if `category` is equal to `wire_decline`.
+       * A Real Time Payments Transfer Instruction object. This field will be present in
+       * the JSON response if and only if `category` is equal to
+       * `real_time_payments_transfer_instruction`.
        */
-      wire_decline: Source.WireDecline | null;
+      real_time_payments_transfer_instruction: Source.RealTimePaymentsTransferInstruction | null;
+
+      /**
+       * A Wire Transfer Instruction object. This field will be present in the JSON
+       * response if and only if `category` is equal to `wire_transfer_instruction`.
+       */
+      wire_transfer_instruction: Source.WireTransferInstruction | null;
     }
 
     export namespace Source {
       /**
-       * A ACH Decline object. This field will be present in the JSON response if and
-       * only if `category` is equal to `ach_decline`.
+       * A Account Transfer Instruction object. This field will be present in the JSON
+       * response if and only if `category` is equal to `account_transfer_instruction`.
        */
-      export interface ACHDecline {
+      export interface AccountTransferInstruction {
         /**
-         * The declined amount in the minor unit of the destination account currency. For
-         * dollars, for example, this is cents.
+         * The pending amount in the minor unit of the transaction's currency. For dollars,
+         * for example, this is cents.
          */
         amount: number;
 
-        originator_company_descriptive_date: string | null;
-
-        originator_company_discretionary_data: string | null;
-
-        originator_company_id: string;
-
-        originator_company_name: string;
-
         /**
-         * Why the ACH transfer was declined.
+         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
+         * account currency.
          */
-        reason:
-          | 'ach_route_canceled'
-          | 'ach_route_disabled'
-          | 'breaches_limit'
-          | 'credit_entry_refused_by_receiver'
-          | 'duplicate_return'
-          | 'entity_not_active'
-          | 'group_locked'
-          | 'insufficient_funds'
-          | 'misrouted_return'
-          | 'no_ach_route'
-          | 'originator_request'
-          | 'transaction_not_allowed';
+        currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
 
-        receiver_id_number: string | null;
+        /**
+         * The identifier of the Account Transfer that led to this Pending Transaction.
+         */
+        transfer_id: string;
+      }
 
-        receiver_name: string | null;
+      /**
+       * A ACH Transfer Instruction object. This field will be present in the JSON
+       * response if and only if `category` is equal to `ach_transfer_instruction`.
+       */
+      export interface ACHTransferInstruction {
+        /**
+         * The pending amount in the minor unit of the transaction's currency. For dollars,
+         * for example, this is cents.
+         */
+        amount: number;
 
-        trace_number: string;
+        /**
+         * The identifier of the ACH Transfer that led to this Pending Transaction.
+         */
+        transfer_id: string;
       }
 
       /**
-       * A Card Decline object. This field will be present in the JSON response if and
-       * only if `category` is equal to `card_decline`.
+       * A Card Authorization object. This field will be present in the JSON response if
+       * and only if `category` is equal to `card_authorization`.
        */
-      export interface CardDecline {
+      export interface CardAuthorization {
         /**
-         * The declined amount in the minor unit of the destination account currency. For
-         * dollars, for example, this is cents.
+         * The Card Authorization identifier.
+         */
+        id: string;
+
+        /**
+         * The pending 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 destination
-         * account currency.
+         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
+         * transaction's currency.
          */
         currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
 
         /**
-         * If the authorization was attempted using a Digital Wallet Token (such as an
-         * Apple Pay purchase), the identifier of the token that was used.
+         * If the authorization was made via a Digital Wallet Token (such as an Apple Pay
+         * purchase), the identifier of the token that was used.
          */
         digital_wallet_token_id: string | null;
 
+        /**
+         * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization
+         * will expire and the pending transaction will be released.
+         */
+        expires_at: string;
+
         /**
          * The merchant identifier (commonly abbreviated as MID) of the merchant the card
          * is transacting with.
@@ -757,11 +853,6 @@ export namespace CardAuthorizationSimulation {
          */
         merchant_descriptor: string;
 
-        /**
-         * The state the merchant resides in.
-         */
-        merchant_state: string | null;
-
         /**
          * The payment network used to process this card authorization
          */
@@ -770,7 +861,12 @@ export namespace CardAuthorizationSimulation {
         /**
          * Fields specific to the `network`
          */
-        network_details: CardDecline.NetworkDetails;
+        network_details: CardAuthorization.NetworkDetails;
+
+        /**
+         * The identifier of the Pending Transaction associated with this Transaction.
+         */
+        pending_transaction_id: string | null;
 
         /**
          * The identifier of the Real-Time Decision sent to approve or decline this
@@ -779,25 +875,13 @@ export namespace CardAuthorizationSimulation {
         real_time_decision_id: string | null;
 
         /**
-         * Why the transaction was declined.
+         * A constant representing the object's type. For this resource it will always be
+         * `card_authorization`.
          */
-        reason:
-          | 'card_not_active'
-          | 'entity_not_active'
-          | 'group_locked'
-          | 'insufficient_funds'
-          | 'cvv2_mismatch'
-          | 'transaction_not_allowed'
-          | 'breaches_internal_limit'
-          | 'breaches_limit'
-          | 'webhook_declined'
-          | 'webhook_timed_out'
-          | 'declined_by_stand_in_processing'
-          | 'invalid_physical_card'
-          | 'missing_original_authorization';
+        type: 'card_authorization';
       }
 
-      export namespace CardDecline {
+      export namespace CardAuthorization {
         /**
          * Fields specific to the `network`
          */
@@ -829,243 +913,160 @@ export namespace CardAuthorizationSimulation {
               | 'non_secure_transaction'
               | null;
 
-            /**
-             * The method used to enter the cardholder's primary account number and card
-             * expiration date
-             */
-            point_of_service_entry_mode: Shared.PointOfServiceEntryMode | null;
-          }
-        }
+            /**
+             * The method used to enter the cardholder's primary account number and card
+             * expiration date
+             */
+            point_of_service_entry_mode: Shared.PointOfServiceEntryMode | null;
+          }
+        }
+      }
+
+      /**
+       * A Check Deposit Instruction object. This field will be present in the JSON
+       * response if and only if `category` is equal to `check_deposit_instruction`.
+       */
+      export interface CheckDepositInstruction {
+        /**
+         * The pending amount in the minor unit of the transaction's currency. For dollars,
+         * for example, this is cents.
+         */
+        amount: number;
+
+        /**
+         * The identifier of the File containing the image of the back of the check that
+         * was deposited.
+         */
+        back_image_file_id: string | null;
+
+        /**
+         * The identifier of the Check Deposit.
+         */
+        check_deposit_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 identifier of the File containing the image of the front of the check that
+         * was deposited.
+         */
+        front_image_file_id: string;
       }
 
       /**
-       * A Check Decline object. This field will be present in the JSON response if and
-       * only if `category` is equal to `check_decline`.
+       * A Check Transfer Instruction object. This field will be present in the JSON
+       * response if and only if `category` is equal to `check_transfer_instruction`.
        */
-      export interface CheckDecline {
+      export interface CheckTransferInstruction {
         /**
-         * The declined amount in the minor unit of the destination account currency. For
-         * dollars, for example, this is cents.
+         * The pending amount in the minor unit of the transaction's currency. For dollars,
+         * for example, this is cents.
          */
         amount: number;
 
-        auxiliary_on_us: string | null;
+        /**
+         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
+         * currency.
+         */
+        currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
 
         /**
-         * Why the check was declined.
+         * The identifier of the Check Transfer that led to this Pending Transaction.
          */
-        reason:
-          | 'ach_route_canceled'
-          | 'ach_route_disabled'
-          | 'breaches_limit'
-          | 'entity_not_active'
-          | 'group_locked'
-          | 'insufficient_funds'
-          | 'unable_to_locate_account'
-          | 'not_our_item'
-          | 'unable_to_process'
-          | 'refer_to_image'
-          | 'stop_payment_requested'
-          | 'returned'
-          | 'duplicate_presentment'
-          | 'not_authorized'
-          | 'altered_or_fictitious';
+        transfer_id: string;
       }
 
       /**
-       * 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`.
+       * A Inbound Funds Hold object. This field will be present in the JSON response if
+       * and only if `category` is equal to `inbound_funds_hold`.
        */
-      export interface InboundRealTimePaymentsTransferDecline {
+      export interface InboundFundsHold {
         /**
-         * The declined amount in the minor unit of the destination account currency. For
-         * dollars, for example, this is cents.
+         * The held amount in the minor unit of the account's currency. For dollars, for
+         * example, this is cents.
          */
         amount: number;
 
         /**
-         * The name the sender of the transfer specified as the recipient of the transfer.
-         */
-        creditor_name: string;
-
-        /**
-         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined
-         * transfer's currency. This will always be "USD" for a Real Time Payments
-         * transfer.
+         * When the hold will be released automatically. Certain conditions may cause it to
+         * be released before this time.
          */
-        currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+        automatically_releases_at: string;
 
         /**
-         * The account number of the account that sent the transfer.
+         * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold
+         * was created.
          */
-        debtor_account_number: string;
+        created_at: string;
 
         /**
-         * The name provided by the sender of the transfer.
+         * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's
+         * currency.
          */
-        debtor_name: string;
+        currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
 
         /**
-         * The routing number of the account that sent the transfer.
+         * The ID of the Transaction for which funds were held.
          */
-        debtor_routing_number: string;
+        held_transaction_id: string | null;
 
         /**
-         * Why the transfer was declined.
+         * The ID of the Pending Transaction representing the held funds.
          */
-        reason:
-          | 'account_number_canceled'
-          | 'account_number_disabled'
-          | 'account_restricted'
-          | 'group_locked'
-          | 'entity_not_active'
-          | 'real_time_payments_not_enabled';
+        pending_transaction_id: string | null;
 
         /**
-         * Additional information included with the transfer.
+         * When the hold was released (if it has been released).
          */
-        remittance_information: string | null;
+        released_at: string | null;
 
         /**
-         * The Real Time Payments network identification of the declined transfer.
+         * The status of the hold.
          */
-        transaction_identification: string;
+        status: 'held' | 'complete';
       }
 
       /**
-       * 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`.
+       * A Real Time Payments Transfer Instruction object. This field will be present in
+       * the JSON response if and only if `category` is equal to
+       * `real_time_payments_transfer_instruction`.
        */
-      export interface InternationalACHDecline {
+      export interface RealTimePaymentsTransferInstruction {
         /**
-         * The declined amount in the minor unit of the destination account currency. For
-         * dollars, for example, this is cents.
+         * The pending amount in the minor unit of the transaction's currency. For dollars,
+         * for example, this is cents.
          */
         amount: number;
 
-        destination_country_code: string;
-
-        destination_currency_code: string;
-
-        foreign_exchange_indicator: string;
-
-        foreign_exchange_reference: string | null;
-
-        foreign_exchange_reference_indicator: string;
-
-        foreign_payment_amount: number;
-
-        foreign_trace_number: string | null;
-
-        international_transaction_type_code: string;
-
-        originating_currency_code: string;
-
-        originating_depository_financial_institution_branch_country: string;
-
-        originating_depository_financial_institution_id: string;
-
-        originating_depository_financial_institution_id_qualifier: string;
-
-        originating_depository_financial_institution_name: string;
-
-        originator_city: string;
-
-        originator_company_entry_description: string;
-
-        originator_country: string;
-
-        originator_identification: string;
-
-        originator_name: string;
-
-        originator_postal_code: string | null;
-
-        originator_state_or_province: string | null;
-
-        originator_street_address: string;
-
-        payment_related_information: string | null;
-
-        payment_related_information2: string | null;
-
-        receiver_city: string;
-
-        receiver_country: string;
-
-        receiver_identification_number: string | null;
-
-        receiver_postal_code: string | null;
-
-        receiver_state_or_province: string | null;
-
-        receiver_street_address: string;
-
-        receiving_company_or_individual_name: string;
-
-        receiving_depository_financial_institution_country: string;
-
-        receiving_depository_financial_institution_id: string;
-
-        receiving_depository_financial_institution_id_qualifier: string;
-
-        receiving_depository_financial_institution_name: string;
-
-        trace_number: string;
+        /**
+         * The identifier of the Real Time Payments Transfer that led to this Pending
+         * Transaction.
+         */
+        transfer_id: string;
       }
 
       /**
-       * A Wire Decline object. This field will be present in the JSON response if and
-       * only if `category` is equal to `wire_decline`.
+       * A Wire Transfer Instruction object. This field will be present in the JSON
+       * response if and only if `category` is equal to `wire_transfer_instruction`.
        */
-      export interface WireDecline {
+      export interface WireTransferInstruction {
+        account_number: string;
+
         /**
-         * The declined amount in the minor unit of the destination account currency. For
-         * dollars, for example, this is cents.
+         * The pending amount in the minor unit of the transaction's 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;
+        message_to_recipient: string;
 
-        originator_to_beneficiary_information_line4: string | null;
+        routing_number: string;
 
-        /**
-         * Why the wire transfer was declined.
-         */
-        reason:
-          | 'account_number_canceled'
-          | 'account_number_disabled'
-          | 'entity_not_active'
-          | 'group_locked'
-          | 'no_account_number'
-          | 'transaction_not_allowed';
+        transfer_id: string;
       }
     }
   }
@@ -1114,3 +1115,9 @@ export interface CardSettlementParams {
    */
   amount?: number;
 }
+
+export namespace Cards {
+  export import CardAuthorizationSimulation = API.CardAuthorizationSimulation;
+  export import CardAuthorizeParams = API.CardAuthorizeParams;
+  export import CardSettlementParams = API.CardSettlementParams;
+}