stripe 18.3.0 → 18.4.0-beta.2

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

@@ -0,0 +1,87 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        /**
+         * The PayoutMethodsBankAccountSpec object.
+         */
+        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;
+        }
+
+        namespace PayoutMethodsBankAccountSpec {
+          interface Countries {
+            /**
+             * The list of fields for a country, along with associated information.
+             */
+            fields: Array<Countries.Field>;
+          }
+
+          namespace Countries {
+            interface Field {
+              /**
+               * 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 {
+                content: string;
+
+                localization_key: string;
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,113 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        interface PayoutMethodRetrieveParams {}
+      }
+
+      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';
+          }
+        }
+      }
+
+      namespace MoneyManagement {
+        interface PayoutMethodArchiveParams {}
+      }
+
+      namespace MoneyManagement {
+        interface PayoutMethodUnarchiveParams {}
+      }
+
+      namespace MoneyManagement {
+        class PayoutMethodsResource {
+          /**
+           * Retrieve a PayoutMethod object.
+           * @throws Stripe.InvalidPayoutMethodError
+           */
+          retrieve(
+            id: string,
+            params?: PayoutMethodRetrieveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.PayoutMethod>>;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.PayoutMethod>>;
+
+          /**
+           * List objects that adhere to the PayoutMethod interface.
+           */
+          list(
+            params?: PayoutMethodListParams,
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.PayoutMethod>;
+          list(
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.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.InvalidPayoutMethodError
+           */
+          archive(
+            id: string,
+            params?: PayoutMethodArchiveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.PayoutMethod>>;
+          archive(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.PayoutMethod>>;
+
+          /**
+           * Unarchive an PayoutMethod object.
+           * @throws Stripe.ControlledByDashboardError
+           * @throws Stripe.InvalidPayoutMethodError
+           */
+          unarchive(
+            id: string,
+            params?: PayoutMethodUnarchiveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.PayoutMethod>>;
+          unarchive(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.PayoutMethod>>;
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,262 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        /**
+         * Use ReceivedCredits API to retrieve information on when, where, and how funds are sent into your FinancialAccount.
+         */
+        interface ReceivedCredit {
+          /**
+           * Unique identifier for the ReceivedCredit.
+           */
+          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.received_credit';
+
+          /**
+           * The amount and currency of the ReceivedCredit.
+           */
+          amount: Amount;
+
+          /**
+           * This object stores details about the originating Stripe transaction that resulted in the ReceivedCredit. Present if `type` field value is `balance_transfer`.
+           */
+          balance_transfer: ReceivedCredit.BalanceTransfer | null;
+
+          /**
+           * This object stores details about the originating banking transaction that resulted in the ReceivedCredit. Present if `type` field value is `external_credit`.
+           */
+          bank_transfer: ReceivedCredit.BankTransfer | null;
+
+          /**
+           * Time at which the ReceivedCredit was created.
+           * Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+           */
+          created: string;
+
+          /**
+           * Freeform string set by originator of the ReceivedCredit.
+           */
+          description: string | null;
+
+          /**
+           * Financial Account ID on which funds for ReceivedCredit were received.
+           */
+          financial_account: 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;
+
+          /**
+           * A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
+           */
+          receipt_url: string | null;
+
+          /**
+           * Open Enum. The status of the ReceivedCredit.
+           */
+          status: ReceivedCredit.Status;
+
+          /**
+           * This hash contains detailed information that elaborates on the specific status of the ReceivedCredit. e.g the reason behind a failure if the status is marked as `failed`.
+           */
+          status_details: ReceivedCredit.StatusDetails | null;
+
+          /**
+           * Hash containing timestamps of when the object transitioned to a particular status.
+           */
+          status_transitions: ReceivedCredit.StatusTransitions | null;
+
+          /**
+           * Open Enum. The type of flow that caused the ReceivedCredit.
+           */
+          type: ReceivedCredit.Type;
+        }
+
+        namespace ReceivedCredit {
+          interface BalanceTransfer {
+            /**
+             * The ID of the account that owns the source object originated the ReceivedCredit.
+             */
+            from_account: string | null;
+
+            /**
+             * Open Enum. The type of Stripe Money Movement that originated the ReceivedCredit.
+             */
+            type: BalanceTransfer.Type;
+
+            /**
+             * The ID of the outbound payment object that originated the ReceivedCredit.
+             */
+            outbound_payment: string | null;
+
+            /**
+             * The ID of the outbound transfer object that originated the ReceivedCredit.
+             */
+            outbound_transfer: string | null;
+
+            /**
+             * The ID of the payout object that originated the ReceivedCredit.
+             */
+            payout_v1: string | null;
+          }
+
+          namespace BalanceTransfer {
+            type Type = 'outbound_payment' | 'outbound_transfer' | 'payout_v1';
+          }
+
+          interface BankTransfer {
+            /**
+             * Financial Address on which funds for ReceivedCredit were received.
+             */
+            financial_address: string;
+
+            /**
+             * Open Enum. Indicates the type of source via from which external funds originated.
+             */
+            payment_method_type: BankTransfer.PaymentMethodType;
+
+            /**
+             * Freeform string set by originator of the external ReceivedCredit.
+             */
+            statement_descriptor: string | null;
+
+            /**
+             * Hash containing the transaction bank details. Present if `payment_method_type` field value is `gb_bank_account`.
+             */
+            gb_bank_account: BankTransfer.GbBankAccount | null;
+
+            /**
+             * Hash containing the transaction bank details. Present if `payment_method_type` field value is `us_bank_account`.
+             */
+            us_bank_account: BankTransfer.UsBankAccount | null;
+          }
+
+          namespace BankTransfer {
+            interface GbBankAccount {
+              /**
+               * The bank name the transfer was received from.
+               */
+              account_holder_name: string | null;
+
+              /**
+               * The bank name the transfer was received from.
+               */
+              bank_name: string | null;
+
+              /**
+               * The last 4 digits of the account number that originated the transfer.
+               */
+              last4: string | null;
+
+              /**
+               * Open Enum. The money transmission network used to send funds for this ReceivedCredit.
+               */
+              network: 'fps';
+
+              /**
+               * The sort code of the account that originated the transfer.
+               */
+              sort_code: string | null;
+            }
+
+            type PaymentMethodType = 'gb_bank_account' | 'us_bank_account';
+
+            interface UsBankAccount {
+              /**
+               * The bank name the transfer was received from.
+               */
+              bank_name: string | null;
+
+              /**
+               * The last 4 digits of the account number that originated the transfer.
+               */
+              last4: string | null;
+
+              /**
+               * Open Enum. The money transmission network used to send funds for this ReceivedCredit.
+               */
+              network: UsBankAccount.Network;
+
+              /**
+               * The routing number of the account that originated the transfer.
+               */
+              routing_number: string | null;
+            }
+
+            namespace UsBankAccount {
+              type Network = 'ach' | 'rtp' | 'us_domestic_wire';
+            }
+          }
+
+          type Status = 'failed' | 'pending' | 'returned' | 'succeeded';
+
+          interface StatusDetails {
+            /**
+             * Hash that provides additional information regarding the reason behind a `failed` ReceivedCredit status. It is only present when the ReceivedCredit status is `failed`.
+             */
+            failed: StatusDetails.Failed | null;
+
+            /**
+             * Hash that provides additional information regarding the reason behind a `returned` ReceivedCredit status. It is only present when the ReceivedCredit status is `returned`.
+             */
+            returned: StatusDetails.Returned | null;
+          }
+
+          namespace StatusDetails {
+            interface Failed {
+              /**
+               * Open Enum. The `failed` status reason.
+               */
+              reason: Failed.Reason;
+            }
+
+            namespace Failed {
+              type Reason =
+                | 'capability_inactive'
+                | 'currency_unsupported_on_financial_address'
+                | 'financial_address_inactive'
+                | 'stripe_rejected';
+            }
+
+            interface Returned {
+              /**
+               * Open Enum. The `returned` status reason.
+               */
+              reason: 'originator_initiated_reversal';
+            }
+          }
+
+          interface StatusTransitions {
+            /**
+             * Timestamp describing when the ReceivedCredit was marked as `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 the ReceivedCredit 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;
+
+            /**
+             * Timestamp describing when the ReceivedCredit was marked as `succeeded`.
+             * Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+             */
+            succeeded_at: string | null;
+          }
+
+          type Type = 'balance_transfer' | 'bank_transfer' | 'external_credit';
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,78 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        interface ReceivedCreditRetrieveParams {}
+      }
+
+      namespace MoneyManagement {
+        interface ReceivedCreditListParams {
+          /**
+           * Filter for objects created at the specified timestamp.
+           * Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
+           */
+          created?: string;
+
+          /**
+           * Filter for objects created after the specified timestamp.
+           * Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
+           */
+          created_gt?: string;
+
+          /**
+           * Filter for objects created on or after the specified timestamp.
+           * Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
+           */
+          created_gte?: string;
+
+          /**
+           * Filter for objects created before the specified timestamp.
+           * Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
+           */
+          created_lt?: string;
+
+          /**
+           * Filter for objects created on or before the specified timestamp.
+           * Must be an RFC 3339 date & time value, for example: 2022-09-18T13:22:00Z.
+           */
+          created_lte?: string;
+
+          /**
+           * The page limit.
+           */
+          limit?: number;
+        }
+      }
+
+      namespace MoneyManagement {
+        class ReceivedCreditsResource {
+          /**
+           * Retrieve a ReceivedCredit by ID.
+           */
+          retrieve(
+            id: string,
+            params?: ReceivedCreditRetrieveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.ReceivedCredit>>;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.ReceivedCredit>>;
+
+          /**
+           * Retrieves a list of ReceivedCredits.
+           */
+          list(
+            params?: ReceivedCreditListParams,
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.ReceivedCredit>;
+          list(
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.ReceivedCredit>;
+        }
+      }
+    }
+  }
+}