stripe 20.0.0 → 20.1.0-alpha.1

package/types/PaymentMethods.d.ts

@@ -71,6 +71,8 @@ declare module 'stripe' {
        */
       customer: string | Stripe.Customer | null;
 
+      customer_account?: string | null;
+
       customer_balance?: PaymentMethod.CustomerBalance;
 
       eps?: PaymentMethod.Eps;
@@ -79,8 +81,12 @@ declare module 'stripe' {
 
       giropay?: PaymentMethod.Giropay;
 
+      gopay?: PaymentMethod.Gopay;
+
       grabpay?: PaymentMethod.Grabpay;
 
+      id_bank_transfer?: PaymentMethod.IdBankTransfer;
+
       ideal?: PaymentMethod.Ideal;
 
       interac_present?: PaymentMethod.InteracPresent;
@@ -93,6 +99,11 @@ declare module 'stripe' {
 
       kr_card?: PaymentMethod.KrCard;
 
+      /**
+       * The Mandate object of the most recently created Mandate associated with this payment method
+       */
+      latest_active_mandate?: Stripe.Mandate | null;
+
       link?: PaymentMethod.Link;
 
       /**
@@ -127,15 +138,23 @@ declare module 'stripe' {
 
       paypal?: PaymentMethod.Paypal;
 
+      paypay?: PaymentMethod.Paypay;
+
+      payto?: PaymentMethod.Payto;
+
       pix?: PaymentMethod.Pix;
 
       promptpay?: PaymentMethod.Promptpay;
 
+      qris?: PaymentMethod.Qris;
+
       /**
        * Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
        */
       radar_options?: PaymentMethod.RadarOptions;
 
+      rechnung?: PaymentMethod.Rechnung;
+
       revolut_pay?: PaymentMethod.RevolutPay;
 
       samsung_pay?: PaymentMethod.SamsungPay;
@@ -144,8 +163,12 @@ declare module 'stripe' {
 
       sepa_debit?: PaymentMethod.SepaDebit;
 
+      shopeepay?: PaymentMethod.Shopeepay;
+
       sofort?: PaymentMethod.Sofort;
 
+      stripe_balance?: PaymentMethod.StripeBalance;
+
       swish?: PaymentMethod.Swish;
 
       twint?: PaymentMethod.Twint;
@@ -164,6 +187,11 @@ declare module 'stripe' {
 
     namespace PaymentMethod {
       interface AcssDebit {
+        /**
+         * Account number of the bank account.
+         */
+        account_number?: string | null;
+
         /**
          * Name of the bank associated with the bank account.
          */
@@ -277,6 +305,8 @@ declare module 'stripe' {
       }
 
       interface Card {
+        benefits?: Card.Benefits;
+
         /**
          * Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
          */
@@ -366,6 +396,18 @@ declare module 'stripe' {
       }
 
       namespace Card {
+        interface Benefits {
+          /**
+           * Issuer of this benefit card
+           */
+          issuer: string | null;
+
+          /**
+           * Available benefit programs for this card
+           */
+          programs: Array<string> | null;
+        }
+
         interface Checks {
           /**
            * If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
@@ -1001,8 +1043,24 @@ declare module 'stripe' {
 
       interface Giropay {}
 
+      interface Gopay {}
+
       interface Grabpay {}
 
+      interface IdBankTransfer {
+        bank: IdBankTransfer.Bank | null;
+
+        bank_code: string | null;
+
+        bank_name: string | null;
+
+        display_name: string | null;
+      }
+
+      namespace IdBankTransfer {
+        type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
+      }
+
       interface Ideal {
         /**
          * The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
@@ -1339,6 +1397,11 @@ declare module 'stripe' {
          */
         country: string | null;
 
+        /**
+         * Uniquely identifies this particular PayPal account. You can use this attribute to check whether two PayPal accounts are the same.
+         */
+        fingerprint?: string | null;
+
         /**
          * Owner's email. Values are provided by PayPal directly
          * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
@@ -1349,12 +1412,39 @@ declare module 'stripe' {
          * PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
          */
         payer_id: string | 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;
+      }
+
+      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;
+
+        /**
+         * The PayID alias for the bank account.
+         */
+        pay_id: string | null;
       }
 
       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.
@@ -1362,6 +1452,29 @@ declare module 'stripe' {
         session?: string;
       }
 
+      interface Rechnung {
+        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 {}
@@ -1414,6 +1527,8 @@ declare module 'stripe' {
         }
       }
 
+      interface Shopeepay {}
+
       interface Sofort {
         /**
          * Two-letter ISO code representing the country the bank account is located in.
@@ -1421,6 +1536,22 @@ declare module 'stripe' {
         country: string | null;
       }
 
+      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 {}
 
       interface Twint {}
@@ -1447,7 +1578,9 @@ declare module 'stripe' {
         | 'eps'
         | 'fpx'
         | 'giropay'
+        | 'gopay'
         | 'grabpay'
+        | 'id_bank_transfer'
         | 'ideal'
         | 'interac_present'
         | 'kakao_pay'
@@ -1466,13 +1599,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'
@@ -1485,6 +1624,11 @@ declare module 'stripe' {
          */
         account_holder_type: UsBankAccount.AccountHolderType | null;
 
+        /**
+         * Account number of the bank account.
+         */
+        account_number?: string | null;
+
         /**
          * Account type: checkings or savings. Defaults to checking if omitted.
          */

package/types/PaymentMethodsResource.d.ts

@@ -123,11 +123,21 @@ declare module 'stripe' {
        */
       giropay?: PaymentMethodCreateParams.Giropay;
 
+      /**
+       * If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
+       */
+      gopay?: PaymentMethodCreateParams.Gopay;
+
       /**
        * If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
        */
       grabpay?: PaymentMethodCreateParams.Grabpay;
 
+      /**
+       * If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
+       */
+      id_bank_transfer?: PaymentMethodCreateParams.IdBankTransfer;
+
       /**
        * If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
        */
@@ -228,6 +238,16 @@ declare module 'stripe' {
        */
       paypal?: PaymentMethodCreateParams.Paypal;
 
+      /**
+       * If this is a `paypay` PaymentMethod, this hash contains details about the PayPay payment method.
+       */
+      paypay?: PaymentMethodCreateParams.Paypay;
+
+      /**
+       * If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
+       */
+      payto?: PaymentMethodCreateParams.Payto;
+
       /**
        * If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
        */
@@ -238,11 +258,21 @@ declare module 'stripe' {
        */
       promptpay?: PaymentMethodCreateParams.Promptpay;
 
+      /**
+       * If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
+       */
+      qris?: PaymentMethodCreateParams.Qris;
+
       /**
        * Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
        */
       radar_options?: PaymentMethodCreateParams.RadarOptions;
 
+      /**
+       * If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
+       */
+      rechnung?: PaymentMethodCreateParams.Rechnung;
+
       /**
        * If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
        */
@@ -263,11 +293,21 @@ declare module 'stripe' {
        */
       sepa_debit?: PaymentMethodCreateParams.SepaDebit;
 
+      /**
+       * If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
+       */
+      shopeepay?: PaymentMethodCreateParams.Shopeepay;
+
       /**
        * If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
        */
       sofort?: PaymentMethodCreateParams.Sofort;
 
+      /**
+       * This hash contains details about the Stripe balance payment method.
+       */
+      stripe_balance?: PaymentMethodCreateParams.StripeBalance;
+
       /**
        * If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
        */
@@ -532,8 +572,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.
@@ -692,10 +745,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.
@@ -703,6 +777,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 {}
@@ -716,6 +816,8 @@ declare module 'stripe' {
         iban: string;
       }
 
+      interface Shopeepay {}
+
       interface Sofort {
         /**
          * Two-letter ISO code representing the country the bank account is located in.
@@ -727,6 +829,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 {}
@@ -752,7 +870,9 @@ declare module 'stripe' {
         | 'eps'
         | 'fpx'
         | 'giropay'
+        | 'gopay'
         | 'grabpay'
+        | 'id_bank_transfer'
         | 'ideal'
         | 'kakao_pay'
         | 'klarna'
@@ -770,13 +890,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'
@@ -854,6 +980,11 @@ declare module 'stripe' {
        */
       metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
 
+      /**
+       * If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
+       */
+      payto?: PaymentMethodUpdateParams.Payto;
+
       /**
        * If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
        */
@@ -920,6 +1051,23 @@ declare module 'stripe' {
         }
       }
 
+      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 UsBankAccount {
         /**
          * Bank account holder type.
@@ -940,11 +1088,21 @@ declare module 'stripe' {
     }
 
     interface PaymentMethodListParams extends PaginationParams {
+      /**
+       * This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
+       */
+      allow_redisplay?: PaymentMethodListParams.AllowRedisplay;
+
       /**
        * The ID of the customer whose PaymentMethods will be retrieved.
        */
       customer?: string;
 
+      /**
+       * The ID of the Account whose PaymentMethods will be retrieved.
+       */
+      customer_account?: string;
+
       /**
        * Specifies which fields in the response should be expanded.
        */
@@ -957,6 +1115,8 @@ declare module 'stripe' {
     }
 
     namespace PaymentMethodListParams {
+      type AllowRedisplay = 'always' | 'limited' | 'unspecified';
+
       type Type =
         | 'acss_debit'
         | 'affirm'
@@ -978,7 +1138,9 @@ declare module 'stripe' {
         | 'eps'
         | 'fpx'
         | 'giropay'
+        | 'gopay'
         | 'grabpay'
+        | 'id_bank_transfer'
         | 'ideal'
         | 'kakao_pay'
         | 'klarna'
@@ -996,13 +1158,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'
@@ -1014,7 +1182,12 @@ declare module 'stripe' {
       /**
        * The ID of the customer to which to attach the PaymentMethod.
        */
-      customer: string;
+      customer?: string;
+
+      /**
+       * The ID of the account to which to attach the PaymentMethod.
+       */
+      customer_account?: string;
 
       /**
        * Specifies which fields in the response should be expanded.
@@ -1022,6 +1195,13 @@ declare module 'stripe' {
       expand?: Array<string>;
     }
 
+    interface PaymentMethodCheckBalanceParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
     interface PaymentMethodDetachParams {
       /**
        * Specifies which fields in the response should be expanded.
@@ -1091,10 +1271,27 @@ declare module 'stripe' {
        */
       attach(
         id: string,
-        params: PaymentMethodAttachParams,
+        params?: PaymentMethodAttachParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.PaymentMethod>>;
+      attach(
+        id: string,
         options?: RequestOptions
       ): Promise<Stripe.Response<Stripe.PaymentMethod>>;
 
+      /**
+       * Retrieves a payment method's balance.
+       */
+      checkBalance(
+        id: string,
+        params?: PaymentMethodCheckBalanceParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.PaymentMethodBalance>>;
+      checkBalance(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.PaymentMethodBalance>>;
+
       /**
        * Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.
        */