Stripe.js Reference

This is the API reference for Stripe.js. With Stripe.js’ APIs, you can tokenize user information, collect sensitive card data using customizable Stripe Elements, and accept payments with browser payment APIs like Apple Pay and the Payment Request API.

• Including Stripe.js
• The Stripe object
  • stripe.elements()
  • stripe.createToken()
  • stripe.createSource()
  • stripe.retrieveSource()
  • stripe.paymentRequest()
• The Elements object
  • elements.create()
• The Element
  • element.mount()
  • element.on()
  • Other methods
    • element.blur()
    • element.clear()
    • element.destroy()
    • element.focus()
    • element.unmount()
    • element.update()
• The Element container
• The PaymentRequest object
  • paymentRequest.canMakePayment()
  • paymentRequest.show()
  • paymentRequest.update()
  • paymentRequest.on()
• Other Payment Request object types
  • The PaymentResponse object
  • The UpdateDetails object
  • The ShippingOption object
  • The shippingAddress object

Including Stripe.js

However you’re using Stripe.js, you always begin by including the library and setting your API key. To get started, include this script on your pages—it should always be loaded directly from https://js.stripe.com:

<script src="https://js.stripe.com/v3/"></script>

To best leverage Stripe’s advanced fraud functionality, include this script on every page on your site, not just the checkout page. This allows Stripe to detect anomalous behavior that may be indicative of fraud as users browse your website.

Stripe(publishableKey[, options])

Use Stripe(publishableKey[, options]) to create an instance of the Stripe object. Your Stripe publishable API key is required when calling this function, as it identifies your website to Stripe:

var stripe = Stripe('pk_test_6pRNASCoBOKtIshFeQd4XMUh');

const stripe = Stripe('pk_test_6pRNASCoBOKtIshFeQd4XMUh');

We‘ve placed a random API key in the code. Replace it with your actual publishable API key to test this code through your Stripe account.

When you’re ready to accept live payments, replace the test key with your live key in production. Learn more about how API keys work in test mode and live mode.

This function accepts an optional options object. Available options are documented below:

The Stripe object

• stripe.elements()
• stripe.createToken()
• stripe.createSource()
• stripe.retrieveSource()
• stripe.paymentRequest()

stripe.elements([options])

Create pre-built UI components to collect sensitive card information with Elements.

var elements = stripe.elements();

const elements = stripe.elements();

This method creates an instance of elements, which manages a group of Elements. It accepts an optional options object. Available options are documented below:

stripe.createToken(element[, cardData])

Use stripe.createToken to convert card information collected by Elements into a single-use token that you safely pass to your server to use in an API call.

stripe.createToken(card).then(function(result) {
  // Handle result.error or result.token
});

const {token, error} = await stripe.createToken(card);

This method takes two arguments:

• element: the Element you wish to tokenize data from. The Element will pull data from other Elements you’ve created on the same instance of elements to tokenize.
• cardData: an optional object containing any of the following parameters:

Although these fields are optional, we highly recommend collecting name and address. This information can be used to perform a number of verifications, such as CVC, ZIP, and address verification. Radar includes built-in rules that can block payments where the ZIP or CVC verifications with the cardholder’s bank failed.

stripe.createToken returns a Promise which resolves with a result object. This object has either:

• result.token: a Token was created successfully.
• result.error: there was an error. This includes client-side validation errors. Refer to the API reference for all possible errors.

stripe.createToken('bank_account', bankAccountData)

Use stripe.createToken to convert bank account information into a single-use token that you safely pass to your server to use in an API call.

stripe.createToken('bank_account', {
  country: 'US',
  currency: 'usd',
  routing_number: '110000000',
  account_number: '000123456789',
  account_holder_name: 'Jenny Rosen',
  account_holder_type: 'individual',
}).then(function(result) {
  // Handle result.error or result.token
});

const {token, error} = await stripe.createToken('bank_account', {
  country: 'US',
  currency: 'usd',
  routing_number: '110000000',
  account_number: '000123456789',
  account_holder_name: 'Jenny Rosen',
  account_holder_type: 'individual',
});

Using stripe.createToken for bank account details requires an object containing the following parameters:

