stripe 22.3.0 → 22.4.0-alpha.2

package/cjs/resources/PaymentMethods.d.ts

@@ -1,5 +1,7 @@
 import { StripeResource } from '../StripeResource.js';
+import { PaymentMethodBalance } from './PaymentMethodBalances.js';
 import { Customer } from './Customers.js';
+import { Mandate } from './Mandates.js';
 import { SetupAttempt } from './SetupAttempts.js';
 import { Charge } from './Charges.js';
 import { MetadataParam, Emptyable, AddressParam, PaginationParams, Metadata, Address } from '../shared.js';
@@ -39,10 +41,18 @@ export declare class PaymentMethodResource extends StripeResource {
      * on the Customer to the PaymentMethod's ID.
      */
     attach(id: string, params?: PaymentMethodAttachParams, options?: RequestOptions): Promise<Response<PaymentMethod>>;
+    /**
+     * Retrieves a PaymentMethod's Balance.
+     */
+    checkBalance(id: string, params?: PaymentMethodCheckBalanceParams, options?: RequestOptions): Promise<Response<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.
      */
     detach(id: string, params?: PaymentMethodDetachParams, options?: RequestOptions): Promise<Response<PaymentMethod>>;
+    serializeBatchAttach(paymentMethod: string, params?: Record<string, unknown>, options?: {
+        apiVersion?: string;
+        stripeContext?: string;
+    }): string;
 }
 export interface PaymentMethod {
     /**
@@ -88,14 +98,21 @@ export interface PaymentMethod {
     customer_balance?: PaymentMethod.CustomerBalance;
     eps?: PaymentMethod.Eps;
     fpx?: PaymentMethod.Fpx;
+    gift_card?: PaymentMethod.GiftCard;
     giropay?: PaymentMethod.Giropay;
+    gopay?: PaymentMethod.Gopay;
     grabpay?: PaymentMethod.Grabpay;
+    id_bank_transfer?: PaymentMethod.IdBankTransfer;
     ideal?: PaymentMethod.Ideal;
     interac_present?: PaymentMethod.InteracPresent;
     kakao_pay?: PaymentMethod.KakaoPay;
     klarna?: PaymentMethod.Klarna;
     konbini?: PaymentMethod.Konbini;
     kr_card?: PaymentMethod.KrCard;
+    /**
+     * The Mandate object of the most recently created Mandate associated with this payment method
+     */
+    latest_active_mandate?: Mandate | null;
     link?: PaymentMethod.Link;
     /**
      * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
@@ -116,21 +133,35 @@ export interface PaymentMethod {
     payco?: PaymentMethod.Payco;
     paynow?: PaymentMethod.Paynow;
     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://docs.stripe.com/radar/radar-session) for more information.
      */
     radar_options?: PaymentMethod.RadarOptions;
+    rechnung?: PaymentMethod.Rechnung;
+    /**
+     * Redaction status of this PaymentMethod. If the PaymentMethod is not redacted, this field will be null.
+     */
+    redaction?: PaymentMethod.Redaction | null;
     revolut_pay?: PaymentMethod.RevolutPay;
     samsung_pay?: PaymentMethod.SamsungPay;
     satispay?: PaymentMethod.Satispay;
     scalapay?: PaymentMethod.Scalapay;
     sepa_debit?: PaymentMethod.SepaDebit;
+    /**
+     * ID of the shared payment granted token used in the creation of this PaymentMethod.
+     */
+    shared_payment_granted_token?: string | null;
+    shopeepay?: PaymentMethod.Shopeepay;
     sofort?: PaymentMethod.Sofort;
+    stripe_balance?: PaymentMethod.StripeBalance;
     sunbit?: PaymentMethod.Sunbit;
     swish?: PaymentMethod.Swish;
+    tamara?: PaymentMethod.Tamara;
     twint?: PaymentMethod.Twint;
     /**
      * The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
@@ -143,6 +174,10 @@ export interface PaymentMethod {
 }
 export declare namespace PaymentMethod {
     interface AcssDebit {
+        /**
+         * Account number of the bank account.
+         */
+        account_number?: string | null;
         /**
          * Name of the bank associated with the bank account.
          */
@@ -248,6 +283,7 @@ export declare namespace PaymentMethod {
         tax_id: string;
     }
     interface Card {
+        benefits?: Card.Benefits;
         /**
          * Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
          */
@@ -409,10 +445,18 @@ export declare namespace PaymentMethod {
          * Contains information about the Dashboard-only CustomPaymentMethodType logo.
          */
         logo: Custom.Logo | null;
+        /**
+         * A reference to an external payment method, such as a PayPal Billing Agreement ID.
+         */
+        payment_method_reference?: string | null;
         /**
          * ID of the Dashboard-only CustomPaymentMethodType. Not expandable.
          */
         type: string;
+        /**
+         * Indicates whether the payment method supports off-session payments.
+         */
+        usage?: 'off_session' | null;
     }
     interface CustomerBalance {
     }
@@ -432,10 +476,40 @@ export declare namespace PaymentMethod {
          */
         bank: Fpx.Bank;
     }
+    interface GiftCard {
+        /**
+         * The brand of the gift card.
+         */
+        brand: GiftCard.Brand;
+        /**
+         * The expiration month of the gift card.
+         */
+        exp_month: number | null;
+        /**
+         * The expiration year of the gift card.
+         */
+        exp_year: number | null;
+        /**
+         * Uniquely identifies the gift card.
+         */
+        fingerprint?: string;
+        /**
+         * The last four digits of the gift card number.
+         */
+        last4: string | null;
+    }
     interface Giropay {
     }
+    interface Gopay {
+    }
     interface Grabpay {
     }
+    interface IdBankTransfer {
+        bank: IdBankTransfer.Bank | null;
+        bank_code: string | null;
+        bank_name: string | null;
+        display_name: string | null;
+    }
     interface Ideal {
         /**
          * The customer's bank, if provided. Can be one of `abn_amro`, `adyen`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
@@ -598,6 +672,10 @@ export declare namespace PaymentMethod {
          * Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
          */
         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.
@@ -607,6 +685,13 @@ export declare namespace PaymentMethod {
          * 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 {
         /**
@@ -630,12 +715,23 @@ export declare namespace PaymentMethod {
     }
     interface Promptpay {
     }
+    interface Qris {
+    }
     interface RadarOptions {
         /**
          * A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
          */
         session?: string;
     }
+    interface Rechnung {
+        dob?: Rechnung.Dob;
+    }
+    interface Redaction {
+        /**
+         * Indicates whether this object and its related objects have been redacted or not.
+         */
+        status: Redaction.Status;
+    }
     interface RevolutPay {
     }
     interface SamsungPay {
@@ -670,19 +766,29 @@ export declare namespace PaymentMethod {
          */
         last4: string | null;
     }
+    interface Shopeepay {
+    }
     interface Sofort {
         /**
          * Two-letter ISO code representing the country the bank account is located in.
          */
         country: string | null;
     }
+    interface StripeBalance {
+        /**
+         * The connected account ID whose Stripe balance to use as the source of payment
+         */
+        account?: string | null;
+    }
     interface Sunbit {
     }
     interface Swish {
     }
+    interface Tamara {
+    }
     interface Twint {
     }
-    type Type = 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'bizum' | 'blik' | 'boleto' | 'card' | 'card_present' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'interac_present' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'mb_way' | 'mobilepay' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'oxxo' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'samsung_pay' | 'satispay' | 'scalapay' | 'sepa_debit' | 'sofort' | 'sunbit' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay' | 'zip';
+    type Type = 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'bizum' | 'blik' | 'boleto' | 'card' | 'card_present' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'gift_card' | 'giropay' | 'gopay' | 'grabpay' | 'id_bank_transfer' | 'ideal' | 'interac_present' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'mb_way' | 'mobilepay' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'oxxo' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'paypay' | 'payto' | 'pix' | 'promptpay' | 'qris' | 'rechnung' | 'revolut_pay' | 'samsung_pay' | 'satispay' | 'scalapay' | 'sepa_debit' | 'shopeepay' | 'sofort' | 'stripe_balance' | 'sunbit' | 'swish' | 'tamara' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay' | 'zip';
     interface Upi {
         /**
          * Customer's unique Virtual Payment Address
@@ -694,6 +800,10 @@ export declare namespace PaymentMethod {
          * Account holder type: individual or company.
          */
         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.
          */
@@ -732,6 +842,16 @@ export declare namespace PaymentMethod {
     interface Zip {
     }
     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`.
@@ -878,6 +998,7 @@ export declare namespace PaymentMethod {
                      * ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to.
                      */
                     location?: string;
+                    multicapture?: CardPresent.Multicapture;
                     /**
                      * Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
                      */
@@ -906,6 +1027,14 @@ export declare namespace PaymentMethod {
                      * ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on.
                      */
                     reader?: string;
+                    /**
+                     * Whether the PaymentIntent can be reauthorized or not.
+                     */
+                    reauthorization?: CardPresent.Reauthorization | null;
+                    /**
+                     * The time at which the associated PaymentIntent will transition to a terminal state if it is not reauthorized.
+                     */
+                    reauthorize_before?: number | null;
                     /**
                      * A collection of fields required to be displayed on receipts. Only required for EMV transactions.
                      */
@@ -913,6 +1042,12 @@ export declare namespace PaymentMethod {
                     wallet?: CardPresent.Wallet;
                 }
                 namespace CardPresent {
+                    interface Multicapture {
+                        /**
+                         * Indicates whether or not multiple captures are supported.
+                         */
+                        status: Multicapture.Status;
+                    }
                     interface Offline {
                         /**
                          * Time at which the payment was collected while offline
@@ -924,6 +1059,12 @@ export declare namespace PaymentMethod {
                         type: 'deferred' | null;
                     }
                     type ReadMethod = 'contact_emv' | 'contactless_emv' | 'contactless_magstripe_mode' | 'magnetic_stripe_fallback' | 'magnetic_stripe_track2';
+                    interface Reauthorization {
+                        /**
+                         * Indicates whether or not the reauthorization feature is supported.
+                         */
+                        status: Reauthorization.Status;
+                    }
                     interface Receipt {
                         /**
                          * The type of account being debited or credited
@@ -968,6 +1109,12 @@ export declare namespace PaymentMethod {
                          */
                         type: Wallet.Type;
                     }
+                    namespace Multicapture {
+                        type Status = 'available' | 'unavailable';
+                    }
+                    namespace Reauthorization {
+                        type Status = 'available' | 'unavailable';
+                    }
                     namespace Receipt {
                         type AccountType = 'checking' | 'credit' | 'prepaid' | 'unknown';
                     }
@@ -1078,6 +1225,12 @@ export declare namespace PaymentMethod {
         type AccountHolderType = 'company' | 'individual';
         type Bank = 'affin_bank' | 'agrobank' | 'alliance_bank' | 'ambank' | 'bank_islam' | 'bank_muamalat' | 'bank_of_china' | 'bank_rakyat' | 'bsn' | 'cimb' | 'deutsche_bank' | 'hong_leong_bank' | 'hsbc' | 'kfh' | 'maybank2e' | 'maybank2u' | 'ocbc' | 'pb_enterprise' | 'public_bank' | 'rhb' | 'standard_chartered' | 'uob';
     }
+    namespace GiftCard {
+        type Brand = 'fiserv_valuelink' | 'givex' | 'svs';
+    }
+    namespace IdBankTransfer {
+        type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
+    }
     namespace Ideal {
         type Bank = 'abn_amro' | 'adyen' | 'asn_bank' | 'bunq' | 'buut' | 'finom' | 'handelsbanken' | 'ing' | 'knab' | 'mollie' | 'moneyou' | 'n26' | 'nn' | 'rabobank' | 'regiobank' | 'revolut' | 'sns_bank' | 'triodos_bank' | 'van_lanschot' | 'yoursafe';
         type Bic = 'ABNANL2A' | 'ADYBNL2A' | 'ASNBNL21' | 'BITSNL2A' | 'BUNQNL2A' | 'BUUTNL2A' | 'FNOMNL22' | 'FVLBNL22' | 'HANDNL2A' | 'INGBNL2A' | 'KNABNL2H' | 'MLLENL2A' | 'MOYONL21' | 'NNBANL2G' | 'NTSBDEB1' | 'RABONL2U' | 'RBRBNL21' | 'REVOIE23' | 'REVOLT21' | 'SNSBNL2A' | 'TRIONL2U';
@@ -1120,12 +1273,35 @@ export declare namespace PaymentMethod {
     namespace P24 {
         type Bank = 'alior_bank' | 'bank_millennium' | 'bank_nowy_bfg_sa' | 'bank_pekao_sa' | 'banki_spbdzielcze' | 'blik' | 'bnp_paribas' | 'boz' | 'citi_handlowy' | 'credit_agricole' | 'envelobank' | 'etransfer_pocztowy24' | 'getin_bank' | 'ideabank' | 'ing' | 'inteligo' | 'mbank_mtransfer' | 'nest_przelew' | 'noble_pay' | 'pbac_z_ipko' | 'plus_bank' | 'santander_przelew24' | 'tmobile_usbugi_bankowe' | 'toyota_bank' | 'velobank' | 'volkswagen_bank';
     }
+    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;
+        }
+    }
+    namespace Redaction {
+        type Status = 'processing' | 'redacted' | 'validated';
+    }
     namespace SepaDebit {
         interface GeneratedFrom {
             /**
              * The ID of the Charge that generated this PaymentMethod, if any.
              */
             charge: string | Charge | null;
+            /**
+             * The ID of the PaymentMethod that generated this PaymentMethod, if any.
+             */
+            payment_method?: string | PaymentMethod | null;
             /**
              * The ID of the SetupAttempt that generated this PaymentMethod, if any.
              */
@@ -1266,14 +1442,26 @@ export interface PaymentMethodCreateParams {
      * If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
      */
     fpx?: PaymentMethodCreateParams.Fpx;
+    /**
+     * If this is a `gift_card` PaymentMethod, this hash contains details about the gift card payment method.
+     */
+    gift_card?: PaymentMethodCreateParams.GiftCard;
     /**
      * If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
      */
     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.
      */
@@ -1354,6 +1542,10 @@ export interface PaymentMethodCreateParams {
      * If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
      */
     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.
      */
@@ -1366,10 +1558,18 @@ export interface PaymentMethodCreateParams {
      * If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
      */
     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://docs.stripe.com/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.
      */
@@ -1390,10 +1590,18 @@ export interface PaymentMethodCreateParams {
      * If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
      */
     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 `sunbit` PaymentMethod, this hash contains details about the Sunbit payment method.
      */
@@ -1402,6 +1610,10 @@ export interface PaymentMethodCreateParams {
      * If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.
      */
     swish?: PaymentMethodCreateParams.Swish;
+    /**
+     * If this is a `tamara` PaymentMethod, this hash contains details about the Tamara payment method.
+     */
+    tamara?: PaymentMethodCreateParams.Tamara;
     /**
      * If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.
      */
@@ -1563,10 +1775,24 @@ export declare namespace PaymentMethodCreateParams {
          */
         bank: Fpx.Bank;
     }
+    interface GiftCard {
+        /**
+         * The gift card ID to redeem
+         */
+        gift_card: string;
+    }
     interface Giropay {
     }
+    interface Gopay {
+    }
     interface Grabpay {
     }
+    interface IdBankTransfer {
+        /**
+         * Bank where the account is held.
+         */
+        bank?: IdBankTransfer.Bank;
+    }
     interface Ideal {
         /**
          * The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
@@ -1640,6 +1866,8 @@ export declare namespace PaymentMethodCreateParams {
     }
     interface Paypal {
     }
+    interface Paypay {
+    }
     interface Payto {
         /**
          * The account number for the bank account.
@@ -1658,12 +1886,20 @@ export declare namespace PaymentMethodCreateParams {
     }
     interface Promptpay {
     }
+    interface Qris {
+    }
     interface RadarOptions {
         /**
          * A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
          */
         session?: string;
     }
+    interface Rechnung {
+        /**
+         * Customer's date of birth
+         */
+        dob: Rechnung.Dob;
+    }
     interface RevolutPay {
     }
     interface SamsungPay {
@@ -1678,19 +1914,29 @@ export declare namespace PaymentMethodCreateParams {
          */
         iban: string;
     }
+    interface Shopeepay {
+    }
     interface Sofort {
         /**
          * Two-letter ISO code representing the country the bank account is located in.
          */
         country: Sofort.Country;
     }
+    interface StripeBalance {
+        /**
+         * The connected account ID whose Stripe balance to use as the source of payment
+         */
+        account?: string;
+    }
     interface Sunbit {
     }
     interface Swish {
     }
+    interface Tamara {
+    }
     interface Twint {
     }
-    type Type = 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'bizum' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'mb_way' | 'mobilepay' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'oxxo' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'samsung_pay' | 'satispay' | 'scalapay' | 'sepa_debit' | 'sofort' | 'sunbit' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay' | 'zip';
+    type Type = 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'bizum' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'gift_card' | 'giropay' | 'gopay' | 'grabpay' | 'id_bank_transfer' | 'ideal' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'mb_way' | 'mobilepay' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'oxxo' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'paypay' | 'payto' | 'pix' | 'promptpay' | 'qris' | 'rechnung' | 'revolut_pay' | 'samsung_pay' | 'satispay' | 'scalapay' | 'sepa_debit' | 'shopeepay' | 'sofort' | 'stripe_balance' | 'sunbit' | 'swish' | 'tamara' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay' | 'zip';
     interface Upi {
         /**
          * Configuration options for setting up an eMandate
@@ -1741,6 +1987,9 @@ export declare namespace PaymentMethodCreateParams {
         type AccountHolderType = 'company' | 'individual';
         type Bank = 'affin_bank' | 'agrobank' | 'alliance_bank' | 'ambank' | 'bank_islam' | 'bank_muamalat' | 'bank_of_china' | 'bank_rakyat' | 'bsn' | 'cimb' | 'deutsche_bank' | 'hong_leong_bank' | 'hsbc' | 'kfh' | 'maybank2e' | 'maybank2u' | 'ocbc' | 'pb_enterprise' | 'public_bank' | 'rhb' | 'standard_chartered' | 'uob';
     }
+    namespace IdBankTransfer {
+        type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
+    }
     namespace Ideal {
         type Bank = 'abn_amro' | 'adyen' | 'asn_bank' | 'bunq' | 'buut' | 'finom' | 'handelsbanken' | 'ing' | 'knab' | 'mollie' | 'moneyou' | 'n26' | 'nn' | 'rabobank' | 'regiobank' | 'revolut' | 'sns_bank' | 'triodos_bank' | 'van_lanschot' | 'yoursafe';
     }
@@ -1766,6 +2015,22 @@ export declare namespace PaymentMethodCreateParams {
     namespace P24 {
         type Bank = 'alior_bank' | 'bank_millennium' | 'bank_nowy_bfg_sa' | 'bank_pekao_sa' | 'banki_spbdzielcze' | 'blik' | 'bnp_paribas' | 'boz' | 'citi_handlowy' | 'credit_agricole' | 'envelobank' | 'etransfer_pocztowy24' | 'getin_bank' | 'ideabank' | 'ing' | 'inteligo' | 'mbank_mtransfer' | 'nest_przelew' | 'noble_pay' | 'pbac_z_ipko' | 'plus_bank' | 'santander_przelew24' | 'tmobile_usbugi_bankowe' | 'toyota_bank' | 'velobank' | 'volkswagen_bank';
     }
+    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;
+        }
+    }
     namespace Sofort {
         type Country = 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL';
     }
@@ -1816,6 +2081,10 @@ export interface PaymentMethodUpdateParams {
      * If this is a `card` PaymentMethod, this hash contains the user's card details.
      */
     card?: PaymentMethodUpdateParams.Card;
+    /**
+     * If this is a `custom` PaymentMethod, this hash contains details about the Custom payment method.
+     */
+    custom?: PaymentMethodUpdateParams.Custom;
     /**
      * Specifies which fields in the response should be expanded.
      */
@@ -1871,6 +2140,16 @@ export declare namespace PaymentMethodUpdateParams {
          */
         networks?: Card.Networks;
     }
+    interface Custom {
+        /**
+         * A reference to an external payment method, such as a PayPal Billing Agreement ID.
+         */
+        payment_method_reference?: string;
+        /**
+         * Indicates whether the payment method supports off-session payments.
+         */
+        usage?: 'off_session';
+    }
     interface Payto {
         /**
          * The account number for the bank account.
@@ -1935,7 +2214,7 @@ export interface PaymentMethodListParams extends PaginationParams {
 }
 export declare namespace PaymentMethodListParams {
     type AllowRedisplay = 'always' | 'limited' | 'unspecified';
-    type Type = 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'bizum' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'mb_way' | 'mobilepay' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'oxxo' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'samsung_pay' | 'satispay' | 'scalapay' | 'sepa_debit' | 'sofort' | 'sunbit' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay' | 'zip';
+    type Type = 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'bizum' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'gift_card' | 'giropay' | 'gopay' | 'grabpay' | 'id_bank_transfer' | 'ideal' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'mb_way' | 'mobilepay' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'oxxo' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'paypay' | 'payto' | 'pix' | 'promptpay' | 'qris' | 'rechnung' | 'revolut_pay' | 'samsung_pay' | 'satispay' | 'scalapay' | 'sepa_debit' | 'shopeepay' | 'sofort' | 'stripe_balance' | 'sunbit' | 'swish' | 'tamara' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay' | 'zip';
 }
 export interface PaymentMethodAttachParams {
     /**
@@ -1951,9 +2230,17 @@ export interface PaymentMethodAttachParams {
      */
     expand?: Array<string>;
 }
+export interface PaymentMethodCheckBalanceParams {
+    /**
+     * Specifies which fields in the response should be expanded.
+     */
+    expand?: Array<string>;
+}
 export interface PaymentMethodDetachParams {
     /**
      * Specifies which fields in the response should be expanded.
      */
     expand?: Array<string>;
 }
+export interface PaymentMethodSerializeBatchAttachParams {
+}

package/cjs/resources/PaymentMethods.js

@@ -50,12 +50,32 @@ class PaymentMethodResource extends StripeResource_js_1.StripeResource {
     attach(id, params, options) {
         return this._makeRequest('POST', `/v1/payment_methods/${encodeURIComponent(id)}/attach`, params, options);
     }
+    /**
+     * Retrieves a PaymentMethod's Balance.
+     */
+    checkBalance(id, params, options) {
+        return this._makeRequest('POST', `/v1/payment_methods/${encodeURIComponent(id)}/check_balance`, params, options);
+    }
     /**
      * 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.
      */
     detach(id, params, options) {
         return this._makeRequest('POST', `/v1/payment_methods/${encodeURIComponent(id)}/detach`, params, options);
     }
+    serializeBatchAttach(paymentMethod, params = {}, options = {}) {
+        const itemId = this._stripe._platformFunctions.uuid4();
+        const stripeVersion = options.apiVersion || this._stripe.getApiField('version');
+        const entry = {
+            id: itemId,
+            params: params,
+            stripe_version: stripeVersion,
+        };
+        entry.path_params = { payment_method: paymentMethod };
+        if (options.stripeContext) {
+            entry.context = options.stripeContext;
+        }
+        return JSON.stringify(entry);
+    }
 }
 exports.PaymentMethodResource = PaymentMethodResource;
 //# sourceMappingURL=PaymentMethods.js.map