• Stars
    star
    625
  • Rank 71,862 (Top 2 %)
  • Language
    TypeScript
  • License
    MIT License
  • Created almost 5 years ago
  • Updated about 1 month ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Loading wrapper for Stripe.js

Stripe.js ES Module

Use Stripe.js as an ES module.

Note: To be PCI compliant, you must load Stripe.js directly from https://js.stripe.com. You cannot include it in a bundle or host it yourself. This package wraps the global Stripe function provided by the Stripe.js script as an ES module.

npm version

Installation

Use npm to install the Stripe.js module:

npm install @stripe/stripe-js

Usage

loadStripe

This function returns a Promise that resolves with a newly created Stripe object once Stripe.js has loaded. It takes the same parameters passed when directly initializing a Stripe instance. If necessary, it will load Stripe.js for you by inserting the Stripe.js script tag. If you call loadStripe in a server environment it will resolve to null.

import {loadStripe} from '@stripe/stripe-js';

const stripe = await loadStripe('pk_test_TYooMQauvdEDq54NiTphI7jx');

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

For more information on how to use Stripe.js, please refer to the Stripe.js API reference or learn to accept a payment with Stripe.

If you have deployed a Content Security Policy, make sure to include Stripe.js in your directives.

TypeScript support

This package includes TypeScript declarations for Stripe.js. We support projects using TypeScript versions >= 3.1.

Some methods in Stripe.js accept and return objects from the Stripe API. The type declarations in @stripe/stripe-js for these objects in will always track the latest version 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, or ignoring and overriding the type definitions as necessary.

Note that we may release new minor and patch versions of @stripe/stripe-js with small but backwards-incompatible fixes to the type declarations. These changes will not affect Stripe.js itself.

Ensuring Stripe.js is available everywhere

To best leverage Stripe’s advanced fraud functionality, ensure that Stripe.js is loaded on every page, not just your checkout page. This allows Stripe to detect suspicious behavior that may be indicative of fraud as customers browse your website.

By default, this module will insert a <script> tag that loads Stripe.js from https://js.stripe.com. This happens as a side effect immediately upon importing this module. If you utilize code splitting or only include your JavaScript app on your checkout page, the Stripe.js script will only be available in parts of your site. To ensure Stripe.js is available everywhere, you can perform either of the following steps:

Import as a side effect

Import @stripe/stripe-js as a side effect in code that will be included throughout your site (e.g. your root module). This will make sure the Stripe.js script tag is inserted immediately upon page load.

import '@stripe/stripe-js';

Manually include the script tag

Manually add the Stripe.js script tag to the <head> of each page on your site. If an existing script tag is already present, this module will not insert a new one. When you call loadStripe, it will use the existing script tag.

<!-- Somewhere in your site's <head> -->
<script src="https://js.stripe.com/v3" async></script>

Importing loadStripe without side effects

If you would like to use loadStripe in your application, but defer loading the Stripe.js script until loadStripe is first called, use the alternative @stripe/stripe-js/pure import path:

import {loadStripe} from '@stripe/stripe-js/pure';

// Stripe.js will not be loaded until `loadStripe` is called
const stripe = await loadStripe('pk_test_TYooMQauvdEDq54NiTphI7jx');

Disabling advanced fraud detection signals

If you would like to disable advanced fraud detection altogether, use loadStripe.setLoadParameters:

import {loadStripe} from '@stripe/stripe-js/pure';

loadStripe.setLoadParameters({advancedFraudSignals: false});
const stripe = await loadStripe('pk_test_TYooMQauvdEDq54NiTphI7jx');

The loadStripe.setLoadParameters function is only available when importing loadStripe from @stripe/stripe-js/pure.

Stripe.js Documentation

More Repositories

1

stripe-node

Node.js library for the Stripe API.
TypeScript
3,874
star
2

stripe-php

PHP library for the Stripe API.
PHP
3,736
star
3

stripe-go

Go library for the Stripe API.
Go
2,144
star
4

stripe-ios

Stripe iOS SDK
Swift
2,110
star
5

stripe-ruby

Ruby library for the Stripe API.
Ruby
1,952
star
6

react-stripe-js

React components for Stripe.js and Stripe Elements
TypeScript
1,757
star
7

veneur

A distributed, fault-tolerant pipeline for observability data
Go
1,734
star
8

stripe-python

Python library for the Stripe API.
Python
1,669
star
9

stripe-cli

A command-line tool for Stripe
Go
1,609
star
10

stripe-mock

stripe-mock is a mock HTTP server that responds like the real Stripe API. It can be used instead of Stripe's testmode to make test suites integrating with Stripe faster and less brittle.
Go
1,374
star
11

stripe-dotnet

Stripe.net is a sync/async .NET 4.6.1+ client, and a portable class library for stripe.com.
C#
1,362
star
12

stripe-android

Stripe Android SDK
Kotlin
1,277
star
13

stripe-react-native

React Native library for Stripe.
TypeScript
1,272
star
14

smokescreen

A simple HTTP proxy that fogs over naughty URLs
Go
1,081
star
15

elements-examples

