stripe 19.2.1 → 19.3.0-alpha.2

package/types/Capital/FinancingTransactions.d.ts

@@ -0,0 +1,135 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Capital {
+      /**
+       * This is an object representing the details of a transaction on a Capital financing object.
+       */
+      interface FinancingTransaction {
+        /**
+         * A unique identifier for the financing transaction object.
+         */
+        id: string;
+
+        /**
+         * The object type: financing_transaction
+         */
+        object: 'capital.financing_transaction';
+
+        /**
+         * The ID of the merchant associated with this financing transaction.
+         */
+        account: string;
+
+        /**
+         * Time at which the financing transaction was created. Given in seconds since unix epoch.
+         */
+        created_at: number;
+
+        /**
+         * This is an object representing a transaction on a Capital financing offer.
+         */
+        details: FinancingTransaction.Details;
+
+        /**
+         * The Capital financing offer for this financing transaction.
+         */
+        financing_offer: string | null;
+
+        /**
+         * The Capital transaction object that predates the Financing Transactions API and
+         * corresponds with the balance transaction that was created as a result of this
+         * financing transaction.
+         */
+        legacy_balance_transaction_source?: 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 type of the financing transaction.
+         */
+        type: FinancingTransaction.Type;
+
+        /**
+         * A human-friendly description of the financing transaction.
+         */
+        user_facing_description: string | null;
+      }
+
+      namespace FinancingTransaction {
+        interface Details {
+          /**
+           * The advance amount being repaid, paid out, or reversed in minor units.
+           */
+          advance_amount: number;
+
+          /**
+           * The currency of the financing transaction.
+           */
+          currency: string;
+
+          /**
+           * The fee amount being repaid, paid out, or reversed in minor units.
+           */
+          fee_amount: number;
+
+          /**
+           * The linked payment for the transaction. This field only applies to financing transactions of type `paydown` and reason `automatic_withholding`.
+           */
+          linked_payment?: string;
+
+          /**
+           * The reason for the financing transaction (if applicable).
+           */
+          reason?: Details.Reason;
+
+          /**
+           * The reversed transaction. This field only applies to financing
+           * transactions of type `reversal`.
+           */
+          reversed_transaction?: string;
+
+          /**
+           * The advance and fee amount being repaid, paid out, or reversed in minor units.
+           */
+          total_amount: number;
+
+          /**
+           * This is an object representing a linked transaction on a Capital Financing Transaction.
+           */
+          transaction?: Details.Transaction;
+        }
+
+        namespace Details {
+          type Reason =
+            | 'automatic_withholding'
+            | 'automatic_withholding_refund'
+            | 'collection'
+            | 'collection_failure'
+            | 'financing_cancellation'
+            | 'refill'
+            | 'requested_by_user'
+            | 'user_initiated';
+
+          interface Transaction {
+            /**
+             * The linked payment ID.
+             */
+            charge?: string;
+
+            /**
+             * The linked Treasury Financing Transaction ID.
+             */
+            treasury_transaction?: string;
+          }
+        }
+
+        type Type = 'payment' | 'payout' | 'reversal';
+      }
+    }
+  }
+}

package/types/Capital/FinancingTransactionsResource.d.ts

