stripe 18.2.1 → 18.3.0-beta.2

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

@@ -0,0 +1,296 @@
+// 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;
+          }
+
+          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;
+            }
+
+            type Type = 'bank_account' | 'card';
+          }
+
+          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';
+          }
+        }
+      }
+
+      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>
+          >;
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,251 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        /**
+         * OutboundTransfer represents a single money movement from one FinancialAccount you own to a payout method you also own.
+         */
+        interface OutboundTransfer {
+          /**
+           * Unique identifier for the OutboundTransfer.
+           */
+          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_transfer';
+
+          /**
+           * The "presentment amount" for the OutboundTransfer.
+           */
+          amount: Amount;
+
+          /**
+           * Returns true if the OutboundTransfer can be canceled, and false otherwise.
+           */
+          cancelable: boolean;
+
+          /**
+           * Time at which the OutboundTransfer was created.
+           * Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+           */
+          created: string;
+
+          /**
+           * Delivery options to be used to send the OutboundTransfer.
+           */
+          delivery_options: OutboundTransfer.DeliveryOptions | null;
+
+          /**
+           * An arbitrary string attached to the OutboundTransfer. Often useful for displaying to users.
+           */
+          description: string | null;
+
+          /**
+           * The date when funds are expected to arrive in the payout method. This field is not set if the payout method is in a `failed`, `canceled`, or `returned` state.
+           * Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+           */
+          expected_arrival_date: string | null;
+
+          /**
+           * The FinancialAccount that funds were pulled from.
+           */
+          from: OutboundTransfer.From;
+
+          /**
+           * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+           */
+          livemode: boolean;
+
+          /**
+           * 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.Metadata | null;
+
+          /**
+           * A link to the Stripe-hosted receipt for this OutboundTransfer. The receipt link remains active for 60 days from the OutboundTransfer creation date. After this period, the link will expire and the receipt url value will be null.
+           */
+          receipt_url: string | null;
+
+          /**
+           * The description that appears on the receiving end for an OutboundTransfer (for example, bank statement for external bank transfer).
+           */
+          statement_descriptor: string;
+
+          /**
+           * Closed Enum. Current status of the OutboundTransfer: `processing`, `failed`, `posted`, `returned`, `canceled`.
+           * An OutboundTransfer is `processing` if it has been created and is processing.
+           * The status changes to `posted` once the OutboundTransfer has been "confirmed" and funds have left the account, or to `failed` or `canceled`.
+           * If an OutboundTransfer fails to arrive at its payout method, its status will change to `returned`.
+           */
+          status: OutboundTransfer.Status;
+
+          /**
+           * Status details for an OutboundTransfer in a `failed` or `returned` state.
+           */
+          status_details: OutboundTransfer.StatusDetails | null;
+
+          /**
+           * Hash containing timestamps of when the object transitioned to a particular status.
+           */
+          status_transitions: OutboundTransfer.StatusTransitions | null;
+
+          /**
+           * To which payout method the OutboundTransfer was sent.
+           */
+          to: OutboundTransfer.To;
+
+          /**
+           * A unique identifier that can be used to track this OutboundTransfer with recipient bank. Banks might call this a “reference number” or something similar.
+           */
+          trace_id: OutboundTransfer.TraceId;
+        }
+
+        namespace OutboundTransfer {
+          interface DeliveryOptions {
+            /**
+             * Open Enum. Method for bank account.
+             */
+            bank_account: DeliveryOptions.BankAccount | null;
+          }
+
+          namespace DeliveryOptions {
+            type BankAccount = 'automatic' | 'local' | 'wire';
+          }
+
+          interface From {
+            /**
+             * The monetary amount debited from the sender, only set on responses.
+             */
+            debited: Amount;
+
+            /**
+             * The FinancialAccount that funds were pulled from.
+             */
+            financial_account: string;
+          }
+
+          type Status =
+            | 'canceled'
+            | 'failed'
+            | 'posted'
+            | 'processing'
+            | 'returned';
+
+          interface StatusDetails {
+            /**
+             * The `failed` status reason.
+             */
+            failed: StatusDetails.Failed | null;
+
+            /**
+             * The `returned` status reason.
+             */
+            returned: StatusDetails.Returned | null;
+          }
+
+          namespace StatusDetails {
+            interface Failed {
+              /**
+               * Open Enum. The `failed` status reason.
+               */
+              reason: Failed.Reason;
+            }
+
+            namespace Failed {
+              type Reason =
+                | 'payout_method_declined'
+                | 'payout_method_does_not_exist'
+                | 'payout_method_expired'
+                | 'payout_method_unsupported'
+                | 'payout_method_usage_frequency_limit_exceeded'
+                | 'unknown_failure';
+            }
+
+            interface Returned {
+              /**
+               * Open Enum. The `returned` status reason.
+               */
+              reason: Returned.Reason;
+            }
+
+            namespace Returned {
+              type Reason =
+                | 'payout_method_canceled_by_customer'
+                | 'payout_method_closed'
+                | 'payout_method_currency_unsupported'
+                | 'payout_method_does_not_exist'
+                | 'payout_method_holder_address_incorrect'
+                | 'payout_method_holder_details_incorrect'
+                | 'payout_method_holder_name_incorrect'
+                | 'payout_method_invalid_account_number'
+                | 'payout_method_restricted'
+                | 'recalled'
+                | 'unknown_failure';
+            }
+          }
+
+          interface StatusTransitions {
+            /**
+             * Timestamp describing when an OutboundTransfer changed status to `canceled`.
+             * Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+             */
+            canceled_at: string | null;
+
+            /**
+             * Timestamp describing when an OutboundTransfer changed status to `failed`.
+             * Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+             */
+            failed_at: string | null;
+
+            /**
+             * Timestamp describing when an OutboundTransfer changed status to `posted`.
+             * Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+             */
+            posted_at: string | null;
+
+            /**
+             * Timestamp describing when an OutboundTransfer changed status to `returned`.
+             * Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+             */
+            returned_at: string | null;
+          }
+
+          interface To {
+            /**
+             * The monetary amount being credited to the destination.
+             */
+            credited: Amount;
+
+            /**
+             * The payout method which the OutboundTransfer uses to send payout.
+             */
+            payout_method: string;
+          }
+
+          interface TraceId {
+            /**
+             * Possible values are `pending`, `supported`, and `unsupported`. Initially set to `pending`, it changes to
+             * `supported` when the recipient bank provides a trace ID, or `unsupported` if the recipient bank doesn't support it.
+             * Note that this status may not align with the OutboundPayment or OutboundTransfer status and can remain `pending`
+             * even after the payment or transfer is posted.
+             */
+            status: TraceId.Status;
+
+            /**
+             * The trace ID value if `trace_id.status` is `supported`, otherwise empty.
+             */
+            value: string | null;
+          }
+
+          namespace TraceId {
+            type Status = 'pending' | 'supported' | 'unsupported';
+          }
+        }
+      }
+    }
+  }
+}