Options
All
  • Public
  • Public/Protected
  • All
Menu

@stripe/stripe-terminal-react-native

Index

Namespaces

Enumerations

Interfaces

Type aliases

Variables

Functions Other

Functions ReactComponents

Type aliases

Amount: { amount: number }

Type declaration

  • amount: number
AmountDetails: { tip: Amount }

Type declaration

CancelDiscoveringResultType: Promise<{ error?: StripeError }>
CardPresentDetails: { brand: string; cardholderName?: string; country?: string; description: string; emvAuthData?: string; expMonth: string; expYear: string; funding: string; generatedCard?: string; iin: string; issuer: string; last4: string; network: string; preferredLocales: string[]; receipt?: string; wallet: Wallet }

Type declaration

  • brand: string
  • Optional cardholderName?: string
  • Optional country?: string
  • description: string
  • Optional emvAuthData?: string
  • expMonth: string
  • expYear: string
  • funding: string
  • Optional generatedCard?: string
  • iin: string
  • issuer: string
  • last4: string
  • network: string
  • preferredLocales: string[]
  • Optional receipt?: string
  • wallet: Wallet
Cart: { currency: string; lineItems: LineItem[]; tax: number; total: number }

Type declaration

  • currency: string
  • lineItems: LineItem[]
  • tax: number
  • total: number
ClearReaderDisplayResultType: { error: StripeError }

Type declaration

CollectPaymentMethodParams: { enableCustomerCancellation?: boolean; paymentIntent: PaymentIntent.Type; requestDynamicCurrencyConversion?: boolean; skipTipping?: boolean; tipEligibleAmount?: number; updatePaymentIntent?: boolean }

Type declaration

  • Optional enableCustomerCancellation?: boolean
  • paymentIntent: PaymentIntent.Type
  • Optional requestDynamicCurrencyConversion?: boolean
  • Optional skipTipping?: boolean
  • Optional tipEligibleAmount?: number
  • Optional updatePaymentIntent?: boolean
CollectRefundPaymentMethodType: { error?: StripeError }

Type declaration

CollectSetupIntentPaymentMethodParams: { customerConsentCollected?: boolean; enableCustomerCancellation?: boolean; setupIntent: SetupIntent.Type }

Type declaration

  • Optional customerConsentCollected?: boolean
  • Optional enableCustomerCancellation?: boolean
  • setupIntent: SetupIntent.Type
ConfirmRefundResultType: { error?: StripeError; refund?: Refund.Props }

Type declaration

ConnectBluetoothReaderParams: { autoReconnectOnUnexpectedDisconnect?: boolean; locationId?: string; reader: Reader.Type }

Type declaration

  • Optional autoReconnectOnUnexpectedDisconnect?: boolean
  • Optional locationId?: string
  • reader: Reader.Type
ConnectHandoffParams: { locationId?: string; reader: Reader.Type }

Type declaration

ConnectInternetReaderParams: { failIfInUse?: boolean; reader: Reader.Type }

Type declaration

ConnectLocalMobileParams: { autoReconnectOnUnexpectedDisconnect?: boolean; locationId?: string; merchantDisplayName?: string; onBehalfOf?: string; reader: Reader.Type; tosAcceptancePermitted?: boolean }

Type declaration

  • Optional autoReconnectOnUnexpectedDisconnect?: boolean
  • Optional locationId?: string
  • Optional merchantDisplayName?: string
  • Optional onBehalfOf?: string
  • reader: Reader.Type
  • Optional tosAcceptancePermitted?: boolean
ConnectReaderResultType: { error?: undefined; reader: Reader.Type } | { error: StripeError; reader?: undefined }
ConnectUsbReaderParams: { autoReconnectOnUnexpectedDisconnect?: boolean; locationId?: string; reader: Reader.Type }

Type declaration

  • Optional autoReconnectOnUnexpectedDisconnect?: boolean
  • Optional locationId?: string
  • reader: Reader.Type
ConnectionStatus: "notConnected" | "connecting" | "connected"
CreatePaymentIntentIOSParams: { paymentMethodTypes?: string[] }

Type declaration

  • Optional paymentMethodTypes?: string[]