@@ -0,0 +1,68 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Capital {
+      interface FinancingTransactionRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface FinancingTransactionListParams extends PaginationParams {
+        /**
+         * For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this charge.
+         */
+        charge?: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Returns transactions that were created that apply to this financing offer ID.
+         */
+        financing_offer?: string;
+
+        /**
+         * Only returns transactions that are responsible for reversing this financing transaction ID.
+         */
+        reversed_transaction?: string;
+
+        /**
+         * For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this Treasury Transaction.
+         */
+        treasury_transaction?: string;
+      }
+
+      class FinancingTransactionsResource {
+        /**
+         * Retrieves a financing transaction for a financing offer.
+         */
+        retrieve(
+          id: string,
+          params?: FinancingTransactionRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Capital.FinancingTransaction>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Capital.FinancingTransaction>>;
+
+        /**
+         * Returns a list of financing transactions. The transactions are returned in sorted order,
+         * with the most recent transactions appearing first.
+         */
+        list(
+          params?: FinancingTransactionListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Capital.FinancingTransaction>;
+        list(
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Capital.FinancingTransaction>;
+      }
+    }
+  }
+}

package/types/Cards.d.ts

@@ -72,11 +72,18 @@ declare module 'stripe' {
        */
       available_payout_methods?: Array<Card.AvailablePayoutMethod> | null;
 
+      benefits?: Card.Benefits;
+
       /**
        * Card brand. Can be `American Express`, `Cartes Bancaires`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
        */
       brand: string;
 
+      /**
+       * The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
+       */
+      brand_product?: string | null;
+
       /**
        * Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
        */
@@ -187,6 +194,18 @@ declare module 'stripe' {
 
       type AvailablePayoutMethod = 'instant' | 'standard';
 
+      interface Benefits {
+        /**
+         * Issuer of this benefit card
+         */
+        issuer: string | null;
+
+        /**
+         * Available benefit programs for this card
+         */
+        programs: Array<string> | null;
+      }
+
       interface Networks {
         /**
          * The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card.

package/types/CashBalances.d.ts

@@ -23,6 +23,11 @@ declare module 'stripe' {
        */
       customer: string;
 
+      /**
+       * The ID of the account whose cash balance this object represents.
+       */
+      customer_account?: string | null;
+
       /**
        * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
        */

package/types/Charges.d.ts

@@ -433,8 +433,12 @@ declare module 'stripe' {
 
         giropay?: PaymentMethodDetails.Giropay;
 
+        gopay?: PaymentMethodDetails.Gopay;
+
         grabpay?: PaymentMethodDetails.Grabpay;
 
+        id_bank_transfer?: PaymentMethodDetails.IdBankTransfer;
+
         ideal?: PaymentMethodDetails.Ideal;
 
         interac_present?: PaymentMethodDetails.InteracPresent;
@@ -471,10 +475,18 @@ declare module 'stripe' {
 
         paypal?: PaymentMethodDetails.Paypal;
 
+        paypay?: PaymentMethodDetails.Paypay;
+
+        payto?: PaymentMethodDetails.Payto;
+
         pix?: PaymentMethodDetails.Pix;
 
         promptpay?: PaymentMethodDetails.Promptpay;
 
+        qris?: PaymentMethodDetails.Qris;
+
+        rechnung?: PaymentMethodDetails.Rechnung;
+
         revolut_pay?: PaymentMethodDetails.RevolutPay;
 
         samsung_pay?: PaymentMethodDetails.SamsungPay;
@@ -485,10 +497,14 @@ declare module 'stripe' {
 
         sepa_debit?: PaymentMethodDetails.SepaDebit;
 
+        shopeepay?: PaymentMethodDetails.Shopeepay;
+
         sofort?: PaymentMethodDetails.Sofort;
 
         stripe_account?: PaymentMethodDetails.StripeAccount;
 
+        stripe_balance?: PaymentMethodDetails.StripeBalance;
+
         swish?: PaymentMethodDetails.Swish;
 
         twint?: PaymentMethodDetails.Twint;
@@ -690,6 +706,11 @@ declare module 'stripe' {
                */
               brand: string | null;
 
+              /**
+               * The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
+               */
+              brand_product?: string | null;
+
               /**
                * Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
                */
@@ -837,11 +858,18 @@ declare module 'stripe' {
            */
           amount_authorized: number | null;
 
+          /**
+           * The latest amount intended to be authorized by this charge.
+           */
+          amount_requested?: number | null;
+
           /**
            * Authorization code on the charge.
            */
           authorization_code: string | null;
 
+          benefits?: Card.Benefits;
+
           /**
            * Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
            */
@@ -862,6 +890,8 @@ declare module 'stripe' {
            */
           country: string | null;
 
+          decremental_authorization?: Card.DecrementalAuthorization;
+
           /**
            * A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
            */
@@ -944,6 +974,8 @@ declare module 'stripe' {
 
           overcapture?: Card.Overcapture;
 
+          partial_authorization?: Card.PartialAuthorization;
+
           /**
            * Status of a card based on the card issuer.
            */
@@ -961,6 +993,13 @@ declare module 'stripe' {
         }
 
         namespace Card {
+          interface Benefits {
+            /**
+             * Issuer of the benefit card utilized on this payment
+             */
+            issuer: string | null;
+          }
+
           interface Checks {
             /**
              * If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
@@ -978,6 +1017,17 @@ declare module 'stripe' {
             cvc_check: string | null;
           }
 
+          interface DecrementalAuthorization {
+            /**
+             * Indicates whether or not the decremental authorization feature is supported.
+             */
+            status: DecrementalAuthorization.Status;
+          }
+
+          namespace DecrementalAuthorization {
+            type Status = 'available' | 'unavailable';
+          }
+
           interface ExtendedAuthorization {
             /**
              * Indicates whether or not the capture window is extended beyond the standard authorization.
@@ -1065,6 +1115,21 @@ declare module 'stripe' {
             type Status = 'available' | 'unavailable';
           }
 
+          interface PartialAuthorization {
+            /**
+             * Indicates whether the transaction requested for partial authorization feature and the authorization outcome.
+             */
+            status: PartialAuthorization.Status;
+          }
+
+          namespace PartialAuthorization {
+            type Status =
+              | 'declined'
+              | 'fully_authorized'
+              | 'not_requested'
+              | 'partially_authorized';
+          }
+
           type RegulatedStatus = 'regulated' | 'unregulated';
 
           interface ThreeDSecure {
@@ -1604,6 +1669,8 @@ declare module 'stripe' {
           verified_name: string | null;
         }
 
+        interface Gopay {}
+
         interface Grabpay {
           /**
            * Unique transaction id generated by GrabPay
@@ -1611,6 +1678,37 @@ declare module 'stripe' {
           transaction_id: string | null;
         }
 
+        interface IdBankTransfer {
+          /**
+           * Account number of the bank account to transfer funds to.
+           */
+          account_number: string;
+
+          /**
+           * Bank where the account is located.
+           */
+          bank: IdBankTransfer.Bank;
+
+          /**
+           * Local bank code of the bank.
+           */
+          bank_code?: string;
+
+          /**
+           * Name of the bank associated with the bank account.
+           */
+          bank_name?: string;
+
+          /**
+           * Merchant name and billing details name, for the customer to check for the correct merchant when performing the bank transfer.
+           */
+          display_name?: string;
+        }
+
+        namespace IdBankTransfer {
+          type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
+        }
+
         interface Ideal {
           /**
            * The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
@@ -2173,10 +2271,36 @@ declare module 'stripe' {
            */
           seller_protection: Paypal.SellerProtection | null;
 
+          /**
+           * The shipping address for the customer, as supplied by the merchant at the point of payment
+           * execution. This shipping address will not be updated if the merchant updates the shipping
+           * address on the PaymentIntent after the PaymentIntent was successfully confirmed.
+           */
+          shipping?: Stripe.Address | null;
+
           /**
            * A unique ID generated by PayPal for this transaction.
            */
           transaction_id: string | null;
+
+          /**
+           * The shipping address for the customer, as supplied by the merchant at the point of payment
+           * execution. This shipping address will not be updated if the merchant updates the shipping
+           * address on the PaymentIntent after the PaymentIntent was successfully confirmed.
+           */
+          verified_address?: Stripe.Address | null;
+
+          /**
+           * Owner's verified email. Values are verified or provided by PayPal directly
+           * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
+           */
+          verified_email?: string | null;
+
+          /**
+           * Owner's verified full name. Values are verified or provided by PayPal directly
+           * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
+           */
+          verified_name?: string | null;
         }
 
         namespace Paypal {
@@ -2199,11 +2323,40 @@ declare module 'stripe' {
           }
         }
 
+        interface Paypay {}
+
+        interface Payto {
+          /**
+           * Bank-State-Branch number of the bank account.
+           */
+          bsb_number: string | null;
+
+          /**
+           * Last four digits of the bank account number.
+           */
+          last4: string | null;
+
+          /**
+           * ID of the mandate used to make this payment.
+           */
+          mandate?: string;
+
+          /**
+           * The PayID alias for the bank account.
+           */
+          pay_id: string | null;
+        }
+
         interface Pix {
           /**
            * Unique transaction id generated by BCB
            */
           bank_transaction_id?: string | null;
+
+          /**
+           * ID of the multi use Mandate generated by the PaymentIntent
+           */
+          mandate?: string;
         }
 
         interface Promptpay {
@@ -2213,6 +2366,15 @@ declare module 'stripe' {
           reference: string | null;
         }
 
+        interface Qris {}
+
+        interface Rechnung {
+          /**
+           * Payment portal URL.
+           */
+          payment_portal_url: string | null;
+        }
+
         interface RevolutPay {
           funding?: RevolutPay.Funding;
 
@@ -2239,6 +2401,11 @@ declare module 'stripe' {
                */
               brand: string | null;
 
+              /**
+               * The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
+               */
+              brand_product?: string | null;
+
               /**
                * Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
                */
@@ -2335,6 +2502,8 @@ declare module 'stripe' {
           mandate: string | null;
         }
 
+        interface Shopeepay {}
+
         interface Sofort {
           /**
            * Bank code of bank associated with the bank account.
@@ -2397,6 +2566,22 @@ declare module 'stripe' {
 
         interface StripeAccount {}
 
+        interface StripeBalance {
+          /**
+           * The connected account ID whose Stripe balance to use as the source of payment
+           */
+          account?: string | null;
+
+          /**
+           * 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 {
           /**
            * Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer