@capacitor-community/stripe-identity
v6.2.1
Published
Stripe Identity SDK bindings for Capacitor Applications
Downloads
2,560
Maintainers
Readme
@capacitor-community/stripe-identity
Stripe Identity SDK bindings for Capacitor Applications.
Install
npm install @capacitor-community/stripe-identity
npx cap sync
Initialize iOS
set up camera authorization by adding NSCameraUsageDescription
in Info.plist
and add a string value that explains the usage.
see more details on Stripe's native iOS SDK page here.
Initialize Android
change base application theme to Theme.MaterialComponents.DayNight
at res/values/styles.xml
:
- <style name="AppTheme" parent="Theme.AppCompat.Light.DarkActionBar">
+ <style name="AppTheme" parent="Theme.MaterialComponents.DayNight">
parent can be any MaterialComponents. See here for other options. see more details on Stripe's native Android SDK page here.
Usage
If you want to implement, we recommend to read https://stripe.com/docs/identity .
import { StripeIdentity } from '@capacitor-community/stripe-identity';
// initialize is needed only for Web Platform
await StripeIdentity.initialize({
publishableKey,
});
await StripeIdentity.create({
ephemeralKeySecret,
verificationId,
// clientSecret is needed only for Web Platform
clientSecret
});
const result = await StripeIdentity.present();
API
initialize(...)
create(...)
present()
addListener(IdentityVerificationSheetEventsEnum.Loaded, ...)
addListener(IdentityVerificationSheetEventsEnum.FailedToLoad, ...)
addListener(IdentityVerificationSheetEventsEnum.Completed, ...)
addListener(IdentityVerificationSheetEventsEnum.Canceled, ...)
addListener(IdentityVerificationSheetEventsEnum.Failed, ...)
- Interfaces
- Type Aliases
- Enums
initialize(...)
initialize(options: InitializeIdentityVerificationSheetOption) => Promise<void>
| Param | Type |
| ------------- | --------------------------------------------------------------------------------------------------------------- |
| options
| InitializeIdentityVerificationSheetOption |
create(...)
create(options: CreateIdentityVerificationSheetOption) => Promise<void>
| Param | Type |
| ------------- | ------------------------------------------------------------------------------------------------------- |
| options
| CreateIdentityVerificationSheetOption |
present()
present() => Promise<{ identityVerificationResult: IdentityVerificationSheetResultInterface; }>
Returns: Promise<{ identityVerificationResult: IdentityVerificationSheetResultInterface; }>
addListener(IdentityVerificationSheetEventsEnum.Loaded, ...)
addListener(eventName: IdentityVerificationSheetEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>
| Param | Type |
| ------------------ | ---------------------------------------------------------------------------------------------------------- |
| eventName
| IdentityVerificationSheetEventsEnum.Loaded |
| listenerFunc
| () => void |
Returns: Promise<PluginListenerHandle>
addListener(IdentityVerificationSheetEventsEnum.FailedToLoad, ...)
addListener(eventName: IdentityVerificationSheetEventsEnum.FailedToLoad, listenerFunc: (info: StripeIdentityError) => void) => Promise<PluginListenerHandle>
| Param | Type |
| ------------------ | ---------------------------------------------------------------------------------------------------------------- |
| eventName
| IdentityVerificationSheetEventsEnum.FailedToLoad |
| listenerFunc
| (info: StripeIdentityError) => void |
Returns: Promise<PluginListenerHandle>
addListener(IdentityVerificationSheetEventsEnum.Completed, ...)
addListener(eventName: IdentityVerificationSheetEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>
| Param | Type |
| ------------------ | ------------------------------------------------------------------------------------------------------------- |
| eventName
| IdentityVerificationSheetEventsEnum.Completed |
| listenerFunc
| () => void |
Returns: Promise<PluginListenerHandle>
addListener(IdentityVerificationSheetEventsEnum.Canceled, ...)
addListener(eventName: IdentityVerificationSheetEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>
| Param | Type |
| ------------------ | ------------------------------------------------------------------------------------------------------------ |
| eventName
| IdentityVerificationSheetEventsEnum.Canceled |
| listenerFunc
| () => void |
Returns: Promise<PluginListenerHandle>
addListener(IdentityVerificationSheetEventsEnum.Failed, ...)
addListener(eventName: IdentityVerificationSheetEventsEnum.Failed, listenerFunc: (info: StripeIdentityError) => void) => Promise<PluginListenerHandle>
| Param | Type |
| ------------------ | ---------------------------------------------------------------------------------------------------------- |
| eventName
| IdentityVerificationSheetEventsEnum.Failed |
| listenerFunc
| (info: StripeIdentityError) => void |
Returns: Promise<PluginListenerHandle>
Interfaces
InitializeIdentityVerificationSheetOption
| Prop | Type |
| -------------------- | ------------------- |
| publishableKey
| string |
CreateIdentityVerificationSheetOption
| Prop | Type | Description |
| ------------------------ | ------------------- | ----------------------------------------------------- |
| verificationId
| string | |
| ephemeralKeySecret
| string | |
| clientSecret
| string | This client secret is used only for the web platform. |
PluginListenerHandle
| Prop | Type |
| ------------ | ----------------------------------------- |
| remove
| () => Promise<void> |
StripeIdentityError
| Prop | Type |
| ------------- | ------------------- |
| message
| string |
Type Aliases
IdentityVerificationSheetResultInterface
IdentityVerificationSheetEventsEnum.Completed | IdentityVerificationSheetEventsEnum.Canceled | IdentityVerificationSheetEventsEnum.Failed
Enums
IdentityVerificationSheetEventsEnum
| Members | Value |
| ------------------ | ---------------------------------------------------- |
| Loaded
| 'identityVerificationSheetLoaded' |
| FailedToLoad
| 'identityVerificationSheetFailedToLoad' |
| Completed
| 'identityVerificationSheetCompleted' |
| Canceled
| 'identityVerificationSheetCanceled' |
| Failed
| 'identityVerificationSheetFailed' |