stripe 22.3.0 → 22.4.0-alpha.2

package/esm/resources/V2/MoneyManagement/PayoutMethods.d.ts

@@ -0,0 +1,266 @@
+import { StripeResource } from '../../../StripeResource.js';
+import { RequestOptions, V2ListPromise, Response } from '../../../lib.js';
+export declare class PayoutMethodResource extends StripeResource {
+    /**
+     * List objects that adhere to the PayoutMethod interface.
+     */
+    list(params?: V2.MoneyManagement.PayoutMethodListParams, options?: RequestOptions): V2ListPromise<PayoutMethod>;
+    /**
+     * Retrieve a PayoutMethod object.
+     * @throws Stripe.InvalidPayoutMethodError
+     */
+    retrieve(id: string, params?: V2.MoneyManagement.PayoutMethodRetrieveParams, options?: RequestOptions): Promise<Response<PayoutMethod>>;
+    /**
+     * Archive a PayoutMethod object. Archived objects cannot be used as payout methods
+     * and will not appear in the payout method list.
+     * @throws Stripe.ControlledByDashboardError
+     * @throws Stripe.CannotProceedError
+     * @throws Stripe.InvalidPayoutMethodError
+     * @throws Stripe.ControlledByAlternateResourceError
+     */
+    archive(id: string, params?: V2.MoneyManagement.PayoutMethodArchiveParams, options?: RequestOptions): Promise<Response<PayoutMethod>>;
+    /**
+     * Unarchive an PayoutMethod object.
+     * @throws Stripe.ControlledByDashboardError
+     * @throws Stripe.InvalidPayoutMethodError
+     * @throws Stripe.ControlledByAlternateResourceError
+     */
+    unarchive(id: string, params?: V2.MoneyManagement.PayoutMethodUnarchiveParams, options?: RequestOptions): Promise<Response<PayoutMethod>>;
+}
+export interface PayoutMethod {
+    /**
+     * ID of the PayoutMethod object.
+     */
+    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_method';
+    /**
+     * The alternative reference for this payout method, if it's a projected payout method.
+     */
+    alternative_reference?: PayoutMethod.AlternativeReference;
+    /**
+     * A set of available payout speeds for this payout method.
+     */
+    available_payout_speeds: Array<PayoutMethod.AvailablePayoutSpeed>;
+    /**
+     * The PayoutMethodBankAccount object details.
+     */
+    bank_account?: PayoutMethod.BankAccount;
+    /**
+     * The PayoutMethodCard object details.
+     */
+    card?: PayoutMethod.Card;
+    /**
+     * Created timestamp.
+     */
+    created: string;
+    /**
+     * The PayoutMethodCryptoWallet object details.
+     */
+    crypto_wallet?: PayoutMethod.CryptoWallet;
+    /**
+     * ID of the underlying active OutboundSetupIntent object, if any.
+     */
+    latest_outbound_setup_intent?: 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;
+    /**
+     * Whether the Payout Method is currently unusable for money movement, despite potentially being correctly set up.
+     * Please reach out to Stripe Support for more information.
+     */
+    restricted: boolean;
+    /**
+     * Closed Enum. The type of payout method.
+     */
+    type: PayoutMethod.Type;
+    /**
+     * Indicates whether the payout method has met the necessary requirements for outbound money movement.
+     */
+    usage_status: PayoutMethod.UsageStatus;
+}
+export declare namespace PayoutMethod {
+    interface AlternativeReference {
+        /**
+         * The ID of the alternative resource being referenced.
+         */
+        id: string;
+        /**
+         * The type of the alternative reference (e.g., external_account for V1 external accounts).
+         */
+        type: AlternativeReference.Type;
+    }
+    type AvailablePayoutSpeed = 'instant' | 'standard';
+    interface BankAccount {
+        /**
+         * Whether this PayoutMethodBankAccount object was archived. PayoutMethodBankAccount objects can be archived through
+         * the /archive API, and they will not be automatically archived by Stripe. Archived PayoutMethodBankAccount objects
+         * cannot be used as payout methods and will not appear in the payout method list.
+         */
+        archived: boolean;
+        /**
+         * The type of bank account (checking or savings).
+         */
+        bank_account_type: BankAccount.BankAccountType;
+        /**
+         * The name of the bank this bank account is in. This field is populated automatically by Stripe.
+         */
+        bank_name: string;
+        /**
+         * The branch number of the bank account, if present.
+         */
+        branch_number?: string;
+        /**
+         * The country code of the bank account.
+         */
+        country: string;
+        /**
+         * List of enabled flows for this bank account (wire or local).
+         */
+        enabled_delivery_options: Array<string>;
+        /**
+         * The ID of the Financial Connections Account used to create the bank account.
+         */
+        financial_connections_account?: string;
+        /**
+         * The last 4 digits of the account number.
+         */
+        last4: string;
+        /**
+         * The routing number of the bank account, if present.
+         */
+        routing_number?: string;
+        /**
+         * The list of currencies supported by this bank account.
+         */
+        supported_currencies: Array<string>;
+        /**
+         * The swift code of the bank or financial institution.
+         */
+        swift_code?: string;
+    }
+    interface Card {
+        /**
+         * Whether the PayoutMethodCard object was archived. PayoutMethodCard objects can be archived through
+         * the /archive API, and they will not be automatically archived by Stripe. Archived PayoutMethodCard objects
+         * cannot be used as payout methods and will not appear in the payout method list.
+         */
+        archived: boolean;
+        /**
+         * The month the card expires.
+         */
+        exp_month: string;
+        /**
+         * The year the card expires.
+         */
+        exp_year: string;
+        /**
+         * Uniquely identifies this particular card number. You can use this attribute to check whether two
+         * recipients who've signed up with you are using the same card number, for example.
+         */
+        fingerprint: string;
+        /**
+         * The last 4 digits of the card number.
+         */
+        last4: string;
+        /**
+         * The list of currencies supported by this bank account.
+         */
+        supported_currencies: Array<string>;
+    }
+    interface CryptoWallet {
+        /**
+         * Destination wallet address.
+         */
+        address: string;
+        /**
+         * Whether the crypto wallet was archived. Crypto wallets can be archived through the /archive API,
+         * and they will not be automatically archived by Stripe. Archived crypto wallets cannot be used as
+         * payout method and will not appear in the payout method list.
+         */
+        archived: boolean;
+        /**
+         * Optional field, required if network supports memos (only "stellar" currently).
+         */
+        memo?: string;
+        /**
+         * Which rail is being used to make an outbound money movement to this wallet.
+         */
+        network: CryptoWallet.Network;
+    }
+    type Type = 'bank_account' | 'card' | 'crypto_wallet';
+    interface UsageStatus {
+        /**
+         * Payments status - used when sending OutboundPayments (sending funds to recipients).
+         */
+        payments: UsageStatus.Payments;
+        /**
+         * Transfers status - used when making an OutboundTransfer (sending funds to yourself).
+         */
+        transfers: UsageStatus.Transfers;
+    }
+    namespace AlternativeReference {
+        type Type = 'external_account' | 'payment_method';
+    }
+    namespace BankAccount {
+        type BankAccountType = 'checking' | 'futsu' | 'savings' | 'toza';
+    }
+    namespace CryptoWallet {
+        type Network = 'arbitrum' | 'avalanche_c_chain' | 'base' | 'ethereum' | 'optimism' | 'polygon' | 'solana' | 'stellar' | 'tempo';
+    }
+    namespace UsageStatus {
+        type Payments = 'eligible' | 'invalid' | 'requires_action';
+        type Transfers = 'eligible' | 'invalid' | 'requires_action';
+    }
+}
+export declare namespace V2 {
+    namespace MoneyManagement {
+        interface PayoutMethodRetrieveParams {
+        }
+    }
+}
+export declare namespace V2 {
+    namespace MoneyManagement {
+        interface PayoutMethodListParams {
+            /**
+             * The page size.
+             */
+            limit?: number;
+            /**
+             * Usage status filter.
+             */
+            usage_status?: PayoutMethodListParams.UsageStatus;
+        }
+        namespace PayoutMethodListParams {
+            interface UsageStatus {
+                /**
+                 * List of payments status to filter by.
+                 */
+                payments?: Array<UsageStatus.Payment>;
+                /**
+                 * List of transfers status to filter by.
+                 */
+                transfers?: Array<UsageStatus.Transfer>;
+            }
+            namespace UsageStatus {
+                type Payment = 'eligible' | 'invalid' | 'requires_action';
+                type Transfer = 'eligible' | 'invalid' | 'requires_action';
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace MoneyManagement {
+        interface PayoutMethodArchiveParams {
+        }
+    }
+}
+export declare namespace V2 {
+    namespace MoneyManagement {
+        interface PayoutMethodUnarchiveParams {
+        }
+    }
+}

package/esm/resources/V2/MoneyManagement/PayoutMethods.js

@@ -0,0 +1,40 @@
+// File generated from our OpenAPI spec
+import { StripeResource } from '../../../StripeResource.js';
+export class PayoutMethodResource extends StripeResource {
+    /**
+     * List objects that adhere to the PayoutMethod interface.
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v2/money_management/payout_methods', params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * Retrieve a PayoutMethod object.
+     * @throws Stripe.InvalidPayoutMethodError
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v2/money_management/payout_methods/${encodeURIComponent(id)}`, params, options);
+    }
+    /**
+     * Archive a PayoutMethod object. Archived objects cannot be used as payout methods
+     * and will not appear in the payout method list.
+     * @throws Stripe.ControlledByDashboardError
+     * @throws Stripe.CannotProceedError
+     * @throws Stripe.InvalidPayoutMethodError
+     * @throws Stripe.ControlledByAlternateResourceError
+     */
+    archive(id, params, options) {
+        return this._makeRequest('POST', `/v2/money_management/payout_methods/${encodeURIComponent(id)}/archive`, params, options);
+    }
+    /**
+     * Unarchive an PayoutMethod object.
+     * @throws Stripe.ControlledByDashboardError
+     * @throws Stripe.InvalidPayoutMethodError
+     * @throws Stripe.ControlledByAlternateResourceError
+     */
+    unarchive(id, params, options) {
+        return this._makeRequest('POST', `/v2/money_management/payout_methods/${encodeURIComponent(id)}/unarchive`, params, options);
+    }
+}
+//# sourceMappingURL=PayoutMethods.js.map

package/esm/resources/V2/MoneyManagement/PayoutMethods.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PayoutMethods.js","sourceRoot":"","sources":["../../../../src/resources/V2/MoneyManagement/PayoutMethods.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAEvC,OAAO,EAAC,cAAc,EAAC,MAAM,4BAA4B,CAAC;AAG1D,MAAM,OAAO,oBAAqB,SAAQ,cAAc;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,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;;;;;;;OAOG;IACH,OAAO,CACL,EAAU,EACV,MAAqD,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uCAAuC,kBAAkB,CAAC,EAAE,CAAC,UAAU,EACvE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;OAKG;IACH,SAAS,CACP,EAAU,EACV,MAAuD,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,uCAAuC,kBAAkB,CAAC,EAAE,CAAC,YAAY,EACzE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF"}

package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts

@@ -0,0 +1,92 @@
+import { StripeResource } from '../../../StripeResource.js';
+import { RequestOptions, Response } from '../../../lib.js';
+export declare class PayoutMethodsBankAccountSpecResource extends StripeResource {
+    /**
+     * Fetch the specifications for a set of countries to know which
+     * credential fields are required, the validations for each fields, and how to translate these
+     * country-specific fields to the generic fields in the PayoutMethodBankAccount type.
+     */
+    retrieve(params?: V2.MoneyManagement.PayoutMethodsBankAccountSpecRetrieveParams, options?: RequestOptions): Promise<Response<PayoutMethodsBankAccountSpec>>;
+}
+export interface PayoutMethodsBankAccountSpec {
+    /**
+     * String representing the object's type. Objects of the same type share the same value of the object field.
+     */
+    object: 'v2.money_management.payout_methods_bank_account_spec';
+    /**
+     * The list of specs by country.
+     */
+    countries: {
+        [key: string]: PayoutMethodsBankAccountSpec.Countries;
+    };
+    /**
+     * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+     */
+    livemode: boolean;
+}
+export declare namespace PayoutMethodsBankAccountSpec {
+    interface Countries {
+        /**
+         * The list of fields for a country, along with associated information.
+         */
+        fields: Array<Countries.Field>;
+    }
+    namespace Countries {
+        interface Field {
+            /**
+             * The currencies supported by the corresponding credentials for bank accounts in the specified country.
+             */
+            currencies?: Array<string>;
+            /**
+             * The local name of the field.
+             */
+            local_name: string;
+            /**
+             * The human readable local name of the field.
+             */
+            local_name_human: Field.LocalNameHuman;
+            /**
+             * The maximum length of the field.
+             */
+            max_length: number;
+            /**
+             * THe minimum length of the field.
+             */
+            min_length: number;
+            /**
+             * The placeholder value of the field.
+             */
+            placeholder: string;
+            /**
+             * The stripe name of the field.
+             */
+            stripe_name: string;
+            /**
+             * The validation regex of the field.
+             */
+            validation_regex: string;
+        }
+        namespace Field {
+            interface LocalNameHuman {
+                /**
+                 * The default content of the localizable string.
+                 */
+                content: string;
+                /**
+                 * A unique key representing the instance of this localizable string.
+                 */
+                localization_key: string;
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace MoneyManagement {
+        interface PayoutMethodsBankAccountSpecRetrieveParams {
+            /**
+             * The countries to fetch the bank account spec for.
+             */
+            countries?: Array<string>;
+        }
+    }
+}

package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js

@@ -0,0 +1,13 @@
+// File generated from our OpenAPI spec
+import { StripeResource } from '../../../StripeResource.js';
+export class PayoutMethodsBankAccountSpecResource extends StripeResource {
+    /**
+     * Fetch the specifications for a set of countries to know which
+     * credential fields are required, the validations for each fields, and how to translate these
+     * country-specific fields to the generic fields in the PayoutMethodBankAccount type.
+     */
+    retrieve(params, options) {
+        return this._makeRequest('GET', '/v2/money_management/payout_methods_bank_account_spec', params, options);
+    }
+}
+//# sourceMappingURL=PayoutMethodsBankAccountSpec.js.map

package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PayoutMethodsBankAccountSpec.js","sourceRoot":"","sources":["../../../../src/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAEvC,OAAO,EAAC,cAAc,EAAC,MAAM,4BAA4B,CAAC;AAG1D,MAAM,OAAO,oCAAqC,SAAQ,cAAc;IACtE;;;;OAIG;IACH,QAAQ,CACN,MAAsE,EACtE,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,uDAAuD,EACvD,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF"}