stripe 22.3.0 → 22.4.0-alpha.2

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

@@ -0,0 +1,525 @@
+import { StripeResource } from '../../../StripeResource.js';
+import { V2Amount } from './../V2Amounts.js';
+import { MetadataParam, Metadata } from '../../../shared.js';
+import { RequestOptions, V2ListPromise, Response } from '../../../lib.js';
+export declare class PayoutIntentResource extends StripeResource {
+    /**
+     * Returns a list of PayoutIntents.
+     */
+    list(params?: V2.MoneyManagement.PayoutIntentListParams, options?: RequestOptions): V2ListPromise<PayoutIntent>;
+    /**
+     * Creates a PayoutIntent.
+     * @throws Stripe.FeatureNotEnabledError
+     */
+    create(params: V2.MoneyManagement.PayoutIntentCreateParams, options?: RequestOptions): Promise<Response<PayoutIntent>>;
+    /**
+     * Retrieves the details of an existing PayoutIntent by passing the unique PayoutIntent ID.
+     */
+    retrieve(id: string, params?: V2.MoneyManagement.PayoutIntentRetrieveParams, options?: RequestOptions): Promise<Response<PayoutIntent>>;
+    /**
+     * Updates a PayoutIntent. Only pending or requires_action PayoutIntents that are editable can be updated.
+     * @throws Stripe.FeatureNotEnabledError
+     */
+    update(id: string, params?: V2.MoneyManagement.PayoutIntentUpdateParams, options?: RequestOptions): Promise<Response<PayoutIntent>>;
+    /**
+     * Cancels a PayoutIntent. Only pending PayoutIntents or processing PayoutIntents with cancelable OutboundPayment/Transfer can be canceled.
+     * @throws Stripe.NotCancelableError
+     */
+    cancel(id: string, params?: V2.MoneyManagement.PayoutIntentCancelParams, options?: RequestOptions): Promise<Response<PayoutIntent>>;
+}
+export interface PayoutIntent {
+    /**
+     * Unique identifier for the PayoutIntent.
+     */
+    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.payout_intent';
+    /**
+     * The monetary amount to be sent.
+     */
+    amount: V2Amount;
+    /**
+     * Time at which the PayoutIntent was created.
+     * Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+     */
+    created: string;
+    /**
+     * An arbitrary string attached to the PayoutIntent. Often useful for displaying to users.
+     */
+    description?: string;
+    /**
+     * The FinancialAccount that funds are pulled from.
+     */
+    from: PayoutIntent.From;
+    /**
+     * Details about the latest payout associated with this PayoutIntent.
+     */
+    latest_payout: PayoutIntent.LatestPayout;
+    /**
+     * 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?: Metadata;
+    /**
+     * Next action required for a PayoutIntent in the requires_action state. Populated when status is requires_action.
+     */
+    next_action?: PayoutIntent.NextAction;
+    /**
+     * Details about the OutboundPayment notification settings for recipient. Only applicable to OutboundPayment.
+     */
+    recipient_notification?: PayoutIntent.RecipientNotification;
+    /**
+     * Scheduling options for the payout. If this is nil, we assume immediate execution.
+     */
+    schedule_options?: PayoutIntent.ScheduleOptions;
+    /**
+     * The description that appears on the receiving end for the payout (for example, on a bank statement).
+     */
+    statement_descriptor?: string;
+    /**
+     * Open Enum. Current status of the PayoutIntent: `pending`, `processing`, `posted`, `canceled`, `requires_action`.
+     */
+    status: PayoutIntent.Status;
+    /**
+     * Hash containing timestamps of when transitioned to a particular status.
+     */
+    status_transitions?: PayoutIntent.StatusTransitions;
+    /**
+     * To which payout method the payout is sent.
+     */
+    to: PayoutIntent.To;
+}
+export declare namespace PayoutIntent {
+    interface From {
+        /**
+         * The currency of the financial account.
+         */
+        currency: string;
+        /**
+         * The FinancialAccount that funds are pulled from.
+         */
+        financial_account: string;
+    }
+    interface LatestPayout {
+        /**
+         * The ID of the OutboundPayment, if applicable.
+         */
+        outbound_payment?: string;
+        /**
+         * The ID of the OutboundTransfer, if applicable.
+         */
+        outbound_transfer?: string;
+        /**
+         * The type of payout.
+         */
+        type: LatestPayout.Type;
+    }
+    interface NextAction {
+        /**
+         * Details about a failure that requires user action. Populated when type is handle_failure.
+         */
+        handle_failure?: NextAction.HandleFailure;
+        /**
+         * Open Enum. The type of next action required.
+         */
+        type: 'handle_failure';
+    }
+    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;
+    }
+    interface ScheduleOptions {
+        /**
+         * The date when the payout should be executed, in YYYY-MM-DD format.
+         */
+        execute_on?: string;
+    }
+    type Status = 'canceled' | 'pending' | 'posted' | 'processing' | 'requires_action';
+    interface StatusTransitions {
+        /**
+         * Timestamp describing when a PayoutIntent 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 a PayoutIntent 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 a PayoutIntent changed status to `processing`.
+         * Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+         */
+        processing_at?: string;
+        /**
+         * Timestamp describing when a PayoutIntent changed status to `requires_action`.
+         * Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+         */
+        requires_action_at?: string;
+    }
+    interface To {
+        /**
+         * The currency to send to the recipient.
+         */
+        currency?: string;
+        /**
+         * The payout method ID. Optional for OutboundPayment if recipient has default payment method. Required for OutboundTransfer.
+         */
+        payout_method?: string;
+        /**
+         * Payout method options for the PayoutIntent.
+         */
+        payout_method_options?: To.PayoutMethodOptions;
+        /**
+         * The recipient ID. Only relevant for OutboundPayment.
+         */
+        recipient?: string;
+    }
+    namespace LatestPayout {
+        type Type = 'outbound_payment' | 'outbound_transfer';
+    }
+    namespace NextAction {
+        interface HandleFailure {
+            /**
+             * Open Enum. The reason for the failure.
+             */
+            failure_reason: HandleFailure.FailureReason;
+        }
+        namespace HandleFailure {
+            type FailureReason = 'account_not_configured_as_recipient' | 'currency_not_supported_for_financial_account_balance' | 'currency_required' | 'feature_not_active_for_recipient' | 'fx_rate_drift_exceeded_after_review' | 'insufficient_funds' | 'payout_method_account_type_incorrect' | 'payout_method_amount_limit_exceeded' | 'payout_method_canceled_by_customer' | 'payout_method_closed' | 'payout_method_currency_unsupported' | 'payout_method_declined' | 'payout_method_does_not_exist' | 'payout_method_expired' | 'payout_method_holder_address_incorrect' | 'payout_method_holder_details_incorrect' | 'payout_method_holder_name_incorrect' | 'payout_method_invalid_account_number' | 'payout_method_restricted' | 'payout_method_unsupported' | 'payout_method_usage_frequency_limit_exceeded' | 'recalled' | 'review_rejected' | 'to_destination_invalid' | 'unknown_failure';
+        }
+    }
+    namespace RecipientNotification {
+        type Setting = 'configured' | 'none';
+    }
+    namespace To {
+        interface PayoutMethodOptions {
+            /**
+             * Options for bank account payout methods.
+             */
+            bank_account?: PayoutMethodOptions.BankAccount;
+        }
+        namespace PayoutMethodOptions {
+            interface BankAccount {
+                /**
+                 * Per-network configuration options.
+                 */
+                preferred_network_options?: BankAccount.PreferredNetworkOptions;
+                /**
+                 * The preferred networks to use for this PayoutIntent.
+                 */
+                preferred_networks: Array<BankAccount.PreferredNetwork>;
+            }
+            namespace BankAccount {
+                interface PreferredNetworkOptions {
+                    /**
+                     * ACH-specific network options.
+                     */
+                    ach?: PreferredNetworkOptions.Ach;
+                }
+                type PreferredNetwork = 'ach' | 'becs' | 'eft' | 'fedwire' | 'fps' | 'npp' | 'rtp' | 'sepa_credit' | 'sepa_instant' | 'swift';
+                namespace PreferredNetworkOptions {
+                    interface Ach {
+                        /**
+                         * Open Enum. ACH submission timing.
+                         */
+                        submission?: Ach.Submission;
+                        /**
+                         * The transaction purpose for this ACH payment.
+                         */
+                        transaction_purpose?: 'payroll';
+                    }
+                    namespace Ach {
+                        type Submission = 'next_day' | 'same_day';
+                    }
+                }
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace MoneyManagement {
+        interface PayoutIntentCreateParams {
+            /**
+             * The monetary amount to be sent.
+             */
+            amount: V2Amount;
+            /**
+             * The FinancialAccount that funds are pulled from.
+             */
+            from: PayoutIntentCreateParams.From;
+            /**
+             * To which payout method the payout is sent.
+             */
+            to: PayoutIntentCreateParams.To;
+            /**
+             * An arbitrary string attached to the PayoutIntent. 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?: MetadataParam;
+            /**
+             * Details about the OutboundPayment notification settings for recipient. Only applicable to OutboundPayment.
+             */
+            recipient_notification?: PayoutIntentCreateParams.RecipientNotification;
+            /**
+             * Scheduling options for the payout. If this is nil, we assume immediate execution.
+             */
+            schedule_options?: PayoutIntentCreateParams.ScheduleOptions;
+            /**
+             * The description that appears on the receiving end for the payout (for example, on a bank statement).
+             */
+            statement_descriptor?: string;
+        }
+        namespace PayoutIntentCreateParams {
+            interface From {
+                /**
+                 * The currency of the financial account.
+                 */
+                currency: string;
+                /**
+                 * The FinancialAccount that funds are pulled from.
+                 */
+                financial_account: string;
+            }
+            interface To {
+                /**
+                 * The currency to send to the recipient.
+                 */
+                currency?: string;
+                /**
+                 * The payout method ID. Optional for OutboundPayment if recipient has default payment method. Required for OutboundTransfer.
+                 */
+                payout_method?: string;
+                /**
+                 * Payout method options for the PayoutIntent.
+                 */
+                payout_method_options?: To.PayoutMethodOptions;
+                /**
+                 * The recipient ID. Only relevant for OutboundPayment.
+                 */
+                recipient?: 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;
+            }
+            interface ScheduleOptions {
+                /**
+                 * The date when the payout should be executed, in YYYY-MM-DD format.
+                 */
+                execute_on?: string;
+            }
+            namespace RecipientNotification {
+                type Setting = 'configured' | 'none';
+            }
+            namespace To {
+                interface PayoutMethodOptions {
+                    /**
+                     * Options for bank account payout methods.
+                     */
+                    bank_account?: PayoutMethodOptions.BankAccount;
+                }
+                namespace PayoutMethodOptions {
+                    interface BankAccount {
+                        /**
+                         * Per-network configuration options.
+                         */
+                        preferred_network_options?: BankAccount.PreferredNetworkOptions;
+                        /**
+                         * The preferred networks to use for this PayoutIntent.
+                         */
+                        preferred_networks: Array<BankAccount.PreferredNetwork>;
+                    }
+                    namespace BankAccount {
+                        interface PreferredNetworkOptions {
+                            /**
+                             * ACH-specific network options.
+                             */
+                            ach?: PreferredNetworkOptions.Ach;
+                        }
+                        type PreferredNetwork = 'ach' | 'becs' | 'eft' | 'fedwire' | 'fps' | 'npp' | 'rtp' | 'sepa_credit' | 'sepa_instant' | 'swift';
+                        namespace PreferredNetworkOptions {
+                            interface Ach {
+                                /**
+                                 * Open Enum. ACH submission timing.
+                                 */
+                                submission?: Ach.Submission;
+                                /**
+                                 * The transaction purpose for this ACH payment.
+                                 */
+                                transaction_purpose?: 'payroll';
+                            }
+                            namespace Ach {
+                                type Submission = 'next_day' | 'same_day';
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace MoneyManagement {
+        interface PayoutIntentRetrieveParams {
+        }
+    }
+}
+export declare namespace V2 {
+    namespace MoneyManagement {
+        interface PayoutIntentUpdateParams {
+            /**
+             * The monetary amount to be sent.
+             */
+            amount?: V2Amount;
+            /**
+             * An arbitrary string attached to the PayoutIntent. Often useful for displaying to users.
+             */
+            description?: string;
+            /**
+             * From which FinancialAccount to pull funds.
+             */
+            from?: PayoutIntentUpdateParams.From;
+            /**
+             * 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?: MetadataParam;
+            /**
+             * Details about the OutboundPayment notification settings for recipient. Only applicable to OutboundPayment.
+             */
+            recipient_notification?: PayoutIntentUpdateParams.RecipientNotification;
+            /**
+             * Scheduling options for the payout. If this is nil, we assume immediate execution.
+             */
+            schedule_options?: PayoutIntentUpdateParams.ScheduleOptions;
+            /**
+             * The description that appears on the receiving end for the payout (for example, on a bank statement).
+             */
+            statement_descriptor?: string;
+            /**
+             * To which payout method the payout is sent.
+             */
+            to?: PayoutIntentUpdateParams.To;
+        }
+        namespace PayoutIntentUpdateParams {
+            interface From {
+                /**
+                 * The currency of the financial account.
+                 */
+                currency: string;
+                /**
+                 * The FinancialAccount that funds are 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;
+            }
+            interface ScheduleOptions {
+                /**
+                 * The date when the payout should be executed, in YYYY-MM-DD format.
+                 */
+                execute_on?: string;
+            }
+            interface To {
+                /**
+                 * The currency to send to the recipient.
+                 */
+                currency?: string;
+                /**
+                 * The payout method ID. Optional for OutboundPayment if recipient has default payment method. Required for OutboundTransfer.
+                 */
+                payout_method?: string;
+                /**
+                 * Payout method options for the PayoutIntent.
+                 */
+                payout_method_options?: To.PayoutMethodOptions;
+                /**
+                 * The recipient ID. Only relevant for OutboundPayment.
+                 */
+                recipient?: string;
+            }
+            namespace RecipientNotification {
+                type Setting = 'configured' | 'none';
+            }
+            namespace To {
+                interface PayoutMethodOptions {
+                    /**
+                     * Options for bank account payout methods.
+                     */
+                    bank_account?: PayoutMethodOptions.BankAccount;
+                }
+                namespace PayoutMethodOptions {
+                    interface BankAccount {
+                        /**
+                         * Per-network configuration options.
+                         */
+                        preferred_network_options?: BankAccount.PreferredNetworkOptions;
+                        /**
+                         * The preferred networks to use for this PayoutIntent.
+                         */
+                        preferred_networks: Array<BankAccount.PreferredNetwork>;
+                    }
+                    namespace BankAccount {
+                        interface PreferredNetworkOptions {
+                            /**
+                             * ACH-specific network options.
+                             */
+                            ach?: PreferredNetworkOptions.Ach;
+                        }
+                        type PreferredNetwork = 'ach' | 'becs' | 'eft' | 'fedwire' | 'fps' | 'npp' | 'rtp' | 'sepa_credit' | 'sepa_instant' | 'swift';
+                        namespace PreferredNetworkOptions {
+                            interface Ach {
+                                /**
+                                 * Open Enum. ACH submission timing.
+                                 */
+                                submission?: Ach.Submission;
+                                /**
+                                 * The transaction purpose for this ACH payment.
+                                 */
+                                transaction_purpose?: 'payroll';
+                            }
+                            namespace Ach {
+                                type Submission = 'next_day' | 'same_day';
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace MoneyManagement {
+        interface PayoutIntentListParams {
+            /**
+             * Maximum number of objects to return. Defaults to 10. Maximum is 100.
+             */
+            limit?: number;
+        }
+    }
+}
+export declare namespace V2 {
+    namespace MoneyManagement {
+        interface PayoutIntentCancelParams {
+        }
+    }
+}

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

@@ -0,0 +1,44 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PayoutIntentResource = void 0;
+const StripeResource_js_1 = require("../../../StripeResource.js");
+class PayoutIntentResource extends StripeResource_js_1.StripeResource {
+    /**
+     * Returns a list of PayoutIntents.
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v2/money_management/payout_intents', params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * Creates a PayoutIntent.
+     * @throws Stripe.FeatureNotEnabledError
+     */
+    create(params, options) {
+        return this._makeRequest('POST', '/v2/money_management/payout_intents', params, options);
+    }
+    /**
+     * Retrieves the details of an existing PayoutIntent by passing the unique PayoutIntent ID.
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v2/money_management/payout_intents/${encodeURIComponent(id)}`, params, options);
+    }
+    /**
+     * Updates a PayoutIntent. Only pending or requires_action PayoutIntents that are editable can be updated.
+     * @throws Stripe.FeatureNotEnabledError
+     */
+    update(id, params, options) {
+        return this._makeRequest('POST', `/v2/money_management/payout_intents/${encodeURIComponent(id)}`, params, options);
+    }
+    /**
+     * Cancels a PayoutIntent. Only pending PayoutIntents or processing PayoutIntents with cancelable OutboundPayment/Transfer can be canceled.
+     * @throws Stripe.NotCancelableError
+     */
+    cancel(id, params, options) {
+        return this._makeRequest('POST', `/v2/money_management/payout_intents/${encodeURIComponent(id)}/cancel`, params, options);
+    }
+}
+exports.PayoutIntentResource = PayoutIntentResource;
+//# sourceMappingURL=PayoutIntents.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PayoutIntents.js","sourceRoot":"","sources":["../../../../src/resources/V2/MoneyManagement/PayoutIntents.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,kEAA0D;AAK1D,MAAa,oBAAqB,SAAQ,kCAAc;IACtD;;OAEG;IACH,IAAI,CACF,MAAkD,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,qCAAqC,EACrC,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;IACD;;;OAGG;IACH,MAAM,CACJ,MAAmD,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,qCAAqC,EACrC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAsD,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,uCAAuC,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC/D,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;OAGG;IACH,MAAM,CACJ,EAAU,EACV,MAAoD,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uCAAuC,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC/D,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;OAGG;IACH,MAAM,CACJ,EAAU,EACV,MAAoD,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uCAAuC,kBAAkB,CAAC,EAAE,CAAC,SAAS,EACtE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AAhFD,oDAgFC"}