stripe 22.3.0 → 22.4.0-alpha.1

package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.d.ts

@@ -0,0 +1,218 @@
+import { StripeResource } from '../../../StripeResource.js';
+import { V2Amount } from './../V2Amounts.js';
+import { RequestOptions, Response } from '../../../lib.js';
+export declare class OutboundPaymentQuoteResource extends StripeResource {
+    /**
+     * Creates an OutboundPaymentQuote usable in an OutboundPayment.
+     * @throws Stripe.FeatureNotEnabledError
+     */
+    create(params: V2.MoneyManagement.OutboundPaymentQuoteCreateParams, options?: RequestOptions): Promise<Response<OutboundPaymentQuote>>;
+    /**
+     * Retrieves the details of an existing OutboundPaymentQuote by passing the unique OutboundPaymentQuote ID.
+     */
+    retrieve(id: string, params?: V2.MoneyManagement.OutboundPaymentQuoteRetrieveParams, options?: RequestOptions): Promise<Response<OutboundPaymentQuote>>;
+}
+export interface OutboundPaymentQuote {
+    /**
+     * Unique identifier for the OutboundPaymentQuote.
+     */
+    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_quote';
+    /**
+     * The "presentment amount" for the OutboundPaymentQuote.
+     */
+    amount: V2Amount;
+    /**
+     * Time at which the OutboundPaymentQuote 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?: OutboundPaymentQuote.DeliveryOptions;
+    /**
+     * The estimated fees for the OutboundPaymentQuote.
+     */
+    estimated_fees: Array<OutboundPaymentQuote.EstimatedFee>;
+    /**
+     * Details about the sender of an OutboundPaymentQuote.
+     */
+    from: OutboundPaymentQuote.From;
+    /**
+     * The underlying FXQuote details for the OutboundPaymentQuote.
+     */
+    fx_quote: OutboundPaymentQuote.FxQuote;
+    /**
+     * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+     */
+    livemode: boolean;
+    /**
+     * Details about the recipient of an OutboundPaymentQuote.
+     */
+    to: OutboundPaymentQuote.To;
+}
+export declare namespace OutboundPaymentQuote {
+    interface DeliveryOptions {
+        /**
+         * Open Enum. Method for bank account.
+         */
+        bank_account?: DeliveryOptions.BankAccount;
+        /**
+         * Open Enum. Speed of the payout.
+         */
+        speed?: DeliveryOptions.Speed;
+    }
+    interface EstimatedFee {
+        /**
+         * The fee amount for corresponding fee type.
+         */
+        amount: V2Amount;
+        /**
+         * The fee type.
+         */
+        type: EstimatedFee.Type;
+    }
+    interface From {
+        /**
+         * The monetary amount debited from the sender, only set on responses.
+         */
+        debited: V2Amount;
+        /**
+         * The FinancialAccount that funds were pulled from.
+         */
+        financial_account: string;
+    }
+    interface FxQuote {
+        /**
+         * The duration the exchange rate lock remains valid from creation time. Allowed value is five_minutes or none.
+         */
+        lock_duration: FxQuote.LockDuration;
+        /**
+         * Time at which the rate lock will expire, measured in seconds since the Unix epoch. Null when rate locking is not supported.
+         */
+        lock_expires_at?: string;
+        /**
+         * Lock status of the quote. Transitions from active to expired once past the lock_expires_at timestamp. Value can be active, expired or none.
+         */
+        lock_status: FxQuote.LockStatus;
+        /**
+         * Key pair: from currency Value: exchange rate going from_currency -> to_currency.
+         */
+        rates: {
+            [key: string]: FxQuote.Rates;
+        };
+        /**
+         * The currency that the transaction is exchanging to.
+         */
+        to_currency: string;
+    }
+    interface To {
+        /**
+         * The monetary amount being credited to the destination.
+         */
+        credited: V2Amount;
+        /**
+         * The payout method which the OutboundPayment uses to send payout.
+         */
+        payout_method: string;
+        /**
+         * To which account the OutboundPayment is sent.
+         */
+        recipient: string;
+    }
+    namespace DeliveryOptions {
+        type BankAccount = 'automatic' | 'local' | 'wire';
+        type Speed = 'instant' | 'next_business_day' | 'standard';
+    }
+    namespace EstimatedFee {
+        type Type = 'cross_border_payout_fee' | 'foreign_exchange_fee' | 'instant_payout_fee' | 'next_day_payout_fee' | 'real_time_payout_fee' | 'standard_payout_fee' | 'wire_payout_fee';
+    }
+    namespace FxQuote {
+        type LockDuration = 'five_minutes' | 'none';
+        type LockStatus = 'active' | 'expired' | 'none';
+        interface Rates {
+            /**
+             * The exchange rate going from_currency -> to_currency.
+             */
+            exchange_rate: string;
+        }
+    }
+}
+export declare namespace V2 {
+    namespace MoneyManagement {
+        interface OutboundPaymentQuoteCreateParams {
+            /**
+             * The "presentment amount" to be sent to the recipient.
+             */
+            amount: V2Amount;
+            /**
+             * 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 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;
+            }
+            interface DeliveryOptions {
+                /**
+                 * Open Enum. Method for bank account.
+                 */
+                bank_account?: DeliveryOptions.BankAccount;
+                /**
+                 * Open Enum. Speed of the payout.
+                 */
+                speed?: DeliveryOptions.Speed;
+            }
+            namespace DeliveryOptions {
+                type BankAccount = 'automatic' | 'local' | 'wire';
+                type Speed = 'instant' | 'next_business_day' | 'standard';
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace MoneyManagement {
+        interface OutboundPaymentQuoteRetrieveParams {
+        }
+    }
+}

package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js

@@ -0,0 +1,22 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OutboundPaymentQuoteResource = void 0;
+const StripeResource_js_1 = require("../../../StripeResource.js");
+class OutboundPaymentQuoteResource extends StripeResource_js_1.StripeResource {
+    /**
+     * Creates an OutboundPaymentQuote usable in an OutboundPayment.
+     * @throws Stripe.FeatureNotEnabledError
+     */
+    create(params, options) {
+        return this._makeRequest('POST', '/v2/money_management/outbound_payment_quotes', params, options);
+    }
+    /**
+     * Retrieves the details of an existing OutboundPaymentQuote by passing the unique OutboundPaymentQuote ID.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v2/money_management/outbound_payment_quotes/${encodeURIComponent(id)}`, params, options);
+    }
+}
+exports.OutboundPaymentQuoteResource = OutboundPaymentQuoteResource;
+//# sourceMappingURL=OutboundPaymentQuotes.js.map

package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OutboundPaymentQuotes.js","sourceRoot":"","sources":["../../../../src/resources/V2/MoneyManagement/OutboundPaymentQuotes.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,kEAA0D;AAI1D,MAAa,4BAA6B,SAAQ,kCAAc;IAC9D;;;OAGG;IACH,MAAM,CACJ,MAA2D,EAC3D,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,8CAA8C,EAC9C,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAA8D,EAC9D,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,gDAAgD,kBAAkB,CAAC,EAAE,CAAC,EAAE,EACxE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AA/BD,oEA+BC"}