stripe 19.3.0 → 19.4.0-alpha.1

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

@@ -0,0 +1,186 @@
+// 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;
+
+          /**
+           * 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;
+
+          /**
+           * The amount and currency of the original/external debit request.
+           */
+          external_amount?: Amount;
+
+          /**
+           * 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;
+
+          /**
+           * Open Enum. The status of the ReceivedDebit.
+           */
+          status: ReceivedDebit.Status;
+
+          /**
+           * Detailed information about the status of the ReceivedDebit.
+           */
+          status_details?: ReceivedDebit.StatusDetails;
+
+          /**
+           * The time at which the ReceivedDebit transitioned to a particular status.
+           */
+          status_transitions?: ReceivedDebit.StatusTransitions;
+
+          /**
+           * 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. Indicates the origin type through which this debit was initiated.
+             */
+            origin_type: 'us_bank_account';
+
+            /**
+             * 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;
+
+            /**
+             * 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;
+
+              /**
+               * 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;
+            }
+          }
+
+          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;
+
+            /**
+             * 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;
+
+            /**
+             * 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;
+          }
+
+          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/RecipientVerifications.d.ts

@@ -0,0 +1,112 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        /**
+         * RecipientVerification represents a verification of recipient you intend to send funds to.
+         */
+        interface RecipientVerification {
+          /**
+           * The ID of the RecipientVerification.
+           */
+          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.recipient_verification';
+
+          /**
+           * The OBP/OBT ID that consumed this verification, present if one is successfully created.
+           */
+          consumed_by?: string;
+
+          /**
+           * Time at which the RecipientVerification was created.
+           * Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+           */
+          created: string;
+
+          /**
+           * Time at which the RecipientVerification expires, 5 minutes after the creation.
+           * Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+           */
+          expires_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;
+
+          /**
+           * Closed Enum. Match level of the RecipientVerification: `match`, `close_match`, `no_match`, `unavailable`.
+           */
+          match_result: RecipientVerification.MatchResult;
+
+          /**
+           * Details for the match result.
+           */
+          match_result_details: RecipientVerification.MatchResultDetails;
+
+          /**
+           * Closed Enum. Current status of the RecipientVerification: `verified`, `consumed`, `expired`, `awaiting_acknowledgement`, `acknowledged`.
+           */
+          status: RecipientVerification.Status;
+
+          /**
+           * Hash containing timestamps of when the object transitioned to a particular status.
+           */
+          status_transitions?: RecipientVerification.StatusTransitions;
+        }
+
+        namespace RecipientVerification {
+          type MatchResult =
+            | 'close_match'
+            | 'match'
+            | 'no_match'
+            | 'unavailable';
+
+          interface MatchResultDetails {
+            /**
+             * The account name associated with the bank account as provided by the VoP provider, only present if there is a match or close match.
+             */
+            matched_name?: string;
+
+            /**
+             * A message describing the match result.
+             */
+            message: string;
+
+            /**
+             * The name associated with the provided recipient.
+             */
+            provided_name: string;
+          }
+
+          type Status =
+            | 'acknowledged'
+            | 'awaiting_acknowledgement'
+            | 'consumed'
+            | 'expired'
+            | 'verified';
+
+          interface StatusTransitions {
+            /**
+             * Timestamp describing when a RecipientVerification changed status to `acknowledged`.
+             * Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+             */
+            acknowledged_at?: string;
+
+            /**
+             * Timestamp describing when a RecipientVerification changed status to `consumed`.
+             * Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+             */
+            consumed_at?: string;
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,77 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        interface RecipientVerificationCreateParams {
+          /**
+           * ID of the payout method.
+           */
+          payout_method: string;
+
+          /**
+           * ID of the recipient account. Required if the recipient distinct from the sender. Leave empty if the recipient and sender are the same entity (i.e. for me-to-me payouts).
+           */
+          recipient?: string;
+        }
+      }
+
+      namespace MoneyManagement {
+        interface RecipientVerificationRetrieveParams {}
+      }
+
+      namespace MoneyManagement {
+        interface RecipientVerificationAcknowledgeParams {}
+      }
+
+      namespace MoneyManagement {
+        class RecipientVerificationsResource {
+          /**
+           * Creates a RecipientVerification to verify the recipient you intend to send funds to.
+           */
+          create(
+            params: RecipientVerificationCreateParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.RecipientVerification>
+          >;
+
+          /**
+           * Retrieves the details of an existing RecipientVerification by passing the unique RecipientVerification ID.
+           */
+          retrieve(
+            id: string,
+            params?: RecipientVerificationRetrieveParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.RecipientVerification>
+          >;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.RecipientVerification>
+          >;
+
+          /**
+           * Acknowledges an existing RecipientVerification. Only RecipientVerification awaiting acknowledgement can be acknowledged.
+           */
+          acknowledge(
+            id: string,
+            params?: RecipientVerificationAcknowledgeParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.RecipientVerification>
+          >;
+          acknowledge(
+            id: string,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.RecipientVerification>
+          >;
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,162 @@
+// 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'
+              | 'currency_conversion'
+              | '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;
+
+              /**
+               * In the future, this will be the ID of the currency conversion that created this Transaction. For now, this field is always null.
+               */
+              currency_conversion?: string;
+
+              /**
+               * If applicable, the ID of the FeeTransaction that created this Transaction.
+               */
+              fee_transaction?: string;
+
+              /**
+               * If applicable, the ID of the InboundTransfer that created this Transaction.
+               */
+              inbound_transfer?: string;
+
+              /**
+               * If applicable, the ID of the OutboundPayment that created this Transaction.
+               */
+              outbound_payment?: string;
+
+              /**
+               * If applicable, the ID of the OutboundTransfer that created this Transaction.
+               */
+              outbound_transfer?: string;
+
+              /**
+               * If applicable, the ID of the ReceivedCredit that created this Transaction.
+               */
+              received_credit?: string;
+
+              /**
+               * If applicable, the ID of the ReceivedDebit that created this Transaction.
+               */
+              received_debit?: string;
+            }
+
+            namespace Flow {
+              type Type =
+                | 'adjustment'
+                | 'currency_conversion'
+                | 'fee_transaction'
+                | 'inbound_transfer'
+                | 'outbound_payment'
+                | 'outbound_transfer'
+                | 'received_credit'
+                | 'received_debit';
+            }
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,82 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace MoneyManagement {
+        interface TransactionEntryRetrieveParams {}
+      }
+
+      namespace MoneyManagement {
+        interface TransactionEntryListParams {
+          /**
+           * Filter for Transactions created at an exact time.
+           */
+          created?: string;
+
+          /**
+           * Filter for Transactions created after the specified timestamp.
+           */
+          created_gt?: string;
+
+          /**
+           * Filter for Transactions created at or after the specified timestamp.
+           */
+          created_gte?: string;
+
+          /**
+           * Filter for Transactions created before the specified timestamp.
+           */
+          created_lt?: string;
+
+          /**
+           * Filter for Transactions created at or before the specified timestamp.
+           */
+          created_lte?: string;
+
+          /**
+           * The page limit.
+           */
+          limit?: number;
+
+          /**
+           * Filter for TransactionEntries belonging to a Transaction.
+           */
+          transaction?: string;
+        }
+      }
+
+      namespace MoneyManagement {
+        class TransactionEntriesResource {
+          /**
+           * Retrieves the details of a TransactionEntry by ID.
+           */
+          retrieve(
+            id: string,
+            params?: TransactionEntryRetrieveParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.TransactionEntry>
+          >;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.TransactionEntry>
+          >;
+
+          /**
+           * Returns a list of TransactionEntries that match the provided filters.
+           */
+          list(
+            params?: TransactionEntryListParams,
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.TransactionEntry>;
+          list(
+            options?: RequestOptions
+          ): ApiListPromise<Stripe.V2.MoneyManagement.TransactionEntry>;
+        }
+      }
+    }
+  }
+}