increase 0.10.2 → 0.10.4

package/resources/transactions.d.ts

@@ -381,13 +381,23 @@ export declare namespace Transaction {
      * response if and only if `category` is equal to `ach_transfer_intention`.
      */
     interface ACHTransferIntention {
+      /**
+       * The account number for the destination account.
+       */
       account_number: string;
       /**
        * The amount in the minor unit of the transaction's currency. For dollars, for
        * example, this is cents.
        */
       amount: number;
+      /**
+       * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
+       * destination account.
+       */
       routing_number: string;
+      /**
+       * A description set when the ACH Transfer was created.
+       */
       statement_descriptor: string;
       /**
        * The identifier of the ACH Transfer that led to this Transaction.
@@ -454,7 +464,7 @@ export declare namespace Transaction {
        * - `enr_invalid_individual_name` - Code R45. The individual name field was
        *   invalid.
        * - `returned_per_odfi_request` - Code R06. The originating financial institution
-       *   reversed the transfer.
+       *   asked for this transfer to be returned.
        * - `limited_participation_dfi` - Code R34. The receiving bank's regulatory
        *   supervisor has limited their participation.
        * - `incorrectly_coded_outbound_international_payment` - Code R85. The outbound
@@ -541,7 +551,7 @@ export declare namespace Transaction {
        *   bank disputes that an earlier `duplicate_entry` return was actually a
        *   duplicate.
        * - `return_of_erroneous_or_reversing_debit` - Code R62. A rare return reason. The
-       *   originating bank made a mistake earlier and this return corrects it.
+       *   originating financial institution made a mistake and this return corrects it.
        * - `return_of_improper_credit_entry` - Code R36. A rare return reason. Return of
        *   a malformed credit entry.
        * - `return_of_improper_debit_entry` - Code R35. A rare return reason. Return of a
@@ -1847,6 +1857,9 @@ export declare namespace Transaction {
        */
       currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
       /**
+       * Why this check was returned by the bank holding the account it was drawn
+       * against.
+       *
        * - `ach_conversion_not_supported` - The check doesn't allow ACH conversion.
        * - `closed_account` - The account is closed.
        * - `duplicate_submission` - The check has already been deposited.
@@ -1894,6 +1907,12 @@ export declare namespace Transaction {
        * deposited check.
        */
       back_image_file_id: string | null;
+      /**
+       * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
+       * bank depositing this check. In some rare cases, this is not transmitted via
+       * Check21 and the value will be null.
+       */
+      bank_of_first_deposit_routing_number: string | null;
       /**
        * When the check was deposited.
        */
@@ -2029,14 +2048,48 @@ export declare namespace Transaction {
        * for example, this is cents.
        */
       amount: number;
+      /**
+       * The description of the date of the transfer, usually in the format `YYMMDD`.
+       */
       originator_company_descriptive_date: string | null;
+      /**
+       * Data set by the originator.
+       */
       originator_company_discretionary_data: string | null;
+      /**
+       * An informational description of the transfer.
+       */
       originator_company_entry_description: string;
+      /**
+       * An identifier for the originating company. This is generally, but not always, a
+       * stable identifier across multiple transfers.
+       */
       originator_company_id: string;
+      /**
+       * A name set by the originator to identify themselves.
+       */
       originator_company_name: string;
+      /**
+       * The originator's identifier for the transfer receipient.
+       */
       receiver_id_number: string | null;
+      /**
+       * The name of the transfer recipient. This value is informational and not verified
+       * by Increase.
+       */
       receiver_name: string | null;
+      /**
+       * A 15 digit number recorded in the Nacha file and available to both the
+       * originating and receiving bank. Along with the amount, date, and originating
+       * routing number, this can be used to identify the ACH transfer at either bank.
+       * ACH trace numbers are not unique, but are
+       * [used to correlate returns](https://increase.com/documentation/ach#returns).
+       */
       trace_number: string;
+      /**
+       * The inbound ach transfer's identifier.
+       */
+      transfer_id: string;
     }
     /**
      * An Inbound Check object. This field will be present in the JSON response if and
@@ -2048,8 +2101,24 @@ export declare namespace Transaction {
        * for example, this is cents.
        */
       amount: number;
+      /**
+       * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
+       * bank depositing this check. In some rare cases, this is not transmitted via
+       * Check21 and the value will be null.
+       */
+      bank_of_first_deposit_routing_number: string | null;
+      /**
+       * The front image of the check. This is a black and white TIFF image file.
+       */
       check_front_image_file_id: string | null;
+      /**
+       * The number of the check. This field is set by the depositing bank and can be
+       * unreliable.
+       */
       check_number: string | null;
+      /**
+       * The rear image of the check. This is a black and white TIFF image file.
+       */
       check_rear_image_file_id: string | null;
       /**
        * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
@@ -2075,40 +2144,245 @@ export declare namespace Transaction {
        * for example, this is cents.
        */
       amount: number;
+      /**
+       * The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
+       * country code of the destination country.
+       */
       destination_country_code: string;
+      /**
+       * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
+       * destination bank account.
+       */
       destination_currency_code: string;
-      foreign_exchange_indicator: string;
+      /**
+       * A description of how the foreign exchange rate was calculated.
+       *
+       * - `fixed_to_variable` - The originator chose an amount in their own currency.
+       *   The settled amount in USD was converted using the exchange rate.
+       * - `variable_to_fixed` - The originator chose an amount to settle in USD. The
+       *   originator's amount was variable; known only after the foreign exchange
+       *   conversion.
+       * - `fixed_to_fixed` - The amount was originated and settled as a fixed amount in
+       *   USD. There is no foreign exchange conversion.
+       */
+      foreign_exchange_indicator: 'fixed_to_variable' | 'variable_to_fixed' | 'fixed_to_fixed';
+      /**
+       * Depending on the `foreign_exchange_reference_indicator`, an exchange rate or a
+       * reference to a well-known rate.
+       */
       foreign_exchange_reference: string | null;
-      foreign_exchange_reference_indicator: string;
+      /**
+       * An instruction of how to interpret the `foreign_exchange_reference` field for
+       * this Transaction.
+       *
+       * - `foreign_exchange_rate` - The ACH file contains a foreign exchange rate.
+       * - `foreign_exchange_reference_number` - The ACH file contains a reference to a
+       *   well-known foreign exchange rate.
+       * - `blank` - There is no foreign exchange for this transfer, so the
+       *   `foreign_exchange_reference` field is blank.
+       */
+      foreign_exchange_reference_indicator:
+        | 'foreign_exchange_rate'
+        | 'foreign_exchange_reference_number'
+        | 'blank';
+      /**
+       * The amount in the minor unit of the foreign payment currency. For dollars, for
+       * example, this is cents.
+       */
       foreign_payment_amount: number;
+      /**
+       * A reference number in the foreign banking infrastructure.
+       */
       foreign_trace_number: string | null;
-      international_transaction_type_code: string;
+      /**
+       * The type of transfer. Set by the originator.
+       *
+       * - `annuity` - Sent as `ANN` in the Nacha file.
+       * - `business_or_commercial` - Sent as `BUS` in the Nacha file.
+       * - `deposit` - Sent as `DEP` in the Nacha file.
+       * - `loan` - Sent as `LOA` in the Nacha file.
+       * - `miscellaneous` - Sent as `MIS` in the Nacha file.
+       * - `mortgage` - Sent as `MOR` in the Nacha file.
+       * - `pension` - Sent as `PEN` in the Nacha file.
+       * - `remittance` - Sent as `REM` in the Nacha file.
+       * - `rent_or_lease` - Sent as `RLS` in the Nacha file.
+       * - `salary_or_payroll` - Sent as `SAL` in the Nacha file.
+       * - `tax` - Sent as `TAX` in the Nacha file.
+       * - `accounts_receivable` - Sent as `ARC` in the Nacha file.
+       * - `back_office_conversion` - Sent as `BOC` in the Nacha file.
+       * - `machine_transfer` - Sent as `MTE` in the Nacha file.
+       * - `point_of_purchase` - Sent as `POP` in the Nacha file.
+       * - `point_of_sale` - Sent as `POS` in the Nacha file.
+       * - `represented_check` - Sent as `RCK` in the Nacha file.
+       * - `shared_network_transaction` - Sent as `SHR` in the Nacha file.
+       * - `telphone_initiated` - Sent as `TEL` in the Nacha file.
+       * - `internet_initiated` - Sent as `WEB` in the Nacha file.
+       */
+      international_transaction_type_code:
+        | 'annuity'
+        | 'business_or_commercial'
+        | 'deposit'
+        | 'loan'
+        | 'miscellaneous'
+        | 'mortgage'
+        | 'pension'
+        | 'remittance'
+        | 'rent_or_lease'
+        | 'salary_or_payroll'
+        | 'tax'
+        | 'accounts_receivable'
+        | 'back_office_conversion'
+        | 'machine_transfer'
+        | 'point_of_purchase'
+        | 'point_of_sale'
+        | 'represented_check'
+        | 'shared_network_transaction'
+        | 'telphone_initiated'
+        | 'internet_initiated';
+      /**
+       * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the
+       * originating bank account.
+       */
       originating_currency_code: string;
+      /**
+       * The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
+       * country code of the originating branch country.
+       */
       originating_depository_financial_institution_branch_country: string;
+      /**
+       * An identifier for the originating bank. One of an International Bank Account
+       * Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
+       * domestic identifier like a US Routing Number.
+       */
       originating_depository_financial_institution_id: string;
-      originating_depository_financial_institution_id_qualifier: string;
+      /**
+       * An instruction of how to interpret the
+       * `originating_depository_financial_institution_id` field for this Transaction.
+       *
+       * - `national_clearing_system_number` - A domestic clearing system number. In the
+       *   US, for example, this is the American Banking Association (ABA) routing
+       *   number.
+       * - `bic_code` - The SWIFT Bank Identifier Code (BIC) of the bank.
+       * - `iban` - An International Bank Account Number.
+       */
+      originating_depository_financial_institution_id_qualifier:
+        | 'national_clearing_system_number'
+        | 'bic_code'
+        | 'iban';
+      /**
+       * The name of the originating bank. Sometimes this will refer to an American bank
+       * and obscure the correspondent foreign bank.
+       */
       originating_depository_financial_institution_name: string;
+      /**
+       * A portion of the originator address. This may be incomplete.
+       */
       originator_city: string;
+      /**
+       * A description field set by the originator.
+       */
       originator_company_entry_description: string;
+      /**
+       * A portion of the originator address. The
+       * [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country
+       * code of the originator country.
+       */
       originator_country: string;
+      /**
+       * An identifier for the originating company. This is generally stable across
+       * multiple ACH transfers.
+       */
       originator_identification: string;
+      /**
+       * Either the name of the originator or an intermediary money transmitter.
+       */
       originator_name: string;
+      /**
+       * A portion of the originator address. This may be incomplete.
+       */
       originator_postal_code: string | null;
+      /**
+       * A portion of the originator address. This may be incomplete.
+       */
       originator_state_or_province: string | null;
+      /**
+       * A portion of the originator address. This may be incomplete.
+       */
       originator_street_address: string;
+      /**
+       * A description field set by the originator.
+       */
       payment_related_information: string | null;
+      /**
+       * A description field set by the originator.
+       */
       payment_related_information2: string | null;
+      /**
+       * A portion of the receiver address. This may be incomplete.
+       */
       receiver_city: string;
+      /**
+       * A portion of the receiver address. The
+       * [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country
+       * code of the receiver country.
+       */
       receiver_country: string;
+      /**
+       * An identification number the originator uses for the receiver.
+       */
       receiver_identification_number: string | null;
+      /**
+       * A portion of the receiver address. This may be incomplete.
+       */
       receiver_postal_code: string | null;
+      /**
+       * A portion of the receiver address. This may be incomplete.
+       */
       receiver_state_or_province: string | null;
+      /**
+       * A portion of the receiver address. This may be incomplete.
+       */
       receiver_street_address: string;
+      /**
+       * The name of the receiver of the transfer. This is not verified by Increase.
+       */
       receiving_company_or_individual_name: string;
+      /**
+       * The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2
+       * country code of the receiving bank country.
+       */
       receiving_depository_financial_institution_country: string;
+      /**
+       * An identifier for the receiving bank. One of an International Bank Account
+       * Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a
+       * domestic identifier like a US Routing Number.
+       */
       receiving_depository_financial_institution_id: string;
-      receiving_depository_financial_institution_id_qualifier: string;
+      /**
+       * An instruction of how to interpret the
+       * `receiving_depository_financial_institution_id` field for this Transaction.
+       *
+       * - `national_clearing_system_number` - A domestic clearing system number. In the
+       *   US, for example, this is the American Banking Association (ABA) routing
+       *   number.
+       * - `bic_code` - The SWIFT Bank Identifier Code (BIC) of the bank.
+       * - `iban` - An International Bank Account Number.
+       */
+      receiving_depository_financial_institution_id_qualifier:
+        | 'national_clearing_system_number'
+        | 'bic_code'
+        | 'iban';
+      /**
+       * The name of the receiving bank, as set by the sending financial institution.
+       */
       receiving_depository_financial_institution_name: string;
+      /**
+       * A 15 digit number recorded in the Nacha file and available to both the
+       * originating and receiving bank. Along with the amount, date, and originating
+       * routing number, this can be used to identify the ACH transfer at either bank.
+       * ACH trace numbers are not unique, but are
+       * [used to correlate returns](https://increase.com/documentation/ach#returns).
+       */
       trace_number: string;
     }
     /**
@@ -2155,7 +2429,7 @@ export declare namespace Transaction {
        */
       remittance_information: string | null;
       /**
-       * The Real-Time Payments network identification of the transfer
+       * The Real-Time Payments network identification of the transfer.
        */
       transaction_identification: string;
     }
