stripe 9.0.0 → 9.3.0

package/types/2020-08-27/Treasury/ReceivedDebits.d.ts

@@ -0,0 +1,231 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Treasury {
+      /**
+       * The ReceivedDebit object.
+       */
+      interface ReceivedDebit {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'treasury.received_debit';
+
+        /**
+         * Amount (in cents) transferred.
+         */
+        amount: number;
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+         */
+        currency: string;
+
+        /**
+         * An arbitrary string attached to the object. Often useful for displaying to users.
+         */
+        description: string;
+
+        /**
+         * Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen.
+         */
+        failure_code: ReceivedDebit.FailureCode | null;
+
+        /**
+         * The FinancialAccount that funds were pulled from.
+         */
+        financial_account: string | null;
+
+        initiating_payment_method_details?: ReceivedDebit.InitiatingPaymentMethodDetails;
+
+        linked_flows: ReceivedDebit.LinkedFlows;
+
+        /**
+         * 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 network used for the ReceivedDebit.
+         */
+        network: ReceivedDebit.Network;
+
+        /**
+         * Status of the ReceivedDebit. ReceivedDebits are created with a status of either `succeeded` (approved) or `failed` (declined). The failure reason can be found under the `failure_code`.
+         */
+        status: ReceivedDebit.Status;
+
+        /**
+         * The Transaction associated with this object.
+         */
+        transaction: string | Stripe.Treasury.Transaction | null;
+      }
+
+      namespace ReceivedDebit {
+        type FailureCode =
+          | 'account_closed'
+          | 'account_frozen'
+          | 'insufficient_funds'
+          | 'other';
+
+        interface InitiatingPaymentMethodDetails {
+          /**
+           * Set when `type` is `balance`.
+           */
+          balance?: 'payments';
+
+          billing_details: InitiatingPaymentMethodDetails.BillingDetails;
+
+          financial_account?: InitiatingPaymentMethodDetails.FinancialAccount;
+
+          /**
+           * Set when `type` is `issuing_card`. This is an [Issuing Card](https://stripe.com/docs/api#issuing_cards) ID.
+           */
+          issuing_card?: string;
+
+          /**
+           * Polymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount.
+           */
+          type: InitiatingPaymentMethodDetails.Type;
+
+          us_bank_account?: InitiatingPaymentMethodDetails.UsBankAccount;
+        }
+
+        namespace InitiatingPaymentMethodDetails {
+          interface BillingDetails {
+            address: Stripe.Address;
+
+            /**
+             * Email address.
+             */
+            email: string | null;
+
+            /**
+             * Full name.
+             */
+            name: string | null;
+          }
+
+          interface FinancialAccount {
+            /**
+             * The FinancialAccount ID.
+             */
+            id: string;
+
+            /**
+             * The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds over `stripe`.
+             */
+            network: 'stripe';
+          }
+
+          type Type =
+            | 'balance'
+            | 'financial_account'
+            | 'issuing_card'
+            | 'stripe'
+            | 'us_bank_account';
+
+          interface UsBankAccount {
+            /**
+             * Bank name.
+             */
+            bank_name: string | null;
+
+            /**
+             * The last four digits of the bank account number.
+             */
+            last4: string | null;
+
+            /**
+             * The routing number for the bank account.
+             */
+            routing_number: string | null;
+          }
+        }
+
+        interface LinkedFlows {
+          /**
+           * Set if the ReceivedDebit is associated with an InboundTransfer's return of funds.
+           */
+          inbound_transfer: string | null;
+
+          /**
+           * Set if the ReceivedCredit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object.
+           */
+          issuing_authorization: string | null;
+
+          /**
+           * Set if the ReceivedDebit is also viewable as an [Issuing Dispute](https://stripe.com/docs/api#issuing_disputes) object.
+           */
+          issuing_transaction: string | null;
+        }
+
+        type Network = 'ach' | 'card' | 'stripe';
+
+        type Status = 'failed' | 'succeeded';
+      }
+
+      interface ReceivedDebitRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface ReceivedDebitListParams extends PaginationParams {
+        /**
+         * The FinancialAccount that funds were pulled from.
+         */
+        financial_account: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Only return ReceivedDebits that have the given status: `succeeded` or `failed`.
+         */
+        status?: ReceivedDebitListParams.Status;
+      }
+
+      namespace ReceivedDebitListParams {
+        type Status = 'failed' | 'succeeded';
+      }
+
+      class ReceivedDebitsResource {
+        /**
+         * Retrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list
+         */
+        retrieve(
+          id: string,
+          params?: ReceivedDebitRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.ReceivedDebit>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.ReceivedDebit>>;
+
+        /**
+         * Returns a list of ReceivedDebits.
+         */
+        list(
+          params: ReceivedDebitListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Treasury.ReceivedDebit>;
+      }
+    }
+  }
+}

package/types/2020-08-27/Treasury/TransactionEntries.d.ts

