stripe 19.2.1 → 19.3.0-alpha.2

package/types/Terminal/ReaderCollectedData.d.ts

@@ -0,0 +1,51 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Terminal {
+      /**
+       * Returns data collected by Terminal readers. This data is only stored for 24 hours.
+       */
+      interface ReaderCollectedData {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'terminal.reader_collected_data';
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * 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 magstripe data collected by the reader.
+         */
+        magstripe: ReaderCollectedData.Magstripe | null;
+
+        /**
+         * The type of data collected by the reader.
+         */
+        type: 'magstripe';
+      }
+
+      namespace ReaderCollectedData {
+        interface Magstripe {
+          /**
+           * The raw magstripe data collected by the reader.
+           */
+          data: string | null;
+        }
+      }
+    }
+  }
+}

package/types/Terminal/ReaderCollectedDataResource.d.ts

@@ -0,0 +1,29 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Terminal {
+      interface ReaderCollectedDataRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class ReaderCollectedDataResource {
+        /**
+         * Retrieve data collected using Reader hardware.
+         */
+        retrieve(
+          id: string,
+          params?: ReaderCollectedDataRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Terminal.ReaderCollectedData>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Terminal.ReaderCollectedData>>;
+      }
+    }
+  }
+}

package/types/Terminal/Readers.d.ts

@@ -366,6 +366,11 @@ declare module 'stripe' {
           }
 
           interface CollectPaymentMethod {
+            /**
+             * Account the payment intent belongs to.
+             */
+            account?: string;
+
             /**
              * Represents a per-transaction override of a reader configuration
              */
@@ -415,6 +420,11 @@ declare module 'stripe' {
           }
 
           interface ConfirmPaymentIntent {
+            /**
+             * Account the payment intent belongs to.
+             */
+            account?: string;
+
             /**
              * Represents a per-transaction override of a reader configuration
              */
@@ -436,6 +446,11 @@ declare module 'stripe' {
           }
 
           interface ProcessPaymentIntent {
+            /**
+             * Account the payment intent belongs to.
+             */
+            account?: string;
+
             /**
              * Most recent PaymentIntent processed by the reader.
              */
@@ -507,6 +522,11 @@ declare module 'stripe' {
           }
 
           interface RefundPayment {
+            /**
+             * Account the payment intent belongs to.
+             */
+            account?: string;
+
             /**
              * The amount being refunded.
              */

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.
@@ -655,10 +708,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.
@@ -666,6 +740,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 {}
@@ -679,6 +779,8 @@ declare module 'stripe' {
             iban: string;
           }
 
+          interface Shopeepay {}
+
           interface Sofort {
             /**
              * Two-letter ISO code representing the country the bank account is located in.
@@ -690,6 +792,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 {}
@@ -713,7 +831,9 @@ declare module 'stripe' {
             | 'eps'
             | 'fpx'
             | 'giropay'
+            | 'gopay'
             | 'grabpay'
+            | 'id_bank_transfer'
             | 'ideal'
             | 'kakao_pay'
             | 'klarna'
@@ -731,13 +851,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/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/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.

package/types/Treasury/FinancialAccountsResource.d.ts

@@ -9,6 +9,11 @@ declare module 'stripe' {
          */
         supported_currencies: Array<string>;
 
+        /**
+         * 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?: Stripe.Emptyable<string>;
+
         /**
          * Specifies which fields in the response should be expanded.
          */
@@ -97,11 +102,20 @@ declare module 'stripe' {
 
           namespace FinancialAddresses {
             interface Aba {
+              /**
+               * Requested bank partner
+               */
+              bank?: Aba.Bank;
+
               /**
                * Whether the FinancialAccount should have the Feature.
                */
               requested: boolean;
             }
+
+            namespace Aba {
+              type Bank = 'evolve' | 'fifth_third' | 'goldman_sachs';
+            }
           }
 
           interface InboundTransfers {
@@ -211,6 +225,11 @@ declare module 'stripe' {
       }
 
       interface FinancialAccountUpdateParams {
+        /**
+         * 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?: Stripe.Emptyable<string>;
+
         /**
          * Specifies which fields in the response should be expanded.
          */
@@ -304,11 +323,20 @@ declare module 'stripe' {
 
           namespace FinancialAddresses {
             interface Aba {
+              /**
+               * Requested bank partner
+               */
+              bank?: Aba.Bank;
+
               /**
                * Whether the FinancialAccount should have the Feature.
                */
               requested: boolean;
             }
+
+            namespace Aba {
+              type Bank = 'evolve' | 'fifth_third' | 'goldman_sachs';
+            }
           }
 
           interface InboundTransfers {
@@ -560,11 +588,20 @@ declare module 'stripe' {
 
         namespace FinancialAddresses {
           interface Aba {
+            /**
+             * Requested bank partner
+             */
+            bank?: Aba.Bank;
+
             /**
              * Whether the FinancialAccount should have the Feature.
              */
             requested: boolean;
           }
+
+          namespace Aba {
+            type Bank = 'evolve' | 'fifth_third' | 'goldman_sachs';
+          }
         }
 
         interface InboundTransfers {

package/types/Treasury/OutboundTransfers.d.ts

@@ -78,6 +78,11 @@ declare module 'stripe' {
          */
         metadata: Stripe.Metadata;
 
+        /**
+         * Details about the network used for the OutboundTransfer.
+         */
+        network_details?: OutboundTransfer.NetworkDetails | null;
+
         /**
          * Details about a returned OutboundTransfer. Only set when the status is `returned`.
          */
@@ -200,6 +205,27 @@ declare module 'stripe' {
           }
         }
 
+        interface NetworkDetails {
+          /**
+           * Details about an ACH transaction.
+           */
+          ach?: NetworkDetails.Ach | null;
+
+          /**
+           * The type of flow that originated the OutboundTransfer.
+           */
+          type: 'ach';
+        }
+
+        namespace NetworkDetails {
+          interface Ach {
+            /**
+             * ACH Addenda record
+             */
+            addenda: string | null;
+          }
+        }
+
         interface ReturnedDetails {
           /**
            * Reason for the return.

package/types/Treasury/OutboundTransfersResource.d.ts

@@ -49,6 +49,11 @@ declare module 'stripe' {
          */
         metadata?: Stripe.MetadataParam;
 
+        /**
+         * Details about the network used for the OutboundTransfer.
+         */
+        network_details?: OutboundTransferCreateParams.NetworkDetails;
+
         /**
          * Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The default value is "transfer".
          */
@@ -89,6 +94,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 OutboundTransfer.
+           */
+          type: 'ach';
+        }
+
+        namespace NetworkDetails {
+          interface Ach {
+            /**
+             * Addenda record data associated with this OutboundTransfer.
+             */
+            addenda?: string;
+          }
+        }
       }
 
       interface OutboundTransferRetrieveParams {