# Stripe Crypto JS ES Module Use [Stripe Crypto JS SDK](https://stripe.com/docs/crypto) as an ES module. **Note**: This package dynamically loads the Stripe Crypto JS SDK from `https://crypto-js.stripe.com` and [Stripe.js](https://stripe.com/docs/stripe-js) from `https://js.stripe.com`. To be [PCI compliant](https://stripe.com/docs/security/guide#validating-pci-compliance), you must load Stripe.js directly from `https://js.stripe.com`. You cannot include it in a bundle or host it yourself. [![npm version](https://img.shields.io/npm/v/@stripe/crypto.svg?style=flat-square)](https://www.npmjs.com/package/@stripe/crypto) ## Installation Use `npm` to install the Stripe.js and Stripe Crypto JS module: ```sh npm install @stripe/stripe-js @stripe/crypto ``` ## Usage ### `loadStripeOnramp` This function returns a `Promise` that resolves with a newly created `StripeOnramp` object once Stripe Crypto JS SDK has loaded. If necessary, it will load Stripe Crypto JS and Stripe.js for you by inserting the script tags. If you call `loadStripeOnramp` in a server environment it will resolve to `null`. ```js import {loadStripeOnramp} from '@stripe/crypto'; const stripeOnramp = await loadStripeOnramp('pk_test_TYooMQauvdEDq54NiTphI7jx'); ``` We’ve placed a random API key in this example. Replace it with your [actual publishable API keys](https://dashboard.stripe.com/account/apikeys) to test this code through your Stripe account. For more information on how to use Stripe Crypto JS SDK, please refer to the [Stripe Crypto docs](https://stripe.com/docs/crypto). If you have deployed a [Content Security Policy](https://developer.mozilla.org/en-US/docs/Web/Security/CSP), make sure to [include Stripe.js in your directives](https://stripe.com/docs/security/guide#content-security-policy). ## TypeScript support This package includes TypeScript declarations for Stripe Crypto JS SDK. We support projects using TypeScript versions >= 3.1. Some methods in Stripe Crypto JS SDK accept and return objects from the [Stripe API](https://stripe.com/docs/api). The type declarations in `@stripe/crypto` for these objects in will always track the [latest version](https://stripe.com/docs/api/versioning) of the Stripe API. If you would like to use these types but are using an older version of the Stripe API, we recommend [updating to the latest version](https://stripe.com/docs/upgrades#how-can-i-upgrade-my-api), or ignoring and overriding the type definitions as necessary. Note that we may release new [minor and patch](https://semver.org/) versions of `@stripe/crypto` with small but backwards-incompatible fixes to the type declarations. These changes will not affect Stripe Crypto JS SDK itself. ## Ensuring Stripe.js is available everywhere To best leverage Stripe’s advanced fraud functionality, ensure that Stripe.js (not Stripe Crypto JS SDK) is loaded on every page, not just your page that integrates with Stripe Crypto. This [allows Stripe to detect suspicious behavior](https://stripe.com/docs/disputes/prevention/advanced-fraud-detection) that may be indicative of fraud as customers browse your website. By default, this module will insert a ` ``` ### Importing `loadStripeOnramp` without side effects If you would like to use `loadStripeOnramp` in your application, but defer loading the Stripe.js script until `loadStripeOnramp` is first called, use the alternative `@stripe/crypto/pure` import path: ```js import {loadStripeOnramp} from '@stripe/crypto/pure'; // Stripe.js will not be loaded until `loadStripe` is called const stripeOnramp = await loadStripeOnramp('pk_test_TYooMQauvdEDq54NiTphI7jx'); ``` ### Disabling advanced fraud detection signals If you would like to [disable advanced fraud detection](https://stripe.com/docs/disputes/prevention/advanced-fraud-detection#disabling-advanced-fraud-detection) altogether, use `loadStripe.setLoadParameters`: ```js import {loadStripe} from '@stripe/stripe-js/pure'; import {loadStripeOnramp} from '@stripe/crypto/pure'; loadStripe.setLoadParameters({advancedFraudSignals: false}); const stripeOnramp = await loadStripeOnramp('pk_test_TYooMQauvdEDq54NiTphI7jx'); ``` The `loadStripe.setLoadParameters` function is only available when importing `loadStripe` from `@stripe/stripe-js/pure`. ## Stripe Crypto JS SDK Documentation - [Stripe Crypto JS SDK Docs](https://stripe.com/docs/crypto)