stripe 20.0.0 → 20.1.0-alpha.1

package/types/TestHelpers/Capital/FinancingOffersResource.d.ts

@@ -0,0 +1,130 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace TestHelpers {
+      namespace Capital {
+        interface FinancingOfferCreateParams {
+          /**
+           * Amount of financing offered, in minor units. For example, 1,000 USD is represented as 100000.
+           */
+          advance_amount: number;
+
+          /**
+           * Fixed fee amount, in minor units. For example, 100 USD is represented as 10000.
+           */
+          fee_amount: number;
+
+          /**
+           * The type of financing offer.
+           */
+          financing_type: FinancingOfferCreateParams.FinancingType;
+
+          /**
+           * Per-transaction rate at which Stripe withholds funds to repay the financing.
+           */
+          withhold_rate: number;
+
+          /**
+           * Specifies which fields in the response should be expanded.
+           */
+          expand?: Array<string>;
+
+          /**
+           * The status of the financing offer.
+           */
+          status?: FinancingOfferCreateParams.Status;
+        }
+
+        namespace FinancingOfferCreateParams {
+          type FinancingType = 'cash_advance' | 'fixed_term_loan' | 'flex_loan';
+
+          type Status =
+            | 'accepted'
+            | 'accepted_other_offer'
+            | 'canceled'
+            | 'completed'
+            | 'delivered'
+            | 'expired'
+            | 'fully_repaid'
+            | 'paid_out'
+            | 'rejected'
+            | 'replaced'
+            | 'undelivered';
+        }
+      }
+
+      namespace Capital {
+        interface FinancingOfferRefillParams {
+          /**
+           * Amount of financing offered, in minor units. For example, 1,000 USD is represented as 100000.
+           */
+          advance_amount: number;
+
+          /**
+           * Fixed fee amount, in minor units. For example, 100 USD is represented as 10000.
+           */
+          fee_amount: number;
+
+          /**
+           * The type of financing offer
+           */
+          financing_type: FinancingOfferRefillParams.FinancingType;
+
+          /**
+           * Per-transaction rate at which Stripe withholds funds to repay the financing.
+           */
+          withhold_rate: number;
+
+          /**
+           * Specifies which fields in the response should be expanded.
+           */
+          expand?: Array<string>;
+
+          /**
+           * The status of the financing offer
+           */
+          status?: FinancingOfferRefillParams.Status;
+        }
+
+        namespace FinancingOfferRefillParams {
+          type FinancingType = 'cash_advance' | 'fixed_term_loan' | 'flex_loan';
+
+          type Status =
+            | 'accepted'
+            | 'accepted_other_offer'
+            | 'canceled'
+            | 'completed'
+            | 'delivered'
+            | 'expired'
+            | 'fully_repaid'
+            | 'paid_out'
+            | 'rejected'
+            | 'replaced'
+            | 'undelivered';
+        }
+      }
+
+      namespace Capital {
+        class FinancingOffersResource {
+          /**
+           * Creates a test financing offer for a connected account.
+           */
+          create(
+            params: FinancingOfferCreateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Capital.FinancingOffer>>;
+
+          /**
+           * Refills a test financing offer for a connected account.
+           */
+          refill(
+            id: string,
+            params: FinancingOfferRefillParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Capital.FinancingOffer>>;
+        }
+      }
+    }
+  }
+}

package/types/TestHelpers/ConfirmationTokensResource.d.ts