Stripe Elements examples.
HTML
996
star
16

stripe-java

Java library for the Stripe API.
Java
818
star
17

skycfg

Skycfg is an extension library for the Starlark language that adds support for constructing Protocol Buffer messages.
Go
646
star
18

stripe-connect-rocketrides

Sample on-demand platform built on Stripe: Connect onboarding for pilots, iOS app for passengers to request rides.
Swift
634
star
19

poncho

Easily create REST APIs
Ruby
516
star
20

rainier

Bayesian inference in Scala.
Scala
433
star
21

openapi

An OpenAPI specification for the Stripe API.
391
star
22

pg-schema-diff

Go library for diffing Postgres schemas and generating SQL migrations
Go
364
star
23

stripe-billing-typographic

⚡️Typographic is a webfont service (and demo) built with Stripe Billing.
JavaScript
216
star
24

subprocess

A port of Python's subprocess module to Ruby
Ruby
208
star
25

carbon-removal-source-materials

Source materials supporting Stripe Climate carbon removal purchases (http://stripe.com/climate)
190
star
26

stripe-apps

Stripe Apps lets you embed custom user experiences directly in the Stripe Dashboard and orchestrate the Stripe API.
TypeScript
148
star
27

dagon

Tools for rewriting and optimizing DAGs (directed-acyclic graphs) in Scala
Scala
148
star
28

bonsai

Beautiful trees, without the landscaping.
Scala
141
star
29

ios-dashboard-ui

[DEPRECATED] UI components from the Stripe Dashboard iOS app
Swift
138
star
30

vscode-stripe

Stripe for Visual Studio Code
TypeScript
123
star
31

stripe.github.io

A landing page for Stripe's GitHub organization
HTML
117
star
32

stripe-terminal-react-native

React Native SDK for Stripe Terminal
TypeScript
108
star
33

example-mobile-backend

A simple, easy-to-deploy backend that you can use to demo our example mobile apps.
Ruby
106
star
34

stripe-terminal-ios

Stripe Terminal iOS SDK
Objective-C
102
star
35

stripe-demo-connect-roastery-saas-platform

Roastery demo SaaS platform using Stripe Connect
JavaScript
94
star
36

stripe-terminal-android

Stripe Terminal Android SDK
Java
93
star
37

example-terminal-backend

A simple, easy-to-deploy backend that you can use to run the Stripe Terminal example apps
Ruby
88
star
38

stripe-terminal-js-demo

Demo app for the Stripe Terminal JS SDK
JavaScript
82
star
39

stripe-postman

Postman collection for Stripe's API
77
star
40

unilog

A logger for use with daemontools.
Go
77
star
41

goforit

A feature flags client library for Go
Go
70
star
42

stripe-connect-custom-rocketdeliveries

Sample on-demand platform built on Stripe Connect: Custom Accounts and Connect Onboarding for deliveries. https://rocketdeliveries.io
JavaScript
69
star
43

tracer-objc

Generic record & playback framework for Objective-C
Objective-C
52
star
44

mobile-viewport-control

Dynamically control the mobile viewport
JavaScript
48
star
45

log4j-remediation-tools

Tools for remediating the recent log4j2 RCE vulnerability (CVE-2021-44228)
Go
41
star
46

terminal-js

Loading wrapper for the Terminal JS SDK
TypeScript
34
star
47

stripe-connect-furever-demo

Code sample demo built on Stripe Connect embedded components.
TypeScript
34
star
48

stripe-identity-react-native

React Native library for Stripe Identity
TypeScript
33
star
49

stripe-reachability

A bash script to test access to the Stripe API
Shell
32
star
50

krl

OpenSSH Key Revocation List support for Go
Go
30
star
51

stripe-magento2-releases

27
star
52

react-connect-js

React components for Connect.js and Connect embedded components
TypeScript
22
star
53

connect-js

Loading wrapper for Connect.js
TypeScript
21
star
54

stripe-mirakl-connector

Official Stripe Mirakl Connector
PHP
13
star
55

salesforce-connector-examples

Stripe Salesforce Connector examples
Apex
12
star
56

checkout-sales-demo

Sales demo of Stripe Checkout with different locales around the world.
HTML
12
star
57

stripe-ios-spm

Swift Package Manager mirror for the Stripe iOS SDK. See http://github.com/stripe/stripe-ios for details.
12
star
58

.github

Stripe uses the Contributor Covenant Code of Conduct for our open-source community.
8
star
59

homebrew-stripe-mock

Homebrew tap for stripestub
Ruby
7
star
60

scoop-stripe-cli

7
star
61

homebrew-stripe-cli

Ruby
7
star
62

stripe-sfcc-b2c-connector

JavaScript
7
star
63

stripe-commercetools-connect-app

TypeScript
5
star
64

ssf-ruby

A Ruby client for the Sensor Sensibility Format
Ruby
5
star
65

terminal-connector-releases

Release binaries for Stripe Terminal connectors
3
star
66

open-banking-v2-docs

Open banking docs for V2 APIs
CSS
2
star
67

vscode-endsmart

vscode extension to smartly add `end` keywords
TypeScript
1
star