stripe 19.2.1 → 19.3.0-alpha.2

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

@@ -0,0 +1,247 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        interface OutboundPaymentCreateParams {
+          /**
+           * The "presentment amount" to be sent to the recipient.
+           */
+          amount: Amount;
+
+          /**
+           * From which FinancialAccount and BalanceType to pull funds from.
+           */
+          from: OutboundPaymentCreateParams.From;
+
+          /**
+           * To which payout method to send the OutboundPayment.
+           */
+          to: OutboundPaymentCreateParams.To;
+
+          /**
+           * Delivery options to be used to send the OutboundPayment.
+           */
+          delivery_options?: OutboundPaymentCreateParams.DeliveryOptions;
+
+          /**
+           * An arbitrary string attached to the OutboundPayment. Often useful for displaying to users.
+           */
+          description?: string;
+
+          /**
+           * 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 quote for this OutboundPayment. Only required for countries with regulatory mandates to display fee estimates before OutboundPayment creation.
+           */
+          outbound_payment_quote?: string;
+
+          /**
+           * 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 {
+          interface DeliveryOptions {
+            /**
+             * Open Enum. Method for bank account.
+             */
+            bank_account?: DeliveryOptions.BankAccount;
+          }
+
+          namespace DeliveryOptions {
+            type BankAccount = 'automatic' | 'local' | 'wire';
+          }
+
+          interface From {
+            /**
+             * Describes the FinancialAmount's currency drawn from.
+             */
+            currency: string;
+
+            /**
+             * The FinancialAccount that funds were pulled from.
+             */
+            financial_account: string;
+          }
+
+          interface RecipientNotification {
+            /**
+             * Closed Enum. Configuration option to enable or disable notifications to recipients.
+             * Do not send notifications when setting is NONE. Default to account setting when setting is CONFIGURED or not set.
+             */
+            setting: RecipientNotification.Setting;
+          }
+
+          namespace RecipientNotification {
+            type Setting = 'configured' | 'none';
+          }
+
+          interface To {
+            /**
+             * Describes the currency to send to the recipient.
+             * If included, this currency must match a currency supported by the destination.
+             * Can be omitted in the following cases:
+             * - destination only supports one currency
+             * - destination supports multiple currencies and one of the currencies matches the FA currency
+             * - destination supports multiple currencies and one of the currencies matches the presentment currency
+             * Note - when both FA currency and presentment currency are supported, we pick the FA currency to minimize FX.
+             */
+            currency?: string;
+
+            /**
+             * The payout method which the OutboundPayment uses to send payout.
+             */
+            payout_method?: string;
+
+            /**
+             * To which account the OutboundPayment is sent.
+             */
+            recipient: string;
+          }
+        }
+      }
+
+      namespace MoneyManagement {
+        interface OutboundPaymentRetrieveParams {}
+      }
+
+      namespace MoneyManagement {
+        interface OutboundPaymentListParams {
+          /**
+           * Filter for objects created at the specified timestamp.
+           * Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
+           */
+          created?: string;
+
+          /**
+           * Filter for objects created after the specified timestamp.
+           * Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
+           */
+          created_gt?: string;
+
+          /**
+           * Filter for objects created on or after the specified timestamp.
+           * Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
+           */
+          created_gte?: string;
+
+          /**
+           * Filter for objects created before the specified timestamp.
+           * Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
+           */
+          created_lt?: string;
+
+          /**
+           * Filter for objects created on or before the specified timestamp.
+           * Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
+           */
+          created_lte?: string;
+
+          /**
+           * The maximum number of results to return.
+           */
+          limit?: number;
+
+          /**
+           * Only return OutboundPayments sent to this recipient.
+           */
+          recipient?: string;
+
+          /**
+           * Closed Enum. Only return OutboundPayments with this status.
+           */
+          status?: Array<OutboundPaymentListParams.Status>;
+        }
+
+        namespace OutboundPaymentListParams {
+          type Status =
+            | 'canceled'
+            | 'failed'
+            | 'posted'
+            | 'processing'
+            | 'returned';
+        }
+      }
+
+      namespace MoneyManagement {
+        interface OutboundPaymentCancelParams {}
+      }
+
+      namespace MoneyManagement {
+        class OutboundPaymentsResource {
+          /**
+           * Creates an OutboundPayment.
+           * @throws Stripe.InsufficientFundsError
+           * @throws Stripe.FeatureNotEnabledError
+           * @throws Stripe.QuotaExceededError
+           * @throws Stripe.RecipientNotNotifiableError
+           */
+          create(
+            params: OutboundPaymentCreateParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.OutboundPayment>
+          >;
+
+          /**
+           * Retrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment create or list response.
+           */
+          retrieve(
+            id: string,
+            params?: OutboundPaymentRetrieveParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.OutboundPayment>
+          >;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.OutboundPayment>
+          >;
+
+          /**
+           * Returns a list of OutboundPayments that match the provided filters.
+           */
+          list(
+            params?: OutboundPaymentListParams,
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.OutboundPayment>;
+          list(
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.OutboundPayment>;
+
+          /**
+           * Cancels an OutboundPayment. Only processing OutboundPayments can be canceled.
+           * @throws Stripe.AlreadyCanceledError
+           * @throws Stripe.NotCancelableError
+           */
+          cancel(
+            id: string,
+            params?: OutboundPaymentCancelParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.OutboundPayment>
+          >;
+          cancel(
+            id: string,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.OutboundPayment>
+          >;
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,97 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        /**
+         * Use the OutboundSetupIntent API to create and setup usable payout methods.
+         */
+        interface OutboundSetupIntent {
+          /**
+           * ID of the outbound setup intent.
+           */
+          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.outbound_setup_intent';
+
+          /**
+           * Created timestamp.
+           */
+          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;
+
+          /**
+           * Specifies which actions needs to be taken next to continue setup of the credential.
+           */
+          next_action?: OutboundSetupIntent.NextAction;
+
+          /**
+           * Use the PayoutMethods API to list and interact with PayoutMethod objects.
+           */
+          payout_method: Stripe.V2.MoneyManagement.PayoutMethod;
+
+          /**
+           * Closed Enum. Status of the outbound setup intent.
+           */
+          status: OutboundSetupIntent.Status;
+
+          /**
+           * The intended money movement flow this payout method should be set up for, specified in params.
+           */
+          usage_intent: OutboundSetupIntent.UsageIntent;
+        }
+
+        namespace OutboundSetupIntent {
+          interface NextAction {
+            /**
+             * The type of next action.
+             */
+            type: 'confirmation_of_payee';
+
+            /**
+             * Confirmation of Payee details.
+             */
+            confirmation_of_payee?: NextAction.ConfirmationOfPayee;
+          }
+
+          namespace NextAction {
+            interface ConfirmationOfPayee {
+              /**
+               * The type of the credential.
+               */
+              object: string;
+
+              /**
+               * The Confirmation of Payee status.
+               */
+              status: ConfirmationOfPayee.Status;
+            }
+
+            namespace ConfirmationOfPayee {
+              type Status =
+                | 'awaiting_acknowledgement'
+                | 'confirmed'
+                | 'uninitiated';
+            }
+          }
+
+          type Status =
+            | 'canceled'
+            | 'requires_action'
+            | 'requires_payout_method'
+            | 'succeeded';
+
+          type UsageIntent = 'payment' | 'transfer';
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,330 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        interface OutboundSetupIntentCreateParams {
+          /**
+           * If provided, the existing payout method resource to link to this setup intent.
+           * Any payout_method_data provided is used to update information on this linked payout method resource.
+           */
+          payout_method?: string;
+
+          /**
+           * If no payout_method provided, used to create the underlying credential that is set up for outbound money movement.
+           * If a payout_method provided, used to update data on the credential linked to this setup intent.
+           */
+          payout_method_data?: OutboundSetupIntentCreateParams.PayoutMethodData;
+
+          /**
+           * Specify which type of outbound money movement this credential should be set up for (payment | transfer).
+           * If not provided, defaults to payment.
+           */
+          usage_intent?: OutboundSetupIntentCreateParams.UsageIntent;
+        }
+
+        namespace OutboundSetupIntentCreateParams {
+          interface PayoutMethodData {
+            /**
+             * Closed Enum. The type of payout method to be created.
+             */
+            type: PayoutMethodData.Type;
+
+            /**
+             * The type specific details of the bank account payout method.
+             */
+            bank_account?: PayoutMethodData.BankAccount;
+
+            /**
+             * 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 {
+            interface BankAccount {
+              /**
+               * The account number or IBAN of the bank account.
+               */
+              account_number: string;
+
+              /**
+               * Closed Enum. The type of the bank account (checking or savings).
+               */
+              bank_account_type?: BankAccount.BankAccountType;
+
+              /**
+               * The branch number of the bank account, if present.
+               */
+              branch_number?: string;
+
+              /**
+               * The country code of the bank account.
+               */
+              country: string;
+
+              /**
+               * The routing number of the bank account, if present.
+               */
+              routing_number?: string;
+
+              /**
+               * The swift code of the bank account, if present.
+               */
+              swift_code?: string;
+            }
+
+            namespace BankAccount {
+              type BankAccountType = 'checking' | 'savings';
+            }
+
+            interface Card {
+              /**
+               * The expiration month of the card.
+               */
+              exp_month: string;
+
+              /**
+               * The expiration year of the card.
+               */
+              exp_year: string;
+
+              /**
+               * The card number.
+               */
+              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';
+          }
+
+          type UsageIntent = 'payment' | 'transfer';
+        }
+      }
+
+      namespace MoneyManagement {
+        interface OutboundSetupIntentRetrieveParams {}
+      }
+
+      namespace MoneyManagement {
+        interface OutboundSetupIntentUpdateParams {
+          /**
+           * If provided, the existing payout method resource to link to this outbound setup intent.
+           */
+          payout_method?: string;
+
+          /**
+           * If no payout_method provided, used to create the underlying credential that is set up for outbound money movement.
+           * If a payout_method provided, used to update data on the credential linked to this setup intent.
+           */
+          payout_method_data?: OutboundSetupIntentUpdateParams.PayoutMethodData;
+        }
+
+        namespace OutboundSetupIntentUpdateParams {
+          interface PayoutMethodData {
+            /**
+             * Closed Enum. The type of payout method to be created/updated.
+             */
+            type: PayoutMethodData.Type;
+
+            /**
+             * The type specific details of the bank account payout method.
+             */
+            bank_account?: PayoutMethodData.BankAccount;
+
+            /**
+             * The type specific details of the card payout method.
+             */
+            card?: PayoutMethodData.Card;
+          }
+
+          namespace PayoutMethodData {
+            interface BankAccount {
+              /**
+               * The account number or IBAN of the bank account.
+               */
+              account_number: string;
+
+              /**
+               * Closed Enum. The type of the bank account (checking or savings).
+               */
+              bank_account_type?: BankAccount.BankAccountType;
+
+              /**
+               * The branch number of the bank account, if present.
+               */
+              branch_number?: string;
+
+              /**
+               * The country code of the bank account.
+               */
+              country: string;
+
+              /**
+               * The routing number of the bank account, if present.
+               */
+              routing_number?: string;
+
+              /**
+               * The swift code of the bank account, if present.
+               */
+              swift_code?: string;
+            }
+
+            namespace BankAccount {
+              type BankAccountType = 'checking' | 'savings';
+            }
+
+            interface Card {
+              /**
+               * The expiration month of the card.
+               */
+              exp_month?: string;
+
+              /**
+               * The expiration year of the card.
+               */
+              exp_year?: string;
+
+              /**
+               * The card number. This can only be passed when creating a new credential on an outbound setup intent in the requires_payout_method state.
+               */
+              number?: string;
+            }
+
+            type Type = 'bank_account' | 'card' | 'crypto_wallet';
+          }
+        }
+      }
+
+      namespace MoneyManagement {
+        interface OutboundSetupIntentListParams {
+          /**
+           * The page size.
+           */
+          limit?: number;
+        }
+      }
+
+      namespace MoneyManagement {
+        interface OutboundSetupIntentCancelParams {}
+      }
+
+      namespace MoneyManagement {
+        class OutboundSetupIntentsResource {
+          /**
+           * Create an OutboundSetupIntent object.
+           * @throws Stripe.BlockedByStripeError
+           * @throws Stripe.InvalidPayoutMethodError
+           * @throws Stripe.QuotaExceededError
+           */
+          create(
+            params?: OutboundSetupIntentCreateParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.OutboundSetupIntent>
+          >;
+          create(
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.OutboundSetupIntent>
+          >;
+
+          /**
+           * Retrieve an OutboundSetupIntent object.
+           */
+          retrieve(
+            id: string,
+            params?: OutboundSetupIntentRetrieveParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.OutboundSetupIntent>
+          >;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.OutboundSetupIntent>
+          >;
+
+          /**
+           * Update an OutboundSetupIntent object.
+           * @throws Stripe.QuotaExceededError
+           * @throws Stripe.BlockedByStripeError
+           * @throws Stripe.InvalidPayoutMethodError
+           */
+          update(
+            id: string,
+            params?: OutboundSetupIntentUpdateParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.OutboundSetupIntent>
+          >;
+
+          /**
+           * List the OutboundSetupIntent objects.
+           */
+          list(
+            params?: OutboundSetupIntentListParams,
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.OutboundSetupIntent>;
+          list(
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.OutboundSetupIntent>;
+
+          /**
+           * Cancel an OutboundSetupIntent object.
+           */
+          cancel(
+            id: string,
+            params?: OutboundSetupIntentCancelParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.OutboundSetupIntent>
+          >;
+          cancel(
+            id: string,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.OutboundSetupIntent>
+          >;
+        }
+      }
+    }
+  }
+}