stripe.createToken returns a Promise which resolves with a result object. This object has either:

• result.token: a Token was created successfully.
• result.error: there was an error. This includes client-side validation errors. Refer to the API reference for all possible errors.

stripe.createToken('pii', piiData)

Use stripe.createToken to convert personally identifiable information (PII) into a single-use token for account identity verification.

stripe.createToken('pii', {
  personal_id_number: '123131185',
}).then(function(result) {
  // Handle result.error or result.token
});

const {token, error} = await stripe.createToken('pii', {
  personal_id_number: '123131185',
});

Using stripe.createToken for PII data requires an object containing the following parameter:

stripe.createToken returns a Promise which resolves with a result object. This object has either:

• result.token: a Token was created successfully.
• result.error: there was an error. This includes client-side validation errors. Refer to the API reference for all possible errors.

stripe.createSource(element[, sourceData])

Use stripe.createSource(element, sourceData) to convert payment information collected by Elements into a Source object that you safely pass to your server to use in an API call. See the Sources documentation for more information about Sources.

stripe.createSource(card, {
  owner: {
    name: 'Jenny Rosen',
  },
}).then(function(result) {
  // Handle result.error or result.source
});

const {source, error} = await stripe.createSource(card, {
  owner: {
    name: 'Jenny Rosen',
  },
});

This method takes two arguments:

• element: the Element containing payment source information. The Element will pull data from other Elements you’ve created on the same instance of elements. The Element will determine the type of the Source returned. For example, the card and cardNumber Elements will create card Sources.
• sourceData: an optional object containing additional payment source information that you have collected. See the Sources API reference for details.

stripe.createSource returns a Promise which resolves with a result object. This object has either:

• result.source: a Source was created successfully.
• result.error: there was an error. This includes client-side validation errors. Refer to the API reference for all possible errors.

stripe.createSource(sourceData)

Use stripe.createSource(sourceData) to convert raw non-card payment information into a Source object that you safely pass to your server to use in an API call. See the Sources documentation for more information about Sources. Note that you must use stripe.createSource(element, sourceData) for card Sources.

stripe.createSource({
  type: 'ideal',
  amount: 1099,
  currency: 'eur',
  owner: {
    name: 'Jenny Rosen',
  },
  redirect: {
    return_url: 'https://shop.example.com/crtA6B28E1',
  },
}).then(function(result) {
  // Handle result.error or result.source
});

const {source, error} = await stripe.createSource({
  type: 'ideal',
  amount: 1099,
  currency: 'eur',
  owner: {
    name: 'Jenny Rosen',
  },
  redirect: {
    return_url: 'https://shop.example.com/crtA6B28E1',
  },
});

This method accepts one argument, sourceData, which is an object containing payment source information that you have collected. See the Sources API reference for details.

stripe.createSource returns a Promise which resolves with a result object. This object has either:

• result.source: a Source was created successfully.
• result.error: there was an error. This includes client-side validation errors. Refer to the API reference for all possible errors.

stripe.retrieveSource(source)

Retrieve a Source using its unique ID and client secret.

stripe.retrieveSource({
  id: "src_18eYalAHEMiOZZp1l9ZTjSU0",
  client_secret: "src_client_secret_NibvRz4PMmJqjfb0sqmT7aq2",
}).then(function(result) {
  // Handle result.error or result.source
});

const {source, error} = await stripe.retrieveSource({
  id: "src_18eYalAHEMiOZZp1l9ZTjSU0",
  client_secret: "src_client_secret_NibvRz4PMmJqjfb0sqmT7aq2",
});

This method accepts an object source with the following required parameters:

You can use a Source object created with stripe.createSource as the argument to retrieveSource, as every Source object will have both id and client_secret keys.

stripe.retrieveSource returns a Promise which resolves with a result object. This object has either:

• result.source: a Source was retrieved successfully.
• result.error: there was an error. Refer to the API reference for all possible errors.

stripe.paymentRequest(options)

