stripe 19.2.0-beta.1 → 19.3.0-alpha.1

package/types/V2/Core/Events.d.ts

@@ -5,6 +5,8 @@ declare module 'stripe' {
     namespace V2 {
       namespace Core {
         namespace Event {
+          interface Changes {}
+
           interface Reason {
             /**
              * Event reason type.
@@ -46,6 +48,11 @@ declare module 'stripe' {
            */
           object: 'v2.core.event';
 
+          /**
+           * Before and after changes for the primary related object.
+           */
+          changes?: Event.Changes;
+
           /**
            * Authentication context needed to fetch the event or related object.
            */
@@ -70,6 +77,11 @@ declare module 'stripe' {
            * The type of the event.
            */
           type: string;
+
+          /**
+           * For interop events, this is the snapshot event ID.
+           */
+          v1_event_id?: string;
         }
       }
     }

package/types/V2/Core/EventsResource.d.ts

@@ -12,14 +12,39 @@ declare module 'stripe' {
       namespace Core {
         interface EventListParams {
           /**
-           * Primary object ID used to retrieve related events.
+           * Filter for events created after the specified timestamp.
            */
-          object_id: string;
+          gt?: string;
+
+          /**
+           * Filter for events created at or after the specified timestamp.
+           */
+          gte?: string;
 
           /**
            * The page size.
            */
           limit?: number;
+
+          /**
+           * Filter for events created before the specified timestamp.
+           */
+          lt?: string;
+
+          /**
+           * Filter for events created at or before the specified timestamp.
+           */
+          lte?: string;
+
+          /**
+           * Primary object ID used to retrieve related events.
+           */
+          object_id?: string;
+
+          /**
+           * An array of up to 20 strings containing specific event names.
+           */
+          types?: Array<string>;
         }
       }
 
@@ -42,9 +67,10 @@ declare module 'stripe' {
            * List events, going back up to 30 days.
            */
           list(
-            params: EventListParams,
+            params?: EventListParams,
             options?: RequestOptions
           ): ApiListPromise<Stripe.V2.Core.Event>;
+          list(options?: RequestOptions): ApiListPromise<Stripe.V2.Core.Event>;
         }
       }
     }

package/types/V2/Core/Vault/GbBankAccountsResource.d.ts

@@ -63,6 +63,17 @@ declare module 'stripe' {
         }
       }
 
+      namespace Core {
+        namespace Vault {
+          interface GbBankAccountListParams {
+            /**
+             * Optionally set the maximum number of results per page. Defaults to 10.
+             */
+            limit?: number;
+          }
+        }
+      }
+
       namespace Core {
         namespace Vault {
           interface GbBankAccountAcknowledgeConfirmationOfPayeeParams {}
@@ -119,6 +130,17 @@ declare module 'stripe' {
               options?: RequestOptions
             ): Promise<Stripe.Response<Stripe.V2.Core.Vault.GbBankAccount>>;
 
+            /**
+             * List objects that can be used as destinations for outbound money movement via OutboundPayment.
+             */
+            list(
+              params?: GbBankAccountListParams,
+              options?: RequestOptions
+            ): ApiListPromise<Stripe.V2.Core.Vault.GbBankAccount>;
+            list(
+              options?: RequestOptions
+            ): ApiListPromise<Stripe.V2.Core.Vault.GbBankAccount>;
+
             /**
              * Confirm that you have received the result of the Confirmation of Payee request, and that you are okay with
              * proceeding to pay out to this bank account despite the account not matching, partially matching, or the service

package/types/V2/Core/Vault/UsBankAccounts.d.ts

@@ -58,10 +58,56 @@ declare module 'stripe' {
              * The ACH routing number of the bank account.
              */
             routing_number?: string;
+
+            /**
+             * The bank account verification details.
+             */
+            verification: UsBankAccount.Verification;
           }
 
           namespace UsBankAccount {
             type BankAccountType = 'checking' | 'savings';
+
+            interface Verification {
+              /**
+               * The microdeposit verification details if the status is awaiting verification.
+               */
+              microdeposit_verification_details?: Verification.MicrodepositVerificationDetails;
+
+              /**
+               * The bank account verification status.
+               */
+              status: Verification.Status;
+            }
+
+            namespace Verification {
+              interface MicrodepositVerificationDetails {
+                /**
+                 * Time when microdeposits will expire and have to be re-sent.
+                 */
+                expires: string;
+
+                /**
+                 * Microdeposit type can be amounts or descriptor_type.
+                 */
+                microdeposit_type: MicrodepositVerificationDetails.MicrodepositType;
+
+                /**
+                 * Time when microdeposits were sent.
+                 */
+                sent: string;
+              }
+
+              namespace MicrodepositVerificationDetails {
+                type MicrodepositType = 'amounts' | 'descriptor_code';
+              }
+
+              type Status =
+                | 'awaiting_verification'
+                | 'unverified'
+                | 'verification_failed'
+                | 'verified';
+            }
           }
         }
       }