CreatePaymentIntentParams: CreatePaymentIntentIOSParams & { amount: number; applicationFeeAmount?: number; captureMethod?: "automatic" | "manual"; currency: string; customer?: string; metadata?: Record<string, string>; offlineBehavior?: "prefer_online" | "require_online" | "force_offline"; onBehalfOf?: string; paymentMethodOptions?: PaymentMethodOptions; receiptEmail?: string; setupFutureUsage?: "off_session" | "on_session"; statementDescriptor?: string; statementDescriptorSuffix?: string; stripeDescription?: string; transferDataDestination?: string; transferGroup?: string }
CreateSetupIntentParams: { customerId?: string }

Type declaration

  • Optional customerId?: string
DisconnectReaderResultType: { error: StripeError }

Type declaration

DiscoverReadersParams: { discoveryMethod: Reader.DiscoveryMethod; simulated?: boolean; timeout?: number }

Type declaration

DiscoverReadersResultType: Promise<{ error?: StripeError }>
GetLocationsParams: { endingBefore?: string; limit?: number; startingAfter?: string }

Type declaration

  • Optional endingBefore?: string
  • Optional limit?: number
  • Optional startingAfter?: string
GetLocationsResultType: { error?: undefined; hasMore: boolean; locations: Location[] } | { error: StripeError; hasMore?: undefined; locations?: undefined }
InitParams: { logLevel?: LogLevel }

Type declaration

InitializeResultType: { error?: undefined; reader?: Reader.Type } | { error: StripeError; reader?: undefined }
LineItem: { amount: number; displayName: string; quantity: number }

Type declaration

  • amount: number
  • displayName: string
  • quantity: number
LocationStatus: "notSet" | "set" | "unknown"
LogLevelAndroid: "none" | "verbose" | "error" | "warning"
LogLevelIOS: "none" | "verbose"
OfflineCardPresentDetails: { brand: string; cardholderName: string; expMonth: number; expYear: number; last4: string; readMethod: string; receiptDetails: ReceiptDetails }

Type declaration

  • brand: string
  • cardholderName: string
  • expMonth: number
  • expYear: number
  • last4: string
  • readMethod: string
  • receiptDetails: ReceiptDetails
OfflineDetails: { amountDetails: AmountDetails; cardPresentDetails: OfflineCardPresentDetails; requiresUpload: boolean; storedAt: string }

Type declaration

OfflineStatus: { reader?: OfflineStatusDetails; sdk: OfflineStatusDetails }

Type declaration

OfflineStatusDetails: { networkStatus: "online" | "offline" | "unknown"; offlinePaymentAmountsByCurrency: {}; offlinePaymentsCount: number }

Type declaration

  • networkStatus: "online" | "offline" | "unknown"
  • offlinePaymentAmountsByCurrency: {}
    • [key: string]: number
  • offlinePaymentsCount: number
PaymentIntentResultType: { error?: undefined; paymentIntent: PaymentIntent.Type } | { error: StripeError; paymentIntent?: undefined } | { error: StripeError; paymentIntent: PaymentIntent.Type }
PaymentMethodDetails: { cardPresentDetails?: CardPresentDetails; interacPresentDetails?: CardPresentDetails; type: string }

Type declaration

PaymentMethodOptions: { requestExtendedAuthorization?: boolean; requestIncrementalAuthorizationSupport?: boolean; requestedPriority: string }

Type declaration

  • Optional requestExtendedAuthorization?: boolean
  • Optional requestIncrementalAuthorizationSupport?: boolean
  • requestedPriority: string
PaymentMethodResultType: { error: undefined; paymentMethod?: PaymentMethod.Type } | { error: StripeError; paymentMethod: undefined }
PaymentMethodType: "cardPresent" | "interacPresent" | "card"
PaymentStatus: "notReady" | "ready" | "processing" | "waitingForInput"
ReaderEvent: "cardInserted" | "cardRemoved"
RebootReaderResultType: { error: StripeError }

Type declaration