Use stripe.paymentRequest to create a PaymentRequest object. A PaymentRequest object is used to collect payment information through an interface controlled and styled by the browser itself (i.e., not by you or your page). See the Payment Request Button Element quickstart for a high-level overview of when you’d want to do this. In Safari, stripe.paymentRequest uses Apple Pay, and in other browsers it uses the Payment Request API standard.

Creating a PaymentRequest requires that you configure it with an options object. Available options are documented below.

You can update a subset of these options after creating the PaymentRequest using paymentRequest.update.

The Elements object

• elements.create(type[, options])

elements.create(type[, options])

var card = elements.create('card');

const card = elements.create('card');

This method creates an instance of a specific Element.

It takes the type of Element to create as well as an optional options object.

Element types

Element options

Here is an example that customizes the base and invalid states of a card Element:

var style = {
  base: {
    color: '#303238',
    fontSize: '16px',
    lineHeight: '48px',
    fontSmoothing: 'antialiased',
    '::placeholder': {
      color: '#ccc',
    },
  },
  invalid: {
    color: '#e5424d',
    ':focus': {
      color: '#303238',
    },
  },
};
var cardElement = elements.create('card', {style: style})

const style = {
  base: {
    color: '#303238',
    fontSize: '16px',
    lineHeight: '48px',
    fontSmoothing: 'antialiased',
    '::placeholder': {
      color: '#ccc',
    },
  },
  invalid: {
    color: '#e5424d',
    ':focus': {
      color: '#303238',
    },
  },
};
const cardElement = elements.create('card', {style})

The Element

• element.mount()
• element.on()
• Other methods
  • element.blur()
  • element.clear()
  • element.destroy()
  • element.focus()
  • element.unmount()
  • element.update()

element.mount(domElement)

You will need to create a container DOM element in order to mount an Element. If it has a label, it will be automatically focused when its label is clicked. There are two ways to do this:

1. Mount the instance within a <label>.

   <label>Card
     <div id="card-element"></div>
   </label>

2. Create a <label> with a for attribute, referencing the ID of your container.

   <label for="card-element">Card</label>
   <div id="card-element"></div>

The mount method attaches your element to the DOM. mount accepts either a CSS Selector (e.g., '#card-element') or a DOM element.

cardElement.mount('#card-element');

element.on(event, handler)

The only way to communicate with your element is by listening to an event. Elements might emit any of these events:

Input validation

Elements validates user input as it is typed. To help your customers catch mistakes, you should listen to change events on the card Element and display any errors:

card.addEventListener('change', function(event) {
  var displayError = document.getElementById('card-errors');
  if (event.error) {
    displayError.textContent = event.error.message;
  } else {
    displayError.textContent = '';
  }
});

card.addEventListener('change', ({error}) => {
  const displayError = document.getElementById('payment-errors');
  if (error) {
    displayError.textContent = error.message;
  }
});

Postal code formatting

Elements automatically determines your customer’s billing address country based on their card number. Using this information, the postal code field validation reflects whether that country uses numeric or alphanumeric-formatted postal codes, or if the country uses postal codes at all. For instance, if a U.S. card is entered, the postal code field only accepts a five-digit numeric value. If it’s a UK card, an alphanumeric value can be provided instead.

Many of our test cards have a U.S. billing address country. When using these to test your payment form, you must also use a five-digit U.S. ZIP code (e.g., 12345). To test Elements with other postal code formats, use our international test card numbers.

Other methods

If you collect certain information in a different part of your interface (e.g., ZIP or postal code), use update() with the appropriate information.

var myPostalCodeField = document.querySelector('input[name="my-postal-code"]');
myPostalCodeField.addEventListener('change', function(event) {
  card.update({value: {postalCode: event.target.value}});
});

const myPostalCodeField = document.querySelector('input[name="my-postal-code"]');
myPostalCodeField.addEventListener('change', ({target}) => {
  card.update({value: {postalCode: target.value}});
});

You can also dynamically change the styles of an Element using update(). This method can be used to simulate CSS media queries that automatically adjust the size of Elements when viewed on different devices.

window.addEventListener('resize', function(event) {
  if (window.innerWidth <= 320) {
    card.update({style: {base: {fontSize: '13px'}}});
  } else {
    card.update({style: {base: {fontSize: '16px'}}});
  }
});

