stripe 20.0.0 → 20.1.0-alpha.2

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

@@ -0,0 +1,127 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        interface OutboundPaymentQuoteCreateParams {
+          /**
+           * The "presentment amount" to be sent to the recipient.
+           */
+          amount: OutboundPaymentQuoteCreateParams.Amount;
+
+          /**
+           * Request details about the sender of an OutboundPaymentQuote.
+           */
+          from: OutboundPaymentQuoteCreateParams.From;
+
+          /**
+           * Request details about the recipient of an OutboundPaymentQuote.
+           */
+          to: OutboundPaymentQuoteCreateParams.To;
+
+          /**
+           * Method to be used to send the OutboundPayment.
+           */
+          delivery_options?: OutboundPaymentQuoteCreateParams.DeliveryOptions;
+        }
+
+        namespace OutboundPaymentQuoteCreateParams {
+          interface Amount {
+            /**
+             * A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
+             */
+            value?: number;
+
+            /**
+             * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+             */
+            currency?: string;
+          }
+
+          interface DeliveryOptions {
+            /**
+             * Open Enum. Method for bank account.
+             */
+            bank_account?: DeliveryOptions.BankAccount;
+          }
+
+          namespace DeliveryOptions {
+            type BankAccount = 'automatic' | 'local' | 'wire';
+          }
+
+          interface From {
+            /**
+             * Describes the FinancialAccount's currency drawn from.
+             */
+            currency: string;
+
+            /**
+             * The FinancialAccount that funds were pulled from.
+             */
+            financial_account: string;
+          }
+
+          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 OutboundPaymentQuoteRetrieveParams {}
+      }
+
+      namespace MoneyManagement {
+        class OutboundPaymentQuotesResource {
+          /**
+           * Creates an OutboundPaymentQuote usable in an OutboundPayment.
+           * @throws Stripe.FeatureNotEnabledError
+           */
+          create(
+            params: OutboundPaymentQuoteCreateParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.OutboundPaymentQuote>
+          >;
+
+          /**
+           * Retrieves the details of an existing OutboundPaymentQuote by passing the unique OutboundPaymentQuote ID.
+           */
+          retrieve(
+            id: string,
+            params?: OutboundPaymentQuoteRetrieveParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.OutboundPaymentQuote>
+          >;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.OutboundPaymentQuote>
+          >;
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,323 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        /**
+         * OutboundPayment represents a single money movement from one FinancialAccount you own to a payout method someone else owns.
+         */
+        interface OutboundPayment {
+          /**
+           * Unique identifier for the OutboundPayment.
+           */
+          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_payment';
+
+          /**
+           * The "presentment amount" for the OutboundPayment.
+           */
+          amount: OutboundPayment.Amount;
+
+          /**
+           * Returns true if the OutboundPayment can be canceled, and false otherwise.
+           */
+          cancelable: boolean;
+
+          /**
+           * Time at which the OutboundPayment 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 OutboundPayment.
+           */
+          delivery_options?: OutboundPayment.DeliveryOptions;
+
+          /**
+           * An arbitrary string attached to the OutboundPayment. Often useful for displaying to users.
+           */
+          description?: string;
+
+          /**
+           * 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;
+
+          /**
+           * The FinancialAccount that funds were pulled from.
+           */
+          from: OutboundPayment.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;
+
+          /**
+           * The quote for this OutboundPayment. Only required for countries with regulatory mandates to display fee estimates before OutboundPayment creation.
+           */
+          outbound_payment_quote?: string;
+
+          /**
+           * A link to the Stripe-hosted receipt for this OutboundPayment. The receipt link remains active for 60 days from the OutboundPayment creation date. After this period, the link will expire and the receipt url value will be null.
+           */
+          receipt_url?: string;
+
+          /**
+           * Details about the OutboundPayment notification settings for recipient.
+           */
+          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.
+           */
+          statement_descriptor: string;
+
+          /**
+           * Closed Enum. Current status of the OutboundPayment: `processing`, `failed`, `posted`, `returned`, `canceled`.
+           * An OutboundPayment is `processing` if it has been created and is processing.
+           * The status changes to `posted` once the OutboundPayment has been "confirmed" and funds have left the account, or to `failed` or `canceled`.
+           * If an OutboundPayment fails to arrive at its payout method, its status will change to `returned`.
+           */
+          status: OutboundPayment.Status;
+
+          /**
+           * Status details for an OutboundPayment in a `failed` or `returned` state.
+           */
+          status_details?: OutboundPayment.StatusDetails;
+
+          /**
+           * Hash containing timestamps of when the object transitioned to a particular status.
+           */
+          status_transitions?: OutboundPayment.StatusTransitions;
+
+          /**
+           * To which payout method the OutboundPayment was sent.
+           */
+          to: OutboundPayment.To;
+
+          /**
+           * A unique identifier that can be used to track this OutboundPayment with recipient bank. Banks might call this a “reference number” or something similar.
+           */
+          trace_id: OutboundPayment.TraceId;
+        }
+
+        namespace OutboundPayment {
+          interface Amount {
+            /**
+             * A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
+             */
+            value?: number;
+
+            /**
+             * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+             */
+            currency?: string;
+          }
+
+          interface DeliveryOptions {
+            /**
+             * Open Enum. Method for bank account.
+             */
+            bank_account?: DeliveryOptions.BankAccount;
+          }
+
+          namespace DeliveryOptions {
+            type BankAccount = 'automatic' | 'local' | 'wire';
+          }
+
+          interface From {
+            /**
+             * The monetary amount debited from the sender, only set on responses.
+             */
+            debited: From.Debited;
+
+            /**
+             * The FinancialAccount that funds were pulled from.
+             */
+            financial_account: string;
+          }
+
+          namespace From {
+            interface Debited {
+              /**
+               * A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
+               */
+              value?: number;
+
+              /**
+               * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+               */
+              currency?: 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';
+          }
+
+          type Status =
+            | 'canceled'
+            | 'failed'
+            | 'posted'
+            | 'processing'
+            | 'returned';
+
+          interface StatusDetails {
+            /**
+             * The `failed` status reason.
+             */
+            failed?: StatusDetails.Failed;
+
+            /**
+             * The `returned` status reason.
+             */
+            returned?: StatusDetails.Returned;
+          }
+
+          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 OutboundPayment 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;
+
+            /**
+             * Timestamp describing when an OutboundPayment 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;
+
+            /**
+             * Timestamp describing when an OutboundPayment 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;
+
+            /**
+             * Timestamp describing when an OutboundPayment 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;
+          }
+
+          interface To {
+            /**
+             * The monetary amount being credited to the destination.
+             */
+            credited: To.Credited;
+
+            /**
+             * The payout method which the OutboundPayment uses to send payout.
+             */
+            payout_method: string;
+
+            /**
+             * To which account the OutboundPayment is sent.
+             */
+            recipient: string;
+          }
+
+          namespace To {
+            interface Credited {
+              /**
+               * A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
+               */
+              value?: number;
+
+              /**
+               * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+               */
+              currency?: 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;
+          }
+
+          namespace TraceId {
+            type Status = 'pending' | 'supported' | 'unsupported';
+          }
+        }
+      }
+    }
+  }
+}