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

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

@@ -5,6 +5,10 @@ declare module 'stripe' {
     namespace V2 {
       namespace Core {
         namespace Event {
+          type Changes = {
+            [key: string]: unknown;
+          };
+
           interface Reason {
             /**
              * Event reason type.
@@ -46,6 +50,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 +79,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/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/InboundTransfers.d.ts

@@ -168,9 +168,13 @@ declare module 'stripe' {
                 | 'insufficient_funds';
             }
 
-            interface BankDebitProcessing {}
+            type BankDebitProcessing = {
+              [key: string]: unknown;
+            };
 
-            interface BankDebitQueued {}
+            type BankDebitQueued = {
+              [key: string]: unknown;
+            };
 
             interface BankDebitReturned {
               /**
@@ -188,7 +192,9 @@ declare module 'stripe' {
                 | 'insufficient_funds';
             }
 
-            interface BankDebitSucceeded {}
+            type BankDebitSucceeded = {
+              [key: string]: unknown;
+            };
 
             type Level = 'canonical' | 'debug';
 

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 {

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;
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,77 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        interface RecipientVerificationCreateParams {
+          /**
+           * ID of the payout method.
+           */
+          payout_method: string;
+
+          /**
+           * ID of the recipient account. Required if the recipient distinct from the sender. Leave empty if the recipient and sender are the same entity (i.e. for me-to-me payouts).
+           */
+          recipient?: string;
+        }
+      }
+
+      namespace MoneyManagement {
+        interface RecipientVerificationRetrieveParams {}
+      }
+
+      namespace MoneyManagement {
+        interface RecipientVerificationAcknowledgeParams {}
+      }
+
+      namespace MoneyManagement {
+        class RecipientVerificationsResource {
+          /**
+           * Creates a RecipientVerification to verify the recipient you intend to send funds to.
+           */
+          create(
+            params: RecipientVerificationCreateParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.RecipientVerification>
+          >;
+
+          /**
+           * Retrieves the details of an existing RecipientVerification by passing the unique RecipientVerification ID.
+           */
+          retrieve(
+            id: string,
+            params?: RecipientVerificationRetrieveParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.RecipientVerification>
+          >;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.RecipientVerification>
+          >;
+
+          /**
+           * Acknowledges an existing RecipientVerification. Only RecipientVerification awaiting acknowledgement can be acknowledged.
+           */
+          acknowledge(
+            id: string,
+            params?: RecipientVerificationAcknowledgeParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.RecipientVerification>
+          >;
+          acknowledge(
+            id: string,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.RecipientVerification>
+          >;
+        }
+      }
+    }
+  }
+}

package/types/V2/Reporting/ReportRuns.d.ts

@@ -0,0 +1,154 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Reporting {
+        /**
+         * The `ReportRun` object represents an instance of a `Report` generated with specific
+         * run parameters. Once the object is created, Stripe begins processing the report. When
+         * the report has finished running, it will give you a reference to the results.
+         */
+        interface ReportRun {
+          /**
+           * The unique identifier of the `ReportRun` object.
+           */
+          id: string;
+
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'v2.reporting.report_run';
+
+          /**
+           * Time at which the object was created.
+           */
+          created: 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;
+
+          /**
+           * The unique identifier of the `Report` object which was run.
+           */
+          report: string;
+
+          /**
+           * The human-readable name of the `Report` which was run.
+           */
+          report_name: string;
+
+          /**
+           * The parameters used to customize the generation of the report.
+           */
+          report_parameters: ReportRun.ReportParameters;
+
+          /**
+           * Details how to retrieve the results of a successfully completed `ReportRun`.
+           */
+          result?: ReportRun.Result;
+
+          /**
+           * The options specified for customizing the output file of the `ReportRun`.
+           */
+          result_options?: ReportRun.ResultOptions;
+
+          /**
+           * The current status of the `ReportRun`.
+           */
+          status: ReportRun.Status;
+
+          /**
+           * Additional details about the current state of the `ReportRun`. The field is currently only populated when a `ReportRun`
+           * is in the `failed` state, providing more information about why the report failed to generate successfully.
+           */
+          status_details: {
+            [key: string]: ReportRun.StatusDetails;
+          };
+        }
+
+        namespace ReportRun {
+          type ReportParameters = {
+            [key: string]: unknown;
+          };
+
+          interface Result {
+            /**
+             * Contains metadata about the file produced by the `ReportRun`, including
+             * its content type, size, and a URL to download its contents.
+             */
+            file: Result.File;
+
+            /**
+             * The type of the `ReportRun` result.
+             */
+            type: 'file';
+          }
+
+          namespace Result {
+            interface File {
+              /**
+               * The content type of the file.
+               */
+              content_type: File.ContentType;
+
+              /**
+               * A pre-signed URL that allows secure, time-limited access to download the file.
+               */
+              download_url: File.DownloadUrl;
+
+              /**
+               * The total size of the file in bytes.
+               */
+              size: number;
+            }
+
+            namespace File {
+              type ContentType = 'csv' | 'zip';
+
+              interface DownloadUrl {
+                /**
+                 * The time that the URL expires.
+                 */
+                expires_at?: string;
+
+                /**
+                 * The URL that can be used for accessing the file.
+                 */
+                url: string;
+              }
+            }
+          }
+
+          interface ResultOptions {
+            /**
+             * If set, the generated report file will be compressed into a ZIP folder.
+             * This is useful for reducing file size and download time for large reports.
+             */
+            compress_file?: boolean;
+          }
+
+          type Status = 'failed' | 'running' | 'succeeded';
+
+          interface StatusDetails {
+            /**
+             * Error code categorizing the reason the `ReportRun` failed.
+             */
+            error_code?: StatusDetails.ErrorCode;
+
+            /**
+             * Error message with additional details about the failure.
+             */
+            error_message?: string;
+          }
+
+          namespace StatusDetails {
+            type ErrorCode = 'file_size_above_limit' | 'internal_error';
+          }
+        }
+      }
+    }
+  }
+}