var previousBrand;
card.on('change', function(event) {
  if (event.brand !== previousBrand && event.brand === 'mastercard') {
    card.update({style: {base: {color: 'orange'}}});
    previousBrand = event.brand;
  }
});

window.addEventListener('resize', (event) => {
  if (window.innerWidth <= 320) {
    card.update({style: {base: {fontSize: '13px'}}});
  } else {
    card.update({style: {base: {fontSize: '16px'}}});
  }
});

let previousBrand;
card.on('change', ({brand}) => {
  if (brand !== previousBrand && brand === 'mastercard') {
    card.update({style: {base: {color: 'orange'}}});
    previousBrand = event.brand;
  }
});

The Element container

You should style the container you mount an Element to as if it were an <input> on your page. For example, to control padding and border on an Element, set these properties on the container. This is usually done by re-using the classes that you have applied to your DOM <input>s. Example:

<style>
 .my-input {
   padding: 10px;
   border: 1px solid #ccc;
 }
</style>

<form>
  <div>
    <label>Name</label>
    <input class="my-input">
  </div>
  <div>
    <label>Card</label>
    <!-- Using the same "my-input" class on the -->
    <!-- regular input above and on this container. -->
    <div class="my-input" id="card-element"></div>
  </div>
</form>

After the Element is mounted, the .StripeElement class is added to the container. Additionally, the following classes are automatically added to the container when the Element is complete, empty, focused, invalid, or autofilled by the browser:

• .StripeElement--complete
• .StripeElement--empty
• .StripeElement--focus
• .StripeElement--invalid
• .StripeElement--webkit-autofill (Chrome and Safari only)

You can override these class names using the classes option when you create an Element.

The PaymentRequest object

• paymentRequest.canMakePayment()
• paymentRequest.show()
• paymentRequest.update()
• paymentRequest.on()

For a quick overview of how to use the PaymentRequest object, see the Payment Request Button guide.

paymentRequest.canMakePayment()

Returns a Promise that resolves with a payload if a browser payment API is available. If no API is available, it will resolve with null. The resolution object has these properties:

paymentRequest.show()

Shows the browser’s payment interface. If you are using the paymentRequestButton Element, this will be called for you under the hood. This method must be called as the result of a user interaction (for example, in a click handler).

paymentRequest.update(options)

You can update a PaymentRequest with an options object. Available options are documented below.

paymentRequest.update can only be called when the browser payment sheet is not showing. You can listen to the click and cancel events to detect if the payment sheet is showing. If you want to update the PaymentRequest right before the payment sheet is opened, you may call paymentRequest.update in your click event handler.

paymentRequest.on(event, handler)

The way you communicate with a PaymentRequest is by listening for an event. These are valid values of event that you can listen to:

Other Payment Request object types

A number of types show up in multiple places the when using the PaymentRequest object or the paymentRequestButton.

• The PaymentResponse object
• The UpdateDetails object
• The ShippingOption object
• The ShippingAddress object

The PaymentResponse object

This object is returned as the payload of the token and source event handlers.

The UpdateDetails object

The UpdateDetails object is used to update certain parts of a PaymentRequest object after it has already been created. See the updateWith callback functions above.

The ShippingOption object

A ShippingOption is a normal JavaScript object you create that has the following parameters. You can use these objects to let the customer select their preferred shipping method.

The ShippingAddress object

You can use the requestShipping option to stripe.paymentRequest() to collect shipping information from the customer. This is the shape of the shipping address the customer enters:

Supported browsers

Stripe.js strives to support all recent versions of major browsers. For the sake of security and providing the best experience to the majority of customers, we do not support browsers that are no longer receiving security updates and represent a small minority of traffic.

• We support Internet Explorer and Edge per Microsoft's lifecycle policy. As of January 12, 2016, we support Internet Explorer 9 and above.
• We support Chrome and Safari on all platforms and Firefox on desktop platforms.
• We support the Android native browser on Android 4.4 and later.
• We require TLS 1.2 to be supported by the browser.
• We respond to bug reports but do not proactively test other mobile browsers.

If you have an issue with Stripe.js on a specific browser, please contact us so we can improve its support.