package/types/V2/Core/Vault/UsBankAccountsResource.d.ts

@@ -55,12 +55,50 @@ declare module 'stripe' {
         }
       }
 
+      namespace Core {
+        namespace Vault {
+          interface UsBankAccountListParams {
+            /**
+             * Optionally set the maximum number of results per page. Defaults to 10.
+             */
+            limit?: number;
+
+            /**
+             * Optionally filter by verification status. Mutually exclusive with `unverified`, `verified`, `awaiting_verification`, and `verification_failed`.
+             */
+            verification_status?: string;
+          }
+        }
+      }
+
       namespace Core {
         namespace Vault {
           interface UsBankAccountArchiveParams {}
         }
       }
 
+      namespace Core {
+        namespace Vault {
+          interface UsBankAccountConfirmMicrodepositsParams {
+            /**
+             * Two amounts received through Send Microdeposits must match the input to Confirm Microdeposits to verify US Bank Account.
+             */
+            amounts?: Array<number>;
+
+            /**
+             * Descriptor code received through Send Microdeposits must match the input to Confirm Microdeposits to verify US Bank Account.
+             */
+            descriptor_code?: string;
+          }
+        }
+      }
+
+      namespace Core {
+        namespace Vault {
+          interface UsBankAccountSendMicrodepositsParams {}
+        }
+      }
+
       namespace Core {
         namespace Vault {
           class UsBankAccountsResource {
@@ -100,6 +138,17 @@ declare module 'stripe' {
               options?: RequestOptions
             ): Promise<Stripe.Response<Stripe.V2.Core.Vault.UsBankAccount>>;
 
+            /**
+             * List USBankAccount objects. Optionally filter by verification status.
+             */
+            list(
+              params?: UsBankAccountListParams,
+              options?: RequestOptions
+            ): ApiListPromise<Stripe.V2.Core.Vault.UsBankAccount>;
+            list(
+              options?: RequestOptions
+            ): ApiListPromise<Stripe.V2.Core.Vault.UsBankAccount>;
+
             /**
              * Archive a USBankAccount object. USBankAccount objects will not be automatically archived by Stripe.
              * Archived USBankAccount objects cannot be used as outbound destinations
@@ -115,6 +164,32 @@ declare module 'stripe' {
               id: string,
               options?: RequestOptions
             ): Promise<Stripe.Response<Stripe.V2.Core.Vault.UsBankAccount>>;
+
+            /**
+             * Confirm microdeposits amounts or descriptor code that you have received from the Send Microdeposits request. Once you correctly confirm this, this US Bank Account will be verified and eligible to transfer funds with.
+             */
+            confirmMicrodeposits(
+              id: string,
+              params?: UsBankAccountConfirmMicrodepositsParams,
+              options?: RequestOptions
+            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.UsBankAccount>>;
+            confirmMicrodeposits(
+              id: string,
+              options?: RequestOptions
+            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.UsBankAccount>>;
+
+            /**
+             * Send microdeposits in order to verify your US Bank Account so it is eligible to transfer funds. This will start the verification process and you must Confirm Microdeposits to successfully verify your US Bank Account.
+             */
+            sendMicrodeposits(
+              id: string,
+              params?: UsBankAccountSendMicrodepositsParams,
+              options?: RequestOptions
+            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.UsBankAccount>>;
+            sendMicrodeposits(
+              id: string,
+              options?: RequestOptions
+            ): Promise<Stripe.Response<Stripe.V2.Core.Vault.UsBankAccount>>;
           }
         }
       }

package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts

@@ -40,6 +40,20 @@ declare module 'stripe' {
         interface FinancialAccountRetrieveParams {}
       }
 
+      namespace MoneyManagement {
+        interface FinancialAccountUpdateParams {
+          /**
+           * A descriptive name for the FinancialAccount, up to 50 characters long. This name will be used in the Stripe Dashboard and embedded components.
+           */
+          display_name?: string;
+
+          /**
+           * Metadata associated with the FinancialAccount.
+           */
+          metadata?: Stripe.MetadataParam;
+        }
+      }
+
       namespace MoneyManagement {
         interface FinancialAccountListParams {
           /**
@@ -112,6 +126,17 @@ declare module 'stripe' {
             Stripe.Response<Stripe.V2.MoneyManagement.FinancialAccount>
           >;
 
+          /**
+           * Updates an existing FinancialAccount.
+           */
+          update(
+            id: string,
+            params?: FinancialAccountUpdateParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.FinancialAccount>
+          >;
+
           /**
            * Lists FinancialAccounts in this compartment.
            */

package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts

@@ -14,9 +14,21 @@ declare module 'stripe' {
            * The type of FinancialAddress details to provision.
            */
           type: FinancialAddressCreateParams.Type;
+
+          /**
+           * Optional SEPA Bank account options, used to configure the type of SEPA Bank account to create, such as the originating country.
+           */
+          sepa_bank_account?: FinancialAddressCreateParams.SepaBankAccount;
         }
 
         namespace FinancialAddressCreateParams {
+          interface SepaBankAccount {
+            /**
+             * The originating country of the SEPA Bank account.
+             */
+            country: string;
+          }
+
           type Type =
             | 'gb_bank_account'
             | 'sepa_bank_account'
@@ -35,6 +47,7 @@ declare module 'stripe' {
         namespace FinancialAddressRetrieveParams {
           type Include =
             | 'credentials.gb_bank_account.account_number'
+            | 'credentials.sepa_bank_account.iban'
             | 'credentials.us_bank_account.account_number';
         }
       }
@@ -60,6 +73,7 @@ declare module 'stripe' {
         namespace FinancialAddressListParams {
           type Include =
             | 'credentials.gb_bank_account.account_number'
+            | 'credentials.sepa_bank_account.iban'
             | 'credentials.us_bank_account.account_number';
         }
       }

package/types/V2/MoneyManagement/OutboundPayments.d.ts

@@ -80,6 +80,11 @@ declare module 'stripe' {
            */
           recipient_notification: OutboundPayment.RecipientNotification;
 
+          /**
+           * The recipient verification id for this OutboundPayment. Only required for countries with regulatory mandates to verify recipient names before OutboundPayment creation.
+           */
+          recipient_verification?: string;
+
           /**
            * The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer). It will default to `STRIPE` if not set on the account settings.
            */

package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts

@@ -44,6 +44,11 @@ declare module 'stripe' {
            * Details about the notification settings for the OutboundPayment recipient.
            */
           recipient_notification?: OutboundPaymentCreateParams.RecipientNotification;
+
+          /**
+           * The recipient verification id for this OutboundPayment. Only required for countries with regulatory mandates to verify recipient names before OutboundPayment creation.
+           */
+          recipient_verification?: string;
         }
 
         namespace OutboundPaymentCreateParams {
@@ -178,9 +183,9 @@ declare module 'stripe' {
           /**
            * Creates an OutboundPayment.
            * @throws Stripe.InsufficientFundsError
+           * @throws Stripe.FeatureNotEnabledError
            * @throws Stripe.QuotaExceededError
            * @throws Stripe.RecipientNotNotifiableError
-           * @throws Stripe.FeatureNotEnabledError
            */
           create(
             params: OutboundPaymentCreateParams,

package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts

@@ -40,6 +40,11 @@ declare module 'stripe' {
              * The type specific details of the card payout method.
              */
             card?: PayoutMethodData.Card;
+
+            /**
+             * The type specific details of the crypto wallet payout method.
+             */
+            crypto_wallet?: PayoutMethodData.CryptoWallet;
           }
 
           namespace PayoutMethodData {
@@ -96,6 +101,35 @@ declare module 'stripe' {
               number: string;
             }
 
+            interface CryptoWallet {
+              /**
+               * Crypto wallet address.
+               */
+              address: string;
+
+              /**
+               * Optional field, required if network supports memos (only "stellar" currently).
+               */
+              memo?: string;
+
+              /**
+               * Which rail we should use to make an Outbound money movement to this wallet.
+               */
+              network: CryptoWallet.Network;
+            }
+
+            namespace CryptoWallet {
+              type Network =
+                | 'arbitrum'
+                | 'avalanche_c_chain'
+                | 'base'
+                | 'ethereum'
+                | 'optimism'
+                | 'polygon'
+                | 'solana'
+                | 'stellar';
+            }
+
             type Type = 'bank_account' | 'card' | 'crypto_wallet';
           }
 

package/types/V2/MoneyManagement/OutboundTransfers.d.ts

@@ -70,6 +70,11 @@ declare module 'stripe' {
            */
           receipt_url?: string;
 
+          /**
+           * The recipient verification id for this OutboundTransfer. Only required for countries with regulatory mandates to verify recipient names before OutboundTransfer creation.
+           */
+          recipient_verification?: string;
+
           /**
            * The description that appears on the receiving end for an OutboundTransfer (for example, bank statement for external bank transfer). It will default to `STRIPE` if not set on the account settings.
            */

package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts

@@ -34,6 +34,11 @@ declare module 'stripe' {
            * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
            */
           metadata?: Stripe.MetadataParam;
+
+          /**
+           * The recipient verification id for this OutboundTransfer. Only required for countries with regulatory mandates to verify recipient names before OutboundTransfer creation.
+           */
+          recipient_verification?: string;
         }
 
         namespace OutboundTransferCreateParams {

package/types/V2/MoneyManagement/PayoutMethods.d.ts

@@ -38,6 +38,11 @@ declare module 'stripe' {
            */
           created: string;
 
+          /**
+           * The PayoutMethodCryptoWallet object details.
+           */
+          crypto_wallet?: PayoutMethod.CryptoWallet;
+
           /**
            * ID of the underlying active OutboundSetupIntent object, if any.
            */
@@ -134,6 +139,42 @@ declare module 'stripe' {
             last4: string;
           }
 
+          interface CryptoWallet {
+            /**
+             * Destination wallet address.
+             */
+            address: string;
+
+            /**
+             * Whether the crypto wallet was archived. Crypto wallets can be archived through the /archive API,
+             * and they will not be automatically archived by Stripe. Archived crypto wallets cannot be used as
+             * payout method and will not appear in the payout method list.
+             */
+            archived: boolean;
+
+            /**
+             * Optional field, required if network supports memos (only "stellar" currently).
+             */
+            memo?: string;
+
+            /**
+             * Which rail is being used to make an outbound money movement to this wallet.
+             */
+            network: CryptoWallet.Network;
+          }
+
+          namespace CryptoWallet {
+            type Network =
+              | 'arbitrum'
+              | 'avalanche_c_chain'
+              | 'base'
+              | 'ethereum'
+              | 'optimism'
+              | 'polygon'
+              | 'solana'
+              | 'stellar';
+          }
+
           type Type = 'bank_account' | 'card' | 'crypto_wallet';
 
           interface UsageStatus {

package/types/V2/MoneyManagement/ReceivedCredits.d.ts

@@ -44,6 +44,11 @@ declare module 'stripe' {
            */
           description?: string;
 
+          /**
+           * The amount and currency of the original/external credit request.
+           */
+          external_amount?: Amount;
+
           /**
            * Financial Account ID on which funds for ReceivedCredit were received.
            */

package/types/V2/MoneyManagement/ReceivedDebits.d.ts

@@ -39,6 +39,11 @@ declare module 'stripe' {
            */
           description?: string;
 
+          /**
+           * The amount and currency of the original/external debit request.
+           */
+          external_amount?: Amount;
+
           /**
            * Financial Account on which funds for ReceivedDebit were debited.
            */
@@ -82,6 +87,11 @@ declare module 'stripe' {
              */
             financial_address: string;
 
+            /**
+             * Open Enum. Indicates the origin type through which this debit was initiated.
+             */
+            origin_type: 'us_bank_account';
+
             /**
              * Open Enum. The type of the payment method used to originate the debit.
              */

package/types/V2/MoneyManagement/RecipientVerifications.d.ts

@@ -0,0 +1,112 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        /**
+         * RecipientVerification represents a verification of recipient you intend to send funds to.
+         */
+        interface RecipientVerification {
+          /**
+           * The ID of the RecipientVerification.
+           */
+          id: string;
+
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'v2.money_management.recipient_verification';
+
+          /**
+           * The OBP/OBT ID that consumed this verification, present if one is successfully created.
+           */
+          consumed_by?: string;
+
+          /**
+           * Time at which the RecipientVerification was created.
+           * Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+           */
+          created: string;
+
+          /**
+           * Time at which the RecipientVerification expires, 5 minutes after the creation.
+           * Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+           */
+          expires_at: string;
+
+          /**
+           * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+           */
+          livemode: boolean;
+
+          /**
+           * Closed Enum. Match level of the RecipientVerification: `match`, `close_match`, `no_match`, `unavailable`.
+           */
+          match_result: RecipientVerification.MatchResult;
+
+          /**
+           * Details for the match result.
+           */
+          match_result_details: RecipientVerification.MatchResultDetails;
+
+          /**
+           * Closed Enum. Current status of the RecipientVerification: `verified`, `consumed`, `expired`, `awaiting_acknowledgement`, `acknowledged`.
+           */
+          status: RecipientVerification.Status;
+
+          /**
+           * Hash containing timestamps of when the object transitioned to a particular status.
+           */
+          status_transitions?: RecipientVerification.StatusTransitions;
+        }
+
+        namespace RecipientVerification {
+          type MatchResult =
+            | 'close_match'
+            | 'match'
+            | 'no_match'
+            | 'unavailable';
+
+          interface MatchResultDetails {
+            /**
+             * The account name associated with the bank account as provided by the VoP provider, only present if there is a match or close match.
+             */
+            matched_name?: string;
+
+            /**
+             * A message describing the match result.
+             */
+            message: string;
+
+            /**
+             * The name associated with the provided recipient.
+             */
+            provided_name: string;
+          }
+
+          type Status =
+            | 'acknowledged'
+            | 'awaiting_acknowledgement'
+            | 'consumed'
+            | 'expired'
+            | 'verified';
+
+          interface StatusTransitions {
+            /**
+             * Timestamp describing when a RecipientVerification changed status to `acknowledged`.
+             * Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+             */
+            acknowledged_at?: string;
+
+            /**
+             * Timestamp describing when a RecipientVerification changed status to `consumed`.
+             * Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+             */
+            consumed_at?: string;
+          }
+        }
+      }
+    }
+  }
+}