increase 0.573.0 → 0.575.0

package/src/resources/ach-transfers.ts

@@ -102,7 +102,7 @@ export interface ACHTransfer {
   account_id: string;
 
   /**
-   * The destination account number.
+   * The receiver's account number.
    */
   account_number: string;
 
@@ -182,8 +182,7 @@ export interface ACHTransfer {
   currency: 'USD';
 
   /**
-   * The type of entity that owns the account to which the ACH Transfer is being
-   * sent.
+   * The type of entity that owns the receiver's account.
    *
    * - `business` - The External Account is owned by a business.
    * - `individual` - The External Account is owned by an individual.
@@ -197,7 +196,7 @@ export interface ACHTransfer {
   external_account_id: string | null;
 
   /**
-   * The type of the account to which the transfer will be sent.
+   * The type of the receiver's bank account.
    *
    * - `checking` - A checking account.
    * - `savings` - A savings account.
@@ -220,7 +219,8 @@ export interface ACHTransfer {
   inbound_funds_hold: ACHTransfer.InboundFundsHold | null;
 
   /**
-   * Your identifier for the transfer recipient.
+   * Your internal identifier for the transfer recipient. This value is informational
+   * and not verified by the recipient's bank.
    */
   individual_id: string | null;
 
@@ -263,7 +263,8 @@ export interface ACHTransfer {
   return: ACHTransfer.Return | null;
 
   /**
-   * The American Bankers' Association (ABA) Routing Transit Number (RTN).
+   * The American Bankers' Association (ABA) Routing Transit Number (RTN) of the
+   * receiver's bank.
    */
   routing_number: string;
 
@@ -314,7 +315,9 @@ export interface ACHTransfer {
    * - `requires_attention` - The transfer requires attention from an Increase
    *   operator.
    * - `rejected` - The transfer has been rejected.
-   * - `submitted` - The transfer is complete.
+   * - `submitted` - The transfer has been submitted to the Federal Reserve. When the
+   *   transfer settles, the status remains `submitted` and the `settlement`
+   *   sub-object is populated.
    * - `returned` - The transfer has been returned.
    */
   status:
@@ -718,7 +721,7 @@ export namespace ACHTransfer {
      * - `same_day` - The chosen effective date will be the same as the ACH processing
      *   date on which the transfer is submitted. This is necessary, but not sufficient
      *   for the transfer to be settled same-day: it must also be submitted before the
-     *   last same-day cutoff and be less than or equal to $1,000.000.00.
+     *   last same-day cutoff and be less than or equal to $1,000,000.00.
      * - `future_dated` - The chosen effective date will be the business day following
      *   the ACH processing date on which the transfer is submitted. The transfer will
      *   be settled on that future day.
@@ -982,7 +985,8 @@ export namespace ACHTransfer {
     transaction_id: string;
 
     /**
-     * The identifier of the ACH Transfer associated with this return.
+     * The identifier of the ACH Transfer associated with this return. This matches the
+     * original Transaction's `source.ach_transfer_intention.transfer_id`.
      */
     transfer_id: string;
 
@@ -1085,44 +1089,52 @@ export interface ACHTransferCreateParams {
   statement_descriptor: string;
 
   /**
-   * The account number for the destination account.
+   * The receiver's account number. For credit transfers (positive `amount`) this is
+   * the account that funds will be sent to. For debit transfers (negative `amount`)
+   * this is the account that funds will be pulled from.
    */
   account_number?: string;
 
   /**
-   * Additional information that will be sent to the recipient. This is included in
-   * the transfer data sent to the receiving bank.
+   * Additional information passed through to the receiving bank with the transfer.
+   * Most ACH transfers do not need this. Only set this if your recipient has asked
+   * for addendum data, typically unstructured remittance information. Corporate
+   * Trade Exchange (CTX) flows can carry structured X12 remittance advice instead.
    */
   addenda?: ACHTransferCreateParams.Addenda;
 
   /**
-   * The description of the date of the transfer, usually in the format `YYMMDD`.
-   * This is included in the transfer data sent to the receiving bank.
+   * A description of the transfer date (typically `YYMMDD`), sent in the company
+   * batch header. This value is informational and does not affect funds movement,
+   * settlement timing, or returns. Only set this if your recipient has asked for it.
    */
   company_descriptive_date?: string;
 
   /**
-   * The data you choose to associate with the transfer. This is included in the
-   * transfer data sent to the receiving bank.
+   * Custom data sent in the company batch header. This value is informational and
+   * does not affect funds movement, settlement timing, or returns. Most ACH
+   * transfers do not need this. Only set this if your recipient has asked for it.
    */
   company_discretionary_data?: string;
 
   /**
-   * A description of the transfer, included in the transfer data sent to the
-   * receiving bank. Standardized formatting may be required, for example `PAYROLL`
-   * for payroll-related Prearranged Payments and Deposits (PPD) credit transfers.
+   * A short description sent in the company batch header. Most receivers do not
+   * surface this. Only set this if your recipient has asked for a specific value or
+   * if Nacha mandates one for your Standard Entry Class (SEC) code and use case. For
+   * example, Prearranged Payment and Deposit (PPD) payroll credits must use
+   * `PAYROLL`, and reversals must use `REVERSAL`.
    */
   company_entry_description?: string;
 
   /**
-   * The name by which the recipient knows you. This is included in the transfer data
-   * sent to the receiving bank.
+   * The name by which the recipient knows you, sent in the company batch header. We
+   * recommend setting this on every transfer; if you do not, we fall back to the ACH
+   * company name configured on your account.
    */
   company_name?: string;
 
   /**
-   * The type of entity that owns the account to which the ACH Transfer is being
-   * sent.
+   * The type of entity that owns the receiver's account.
    *
    * - `business` - The External Account is owned by a business.
    * - `individual` - The External Account is owned by an individual.
@@ -1137,7 +1149,7 @@ export interface ACHTransferCreateParams {
   external_account_id?: string;
 
   /**
-   * The type of the account to which the transfer will be sent.
+   * The type of the receiver's bank account.
    *
    * - `checking` - A checking account.
    * - `savings` - A savings account.
@@ -1147,7 +1159,8 @@ export interface ACHTransferCreateParams {
   funding?: 'checking' | 'savings' | 'loan' | 'general_ledger';
 
   /**
-   * Your identifier for the transfer recipient.
+   * Your internal identifier for the transfer recipient. This value is informational
+   * and not verified by the recipient's bank. Most callers can leave this unset.
    */
   individual_id?: string;
 
@@ -1171,15 +1184,16 @@ export interface ACHTransferCreateParams {
   require_approval?: boolean;
 
   /**
-   * The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
-   * destination account.
+   * The American Bankers' Association (ABA) Routing Transit Number (RTN) of the
+   * receiver's bank.
    */
   routing_number?: string;
 
   /**
    * The
    * [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
-   * to use for the transfer.
+   * to use for the transfer. If not provided, the default is
+   * `corporate_credit_or_debit`.
    *
    * - `corporate_credit_or_debit` - Corporate Credit and Debit (CCD) is used for
    *   business-to-business payments.
@@ -1213,8 +1227,10 @@ export interface ACHTransferCreateParams {
 
 export namespace ACHTransferCreateParams {
   /**
-   * Additional information that will be sent to the recipient. This is included in
-   * the transfer data sent to the receiving bank.
+   * Additional information passed through to the receiving bank with the transfer.
+   * Most ACH transfers do not need this. Only set this if your recipient has asked
+   * for addendum data, typically unstructured remittance information. Corporate
+   * Trade Exchange (CTX) flows can carry structured X12 remittance advice instead.
    */
   export interface Addenda {
     /**
@@ -1312,7 +1328,7 @@ export namespace ACHTransferCreateParams {
      * - `same_day` - The chosen effective date will be the same as the ACH processing
      *   date on which the transfer is submitted. This is necessary, but not sufficient
      *   for the transfer to be settled same-day: it must also be submitted before the
-     *   last same-day cutoff and be less than or equal to $1,000.000.00.
+     *   last same-day cutoff and be less than or equal to $1,000,000.00.
      * - `future_dated` - The chosen effective date will be the business day following
      *   the ACH processing date on which the transfer is submitted. The transfer will
      *   be settled on that future day.

package/src/resources/beneficial-owners.ts

@@ -264,7 +264,8 @@ export namespace EntityBeneficialOwner {
 
 export interface BeneficialOwnerCreateParams {
   /**
-   * The identifier of the Entity to associate with the new Beneficial Owner.
+   * The identifier of the Entity to associate with the new Beneficial Owner. Only
+   * `corporation` entities have beneficial owners.
    */
   entity_id: string;
 
@@ -386,7 +387,8 @@ export namespace BeneficialOwnerCreateParams {
        * An identification number that can be used to verify the individual's identity,
        * such as a social security number. For Social Security Numbers and Individual
        * Taxpayer Identification Numbers, submit nine digits with no dashes or other
-       * separators.
+       * separators. When testing in sandbox, use one of our
+       * [sandbox test values](https://increase.com/documentation/sandbox-test-values).
        */
       number: string;
 
@@ -593,7 +595,8 @@ export namespace BeneficialOwnerUpdateParams {
      * An identification number that can be used to verify the individual's identity,
      * such as a social security number. For Social Security Numbers and Individual
      * Taxpayer Identification Numbers, submit nine digits with no dashes or other
-     * separators.
+     * separators. When testing in sandbox, use one of our
+     * [sandbox test values](https://increase.com/documentation/sandbox-test-values).
      */
     number: string;
 

package/src/resources/card-push-transfers.ts

@@ -331,11 +331,11 @@ export interface CardPushTransfer {
    *
    * - `pending_approval` - The transfer is pending approval.
    * - `canceled` - The transfer has been canceled.
+   * - `pending_submission` - The transfer is queued to be submitted to the card
+   *   network.
    * - `pending_reviewing` - The transfer is pending review by Increase.
    * - `requires_attention` - The transfer requires attention from an Increase
    *   operator.
-   * - `pending_submission` - The transfer is queued to be submitted to the card
-   *   network.
    * - `submitted` - The transfer has been submitted and is pending a response from
    *   the card network.
    * - `complete` - The transfer has been sent successfully and is complete.
@@ -344,9 +344,9 @@ export interface CardPushTransfer {
   status:
     | 'pending_approval'
     | 'canceled'
+    | 'pending_submission'
     | 'pending_reviewing'
     | 'requires_attention'
-    | 'pending_submission'
     | 'submitted'
     | 'complete'
     | 'declined';
@@ -1626,9 +1626,9 @@ export namespace CardPushTransferListParams {
     in?: Array<
       | 'pending_approval'
       | 'canceled'
+      | 'pending_submission'
       | 'pending_reviewing'
       | 'requires_attention'
-      | 'pending_submission'
       | 'submitted'
       | 'complete'
       | 'declined'

package/src/resources/check-transfers.ts

@@ -243,6 +243,7 @@ export interface CheckTransfer {
    * - `pending_approval` - The transfer is awaiting approval.
    * - `canceled` - The transfer has been canceled.
    * - `pending_submission` - The transfer is pending submission.
+   * - `pending_reviewing` - The transfer is pending review by Increase.
    * - `requires_attention` - The transfer requires attention from an Increase
    *   operator.
    * - `rejected` - The transfer has been rejected.
@@ -256,6 +257,7 @@ export interface CheckTransfer {
     | 'pending_approval'
     | 'canceled'
     | 'pending_submission'
+    | 'pending_reviewing'
     | 'requires_attention'
     | 'rejected'
     | 'pending_mailing'
@@ -595,14 +597,16 @@ export namespace CheckTransfer {
        *   While uncommon, a single check may have more than one delivered event.
        * - `delivery_issue` - There is an issue preventing delivery. The delivery will be
        *   attempted again if possible. If the issue cannot be resolved, the check will
-       *   be returned to sender.
-       * - `returned_to_sender` - Delivery failed and the check was returned to sender.
+       *   be rerouted to the return address.
+       * - `returning_to_sender` - The check has been rerouted to the return address.
+       * - `returned_to_sender` - The check has been delivered to the return address.
        */
       category:
         | 'in_transit'
         | 'processed_for_delivery'
         | 'delivered'
         | 'delivery_issue'
+        | 'returning_to_sender'
         | 'returned_to_sender';
 
       /**
@@ -1084,6 +1088,7 @@ export namespace CheckTransferListParams {
       | 'pending_approval'
       | 'canceled'
       | 'pending_submission'
+      | 'pending_reviewing'
       | 'requires_attention'
       | 'rejected'
       | 'pending_mailing'

package/src/resources/entities.ts

@@ -87,7 +87,7 @@ export type EntitiesPage = Page<Entity>;
 
 /**
  * Entities are the legal entities that own accounts. They can be people,
- * corporations, partnerships, government authorities, or trusts. To learn more,
+ * corporations, joint accounts, trusts, or government authorities. To learn more,
  * see [Entities](/documentation/entities).
  */
 export interface Entity {
@@ -271,7 +271,8 @@ export namespace Entity {
     industry_code: string | null;
 
     /**
-     * The legal identifier of the corporation.
+     * The legal identifier of the corporation, like an Employer Identification Number
+     * (EIN).
      */
     legal_identifier: Corporation.LegalIdentifier | null;
 
@@ -445,7 +446,8 @@ export namespace Entity {
     }
 
     /**
-     * The legal identifier of the corporation.
+     * The legal identifier of the corporation, like an Employer Identification Number
+     * (EIN).
      */
     export interface LegalIdentifier {
       /**
@@ -460,7 +462,7 @@ export namespace Entity {
       category: 'us_employer_identification_number' | 'other';
 
       /**
-       * The identifier of the legal identifier.
+       * The legal identifier itself.
        */
       value: string;
     }
@@ -1325,7 +1327,8 @@ export namespace EntityCreateParams {
 
     /**
      * The legal identifier of the corporation. This is usually the Employer
-     * Identification Number (EIN).
+     * Identification Number (EIN). This replaces the deprecated `tax_identifier`
+     * field.
      */
     legal_identifier: Corporation.LegalIdentifier;
 
@@ -1539,7 +1542,8 @@ export namespace EntityCreateParams {
            * An identification number that can be used to verify the individual's identity,
            * such as a social security number. For Social Security Numbers and Individual
            * Taxpayer Identification Numbers, submit nine digits with no dashes or other
-           * separators.
+           * separators. When testing in sandbox, use one of our
+           * [sandbox test values](https://increase.com/documentation/sandbox-test-values).
            */
           number: string;
 
@@ -1651,12 +1655,15 @@ export namespace EntityCreateParams {
 
     /**
      * The legal identifier of the corporation. This is usually the Employer
-     * Identification Number (EIN).
+     * Identification Number (EIN). This replaces the deprecated `tax_identifier`
+     * field.
      */
     export interface LegalIdentifier {
       /**
-       * The legal identifier. For US Employer Identification Numbers, submit nine digits
-       * with no dashes or other separators.
+       * The legal identifier itself. For US Employer Identification Numbers, submit nine
+       * digits with no dashes or other separators. When testing in sandbox, use one of
+       * our
+       * [sandbox test values](https://increase.com/documentation/sandbox-test-values).
        */
       value: string;
 
@@ -1865,7 +1872,8 @@ export namespace EntityCreateParams {
          * An identification number that can be used to verify the individual's identity,
          * such as a social security number. For Social Security Numbers and Individual
          * Taxpayer Identification Numbers, submit nine digits with no dashes or other
-         * separators.
+         * separators. When testing in sandbox, use one of our
+         * [sandbox test values](https://increase.com/documentation/sandbox-test-values).
          */
         number: string;
 
@@ -2075,7 +2083,8 @@ export namespace EntityCreateParams {
        * An identification number that can be used to verify the individual's identity,
        * such as a social security number. For Social Security Numbers and Individual
        * Taxpayer Identification Numbers, submit nine digits with no dashes or other
-       * separators.
+       * separators. When testing in sandbox, use one of our
+       * [sandbox test values](https://increase.com/documentation/sandbox-test-values).
        */
       number: string;
 
@@ -2453,7 +2462,8 @@ export namespace EntityCreateParams {
            * An identification number that can be used to verify the individual's identity,
            * such as a social security number. For Social Security Numbers and Individual
            * Taxpayer Identification Numbers, submit nine digits with no dashes or other
-           * separators.
+           * separators. When testing in sandbox, use one of our
+           * [sandbox test values](https://increase.com/documentation/sandbox-test-values).
            */
           number: string;
 
@@ -2660,7 +2670,8 @@ export namespace EntityCreateParams {
          * An identification number that can be used to verify the individual's identity,
          * such as a social security number. For Social Security Numbers and Individual
          * Taxpayer Identification Numbers, submit nine digits with no dashes or other
-         * separators.
+         * separators. When testing in sandbox, use one of our
+         * [sandbox test values](https://increase.com/documentation/sandbox-test-values).
          */
         number: string;
 
@@ -2919,8 +2930,8 @@ export namespace EntityUpdateParams {
      */
     export interface LegalIdentifier {
       /**
-       * The identifier of the legal identifier. For US Employer Identification Numbers,
-       * submit nine digits with no dashes or other separators.
+       * The legal identifier itself. For US Employer Identification Numbers, submit nine
+       * digits with no dashes or other separators.
        */
       value: string;
 
@@ -3081,7 +3092,8 @@ export namespace EntityUpdateParams {
        * An identification number that can be used to verify the individual's identity,
        * such as a social security number. For Social Security Numbers and Individual
        * Taxpayer Identification Numbers, submit nine digits with no dashes or other
-       * separators.
+       * separators. When testing in sandbox, use one of our
+       * [sandbox test values](https://increase.com/documentation/sandbox-test-values).
        */
       number: string;
 

package/src/resources/fednow-transfers.ts

@@ -199,25 +199,25 @@ export interface FednowTransfer {
   /**
    * The lifecycle status of the transfer.
    *
+   * - `pending_submitting` - The transfer is queued to be submitted to FedNow.
    * - `pending_reviewing` - The transfer is pending review by Increase.
    * - `canceled` - The transfer has been canceled.
    * - `reviewing_rejected` - The transfer has been rejected by Increase.
    * - `requires_attention` - The transfer requires attention from an Increase
    *   operator.
    * - `pending_approval` - The transfer is pending approval.
-   * - `pending_submitting` - The transfer is queued to be submitted to FedNow.
    * - `pending_response` - The transfer has been submitted and is pending a response
    *   from FedNow.
    * - `complete` - The transfer has been sent successfully and is complete.
    * - `rejected` - The transfer was rejected by the network or the recipient's bank.
    */
   status:
+    | 'pending_submitting'
     | 'pending_reviewing'
     | 'canceled'
     | 'reviewing_rejected'
     | 'requires_attention'
     | 'pending_approval'
-    | 'pending_submitting'
     | 'pending_response'
     | 'complete'
     | 'rejected';
@@ -632,12 +632,12 @@ export namespace FednowTransferListParams {
      * should be encoded as a comma-delimited string, such as `?in=one,two,three`.
      */
     in?: Array<
+      | 'pending_submitting'
       | 'pending_reviewing'
       | 'canceled'
       | 'reviewing_rejected'
       | 'requires_attention'
       | 'pending_approval'
-      | 'pending_submitting'
       | 'pending_response'
       | 'complete'
       | 'rejected'

package/src/resources/inbound-mail-items.ts

@@ -41,7 +41,9 @@ export class InboundMailItems extends APIResource {
   }
 
   /**
-   * Action an Inbound Mail Item
+   * Deposits or ignores each check contained in a pending Inbound Mail Item.
+   * Depositing a check creates a [Check Deposit](#check-deposits) into the Account
+   * you specify.
    *
    * @example
    * ```ts
@@ -67,7 +69,9 @@ export type InboundMailItemsPage = Page<InboundMailItem>;
 
 /**
  * Inbound Mail Items represent pieces of physical mail delivered to a Lockbox
- * Address.
+ * Address. Increase automatically deposits checks mailed to a Lockbox Recipient
+ * into the recipient's Account. Checks that are not matched to a Lockbox Recipient
+ * must be deposited or ignored using the Action an Inbound Mail Item endpoint.
  */
 export interface InboundMailItem {
   /**

package/src/resources/inbound-real-time-payments-transfers.ts

@@ -126,7 +126,8 @@ export interface InboundRealTimePaymentsTransfer {
    * The lifecycle status of the transfer.
    *
    * - `pending_confirming` - The transfer is pending confirmation.
-   * - `timed_out` - The transfer was not responded to in time.
+   * - `timed_out` - The transfer was not responded to in time. This is rare and
+   *   represents an error at Increase.
    * - `confirmed` - The transfer has been received successfully and is confirmed.
    * - `declined` - The transfer has been declined.
    */

package/src/resources/lockbox-addresses.ts

@@ -8,7 +8,10 @@ import { path } from '../internal/utils/path';
 
 export class LockboxAddresses extends APIResource {
   /**
-   * Create a Lockbox Address
+   * The Lockbox Address starts with a `pending` status and a null `address`. Shortly
+   * after creation, Increase generates the mailing address and the status becomes
+   * `active`. You can only create Lockbox Recipients for an `active` Lockbox
+   * Address.
    *
    * @example
    * ```ts
@@ -76,7 +79,11 @@ export type LockboxAddressesPage = Page<LockboxAddress>;
 
 /**
  * Lockbox Addresses are physical locations that can receive mail containing paper
- * checks.
+ * checks. A Lockbox Address is not itself linked to an Account; Lockbox Recipients
+ * determine where checks received at the address are deposited. Lockbox Addresses
+ * are created with a `pending` status and a null `address`. Increase generates the
+ * mailing address shortly after creation, at which point the status becomes
+ * `active`.
  */
 export interface LockboxAddress {
   /**

package/src/resources/lockbox-recipients.ts

@@ -156,7 +156,8 @@ export interface LockboxRecipientCreateParams {
   account_id: string;
 
   /**
-   * The Lockbox Address where this Lockbox Recipient may receive mail.
+   * The Lockbox Address where this Lockbox Recipient may receive mail. The Lockbox
+   * Address must have a `status` of `active`.
    */
   lockbox_address_id: string;
 

package/src/resources/pending-transactions.ts

@@ -100,7 +100,10 @@ export interface PendingTransaction {
 
   /**
    * The Pending Transaction amount in the minor unit of its currency. For dollars,
-   * for example, this is cents.
+   * for example, this is cents. This amount does not change after the Pending
+   * Transaction is created. If a card authorization settles for a different amount,
+   * the settled amount is available on the resulting Transaction and on the Card
+   * Payment's `state.settled_amount`.
    */
   amount: number;
 
@@ -168,7 +171,9 @@ export interface PendingTransaction {
    * - `pending` - The Pending Transaction is still awaiting confirmation.
    * - `complete` - The Pending Transaction is confirmed. An associated Transaction
    *   exists for this object. The Pending Transaction will no longer count against
-   *   your balance and can generally be hidden from UIs, etc.
+   *   your balance and can generally be hidden from UIs, etc. The Pending
+   *   Transaction's `amount` is not updated if the associated Transaction settles
+   *   for a different amount.
    */
   status: 'pending' | 'complete';
 

package/src/resources/physical-cards.ts

@@ -329,15 +329,18 @@ export namespace PhysicalCard {
          *   event.
          * - `delivery_issue` - There is an issue preventing delivery. The delivery will be
          *   attempted again if possible. If the issue cannot be resolved, the physical
-         *   card will be returned to sender.
-         * - `returned_to_sender` - Delivery failed and the physical card was returned to
-         *   sender.
+         *   card will be rerouted to the return address.
+         * - `returning_to_sender` - The physical card has been rerouted to the return
+         *   address.
+         * - `returned_to_sender` - The physical card has been delivered to the return
+         *   address.
          */
         category:
           | 'in_transit'
           | 'processed_for_delivery'
           | 'delivered'
           | 'delivery_issue'
+          | 'returning_to_sender'
           | 'returned_to_sender';
 
         /**

package/src/resources/real-time-payments-transfers.ts

@@ -226,12 +226,12 @@ export interface RealTimePaymentsTransfer {
    *
    * - `pending_approval` - The transfer is pending approval.
    * - `canceled` - The transfer has been canceled.
+   * - `pending_submission` - The transfer is queued to be submitted to Real-Time
+   *   Payments.
    * - `pending_reviewing` - The transfer is pending review by Increase.
    * - `requires_attention` - The transfer requires attention from an Increase
    *   operator.
    * - `rejected` - The transfer was rejected by the network or the recipient's bank.
-   * - `pending_submission` - The transfer is queued to be submitted to Real-Time
-   *   Payments.
    * - `submitted` - The transfer has been submitted and is pending a response from
    *   Real-Time Payments.
    * - `complete` - The transfer has been sent successfully and is complete.
@@ -239,10 +239,10 @@ export interface RealTimePaymentsTransfer {
   status:
     | 'pending_approval'
     | 'canceled'
+    | 'pending_submission'
     | 'pending_reviewing'
     | 'requires_attention'
     | 'rejected'
-    | 'pending_submission'
     | 'submitted'
     | 'complete';
 
@@ -631,10 +631,10 @@ export namespace RealTimePaymentsTransferListParams {
     in?: Array<
       | 'pending_approval'
       | 'canceled'
+      | 'pending_submission'
       | 'pending_reviewing'
       | 'requires_attention'
       | 'rejected'
-      | 'pending_submission'
       | 'submitted'
       | 'complete'
     >;

package/src/resources/simulations/card-authorizations.ts

@@ -14,7 +14,10 @@ export class CardAuthorizations extends APIResource {
    * `card_authorization` or a [Declined Transaction](#declined-transactions) of type
    * `card_decline`. You can pass either a Card id or a
    * [Digital Wallet Token](#digital-wallet-tokens) id to simulate the two different
-   * ways purchases can be made.
+   * ways purchases can be made. The response will contain either a
+   * `pending_transaction` or a `declined_transaction`; the other attribute will be
+   * null. If the authorization is declined, the reason is available on the Declined
+   * Transaction at `source.card_decline.reason`.
    *
    * @example
    * ```ts