@@ -2169,18 +2443,72 @@ export declare namespace Transaction {
        * example, this is cents.
        */
       amount: number;
+      /**
+       * A free-form address field set by the sender.
+       */
       beneficiary_address_line1: string | null;
+      /**
+       * A free-form address field set by the sender.
+       */
       beneficiary_address_line2: string | null;
+      /**
+       * A free-form address field set by the sender.
+       */
       beneficiary_address_line3: string | null;
+      /**
+       * A name set by the sender.
+       */
       beneficiary_name: string | null;
+      /**
+       * A free-form reference string set by the sender, to help identify the transfer.
+       */
       beneficiary_reference: string | null;
+      /**
+       * An Increase-constructed description of the transfer.
+       */
       description: string;
+      /**
+       * A unique identifier available to the originating and receiving banks, commonly
+       * abbreviated as IMAD. It is created when the wire is submitted to the Fedwire
+       * service and is helpful when debugging wires with the receiving bank.
+       */
       input_message_accountability_data: string | null;
+      /**
+       * The address of the wire originator, set by the sending bank.
+       */
       originator_address_line1: string | null;
+      /**
+       * The address of the wire originator, set by the sending bank.
+       */
       originator_address_line2: string | null;
+      /**
+       * The address of the wire originator, set by the sending bank.
+       */
       originator_address_line3: string | null;
+      /**
+       * The originator of the wire, set by the sending bank.
+       */
       originator_name: string | null;
+      /**
+       * An Increase-created concatenation of the Originator-to-Beneficiary lines.
+       */
       originator_to_beneficiary_information: string | null;
+      /**
+       * A free-form message set by the wire originator.
+       */
+      originator_to_beneficiary_information_line1: string | null;
+      /**
+       * A free-form message set by the wire originator.
+       */
+      originator_to_beneficiary_information_line2: string | null;
+      /**
+       * A free-form message set by the wire originator.
+       */
+      originator_to_beneficiary_information_line3: string | null;
+      /**
+       * A free-form message set by the wire originator.
+       */
+      originator_to_beneficiary_information_line4: string | null;
     }
     /**
      * An Inbound Wire Drawdown Payment Reversal object. This field will be present in
@@ -2235,7 +2563,7 @@ export declare namespace Transaction {
      */
     interface InboundWireReversal {
       /**
-       * The amount that was reversed.
+       * The amount that was reversed in USD cents.
        */
       amount: number;
       /**
@@ -2244,7 +2572,7 @@ export declare namespace Transaction {
        */
       created_at: string;
       /**
-       * The description on the reversal message from Fedwire.
+       * The description on the reversal message from Fedwire, set by the reversing bank.
        */
       description: string;
       /**
@@ -2252,7 +2580,8 @@ export declare namespace Transaction {
        */
       financial_institution_to_financial_institution_information: string | null;
       /**
-       * The Fedwire cycle date for the wire reversal.
+       * The Fedwire cycle date for the wire reversal. The "Fedwire day" begins at 9:00
+       * PM Eastern Time on the evening before the `cycle date`.
        */
       input_cycle_date: string;
       /**
@@ -2268,7 +2597,8 @@ export declare namespace Transaction {
        */
       input_source: string;
       /**
-       * The Fedwire cycle date for the wire transfer that was reversed.
+       * The Fedwire cycle date for the wire transfer that is being reversed by this
+       * message.
        */
       previous_message_input_cycle_date: string;
       /**
@@ -2303,25 +2633,74 @@ export declare namespace Transaction {
      */
     interface InboundWireTransfer {
       /**
-       * The amount in the minor unit of the transaction's currency. For dollars, for
-       * example, this is cents.
+       * The amount in USD cents.
        */
       amount: number;
+      /**
+       * A free-form address field set by the sender.
+       */
       beneficiary_address_line1: string | null;
+      /**
+       * A free-form address field set by the sender.
+       */
       beneficiary_address_line2: string | null;
+      /**
+       * A free-form address field set by the sender.
+       */
       beneficiary_address_line3: string | null;
+      /**
+       * A name set by the sender.
+       */
       beneficiary_name: string | null;
+      /**
+       * A free-form reference string set by the sender, to help identify the transfer.
+       */
       beneficiary_reference: string | null;
+      /**
+       * An Increase-constructed description of the transfer.
+       */
       description: string;
+      /**
+       * A unique identifier available to the originating and receiving banks, commonly
+       * abbreviated as IMAD. It is created when the wire is submitted to the Fedwire
+       * service and is helpful when debugging wires with the originating bank.
+       */
       input_message_accountability_data: string | null;
+      /**
+       * The address of the wire originator, set by the sending bank.
+       */
       originator_address_line1: string | null;
+      /**
+       * The address of the wire originator, set by the sending bank.
+       */
       originator_address_line2: string | null;
+      /**
+       * The address of the wire originator, set by the sending bank.
+       */
       originator_address_line3: string | null;
+      /**
+       * The originator of the wire, set by the sending bank.
+       */
       originator_name: string | null;
+      /**
+       * An Increase-created concatenation of the Originator-to-Beneficiary lines.
+       */
       originator_to_beneficiary_information: string | null;
+      /**
+       * A free-form message set by the wire originator.
+       */
       originator_to_beneficiary_information_line1: string | null;
+      /**
+       * A free-form message set by the wire originator.
+       */
       originator_to_beneficiary_information_line2: string | null;
+      /**
+       * A free-form message set by the wire originator.
+       */
       originator_to_beneficiary_information_line3: string | null;
+      /**
+       * A free-form message set by the wire originator.
+       */
       originator_to_beneficiary_information_line4: string | null;
     }
     /**
@@ -2382,6 +2761,9 @@ export declare namespace Transaction {
        */
       currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
       /**
+       * An Internal Source is a transaction between you and Increase. This describes the
+       * reason for the transaction.
+       *
        * - `account_closure` - Account closure
        * - `bank_migration` - Bank migration
        * - `cashback` - Cashback
@@ -2469,6 +2851,9 @@ export declare namespace Transaction {
        * The American Bankers' Association (ABA) Routing Transit Number (RTN).
        */
       routing_number: string;
+      /**
+       * The identifier of the Wire Transfer that led to this Transaction.
+       */
       transfer_id: string;
     }
     /**
@@ -2476,6 +2861,9 @@ export declare namespace Transaction {
      * response if and only if `category` is equal to `wire_transfer_rejection`.
      */
     interface WireTransferRejection {
+      /**
+       * The identifier of the Wire Transfer that led to this Transaction.
+       */
       transfer_id: string;
     }
   }