Stripe Payment Element

The Payment Element is a UI component for the web that lets you accept more than 100 payment methods, validates input, and handles errors. Use it alone or with other elements in your web apps front end.

Compatible APIs

Stripe offers two core payments APIs compatible with Elements. We recommend the Checkout Sessions API for most integrations.

• Use the Checkout Sessions API to build your checkout flow. Checkout Sessions covers similar use cases as Payment Intents, including basic payments using price_data or full checkout with line items, tax, discounts, shipping, subscriptions, or Adaptive Pricing (only available with Checkout Sessions).

  Build a checkout page with the Checkout Sessions API.

• The Payment Intents API is a lower-level API that models only the payment step. You pass in a final amount and build all checkout logic yourself, including tax calculation, discounts, shipping, subscriptions, and currency conversion. Use Payment Intents only if you want to deeply own your checkout state and build these features yourself.

  Build a custom integration from scratch with the Payment Intents API.

Combine elements

The Payment Element interoperates with other elements. For instance, this form uses one additional element to autofill checkout details, and another to collect the shipping address.

[A form with contact info, shipping address, and payment fields. The contact info is labeled Contact Details Element, the shipping address is labeled Address Element, and the payment fields are labeled Payment Element.]Payment form combining multiple elements

For the complete code for this example, see Add Link to an Elements integration.

You can also combine the Payment Element with the Express Checkout Element. In this case, wallet payment methods such as Apple Pay and Google Pay are only displayed in the Express Checkout Element to avoid duplication.

Payment methods

Stripe enables certain payment methods for you by default. We might also enable additional payment methods after notifying you. Use the Dashboard to enable or disable payment methods at any time. With the Payment Element, you can use Dynamic payment methods to:

• Manage payment methods in the Dashboard without coding
• Dynamically display the most relevant payment options based on factors such as location, currency, and transaction amount

For instance, if a customer in Germany is paying in EUR, they see all the active payment methods that accept EUR, starting with ones that are widely used in Germany.

[A variety of payment methods.]

Show payment methods in order of relevance to your customer

To further customize how payment methods render, see Customize payment methods. To add payment methods integrated outside of Stripe, you can use custom payment methods.

If your integration requires you to list payment methods manually, see Manually list payment methods.

Layout

You can customize the Payment Elements layout to fit your checkout flow. The following image is the same Payment Element rendered using different layout configurations.

[Examples of the three checkout forms. The image shows the tab option, where customers pick from payment methods shown as tabs or the two accordion options, where payment methods are vertically listed. You can choose to either display radio buttons or not in the accordion view.]

Payment Element with different layouts.

const stripe = Stripe('pk_test_YVzIqUTwiCYcEXO1DPqDrM98');

const appearance = { /* appearance */ };
const options = {
  layout: {
    type: 'tabs',
    defaultCollapsed: false,
  }
};

Appearance

Use the Appearance API to control the style of all elements. Choose a theme or update specific details.

[Examples of light and dark modes for the payment element checkout form.]

For instance, choose the flat theme and override the primary text color.

const stripe = Stripe('pk_test_YVzIqUTwiCYcEXO1DPqDrM98');

const appearance = {
  theme: 'flat',
  variables: { colorPrimaryText: '#262626' }
};

See the Appearance API documentation for a full list of themes and variables.

Options

Stripe elements support more options than these. For instance, display your business name using the business option.

const stripe = Stripe('pk_test_YVzIqUTwiCYcEXO1DPqDrM98');

const appearance = { /* appearance */};
const options = {
  business: { name: "RocketRides" }
};

The Payment Element supports the following options. See each optionss reference entry for more information.

Errors

Payment Element automatically shows localized customer-facing error messages during client confirmation for the following decline codes:

• card_declined
• card_velocity_exceeded
• expired_card
• fraudulent
• generic_decline
• incorrect_cvc
• incorrect_number
• incorrect_zip
• insufficient_funds
• invalid_cvc
• invalid_expiry_month
• invalid_expiry_year
• live_mode_test_card
• lost_card
• processing_error
• stolen_card
• test_mode_live_card

To display messages for other types of errors, refer to error codes and error handling.