@@ -0,0 +1,257 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Treasury {
+      /**
+       * The TransactionEntry object.
+       */
+      interface TransactionEntry {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'treasury.transaction_entry';
+
+        /**
+         * Change to a FinancialAccount's balance
+         */
+        balance_impact: TransactionEntry.BalanceImpact;
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+         */
+        currency: string;
+
+        /**
+         * When the TransactionEntry will impact the FinancialAccount's balance.
+         */
+        effective_at: number;
+
+        /**
+         * The FinancialAccount associated with this object.
+         */
+        financial_account: string;
+
+        /**
+         * Token of the flow associated with the TransactionEntry.
+         */
+        flow: string | null;
+
+        /**
+         * Details of the flow associated with the TransactionEntry.
+         */
+        flow_details: TransactionEntry.FlowDetails | null;
+
+        /**
+         * Type of the flow associated with the TransactionEntry.
+         */
+        flow_type: TransactionEntry.FlowType;
+
+        /**
+         * 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 associated with this object.
+         */
+        transaction: string | Stripe.Treasury.Transaction;
+
+        /**
+         * The specific money movement that generated the TransactionEntry.
+         */
+        type: TransactionEntry.Type;
+      }
+
+      namespace TransactionEntry {
+        interface BalanceImpact {
+          /**
+           * The change made to funds the user can spend right now.
+           */
+          cash: number;
+
+          /**
+           * The change made to funds that are not spendable yet, but will become available at a later time.
+           */
+          inbound_pending: number;
+
+          /**
+           * The change made to funds in the account, but not spendable because they are being held for pending outbound flows.
+           */
+          outbound_pending: number;
+        }
+
+        interface FlowDetails {
+          /**
+           * You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.
+           */
+          credit_reversal?: Stripe.Treasury.CreditReversal;
+
+          /**
+           * You can reverse some [ReceivedDebits](https://stripe.com/docs/api#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.
+           */
+          debit_reversal?: Stripe.Treasury.DebitReversal;
+
+          /**
+           * Use InboundTransfers to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.
+           */
+          inbound_transfer?: Stripe.Treasury.InboundTransfer;
+
+          /**
+           * When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization`
+           * object is created. [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) must be approved for the
+           * purchase to be completed successfully.
+           *
+           * Related guide: [Issued Card Authorizations](https://stripe.com/docs/issuing/purchases/authorizations).
+           */
+          issuing_authorization?: Stripe.Issuing.Authorization;
+
+          /**
+           * Use OutboundPayments to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).
+           *
+           * Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.
+           */
+          outbound_payment?: Stripe.Treasury.OutboundPayment;
+
+          /**
+           * Use OutboundTransfers to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.
+           *
+           * Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.
+           */
+          outbound_transfer?: Stripe.Treasury.OutboundTransfer;
+
+          /**
+           * ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.
+           */
+          received_credit?: Stripe.Treasury.ReceivedCredit;
+
+          /**
+           * ReceivedDebits represent funds pulled from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts). These are not initiated from the FinancialAccount.
+           */
+          received_debit?: Stripe.Treasury.ReceivedDebit;
+
+          /**
+           * Type of the flow that created the Transaction. Set to the same value as `flow_type`.
+           */
+          type: FlowDetails.Type;
+        }
+
+        namespace FlowDetails {
+          type Type =
+            | 'credit_reversal'
+            | 'debit_reversal'
+            | 'inbound_transfer'
+            | 'issuing_authorization'
+            | 'other'
+            | 'outbound_payment'
+            | 'outbound_transfer'
+            | 'received_credit'
+            | 'received_debit';
+        }
+
+        type FlowType =
+          | 'credit_reversal'
+          | 'debit_reversal'
+          | 'inbound_transfer'
+          | 'issuing_authorization'
+          | 'other'
+          | 'outbound_payment'
+          | 'outbound_transfer'
+          | 'received_credit'
+          | 'received_debit';
+
+        type Type =
+          | 'credit_reversal'
+          | 'credit_reversal_posting'
+          | 'debit_reversal'
+          | 'inbound_transfer'
+          | 'inbound_transfer_return'
+          | 'issuing_authorization_hold'
+          | 'issuing_authorization_release'
+          | 'other'
+          | 'outbound_payment'
+          | 'outbound_payment_cancellation'
+          | 'outbound_payment_failure'
+          | 'outbound_payment_posting'
+          | 'outbound_payment_return'
+          | 'outbound_transfer'
+          | 'outbound_transfer_cancellation'
+          | 'outbound_transfer_failure'
+          | 'outbound_transfer_posting'
+          | 'outbound_transfer_return'
+          | 'received_credit'
+          | 'received_debit';
+      }
+
+      interface TransactionEntryRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface TransactionEntryListParams extends PaginationParams {
+        /**
+         * Returns objects associated with this FinancialAccount.
+         */
+        financial_account: string;
+
+        created?: Stripe.RangeQueryParam | number;
+
+        effective_at?: Stripe.RangeQueryParam | number;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * The results are in reverse chronological order by `created` or `effective_at`. The default is `created`.
+         */
+        order_by?: TransactionEntryListParams.OrderBy;
+
+        /**
+         * Only return TransactionEntries associated with this Transaction.
+         */
+        transaction?: string;
+      }
+
+      namespace TransactionEntryListParams {
+        type OrderBy = 'created' | 'effective_at';
+      }
+
+      class TransactionEntriesResource {
+        /**
+         * Retrieves a TransactionEntry object.
+         */
+        retrieve(
+          id: string,
+          params?: TransactionEntryRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.TransactionEntry>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Treasury.TransactionEntry>>;
+
+        /**
+         * Retrieves a list of TransactionEntry objects.
+         */
+        list(
+          params: TransactionEntryListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Treasury.TransactionEntry>;
+      }
+    }
+  }
+}