@@ -144,11 +144,21 @@ declare module 'stripe' {
            */
           giropay?: PaymentMethodData.Giropay;
 
+          /**
+           * If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
+           */
+          gopay?: PaymentMethodData.Gopay;
+
           /**
            * If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
            */
           grabpay?: PaymentMethodData.Grabpay;
 
+          /**
+           * If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
+           */
+          id_bank_transfer?: PaymentMethodData.IdBankTransfer;
+
           /**
            * If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
            */
@@ -244,6 +254,16 @@ declare module 'stripe' {
            */
           paypal?: PaymentMethodData.Paypal;
 
+          /**
+           * If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
+           */
+          paypay?: PaymentMethodData.Paypay;
+
+          /**
+           * If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
+           */
+          payto?: PaymentMethodData.Payto;
+
           /**
            * If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
            */
@@ -254,11 +274,21 @@ declare module 'stripe' {
            */
           promptpay?: PaymentMethodData.Promptpay;
 
+          /**
+           * If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
+           */
+          qris?: PaymentMethodData.Qris;
+
           /**
            * Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
            */
           radar_options?: PaymentMethodData.RadarOptions;
 
+          /**
+           * If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
+           */
+          rechnung?: PaymentMethodData.Rechnung;
+
           /**
            * If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
            */
@@ -279,11 +309,21 @@ declare module 'stripe' {
            */
           sepa_debit?: PaymentMethodData.SepaDebit;
 
+          /**
+           * If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
+           */
+          shopeepay?: PaymentMethodData.Shopeepay;
+
           /**
            * If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
            */
           sofort?: PaymentMethodData.Sofort;
 
+          /**
+           * This hash contains details about the Stripe balance payment method.
+           */
+          stripe_balance?: PaymentMethodData.StripeBalance;
+
           /**
            * If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
            */
@@ -496,8 +536,21 @@ declare module 'stripe' {
 
           interface Giropay {}
 
+          interface Gopay {}
+
           interface Grabpay {}
 
+          interface IdBankTransfer {
+            /**
+             * Bank where the account is held.
+             */
+            bank?: IdBankTransfer.Bank;
+          }
+
+          namespace IdBankTransfer {
+            type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
+          }
+
           interface Ideal {
             /**
              * The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
@@ -656,10 +709,31 @@ declare module 'stripe' {
 
           interface Paypal {}
 
+          interface Paypay {}
+
+          interface Payto {
+            /**
+             * The account number for the bank account.
+             */
+            account_number?: string;
+
+            /**
+             * Bank-State-Branch number of the bank account.
+             */
+            bsb_number?: string;
+
+            /**
+             * The PayID alias for the bank account.
+             */
+            pay_id?: string;
+          }
+
           interface Pix {}
 
           interface Promptpay {}
 
+          interface Qris {}
+
           interface RadarOptions {
             /**
              * A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
@@ -667,6 +741,32 @@ declare module 'stripe' {
             session?: string;
           }
 
+          interface Rechnung {
+            /**
+             * Customer's date of birth
+             */
+            dob: Rechnung.Dob;
+          }
+
+          namespace Rechnung {
+            interface Dob {
+              /**
+               * The day of birth, between 1 and 31.
+               */
+              day: number;
+
+              /**
+               * The month of birth, between 1 and 12.
+               */
+              month: number;
+
+              /**
+               * The four-digit year of birth.
+               */
+              year: number;
+            }
+          }
+
           interface RevolutPay {}
 
           interface SamsungPay {}
@@ -680,6 +780,8 @@ declare module 'stripe' {
             iban: string;
           }
 
+          interface Shopeepay {}
+
           interface Sofort {
             /**
              * Two-letter ISO code representing the country the bank account is located in.
@@ -691,6 +793,22 @@ declare module 'stripe' {
             type Country = 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL';
           }
 
+          interface StripeBalance {
+            /**
+             * The connected account ID whose Stripe balance to use as the source of payment
+             */
+            account?: string;
+
+            /**
+             * The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
+             */
+            source_type?: StripeBalance.SourceType;
+          }
+
+          namespace StripeBalance {
+            type SourceType = 'bank_account' | 'card' | 'fpx';
+          }
+
           interface Swish {}
 
           interface Twint {}
@@ -714,7 +832,9 @@ declare module 'stripe' {
             | 'eps'
             | 'fpx'
             | 'giropay'
+            | 'gopay'
             | 'grabpay'
+            | 'id_bank_transfer'
             | 'ideal'
             | 'kakao_pay'
             | 'klarna'
@@ -732,13 +852,19 @@ declare module 'stripe' {
             | 'payco'
             | 'paynow'
             | 'paypal'
+            | 'paypay'
+            | 'payto'
             | 'pix'
             | 'promptpay'
+            | 'qris'
+            | 'rechnung'
             | 'revolut_pay'
             | 'samsung_pay'
             | 'satispay'
             | 'sepa_debit'
+            | 'shopeepay'
             | 'sofort'
+            | 'stripe_balance'
             | 'swish'
             | 'twint'
             | 'us_bank_account'

package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts

@@ -39,6 +39,11 @@ declare module 'stripe' {
            * Initiating payment method details for the object.
            */
           initiating_payment_method_details?: ReceivedCreditCreateParams.InitiatingPaymentMethodDetails;
+
+          /**
+           * Details about the network used for the ReceivedCredit.
+           */
+          network_details?: ReceivedCreditCreateParams.NetworkDetails;
         }
 
         namespace ReceivedCreditCreateParams {
@@ -74,6 +79,27 @@ declare module 'stripe' {
           }
 
           type Network = 'ach' | 'us_domestic_wire';
+
+          interface NetworkDetails {
+            /**
+             * Optional fields for `ach`.
+             */
+            ach?: NetworkDetails.Ach;
+
+            /**
+             * The type of flow that originated the ReceivedCredit.
+             */
+            type: 'ach';
+          }
+
+          namespace NetworkDetails {
+            interface Ach {
+              /**
+               * ACH Addenda record
+               */
+              addenda?: string;
+            }
+          }
         }
       }
 

package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts

@@ -39,6 +39,11 @@ declare module 'stripe' {
            * Initiating payment method details for the object.
            */
           initiating_payment_method_details?: ReceivedDebitCreateParams.InitiatingPaymentMethodDetails;
+
+          /**
+           * Details about the network used for the ReceivedDebit.
+           */
+          network_details?: ReceivedDebitCreateParams.NetworkDetails;
         }
 
         namespace ReceivedDebitCreateParams {
@@ -72,6 +77,27 @@ declare module 'stripe' {
               routing_number?: string;
             }
           }
+
+          interface NetworkDetails {
+            /**
+             * Optional fields for `ach`.
+             */
+            ach?: NetworkDetails.Ach;
+
+            /**
+             * The type of flow that originated the ReceivedDebit.
+             */
+            type: 'ach';
+          }
+
+          namespace NetworkDetails {
+            interface Ach {
+              /**
+               * Addenda record data associated with this ReceivedDebit.
+               */
+              addenda?: string;
+            }
+          }
         }
       }
 

package/types/TokensResource.d.ts

@@ -424,6 +424,16 @@ declare module 'stripe' {
            */
           relationship?: Individual.Relationship;
 
+          /**
+           * The credit applicant's self-reported yearly income in minor units.
+           */
+          self_reported_income?: Individual.SelfReportedIncome;
+
+          /**
+           * The credit applicant's self-reported monthly housing payment in minor units.
+           */
+          self_reported_monthly_housing_payment?: Individual.SelfReportedMonthlyHousingPayment;
+
           /**
            * The last four digits of the individual's Social Security Number (U.S. only).
            */
@@ -482,6 +492,18 @@ declare module 'stripe' {
             title?: string;
           }
 
+          interface SelfReportedIncome {
+            amount: number;
+
+            currency: string;
+          }
+
+          interface SelfReportedMonthlyHousingPayment {
+            amount: number;
+
+            currency: string;
+          }
+
           interface Verification {
             /**
              * A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
@@ -778,6 +800,16 @@ declare module 'stripe' {
          */
         relationship?: Person.Relationship;
 
+        /**
+         * The credit applicant's self-reported yearly income in minor units.
+         */
+        self_reported_income?: Person.SelfReportedIncome;
+
+        /**
+         * The credit applicant's self-reported monthly housing payment in minor units.
+         */
+        self_reported_monthly_housing_payment?: Person.SelfReportedMonthlyHousingPayment;
+
         /**
          * The last four digits of the person's Social Security number (U.S. only).
          */
@@ -922,6 +954,18 @@ declare module 'stripe' {
           title?: string;
         }
 
+        interface SelfReportedIncome {
+          amount: number;
+
+          currency: string;
+        }
+
+        interface SelfReportedMonthlyHousingPayment {
+          amount: number;
+
+          currency: string;
+        }
+
         interface UsCfpbData {
           /**
            * The persons ethnicity details

package/types/Transfers.d.ts

@@ -35,6 +35,10 @@ declare module 'stripe' {
        */
       amount_reversed: number;
 
+      application_fee?: string | Stripe.ApplicationFee | null;
+
+      application_fee_amount?: number | null;
+
       /**
        * Balance transaction that describes the impact of this transfer on your account balance.
        */
@@ -65,6 +69,11 @@ declare module 'stripe' {
        */
       destination_payment?: string | Stripe.Charge;
 
+      /**
+       * The FX Quote used for the transfer.
+       */
+      fx_quote?: string;
+
       /**
        * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
        */

package/types/TransfersResource.d.ts

@@ -18,6 +18,8 @@ declare module 'stripe' {
        */
       amount?: number;
 
+      application_fee_amount?: number;
+
       /**
        * An arbitrary string attached to the object. Often useful for displaying to users.
        */
@@ -28,6 +30,11 @@ declare module 'stripe' {
        */
       expand?: Array<string>;
 
+      /**
+       * The FX rate in the quote is validated and used to convert the transfer amount to the destination currency.
+       */
+      fx_quote?: string;
+
       /**
        * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        */

package/types/TransitBalances.d.ts

@@ -0,0 +1,40 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * Funds that are in transit and destined for another balance or another connected account.
+     */
+    interface TransitBalance {
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'transit_balance';
+
+      balance: TransitBalance.Balance;
+
+      /**
+       * 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;
+
+      /**
+       * 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 TransitBalance {
+      interface Balance {
+        available: number;
+
+        pending: number;
+      }
+    }
+  }
+}

package/types/Treasury/FinancialAccountFeatures.d.ts

@@ -175,6 +175,11 @@ declare module 'stripe' {
 
         namespace FinancialAddresses {
           interface Aba {
+            /**
+             * Requested bank partner for this Financial Account
+             */
+            bank?: Aba.Bank;
+
             /**
              * Whether the FinancialAccount should have the Feature.
              */
@@ -192,6 +197,8 @@ declare module 'stripe' {
           }
 
           namespace Aba {
+            type Bank = 'evolve' | 'fifth_third' | 'goldman_sachs';
+
             type Status = 'active' | 'pending' | 'restricted';
 
             interface StatusDetail {

package/types/Treasury/FinancialAccounts.d.ts

@@ -38,6 +38,11 @@ declare module 'stripe' {
          */
         created: number;
 
+        /**
+         * The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
+         */
+        display_name?: string | null;
+
         /**
          * Encodes whether a FinancialAccount has access to a particular Feature, with a `status` enum and associated `status_details`.
          * Stripe or the platform can control Features via the requested field.