stripe 18.2.0 → 18.3.0-beta.1

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

@@ -0,0 +1,243 @@
+// 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 Stripe Money Movement that originated the ReceivedCredit.
+             */
+            payout_v1: string;
+
+            /**
+             * Open Enum. The type of Stripe Money Movement that originated the ReceivedCredit.
+             */
+            type: '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>;
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,176 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        /**
+         * ReceivedDebit resource
+         */
+        interface ReceivedDebit {
+          /**
+           * Unique identifier for the ReceivedDebit.
+           */
+          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_debit';
+
+          /**
+           * Amount and currency of the ReceivedDebit.
+           */
+          amount: Amount;
+
+          /**
+           * This object stores details about the originating banking transaction that resulted in the ReceivedDebit. Present if `type` field value is `bank_transfer`.
+           */
+          bank_transfer: ReceivedDebit.BankTransfer | null;
+
+          /**
+           * The time at which the ReceivedDebit 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 sent by the originator of the ReceivedDebit.
+           */
+          description: string | null;
+
+          /**
+           * Financial Account on which funds for ReceivedDebit were debited.
+           */
+          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 link to the Stripe-hosted receipt for this ReceivedDebit.
+           */
+          receipt_url: string | null;
+
+          /**
+           * Open Enum. The status of the ReceivedDebit.
+           */
+          status: ReceivedDebit.Status;
+
+          /**
+           * Detailed information about the status of the ReceivedDebit.
+           */
+          status_details: ReceivedDebit.StatusDetails | null;
+
+          /**
+           * The time at which the ReceivedDebit transitioned to a particular status.
+           */
+          status_transitions: ReceivedDebit.StatusTransitions | null;
+
+          /**
+           * Open Enum. The type of the ReceivedDebit.
+           */
+          type: ReceivedDebit.Type;
+        }
+
+        namespace ReceivedDebit {
+          interface BankTransfer {
+            /**
+             * The Financial Address that was debited.
+             */
+            financial_address: string;
+
+            /**
+             * Open Enum. The type of the payment method used to originate the debit.
+             */
+            payment_method_type: 'us_bank_account';
+
+            /**
+             * The statement descriptor set by the originator of the debit.
+             */
+            statement_descriptor: string | null;
+
+            /**
+             * The payment method used to originate the debit.
+             */
+            us_bank_account: BankTransfer.UsBankAccount;
+          }
+
+          namespace BankTransfer {
+            interface UsBankAccount {
+              /**
+               * The name of the bank the debit originated from.
+               */
+              bank_name: string | null;
+
+              /**
+               * Open Enum. The bank network the debit was originated on.
+               */
+              network: 'ach';
+
+              /**
+               * The routing number of the bank that originated the debit.
+               */
+              routing_number: string | null;
+            }
+          }
+
+          type Status =
+            | 'canceled'
+            | 'failed'
+            | 'pending'
+            | 'returned'
+            | 'succeeded';
+
+          interface StatusDetails {
+            /**
+             * Information that elaborates on the `failed` status of a ReceivedDebit.
+             * It is only present when the ReceivedDebit status is `failed`.
+             */
+            failed: StatusDetails.Failed;
+          }
+
+          namespace StatusDetails {
+            interface Failed {
+              /**
+               * Open Enum. The reason for the failure of the ReceivedDebit.
+               */
+              reason: Failed.Reason;
+            }
+
+            namespace Failed {
+              type Reason =
+                | 'financial_address_inactive'
+                | 'insufficient_funds'
+                | 'stripe_rejected';
+            }
+          }
+
+          interface StatusTransitions {
+            /**
+             * The time when the ReceivedDebit was marked as `canceled`.
+             * Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: `2022-09-18T13:22:18.123Z`.
+             */
+            canceled_at: string | null;
+
+            /**
+             * The time when the ReceivedDebit 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;
+
+            /**
+             * The time when the ReceivedDebit 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 = 'bank_transfer' | 'external_debit';
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,48 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        interface ReceivedDebitRetrieveParams {}
+      }
+
+      namespace MoneyManagement {
+        interface ReceivedDebitListParams {
+          /**
+           * The page limit.
+           */
+          limit?: number;
+        }
+      }
+
+      namespace MoneyManagement {
+        class ReceivedDebitsResource {
+          /**
+           * Retrieves a single ReceivedDebit by ID.
+           */
+          retrieve(
+            id: string,
+            params?: ReceivedDebitRetrieveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.ReceivedDebit>>;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.MoneyManagement.ReceivedDebit>>;
+
+          /**
+           * Retrieves a list of ReceivedDebits, given the selected filters.
+           */
+          list(
+            params?: ReceivedDebitListParams,
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.ReceivedDebit>;
+          list(
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.ReceivedDebit>;
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,155 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        /**
+         * TransactionEntries represent individual money movements across different states within a Transaction.
+         */
+        interface TransactionEntry {
+          /**
+           * Unique identifier for the 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.transaction_entry';
+
+          /**
+           * The delta to the FinancialAccount's balance.
+           */
+          balance_impact: TransactionEntry.BalanceImpact;
+
+          /**
+           * Time at which the object was created.
+           */
+          created: string;
+
+          /**
+           * Time at which the entry impacted (or will impact if it's in the future) the FinancialAccount balance.
+           */
+          effective_at: 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;
+
+          /**
+           * The Transaction that this TransactionEntry belongs to.
+           */
+          transaction: string;
+
+          /**
+           * Details copied from the transaction that this TransactionEntry belongs to.
+           */
+          transaction_details: TransactionEntry.TransactionDetails;
+        }
+
+        namespace TransactionEntry {
+          interface BalanceImpact {
+            /**
+             * Impact to the available balance.
+             */
+            available: Amount;
+
+            /**
+             * Impact to the inbound_pending balance.
+             */
+            inbound_pending: Amount;
+
+            /**
+             * Impact to the outbound_pending balance.
+             */
+            outbound_pending: Amount;
+          }
+
+          interface TransactionDetails {
+            /**
+             * Closed Enum for now, and will be turned into an Open Enum soon. A descriptive category used to classify the Transaction.
+             */
+            category: TransactionDetails.Category;
+
+            /**
+             * Indicates the FinancialAccount affected by this Transaction.
+             */
+            financial_account: string;
+
+            /**
+             * Details about the Flow object that created the Transaction.
+             */
+            flow: TransactionDetails.Flow;
+          }
+
+          namespace TransactionDetails {
+            type Category =
+              | 'adjustment'
+              | 'inbound_transfer'
+              | 'outbound_payment'
+              | 'outbound_transfer'
+              | 'received_credit'
+              | 'received_debit'
+              | 'return'
+              | 'stripe_fee';
+
+            interface Flow {
+              /**
+               * Open Enum. Type of the flow that created the Transaction. The field matching this value will contain the ID of the flow.
+               */
+              type: Flow.Type;
+
+              /**
+               * If applicable, the ID of the Adjustment that created this Transaction.
+               */
+              adjustment: string | null;
+
+              /**
+               * If applicable, the ID of the FeeTransaction that created this Transaction.
+               */
+              fee_transaction: string | null;
+
+              /**
+               * If applicable, the ID of the InboundTransfer that created this Transaction.
+               */
+              inbound_transfer: string | null;
+
+              /**
+               * If applicable, the ID of the OutboundPayment that created this Transaction.
+               */
+              outbound_payment: string | null;
+
+              /**
+               * If applicable, the ID of the OutboundTransfer that created this Transaction.
+               */
+              outbound_transfer: string | null;
+
+              /**
+               * If applicable, the ID of the ReceivedCredit that created this Transaction.
+               */
+              received_credit: string | null;
+
+              /**
+               * If applicable, the ID of the ReceivedDebit that created this Transaction.
+               */
+              received_debit: string | null;
+            }
+
+            namespace Flow {
+              type Type =
+                | 'adjustment'
+                | 'fee_transaction'
+                | 'inbound_transfer'
+                | 'outbound_payment'
+                | 'outbound_transfer'
+                | 'received_credit'
+                | 'received_debit';
+            }
+          }
+        }
+      }
+    }
+  }
+}