ReceiptDetails: { accountType: string; applicationCryptogram: string; applicationPreferredName: string; authorizationCode: string; authorizationResponseCode: string; cvm: string; dedicatedFileName: string; terminalVerificationResult: string; transactionStatusInformation: string }

Type declaration

  • accountType: string
  • applicationCryptogram: string
  • applicationPreferredName: string
  • authorizationCode: string
  • authorizationResponseCode: string
  • cvm: string
  • dedicatedFileName: string
  • terminalVerificationResult: string
  • transactionStatusInformation: string
RefundParams: { amount: number; chargeId: string; currency: string; enableCustomerCancellation?: boolean; paymentIntentId: string; refundApplicationFee?: boolean; reverseTransfer?: boolean }

Type declaration

  • amount: number
  • chargeId: string
  • currency: string
  • Optional enableCustomerCancellation?: boolean
  • paymentIntentId: string
  • Optional refundApplicationFee?: boolean
  • Optional reverseTransfer?: boolean
SetConnectionTokenParams: { error?: string; token?: string }

Type declaration

  • Optional error?: string
  • Optional token?: string
SetupIntentResultType: { error?: undefined; setupIntent: SetupIntent.Type } | { error: StripeError; setupIntent?: undefined }
StripeError<T>: { code: T; message: string }

Type parameters

Type declaration

  • code: T
  • message: string
UpdateSoftwareResultType: { error?: StripeError; update?: SoftwareUpdate }

Type declaration

UseStripeTerminalProps: UserCallbacks

useStripeTerminal hook Props

UserCallbacks: { onDidChangeConnectionStatus?: any; onDidChangeOfflineStatus?: any; onDidChangePaymentStatus?: any; onDidDisconnect?: any; onDidFailReaderReconnect?: any; onDidFinishInstallingUpdate?: any; onDidForwardPaymentIntent?: any; onDidForwardingFailure?: any; onDidReportAvailableUpdate?: any; onDidReportLowBatteryWarning?: any; onDidReportReaderEvent?: any; onDidReportReaderSoftwareUpdateProgress?: any; onDidReportUnexpectedReaderDisconnect?: any; onDidRequestReaderDisplayMessage?: any; onDidRequestReaderInput?: any; onDidStartInstallingUpdate?: any; onDidStartReaderReconnect?: any; onDidSucceedReaderReconnect?: any; onDidUpdateBatteryLevel?: any; onFinishDiscoveringReaders?: any; onUpdateDiscoveredReaders?: any }

Type declaration

Wallet: { type: string }

Type declaration

  • type: string
WithStripeTerminalProps: ReturnType<typeof useStripeTerminal>

Variables

CHANGE_CONNECTION_STATUS: any
CHANGE_OFFLINE_STATUS: any
CHANGE_PAYMENT_STATUS: any
FETCH_TOKEN_PROVIDER: any
FINISH_DISCOVERING_READERS: any
FINISH_INSTALLING_UPDATE: any
FORWARD_PAYMENT_INTENT: any
READER_RECONNECT_FAIL: any
READER_RECONNECT_SUCCEED: any
REPORT_AVAILABLE_UPDATE: any
REPORT_FORWARDING_ERROR: any
REPORT_UNEXPECTED_READER_DISCONNECT: any
REPORT_UPDATE_PROGRESS: any
REQUEST_READER_DISPLAY_MESSAGE: any
REQUEST_READER_INPUT: any
START_INSTALLING_UPDATE: any
START_READER_RECONNECT: any
UPDATE_DISCOVERED_READERS: any

Other Functions

  • requestNeededAndroidPermissions(__namedParameters?: undefined | PermissionsProps): Promise<Error>

ReactComponents Functions

  • withStripeTerminal<Props>(WrappedComponent: ComponentType<Props>): { displayName: string }
  • withStripeTerminal HoC Component

    example
     function YourScreenComponent(props: WithStripeTerminalProps) { }

    export default withStripeTerminal(YourScreenComponent);

    Type parameters

    • Props

    Parameters

    • WrappedComponent: ComponentType<Props>

    Returns { displayName: string }

    JSX.Element

      • (props: Props): Element
      • Parameters

        • props: Props

        Returns Element

    • displayName: string

Generated using TypeDoc