@stripe/stripe-js

property city

city?: string;

• City, district, suburb, town, or village.

property country

country?: string;

• Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

property line1

line1?: string;

• Address line 1 (e.g., street, PO Box, or company name).

property line2

line2?: string;

• Address line 2 (e.g., apartment, suite, unit, or building).

property postal_code

postal_code?: string;

• ZIP or postal code.

property state

state?: string;

• State, county, province, or region.

property city

city: string | null;

• City/District/Suburb/Town/Village.

property country

country: string | null;

• 2-letter country code.

property line1

line1: string | null;

• Address line 1 (Street address/PO Box/Company name).

property line2

line2: string | null;

• Address line 2 (Apartment/Suite/Unit/Building).

property postal_code

postal_code: string | null;

• ZIP or postal code.

property state

state: string | null;

• State/County/Province/Region.

property line1

line1: string;

• Address line 1 (e.g., street, PO Box, or company name).

property disableAnimations

disableAnimations?: boolean;

property labels

labels?: 'above' | 'floating';

property rules

rules?: {
    [selector: string]: {
        [cssPropertyName: string]: string;
    };
};

property theme

theme?: 'stripe' | 'night' | 'flat' | 'none';

property variables

variables?: {
    // General font styles
    fontFamily?: string;
    fontSmooth?: string;
    fontVariantLigatures?: string;
    fontVariationSettings?: string;
    fontLineHeight?: string;

    // Font sizes
    fontSizeBase?: string;
    fontSizeSm?: string;
    fontSizeXs?: string;
    fontSize2Xs?: string;
    fontSize3Xs?: string;
    fontSizeLg?: string;
    fontSizeXl?: string;

    // Font weights
    fontWeightLight?: string;
    fontWeightNormal?: string;
    fontWeightMedium?: string;
    fontWeightBold?: string;

    // Spacing
    spacingUnit?: string;
    spacingGridRow?: string;
    spacingGridColumn?: string;
    spacingTab?: string;

    // Colors
    colorPrimary?: string;
    colorPrimaryText?: string;
    colorBackground?: string;
    colorBackgroundText?: string;
    colorText?: string;
    colorSuccess?: string;
    colorSuccessText?: string;
    colorDanger?: string;
    colorDangerText?: string;
    colorWarning?: string;
    colorWarningText?: string;

    // Text variations
    colorTextSecondary?: string;
    colorTextPlaceholder?: string;

    // Icons
    colorIcon?: string;
    colorIconHover?: string;
    colorIconCardError?: string;
    colorIconCardCvc?: string;
    colorIconCardCvcError?: string;
    colorIconCheckmark?: string;
    colorIconChevronDown?: string;
    colorIconChevronDownHover?: string;
    colorIconRedirect?: string;
    colorIconTab?: string;
    colorIconTabHover?: string;
    colorIconTabSelected?: string;
    colorIconTabMore?: string;
    colorIconTabMoreHover?: string;

    // Logos
    colorLogo?: string;
    colorLogoTab?: string;
    colorLogoTabSelected?: string;
    colorLogoBlock?: string;

    // Focus
    focusBoxShadow?: string;
    focusOutline?: string;

    // Radius
    borderRadius?: string;
};

property account_holder_name

account_holder_name: string | null;

• The name of the person or business that owns the bank account.

property account_holder_type

account_holder_type: string | null;

• The type of entity that holds the account. This can be either individual or company.

property bank_name

bank_name: string | null;

• Name of the bank associated with the routing number (e.g., WELLS FARGO).

property country

country: string;

• Two-letter ISO code representing the country the bank account is located in.

property currency

currency: string;

• Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.

property fingerprint

fingerprint: string | null;

• Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

property id

id: string;

• Unique identifier for the object.

property last4

last4: string;

• The last four digits of the bank account number.

property object

object: 'bank_account';

• String representing the object's type. Objects of the same type share the same value.

property routing_number

routing_number: string | null;

• The routing transit number for the bank account.

property status

status: string;

• For bank accounts, possible values are new, validated, verified, verification_failed, or errored. A bank account that hasn't had any activity or validation performed is new. If Stripe can determine that the bank account exists, its status will be validated. Note that there often isn't enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be verified. If the verification failed for any reason, such as microdeposit failure, the status will be verification_failed. If a transfer sent to this bank account fails, we'll set the status to errored and will not continue to send transfers until the bank details are updated.

  For external accounts, possible values are new and errored. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to errored and transfers are stopped until account details are updated.

property address_city

address_city: string | null;

• City/District/Suburb/Town/Village.

property address_country

address_country: string | null;

• Billing address country, if provided when creating card.

property address_line1

address_line1: string | null;

• Address line 1 (Street address/PO Box/Company name).

property address_line1_check

address_line1_check: string | null;

• If address_line1 was provided, results of the check: pass, fail, unavailable, or unchecked.

property address_line2

address_line2: string | null;

• Address line 2 (Apartment/Suite/Unit/Building).

property address_state

address_state: string | null;

• State/County/Province/Region.

property address_zip

address_zip: string | null;

• ZIP or postal code.

property address_zip_check

address_zip_check: string | null;

• If address_zip was provided, results of the check: pass, fail, unavailable, or unchecked.

property brand

brand: string;

• Card brand. Can be American Express, Diners Club, Discover, JCB, MasterCard, UnionPay, Visa, or Unknown.

property country

country: 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.

property currency

currency?: string | null;

• Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

property customer

customer?: string | null;

• The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.

property cvc_check

cvc_check: string | null;

• If a CVC was provided, results of the check: pass, fail, unavailable, or unchecked.

property dynamic_last4

dynamic_last4: string | null;

• (For tokenized numbers only.) The last four digits of the device account number.

property exp_month

exp_month: number;

• Two-digit number representing the card's expiration month.

property exp_year

exp_year: number;

• Four-digit number representing the card's expiration year.

property fingerprint

fingerprint?: string | null;

• Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.

property funding

funding: string;

• Card funding type. Can be credit, debit, prepaid, or unknown.

property id

id: string;

• Unique identifier for the object.

property last4

last4: string;

• The last four digits of the card.

property metadata

metadata: Metadata;

• Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

property name

name: string | null;

• Cardholder name.

property object

object: 'card';

• String representing the object's type. Objects of the same type share the same value.

property tokenization_method

tokenization_method: string | null;

• If the card number is tokenized, this is the method that was used. Can be apple_pay or google_pay.

property clientSecret

clientSecret: string;

• The client secret of the PaymentIntent.

property expand

expand?: Array<string>;

• Specifies which fields in the response should be expanded.

property params

params: CollectBankAccountParams;

property clientSecret

clientSecret: string;

• The client secret of the SetupIntent.

property expand

expand?: Array<string>;

• Specifies which fields in the response should be expanded.

property params

params: CollectBankAccountParams;

property payment_method_data

payment_method_data: CollectBankAccountPaymentMethodData;

• Payment method specific data to be sent with the request (billing details)

property payment_method_type

payment_method_type: string;

• The payment method type for the bank account details (e.g. us_bank_account)

property billing_details

billing_details: PaymentMethodCreateParams.BillingDetails;

• The customer's billing details. name, email, and address are required.

  https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details

property payment_method

payment_method?: string | Omit<CreatePaymentMethodAcssDebitData, 'type'>;

• Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property skipMandate

skipMandate?: boolean;

• Set skipMandate to true if you want to skip displaying the mandate confirmation screen.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodAcssDebitData, 'type'>;

• Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this SetupIntent.

property skipMandate

skipMandate?: boolean;

• Set this to true if you want to skip displaying the mandate confirmation.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodAffirmData, 'type'>;

• Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property return_url

return_url?: string;

• The url your customer will be directed to after they complete authentication.

property handleActions

handleActions?: boolean;

• Set this to false if you want to handle next actions yourself. Please refer to our [Stripe Affirm integration guide](https://stripe.com/docs/payments/affirm/accept-a-payment) for more info. Default is true.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodAfterpayClearpayData, 'type'>;

• Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property return_url

return_url?: string;

• The url your customer will be directed to after they complete authentication.

property handleActions

handleActions?: boolean;

• Set this to false if you want to handle next actions yourself. Please refer to our [Stripe Afterpay / Clearpay integration guide](https://stripe.com/docs/payments/afterpay-clearpay/accept-a-payment#handle-redirect) for more info. Default is true.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodAlipayData, 'type'>;

• The id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods). This field is optional if a PaymentMethod has already been attached to this PaymentIntent or a new PaymentMethod will be created.

property return_url

return_url?: string;

• The url your customer will be directed to after they complete authentication.

property handleActions

handleActions?: boolean;

• Set this to false if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/alipay/accept-a-payment#handle-redirect). Default is true.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodAuBecsDebitData, 'type'>;

• Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property setup_future_usage

setup_future_usage?: 'off_session';

• To save the BECS Direct Debit account for reuse, set this parameter to off_session. BECS Direct Debit only accepts an off_session value for this parameter.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodAuBecsDebitData, 'type'>;

property payment_method

payment_method?: string | Omit<CreatePaymentMethodBacsDebitData, 'type'>;

property payment_method

payment_method?: string | Omit<CreatePaymentMethodBancontactData, 'type'>;

• Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property return_url

return_url?: string;

• The url your customer will be directed to after they complete authentication.

property handleActions

handleActions?: boolean;

• Set this to false if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/bancontact#handle-redirect). Default is true.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodBancontactData, 'type'>;

property payment_method

payment_method?: string | Omit<CreatePaymentMethodBoletoData, 'type'>;

• Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property handleActions

handleActions?: boolean;

• Set this to false if you want to handle next actions yourself. Please refer to our [Stripe Boleto integration guide](https://stripe.com/docs/payments/boleto) for more info. Default is true.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodCardData, 'type'>;

• Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property payment_method_options

payment_method_options?: {
    /**
     * Configuration for this card payment.
     */
    card: {
        /**
         * Use the provided `CardCvcElement` when confirming the PaymentIntent with an existing PaymentMethod.
         */
        cvc?: StripeCardCvcElement;

        /**
         * Selected network to process this PaymentIntent on. Depends on the available networks of the card attached to the PaymentIntent.
         */
        network?: string;
    };
};

• An object containing payment-method-specific configuration to confirm the [PaymentIntent](https://stripe.com/docs/api/payment_intents) with.

property handleActions

handleActions?: boolean;

• Set this to false if you want to [handle next actions yourself](https://stripe.com/docs/payments/payment-intents/verifying-status#next-actions), or if you want to defer next action handling until later (e.g. for use in the [PaymentRequest API](https://stripe.com/docs/stripe-js/elements/payment-request-button#complete-payment-intents)). Default is true.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodCardData, 'type'>;

property handleActions

handleActions?: boolean;

property payment_method

payment_method: CreatePaymentMethodCustomerBalanceData;

• An object specifying the customer_balance type.

property payment_method_options

payment_method_options?: {
    customer_balance?: {
        funding_type?: 'bank_transfer';
        bank_transfer?: {
            type:
                | 'us_bank_account'
                | 'eu_bank_account'
                | 'id_bank_account'
                | 'gb_bank_account'
                | 'jp_bank_account'
                | 'mx_bank_account';
            eu_bank_account?: {
                country: 'ES' | 'FR' | 'IE' | 'NL';
            };
            id_bank_account?: {
                bank: 'bni' | 'bca';
            };
            requested_address_types?: Array<
                | 'aba'
                | 'swift'
                | 'sort_code'
                | 'zengin'
                | 'iban'
                | 'spei'
                | 'id_bban'
                | 'sepa'
            >;
        };
    };
};

property handleActions

handleActions: false;

• This must be set to false. The Customer Balance does not handle the next actions for you automatically (e.g. displaying bank transfer details). To make future upgrades easier, this option is required to always be sent. Please refer to our [Stripe Customer Balance integration guide](https://stripe.com/docs/payments/bank-transfers) for more info.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodEpsData, 'type'>;

• Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property return_url

return_url?: string;

• The url your customer will be directed to after they complete authentication.

property handleActions

handleActions?: boolean;

• Set this to false if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/eps#handle-redirect). Default is true.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodFpxData, 'type'>;

• Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property return_url

return_url?: string;

• The url your customer will be directed to after they complete authentication.

property handleActions

handleActions?: boolean;

• Set this to false if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/fpx#handle-redirect). Default is true.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodGiropayData, 'type'>;

• Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property return_url

return_url?: string;

• The url your customer will be directed to after they complete authentication.

property handleActions

handleActions?: boolean;

• Set this to false if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/giropay#handle-redirect). Default is true.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodGrabPayData, 'type'>;

• Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property return_url

return_url?: string;

• The url your customer will be directed to after they complete authentication.

property handleActions

handleActions?: boolean;

• Set this to false if you want to handle next actions yourself. Please refer to our [Stripe GrabPay integration guide](https://stripe.com/docs/payments/grabpay/accept-a-payment) for more info. Default is true.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodIdealData, 'type'>;

• Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property return_url

return_url?: string;

• The url your customer will be directed to after they complete authentication.

property handleActions

handleActions?: boolean;

• Set this to false if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/ideal#handle-redirect). Default is true.

property payment_method

payment_method?: string | Omit<CreatePaymentMethodIdealData, 'type'>;

property payment_method

payment_method?: string | Omit<CreatePaymentMethodKlarnaData, 'type'>;

• Either the id of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a PaymentMethod with. This field is optional if a PaymentMethod has already been attached to this PaymentIntent.

property return_url

return_url?: string;

• The url your customer will be directed to after they complete authentication.

property handleActions

handleActions?: boolean;

• Set this to false if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/klarna#handle-redirect). Default is true.