diff --git a/CHANGELOG.md b/CHANGELOG.md index c8a08f16..e0c7a525 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,14 @@ If you are using CocoaPods, update your Podfile: ``` pod 'StripeTerminal', '~> 2.0' ``` +# 2.19.0 2023-04-03 +* New: Cancel `PaymentIntent` and `SetupIntent` via the SDK when connected to an internet reader by calling [`cancelPaymentIntent`](https://stripe.dev/stripe-terminal-ios/docs/Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)cancelPaymentIntent:completion:) or [`cancelSetupIntent`](https://stripe.dev/stripe-terminal-ios/docs/Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)cancelSetupIntent:completion:) instead of using your backend. + * _Note: This feature requires version `2.11.0.24` or later to be installed on your internet reader._ +* Added [`authorizationCode`](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-receipt-authorization_code) to [`SCPReceiptDetails`](https://stripe.dev/stripe-terminal-ios/docs/Classes/SCPReceiptDetails.html). +* Added support for simulating an on-reader tip amount to the [`SCPSimulatorConfiguration`](https://stripe.dev/stripe-terminal-ios/docs/Classes/SCPSimulatorConfiguration.html) when collecting and processing a payment using a simulated reader. +* Add two new simulated test cards: `.eftposAuVisaDebit` & `.eftposAuDebitMastercard` to [ `SCPSimulatedCardType`](https://stripe.dev/stripe-terminal-ios/docs/Enums/SCPSimulatedCardType.html) +* Added [`captureMethod`](https://stripe.dev/stripe-terminal-ios/docs/Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)captureMethod) property to `SCPPaymentIntent`. + # 2.18.1 2023-03-15 * Fixes an issue where the SDK may report a failure during `processPayment` when using a WisePad 3 and the reader times out waiting for the /confirm response from the Stripe API. The SDK will now will report success if the PaymentIntent status moved to `requires_capture` or `succeeded`. diff --git a/Example/Example.xcodeproj/project.pbxproj b/Example/Example.xcodeproj/project.pbxproj index 3b84f218..004b0b4a 100644 --- a/Example/Example.xcodeproj/project.pbxproj +++ b/Example/Example.xcodeproj/project.pbxproj @@ -26,7 +26,6 @@ A63E8431260D073B006CB90C /* CreateLocationViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = A63E8430260D073B006CB90C /* CreateLocationViewController.swift */; }; A63E8435260D0A0D006CB90C /* SelectLocationViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = A63E8434260D0A0D006CB90C /* SelectLocationViewController.swift */; }; A63E8457260D23C9006CB90C /* StripeCountries.swift in Sources */ = {isa = PBXBuildFile; fileRef = A63E8456260D23C9006CB90C /* StripeCountries.swift */; }; - B1BFECBE2C293B7F6F43934E /* Pods_Example.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 4BBCA8B8D89E2A5CA481D1CB /* Pods_Example.framework */; }; B3C24C6C23285BF6003271BD /* ifaddrs.swift in Sources */ = {isa = PBXBuildFile; fileRef = B3C24C6B23285BF6003271BD /* ifaddrs.swift */; }; C151C7A621605B6200FC206F /* UpdateReaderViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = C151C7A521605B6200FC206F /* UpdateReaderViewController.swift */; }; C152F7782149ECA30078BD07 /* ReadReusableCardViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = C152F7772149ECA20078BD07 /* ReadReusableCardViewController.swift */; }; @@ -45,6 +44,7 @@ C1DE30D721438E9900A3026F /* UIViewController+UIAlertController.swift in Sources */ = {isa = PBXBuildFile; fileRef = C1DE30D121438E9800A3026F /* UIViewController+UIAlertController.swift */; }; C1DE30D821438E9900A3026F /* UIView+Layout.swift in Sources */ = {isa = PBXBuildFile; fileRef = C1DE30D221438E9800A3026F /* UIView+Layout.swift */; }; C1F78BDB2144F0830094BE37 /* CustomViews.swift in Sources */ = {isa = PBXBuildFile; fileRef = C1F78BDA2144F0830094BE37 /* CustomViews.swift */; }; + ECCE943A29850596A074425C /* Pods_Example.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 11924A618586BB3FB4FBCAE3 /* Pods_Example.framework */; }; /* End PBXBuildFile section */ /* Begin PBXCopyFilesBuildPhase section */ @@ -65,6 +65,7 @@ 022FB25A245868EF00F4C321 /* StripeTerminal.xcframework */ = {isa = PBXFileReference; explicitFileType = wrapper.xcframework; path = StripeTerminal.xcframework; sourceTree = SOURCE_ROOT; }; 02370F5C244C94D00056D896 /* CancelableViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CancelableViewController.swift; sourceTree = ""; }; 02DA8E3924532E4900235921 /* DelegateAnnouncer.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DelegateAnnouncer.swift; sourceTree = ""; }; + 11924A618586BB3FB4FBCAE3 /* Pods_Example.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_Example.framework; sourceTree = BUILT_PRODUCTS_DIR; }; 199A008C245A2D6F00E89BE9 /* TableViewController+StripeTerminal.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "TableViewController+StripeTerminal.swift"; sourceTree = ""; }; 241B90F8249027DE0083C908 /* ReaderRegistrationViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ReaderRegistrationViewController.swift; sourceTree = ""; }; 2446E3EE25AF499B00FB4510 /* SetupIntentViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SetupIntentViewController.swift; sourceTree = ""; }; @@ -74,8 +75,7 @@ 259FDFDE2485AF0F0097686C /* EventDisplayingViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = EventDisplayingViewController.swift; sourceTree = ""; }; 25CB2CF624941F8D0018535C /* StartSetReaderDisplayViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StartSetReaderDisplayViewController.swift; sourceTree = ""; }; 3936853D28860BDE0026A906 /* CaptureMethod+String.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "CaptureMethod+String.swift"; sourceTree = ""; }; - 4BBCA8B8D89E2A5CA481D1CB /* Pods_Example.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_Example.framework; sourceTree = BUILT_PRODUCTS_DIR; }; - 68C3367A0CD4F7DB1427ADF0 /* Pods-Example.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Example.release.xcconfig"; path = "Target Support Files/Pods-Example/Pods-Example.release.xcconfig"; sourceTree = ""; }; + 3D9C64B5A8713739F84D3678 /* Pods-Example.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Example.debug.xcconfig"; path = "Target Support Files/Pods-Example/Pods-Example.debug.xcconfig"; sourceTree = ""; }; 6F8BE0912177B403009511E5 /* DiscoveryMethodViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DiscoveryMethodViewController.swift; sourceTree = ""; }; A63E8430260D073B006CB90C /* CreateLocationViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CreateLocationViewController.swift; sourceTree = ""; }; A63E8434260D0A0D006CB90C /* SelectLocationViewController.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = SelectLocationViewController.swift; sourceTree = ""; }; @@ -102,7 +102,7 @@ C1DE30D121438E9800A3026F /* UIViewController+UIAlertController.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "UIViewController+UIAlertController.swift"; sourceTree = ""; }; C1DE30D221438E9800A3026F /* UIView+Layout.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "UIView+Layout.swift"; sourceTree = ""; }; C1F78BDA2144F0830094BE37 /* CustomViews.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CustomViews.swift; sourceTree = ""; }; - CFF56A7DB13F7A64B11032A5 /* Pods-Example.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Example.debug.xcconfig"; path = "Target Support Files/Pods-Example/Pods-Example.debug.xcconfig"; sourceTree = ""; }; + FEA2646D56C58E3761266395 /* Pods-Example.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Example.release.xcconfig"; path = "Target Support Files/Pods-Example/Pods-Example.release.xcconfig"; sourceTree = ""; }; /* End PBXFileReference section */ /* Begin PBXFrameworksBuildPhase section */ @@ -111,20 +111,30 @@ buildActionMask = 2147483647; files = ( 022FB25B245868EF00F4C321 /* StripeTerminal.xcframework in Frameworks */, - B1BFECBE2C293B7F6F43934E /* Pods_Example.framework in Frameworks */, + ECCE943A29850596A074425C /* Pods_Example.framework in Frameworks */, ); runOnlyForDeploymentPostprocessing = 0; }; /* End PBXFrameworksBuildPhase section */ /* Begin PBXGroup section */ + 2E7D0EB729C613630A281CC8 /* Pods */ = { + isa = PBXGroup; + children = ( + 3D9C64B5A8713739F84D3678 /* Pods-Example.debug.xcconfig */, + FEA2646D56C58E3761266395 /* Pods-Example.release.xcconfig */, + ); + name = Pods; + path = Pods; + sourceTree = ""; + }; C16F40942094F07B009CE87C = { isa = PBXGroup; children = ( C16F409F2094F07B009CE87C /* Example */, EE087B524FD387212EBE036B /* Frameworks */, C16F409E2094F07B009CE87C /* Products */, - EE4E22BFCA386A160DB7646C /* Pods */, + 2E7D0EB729C613630A281CC8 /* Pods */, ); sourceTree = ""; }; @@ -184,21 +194,11 @@ isa = PBXGroup; children = ( 022FB25A245868EF00F4C321 /* StripeTerminal.xcframework */, - 4BBCA8B8D89E2A5CA481D1CB /* Pods_Example.framework */, + 11924A618586BB3FB4FBCAE3 /* Pods_Example.framework */, ); name = Frameworks; sourceTree = ""; }; - EE4E22BFCA386A160DB7646C /* Pods */ = { - isa = PBXGroup; - children = ( - CFF56A7DB13F7A64B11032A5 /* Pods-Example.debug.xcconfig */, - 68C3367A0CD4F7DB1427ADF0 /* Pods-Example.release.xcconfig */, - ); - name = Pods; - path = Pods; - sourceTree = ""; - }; /* End PBXGroup section */ /* Begin PBXNativeTarget section */ @@ -206,12 +206,12 @@ isa = PBXNativeTarget; buildConfigurationList = C16F40AF2094F07C009CE87C /* Build configuration list for PBXNativeTarget "Example" */; buildPhases = ( - BEA0810E7A3021C03D51A737 /* [CP] Check Pods Manifest.lock */, + 9AC2578999BB2376F5D3C8BC /* [CP] Check Pods Manifest.lock */, C16F40992094F07B009CE87C /* Sources */, C16F409B2094F07B009CE87C /* Resources */, 0DE2ACED4D7F3843500B5F14 /* Frameworks */, 02A6BF5524CB1C3D0054ADFF /* CopyFiles */, - 6313EA52CD77D422FE0AE313 /* [CP] Embed Pods Frameworks */, + 31AA7CB5AB7CCD316C49262D /* [CP] Embed Pods Frameworks */, ); buildRules = ( ); @@ -271,7 +271,7 @@ /* End PBXResourcesBuildPhase section */ /* Begin PBXShellScriptBuildPhase section */ - 6313EA52CD77D422FE0AE313 /* [CP] Embed Pods Frameworks */ = { + 31AA7CB5AB7CCD316C49262D /* [CP] Embed Pods Frameworks */ = { isa = PBXShellScriptBuildPhase; buildActionMask = 2147483647; files = ( @@ -291,7 +291,7 @@ shellScript = "\"${PODS_ROOT}/Target Support Files/Pods-Example/Pods-Example-frameworks.sh\"\n"; showEnvVarsInLog = 0; }; - BEA0810E7A3021C03D51A737 /* [CP] Check Pods Manifest.lock */ = { + 9AC2578999BB2376F5D3C8BC /* [CP] Check Pods Manifest.lock */ = { isa = PBXShellScriptBuildPhase; buildActionMask = 2147483647; files = ( @@ -494,7 +494,7 @@ }; C16F40B02094F07C009CE87C /* Debug */ = { isa = XCBuildConfiguration; - baseConfigurationReference = CFF56A7DB13F7A64B11032A5 /* Pods-Example.debug.xcconfig */; + baseConfigurationReference = 3D9C64B5A8713739F84D3678 /* Pods-Example.debug.xcconfig */; buildSettings = { ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; CODE_SIGN_IDENTITY = "Apple Development"; @@ -520,7 +520,7 @@ }; C16F40B12094F07C009CE87C /* Release */ = { isa = XCBuildConfiguration; - baseConfigurationReference = 68C3367A0CD4F7DB1427ADF0 /* Pods-Example.release.xcconfig */; + baseConfigurationReference = FEA2646D56C58E3761266395 /* Pods-Example.release.xcconfig */; buildSettings = { ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; CODE_SIGN_IDENTITY = "Apple Development"; diff --git a/Example/Example/CustomViews.swift b/Example/Example/CustomViews.swift index c2f3287a..a1a8f63e 100644 --- a/Example/Example/CustomViews.swift +++ b/Example/Example/CustomViews.swift @@ -332,6 +332,8 @@ class TestCardPickerView: TextFieldView, UIPickerViewDelegate, UIPickerViewDataS .unionPay, .interac, .eftposAuDebit, + .eftposAuVisaDebit, + .eftposAuDebitMastercard, .onlinePinCvm, .onlinePinScaRetry, .offlinePinCvm, diff --git a/Example/Example/EventDisplayingViewController.swift b/Example/Example/EventDisplayingViewController.swift index 0f595515..89d25fe0 100644 --- a/Example/Example/EventDisplayingViewController.swift +++ b/Example/Example/EventDisplayingViewController.swift @@ -132,7 +132,6 @@ class EventDisplayingViewController: TableViewController, CancelableViewControll event.object = .error(error as NSError) } else { event.result = .succeeded - self.dismiss(animated: true, completion: nil) } self.events.append(event) } diff --git a/Example/Example/LogEventViewController.swift b/Example/Example/LogEventViewController.swift index 96fb871f..e87665f9 100644 --- a/Example/Example/LogEventViewController.swift +++ b/Example/Example/LogEventViewController.swift @@ -61,6 +61,8 @@ struct LogEvent: CustomStringConvertible, Event { case backendCreateSetupIntent = "backend.createSetupIntent" case retrieveSetupIntent = "backend.retrieveSetupIntent" case captureSetupIntent = "backend.captuteSetupIntent" + case cancelPaymentIntent = "terminal.cancelPaymentIntent" + case cancelSetupIntent = "terminal.cancelSetupIntent" } enum AssociatedObject { @@ -234,6 +236,20 @@ struct LogEvent: CustomStringConvertible, Event { case .errored: string = "Capture SetupIntent Failed" case .message(let message): string = message } + case .cancelPaymentIntent: + switch result { + case .started: string = "Cancel PaymentIntent" + case .succeeded: string = "Canceled PaymentIntent" + case .errored: string = "Cancel PaymentIntent Failed" + case .message(let message): string = message + } + case .cancelSetupIntent: + switch result { + case .started: string = "Cancel SetupIntent" + case .succeeded: string = "Canceled SetupIntent" + case .errored: string = "Cancel SetupIntent Failed" + case .message(let message): string = message + } } return string } diff --git a/Example/Example/PaymentViewController.swift b/Example/Example/PaymentViewController.swift index 2804d6db..c0655b8f 100644 --- a/Example/Example/PaymentViewController.swift +++ b/Example/Example/PaymentViewController.swift @@ -113,7 +113,11 @@ class PaymentViewController: EventDisplayingViewController { collectEvent.result = .errored collectEvent.object = .error(error as NSError) self.events.append(collectEvent) - self.complete() + if (error as NSError).code == ErrorCode.canceled.rawValue { + self.cancelPaymentIntent(intent: intent) + } else { + self.complete() + } } else if let intent = intentWithPaymentMethod { // Before proceeding check if the card brand provided matches the brand chosen to reject if let declineCardBrand = self.declineCardBrand, @@ -141,7 +145,7 @@ class PaymentViewController: EventDisplayingViewController { cancelEvent.object = .paymentIntent(intent) } self.events.append(cancelEvent) - self.complete() + self.cancelPaymentIntent(intent: intent) } } return @@ -157,6 +161,23 @@ class PaymentViewController: EventDisplayingViewController { } } + private func cancelPaymentIntent(intent: PaymentIntent) { + var cancelEvent = LogEvent(method: .cancelPaymentIntent) + self.events.append(cancelEvent) + Terminal.shared.cancelPaymentIntent(intent) { canceledPaymentIntent, cancelError in + if let error = cancelError { + cancelEvent.result = .errored + cancelEvent.object = .error(error as NSError) + self.events.append(cancelEvent) + } else if let intent = canceledPaymentIntent { + cancelEvent.result = .succeeded + cancelEvent.object = .paymentIntent(intent) + self.events.append(cancelEvent) + } + self.complete() + } + } + private func confirmPaymentIntent(intent: PaymentIntent) { var processEvent = LogEvent(method: .processPayment) self.events.append(processEvent) diff --git a/Example/Example/SetupIntentViewController.swift b/Example/Example/SetupIntentViewController.swift index 05f5b6de..65152375 100644 --- a/Example/Example/SetupIntentViewController.swift +++ b/Example/Example/SetupIntentViewController.swift @@ -56,7 +56,11 @@ class SetupIntentViewController: EventDisplayingViewController { collectEvent.result = .errored collectEvent.object = .error(error as NSError) self.events.append(collectEvent) - self.complete() + if (error as NSError).code == ErrorCode.canceled.rawValue { + self.cancelSetupIntent(intent: intent) + } else { + self.complete() + } } else if let intent = collectedSetupIntent { collectEvent.result = .succeeded collectEvent.object = .setupIntent(intent) @@ -66,6 +70,23 @@ class SetupIntentViewController: EventDisplayingViewController { } } + private func cancelSetupIntent(intent: SetupIntent) { + var cancelEvent = LogEvent(method: .cancelSetupIntent) + self.events.append(cancelEvent) + Terminal.shared.cancelSetupIntent(intent) { canceledSetupIntent, cancelError in + if let error = cancelError { + cancelEvent.result = .errored + cancelEvent.object = .error(error as NSError) + self.events.append(cancelEvent) + } else if let intent = canceledSetupIntent { + cancelEvent.result = .succeeded + cancelEvent.object = .setupIntent(intent) + self.events.append(cancelEvent) + } + self.complete() + } + } + private func confirmSetupIntent(_ intent: SetupIntent) { var processEvent = LogEvent(method: .confirmSetupIntent) self.events.append(processEvent) diff --git a/Example/Example/StartPaymentViewController.swift b/Example/Example/StartPaymentViewController.swift index 439e329b..9f186b01 100644 --- a/Example/Example/StartPaymentViewController.swift +++ b/Example/Example/StartPaymentViewController.swift @@ -48,6 +48,14 @@ class StartPaymentViewController: TableViewController, CancelingViewController { return textField }() + private lazy var simulatedTipAmountTextField: AmountInputView = { + let textField = AmountInputView(placeholderText: "Simulated tip amount") + textField.textField.text = nil + textField.textField.clearButtonMode = .whileEditing + textField.textField.keyboardType = .numberPad + return textField + }() + convenience init() { self.init(style: .grouped) } @@ -147,6 +155,8 @@ class StartPaymentViewController: TableViewController, CancelingViewController { paymentParams.applicationFeeAmount = applicationFeeAmount } + Terminal.shared.simulatorConfiguration.simulatedTipAmount = NSNumber(value: simulatedTipAmountTextField.amount) + let collectConfig = CollectConfiguration(skipTipping: self.skipTipping, updatePaymentIntent: declineCardBrand != nil) if let eligibleAmount = Int(tipEligibleAmountTextField.textField.text ?? "none") { let tippingConfig = TippingConfiguration(eligibleAmount: eligibleAmount) @@ -206,6 +216,16 @@ class StartPaymentViewController: TableViewController, CancelingViewController { footer: .autoLayoutView(tipEligibleAmountTextField)) } + private func makeSimulatedTipAmountSection() -> Section? { + if Terminal.shared.connectedReader?.simulated == true { + return Section( + header: "SIMULATED TIP AMOUNT", + footer: .autoLayoutView(simulatedTipAmountTextField)) + } else { + return nil + } + } + private func makePaymentMethodSection() -> Section { let shouldShowTestCardPickerView = Terminal.shared.connectedReader?.simulated == true @@ -313,24 +333,19 @@ class StartPaymentViewController: TableViewController, CancelingViewController { private func updateContent() { - var sections: [Section] = [ + let sections: [Section?] = [ self.makeAmountSection(), self.makeCurrencySection(), self.makeTippingSection(), + self.makeSimulatedTipAmountSection(), self.makePaymentMethodSection(), self.makeDestinationPaymentSection(), self.makeApplicationFeeAmountSection(), + self.makeSetupFutureUsageSection(), + self.startSection ] - if let setupFutureUsageSection = self.makeSetupFutureUsageSection() { - sections.append(setupFutureUsageSection) - } - - if let startSection = self.startSection { - sections.append(startSection) - } - - dataSource.sections = sections + dataSource.sections = sections.compactMap { $0 } } } diff --git a/Example/Podfile.lock b/Example/Podfile.lock index 02fffa74..67f57212 100644 --- a/Example/Podfile.lock +++ b/Example/Podfile.lock @@ -26,4 +26,4 @@ SPEC CHECKSUMS: PODFILE CHECKSUM: 9c573d12813794199966fc330a5c195afc20cec4 -COCOAPODS: 1.12.0 +COCOAPODS: 1.11.3 diff --git a/Example/Pods/Manifest.lock b/Example/Pods/Manifest.lock index 02fffa74..67f57212 100644 --- a/Example/Pods/Manifest.lock +++ b/Example/Pods/Manifest.lock @@ -26,4 +26,4 @@ SPEC CHECKSUMS: PODFILE CHECKSUM: 9c573d12813794199966fc330a5c195afc20cec4 -COCOAPODS: 1.12.0 +COCOAPODS: 1.11.3 diff --git a/Example/Pods/Target Support Files/Alamofire/Alamofire-Info.plist b/Example/Pods/Target Support Files/Alamofire/Alamofire-Info.plist index 28d54482..0dbae303 100644 --- a/Example/Pods/Target Support Files/Alamofire/Alamofire-Info.plist +++ b/Example/Pods/Target Support Files/Alamofire/Alamofire-Info.plist @@ -3,7 +3,7 @@ CFBundleDevelopmentRegion - ${PODS_DEVELOPMENT_LANGUAGE} + en CFBundleExecutable ${EXECUTABLE_NAME} CFBundleIdentifier diff --git a/Example/Pods/Target Support Files/Alamofire/Alamofire.debug.xcconfig b/Example/Pods/Target Support Files/Alamofire/Alamofire.debug.xcconfig index a3b1b91d..6876d983 100644 --- a/Example/Pods/Target Support Files/Alamofire/Alamofire.debug.xcconfig +++ b/Example/Pods/Target Support Files/Alamofire/Alamofire.debug.xcconfig @@ -5,7 +5,6 @@ LIBRARY_SEARCH_PATHS = $(inherited) "${DT_TOOLCHAIN_DIR}/usr/lib/swift/${PLATFOR OTHER_SWIFT_FLAGS = $(inherited) -D COCOAPODS PODS_BUILD_DIR = ${BUILD_DIR} PODS_CONFIGURATION_BUILD_DIR = ${PODS_BUILD_DIR}/$(CONFIGURATION)$(EFFECTIVE_PLATFORM_NAME) -PODS_DEVELOPMENT_LANGUAGE = ${DEVELOPMENT_LANGUAGE} PODS_ROOT = ${SRCROOT} PODS_TARGET_SRCROOT = ${PODS_ROOT}/Alamofire PODS_XCFRAMEWORKS_BUILD_DIR = $(PODS_CONFIGURATION_BUILD_DIR)/XCFrameworkIntermediates diff --git a/Example/Pods/Target Support Files/Alamofire/Alamofire.release.xcconfig b/Example/Pods/Target Support Files/Alamofire/Alamofire.release.xcconfig index a3b1b91d..6876d983 100644 --- a/Example/Pods/Target Support Files/Alamofire/Alamofire.release.xcconfig +++ b/Example/Pods/Target Support Files/Alamofire/Alamofire.release.xcconfig @@ -5,7 +5,6 @@ LIBRARY_SEARCH_PATHS = $(inherited) "${DT_TOOLCHAIN_DIR}/usr/lib/swift/${PLATFOR OTHER_SWIFT_FLAGS = $(inherited) -D COCOAPODS PODS_BUILD_DIR = ${BUILD_DIR} PODS_CONFIGURATION_BUILD_DIR = ${PODS_BUILD_DIR}/$(CONFIGURATION)$(EFFECTIVE_PLATFORM_NAME) -PODS_DEVELOPMENT_LANGUAGE = ${DEVELOPMENT_LANGUAGE} PODS_ROOT = ${SRCROOT} PODS_TARGET_SRCROOT = ${PODS_ROOT}/Alamofire PODS_XCFRAMEWORKS_BUILD_DIR = $(PODS_CONFIGURATION_BUILD_DIR)/XCFrameworkIntermediates diff --git a/Example/Pods/Target Support Files/Pods-Example/Pods-Example-Info.plist b/Example/Pods/Target Support Files/Pods-Example/Pods-Example-Info.plist index 19cf209d..2243fe6e 100644 --- a/Example/Pods/Target Support Files/Pods-Example/Pods-Example-Info.plist +++ b/Example/Pods/Target Support Files/Pods-Example/Pods-Example-Info.plist @@ -3,7 +3,7 @@ CFBundleDevelopmentRegion - ${PODS_DEVELOPMENT_LANGUAGE} + en CFBundleExecutable ${EXECUTABLE_NAME} CFBundleIdentifier diff --git a/Example/Pods/Target Support Files/Static/Static-Info.plist b/Example/Pods/Target Support Files/Static/Static-Info.plist index fee5e016..3424ca66 100644 --- a/Example/Pods/Target Support Files/Static/Static-Info.plist +++ b/Example/Pods/Target Support Files/Static/Static-Info.plist @@ -3,7 +3,7 @@ CFBundleDevelopmentRegion - ${PODS_DEVELOPMENT_LANGUAGE} + en CFBundleExecutable ${EXECUTABLE_NAME} CFBundleIdentifier diff --git a/Example/Pods/Target Support Files/Static/Static.debug.xcconfig b/Example/Pods/Target Support Files/Static/Static.debug.xcconfig index b6718f3b..8bc89ef3 100644 --- a/Example/Pods/Target Support Files/Static/Static.debug.xcconfig +++ b/Example/Pods/Target Support Files/Static/Static.debug.xcconfig @@ -6,7 +6,6 @@ OTHER_LDFLAGS = $(inherited) -framework "UIKit" OTHER_SWIFT_FLAGS = $(inherited) -D COCOAPODS -suppress-warnings PODS_BUILD_DIR = ${BUILD_DIR} PODS_CONFIGURATION_BUILD_DIR = ${PODS_BUILD_DIR}/$(CONFIGURATION)$(EFFECTIVE_PLATFORM_NAME) -PODS_DEVELOPMENT_LANGUAGE = ${DEVELOPMENT_LANGUAGE} PODS_ROOT = ${SRCROOT} PODS_TARGET_SRCROOT = ${PODS_ROOT}/Static PODS_XCFRAMEWORKS_BUILD_DIR = $(PODS_CONFIGURATION_BUILD_DIR)/XCFrameworkIntermediates diff --git a/Example/Pods/Target Support Files/Static/Static.release.xcconfig b/Example/Pods/Target Support Files/Static/Static.release.xcconfig index b6718f3b..8bc89ef3 100644 --- a/Example/Pods/Target Support Files/Static/Static.release.xcconfig +++ b/Example/Pods/Target Support Files/Static/Static.release.xcconfig @@ -6,7 +6,6 @@ OTHER_LDFLAGS = $(inherited) -framework "UIKit" OTHER_SWIFT_FLAGS = $(inherited) -D COCOAPODS -suppress-warnings PODS_BUILD_DIR = ${BUILD_DIR} PODS_CONFIGURATION_BUILD_DIR = ${PODS_BUILD_DIR}/$(CONFIGURATION)$(EFFECTIVE_PLATFORM_NAME) -PODS_DEVELOPMENT_LANGUAGE = ${DEVELOPMENT_LANGUAGE} PODS_ROOT = ${SRCROOT} PODS_TARGET_SRCROOT = ${PODS_ROOT}/Static PODS_XCFRAMEWORKS_BUILD_DIR = $(PODS_CONFIGURATION_BUILD_DIR)/XCFrameworkIntermediates diff --git a/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPBluetoothReaderDelegate.h b/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPBluetoothReaderDelegate.h index c5ee7359..7f9707d6 100644 --- a/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPBluetoothReaderDelegate.h +++ b/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPBluetoothReaderDelegate.h @@ -16,6 +16,7 @@ #import #import + @class SCPReader; @class SCPReaderSoftwareUpdate; @class SCPCancelable; @@ -32,7 +33,8 @@ NS_ASSUME_NONNULL_BEGIN The provided delegate must be retained by your application until the reader disconnects. */ NS_SWIFT_NAME(BluetoothReaderDelegate) -@protocol SCPBluetoothReaderDelegate +@protocol SCPBluetoothReaderDelegate + /** The SDK is reporting that an update is available for the reader. diff --git a/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPErrors.h b/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPErrors.h index 1d4caa6e..8a8936df 100644 --- a/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPErrors.h +++ b/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPErrors.h @@ -165,6 +165,7 @@ typedef NS_ERROR_ENUM(SCPErrorDomain, SCPError){ */ SCPErrorInvalidLocationIdParameter = 1960, + /* USER ERRORS */ diff --git a/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPLocalMobileReaderDelegate.h b/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPLocalMobileReaderDelegate.h index 8f90cc19..24f86000 100644 --- a/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPLocalMobileReaderDelegate.h +++ b/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPLocalMobileReaderDelegate.h @@ -12,6 +12,7 @@ #import #import + @class SCPReader; @class SCPReaderSoftwareUpdate; @class SCPCancelable; @@ -27,7 +28,8 @@ NS_ASSUME_NONNULL_BEGIN The provided delegate must be retained by your application until the reader disconnects. */ NS_SWIFT_NAME(LocalMobileReaderDelegate) -@protocol SCPLocalMobileReaderDelegate +@protocol SCPLocalMobileReaderDelegate + /** The reader has started installing a software update. diff --git a/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPPaymentIntent.h b/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPPaymentIntent.h index 479589d2..fc1a8b67 100644 --- a/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPPaymentIntent.h +++ b/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPPaymentIntent.h @@ -11,6 +11,7 @@ #import #import +#import NS_ASSUME_NONNULL_BEGIN @@ -86,6 +87,11 @@ NS_SWIFT_NAME(PaymentIntent) */ @property (nonatomic, readonly) NSUInteger amount; +/** + Controls when the funds will be captured from the customer’s account. + */ +@property (nonatomic, readonly) SCPCaptureMethod captureMethod; + /** The currency of the payment. */ diff --git a/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPReceiptDetails.h b/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPReceiptDetails.h index 7fa12fff..d4fda53c 100644 --- a/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPReceiptDetails.h +++ b/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPReceiptDetails.h @@ -38,6 +38,11 @@ NS_SWIFT_NAME(ReceiptDetails) */ @property (nonatomic, readonly) NSString *dedicatedFileName; +/** + Identifier for this transaction + */ +@property (nonatomic, nullable, readonly) NSString *authorizationCode; + /** Authorization Response Code */ diff --git a/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPSimulatedCardType.h b/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPSimulatedCardType.h index d9a823c6..3cbc557a 100644 --- a/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPSimulatedCardType.h +++ b/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPSimulatedCardType.h @@ -64,6 +64,12 @@ typedef NS_ENUM(NSUInteger, SCPSimulatedCardType) { /// Eftpos Australia SCPSimulatedCardTypeEftposAuDebit, + /// Eftpos Australia/Visa + SCPSimulatedCardTypeEftposAuVisaDebit, + + /// Eftpos Australia/Mastercard + SCPSimulatedCardTypeEftposAuDebitMastercard, + /// Charge is declined with a card_declined code. SCPSimulatedCardTypeChargeDeclined, diff --git a/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPSimulatorConfiguration.h b/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPSimulatorConfiguration.h index 64b4f742..c05c5e66 100644 --- a/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPSimulatorConfiguration.h +++ b/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPSimulatorConfiguration.h @@ -46,6 +46,12 @@ NS_SWIFT_NAME(SimulatorConfiguration) */ @property (nonatomic, readwrite) SCPSimulatedCard *simulatedCard; +/** + Set this to simulate a Terminal configuration object with this fixed tip + amount for all currencies. + */ +@property (nonatomic, readwrite, nullable) NSNumber *simulatedTipAmount; + /** You cannot directly instantiate this class. Set exposed properties via `SCPTerminal.shared.simulatorConfiguration` diff --git a/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPTerminal.h b/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPTerminal.h index 61abdda8..53a0437f 100644 --- a/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPTerminal.h +++ b/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/SCPTerminal.h @@ -21,6 +21,7 @@ #import #import #import +#import #import #import #import @@ -31,7 +32,7 @@ NS_ASSUME_NONNULL_BEGIN /** The current version of this library. */ -static NSString *const SCPSDKVersion = @"2.18.1"; +static NSString *const SCPSDKVersion = @"2.19.0"; @class SCPCancelable, SCPBluetoothConnectionConfiguration, @@ -605,8 +606,8 @@ before connecting which specifies the location to which this @see https://stripe.com/docs/api/setup_intents/create - @param setupIntentParams The parameters that control the creation of the SetupIntent - @param completion The compltion block called when the command completes + @param setupIntentParams The parameters that control the creation of the SetupIntent. + @param completion The completion block called when the command completes. */ - (void)createSetupIntent:(SCPSetupIntentParameters *)setupIntentParams completion:(SCPSetupIntentCompletionBlock)completion NS_SWIFT_NAME(createSetupIntent(_:completion:)); @@ -617,7 +618,7 @@ before connecting which specifies the location to which this If you've created a SetupIntent on your backend, you must retrieve it in the Stripe Terminal SDK before calling `collectSetupIntentPaymentMethod`. - @param clientSecret The client secret of the SetupIntent to be retrieved + @param clientSecret The client secret of the SetupIntent to be retrieved. @param completion The completion block called when the command completes. */ - (void)retrieveSetupIntent:(NSString *)clientSecret @@ -855,6 +856,11 @@ before connecting which specifies the location to which this */ + (NSString *)stringFromPaymentIntentStatus:(SCPPaymentIntentStatus)paymentIntentStatus NS_SWIFT_NAME(stringFromPaymentIntentStatus(_:)); +/** + Returns an unlocalized string for the given capture method. + */ ++ (NSString *)stringFromCaptureMethod:(SCPCaptureMethod)captureMethod NS_SWIFT_NAME(stringFromCaptureMethod(_:)); + /** Use `initWithConfiguration:tokenProvider:delegate:` diff --git a/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/StripeTerminal.h b/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/StripeTerminal.h index 3b6c2ebf..15edb7b7 100644 --- a/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/StripeTerminal.h +++ b/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Headers/StripeTerminal.h @@ -77,3 +77,4 @@ #import #import + diff --git a/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Info.plist b/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Info.plist index 572c75cb..ab327ff5 100644 Binary files a/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Info.plist and b/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Info.plist differ diff --git a/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Modules/StripeTerminal.swiftmodule/arm64-apple-ios.abi.json b/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Modules/StripeTerminal.swiftmodule/arm64-apple-ios.abi.json index 62afc237..25c831b1 100644 --- a/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Modules/StripeTerminal.swiftmodule/arm64-apple-ios.abi.json +++ b/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/Modules/StripeTerminal.swiftmodule/arm64-apple-ios.abi.json @@ -6524,1183 +6524,1183 @@ }, "ConstValues": [ { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 3088, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "FloatLiteral", "offset": 3234, "length": 4, "value": "10.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 3470, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "StringLiteral", "offset": 3497, "length": 11, "value": "\"💳\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "FloatLiteral", "offset": 3594, "length": 4, "value": "72.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 3876, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "FloatLiteral", "offset": 3967, "length": 4, "value": "24.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "FloatLiteral", "offset": 4025, "length": 3, "value": "0.5" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 4071, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 4151, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 4399, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "FloatLiteral", "offset": 4490, "length": 4, "value": "72.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "FloatLiteral", "offset": 4550, "length": 4, "value": "0.25" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 4597, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 4677, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 4949, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "FloatLiteral", "offset": 5040, "length": 4, "value": "36.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "FloatLiteral", "offset": 5096, "length": 3, "value": "0.5" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 5142, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "StringLiteral", "offset": 5218, "length": 11, "value": "\"Save Card\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 5255, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 5484, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReader.swift", "kind": "BooleanLiteral", "offset": 4084, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReader.swift", "kind": "StringLiteral", "offset": 1120, "length": 18, "value": "\"StripeTerminal.AppleBuiltInReader\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 785, "length": 1, "value": "0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 876, "length": 13, "value": "1" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 976, "length": 22, "value": "2" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1140, "length": 16, "value": "3" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1341, "length": 10, "value": "4" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1462, "length": 27, "value": "5" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1554, "length": 11, "value": "6" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1620, "length": 21, "value": "7" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1690, "length": 17, "value": "8" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1764, "length": 12, "value": "9" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1837, "length": 26, "value": "10" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1920, "length": 22, "value": "11" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2035, "length": 8, "value": "12" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2102, "length": 16, "value": "13" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2196, "length": 18, "value": "14" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2315, "length": 13, "value": "15" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2442, "length": 14, "value": "16" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2545, "length": 12, "value": "17" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2654, "length": 12, "value": "18" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2713, "length": 16, "value": "19" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2839, "length": 10, "value": "20" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2954, "length": 16, "value": "21" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3100, "length": 20, "value": "22" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3184, "length": 34, "value": "23" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3298, "length": 23, "value": "24" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3360, "length": 15, "value": "25" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3414, "length": 15, "value": "26" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3588, "length": 14, "value": "27" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3713, "length": 23, "value": "28" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3806, "length": 28, "value": "29" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3922, "length": 18, "value": "30" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4036, "length": 15, "value": "31" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4161, "length": 20, "value": "32" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4313, "length": 18, "value": "33" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4404, "length": 25, "value": "34" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4492, "length": 32, "value": "35" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4596, "length": 17, "value": "36" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4673, "length": 13, "value": "37" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4740, "length": 13, "value": "38" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4809, "length": 15, "value": "39" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4891, "length": 11, "value": "40" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 5013, "length": 24, "value": "41" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 5116, "length": 14, "value": "42" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 5209, "length": 17, "value": "43" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 5287, "length": 19, "value": "44" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 785, "length": 1, "value": "0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 876, "length": 13, "value": "1" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 976, "length": 22, "value": "2" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1140, "length": 16, "value": "3" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1341, "length": 10, "value": "4" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1462, "length": 27, "value": "5" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1554, "length": 11, "value": "6" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1620, "length": 21, "value": "7" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1690, "length": 17, "value": "8" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1764, "length": 12, "value": "9" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1837, "length": 26, "value": "10" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1920, "length": 22, "value": "11" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2035, "length": 8, "value": "12" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2102, "length": 16, "value": "13" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2196, "length": 18, "value": "14" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2315, "length": 13, "value": "15" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2442, "length": 14, "value": "16" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2545, "length": 12, "value": "17" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2654, "length": 12, "value": "18" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2713, "length": 16, "value": "19" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2839, "length": 10, "value": "20" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2954, "length": 16, "value": "21" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3100, "length": 20, "value": "22" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3184, "length": 34, "value": "23" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3298, "length": 23, "value": "24" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3360, "length": 15, "value": "25" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3414, "length": 15, "value": "26" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3588, "length": 14, "value": "27" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3713, "length": 23, "value": "28" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3806, "length": 28, "value": "29" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3922, "length": 18, "value": "30" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4036, "length": 15, "value": "31" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4161, "length": 20, "value": "32" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4313, "length": 18, "value": "33" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4404, "length": 25, "value": "34" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4492, "length": 32, "value": "35" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4596, "length": 17, "value": "36" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4673, "length": 13, "value": "37" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4740, "length": 13, "value": "38" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4809, "length": 15, "value": "39" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4891, "length": 11, "value": "40" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 5013, "length": 24, "value": "41" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 5116, "length": 14, "value": "42" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 5209, "length": 17, "value": "43" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 5287, "length": 19, "value": "44" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "StringLiteral", "offset": 8964, "length": 34, "value": "\"SCPAppleBuiltInReaderErrorDomain\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "StringLiteral", "offset": 9135, "length": 43, "value": "\"SCPAppleBuiltInReaderErrorUserInfoNameKey\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "StringLiteral", "offset": 9328, "length": 49, "value": "\"SCPAppleBuiltInReaderErrorUserInfoReaderMessage\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "StringLiteral", "offset": 9545, "length": 57, "value": "\"SCPAppleBuiltInReaderErrorUserInfoDeviceBannedUntilDate\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 717, "length": 1, "value": "0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 815, "length": 11, "value": "1" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 888, "length": 12, "value": "2" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 971, "length": 10, "value": "3" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 1043, "length": 9, "value": "4" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 1144, "length": 5, "value": "5" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 1198, "length": 12, "value": "6" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 1265, "length": 16, "value": "7" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 717, "length": 1, "value": "0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 815, "length": 11, "value": "1" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 888, "length": 12, "value": "2" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 971, "length": 10, "value": "3" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 1043, "length": 9, "value": "4" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 1144, "length": 5, "value": "5" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 1198, "length": 12, "value": "6" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 1265, "length": 16, "value": "7" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 2332, "length": 4, "value": "30.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "BooleanLiteral", "offset": 5724, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 5870, "length": 4, "value": "20.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "BooleanLiteral", "offset": 6190, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "StringLiteral", "offset": 6322, "length": 25, "value": "\"Tap to Simulate Payment\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 6468, "length": 4, "value": "24.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 6539, "length": 4, "value": "0.95" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 6552, "length": 3, "value": "1.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 6610, "length": 4, "value": "20.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 6622, "length": 4, "value": "20.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 6636, "length": 4, "value": "20.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 6649, "length": 4, "value": "20.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 6691, "length": 3, "value": "4.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "BooleanLiteral", "offset": 6726, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "BooleanLiteral", "offset": 7017, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "BooleanLiteral", "offset": 7373, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "StringLiteral", "offset": 7503, "length": 10, "value": "\"✕\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 7634, "length": 4, "value": "32.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 7705, "length": 3, "value": "0.9" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 7717, "length": 3, "value": "1.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 7777, "length": 4, "value": "48.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "BooleanLiteral", "offset": 7794, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 7855, "length": 4, "value": "48.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "BooleanLiteral", "offset": 7872, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 7913, "length": 4, "value": "24.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "BooleanLiteral", "offset": 7949, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "StringLiteral", "offset": 2031, "length": 36, "value": "\"StripeTerminal.AppleBuiltInReaderMockViewController\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", "kind": "IntegerLiteral", "offset": 466, "length": 1, "value": "0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", "kind": "IntegerLiteral", "offset": 514, "length": 8, "value": "1" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", "kind": "IntegerLiteral", "offset": 569, "length": 6, "value": "2" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", "kind": "IntegerLiteral", "offset": 620, "length": 12, "value": "3" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", "kind": "IntegerLiteral", "offset": 466, "length": 1, "value": "0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", "kind": "IntegerLiteral", "offset": 514, "length": 8, "value": "1" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", "kind": "IntegerLiteral", "offset": 569, "length": 6, "value": "2" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", "kind": "IntegerLiteral", "offset": 620, "length": 12, diff --git a/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/StripeTerminal b/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/StripeTerminal index 8070efb9..0490c30b 100755 Binary files a/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/StripeTerminal and b/Example/StripeTerminal.xcframework/ios-arm64/StripeTerminal.framework/StripeTerminal differ diff --git a/Example/StripeTerminal.xcframework/ios-arm64/dSYMs/StripeTerminal.framework.dSYM/Contents/Info.plist b/Example/StripeTerminal.xcframework/ios-arm64/dSYMs/StripeTerminal.framework.dSYM/Contents/Info.plist index 9d15e8f6..0b7e1e89 100644 --- a/Example/StripeTerminal.xcframework/ios-arm64/dSYMs/StripeTerminal.framework.dSYM/Contents/Info.plist +++ b/Example/StripeTerminal.xcframework/ios-arm64/dSYMs/StripeTerminal.framework.dSYM/Contents/Info.plist @@ -13,8 +13,8 @@ CFBundleSignature ???? CFBundleShortVersionString - 2.18.1 + 2.19.0 CFBundleVersion - 2.18.1 + 2.19.0 diff --git a/Example/StripeTerminal.xcframework/ios-arm64/dSYMs/StripeTerminal.framework.dSYM/Contents/Resources/DWARF/StripeTerminal b/Example/StripeTerminal.xcframework/ios-arm64/dSYMs/StripeTerminal.framework.dSYM/Contents/Resources/DWARF/StripeTerminal index f8a55c22..4e5bfbd4 100644 Binary files a/Example/StripeTerminal.xcframework/ios-arm64/dSYMs/StripeTerminal.framework.dSYM/Contents/Resources/DWARF/StripeTerminal and b/Example/StripeTerminal.xcframework/ios-arm64/dSYMs/StripeTerminal.framework.dSYM/Contents/Resources/DWARF/StripeTerminal differ diff --git a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPBluetoothReaderDelegate.h b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPBluetoothReaderDelegate.h index c5ee7359..7f9707d6 100644 --- a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPBluetoothReaderDelegate.h +++ b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPBluetoothReaderDelegate.h @@ -16,6 +16,7 @@ #import #import + @class SCPReader; @class SCPReaderSoftwareUpdate; @class SCPCancelable; @@ -32,7 +33,8 @@ NS_ASSUME_NONNULL_BEGIN The provided delegate must be retained by your application until the reader disconnects. */ NS_SWIFT_NAME(BluetoothReaderDelegate) -@protocol SCPBluetoothReaderDelegate +@protocol SCPBluetoothReaderDelegate + /** The SDK is reporting that an update is available for the reader. diff --git a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPErrors.h b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPErrors.h index 1d4caa6e..8a8936df 100644 --- a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPErrors.h +++ b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPErrors.h @@ -165,6 +165,7 @@ typedef NS_ERROR_ENUM(SCPErrorDomain, SCPError){ */ SCPErrorInvalidLocationIdParameter = 1960, + /* USER ERRORS */ diff --git a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPLocalMobileReaderDelegate.h b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPLocalMobileReaderDelegate.h index 8f90cc19..24f86000 100644 --- a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPLocalMobileReaderDelegate.h +++ b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPLocalMobileReaderDelegate.h @@ -12,6 +12,7 @@ #import #import + @class SCPReader; @class SCPReaderSoftwareUpdate; @class SCPCancelable; @@ -27,7 +28,8 @@ NS_ASSUME_NONNULL_BEGIN The provided delegate must be retained by your application until the reader disconnects. */ NS_SWIFT_NAME(LocalMobileReaderDelegate) -@protocol SCPLocalMobileReaderDelegate +@protocol SCPLocalMobileReaderDelegate + /** The reader has started installing a software update. diff --git a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPPaymentIntent.h b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPPaymentIntent.h index 479589d2..fc1a8b67 100644 --- a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPPaymentIntent.h +++ b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPPaymentIntent.h @@ -11,6 +11,7 @@ #import #import +#import NS_ASSUME_NONNULL_BEGIN @@ -86,6 +87,11 @@ NS_SWIFT_NAME(PaymentIntent) */ @property (nonatomic, readonly) NSUInteger amount; +/** + Controls when the funds will be captured from the customer’s account. + */ +@property (nonatomic, readonly) SCPCaptureMethod captureMethod; + /** The currency of the payment. */ diff --git a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPReceiptDetails.h b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPReceiptDetails.h index 7fa12fff..d4fda53c 100644 --- a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPReceiptDetails.h +++ b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPReceiptDetails.h @@ -38,6 +38,11 @@ NS_SWIFT_NAME(ReceiptDetails) */ @property (nonatomic, readonly) NSString *dedicatedFileName; +/** + Identifier for this transaction + */ +@property (nonatomic, nullable, readonly) NSString *authorizationCode; + /** Authorization Response Code */ diff --git a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPSimulatedCardType.h b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPSimulatedCardType.h index d9a823c6..3cbc557a 100644 --- a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPSimulatedCardType.h +++ b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPSimulatedCardType.h @@ -64,6 +64,12 @@ typedef NS_ENUM(NSUInteger, SCPSimulatedCardType) { /// Eftpos Australia SCPSimulatedCardTypeEftposAuDebit, + /// Eftpos Australia/Visa + SCPSimulatedCardTypeEftposAuVisaDebit, + + /// Eftpos Australia/Mastercard + SCPSimulatedCardTypeEftposAuDebitMastercard, + /// Charge is declined with a card_declined code. SCPSimulatedCardTypeChargeDeclined, diff --git a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPSimulatorConfiguration.h b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPSimulatorConfiguration.h index 64b4f742..c05c5e66 100644 --- a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPSimulatorConfiguration.h +++ b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPSimulatorConfiguration.h @@ -46,6 +46,12 @@ NS_SWIFT_NAME(SimulatorConfiguration) */ @property (nonatomic, readwrite) SCPSimulatedCard *simulatedCard; +/** + Set this to simulate a Terminal configuration object with this fixed tip + amount for all currencies. + */ +@property (nonatomic, readwrite, nullable) NSNumber *simulatedTipAmount; + /** You cannot directly instantiate this class. Set exposed properties via `SCPTerminal.shared.simulatorConfiguration` diff --git a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPTerminal.h b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPTerminal.h index 61abdda8..53a0437f 100644 --- a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPTerminal.h +++ b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/SCPTerminal.h @@ -21,6 +21,7 @@ #import #import #import +#import #import #import #import @@ -31,7 +32,7 @@ NS_ASSUME_NONNULL_BEGIN /** The current version of this library. */ -static NSString *const SCPSDKVersion = @"2.18.1"; +static NSString *const SCPSDKVersion = @"2.19.0"; @class SCPCancelable, SCPBluetoothConnectionConfiguration, @@ -605,8 +606,8 @@ before connecting which specifies the location to which this @see https://stripe.com/docs/api/setup_intents/create - @param setupIntentParams The parameters that control the creation of the SetupIntent - @param completion The compltion block called when the command completes + @param setupIntentParams The parameters that control the creation of the SetupIntent. + @param completion The completion block called when the command completes. */ - (void)createSetupIntent:(SCPSetupIntentParameters *)setupIntentParams completion:(SCPSetupIntentCompletionBlock)completion NS_SWIFT_NAME(createSetupIntent(_:completion:)); @@ -617,7 +618,7 @@ before connecting which specifies the location to which this If you've created a SetupIntent on your backend, you must retrieve it in the Stripe Terminal SDK before calling `collectSetupIntentPaymentMethod`. - @param clientSecret The client secret of the SetupIntent to be retrieved + @param clientSecret The client secret of the SetupIntent to be retrieved. @param completion The completion block called when the command completes. */ - (void)retrieveSetupIntent:(NSString *)clientSecret @@ -855,6 +856,11 @@ before connecting which specifies the location to which this */ + (NSString *)stringFromPaymentIntentStatus:(SCPPaymentIntentStatus)paymentIntentStatus NS_SWIFT_NAME(stringFromPaymentIntentStatus(_:)); +/** + Returns an unlocalized string for the given capture method. + */ ++ (NSString *)stringFromCaptureMethod:(SCPCaptureMethod)captureMethod NS_SWIFT_NAME(stringFromCaptureMethod(_:)); + /** Use `initWithConfiguration:tokenProvider:delegate:` diff --git a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/StripeTerminal.h b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/StripeTerminal.h index 3b6c2ebf..15edb7b7 100644 --- a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/StripeTerminal.h +++ b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Headers/StripeTerminal.h @@ -77,3 +77,4 @@ #import #import + diff --git a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Info.plist b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Info.plist index 6db5142a..ac5a5a89 100644 Binary files a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Info.plist and b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Info.plist differ diff --git a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Modules/StripeTerminal.swiftmodule/arm64-apple-ios-simulator.abi.json b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Modules/StripeTerminal.swiftmodule/arm64-apple-ios-simulator.abi.json index f99c5469..e7eba691 100644 --- a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Modules/StripeTerminal.swiftmodule/arm64-apple-ios-simulator.abi.json +++ b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Modules/StripeTerminal.swiftmodule/arm64-apple-ios-simulator.abi.json @@ -6500,1176 +6500,1176 @@ }, "ConstValues": [ { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 3088, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "FloatLiteral", "offset": 3234, "length": 4, "value": "10.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 3470, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "StringLiteral", "offset": 3497, "length": 11, "value": "\"💳\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "FloatLiteral", "offset": 3594, "length": 4, "value": "72.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 3876, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "FloatLiteral", "offset": 3967, "length": 4, "value": "24.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "FloatLiteral", "offset": 4025, "length": 3, "value": "0.5" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 4071, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 4151, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 4399, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "FloatLiteral", "offset": 4490, "length": 4, "value": "72.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "FloatLiteral", "offset": 4550, "length": 4, "value": "0.25" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 4597, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 4677, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 4949, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "FloatLiteral", "offset": 5040, "length": 4, "value": "36.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "FloatLiteral", "offset": 5096, "length": 3, "value": "0.5" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 5142, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "StringLiteral", "offset": 5218, "length": 11, "value": "\"Save Card\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 5255, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 5484, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 785, "length": 1, "value": "0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 876, "length": 13, "value": "1" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 976, "length": 22, "value": "2" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1140, "length": 16, "value": "3" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1341, "length": 10, "value": "4" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1462, "length": 27, "value": "5" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1554, "length": 11, "value": "6" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1620, "length": 21, "value": "7" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1690, "length": 17, "value": "8" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1764, "length": 12, "value": "9" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1837, "length": 26, "value": "10" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1920, "length": 22, "value": "11" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2035, "length": 8, "value": "12" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2102, "length": 16, "value": "13" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2196, "length": 18, "value": "14" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2315, "length": 13, "value": "15" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2442, "length": 14, "value": "16" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2545, "length": 12, "value": "17" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2654, "length": 12, "value": "18" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2713, "length": 16, "value": "19" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2839, "length": 10, "value": "20" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2954, "length": 16, "value": "21" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3100, "length": 20, "value": "22" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3184, "length": 34, "value": "23" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3298, "length": 23, "value": "24" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3360, "length": 15, "value": "25" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3414, "length": 15, "value": "26" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3588, "length": 14, "value": "27" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3713, "length": 23, "value": "28" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3806, "length": 28, "value": "29" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3922, "length": 18, "value": "30" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4036, "length": 15, "value": "31" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4161, "length": 20, "value": "32" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4313, "length": 18, "value": "33" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4404, "length": 25, "value": "34" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4492, "length": 32, "value": "35" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4596, "length": 17, "value": "36" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4673, "length": 13, "value": "37" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4740, "length": 13, "value": "38" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4809, "length": 15, "value": "39" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4891, "length": 11, "value": "40" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 5013, "length": 24, "value": "41" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 5116, "length": 14, "value": "42" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 5209, "length": 17, "value": "43" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 5287, "length": 19, "value": "44" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 785, "length": 1, "value": "0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 876, "length": 13, "value": "1" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 976, "length": 22, "value": "2" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1140, "length": 16, "value": "3" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1341, "length": 10, "value": "4" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1462, "length": 27, "value": "5" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1554, "length": 11, "value": "6" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1620, "length": 21, "value": "7" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1690, "length": 17, "value": "8" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1764, "length": 12, "value": "9" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1837, "length": 26, "value": "10" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1920, "length": 22, "value": "11" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2035, "length": 8, "value": "12" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2102, "length": 16, "value": "13" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2196, "length": 18, "value": "14" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2315, "length": 13, "value": "15" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2442, "length": 14, "value": "16" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2545, "length": 12, "value": "17" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2654, "length": 12, "value": "18" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2713, "length": 16, "value": "19" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2839, "length": 10, "value": "20" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2954, "length": 16, "value": "21" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3100, "length": 20, "value": "22" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3184, "length": 34, "value": "23" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3298, "length": 23, "value": "24" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3360, "length": 15, "value": "25" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3414, "length": 15, "value": "26" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3588, "length": 14, "value": "27" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3713, "length": 23, "value": "28" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3806, "length": 28, "value": "29" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3922, "length": 18, "value": "30" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4036, "length": 15, "value": "31" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4161, "length": 20, "value": "32" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4313, "length": 18, "value": "33" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4404, "length": 25, "value": "34" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4492, "length": 32, "value": "35" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4596, "length": 17, "value": "36" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4673, "length": 13, "value": "37" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4740, "length": 13, "value": "38" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4809, "length": 15, "value": "39" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4891, "length": 11, "value": "40" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 5013, "length": 24, "value": "41" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 5116, "length": 14, "value": "42" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 5209, "length": 17, "value": "43" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 5287, "length": 19, "value": "44" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "StringLiteral", "offset": 8964, "length": 34, "value": "\"SCPAppleBuiltInReaderErrorDomain\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "StringLiteral", "offset": 9135, "length": 43, "value": "\"SCPAppleBuiltInReaderErrorUserInfoNameKey\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "StringLiteral", "offset": 9328, "length": 49, "value": "\"SCPAppleBuiltInReaderErrorUserInfoReaderMessage\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "StringLiteral", "offset": 9545, "length": 57, "value": "\"SCPAppleBuiltInReaderErrorUserInfoDeviceBannedUntilDate\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 717, "length": 1, "value": "0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 815, "length": 11, "value": "1" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 888, "length": 12, "value": "2" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 971, "length": 10, "value": "3" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 1043, "length": 9, "value": "4" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 1144, "length": 5, "value": "5" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 1198, "length": 12, "value": "6" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 1265, "length": 16, "value": "7" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 717, "length": 1, "value": "0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 815, "length": 11, "value": "1" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 888, "length": 12, "value": "2" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 971, "length": 10, "value": "3" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 1043, "length": 9, "value": "4" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 1144, "length": 5, "value": "5" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 1198, "length": 12, "value": "6" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 1265, "length": 16, "value": "7" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderStub.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderStub.swift", "kind": "StringLiteral", "offset": 824, "length": 18, "value": "\"StripeTerminal.AppleBuiltInReader\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 2332, "length": 4, "value": "30.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "BooleanLiteral", "offset": 5724, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 5870, "length": 4, "value": "20.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "BooleanLiteral", "offset": 6190, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "StringLiteral", "offset": 6322, "length": 25, "value": "\"Tap to Simulate Payment\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 6468, "length": 4, "value": "24.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 6539, "length": 4, "value": "0.95" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 6552, "length": 3, "value": "1.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 6610, "length": 4, "value": "20.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 6622, "length": 4, "value": "20.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 6636, "length": 4, "value": "20.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 6649, "length": 4, "value": "20.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 6691, "length": 3, "value": "4.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "BooleanLiteral", "offset": 6726, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "BooleanLiteral", "offset": 7017, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "BooleanLiteral", "offset": 7373, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "StringLiteral", "offset": 7503, "length": 10, "value": "\"✕\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 7634, "length": 4, "value": "32.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 7705, "length": 3, "value": "0.9" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 7717, "length": 3, "value": "1.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 7777, "length": 4, "value": "48.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "BooleanLiteral", "offset": 7794, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 7855, "length": 4, "value": "48.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "BooleanLiteral", "offset": 7872, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 7913, "length": 4, "value": "24.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "BooleanLiteral", "offset": 7949, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "StringLiteral", "offset": 2031, "length": 36, "value": "\"StripeTerminal.AppleBuiltInReaderMockViewController\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", "kind": "IntegerLiteral", "offset": 466, "length": 1, "value": "0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", "kind": "IntegerLiteral", "offset": 514, "length": 8, "value": "1" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", "kind": "IntegerLiteral", "offset": 569, "length": 6, "value": "2" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", "kind": "IntegerLiteral", "offset": 620, "length": 12, "value": "3" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", "kind": "IntegerLiteral", "offset": 466, "length": 1, "value": "0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", "kind": "IntegerLiteral", "offset": 514, "length": 8, "value": "1" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", "kind": "IntegerLiteral", "offset": 569, "length": 6, "value": "2" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", "kind": "IntegerLiteral", "offset": 620, "length": 12, diff --git a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Modules/StripeTerminal.swiftmodule/x86_64-apple-ios-simulator.abi.json b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Modules/StripeTerminal.swiftmodule/x86_64-apple-ios-simulator.abi.json index f99c5469..e7eba691 100644 --- a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Modules/StripeTerminal.swiftmodule/x86_64-apple-ios-simulator.abi.json +++ b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/Modules/StripeTerminal.swiftmodule/x86_64-apple-ios-simulator.abi.json @@ -6500,1176 +6500,1176 @@ }, "ConstValues": [ { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 3088, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "FloatLiteral", "offset": 3234, "length": 4, "value": "10.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 3470, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "StringLiteral", "offset": 3497, "length": 11, "value": "\"💳\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "FloatLiteral", "offset": 3594, "length": 4, "value": "72.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 3876, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "FloatLiteral", "offset": 3967, "length": 4, "value": "24.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "FloatLiteral", "offset": 4025, "length": 3, "value": "0.5" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 4071, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 4151, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 4399, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "FloatLiteral", "offset": 4490, "length": 4, "value": "72.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "FloatLiteral", "offset": 4550, "length": 4, "value": "0.25" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 4597, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 4677, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 4949, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "FloatLiteral", "offset": 5040, "length": 4, "value": "36.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "FloatLiteral", "offset": 5096, "length": 3, "value": "0.5" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 5142, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "StringLiteral", "offset": 5218, "length": 11, "value": "\"Save Card\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 5255, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockMetadataView.swift", "kind": "BooleanLiteral", "offset": 5484, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 785, "length": 1, "value": "0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 876, "length": 13, "value": "1" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 976, "length": 22, "value": "2" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1140, "length": 16, "value": "3" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1341, "length": 10, "value": "4" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1462, "length": 27, "value": "5" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1554, "length": 11, "value": "6" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1620, "length": 21, "value": "7" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1690, "length": 17, "value": "8" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1764, "length": 12, "value": "9" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1837, "length": 26, "value": "10" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1920, "length": 22, "value": "11" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2035, "length": 8, "value": "12" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2102, "length": 16, "value": "13" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2196, "length": 18, "value": "14" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2315, "length": 13, "value": "15" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2442, "length": 14, "value": "16" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2545, "length": 12, "value": "17" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2654, "length": 12, "value": "18" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2713, "length": 16, "value": "19" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2839, "length": 10, "value": "20" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2954, "length": 16, "value": "21" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3100, "length": 20, "value": "22" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3184, "length": 34, "value": "23" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3298, "length": 23, "value": "24" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3360, "length": 15, "value": "25" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3414, "length": 15, "value": "26" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3588, "length": 14, "value": "27" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3713, "length": 23, "value": "28" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3806, "length": 28, "value": "29" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3922, "length": 18, "value": "30" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4036, "length": 15, "value": "31" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4161, "length": 20, "value": "32" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4313, "length": 18, "value": "33" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4404, "length": 25, "value": "34" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4492, "length": 32, "value": "35" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4596, "length": 17, "value": "36" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4673, "length": 13, "value": "37" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4740, "length": 13, "value": "38" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4809, "length": 15, "value": "39" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4891, "length": 11, "value": "40" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 5013, "length": 24, "value": "41" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 5116, "length": 14, "value": "42" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 5209, "length": 17, "value": "43" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 5287, "length": 19, "value": "44" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 785, "length": 1, "value": "0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 876, "length": 13, "value": "1" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 976, "length": 22, "value": "2" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1140, "length": 16, "value": "3" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1341, "length": 10, "value": "4" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1462, "length": 27, "value": "5" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1554, "length": 11, "value": "6" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1620, "length": 21, "value": "7" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1690, "length": 17, "value": "8" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1764, "length": 12, "value": "9" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1837, "length": 26, "value": "10" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 1920, "length": 22, "value": "11" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2035, "length": 8, "value": "12" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2102, "length": 16, "value": "13" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2196, "length": 18, "value": "14" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2315, "length": 13, "value": "15" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2442, "length": 14, "value": "16" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2545, "length": 12, "value": "17" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2654, "length": 12, "value": "18" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2713, "length": 16, "value": "19" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2839, "length": 10, "value": "20" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 2954, "length": 16, "value": "21" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3100, "length": 20, "value": "22" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3184, "length": 34, "value": "23" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3298, "length": 23, "value": "24" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3360, "length": 15, "value": "25" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3414, "length": 15, "value": "26" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3588, "length": 14, "value": "27" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3713, "length": 23, "value": "28" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3806, "length": 28, "value": "29" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 3922, "length": 18, "value": "30" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4036, "length": 15, "value": "31" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4161, "length": 20, "value": "32" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4313, "length": 18, "value": "33" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4404, "length": 25, "value": "34" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4492, "length": 32, "value": "35" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4596, "length": 17, "value": "36" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4673, "length": 13, "value": "37" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4740, "length": 13, "value": "38" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4809, "length": 15, "value": "39" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 4891, "length": 11, "value": "40" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 5013, "length": 24, "value": "41" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 5116, "length": 14, "value": "42" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 5209, "length": 17, "value": "43" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "IntegerLiteral", "offset": 5287, "length": 19, "value": "44" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "StringLiteral", "offset": 8964, "length": 34, "value": "\"SCPAppleBuiltInReaderErrorDomain\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "StringLiteral", "offset": 9135, "length": 43, "value": "\"SCPAppleBuiltInReaderErrorUserInfoNameKey\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "StringLiteral", "offset": 9328, "length": 49, "value": "\"SCPAppleBuiltInReaderErrorUserInfoReaderMessage\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/NSError+SCPAppleBuiltInReader.swift", "kind": "StringLiteral", "offset": 9545, "length": 57, "value": "\"SCPAppleBuiltInReaderErrorUserInfoDeviceBannedUntilDate\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 717, "length": 1, "value": "0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 815, "length": 11, "value": "1" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 888, "length": 12, "value": "2" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 971, "length": 10, "value": "3" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 1043, "length": 9, "value": "4" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 1144, "length": 5, "value": "5" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 1198, "length": 12, "value": "6" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 1265, "length": 16, "value": "7" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 717, "length": 1, "value": "0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 815, "length": 11, "value": "1" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 888, "length": 12, "value": "2" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 971, "length": 10, "value": "3" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 1043, "length": 9, "value": "4" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 1144, "length": 5, "value": "5" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 1198, "length": 12, "value": "6" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionEvent.swift", "kind": "IntegerLiteral", "offset": 1265, "length": 16, "value": "7" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderStub.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderStub.swift", "kind": "StringLiteral", "offset": 824, "length": 18, "value": "\"StripeTerminal.AppleBuiltInReader\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 2332, "length": 4, "value": "30.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "BooleanLiteral", "offset": 5724, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 5870, "length": 4, "value": "20.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "BooleanLiteral", "offset": 6190, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "StringLiteral", "offset": 6322, "length": 25, "value": "\"Tap to Simulate Payment\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 6468, "length": 4, "value": "24.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 6539, "length": 4, "value": "0.95" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 6552, "length": 3, "value": "1.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 6610, "length": 4, "value": "20.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 6622, "length": 4, "value": "20.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 6636, "length": 4, "value": "20.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 6649, "length": 4, "value": "20.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 6691, "length": 3, "value": "4.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "BooleanLiteral", "offset": 6726, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "BooleanLiteral", "offset": 7017, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "BooleanLiteral", "offset": 7373, "length": 5, "value": "false" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "StringLiteral", "offset": 7503, "length": 10, "value": "\"✕\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 7634, "length": 4, "value": "32.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 7705, "length": 3, "value": "0.9" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 7717, "length": 3, "value": "1.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 7777, "length": 4, "value": "48.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "BooleanLiteral", "offset": 7794, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 7855, "length": 4, "value": "48.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "BooleanLiteral", "offset": 7872, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "FloatLiteral", "offset": 7913, "length": 4, "value": "24.0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "BooleanLiteral", "offset": 7949, "length": 4, "value": "true" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderMockViewController.swift", "kind": "StringLiteral", "offset": 2031, "length": 36, "value": "\"StripeTerminal.AppleBuiltInReaderMockViewController\"" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", "kind": "IntegerLiteral", "offset": 466, "length": 1, "value": "0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", "kind": "IntegerLiteral", "offset": 514, "length": 8, "value": "1" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", "kind": "IntegerLiteral", "offset": 569, "length": 6, "value": "2" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", "kind": "IntegerLiteral", "offset": 620, "length": 12, "value": "3" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", "kind": "IntegerLiteral", "offset": 466, "length": 1, "value": "0" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", "kind": "IntegerLiteral", "offset": 514, "length": 8, "value": "1" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", "kind": "IntegerLiteral", "offset": 569, "length": 6, "value": "2" }, { - "filePath": "\/Users\/bric\/stripe\/terminal\/historic\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", + "filePath": "\/Users\/mindy\/stripe\/stripe-terminal-ios\/StripeTerminal\/SCPAppleBuiltInReaderTransactionType.swift", "kind": "IntegerLiteral", "offset": 620, "length": 12, diff --git a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/StripeTerminal b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/StripeTerminal index 34a61a1d..b092c773 100755 Binary files a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/StripeTerminal and b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/StripeTerminal differ diff --git a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/_CodeSignature/CodeResources b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/_CodeSignature/CodeResources index 6d642ce1..6d18359a 100644 --- a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/_CodeSignature/CodeResources +++ b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/StripeTerminal.framework/_CodeSignature/CodeResources @@ -26,7 +26,7 @@ Headers/SCPBluetoothReaderDelegate.h - Jk6jHVsYiSLZaMDluaR1UXuNNv8= + 2FpPlZwOnnrnTvwAnd1qTZMfvTU= Headers/SCPCancelable.h @@ -106,12 +106,16 @@ Headers/SCPErrors.h - 1YxYfwKankBuTjVnp5dF394sth0= + jlmlZk8yhypRBhhMCsfE2VBSXFQ= Headers/SCPInternetConnectionConfiguration.h yK4WFSO/ZsjZBxTWR/sXIRwdqDQ= + Headers/SCPInternetReaderDelegate.h + + TDZUtQKm/Nrr6QipDFHyag3to4I= + Headers/SCPJSONDecodable.h KIT6gulmrstUQgK5h54NHVX9R5k= @@ -126,7 +130,7 @@ Headers/SCPLocalMobileReaderDelegate.h - HXsve6GUQXUTwqCiaIUQjrTdzvc= + Wv6uo7IxOIlaGUDgspBr5mqx4eo= Headers/SCPLocation.h @@ -158,7 +162,7 @@ Headers/SCPPaymentIntent.h - aWGfB9A54NZHgO+csKP31KW2sHM= + FNrR0ywUkmHvgdZ5XALUgiM36sg= Headers/SCPPaymentIntentParameters.h @@ -200,6 +204,10 @@ TgWDvX403XvzA1zPimO4ABfR4bc= + Headers/SCPReaderDelegate.h + + 5EhkIML1vOMX06FL9+e1B8Fn7JQ= + Headers/SCPReaderDisplayMessage.h eDVPVriWJcByqP8muj8P9gPkZj0= @@ -222,7 +230,7 @@ Headers/SCPReceiptDetails.h - FyyoqbeJCEEDHmyVyvoozIa+6HM= + EcM2yscVplLHsRzAvGb5WBlmvVM= Headers/SCPReconnectionDelegate.h @@ -266,15 +274,19 @@ Headers/SCPSimulatedCardType.h - EpfnEssfy89It7ou227GZMZg88w= + OmxSNiVc0+7sn7MqX/WMrO5kjNw= Headers/SCPSimulatorConfiguration.h - aNvPc4o26JjdLbv9YMeuqhvXMdk= + 14iz+ct3fPbktp7cJ1Tp0ksFL+M= + + Headers/SCPTerminal+SimultaneousReaderConnect.h + + AgONEDOU/EVer86FSi9IoiDuCvE= Headers/SCPTerminal.h - 4K6BR9Y9C6/Tum7OenI3IlRp6WY= + OaiBfJjhRzen5S6aTYB8Hq3UFTE= Headers/SCPTerminalDelegate.h @@ -294,15 +306,15 @@ Headers/StripeTerminal.h - 4+5ysvl4DxKI1ts0KmslHpH4vw4= + FfrCI/hCJPh3GRf8f7htoNc/vZA= Info.plist - Jv/2/RmuoNW7ZYxWt8ZAfVpRynw= + HXsAjapN9d+5c5bFrp/VC3zAJwM= Modules/StripeTerminal.swiftmodule/arm64-apple-ios-simulator.abi.json - 9IzY2gTAbr6EbojDLijdXO+nqH4= + hm0kZaf4AcPl+7phZlVAKC0HW5w= Modules/StripeTerminal.swiftmodule/arm64-apple-ios-simulator.private.swiftinterface @@ -322,7 +334,7 @@ Modules/StripeTerminal.swiftmodule/x86_64-apple-ios-simulator.abi.json - 9IzY2gTAbr6EbojDLijdXO+nqH4= + hm0kZaf4AcPl+7phZlVAKC0HW5w= Modules/StripeTerminal.swiftmodule/x86_64-apple-ios-simulator.private.swiftinterface @@ -386,7 +398,7 @@ hash2 - kfWzS/lvmEzqc3iTkD8rRt9KfWWzHhg7aFAZ039OOOc= + CbXY4eMKjmw/DdBCdgW/5KIcZ9NFRi0EuplF4S7zdLI= Headers/SCPCancelable.h @@ -526,7 +538,7 @@ hash2 - RR7tku6+DwRYhw2dJtmFABMU4aojk7Us3A/msZyIKVQ= + x8X8SeYsgJxAaJClj1KXDJLYIPgkhrnYge3edccQKKU= Headers/SCPInternetConnectionConfiguration.h @@ -536,6 +548,13 @@ 5p6U6JxAIuH3R7T/RqNDk2Ts2Kdsnf16B2xu1yIj6HQ= + Headers/SCPInternetReaderDelegate.h + + hash2 + + yQZu2T1x1uRoWskHk+famvrU4r9TP+dZeBbltkSOgK4= + + Headers/SCPJSONDecodable.h hash2 @@ -561,7 +580,7 @@ hash2 - t+qjirmr7lFtaJa+DLrR2/KLC0C2Bhrlez1WPOPh+Mo= + kCCXoHfQ4Onq2wVS02o3E9ylyvW/N82ODlMzKX2S1Nw= Headers/SCPLocation.h @@ -617,7 +636,7 @@ hash2 - bCp8Pr7mEHb+AZitiz/T6HwUR04Br5w415JGUNlVi4w= + lIvOccgoAdLic7zZxWT88y+Obhuf3jZ4+7f4GZDDnZw= Headers/SCPPaymentIntentParameters.h @@ -690,6 +709,13 @@ 7Pv5HTCIp7P6L+xzpQUFXrzxBigMQMI3XUwXUk0J260= + Headers/SCPReaderDelegate.h + + hash2 + + bTAh96ZQyYtNaTNS42xeRtkheWltUfaeLwBTjPHlqOI= + + Headers/SCPReaderDisplayMessage.h hash2 @@ -729,7 +755,7 @@ hash2 - 9SpdpSsT/nq5EkrdiqMnKAm3oq2+txtZkXgqYc6Gd4k= + umVsIe1ixjOd2hvoUNDbho+PP0EWDZrsPmGKNGJjKzc= Headers/SCPReconnectionDelegate.h @@ -806,21 +832,28 @@ hash2 - l40TjOcYA+ZMZUhwBLzMSSe09MMg/tD5DdjAjPb2OmI= + MhQJoDlmSaM1pu5h1TYY//2SQVUT4yA7WzZZU4FRhh0= Headers/SCPSimulatorConfiguration.h hash2 - W3XVr/8TY1idy4ShSXInpB3myePUwYkNSoDxXmX8hYc= + dQXH6QJdqEpKvnNyslcmSak4iLB0DHerpFklNj4qv/o= + + + Headers/SCPTerminal+SimultaneousReaderConnect.h + + hash2 + + fOVRX+LEIcEq4emAVEBYM5UkdBqujRIFGrspVFO2+VM= Headers/SCPTerminal.h hash2 - sxE9kHouIKOAN87lWARxef4SmzeCT9IzWjbiVXRvP0w= + p1cZrL87ocD0hzJJ9PFDi5JgXvtZf07zZbxW1JyiYRY= Headers/SCPTerminalDelegate.h @@ -855,14 +888,14 @@ hash2 - vCi3icjdj1enycpAQCgj5cE5n1grmeAoZtw79UZn6YI= + 0dUV3XjFif00R2ohyyxtYmDDDILL51OzSQ70iU0yhYw= Modules/StripeTerminal.swiftmodule/arm64-apple-ios-simulator.abi.json hash2 - krmtRv/CbRemcJqGYXD4h9LAOGoxvBPR5BkNsV+aepI= + lzDp4RcBR9YRE8/zsA5XRk76QXdnQXwEhSk5l/Bq8dU= Modules/StripeTerminal.swiftmodule/arm64-apple-ios-simulator.private.swiftinterface @@ -897,7 +930,7 @@ hash2 - krmtRv/CbRemcJqGYXD4h9LAOGoxvBPR5BkNsV+aepI= + lzDp4RcBR9YRE8/zsA5XRk76QXdnQXwEhSk5l/Bq8dU= Modules/StripeTerminal.swiftmodule/x86_64-apple-ios-simulator.private.swiftinterface diff --git a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/dSYMs/StripeTerminal.framework.dSYM/Contents/Info.plist b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/dSYMs/StripeTerminal.framework.dSYM/Contents/Info.plist index 9d15e8f6..0b7e1e89 100644 --- a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/dSYMs/StripeTerminal.framework.dSYM/Contents/Info.plist +++ b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/dSYMs/StripeTerminal.framework.dSYM/Contents/Info.plist @@ -13,8 +13,8 @@ CFBundleSignature ???? CFBundleShortVersionString - 2.18.1 + 2.19.0 CFBundleVersion - 2.18.1 + 2.19.0 diff --git a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/dSYMs/StripeTerminal.framework.dSYM/Contents/Resources/DWARF/StripeTerminal b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/dSYMs/StripeTerminal.framework.dSYM/Contents/Resources/DWARF/StripeTerminal index 2d39b006..e8cf48c8 100644 Binary files a/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/dSYMs/StripeTerminal.framework.dSYM/Contents/Resources/DWARF/StripeTerminal and b/Example/StripeTerminal.xcframework/ios-arm64_x86_64-simulator/dSYMs/StripeTerminal.framework.dSYM/Contents/Resources/DWARF/StripeTerminal differ diff --git a/Package.swift b/Package.swift index 5a25ac6b..649c377e 100644 --- a/Package.swift +++ b/Package.swift @@ -15,8 +15,8 @@ let package = Package( targets: [ .binaryTarget( name: "StripeTerminal", - url: "https://github.com/stripe/stripe-terminal-ios/releases/download/v2.18.1/StripeTerminal.xcframework.zip", - checksum: "26f833e686d593f72094f9b31d96d0194094549a76b5357575ea77da6d83775e" + url: "https://github.com/stripe/stripe-terminal-ios/releases/download/v2.19.0/StripeTerminal.xcframework.zip", + checksum: "01962eaae980c5b73db81a69f16967b59a275b3c2b6260111543f6ea8e0f82f3" ) ] ) diff --git a/PublicHeaders/SCPBluetoothReaderDelegate.h b/PublicHeaders/SCPBluetoothReaderDelegate.h index c5ee7359..7f9707d6 100644 --- a/PublicHeaders/SCPBluetoothReaderDelegate.h +++ b/PublicHeaders/SCPBluetoothReaderDelegate.h @@ -16,6 +16,7 @@ #import #import + @class SCPReader; @class SCPReaderSoftwareUpdate; @class SCPCancelable; @@ -32,7 +33,8 @@ NS_ASSUME_NONNULL_BEGIN The provided delegate must be retained by your application until the reader disconnects. */ NS_SWIFT_NAME(BluetoothReaderDelegate) -@protocol SCPBluetoothReaderDelegate +@protocol SCPBluetoothReaderDelegate + /** The SDK is reporting that an update is available for the reader. diff --git a/PublicHeaders/SCPErrors.h b/PublicHeaders/SCPErrors.h index 1d4caa6e..8a8936df 100644 --- a/PublicHeaders/SCPErrors.h +++ b/PublicHeaders/SCPErrors.h @@ -165,6 +165,7 @@ typedef NS_ERROR_ENUM(SCPErrorDomain, SCPError){ */ SCPErrorInvalidLocationIdParameter = 1960, + /* USER ERRORS */ diff --git a/PublicHeaders/SCPLocalMobileReaderDelegate.h b/PublicHeaders/SCPLocalMobileReaderDelegate.h index 8f90cc19..24f86000 100644 --- a/PublicHeaders/SCPLocalMobileReaderDelegate.h +++ b/PublicHeaders/SCPLocalMobileReaderDelegate.h @@ -12,6 +12,7 @@ #import #import + @class SCPReader; @class SCPReaderSoftwareUpdate; @class SCPCancelable; @@ -27,7 +28,8 @@ NS_ASSUME_NONNULL_BEGIN The provided delegate must be retained by your application until the reader disconnects. */ NS_SWIFT_NAME(LocalMobileReaderDelegate) -@protocol SCPLocalMobileReaderDelegate +@protocol SCPLocalMobileReaderDelegate + /** The reader has started installing a software update. diff --git a/PublicHeaders/SCPPaymentIntent.h b/PublicHeaders/SCPPaymentIntent.h index 479589d2..fc1a8b67 100644 --- a/PublicHeaders/SCPPaymentIntent.h +++ b/PublicHeaders/SCPPaymentIntent.h @@ -11,6 +11,7 @@ #import #import +#import NS_ASSUME_NONNULL_BEGIN @@ -86,6 +87,11 @@ NS_SWIFT_NAME(PaymentIntent) */ @property (nonatomic, readonly) NSUInteger amount; +/** + Controls when the funds will be captured from the customer’s account. + */ +@property (nonatomic, readonly) SCPCaptureMethod captureMethod; + /** The currency of the payment. */ diff --git a/PublicHeaders/SCPReceiptDetails.h b/PublicHeaders/SCPReceiptDetails.h index 7fa12fff..d4fda53c 100644 --- a/PublicHeaders/SCPReceiptDetails.h +++ b/PublicHeaders/SCPReceiptDetails.h @@ -38,6 +38,11 @@ NS_SWIFT_NAME(ReceiptDetails) */ @property (nonatomic, readonly) NSString *dedicatedFileName; +/** + Identifier for this transaction + */ +@property (nonatomic, nullable, readonly) NSString *authorizationCode; + /** Authorization Response Code */ diff --git a/PublicHeaders/SCPSimulatedCardType.h b/PublicHeaders/SCPSimulatedCardType.h index d9a823c6..3cbc557a 100644 --- a/PublicHeaders/SCPSimulatedCardType.h +++ b/PublicHeaders/SCPSimulatedCardType.h @@ -64,6 +64,12 @@ typedef NS_ENUM(NSUInteger, SCPSimulatedCardType) { /// Eftpos Australia SCPSimulatedCardTypeEftposAuDebit, + /// Eftpos Australia/Visa + SCPSimulatedCardTypeEftposAuVisaDebit, + + /// Eftpos Australia/Mastercard + SCPSimulatedCardTypeEftposAuDebitMastercard, + /// Charge is declined with a card_declined code. SCPSimulatedCardTypeChargeDeclined, diff --git a/PublicHeaders/SCPSimulatorConfiguration.h b/PublicHeaders/SCPSimulatorConfiguration.h index 64b4f742..c05c5e66 100644 --- a/PublicHeaders/SCPSimulatorConfiguration.h +++ b/PublicHeaders/SCPSimulatorConfiguration.h @@ -46,6 +46,12 @@ NS_SWIFT_NAME(SimulatorConfiguration) */ @property (nonatomic, readwrite) SCPSimulatedCard *simulatedCard; +/** + Set this to simulate a Terminal configuration object with this fixed tip + amount for all currencies. + */ +@property (nonatomic, readwrite, nullable) NSNumber *simulatedTipAmount; + /** You cannot directly instantiate this class. Set exposed properties via `SCPTerminal.shared.simulatorConfiguration` diff --git a/PublicHeaders/SCPTerminal.h b/PublicHeaders/SCPTerminal.h index 61abdda8..53a0437f 100644 --- a/PublicHeaders/SCPTerminal.h +++ b/PublicHeaders/SCPTerminal.h @@ -21,6 +21,7 @@ #import #import #import +#import #import #import #import @@ -31,7 +32,7 @@ NS_ASSUME_NONNULL_BEGIN /** The current version of this library. */ -static NSString *const SCPSDKVersion = @"2.18.1"; +static NSString *const SCPSDKVersion = @"2.19.0"; @class SCPCancelable, SCPBluetoothConnectionConfiguration, @@ -605,8 +606,8 @@ before connecting which specifies the location to which this @see https://stripe.com/docs/api/setup_intents/create - @param setupIntentParams The parameters that control the creation of the SetupIntent - @param completion The compltion block called when the command completes + @param setupIntentParams The parameters that control the creation of the SetupIntent. + @param completion The completion block called when the command completes. */ - (void)createSetupIntent:(SCPSetupIntentParameters *)setupIntentParams completion:(SCPSetupIntentCompletionBlock)completion NS_SWIFT_NAME(createSetupIntent(_:completion:)); @@ -617,7 +618,7 @@ before connecting which specifies the location to which this If you've created a SetupIntent on your backend, you must retrieve it in the Stripe Terminal SDK before calling `collectSetupIntentPaymentMethod`. - @param clientSecret The client secret of the SetupIntent to be retrieved + @param clientSecret The client secret of the SetupIntent to be retrieved. @param completion The completion block called when the command completes. */ - (void)retrieveSetupIntent:(NSString *)clientSecret @@ -855,6 +856,11 @@ before connecting which specifies the location to which this */ + (NSString *)stringFromPaymentIntentStatus:(SCPPaymentIntentStatus)paymentIntentStatus NS_SWIFT_NAME(stringFromPaymentIntentStatus(_:)); +/** + Returns an unlocalized string for the given capture method. + */ ++ (NSString *)stringFromCaptureMethod:(SCPCaptureMethod)captureMethod NS_SWIFT_NAME(stringFromCaptureMethod(_:)); + /** Use `initWithConfiguration:tokenProvider:delegate:` diff --git a/PublicHeaders/StripeTerminal.h b/PublicHeaders/StripeTerminal.h index 3b6c2ebf..15edb7b7 100644 --- a/PublicHeaders/StripeTerminal.h +++ b/PublicHeaders/StripeTerminal.h @@ -77,3 +77,4 @@ #import #import + diff --git a/docs/2.19.0/Blocks.html b/docs/2.19.0/Blocks.html new file mode 100644 index 00000000..1ae50c86 --- /dev/null +++ b/docs/2.19.0/Blocks.html @@ -0,0 +1,1187 @@ + + + + Blocks Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + Blocks Reference +

+ +
+ +
+ +
+
+

Blocks

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    A block called with a connection token or an error from your backend.

    +
    +

    See

    +

    SCPConnectionTokenProvider

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^SCPConnectionTokenCompletionBlock)(NSString *_Nullable,
+                                                  NSError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias ConnectionTokenCompletionBlock = (String?, Error?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + token + + +
    +

    The connection token from your backend server.

    +
    +
    + + error + + +
    +

    An error if one occurred, or nil.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A block called with an optional error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^SCPErrorCompletionBlock)(NSError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias ErrorCompletionBlock = (Error?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + error + + +
    +

    The error, or nil if no error occured.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPLogListenerBlock + +
    +
    +
    +
    +
    +
    +

    A block called with a logline from the SDK.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^SCPLogListenerBlock)(NSString *_Nonnull)
    + +
    +
    +

    Swift

    + 
    typealias LogListenerBlock = (String) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + logline + + +
    +

    An internal logline from the SDK.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A block called with a PaymentIntent or an error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^SCPPaymentIntentCompletionBlock)(SCPPaymentIntent *_Nullable,
+                                                NSError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias PaymentIntentCompletionBlock = (SCPPaymentIntent?, Error?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + intent + + +
    +

    The PaymentIntent, or nil.

    +
    +
    + + error + + +
    +

    An error if one occurred, or nil.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A block called with a PaymentMethod.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^SCPPaymentMethodCompletionBlock)(SCPPaymentMethod *_Nullable,
+                                                NSError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias PaymentMethodCompletionBlock = (SCPPaymentMethod?, Error?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + paymentMethod + + +
    +

    A PaymentMethod object, or nil if an error occurred.

    +
    +
    + + error + + +
    +

    An error if one occurred, or nil.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A block called with a PaymentIntent or a ProcessPaymentError

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^SCPProcessPaymentCompletionBlock)(
+    SCPPaymentIntent *_Nullable, SCPProcessPaymentError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias ProcessPaymentCompletionBlock = (SCPPaymentIntent?, SCPProcessPaymentError?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + intent + + +
    +

    The PaymentIntent, or nil.

    +
    +
    + + error + + +
    +

    An error if one occurred, or nil.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A block called with a reader object or an error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^SCPReaderCompletionBlock)(SCPReader *_Nullable,
+                                         NSError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias ReaderCompletionBlock = (SCPReader?, Error?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + reader + + +
    +

    A reader object, or nil.

    +
    +
    + + error + + +
    +

    An error if one occurred, or nil.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A block called with a Refund or a ProcessRefundError.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^SCPProcessRefundCompletionBlock)(
+    SCPRefund *_Nullable, SCPProcessRefundError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias ProcessRefundCompletionBlock = (SCPRefund?, SCPProcessRefundError?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + refund + + +
    +

    The Refund, or nil.

    +
    +
    + + error + + +
    +

    An error if one occurred, or nil.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A block called with a SetupIntent or a ConfirmSetupIntentError.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^SCPConfirmSetupIntentCompletionBlock)(
+    SCPSetupIntent *_Nullable, SCPConfirmSetupIntentError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias ConfirmSetupIntentCompletionBlock = (SCPSetupIntent?, SCPConfirmSetupIntentError?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + intent + + +
    +

    The SetupIntent, or nil.

    +
    +
    + + error + + +
    +

    An error if one occurred, or nil.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A block called with a list of Locations or an error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^SCPLocationsCompletionBlock)(NSArray<SCPLocation *> *_Nullable,
+                                            BOOL, NSError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias LocationsCompletionBlock = ([SCPLocation]?, Bool, Error?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + locations + + +
    +

    A list of Locations, or nil.

    +
    +
    + + hasMore + + +
    +

    Indicates whether there are more locations for the account; use the pagination parameters in SCPListLocationsParameters to fetch more locations

    +
    +
    + + error + + +
    +

    An error if one occurred, or nil.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A block called with a Refund or an error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^SCPRefundCompletionBlock)(SCPRefund *_Nullable,
+                                         NSError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias RefundCompletionBlock = (SCPRefund?, Error?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + refund + + +
    +

    The Refund, or nil.

    +
    +
    + + error + + +
    +

    An error if one occurred, or nil.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A block called with a SetupIntent or an error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^SCPSetupIntentCompletionBlock)(SCPSetupIntent *_Nullable,
+                                              NSError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias SetupIntentCompletionBlock = (SCPSetupIntent?, Error?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + intent + + +
    +

    The SetupIntent, or nil.

    +
    +
    + + error + + +
    +

    An error if one occurred, or nil.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Card-Present Refunds.html b/docs/2.19.0/Card-Present Refunds.html new file mode 100644 index 00000000..8dfab0e8 --- /dev/null +++ b/docs/2.19.0/Card-Present Refunds.html @@ -0,0 +1,600 @@ + + + + Card-Present Refunds Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + Card-Present Refunds Reference +

+ +
+ +
+ +
+
+

Card-Present Refunds

+ +
+
+ +
+
+
+
    +
  • +
    + + + + SCPRefund + +
    +
    +
    +
    +
    +
    +

    An object representing a Stripe refund.

    + +

    Some payment methods, like Interac Debit payments, require that in-person payments +also be refunded while the cardholder is present. The cardholder must present +the Interac card to the card reader; these payments cannot be refunded via the +dashboard or the API.

    +
    +

    See

    + https://stripe.com/docs/terminal/canada#interac-refunds + +
    + +

    The collectRefundPaymentMethod:completion and processRefund SDK methods +allow you to build an in-person refund interface into your app.

    + +

    The refund SDK methods and the SCPRefund class are only available for +payment methods that require in-person refunds, such as Interac Debit. For +all other refunds, use the Stripe Dashboard or the Stripe API.

    +
    +

    See

    + https://stripe.com/docs/api#refunds + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPRefund : NSObject <SCPJSONDecodable>
    + +
    +
    +

    Swift

    + 
    class Refund : NSObject, JSONDecodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPRefundParameters + +
    +
    +
    +
    +
    +
    +

    Parameters for creating an SCPRefund.

    +
    +

    See

    + https://stripe.com/docs/api/refunds/create + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPRefundParameters : NSObject
    + +
    +
    +

    Swift

    + 
    class RefundParameters : NSObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPProcessRefundError + +
    +
    +
    +
    +
    +
    +

    An error from -[SCPTerminal processRefund:completion:].

    +
    +

    See

    + https://stripe.com/docs/terminal/canada#interac-refunds + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPProcessRefundError : NSError
    + +
    +
    +

    Swift

    + 
    class ProcessRefundError : NSError
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPRefundStatus + +
    +
    +
    +
    +
    +
    +

    The possible statuses for a refund.

    +
    +

    See

    + https://stripe.com/docs/api/refunds/object#refund_object-status + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPRefundStatus : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum RefundStatus : UInt, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPAddress.html b/docs/2.19.0/Classes/SCPAddress.html new file mode 100644 index 00000000..1cc43df7 --- /dev/null +++ b/docs/2.19.0/Classes/SCPAddress.html @@ -0,0 +1,709 @@ + + + + SCPAddress Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPAddress Class Reference +

+ +
+ +
+ +
+
+

SCPAddress

+
+
+

Objective-C

+ 

+@interface SCPAddress : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class Address : NSObject, JSONDecodable
+ +
+
+

Holds address data associated with a given SCPLocation.

+ +

You cannot create SCPAddress objects from within the SDK. Instead, they will +be returned as an address property on an SCPLocation object retrieved +by the SDK.

+
+

See

+ https://stripe.com/docs/api/terminal/locations/object#terminal_location_object-address + +
+

See

+ SCPLocation + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + city + +
    +
    +
    +
    +
    +
    +

    The city name

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSString *city;
    + +
    +
    +

    Swift

    + 
    var city: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + country + +
    +
    +
    +
    +
    +
    +

    The country code

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSString *country;
    + +
    +
    +

    Swift

    + 
    var country: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + line1 + +
    +
    +
    +
    +
    +
    +

    The first line of the address

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSString *line1;
    + +
    +
    +

    Swift

    + 
    var line1: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + line2 + +
    +
    +
    +
    +
    +
    +

    The second line of the address

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSString *line2;
    + +
    +
    +

    Swift

    + 
    var line2: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + postalCode + +
    +
    +
    +
    +
    +
    +

    The postal code of the address

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSString *postalCode;
    + +
    +
    +

    Swift

    + 
    var postalCode: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + state + +
    +
    +
    +
    +
    +
    +

    The state of the address

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSString *state;
    + +
    +
    +

    Swift

    + 
    var state: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPAmountDetails.html b/docs/2.19.0/Classes/SCPAmountDetails.html new file mode 100644 index 00000000..01e45108 --- /dev/null +++ b/docs/2.19.0/Classes/SCPAmountDetails.html @@ -0,0 +1,535 @@ + + + + SCPAmountDetails Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPAmountDetails Class Reference +

+ +
+ +
+ +
+
+

SCPAmountDetails

+
+
+

Objective-C

+ 
@interface SCPAmountDetails : NSObject <SCPJSONDecodable, NSCopying>
+ +
+
+

Swift

+ 
class SCPAmountDetails : NSObject, JSONDecodable, NSCopying
+ +
+
+

Contains details about items included in the [PaymentIntent] amount

+ +
+
+ +
+
+
+
    +
  • +
    + + + + tip + +
    +
    +
    +
    +
    +
    +

    Details about the tip

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPTip *tip;
    + +
    +
    +

    Swift

    + 
    var tip: SCPTip? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate SCPAmountDetails.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate SCPAmountDetails.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPBluetoothConnectionConfiguration.html b/docs/2.19.0/Classes/SCPBluetoothConnectionConfiguration.html new file mode 100644 index 00000000..8b1d745d --- /dev/null +++ b/docs/2.19.0/Classes/SCPBluetoothConnectionConfiguration.html @@ -0,0 +1,627 @@ + + + + SCPBluetoothConnectionConfiguration Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPBluetoothConnectionConfiguration Class Reference +

+ +
+ +
+ +
+
+

SCPBluetoothConnectionConfiguration

+
+
+

Objective-C

+ 

+@interface SCPBluetoothConnectionConfiguration : SCPConnectionConfiguration
+ +
+
+

Swift

+ 
class BluetoothConnectionConfiguration : ConnectionConfiguration
+ +
+
+

This class lets you define Bluetooth reader connection options.

+ +

An object of this class should get passed into Terminal.shared.connectBluetoothReader().

+ +
+
+ +
+
+
+
    +
  • +
    + + + + locationId + +
    +
    +
    +
    +
    +
    +

    The ID of the Location which the reader should be registered to during connection.

    + +

    If the provided ID matches the location the reader is already registered to, the +location will not be changed.

    + +

    When connecting to a simulated reader, pass in the reader’s pre-existing mock location. +You can find the mock location ID on the reader object returned to the DiscoveryDelegate, +on the locationId property.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers/fleet-management#bbpos-wisepad3-discovery + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull locationId;
    + +
    +
    +

    Swift

    + 
    var locationId: String { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    When set to true, the Terminal SDK will attempt a Bluetooth auto-reconnection on any unexpected disconnect. +You must also set an autoReconnectionDelegate for your application to respond accordingly to reconnection attempts. +Enabling autoReconnectOnUnexpectedDisconnect without providing an autoReconnectionDelegate will error with SCPErrorReaderConnectionConfigurationInvalid.

    + +

    When set to false, we will immediately surface any disconnection through TerminalDelegate.

    + +

    Defaults to false.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) BOOL autoReconnectOnUnexpectedDisconnect;
    + +
    +
    +

    Swift

    + 
    var autoReconnectOnUnexpectedDisconnect: Bool { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Contains callback methods for Bluetooth auto-reconnection.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, weak, readonly, nullable) id<SCPReconnectionDelegate> autoReconnectionDelegate;
    + +
    +
    +

    Swift

    + 
    weak var autoReconnectionDelegate: ReconnectionDelegate? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -initWithLocationId: + +
    +
    +
    +
    +
    +
    +

    Initialize your connect options with a location ID.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithLocationId:(nonnull NSString *)locationId;
    + +
    +
    +

    Swift

    + 
    init(locationId: String)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize your connect options with a location ID and an expected behavior for unexpected disconnects.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithLocationId:(nonnull NSString *)locationId
+       autoReconnectOnUnexpectedDisconnect:
+           (BOOL)autoReconnectOnUnexpectedDisconnect
+                  autoReconnectionDelegate:
+                      (nullable id<SCPReconnectionDelegate>)
+                          autoReconnectionDelegate;
    + +
    +
    +

    Swift

    + 
    init(locationId: String, autoReconnectOnUnexpectedDisconnect: Bool, autoReconnectionDelegate: ReconnectionDelegate?)
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPCancelable.html b/docs/2.19.0/Classes/SCPCancelable.html new file mode 100644 index 00000000..12f88a0f --- /dev/null +++ b/docs/2.19.0/Classes/SCPCancelable.html @@ -0,0 +1,509 @@ + + + + SCPCancelable Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCancelable Class Reference +

+ +
+ +
+ +
+
+

SCPCancelable

+
+
+

Objective-C

+ 

+@interface SCPCancelable : NSObject
+ +
+
+

Swift

+ 
class Cancelable : NSObject
+ +
+
+

An object representing an action that can be canceled.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + completed + +
    +
    +
    +
    +
    +
    +

    Indicates whether the command has completed. After the command has completed, +subsequent calls to cancel will fail.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) BOOL completed;
    + +
    +
    +

    Swift

    + 
    var completed: Bool { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -cancel: + +
    +
    +
    +
    +
    +
    +

    Attempts to cancel the action in progress. If the action could not be canceled, +e.g. it has already completed, the completion block will be called with an +error. Otherwise, the completion block will be called with nil.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)cancel:(nonnull SCPErrorCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func cancel() async throws
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPCardDetails.html b/docs/2.19.0/Classes/SCPCardDetails.html new file mode 100644 index 00000000..03455eea --- /dev/null +++ b/docs/2.19.0/Classes/SCPCardDetails.html @@ -0,0 +1,706 @@ + + + + SCPCardDetails Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCardDetails Class Reference +

+ +
+ +
+ +
+
+

SCPCardDetails

+
+
+

Objective-C

+ 

+@interface SCPCardDetails : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class CardDetails : NSObject, JSONDecodable
+ +
+
+

Contains details about a user’s credit card.

+
+

See

+ https://stripe.com/docs/api/payment_methods/object#payment_method_object-card + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + brand + +
    +
    +
    +
    +
    +
    +

    The issuer of the card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPCardBrand brand;
    + +
    +
    +

    Swift

    + 
    var brand: CardBrand { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + country + +
    +
    +
    +
    +
    +
    +

    Two-letter ISO code representing the country of the card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *country;
    + +
    +
    +

    Swift

    + 
    var country: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + expMonth + +
    +
    +
    +
    +
    +
    +

    Two-digit number representing the card’s expiration month. +0 if the expiration month was missing.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSInteger expMonth;
    + +
    +
    +

    Swift

    + 
    var expMonth: Int { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + expYear + +
    +
    +
    +
    +
    +
    +

    Four-digit number representing the card’s expiration year. +0 if the expiration year was missing.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSInteger expYear;
    + +
    +
    +

    Swift

    + 
    var expYear: Int { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + funding + +
    +
    +
    +
    +
    +
    +

    Card funding type. Ex: credit, debit, etc.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPCardFundingType funding;
    + +
    +
    +

    Swift

    + 
    var funding: CardFundingType { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + last4 + +
    +
    +
    +
    +
    +
    +

    The last four digits of the card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *last4;
    + +
    +
    +

    Swift

    + 
    var last4: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + fingerprint + +
    +
    +
    +
    +
    +
    +

    Uniquely identifies this particular card number. You can use this attribute +to check whether two customers who’ve signed up with you are using the +same card number, for example.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *fingerprint;
    + +
    +
    +

    Swift

    + 
    var fingerprint: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPCardPresentDetails.html b/docs/2.19.0/Classes/SCPCardPresentDetails.html new file mode 100644 index 00000000..1c726500 --- /dev/null +++ b/docs/2.19.0/Classes/SCPCardPresentDetails.html @@ -0,0 +1,977 @@ + + + + SCPCardPresentDetails Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCardPresentDetails Class Reference +

+ +
+ +
+ +
+
+

SCPCardPresentDetails

+
+
+

Objective-C

+ 

+@interface SCPCardPresentDetails : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class CardPresentDetails : NSObject, JSONDecodable
+ +
+
+

An object representing details from a transaction using a card_present +payment method.

+
+

See

+ https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + last4 + +
    +
    +
    +
    +
    +
    +

    The last 4 digits of the card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull last4;
    + +
    +
    +

    Swift

    + 
    var last4: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + expMonth + +
    +
    +
    +
    +
    +
    +

    The card’s expiration month. 1-indexed (i.e. 1 == January)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSInteger expMonth;
    + +
    +
    +

    Swift

    + 
    var expMonth: Int { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + expYear + +
    +
    +
    +
    +
    +
    +

    The card’s expiration year.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSInteger expYear;
    + +
    +
    +

    Swift

    + 
    var expYear: Int { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardholderName + +
    +
    +
    +
    +
    +
    +

    The cardholder name as read from the card, in ISO 7813 format. May include +alphanumeric characters, special characters and first/last name separator (/).

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *cardholderName;
    + +
    +
    +

    Swift

    + 
    var cardholderName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + funding + +
    +
    +
    +
    +
    +
    +

    The card’s funding type.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPCardFundingType funding;
    + +
    +
    +

    Swift

    + 
    var funding: CardFundingType { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + brand + +
    +
    +
    +
    +
    +
    +

    The issuing brand of the card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPCardBrand brand;
    + +
    +
    +

    Swift

    + 
    var brand: CardBrand { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + fingerprint + +
    +
    +
    +
    +
    +
    +

    A string uniquely identifying this card number.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull fingerprint;
    + +
    +
    +

    Swift

    + 
    var fingerprint: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + generatedCard + +
    +
    +
    +
    +
    +
    +

    ID of a card PaymentMethod that may be attached to a Customer for future +transactions. Only present if it was possible to generate a card +PaymentMethod.

    +
    +

    See

    + https://stripe.com/docs/terminal/payments/saving-cards#saving-payment-intent-card + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *generatedCard;
    + +
    +
    +

    Swift

    + 
    var generatedCard: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + receipt + +
    +
    +
    +
    +
    +
    +

    Receipt information for the card present transaction. Only present for EMV +transactions.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPReceiptDetails *receipt;
    + +
    +
    +

    Swift

    + 
    var receipt: SCPReceiptDetails? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + emvAuthData + +
    +
    +
    +
    +
    +
    +

    (Only applicable to EMV payments) The authorization data from the card +issuer.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *emvAuthData;
    + +
    +
    +

    Swift

    + 
    var emvAuthData: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + country + +
    +
    +
    +
    +
    +
    +

    Two-letter ISO code representing the country of the card. You could use this +attribute to get a sense of the international breakdown of cards you’ve collected.

    + +

    Only available for interac_present payments.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSString *country;
    + +
    +
    +

    Swift

    + 
    var country: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + preferredLocales + +
    +
    +
    +
    +
    +
    +

    EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.

    + +

    Only available for interac_present payments.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSArray<NSString *> *preferredLocales;
    + +
    +
    +

    Swift

    + 
    var preferredLocales: [String]? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + networks + +
    +
    +
    +
    +
    +
    +

    Contains information about card networks that can be used to process the payment.

    + +

    Only available after collectPaymentMethod when using updatePaymentIntent on the CollectConfiguration.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) SCPNetworks *networks;
    + +
    +
    +

    Swift

    + 
    @NSCopying var networks: SCPNetworks? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Whether this payment method is eligible for incremental authorizations.

    + +

    Note: This is only known if the PaymentIntent was confirmed.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPIncrementalAuthorizationStatus incrementalAuthorizationStatus;
    + +
    +
    +

    Swift

    + 
    var incrementalAuthorizationStatus: SCPIncrementalAuthorizationStatus { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPCardPresentParameters.html b/docs/2.19.0/Classes/SCPCardPresentParameters.html new file mode 100644 index 00000000..9dead429 --- /dev/null +++ b/docs/2.19.0/Classes/SCPCardPresentParameters.html @@ -0,0 +1,1342 @@ + + + + SCPCardPresentParameters Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCardPresentParameters Class Reference +

+ +
+ +
+ +
+
+

SCPCardPresentParameters

+
+
+

Objective-C

+ 

+@interface SCPCardPresentParameters : NSObject
+ +
+
+

Swift

+ 
class CardPresentParameters : NSObject
+ +
+
+

Parameters that will be applied to the card present PaymentIntent.

+
+

See

+ https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Using the extended authorizations feature, users in eligible categories can capture up to 31 days later, depending on the card brand.

    +
    +

    See

    + https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) BOOL requestExtendedAuthorization;
    + +
    +
    +

    Swift

    + 
    var requestExtendedAuthorization: Bool { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Allows you to increase the authorized amount on a confirmed PaymentIntent before you capture it. This means you can update the amount on a payment if the estimated price changes or goods and services are added. Before capture, each incremental authorization appears on your customer’s credit card statement as an additional pending charge.

    +
    +

    See

    + https://stripe.com/docs/terminal/features/incremental-authorizations + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) BOOL requestIncrementalAuthorizationSupport;
    + +
    +
    +

    Swift

    + 
    var requestIncrementalAuthorizationSupport: Bool { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + captureMethod + +
    +
    +
    +
    +
    +
    +

    SCPCardPresentCaptureMethod as a nullable NSNumber.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, strong, nullable) NSNumber *captureMethod;
    + +
    +
    +

    Swift

    + 
    var captureMethod: NSNumber? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + requestedPriority + +
    +
    +
    +
    +
    +
    +

    The requested routing priority as a nullable NSNumber.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, strong, nullable) NSNumber *requestedPriority;
    + +
    +
    +

    Swift

    + 
    var requestedPriority: NSNumber? { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a CardPresentParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithRequestExtendedAuthorization:
+                            (BOOL)requestExtendedAuthorization
+                      requestIncrementalAuthorizationSupport:
+                          (BOOL)requestIncrementalAuthorizationSupport;
    + +
    +
    +

    Swift

    + 
    init(requestExtendedAuthorization: Bool, requestIncrementalAuthorizationSupport: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + requestExtendedAuthorization + + +
    +

    Uses the extended authorization feature to extend capture elgibility

    +
    +
    + + requestIncrementalAuthorizationSupport + + +
    +

    Uses the incremental authorization feature to allow additional charges before capture

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a CardPresentParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithRequestExtendedAuthorization:
+    (BOOL)requestExtendedAuthorization;
    + +
    +
    +

    Swift

    + 
    init(requestExtendedAuthorization: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + requestExtendedAuthorization + + +
    +

    Uses the extended authorization feature to extend capture elgibility

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a CardPresentParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithRequestIncrementalAuthorizationSupport:
+    (BOOL)requestIncrementalAuthorizationSupport;
    + +
    +
    +

    Swift

    + 
    init(requestIncrementalAuthorizationSupport: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + requestIncrementalAuthorizationSupport + + +
    +

    Uses the incremental authorization feature to allow additional charges before capture

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a CardPresentParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)
+      initWithRequestExtendedAuthorization:(BOOL)requestExtendedAuthorization
+    requestIncrementalAuthorizationSupport:
+        (BOOL)requestIncrementalAuthorizationSupport
+                             captureMethod:
+                                 (SCPCardPresentCaptureMethod)captureMethod;
    + +
    +
    +

    Swift

    + 
    init(requestExtendedAuthorization: Bool, requestIncrementalAuthorizationSupport: Bool, captureMethod: CardPresentCaptureMethod)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + requestExtendedAuthorization + + +
    +

    Uses the extended authorization feature to extend capture elgibility

    +
    +
    + + requestIncrementalAuthorizationSupport + + +
    +

    Uses the incremental authorization feature to allow additional charges before capture

    +
    +
    + + captureMethod + + +
    +

    Card present capture method.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a CardPresentParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)
+    initWithRequestExtendedAuthorization:(BOOL)requestExtendedAuthorization
+                           captureMethod:
+                               (SCPCardPresentCaptureMethod)captureMethod;
    + +
    +
    +

    Swift

    + 
    init(requestExtendedAuthorization: Bool, captureMethod: CardPresentCaptureMethod)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + requestExtendedAuthorization + + +
    +

    Uses the extended authorization feature to extend capture elgibility

    +
    +
    + + captureMethod + + +
    +

    Card present capture method.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a CardPresentParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)
+    initWithRequestIncrementalAuthorizationSupport:
+        (BOOL)requestIncrementalAuthorizationSupport
+                                     captureMethod:(SCPCardPresentCaptureMethod)
+                                                       captureMethod;
    + +
    +
    +

    Swift

    + 
    init(requestIncrementalAuthorizationSupport: Bool, captureMethod: CardPresentCaptureMethod)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + requestIncrementalAuthorizationSupport + + +
    +

    Uses the incremental authorization feature to allow additional charges before capture

    +
    +
    + + captureMethod + + +
    +

    Card present capture method.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a CardPresentParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithCaptureMethod:
+    (SCPCardPresentCaptureMethod)captureMethod;
    + +
    +
    +

    Swift

    + 
    init(captureMethod: CardPresentCaptureMethod)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + captureMethod + + +
    +

    Card present capture method.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a CardPresentParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)
+      initWithRequestExtendedAuthorization:(BOOL)requestExtendedAuthorization
+    requestIncrementalAuthorizationSupport:
+        (BOOL)requestIncrementalAuthorizationSupport
+                             captureMethod:
+                                 (SCPCardPresentCaptureMethod)captureMethod
+                         requestedPriority:
+                             (SCPCardPresentRouting)requestedPriority;
    + +
    +
    +

    Swift

    + 
    init(requestExtendedAuthorization: Bool, requestIncrementalAuthorizationSupport: Bool, captureMethod: CardPresentCaptureMethod, requestedPriority: CardPresentRouting)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + requestExtendedAuthorization + + +
    +

    Uses the extended authorization feature to extend capture elgibility

    +
    +
    + + requestIncrementalAuthorizationSupport + + +
    +

    Uses the incremental authorization feature to allow additional charges before capture

    +
    +
    + + captureMethod + + +
    +

    Card present capture method.

    +
    +
    + + requestedPriority + + +
    +

    Requested card present routing option.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a CardPresentParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)
+      initWithRequestExtendedAuthorization:(BOOL)requestExtendedAuthorization
+    requestIncrementalAuthorizationSupport:
+        (BOOL)requestIncrementalAuthorizationSupport
+                         requestedPriority:
+                             (SCPCardPresentRouting)requestedPriority;
    + +
    +
    +

    Swift

    + 
    init(requestExtendedAuthorization: Bool, requestIncrementalAuthorizationSupport: Bool, requestedPriority: CardPresentRouting)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + requestExtendedAuthorization + + +
    +

    Uses the extended authorization feature to extend capture elgibility

    +
    +
    + + requestIncrementalAuthorizationSupport + + +
    +

    Uses the incremental authorization feature to allow additional charges before capture

    +
    +
    + + requestedPriority + + +
    +

    Requested card present routing option.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a CardPresentParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)
+    initWithCaptureMethod:(SCPCardPresentCaptureMethod)captureMethod
+        requestedPriority:(SCPCardPresentRouting)requestedPriority;
    + +
    +
    +

    Swift

    + 
    init(captureMethod: CardPresentCaptureMethod, requestedPriority: CardPresentRouting)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + captureMethod + + +
    +

    Card present capture method.

    +
    +
    + + requestedPriority + + +
    +

    Requested card present routing option.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a CardPresentParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithRequestedPriority:
+    (SCPCardPresentRouting)requestedPriority;
    + +
    +
    +

    Swift

    + 
    init(requestedPriority: CardPresentRouting)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + requestedPriority + + +
    +

    Requested card present routing option.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use alternative initializer.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPCart.html b/docs/2.19.0/Classes/SCPCart.html new file mode 100644 index 00000000..d75a2035 --- /dev/null +++ b/docs/2.19.0/Classes/SCPCart.html @@ -0,0 +1,730 @@ + + + + SCPCart Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCart Class Reference +

+ +
+ +
+ +
+
+

SCPCart

+
+
+

Objective-C

+ 

+@interface SCPCart : NSObject
+ +
+
+

Swift

+ 
class Cart : NSObject
+ +
+
+

An SCPCart object contains information about what line items are included in +the current transaction. A cart object should be created and then passed into +Terminal.shared.setReaderDisplay(), which will display the cart’s contents +on the reader’s screen.

+ +

The SCPCart only represents exactly what will be shown on the screen, and is +not reflective of what the customer is actually charged. You are +responsible for making sure that tax and total reflect what is in the cart.

+
+

Note

+

Only Internet readers support setReaderDisplay functionality

+ +
+

See

+

https://stripe.com/docs/terminal/checkout/cart-display

+ +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + lineItems + +
    +
    +
    +
    +
    +
    +

    You can add or remove line items from this array individually or reassign the array entirely. + After making your desired changes, call setReaderDisplay to update the cart on the reader’s screen.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, strong) NSMutableArray<SCPCartLineItem *> *_Nonnull lineItems;
    + +
    +
    +

    Swift

    + 
    var lineItems: NSMutableArray { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + tax + +
    +
    +
    +
    +
    +
    +

    The displayed tax amount, provided in the currency’s smallest unit.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) NSInteger tax;
    + +
    +
    +

    Swift

    + 
    var tax: Int { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + total + +
    +
    +
    +
    +
    +
    +

    The cart’s total balance, provided in the currency’s smallest unit.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) NSInteger total;
    + +
    +
    +

    Swift

    + 
    var total: Int { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    The currency of the cart.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy) NSString *_Nonnull currency;
    + +
    +
    +

    Swift

    + 
    var currency: String { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes an SCPCart with tax and total, in cents, as well as the currency. +These values are exactly what will be shown on the screen and do not reflect +what the user is actually charged.

    + +

    This initializer will initialize lineItems as an empty array.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithCurrency:(nonnull NSString *)currency
+                                     tax:(NSInteger)tax
+                                   total:(NSInteger)total;
    + +
    +
    +

    Swift

    + 
    init(currency: String, tax: Int, total: Int)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + tax + + +
    +

    The tax in cents

    +
    +
    + + total + + +
    +

    The total in cents

    +
    +
    + + currency + + +
    +

    The currency of the basket (i.e. USD or AUD)

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithTax:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithTax:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPCartLineItem.html b/docs/2.19.0/Classes/SCPCartLineItem.html new file mode 100644 index 00000000..0e13cb38 --- /dev/null +++ b/docs/2.19.0/Classes/SCPCartLineItem.html @@ -0,0 +1,625 @@ + + + + SCPCartLineItem Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCartLineItem Class Reference +

+ +
+ +
+ +
+
+

SCPCartLineItem

+
+
+

Objective-C

+ 

+@interface SCPCartLineItem : NSObject
+ +
+
+

Swift

+ 
class CartLineItem : NSObject
+ +
+
+

Represents a single line item in an SCPCart, displayed on the reader’s screen +during checkout.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + quantity + +
    +
    +
    +
    +
    +
    +

    The quantity of the line item being purchased.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) NSInteger quantity;
    + +
    +
    +

    Swift

    + 
    var quantity: Int { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + displayName + +
    +
    +
    +
    +
    +
    +

    The description or name of the item.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy) NSString *_Nonnull displayName;
    + +
    +
    +

    Swift

    + 
    var displayName: String { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    The price of the item, provided in the cart’s currency’s smallest unit.

    +
    +

    See

    + https://stripe.com/docs/currencies#zero-decimal + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) NSInteger amount;
    + +
    +
    +

    Swift

    + 
    var amount: Int { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The values set here will be shown on the screen as-is. Make sure you’re +correctly calculating and setting the SCPCart’s tax and total – the reader +will not calculate tax or total for you. Similarly, make sure the values +displayed reflect what the customer is actually charged.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithDisplayName:(nonnull NSString *)displayName
+                                   quantity:(NSInteger)quantity
+                                     amount:(NSInteger)amount;
    + +
    +
    +

    Swift

    + 
    init(displayName: String, quantity: Int, amount: Int)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + displayName + + +
    +

    The description or name of the item.

    +
    +
    + + quantity + + +
    +

    The quanitity of the item that should show in the cart.

    +
    +
    + + amount + + +
    +

    The price in the currency’s smallest unit. The line item + will assume the currency of the parent SCPCart.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPCharge.html b/docs/2.19.0/Classes/SCPCharge.html new file mode 100644 index 00000000..97b56c17 --- /dev/null +++ b/docs/2.19.0/Classes/SCPCharge.html @@ -0,0 +1,805 @@ + + + + SCPCharge Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCharge Class Reference +

+ +
+ +
+ +
+
+

SCPCharge

+
+
+

Objective-C

+ 

+@interface SCPCharge : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class Charge : NSObject, JSONDecodable
+ +
+
+

An object representing a Stripe charge.

+
+

See

+ https://stripe.com/docs/api#charges + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    The amount of the charge.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSUInteger amount;
    + +
    +
    +

    Swift

    + 
    var amount: UInt { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    The currency of the charge.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull currency;
    + +
    +
    +

    Swift

    + 
    var currency: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    The status of the charge.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPChargeStatus status;
    + +
    +
    +

    Swift

    + 
    var status: ChargeStatus { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentMethodDetails + +
    +
    +
    +
    +
    +
    +

    The payment method details associated with the charge.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPPaymentMethodDetails *paymentMethodDetails;
    + +
    +
    +

    Swift

    + 
    var paymentMethodDetails: SCPPaymentMethodDetails? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + stripeDescription + +
    +
    +
    +
    +
    +
    +

    A string describing the charge, displayed in the Stripe dashboard and in +email receipts.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *stripeDescription;
    + +
    +
    +

    Swift

    + 
    var stripeDescription: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Metadata associated with the charge.

    +
    +

    See

    + https://stripe.com/docs/api#metadata + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSDictionary<NSString *, NSString *> *_Nonnull metadata;
    + +
    +
    +

    Swift

    + 
    var metadata: [String : String] { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + stripeId + +
    +
    +
    +
    +
    +
    +

    The unique identifier for the charge.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull stripeId;
    + +
    +
    +

    Swift

    + 
    var stripeId: String { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Extra dynamic information about a Charge. This will appear concatenated with the statementDescriptor on +your customer’s credit card’s statement.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *statementDescriptorSuffix;
    + +
    +
    +

    Swift

    + 
    var statementDescriptorSuffix: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The full statement descriptor that is displayed on your customer’s credit card’s statement, after the +static statementDescriptor and dynamic statementDescriptorSuffix portions are combined.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *calculatedStatementDescriptor;
    + +
    +
    +

    Swift

    + 
    var calculatedStatementDescriptor: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPCollectConfiguration.html b/docs/2.19.0/Classes/SCPCollectConfiguration.html new file mode 100644 index 00000000..273cb8f0 --- /dev/null +++ b/docs/2.19.0/Classes/SCPCollectConfiguration.html @@ -0,0 +1,1042 @@ + + + + SCPCollectConfiguration Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCollectConfiguration Class Reference +

+ +
+ +
+ +
+
+

SCPCollectConfiguration

+
+
+

Objective-C

+ 

+@interface SCPCollectConfiguration : NSObject <NSCopying>
+ +
+
+

Swift

+ 
class CollectConfiguration : NSObject, NSCopying
+ +
+
+

The CollectConfiguration contains configuration information relevant to collecting a payment +method.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + skipTipping + +
    +
    +
    +
    +
    +
    +

    Bypass tipping selection if it would have otherwise been shown.

    + +

    Defaults to NO.

    +
    +

    See

    + https://stripe.com/docs/terminal/features/collecting-tips/on-reader + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) BOOL skipTipping;
    + +
    +
    +

    Swift

    + 
    var skipTipping: Bool { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + tippingConfiguration + +
    +
    +
    +
    +
    +
    +

    The tipping configuration for this payment collection.

    +
    +

    See

    + https://stripe.com/docs/terminal/features/collecting-tips/on-reader#tip-eligible + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, strong, nullable) SCPTippingConfiguration *tippingConfiguration;
    + +
    +
    +

    Swift

    + 
    var tippingConfiguration: SCPTippingConfiguration? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + updatePaymentIntent + +
    +
    +
    +
    +
    +
    +

    Whether or not to update the PaymentIntent server side during collectPaymentMethod.

    + +

    Defaults to NO.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) BOOL updatePaymentIntent;
    + +
    +
    +

    Swift

    + 
    var updatePaymentIntent: Bool { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -initWithSkipTipping: + +
    +
    +
    +
    +
    +
    +

    Initialize a CollectConfiguration

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithSkipTipping:(BOOL)skipTipping;
    + +
    +
    +

    Swift

    + 
    convenience init(skipTipping: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + skipTipping + + +
    +

    Bypass tipping selection if it would have otherwise been shown.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize a CollectConfiguration

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithUpdatePaymentIntent:(BOOL)updatePaymentIntent;
    + +
    +
    +

    Swift

    + 
    convenience init(updatePaymentIntent: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + updatePaymentIntent + + +
    +

    Whether or not to update the PaymentIntent server side during collectPaymentMethod.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize a CollectConfiguration.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithTippingConfiguration:
+    (nonnull SCPTippingConfiguration *)tippingConfiguration;
    + +
    +
    +

    Swift

    + 
    convenience init(tippingConfiguration: SCPTippingConfiguration)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + tippingConfiguration + + +
    +

    Tipping configuration for the payment method collection.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize a CollectConfiguration

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithSkipTipping:(BOOL)skipTipping
+                        updatePaymentIntent:(BOOL)updatePaymentIntent;
    + +
    +
    +

    Swift

    + 
    convenience init(skipTipping: Bool, updatePaymentIntent: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + skipTipping + + +
    +

    Bypass tipping selection if it would have otherwise been shown.

    +
    +
    + + updatePaymentIntent + + +
    +

    Whether or not to update the PaymentIntent server side during collectPaymentMethod.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize a CollectConfiguration.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithSkipTipping:(BOOL)skipTipping
+                       tippingConfiguration:(nullable SCPTippingConfiguration *)
+                                                tippingConfiguration;
    + +
    +
    +

    Swift

    + 
    convenience init(skipTipping: Bool, tippingConfiguration: SCPTippingConfiguration?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + skipTipping + + +
    +

    Bypass tipping selection if it would have otherwise been shown.

    +
    +
    + + tippingConfiguration + + +
    +

    Tipping configuration for the payment method collection.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize a CollectConfiguration.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithUpdatePaymentIntent:(BOOL)updatePaymentIntent
+                               tippingConfiguration:
+                                   (nullable SCPTippingConfiguration *)
+                                       tippingConfiguration;
    + +
    +
    +

    Swift

    + 
    convenience init(updatePaymentIntent: Bool, tippingConfiguration: SCPTippingConfiguration?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + updatePaymentIntent + + +
    +

    Whether or not to update the PaymentIntent server side during collectPaymentMethod.

    +
    +
    + + tippingConfiguration + + +
    +

    Tipping configuration for the payment method collection.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize a CollectConfiguration.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithSkipTipping:(BOOL)skipTipping
+                        updatePaymentIntent:(BOOL)updatePaymentIntent
+                       tippingConfiguration:(nullable SCPTippingConfiguration *)
+                                                tippingConfiguration;
    + +
    +
    +

    Swift

    + 
    init(skipTipping: Bool, updatePaymentIntent: Bool, tippingConfiguration: SCPTippingConfiguration?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + skipTipping + + +
    +

    Bypass tipping selection if it would have otherwise been shown.

    +
    +
    + + updatePaymentIntent + + +
    +

    Whether or not to update the PaymentIntent server side during collectPaymentMethod.

    +
    +
    + + tippingConfiguration + + +
    +

    Tipping configuration for the payment method collection.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithSkipTipping:updatePaymentIntent:tippingConfiguration: or helper initializers.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithSkipTipping:updatePaymentIntent:tippingConfiguration: or helper initializers.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPConfirmSetupIntentError.html b/docs/2.19.0/Classes/SCPConfirmSetupIntentError.html new file mode 100644 index 00000000..41bf695c --- /dev/null +++ b/docs/2.19.0/Classes/SCPConfirmSetupIntentError.html @@ -0,0 +1,602 @@ + + + + SCPConfirmSetupIntentError Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPConfirmSetupIntentError Class Reference +

+ +
+ +
+ +
+
+

SCPConfirmSetupIntentError

+
+
+

Objective-C

+ 

+@interface SCPConfirmSetupIntentError : NSError
+ +
+
+

Swift

+ 
class ConfirmSetupIntentError : NSError
+ +
+
+

An error from -[SCPTerminal confirmSetupIntent:completion:]

+ +
+
+ +
+
+
+
    +
  • +
    + + + + setupIntent + +
    +
    +
    +
    +
    +
    +

    The updated SetupIntent after confirmSetupIntent failed.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPSetupIntent *setupIntent;
    + +
    +
    +

    Swift

    + 
    var setupIntent: SCPSetupIntent? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + requestError + +
    +
    +
    +
    +
    +
    +

    If confirmSetupIntent failed because the underlying network request errored, +this property contains additional details about the error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSError *requestError;
    + +
    +
    +

    Swift

    + 
    var requestError: Error? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + declineCode + +
    +
    +
    +
    +
    +
    +

    If confirmSetupIntent failed because the payment method was declined, this +property contains the decline code.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *declineCode;
    + +
    +
    +

    Swift

    + 
    var declineCode: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPDiscoveryConfiguration.html b/docs/2.19.0/Classes/SCPDiscoveryConfiguration.html new file mode 100644 index 00000000..854a42e2 --- /dev/null +++ b/docs/2.19.0/Classes/SCPDiscoveryConfiguration.html @@ -0,0 +1,811 @@ + + + + SCPDiscoveryConfiguration Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPDiscoveryConfiguration Class Reference +

+ +
+ +
+ +
+
+

SCPDiscoveryConfiguration

+
+
+

Objective-C

+ 

+@interface SCPDiscoveryConfiguration : NSObject
+ +
+
+

Swift

+ 
class DiscoveryConfiguration : NSObject
+ +
+
+

Configuration options for discovering readers.

+ +

Objects of this type get passed into the Terminal.shared.discoverReaders() +method to control which devices get discovered, and how.

+
+

See

+ https://stripe.com/docs/terminal/readers/connecting + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Initializes a discovery configuration with the given discovery method. All discoverable readers +for that method will be discovered.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithDiscoveryMethod:
+                            (SCPDiscoveryMethod)discoveryMethod
+                                      simulated:(BOOL)simulated;
    + +
    +
    +

    Swift

    + 
    init(discoveryMethod: DiscoveryMethod, simulated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + discoveryMethod + + +
    +

    The discovery method to use.

    +
    +
    + + simulated + + +
    +

    Whether to use simulated discovery to discover a +device simulator. The SDK comes with the ability to simulate behavior without +using physical hardware. This makes it easy to quickly test your integration +end-to-end, from pairing with a reader to taking payments.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This variant of the initializer lets you specify a Location to filter the +list of discovered readers.

    + +

    This filtering behavior is only available when discovering internet readers. +Starting a discoverReaders call with a bluetooth discovery method will +discover all bluetooth readers that can be found, regardless of the location +to which those readers have been registered.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithDiscoveryMethod:
+                            (SCPDiscoveryMethod)discoveryMethod
+                                     locationId:(nullable NSString *)locationId
+                                      simulated:(BOOL)simulated;
    + +
    +
    +

    Swift

    + 
    init(discoveryMethod: DiscoveryMethod, locationId: String?, simulated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + discoveryMethod + + +
    +

    The discovery method to use.

    +
    +
    + + locationId + + +
    +

    The optional location ID to filter the discovered +list to only readers at the specific location. Currently updating and creating +locations is not supported by this SDK and will need to take place on the +backend. Only available for the Internet discovery method.

    +
    +
    + + simulated + + +
    +

    Whether to use simulated discovery to discover a +device simulator. The SDK comes with the ability to simulate behavior without +using physical hardware. This makes it easy to quickly test your integration +end-to-end, from pairing with a reader to taking payments.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + timeout + +
    +
    +
    +
    +
    +
    +

    The timeout (in seconds) after which discoverReaders: should fail. If the +value is 0 (the default), discoverReaders will never timeout.

    + +

    Note that setting a timeout is not currently supported when using +SCPDiscoveryMethodBluetoothProximity, or any simulated discovery. If you set +a timeout when using these configurations, the timeout will be ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) NSUInteger timeout;
    + +
    +
    +

    Swift

    + 
    var timeout: UInt { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + discoveryMethod + +
    +
    +
    +
    +
    +
    +

    The method by which to discover readers.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPDiscoveryMethod discoveryMethod;
    + +
    +
    +

    Swift

    + 
    var discoveryMethod: DiscoveryMethod { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + simulated + +
    +
    +
    +
    +
    +
    +

    Whether to use simulated discovery to discover a device simulator.

    + +

    The Terminal SDK comes with the ability to simulate behavior without using +physical hardware. This makes it easy to quickly test your integration +end-to-end, from pairing with a reader to taking payments.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) BOOL simulated;
    + +
    +
    +

    Swift

    + 
    var simulated: Bool { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + locationId + +
    +
    +
    +
    +
    +
    +

    A location ID that can be used to filter discovery result so only readers +registered to that location are returned. Filtering discovery by a location is +only applicable to Internet readers; this parameter must be nil when discovering +Bluetooth readers.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSString *locationId;
    + +
    +
    +

    Swift

    + 
    var locationId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithDiscoveryMethod:simulated:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithDiscoveryMethod:simulated:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPInternetConnectionConfiguration.html b/docs/2.19.0/Classes/SCPInternetConnectionConfiguration.html new file mode 100644 index 00000000..7f83eca2 --- /dev/null +++ b/docs/2.19.0/Classes/SCPInternetConnectionConfiguration.html @@ -0,0 +1,631 @@ + + + + SCPInternetConnectionConfiguration Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPInternetConnectionConfiguration Class Reference +

+ +
+ +
+ +
+
+

SCPInternetConnectionConfiguration

+
+
+

Objective-C

+ 

+@interface SCPInternetConnectionConfiguration : SCPConnectionConfiguration
+ +
+
+

Swift

+ 
class InternetConnectionConfiguration : ConnectionConfiguration
+ +
+
+

This class lets you set options that define internet reader behavior throughout a given +reader-to-SDK connection session.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + failIfInUse + +
    +
    +
    +
    +
    +
    +

    When set to true, the connection will automatically error if the reader is already +connected to a device and collecting payment. When set to false, this will allow +you to connect to a reader already connected to another device, and will break +the existing reader-to-SDK connection on the other device when it attempts to +collect payment.

    + +

    If Terminal.connectReader is invoked without a SCPInternetConnectionConfiguration, +then failIfInUse defaults to NO.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers/connecting/verifone-p400#connect-reader-ios + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) BOOL failIfInUse;
    + +
    +
    +

    Swift

    + 
    var failIfInUse: Bool { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + allowCustomerCancel + +
    +
    +
    +
    +
    +
    +

    If set to true, the customer will be able to press the red X button on the +Verifone P400 to cancel a collectPaymentMethod, collectReusableCard, or +collectRefundPaymentMethod command.

    + +

    The property defaults to NO if not set.

    +
    +

    Note

    + This behavior is part of a private beta. Setting this property will have +no effect if you are not part of the allowCustomerCancel beta program. + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) BOOL allowCustomerCancel;
    + +
    +
    +

    Swift

    + 
    var allowCustomerCancel: Bool { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize an InternetConnectionConfiguration object with all possible properties.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithFailIfInUse:(BOOL)failIfInUse
+                        allowCustomerCancel:(BOOL)allowCustomerCancel;
    + +
    +
    +

    Swift

    + 
    init(failIfInUse: Bool, allowCustomerCancel: Bool)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -initWithFailIfInUse: + +
    +
    +
    +
    +
    +
    +

    Initalize an InternetConnectionConfiguration object and set the failIfInUse +property.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithFailIfInUse:(BOOL)failIfInUse;
    + +
    +
    +

    Swift

    + 
    init(failIfInUse: Bool)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize an InternetConnectionConfiguration object and set the +allowCustomerCancel property.

    + +

    This property is in private beta, and will have no effect if you are not part +of the allowCustomerCancel beta program.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithAllowCustomerCancel:(BOOL)allowCustomerCancel;
    + +
    +
    +

    Swift

    + 
    init(allowCustomerCancel: Bool)
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPListLocationsParameters.html b/docs/2.19.0/Classes/SCPListLocationsParameters.html new file mode 100644 index 00000000..334e6957 --- /dev/null +++ b/docs/2.19.0/Classes/SCPListLocationsParameters.html @@ -0,0 +1,648 @@ + + + + SCPListLocationsParameters Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPListLocationsParameters Class Reference +

+ +
+ +
+ +
+
+

SCPListLocationsParameters

+
+
+

Objective-C

+ 

+@interface SCPListLocationsParameters : NSObject
+ +
+
+

Swift

+ 
class ListLocationsParameters : NSObject
+ +
+
+

Parameters to be used when calling Terminal.shared.listLocations() to list +the Location objects associated with an account.

+
+

See

+ https://stripe.com/docs/terminal/readers/connecting + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + limit + +
    +
    +
    +
    +
    +
    +

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    +
    +

    See

    + https://stripe.com/docs/api/terminal/locations/list#list_terminal_locations-limit + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, nullable) NSNumber *limit;
    + +
    +
    +

    Swift

    + 
    var limit: NSNumber? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + endingBefore + +
    +
    +
    +
    +
    +
    +

    A cursor for use in pagination. ending_before is an object ID that defines +your place in the list. For instance, if you make a list request and receive 100 +objects, starting with obj_bar, your subsequent call can include +ending_before=obj_bar in order to fetch the previous page of the list.

    +
    +

    See

    + https://stripe.com/docs/api/terminal/locations/list#list_terminal_locations-ending_before + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *endingBefore;
    + +
    +
    +

    Swift

    + 
    var endingBefore: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + startingAfter + +
    +
    +
    +
    +
    +
    +

    A cursor for use in pagination. starting_after is an object ID that defines +your place in the list. For instance, if you make a list request and receive 100 +objects, ending with obj_foo, your subsequent call can include +starting_after=obj_foo in order to fetch the next page of the list.

    +
    +

    See

    + https://stripe.com/docs/api/terminal/locations/list#list_terminal_locations-starting_after + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *startingAfter;
    + +
    +
    +

    Swift

    + 
    var startingAfter: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes SCPListLocationsParameters with the given parameters.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithLimit:(nullable NSNumber *)limit
+                         endingBefore:(nullable NSString *)endingBefore
+                        startingAfter:(nullable NSString *)startingAfter;
    + +
    +
    +

    Swift

    + 
    init(limit: NSNumber?, endingBefore: String?, startingAfter: String?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + limit + + +
    +

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    +
    +
    + + endingBefore + + +
    +

    A cursor for use in pagination. ending_before is an object ID that defines +your place in the list. For instance, if you make a list request and receive 100 +objects, starting with obj_bar, your subsequent call can include +ending_before=obj_bar in order to fetch the previous page of the list.

    +
    +
    + + startingAfter + + +
    +

    A cursor for use in pagination. starting_after is an object ID that defines +your place in the list. For instance, if you make a list request and receive 100 +objects, ending with obj_foo, your subsequent call can include +starting_after=obj_foo in order to fetch the next page of the list.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPLocalMobileConnectionConfiguration.html b/docs/2.19.0/Classes/SCPLocalMobileConnectionConfiguration.html new file mode 100644 index 00000000..04b672f2 --- /dev/null +++ b/docs/2.19.0/Classes/SCPLocalMobileConnectionConfiguration.html @@ -0,0 +1,836 @@ + + + + SCPLocalMobileConnectionConfiguration Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPLocalMobileConnectionConfiguration Class Reference +

+ +
+ +
+ +
+
+

SCPLocalMobileConnectionConfiguration

+
+
+

Objective-C

+ 

+@interface SCPLocalMobileConnectionConfiguration : SCPConnectionConfiguration
+ +
+
+

Swift

+ 
class LocalMobileConnectionConfiguration : ConnectionConfiguration
+ +
+
+

This class lets you set options that define local mobile reader behavior throughout a given +reader-to-SDK connection session.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + locationId + +
    +
    +
    +
    +
    +
    +

    The ID of the Location which the reader should be +registered to during connection. +If the provided ID matches the location the reader is already registered to, the location field on the reader +object will not be changed.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly) NSString *_Nonnull locationId;
    + +
    +
    +

    Swift

    + 
    var locationId: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + onBehalfOf + +
    +
    +
    +
    +
    +
    +

    If your integration is creating destination charges and using on_behalf_of, you must provide the +connected_account_id in the onBehalfOf parameter as part of the +SCPLocalMobileConnectionConfiguration. +Unlike other reader types which require this information on a per-transaction basis, the Apple Built-In reader +requires this on a per-connection basis as well in order to establish a reader connection.

    +
    +

    See

    + https://stripe.com/docs/terminal/features/connect#destination-payment-intents + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSString *onBehalfOf;
    + +
    +
    +

    Swift

    + 
    var onBehalfOf: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + merchantDisplayName + +
    +
    +
    +
    +
    +
    +

    Optional cardholder facing merchant display name that will be used in the prompt for the cardholder +to present their card. If this value is not provided, the merchant display name will be taken from +the Terminal Location.display_name associated with the connection.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSString *merchantDisplayName;
    + +
    +
    +

    Swift

    + 
    var merchantDisplayName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    In order to connect to a reader, merchant-specific terms of service may need to be accepted. +Presenting the flow requires iCloud sign-in and an authorized individual. This attribute +determines how the connection process should proceed if this situation is +encountered.

    + +
      +
    • If YES, the terms the terms of service should be presented during connection. +If accepted successfully, the connection process will resume. +If not accepted succesfully, the connection will fail with an error.
      • +

    • If NO, the terms of service will not be presented and the connection will fail with an error.

      • +
    +

    See

    +

    SCPErrorAppleBuiltInReaderTOSNotYetAccepted

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, assign, unsafe_unretained, readonly,
+          getter=isTOSAcceptancePermitted) BOOL tosAcceptancePermitted;
    + +
    +
    +

    Swift

    + 
    var isTOSAcceptancePermitted: Bool { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -initWithLocationId: + +
    +
    +
    +
    +
    +
    +

    Initialize ConnectionConfiguration with a location ID.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithLocationId:(nonnull NSString *)locationId;
    + +
    +
    +

    Swift

    + 
    convenience init(locationId: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + locationId + + +
    +

    The ID of the location to be associated with the reader.

    +
    +
    +
    +
    +

    Return Value

    +

    A new instance of the receiver configured with a location ID.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize ConnectionConfiguration with a location ID, custom merchant display name, and ‘on behalf of’ +connected account ID.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithLocationId:(nonnull NSString *)locationId
+                       merchantDisplayName:
+                           (nullable NSString *)merchantDisplayName
+                                onBehalfOf:(nullable NSString *)onBehalfOf;
    + +
    +
    +

    Swift

    + 
    convenience init(locationId: String, merchantDisplayName: String?, onBehalfOf: String?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + locationId + + +
    +

    ID of the location to be associated with the reader.

    +
    +
    + + merchantDisplayName + + +
    +

    Cardholder facing merchant display name that will be used in the prompt +for the cardholder to present their card.

    +
    +
    + + onBehalfOf + + +
    +

    Connected account id that the merchant is taking payments on behalf of.

    +
    +
    +
    +
    +

    Return Value

    +

    A new instance of the receiver configured with a location ID, merchant +display name, and the ‘on behalf of’ connected account ID.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize ConnectionConfiguration with a location ID, custom merchant display name, ‘on behalf of’ +connected account ID and terms of service acceptance configuration.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithLocationId:(nonnull NSString *)locationId
+                       merchantDisplayName:
+                           (nullable NSString *)merchantDisplayName
+                                onBehalfOf:(nullable NSString *)onBehalfOf
+                    tosAcceptancePermitted:(BOOL)tosAcceptancePermitted;
    + +
    +
    +

    Swift

    + 
    init(locationId: String, merchantDisplayName: String?, onBehalfOf: String?, tosAcceptancePermitted: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + locationId + + +
    +

    ID of the location to be associated with the reader.

    +
    +
    + + merchantDisplayName + + +
    +

    Cardholder facing merchant display name that will be used in the prompt +for the cardholder to present their card.

    +
    +
    + + onBehalfOf + + +
    +

    Connected account id that the merchant is taking payments on behalf of.

    +
    +
    + + tosAcceptancePermitted + + +
    +

    Determines how to handle the situation where merchant-specific +terms of service need to be presented in order to connect to a reader. +@returns A new instance of the receiver configured with a location ID, merchant +display name, ‘on behalf of’ connected account ID and terms of service acceptance configuration.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPLocation.html b/docs/2.19.0/Classes/SCPLocation.html new file mode 100644 index 00000000..08d41ac9 --- /dev/null +++ b/docs/2.19.0/Classes/SCPLocation.html @@ -0,0 +1,687 @@ + + + + SCPLocation Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPLocation Class Reference +

+ +
+ +
+ +
+
+

SCPLocation

+
+
+

Objective-C

+ 

+@interface SCPLocation : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class Location : NSObject, JSONDecodable
+ +
+
+

A Location is used to group readers in the Stripe Terminal ecosystem. The +Location to which a reader is registered can control regional behavior +for that particular reader.

+ +

You cannot create locations through the SDK. Instead, use the Stripe API +from your backend to manage your account’s locations.

+ +

To fetch the Location objects associated with your account, call +Terminal.shared.listLocations().

+
+

See

+ https://stripe.com/docs/api/terminal/locations + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + stripeId + +
    +
    +
    +
    +
    +
    +

    The ID of the Location

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly) NSString *_Nonnull stripeId;
    + +
    +
    +

    Swift

    + 
    var stripeId: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    The address of this Location

    +
    +

    See

    + SCPAddress + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, strong, readonly, nullable) SCPAddress *address;
    + +
    +
    +

    Swift

    + 
    var address: SCPAddress? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + displayName + +
    +
    +
    +
    +
    +
    +

    The display name of this Location

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSString *displayName;
    + +
    +
    +

    Swift

    + 
    var displayName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + livemode + +
    +
    +
    +
    +
    +
    +

    Whether this Location was created in livemode

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) BOOL livemode;
    + +
    +
    +

    Swift

    + 
    var livemode: Bool { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Any metadata attached to this Location

    +
    +

    See

    + https://stripe.com/docs/api/terminal/locations/create#create_terminal_location-metadata + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, strong, readonly, nullable) NSDictionary<NSString *, NSString *> *metadata;
    + +
    +
    +

    Swift

    + 
    var metadata: [String : String]? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPNetworks.html b/docs/2.19.0/Classes/SCPNetworks.html new file mode 100644 index 00000000..930d0cb4 --- /dev/null +++ b/docs/2.19.0/Classes/SCPNetworks.html @@ -0,0 +1,542 @@ + + + + SCPNetworks Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPNetworks Class Reference +

+ +
+ +
+ +
+
+

SCPNetworks

+
+
+

Objective-C

+ 
@interface SCPNetworks : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class SCPNetworks : NSObject, JSONDecodable
+ +
+
+

Contains information about card networks that can be used to process the payment.

+
+

See

+ https://stripe.com/docs/api/payment_methods/object#payment_method_object-card-networks-available + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + available + +
    +
    +
    +
    +
    +
    +

    All available networks for the card.

    + +

    Contains SCPCardBrand’s represented as NSNumber.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSArray<NSNumber *> *available;
    + +
    +
    +

    Swift

    + 
    var available: [NSNumber]? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPPaymentIntent.html b/docs/2.19.0/Classes/SCPPaymentIntent.html new file mode 100644 index 00000000..a05eba8c --- /dev/null +++ b/docs/2.19.0/Classes/SCPPaymentIntent.html @@ -0,0 +1,960 @@ + + + + SCPPaymentIntent Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPPaymentIntent Class Reference +

+ +
+ +
+ +
+
+

SCPPaymentIntent

+
+
+

Objective-C

+ 

+@interface SCPPaymentIntent : NSObject <SCPJSONDecodable, NSCopying>
+ +
+
+

Swift

+ 
class PaymentIntent : NSObject, JSONDecodable, NSCopying
+ +
+
+

A PaymentIntent tracks the process of collecting a payment from your customer. +We recommend that you create exactly one PaymentIntent for each order or +customer session in your system. You can reference the PaymentIntent later to +see the history of payment attempts for a particular session.

+ +

A PaymentIntent transitions through multiple statuses throughout its lifetime +and ultimately creates at most one successful charge.

+ +

https://stripe.com/docs/api/payment_intents

+ +
+
+ +
+
+
+
    +
  • +
    + + + + stripeId + +
    +
    +
    +
    +
    +
    +

    The unique identifier for the intent.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly) NSString *_Nonnull stripeId;
    + +
    +
    +

    Swift

    + 
    var stripeId: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + created + +
    +
    +
    +
    +
    +
    +

    When the intent was created.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSDate *_Nonnull created;
    + +
    +
    +

    Swift

    + 
    var created: Date { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    The status of the PaymentIntent.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPPaymentIntentStatus status;
    + +
    +
    +

    Swift

    + 
    var status: PaymentIntentStatus { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    The amount to be collected by this PaymentIntent, provided in the currency’s +smallest unit.

    +
    +

    See

    + https://stripe.com/docs/currencies#zero-decimal + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSUInteger amount;
    + +
    +
    +

    Swift

    + 
    var amount: UInt { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + captureMethod + +
    +
    +
    +
    +
    +
    +

    Controls when the funds will be captured from the customer’s account.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPCaptureMethod captureMethod;
    + +
    +
    +

    Swift

    + 
    var captureMethod: CaptureMethod { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    The currency of the payment.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull currency;
    + +
    +
    +

    Swift

    + 
    var currency: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Set of key-value pairs attached to the object.

    +
    +

    See

    + https://stripe.com/docs/api#metadata + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSDictionary<NSString *, NSString *> *metadata;
    + +
    +
    +

    Swift

    + 
    var metadata: [String : String]? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + charges + +
    +
    +
    +
    +
    +
    +

    Charges that were created by this PaymentIntent, if any.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSArray<SCPCharge *> *_Nonnull charges;
    + +
    +
    +

    Swift

    + 
    var charges: [SCPCharge] { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentMethod + +
    +
    +
    +
    +
    +
    +

    The payment method to be used in this PaymentIntent. Only valid in the +intent returned during collectPaymentMethod when using the updatePaymentIntent +option in the SCPCollectConfiguration.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPPaymentMethod *paymentMethod;
    + +
    +
    +

    Swift

    + 
    var paymentMethod: SCPPaymentMethod? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + amountDetails + +
    +
    +
    +
    +
    +
    +

    Details about items included in the amount after confirmation.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPAmountDetails *amountDetails;
    + +
    +
    +

    Swift

    + 
    var amountDetails: SCPAmountDetails? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + amountTip + +
    +
    +
    +
    +
    +
    +

    Indicates how much the user intends to tip in addition to the amount by at confirmation time. +This is only non-null in the PaymentIntent instance returned during collect when using +updatePaymentIntent set to true in the CollectConfiguration.

    + +

    After processPaymentIntent the amount will have this tip amount added to it and the +amountDetails will contain the breakdown of how much of the amount was a tip.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSNumber *amountTip;
    + +
    +
    +

    Swift

    + 
    var amountTip: NSNumber? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + statementDescriptor + +
    +
    +
    +
    +
    +
    +

    Extra information about a PaymentIntent. This will appear on your customer’s statement when +this PaymentIntent succeeds in creating a charge.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *statementDescriptor;
    + +
    +
    +

    Swift

    + 
    var statementDescriptor: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Extra dynamic information about a PaymentIntent. This will appear concatenated with the statementDescriptor on +your customer’s statement when this PaymentIntent succeeds in creating a charge.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *statementDescriptorSuffix;
    + +
    +
    +

    Swift

    + 
    var statementDescriptorSuffix: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate SCPPaymentIntent. You should only use +one that has been returned by our SDK.

    +
    +

    See

    + SCPTerminal.shared.createPaymentIntent() + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate SCPPaymentIntent. You should only use +one that has been returned by our SDK.

    +
    +

    See

    + SCPTerminal.shared.createPaymentIntent() + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPPaymentIntentParameters.html b/docs/2.19.0/Classes/SCPPaymentIntentParameters.html new file mode 100644 index 00000000..85be4f22 --- /dev/null +++ b/docs/2.19.0/Classes/SCPPaymentIntentParameters.html @@ -0,0 +1,1485 @@ + + + + SCPPaymentIntentParameters Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPPaymentIntentParameters Class Reference +

+ +
+ +
+ +
+
+

SCPPaymentIntentParameters

+
+
+

Objective-C

+ 

+@interface SCPPaymentIntentParameters : NSObject
+ +
+
+

Swift

+ 
class PaymentIntentParameters : NSObject
+ +
+
+

Parameters for creating an SCPPaymentIntent. Pass an object of this type +into Terminal.shared.createPaymentIntent().

+
+

See

+ https://stripe.com/docs/api/payment_intents/create + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    The amount of the payment, provided in the currency’s smallest unit.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSUInteger amount;
    + +
    +
    +

    Swift

    + 
    var amount: UInt { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull currency;
    + +
    +
    +

    Swift

    + 
    var currency: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentMethodTypes + +
    +
    +
    +
    +
    +
    +

    The list of payment method types that this PaymentIntent is allowed to use. +The default is value for this is [“card_present”].

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSArray<NSString *> *_Nonnull paymentMethodTypes;
    + +
    +
    +

    Swift

    + 
    var paymentMethodTypes: [String] { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + captureMethod + +
    +
    +
    +
    +
    +
    +

    The capture method that this PaymentIntent should use. Defaults to SCPCaptureMethodManual.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPCaptureMethod captureMethod;
    + +
    +
    +

    Swift

    + 
    var captureMethod: CaptureMethod { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Set of key-value pairs that you can attach to an object. This can be useful for +storing additional information about the object in a structured format.

    +
    +

    See

    + https://stripe.com/docs/api#metadata + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSDictionary<NSString *, NSString *> *metadata;
    + +
    +
    +

    Swift

    + 
    var metadata: [String : String]? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + stripeDescription + +
    +
    +
    +
    +
    +
    +

    An arbitrary string attached to the object. If you send a receipt email for +this payment, the email will include the description.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *stripeDescription;
    + +
    +
    +

    Swift

    + 
    var stripeDescription: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + statementDescriptor + +
    +
    +
    +
    +
    +
    +

    A string to be displayed on your customer’s credit card statement. This may be +up to 22 characters. The statement descriptor must contain at least one letter, +may not include <>"' characters, and will appear on your customer’s statement +in capital letters. Non-ASCII characters are automatically stripped. While +most banks and card issuers display this information consistently, some may +display it incorrectly or not at all.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *statementDescriptor;
    + +
    +
    +

    Swift

    + 
    var statementDescriptor: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A string to specify details about the transaction so your customer can understand it clearly on their statement. +The suffix is concatenated with the statementDescriptor, the * symbol, and a space to form the complete statement +descriptor that your customer sees. Maximum 22 characters for the final concatenated descriptor.

    +
    +

    See

    + https://stripe.com/docs/account/statement-descriptors + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *statementDescriptorSuffix;
    + +
    +
    +

    Swift

    + 
    var statementDescriptorSuffix: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + receiptEmail + +
    +
    +
    +
    +
    +
    +

    Email address that the receipt for the resulting payment will be sent to.

    +
    +

    See

    + https://stripe.com/docs/terminal/checkout/receipts + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *receiptEmail;
    + +
    +
    +

    Swift

    + 
    var receiptEmail: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + customer + +
    +
    +
    +
    +
    +
    +

    The ID of the Customer this PaymentIntent is for, if one exists.

    +
    +

    See

    + https://stripe.com/docs/api/customers + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *customer;
    + +
    +
    +

    Swift

    + 
    var customer: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + applicationFeeAmount + +
    +
    +
    +
    +
    +
    +

    The amount of the application fee (if any) that will be applied to the +payment and transferred to the application owner’s Stripe account. To use an +application fee, the request must be made on behalf of another account, +using the stripeAccount property or an OAuth key.

    + +

    The amount must be provided as a boxed UInt in the currency’s smallest unit.

    +
    +

    See

    + https://stripe.com/docs/connect/direct-charges#collecting-fees + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSNumber *applicationFeeAmount;
    + +
    +
    +

    Swift

    + 
    @NSCopying var applicationFeeAmount: NSNumber? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferGroup + +
    +
    +
    +
    +
    +
    +

    A string that identifies the resulting payment as part of a group.

    +
    +

    See

    + https://stripe.com/docs/connect/charges-transfers#grouping-transactions + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *transferGroup;
    + +
    +
    +

    Swift

    + 
    var transferGroup: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The account (if any) the payment will be attributed to for tax reporting, and +where funds from the payment will be transferred to upon payment success.

    + +

    At capture time, use transfer_data[amount] to specify the amount that will be +transferred automatically when a charge succeeds.

    + +

    When transferDataDestination is specified, onBehalfOf must also be +specified and must match the destination of the transfer.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *transferDataDestination;
    + +
    +
    +

    Swift

    + 
    var transferDataDestination: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + onBehalfOf + +
    +
    +
    +
    +
    +
    +

    The Stripe account ID for which these funds are intended.

    + +

    When transferDataDestination is specified, onBehalfOf must also be +specified and must match the destination of the transfer.

    +
    +

    See

    + https://stripe.com/docs/connect/charges-transfers#on-behalf-of + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *onBehalfOf;
    + +
    +
    +

    Swift

    + 
    var onBehalfOf: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + setupFutureUsage + +
    +
    +
    +
    +
    +
    +

    Indicates that you intend to make future payments with this PaymentIntent’s payment method.

    + +

    Providing this parameter will attach the payment method to the PaymentIntent’s Customer, +after the PaymentIntent is confirmed and any required actions from the user are complete. +If no Customer was provided, the payment method can still be attached to a Customer after +the transaction completes.

    + +

    Possible values: +“on_session”: Use “on_session” if you intend to only reuse the payment method when your +customer is present in your checkout flow. +“off_session”: Use “off_session” if your customer may or may not be present in your checkout flow.

    +
    +

    See

    + https://stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *setupFutureUsage;
    + +
    +
    +

    Swift

    + 
    var setupFutureUsage: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Specific options used during the creation of the PaymentMethod.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) SCPPaymentMethodOptionsParameters *_Nonnull paymentMethodOptionsParameters;
    + +
    +
    +

    Swift

    + 
    var paymentMethodOptionsParameters: PaymentMethodOptionsParameters { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes SCPPaymentIntentParameters with the given parameters.

    + +

    Note: in testmode, only amounts ending in “00” will be approved. All other +amounts will be declined by the Stripe API. For more information about this +feature, see https://stripe.com/docs/terminal/testing#test-card

    + +

    This initializer will use the default paymentMethodTypes value: [“card_present”]

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithAmount:(NSUInteger)amount
+                              currency:(nonnull NSString *)currency;
    + +
    +
    +

    Swift

    + 
    init(amount: UInt, currency: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + amount + + +
    +

    The amount of the payment, provided in the currency’s +smallest unit.

    +
    +
    + + currency + + +
    +

    The currency of the payment.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes SCPPaymentIntentParameters with the given parameters.

    +
    +

    Note

    +

    In testmode, only amounts ending in “00” will be approved. All other +amounts will be declined by the Stripe API. For more information about this +feature, see https://stripe.com/docs/terminal/testing#test-card

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithAmount:(NSUInteger)amount
+                              currency:(nonnull NSString *)currency
+                    paymentMethodTypes:
+                        (nonnull NSArray<NSString *> *)paymentMethodTypes;
    + +
    +
    +

    Swift

    + 
    init(amount: UInt, currency: String, paymentMethodTypes: [String])
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + amount + + +
    +

    The amount of the payment, provided in the currency’s +smallest unit.

    +
    +
    + + currency + + +
    +

    The currency of the payment.

    +
    +
    + + paymentMethodTypes + + +
    +

    The payment method types allowed for this +payment. Currently allowed payment method types for a Terminal transaction are +“card_present” and “interac_present”.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes SCPPaymentIntentParameters with the given parameters.

    +
    +

    Note

    +

    In testmode, only amounts ending in “00” will be approved. All other +amounts will be declined by the Stripe API. For more information about this +feature, see https://stripe.com/docs/terminal/testing#test-card

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithAmount:(NSUInteger)amount
+                              currency:(nonnull NSString *)currency
+                         captureMethod:(SCPCaptureMethod)captureMethod;
    + +
    +
    +

    Swift

    + 
    init(amount: UInt, currency: String, captureMethod: CaptureMethod)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + amount + + +
    +

    The amount of the payment, provided in the currency’s +smallest unit.

    +
    +
    + + currency + + +
    +

    The currency of the payment.

    +
    +
    + + captureMethod + + +
    +

    The type of capture method used for this payment. +Passing in SCPCaptureMethodAutomatic will result in a capture occurring automatically +whereas SCPCaptureMethodManual will require an explicit call to capture payments +(see: https://stripe.com/docs/terminal/payments/collect-payment?terminal-sdk-platform=ios#capture-payment)

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes SCPPaymentIntentParameters with the given parameters.

    +
    +

    Note

    +

    In testmode, only amounts ending in “00” will be approved. All other +amounts will be declined by the Stripe API. For more information about this +feature, see https://stripe.com/docs/terminal/testing#test-card

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithAmount:(NSUInteger)amount
+                              currency:(nonnull NSString *)currency
+                    paymentMethodTypes:
+                        (nonnull NSArray<NSString *> *)paymentMethodTypes
+                         captureMethod:(SCPCaptureMethod)captureMethod;
    + +
    +
    +

    Swift

    + 
    init(amount: UInt, currency: String, paymentMethodTypes: [String], captureMethod: CaptureMethod)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + amount + + +
    +

    The amount of the payment, provided in the currency’s +smallest unit.

    +
    +
    + + currency + + +
    +

    The currency of the payment.

    +
    +
    + + paymentMethodTypes + + +
    +

    The payment method types allowed for this +payment. Currently allowed payment method types for a Terminal transaction are +“card_present” and “interac_present”.

    +
    +
    + + captureMethod + + +
    +

    The type of capture method used for this payment. +Passing in SCPCaptureMethodAutomatic will result in a capture occuring automatically +whereas SCPCaptureMethodManual will require an explicit call to capture payments +(see: https://stripe.com/docs/terminal/payments/collect-payment?terminal-sdk-platform=ios#capture-payment)

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithAmount:currency:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithAmount:currency:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + description + +
    +
    +
    +
    +
    +
    +

    Deprecated

    +

    Did you mean to use stripeDescription?

    + +
    +
    +

    Use stripeDescription for the string attached to the object.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly) DEPRECATED_MSG_ATTRIBUTE("Did you mean to use stripeDescription?") NSString *description;
    + +
    +
    +

    Swift

    + 
    var description: String { get }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPPaymentMethod.html b/docs/2.19.0/Classes/SCPPaymentMethod.html new file mode 100644 index 00000000..0cc3a9cd --- /dev/null +++ b/docs/2.19.0/Classes/SCPPaymentMethod.html @@ -0,0 +1,777 @@ + + + + SCPPaymentMethod Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPPaymentMethod Class Reference +

+ +
+ +
+ +
+
+

SCPPaymentMethod

+
+
+

Objective-C

+ 

+@interface SCPPaymentMethod : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class PaymentMethod : NSObject, JSONDecodable
+ +
+
+

PaymentMethod objects represent your customer’s payment instruments. +They can be used with PaymentIntents to collect payments, or saved +to Customer objects to store instrument details for future payments.

+
+

See

+ https://stripe.com/docs/api/payment_methods + +
+

See

+ https://stripe.com/docs/payments/payment-methods/saving#attach-method + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + stripeId + +
    +
    +
    +
    +
    +
    +

    The unique identifier for the PaymentMethod

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull stripeId;
    + +
    +
    +

    Swift

    + 
    var stripeId: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + created + +
    +
    +
    +
    +
    +
    +

    Time at which the object was created. Measured in seconds since the Unix epoch.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSDate *created;
    + +
    +
    +

    Swift

    + 
    var created: Date? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    The type of the PaymentMethod. The corresponding, similarly named property contains additional information specific to the PaymentMethod type. +e.g. if the type is SCPPaymentMethodTypeCard, the card property is also populated.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPPaymentMethodType type;
    + +
    +
    +

    Swift

    + 
    var type: PaymentMethodType { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + card + +
    +
    +
    +
    +
    +
    +

    If this is a card PaymentMethod (ie self.type == SCPPaymentMethodTypeCard), this contains additional details.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPCardDetails *card;
    + +
    +
    +

    Swift

    + 
    var card: SCPCardDetails? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardPresent + +
    +
    +
    +
    +
    +
    +

    If this is a card_present PaymentMethod (ie self.type == SCPPaymentMethodTypeCardPresent), this contains additional details.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPCardPresentDetails *cardPresent;
    + +
    +
    +

    Swift

    + 
    var cardPresent: SCPCardPresentDetails? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + interacPresent + +
    +
    +
    +
    +
    +
    +

    If this is an Interac_present PaymentMethod (ie self.type == SCPPaymentMethodTypeInteracPresent), this contains additional details.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPCardPresentDetails *interacPresent;
    + +
    +
    +

    Swift

    + 
    var interacPresent: SCPCardPresentDetails? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + customer + +
    +
    +
    +
    +
    +
    +

    The Customer that this PaymentMethod is attached to, or nil.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *customer;
    + +
    +
    +

    Swift

    + 
    var customer: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    +
    +

    See

    + https://stripe.com/docs/api#metadata + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSDictionary<NSString *, NSString *> *_Nonnull metadata;
    + +
    +
    +

    Swift

    + 
    var metadata: [String : String] { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPPaymentMethodDetails.html b/docs/2.19.0/Classes/SCPPaymentMethodDetails.html new file mode 100644 index 00000000..47f84137 --- /dev/null +++ b/docs/2.19.0/Classes/SCPPaymentMethodDetails.html @@ -0,0 +1,583 @@ + + + + SCPPaymentMethodDetails Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPPaymentMethodDetails Class Reference +

+ +
+ +
+ +
+
+

SCPPaymentMethodDetails

+
+
+

Objective-C

+ 

+@interface SCPPaymentMethodDetails : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class PaymentMethodDetails : NSObject, JSONDecodable
+ +
+
+

Details about a PaymentMethod at a specific time. ex: at time of transaction +for a Charge.

+
+

See

+ https://stripe.com/docs/api/charges/object#charge_object-payment_method_details + +
+ +

Unlike an SCPPaymentMethod, the details object does not have a stripeId, +and only exists as a sub-object of another Stripe object.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    The type of the PaymentMethod. The corresponding, similarly named property +contains additional information specific to the PaymentMethod type. +e.g. if the type is SCPPaymentMethodTypeCardPresent, the cardPresent +property is also populated.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPPaymentMethodType type;
    + +
    +
    +

    Swift

    + 
    var type: PaymentMethodType { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardPresent + +
    +
    +
    +
    +
    +
    +

    If this is a card present payment method (ie self.type == SCPPaymentMethodTypeCardPresent), +this contains additional information.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPCardPresentDetails *cardPresent;
    + +
    +
    +

    Swift

    + 
    var cardPresent: SCPCardPresentDetails? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + interacPresent + +
    +
    +
    +
    +
    +
    +

    If this is an Interac present payment method (ie self.type == SCPPaymentMethodTypeInteracPresent), +this contains additional information.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPCardPresentDetails *interacPresent;
    + +
    +
    +

    Swift

    + 
    var interacPresent: SCPCardPresentDetails? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPPaymentMethodOptionsParameters.html b/docs/2.19.0/Classes/SCPPaymentMethodOptionsParameters.html new file mode 100644 index 00000000..f4b01067 --- /dev/null +++ b/docs/2.19.0/Classes/SCPPaymentMethodOptionsParameters.html @@ -0,0 +1,562 @@ + + + + SCPPaymentMethodOptionsParameters Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPPaymentMethodOptionsParameters Class Reference +

+ +
+ +
+ +
+
+

SCPPaymentMethodOptionsParameters

+
+
+

Objective-C

+ 

+@interface SCPPaymentMethodOptionsParameters : NSObject
+ +
+
+

Swift

+ 
class PaymentMethodOptionsParameters : NSObject
+ +
+
+

The PaymentMethodOptionsParameters contains options for PaymentMethod creation.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + cardPresentParameters + +
    +
    +
    +
    +
    +
    +

    Card-present-specific configuration for this PaymentMethod.

    +
    +

    See

    + https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method_options-card_present + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, strong) SCPCardPresentParameters *_Nonnull cardPresentParameters;
    + +
    +
    +

    Swift

    + 
    var cardPresentParameters: CardPresentParameters { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize a PaymentMethodOptionsParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithCardPresentParameters:
+    (nonnull SCPCardPresentParameters *)cardPresentParameters;
    + +
    +
    +

    Swift

    + 
    init(cardPresentParameters: CardPresentParameters)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + cardPresentParameters + + +
    +

    Payment-method-specific configuration for this PaymentIntent.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithCardPresentParameters:(SCPCardPresentParameters)cardPresentParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPProcessPaymentError.html b/docs/2.19.0/Classes/SCPProcessPaymentError.html new file mode 100644 index 00000000..dbe0e5b2 --- /dev/null +++ b/docs/2.19.0/Classes/SCPProcessPaymentError.html @@ -0,0 +1,623 @@ + + + + SCPProcessPaymentError Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPProcessPaymentError Class Reference +

+ +
+ +
+ +
+
+

SCPProcessPaymentError

+
+
+

Objective-C

+ 

+@interface SCPProcessPaymentError : NSError
+ +
+
+

Swift

+ 
class ProcessPaymentError : NSError
+ +
+
+

An error from -[SCPTerminal processPayment:completion:].

+
+

See

+ https://stripe.com/docs/terminal/payments#process + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + paymentIntent + +
    +
    +
    +
    +
    +
    +

    The updated PaymentIntent after processPayment failed.

    + +
      +

    1. If the status of the updated PaymentIntent is still .requiresConfirmation +(e.g the request failed because your app is not connected to the internet), +you may call processPayment again with the updated PaymentIntent to +retry the request.

      2. +

    2. If the status of the updated PaymentIntent is .requiresPaymentMethod (e.g. the +request failed because the card was declined), you should call +collectPaymentMethod with the updated PaymentIntent to try charging another +card.

      3. +

    3. If this value is nil, the request timed out, and the status of the +PaymentIntent is unknown. We recommend that you retry processPayment using +the original PaymentIntent. If you instead choose to abandon the original +PaymentIntent and create a new one, you should be sure not to capture the +original PaymentIntent.

      4. +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPPaymentIntent *paymentIntent;
    + +
    +
    +

    Swift

    + 
    var paymentIntent: SCPPaymentIntent? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + requestError + +
    +
    +
    +
    +
    +
    +

    If processPayment failed because the underlying network request errored, +this property contains additional details about the error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSError *requestError;
    + +
    +
    +

    Swift

    + 
    var requestError: Error? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + declineCode + +
    +
    +
    +
    +
    +
    +

    If processPayment failed because the payment method was declined, this +property contains the decline code.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *declineCode;
    + +
    +
    +

    Swift

    + 
    var declineCode: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPProcessRefundError.html b/docs/2.19.0/Classes/SCPProcessRefundError.html new file mode 100644 index 00000000..fbdca4ef --- /dev/null +++ b/docs/2.19.0/Classes/SCPProcessRefundError.html @@ -0,0 +1,580 @@ + + + + SCPProcessRefundError Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPProcessRefundError Class Reference +

+ +
+ +
+ +
+
+

SCPProcessRefundError

+
+
+

Objective-C

+ 

+@interface SCPProcessRefundError : NSError
+ +
+
+

Swift

+ 
class ProcessRefundError : NSError
+ +
+
+

An error from -[SCPTerminal processRefund:completion:].

+
+

See

+ https://stripe.com/docs/terminal/canada#interac-refunds + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + refund + +
    +
    +
    +
    +
    +
    +

    If processRefund failed after the refund was created, this property contains +the failing refund.

    +
    +

    See

    + https://stripe.com/docs/api/refunds/object + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPRefund *refund;
    + +
    +
    +

    Swift

    + 
    var refund: SCPRefund? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + requestError + +
    +
    +
    +
    +
    +
    +

    If processRefund failed because the underlying network request errored, +this property contains additional details about the error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSError *requestError;
    + +
    +
    +

    Swift

    + 
    var requestError: Error? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPReadReusableCardParameters.html b/docs/2.19.0/Classes/SCPReadReusableCardParameters.html new file mode 100644 index 00000000..ee8243fb --- /dev/null +++ b/docs/2.19.0/Classes/SCPReadReusableCardParameters.html @@ -0,0 +1,530 @@ + + + + SCPReadReusableCardParameters Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPReadReusableCardParameters Class Reference +

+ +
+ +
+ +
+
+

SCPReadReusableCardParameters

+
+
+

Objective-C

+ 

+@interface SCPReadReusableCardParameters : NSObject
+ +
+
+

Swift

+ 
class ReadReusableCardParameters : NSObject
+ +
+
+

Parameters for reading a reusable card.

+ +

NOTE: Most integrations should not use readReusableCard.

+ +

You should create a PaymentIntent and use the associated collectPaymentMethod +and processPayment methods if you are simply collecting a payment from +a customer.

+ +

You can use -[SCPTerminal readReusableCard:delegate:completion:] to read +payment details and defer payment for later. The SCPPaymentMethod created by +this method will have type card, suitable for use with online payments.

+ +

Note that if you use this method to defer a payment, the transaction will +not receive the beneficial rates and liability shift associated with card +present transactions.

+
+

See

+ https://stripe.com/docs/terminal/online-payments + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + customer + +
    +
    +
    +
    +
    +
    +

    Optional parameter: attach the new PaymentMethod to Customer with this id

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *customer;
    + +
    +
    +

    Swift

    + 
    var customer: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Optional set of key-value pairs attached to the object. The default is nil.

    +
    +

    See

    + https://stripe.com/docs/api#metadata + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSDictionary<NSString *, NSString *> *metadata;
    + +
    +
    +

    Swift

    + 
    var metadata: [String : String]? { get set }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPReader.html b/docs/2.19.0/Classes/SCPReader.html new file mode 100644 index 00000000..32b7bf17 --- /dev/null +++ b/docs/2.19.0/Classes/SCPReader.html @@ -0,0 +1,1102 @@ + + + + SCPReader Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPReader Class Reference +

+ +
+ +
+ +
+
+

SCPReader

+
+
+

Objective-C

+ 

+@interface SCPReader : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class Reader : NSObject, JSONDecodable
+ +
+
+

Information about a card reader that has been discovered by or connected to +the SDK.

+ +

Some of the properties are only applicable to a certain device type. +These properties are labeled with the reader or reader type to which they apply.

+
+

See

+ https://stripe.com/docs/terminal/readers + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + deviceType + +
    +
    +
    +
    +
    +
    +

    The reader’s device type.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPDeviceType deviceType;
    + +
    +
    +

    Swift

    + 
    var deviceType: DeviceType { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + simulated + +
    +
    +
    +
    +
    +
    +

    True if this is a simulated reader.

    + +

    SCPDiscoveryConfiguration objects with simulated set to true produce simulated +readers.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) BOOL simulated;
    + +
    +
    +

    Swift

    + 
    var simulated: Bool { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + stripeId + +
    +
    +
    +
    +
    +
    +

    The Stripe unique identifier for the reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *stripeId;
    + +
    +
    +

    Swift

    + 
    var stripeId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + locationId + +
    +
    +
    +
    +
    +
    +

    The ID of the reader’s Location.

    + +

    Internet readers remain registered to the location specified when registering +the reader to your account. For internet readers, this field represents that location. +If you need to change your internet reader’s location, re-register the reader and +specify the new location id in the location param. +See https://stripe.com/docs/api/terminal/readers/create

    + +

    Bluetooth and Apple Built-In readers are designed to be more mobile and must be +registered to a location upon each connection. This field represents the last +location that the reader was registered to. If the reader has not been used before, +this field will be nil. If you associate the reader to a different location while calling +connectBluetoothReader, this field will update to that new location’s ID.

    +
    +

    See

    + https://stripe.com/docs/api/terminal/locations + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nullable) NSString *locationId;
    + +
    +
    +

    Swift

    + 
    var locationId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + locationStatus + +
    +
    +
    +
    +
    +
    +

    Used to tell whether the location field has been set. +Note that the Internet and simulated readers will always +have an unknown locationStatus.

    + +

    (Bluetooth and Apple Built-In readers only.)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly) SCPLocationStatus locationStatus;
    + +
    +
    +

    Swift

    + 
    var locationStatus: LocationStatus { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + location + +
    +
    +
    +
    +
    +
    +

    The details of the location this reader is registered to, if any.

    + +

    During discovery, location will be nil for Bluetooth readers that have never +been connected to.

    + +

    You must assign a Bluetooth reader to a location from the SDK during connectBluetoothReader. +See locationId in SCPBluetoothConnectionConfiguration.

    + +

    After connecting to a reader, location will be nil if the reader has been +registered to a new location. See https://stripe.com/docs/api/terminal/locations/retrieve +for documentation on retrieving location details in your app.

    + +

    (Bluetooth and Apple Built-In readers only.)

    +
    +

    See

    + https://stripe.com/docs/api/terminal/locations + +
    +

    See

    + https://stripe.com/docs/terminal/readers/fleet-management#bbpos-wisepad3 + +
    +

    See

    + SCPConnectionConfiguration + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nullable) SCPLocation *location;
    + +
    +
    +

    Swift

    + 
    var location: Location? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + serialNumber + +
    +
    +
    +
    +
    +
    +

    The reader’s serial number.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull serialNumber;
    + +
    +
    +

    Swift

    + 
    var serialNumber: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + deviceSoftwareVersion + +
    +
    +
    +
    +
    +
    +

    The reader’s current device software version, or nil if this information is +unavailable.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nullable) NSString *deviceSoftwareVersion;
    + +
    +
    +

    Swift

    + 
    var deviceSoftwareVersion: String? { get }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Bluetooth Reader Properties +

+
+
+
    +
  • +
    + + + + availableUpdate + +
    +
    +
    +
    +
    +
    +

    The available update for this reader, or nil if no update is available. +This update will also have been announced via +- [BluetoothReaderDelegate reader:didReportAvailableUpdate:]

    + +

    Install this update with - [Terminal installAvailableUpdate]

    + +

    calls to installAvailableUpdate when availableUpdate is nil will result +in - [BluetoothReaderDelegate reader:didFinishInstallingUpdate:error:] called +immediately with a nil update and nil error.

    + +

    (Bluetooth readers only.)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nullable) SCPReaderSoftwareUpdate *availableUpdate;
    + +
    +
    +

    Swift

    + 
    var availableUpdate: SCPReaderSoftwareUpdate? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + batteryLevel + +
    +
    +
    +
    +
    +
    +

    The reader’s battery level, represented as a boxed float in the range [0, 1]. +If the reader does not have a battery, or the battery level is unknown, this +value is nil.

    + +

    (Bluetooth readers only.)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nullable) NSNumber *batteryLevel;
    + +
    +
    +

    Swift

    + 
    var batteryLevel: NSNumber? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + batteryStatus + +
    +
    +
    +
    +
    +
    +

    The reader’s battery status. Usable as a general classification for the current +battery state.

    + +

    (Bluetooth readers only.)

    +
    +

    See

    + SCPBatteryStatus + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly) SCPBatteryStatus batteryStatus;
    + +
    +
    +

    Swift

    + 
    var batteryStatus: BatteryStatus { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + isCharging + +
    +
    +
    +
    +
    +
    +

    The reader’s charging state, represented as a BOOL +If the reader does not have a battery, or the battery level is unknown, this +value is nil.

    + +

    (Bluetooth readers only.)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nullable) NSNumber *isCharging;
    + +
    +
    +

    Swift

    + 
    var isCharging: NSNumber? { get }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Internet Reader Properties +

+
+
+
    +
  • +
    + + + + ipAddress + +
    +
    +
    +
    +
    +
    +

    The IP address of the reader.

    + +

    (Internet readers only.)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *ipAddress;
    + +
    +
    +

    Swift

    + 
    var ipAddress: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    The networking status of the reader: either offline or online. Note that +non-Internet readers status will always be offline.

    + +

    (Internet readers only).

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPReaderNetworkStatus status;
    + +
    +
    +

    Swift

    + 
    var status: ReaderNetworkStatus { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + label + +
    +
    +
    +
    +
    +
    +

    A custom label that may be given to a reader for easier identification.

    + +

    (Internet readers only.)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *label;
    + +
    +
    +

    Swift

    + 
    var label: String? { get }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPReaderSoftwareUpdate.html b/docs/2.19.0/Classes/SCPReaderSoftwareUpdate.html new file mode 100644 index 00000000..c77821cb --- /dev/null +++ b/docs/2.19.0/Classes/SCPReaderSoftwareUpdate.html @@ -0,0 +1,681 @@ + + + + SCPReaderSoftwareUpdate Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPReaderSoftwareUpdate Class Reference +

+ +
+ +
+ +
+
+

SCPReaderSoftwareUpdate

+
+
+

Objective-C

+ 

+@interface SCPReaderSoftwareUpdate : NSObject
+ +
+
+

Swift

+ 
class ReaderSoftwareUpdate : NSObject
+ +
+
+

An object representing a reader update.

+
+

See

+ https://stripe.com/docs/terminal/readers/bbpos-chipper2xbt#reader-software-releases + +
+

See

+ https://stripe.com/docs/terminal/readers/bbpos-wisepad3#reader-software-releases + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + estimatedUpdateTime + +
    +
    +
    +
    +
    +
    +

    The estimated amount of time for the update.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPUpdateTimeEstimate estimatedUpdateTime;
    + +
    +
    +

    Swift

    + 
    var estimatedUpdateTime: UpdateTimeEstimate { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + deviceSoftwareVersion + +
    +
    +
    +
    +
    +
    +

    The target version for the update.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull deviceSoftwareVersion;
    + +
    +
    +

    Swift

    + 
    var deviceSoftwareVersion: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + components + +
    +
    +
    +
    +
    +
    +

    The components that will be installed in this update.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPUpdateComponent components;
    + +
    +
    +

    Swift

    + 
    var components: UpdateComponent { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + requiredAt + +
    +
    +
    +
    +
    +
    +

    The date at which this update will be required to be installed. If this date +is in the past, the SDK will automatically update the reader upon connection. +The reader will not be able to transact until the update is complete.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers/bbpos-wisepad3#updating-reader-software + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSDate *_Nonnull requiredAt;
    + +
    +
    +

    Swift

    + 
    var requiredAt: Date { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns an unlocalized string for the given update time estimate.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSString *)stringFromUpdateTimeEstimate:
+    (SCPUpdateTimeEstimate)estimate;
    + +
    +
    +

    Swift

    + 
    class func string(from estimate: UpdateTimeEstimate) -> String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPReceiptDetails.html b/docs/2.19.0/Classes/SCPReceiptDetails.html new file mode 100644 index 00000000..ecc9a2d0 --- /dev/null +++ b/docs/2.19.0/Classes/SCPReceiptDetails.html @@ -0,0 +1,765 @@ + + + + SCPReceiptDetails Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPReceiptDetails Class Reference +

+ +
+ +
+ +
+
+

SCPReceiptDetails

+
+
+

Objective-C

+ 

+@interface SCPReceiptDetails : NSObject <SCPJSONDecodable, NSCopying>
+ +
+
+

Swift

+ 
class ReceiptDetails : NSObject, JSONDecodable, NSCopying
+ +
+
+

Receipt details associated with a card present transaction.

+
+

See

+ https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-receipt + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + accountType + +
    +
    +
    +
    +
    +
    +

    The type of account being debited or credited

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *accountType;
    + +
    +
    +

    Swift

    + 
    var accountType: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Also known as “Application Name”. Required on EMV receipts.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull applicationPreferredName;
    + +
    +
    +

    Swift

    + 
    var applicationPreferredName: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + dedicatedFileName + +
    +
    +
    +
    +
    +
    +

    Also known as “AID”. Required on EMV receipts.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull dedicatedFileName;
    + +
    +
    +

    Swift

    + 
    var dedicatedFileName: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + authorizationCode + +
    +
    +
    +
    +
    +
    +

    Identifier for this transaction

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *authorizationCode;
    + +
    +
    +

    Swift

    + 
    var authorizationCode: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Authorization Response Code

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull authorizationResponseCode;
    + +
    +
    +

    Swift

    + 
    var authorizationResponseCode: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + applicationCryptogram + +
    +
    +
    +
    +
    +
    +

    Application Cryptogram

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull applicationCryptogram;
    + +
    +
    +

    Swift

    + 
    var applicationCryptogram: String { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    TVR

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull terminalVerificationResults;
    + +
    +
    +

    Swift

    + 
    var terminalVerificationResults: String { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    TSI

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull transactionStatusInformation;
    + +
    +
    +

    Swift

    + 
    var transactionStatusInformation: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPRefund.html b/docs/2.19.0/Classes/SCPRefund.html new file mode 100644 index 00000000..9ac10c01 --- /dev/null +++ b/docs/2.19.0/Classes/SCPRefund.html @@ -0,0 +1,853 @@ + + + + SCPRefund Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPRefund Class Reference +

+ +
+ +
+ +
+
+

SCPRefund

+
+
+

Objective-C

+ 

+@interface SCPRefund : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class Refund : NSObject, JSONDecodable
+ +
+
+

An object representing a Stripe refund.

+ +

Some payment methods, like Interac Debit payments, require that in-person payments +also be refunded while the cardholder is present. The cardholder must present +the Interac card to the card reader; these payments cannot be refunded via the +dashboard or the API.

+
+

See

+ https://stripe.com/docs/terminal/canada#interac-refunds + +
+ +

The collectRefundPaymentMethod:completion and processRefund SDK methods +allow you to build an in-person refund interface into your app.

+ +

The refund SDK methods and the SCPRefund class are only available for +payment methods that require in-person refunds, such as Interac Debit. For +all other refunds, use the Stripe Dashboard or the Stripe API.

+
+

See

+ https://stripe.com/docs/api#refunds + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + stripeId + +
    +
    +
    +
    +
    +
    +

    The unique identifier for the refund.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull stripeId;
    + +
    +
    +

    Swift

    + 
    var stripeId: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    The amount that was refunded.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSUInteger amount;
    + +
    +
    +

    Swift

    + 
    var amount: UInt { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + charge + +
    +
    +
    +
    +
    +
    +

    The ID of the charge that was refunded

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull charge;
    + +
    +
    +

    Swift

    + 
    var charge: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + created + +
    +
    +
    +
    +
    +
    +

    When the refund object was created.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSDate *_Nonnull created;
    + +
    +
    +

    Swift

    + 
    var created: Date { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    The currency of the amount refunded.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull currency;
    + +
    +
    +

    Swift

    + 
    var currency: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Metadata associated with the refund.

    +
    +

    See

    + https://stripe.com/docs/api#metadata + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSDictionary<NSString *, NSString *> *_Nonnull metadata;
    + +
    +
    +

    Swift

    + 
    var metadata: [String : String] { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + reason + +
    +
    +
    +
    +
    +
    +

    Reason for the refund, either user-provided (duplicate, fraudulent, or +requested_by_customer) or generated by Stripe internally +(expired_uncaptured_charge).

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *reason;
    + +
    +
    +

    Swift

    + 
    var reason: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    The status of the refund.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPRefundStatus status;
    + +
    +
    +

    Swift

    + 
    var status: RefundStatus { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentMethodDetails + +
    +
    +
    +
    +
    +
    +

    The payment method details associated with the refund.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPPaymentMethodDetails *paymentMethodDetails;
    + +
    +
    +

    Swift

    + 
    var paymentMethodDetails: SCPPaymentMethodDetails? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + failureReason + +
    +
    +
    +
    +
    +
    +

    If the refund failed, the reason for refund failure if known.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *failureReason;
    + +
    +
    +

    Swift

    + 
    var failureReason: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPRefundParameters.html b/docs/2.19.0/Classes/SCPRefundParameters.html new file mode 100644 index 00000000..3336fc40 --- /dev/null +++ b/docs/2.19.0/Classes/SCPRefundParameters.html @@ -0,0 +1,817 @@ + + + + SCPRefundParameters Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPRefundParameters Class Reference +

+ +
+ +
+ +
+
+

SCPRefundParameters

+
+
+

Objective-C

+ 

+@interface SCPRefundParameters : NSObject
+ +
+
+

Swift

+ 
class RefundParameters : NSObject
+ +
+
+

Parameters for creating an SCPRefund.

+
+

See

+ https://stripe.com/docs/api/refunds/create + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + chargeId + +
    +
    +
    +
    +
    +
    +

    The ID of the charge to be refunded.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *chargeId;
    + +
    +
    +

    Swift

    + 
    var chargeId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    The amount of the refund, provided in the currency’s smallest unit.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSUInteger amount;
    + +
    +
    +

    Swift

    + 
    var amount: UInt { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    Three-letter ISO currency code. Must be a supported currency.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull currency;
    + +
    +
    +

    Swift

    + 
    var currency: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Set of key-value pairs that you can attach to an object. This can be useful for +storing additional information about the object in a structured format.

    +
    +

    Note

    +

    The metadata property is not set when issuing refunds with the Verifone P400 reader.

    + +
    +

    See

    +

    https://stripe.com/docs/api#metadata

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSDictionary<NSString *, NSString *> *metadata;
    + +
    +
    +

    Swift

    + 
    var metadata: [String : String]? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + reverseTransfer + +
    +
    +
    +
    +
    +
    +

    Connect only: Nullable boolean indicating whether the transfer should be +reversed when refunding this charge. The transfer will be reversed proportionally +to the amount being refunded (either the entire or partial amount).

    +
    +

    Note

    +

    This property is a nullable NSNumber being used to represent a nullable +boolean. A value of 0 represents false, while any non-zero value represents +true.

    + +
    +

    See

    +

    https://stripe.com/docs/api/refunds/create#create_refund-reverse_transfer

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, nullable) NSNumber *reverseTransfer;
    + +
    +
    +

    Swift

    + 
    var reverseTransfer: NSNumber? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + refundApplicationFee + +
    +
    +
    +
    +
    +
    +

    Connect only: Nullable boolean indicating whether the application fee should be +refunded when refunding this charge. If a full charge refund is given, the +full application fee will be refunded. Otherwise, the application fee will be +refunded in an amount proportional to the amount of the charge refunded.

    +
    +

    Note

    +

    This property is a nullable NSNumber being used to represent a nullable +boolean. A value of 0 represents false, while any non-zero value represents +true.

    + +
    +

    See

    +

    https://stripe.com/docs/api/refunds/create#create_refund-refund_application_fee

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, nullable) NSNumber *refundApplicationFee;
    + +
    +
    +

    Swift

    + 
    var refundApplicationFee: NSNumber? { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes SCPRefundParameters with the given charge, amount, and currency.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithChargeId:(nonnull NSString *)chargeId
+                                  amount:(NSUInteger)amount
+                                currency:(nonnull NSString *)currency;
    + +
    +
    +

    Swift

    + 
    init(chargeId: String, amount: UInt, currency: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + chargeId + + +
    +

    The ID of the charge to be refunded.

    +
    +
    + + amount + + +
    +

    The amount to be refunded, provided in the currency’s +smallest unit.

    +
    +
    + + currency + + +
    +

    The currency of the original charge. You cannot refund a charge +with a different currency than the currency that was used to create the charge.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithChargeId:amount:currency:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithChargeId:amount:currency:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPSetupAttempt.html b/docs/2.19.0/Classes/SCPSetupAttempt.html new file mode 100644 index 00000000..5d2a7650 --- /dev/null +++ b/docs/2.19.0/Classes/SCPSetupAttempt.html @@ -0,0 +1,739 @@ + + + + SCPSetupAttempt Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPSetupAttempt Class Reference +

+ +
+ +
+ +
+
+

SCPSetupAttempt

+
+
+

Objective-C

+ 

+@interface SCPSetupAttempt : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class SetupAttempt : NSObject, JSONDecodable
+ +
+
+

A SetupAttempt describes one attempted confirmation of a SetupIntent, +whether that confirmation was successful or unsuccessful. You can use +SetupAttempts to inspect details of a specific attempt at setting up a +payment method using a SetupIntent.

+
+

See

+ https://stripe.com/docs/api/setup_attempts + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + application + +
    +
    +
    +
    +
    +
    +

    The ID of the Connect application that created the SetupIntent.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *application;
    + +
    +
    +

    Swift

    + 
    var application: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + created + +
    +
    +
    +
    +
    +
    +

    Time at which the object was created.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSDate *_Nonnull created;
    + +
    +
    +

    Swift

    + 
    var created: Date { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + customer + +
    +
    +
    +
    +
    +
    +

    ID of the Customer this SetupIntent belongs to, if one exists.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *customer;
    + +
    +
    +

    Swift

    + 
    var customer: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + onBehalfOf + +
    +
    +
    +
    +
    +
    +

    (Connect) The account (if any) for which the setup is intended.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *onBehalfOf;
    + +
    +
    +

    Swift

    + 
    var onBehalfOf: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentMethod + +
    +
    +
    +
    +
    +
    +

    ID of the payment method used with this SetupAttempt.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *paymentMethod;
    + +
    +
    +

    Swift

    + 
    var paymentMethod: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentMethodDetails + +
    +
    +
    +
    +
    +
    +

    Details about the payment method at the time of SetupIntent confirmation.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPSetupAttemptPaymentMethodDetails *paymentMethodDetails;
    + +
    +
    +

    Swift

    + 
    var paymentMethodDetails: SCPSetupAttemptPaymentMethodDetails? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + setupIntent + +
    +
    +
    +
    +
    +
    +

    ID of the SetupIntent that this attempt belongs to.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull setupIntent;
    + +
    +
    +

    Swift

    + 
    var setupIntent: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    The status of this SetupAttempt. One of: requires_confirmation, +requires_action, processing, succeeded, failed, or abandoned.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull status;
    + +
    +
    +

    Swift

    + 
    var status: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + stripeId + +
    +
    +
    +
    +
    +
    +

    The unique identifier for the SetupAttempt.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull stripeId;
    + +
    +
    +

    Swift

    + 
    var stripeId: String { get }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPSetupAttemptCardPresentDetails.html b/docs/2.19.0/Classes/SCPSetupAttemptCardPresentDetails.html new file mode 100644 index 00000000..3ed97167 --- /dev/null +++ b/docs/2.19.0/Classes/SCPSetupAttemptCardPresentDetails.html @@ -0,0 +1,574 @@ + + + + SCPSetupAttemptCardPresentDetails Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPSetupAttemptCardPresentDetails Class Reference +

+ +
+ +
+ +
+
+

SCPSetupAttemptCardPresentDetails

+
+
+

Objective-C

+ 

+@interface SCPSetupAttemptCardPresentDetails : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class SetupAttemptCardPresentDetails : NSObject, JSONDecodable
+ +
+
+

An object representing details from a transaction using a card_present +payment method.

+
+

See

+ https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + generatedCard + +
    +
    +
    +
    +
    +
    +

    The ID of the Card PaymentMethod which was generated by this SetupAttempt.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull generatedCard;
    + +
    +
    +

    Swift

    + 
    var generatedCard: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + emvAuthData + +
    +
    +
    +
    +
    +
    +

    The Authorization Response Cryptogram (ARPC) from the issuer.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull emvAuthData;
    + +
    +
    +

    Swift

    + 
    var emvAuthData: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPSetupAttemptPaymentMethodDetails.html b/docs/2.19.0/Classes/SCPSetupAttemptPaymentMethodDetails.html new file mode 100644 index 00000000..2c61e973 --- /dev/null +++ b/docs/2.19.0/Classes/SCPSetupAttemptPaymentMethodDetails.html @@ -0,0 +1,583 @@ + + + + SCPSetupAttemptPaymentMethodDetails Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPSetupAttemptPaymentMethodDetails Class Reference +

+ +
+ +
+ +
+
+

SCPSetupAttemptPaymentMethodDetails

+
+
+

Objective-C

+ 

+@interface SCPSetupAttemptPaymentMethodDetails : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class SetupAttemptPaymentMethodDetails : NSObject, JSONDecodable
+ +
+
+

Details about a PaymentMethod at a specific time. ex: at time of transaction +for a SetupAttempt.

+
+

See

+ https://stripe.com/docs/api/setup_attempts/object#setup_attempt_object-payment_method_details + +
+ +

Unlike an SCPPaymentMethod, the details object does not have a stripeId, +and only exists as a sub-object of another Stripe object.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    The type of the PaymentMethod. The corresponding, similarly named property +contains additional information specific to the PaymentMethod type. +e.g. if the type is SCPPaymentMethodTypeCardPresent, the cardPresent +property is also populated.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPPaymentMethodType type;
    + +
    +
    +

    Swift

    + 
    var type: PaymentMethodType { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardPresent + +
    +
    +
    +
    +
    +
    +

    If this is a card present payment method (ie self.type == SCPPaymentMethodTypeCardPresent), +this contains additional information.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPSetupAttemptCardPresentDetails *cardPresent;
    + +
    +
    +

    Swift

    + 
    var cardPresent: SCPSetupAttemptCardPresentDetails? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + interacPresent + +
    +
    +
    +
    +
    +
    +

    If this is a card present payment method (ie self.type == SCPPaymentMethodTypeInteracPresent), +this contains additional information.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPSetupAttemptCardPresentDetails *interacPresent;
    + +
    +
    +

    Swift

    + 
    var interacPresent: SCPSetupAttemptCardPresentDetails? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPSetupIntent.html b/docs/2.19.0/Classes/SCPSetupIntent.html new file mode 100644 index 00000000..f265e94b --- /dev/null +++ b/docs/2.19.0/Classes/SCPSetupIntent.html @@ -0,0 +1,744 @@ + + + + SCPSetupIntent Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPSetupIntent Class Reference +

+ +
+ +
+ +
+
+

SCPSetupIntent

+
+
+

Objective-C

+ 

+@interface SCPSetupIntent : NSObject <SCPJSONDecodable, NSCopying>
+ +
+
+

Swift

+ 
class SetupIntent : NSObject, JSONDecodable, NSCopying
+ +
+
+

A SetupIntent guides you through the process of setting up and saving a +customer’s payment credentials for future payments. For example, you could use +a SetupIntent to set up and save your customer’s card without immediately +collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

+
+

See

+ https://stripe.com/docs/api/setup_intents + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + stripeId + +
    +
    +
    +
    +
    +
    +

    The unique identifier for the intent.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull stripeId;
    + +
    +
    +

    Swift

    + 
    var stripeId: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + created + +
    +
    +
    +
    +
    +
    +

    When the intent was created.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSDate *_Nonnull created;
    + +
    +
    +

    Swift

    + 
    var created: Date { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + customer + +
    +
    +
    +
    +
    +
    +

    The identifier of a customer object to which the SetupIntent is attached, if applicable.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *customer;
    + +
    +
    +

    Swift

    + 
    var customer: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Set of key-value pairs attached to the object.

    +
    +

    See

    + https://stripe.com/docs/api#metadata + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSDictionary<NSString *, NSString *> *metadata;
    + +
    +
    +

    Swift

    + 
    var metadata: [String : String]? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + usage + +
    +
    +
    +
    +
    +
    +

    An SCPSetupIntentUsage value describing how the SetupIntent will be used. +Defaults to off-session if not set.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPSetupIntentUsage usage;
    + +
    +
    +

    Swift

    + 
    var usage: SetupIntentUsage { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    The status of the intent.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPSetupIntentStatus status;
    + +
    +
    +

    Swift

    + 
    var status: SetupIntentStatus { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + latestAttempt + +
    +
    +
    +
    +
    +
    +

    The most recent SetupAttempt for this SetupIntent

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPSetupAttempt *latestAttempt;
    + +
    +
    +

    Swift

    + 
    var latestAttempt: SCPSetupAttempt? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class. You should only use SetupIntents +that have been returned by other methods in our SDK.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class. You should only use SetupIntents +that have been returned by other methods in our SDK.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPSetupIntentParameters.html b/docs/2.19.0/Classes/SCPSetupIntentParameters.html new file mode 100644 index 00000000..9b5e65b8 --- /dev/null +++ b/docs/2.19.0/Classes/SCPSetupIntentParameters.html @@ -0,0 +1,769 @@ + + + + SCPSetupIntentParameters Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPSetupIntentParameters Class Reference +

+ +
+ +
+ +
+
+

SCPSetupIntentParameters

+
+
+

Objective-C

+ 

+@interface SCPSetupIntentParameters : NSObject
+ +
+
+

Swift

+ 
class SetupIntentParameters : NSObject
+ +
+
+

Parameters for creating an SCPSetupIntent.

+
+

See

+ https://stripe.com/docs/api/setup_intents/create + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + customer + +
    +
    +
    +
    +
    +
    +

    ID of the customer this SetupIntent belongs to, if one exists.

    + +

    If present, the SetupIntent’s payment method will be attached to the Customer +on successful setup. Payment methods attached to other Customers cannot be +used with this SetupIntent.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *customer;
    + +
    +
    +

    Swift

    + 
    var customer: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + stripeDescription + +
    +
    +
    +
    +
    +
    +

    An arbitrary string attached to the object. Often useful for displaying to users.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *stripeDescription;
    + +
    +
    +

    Swift

    + 
    var stripeDescription: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Set of key-value pairs that you can attach to an object. This can be useful for +storing additional information about the object in a structured format.

    +
    +

    See

    + https://stripe.com/docs/api#metadata + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSDictionary<NSString *, NSString *> *metadata;
    + +
    +
    +

    Swift

    + 
    var metadata: [String : String]? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + usage + +
    +
    +
    +
    +
    +
    +

    Indicates how the payment method is intended to be used in the future. If not +provided, this value defaults to SCPSetupIntentUsageOffSession.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) SCPSetupIntentUsage usage;
    + +
    +
    +

    Swift

    + 
    var usage: SetupIntentUsage { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + onBehalfOf + +
    +
    +
    +
    +
    +
    +

    Connect Only:** The Stripe account ID for which this SetupIntent is created.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *onBehalfOf;
    + +
    +
    +

    Swift

    + 
    var onBehalfOf: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -initWithCustomer: + +
    +
    +
    +
    +
    +
    +

    Initializes SCPSetupIntentParameters with the given customer ID.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithCustomer:(NSString *_Nullable)customerId;
    + +
    +
    +

    Swift

    + 
    init(customer customerId: String?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + customerId + + +
    +

    ID of the customer this SetupIntent belongs to, if one exists. +Stripe will attach this SetupIntent to the customer on successful creation.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithCustomer:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithCustomer:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + description + +
    +
    +
    +
    +
    +
    +

    Deprecated

    +

    Did you mean to use stripeDescription?

    + +
    +
    +

    Use stripeDescription for the string attached to the object.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly) DEPRECATED_MSG_ATTRIBUTE("Did you mean to use stripeDescription?") NSString *description;
    + +
    +
    +

    Swift

    + 
    var description: String { get }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPSimulatedCard.html b/docs/2.19.0/Classes/SCPSimulatedCard.html new file mode 100644 index 00000000..c048b926 --- /dev/null +++ b/docs/2.19.0/Classes/SCPSimulatedCard.html @@ -0,0 +1,657 @@ + + + + SCPSimulatedCard Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPSimulatedCard Class Reference +

+ +
+ +
+ +
+
+

SCPSimulatedCard

+
+
+

Objective-C

+ 

+@interface SCPSimulatedCard : NSObject
+ +
+
+

Swift

+ 
class SimulatedCard : NSObject
+ +
+
+

Simulated Card objects can be used with the shared SCPSimulatorConfiguration +to simulate different card brand and error cases with a simulated Reader.

+ +

Simulated Card objects are backed by one of Stripe’s test card numbers, which +are hardcoded to provide certain behavior within Stripe’s backend. The +Terminal SDK provides an SCPSimulatedCardType enum that automatically maps +to the card numbers for convenience.

+
+

See

+ https://stripe.com/docs/terminal/testing#simulated-test-cards + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + -initWithType: + +
    +
    +
    +
    +
    +
    +

    Create a Simulated Card object with a given simulated card type.

    +
    +

    See

    + SCPSimulatedCardType + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithType:(SCPSimulatedCardType)type;
    + +
    +
    +

    Swift

    + 
    init(type: SimulatedCardType)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Create a Simulated Card object with a raw card number. This initializer is +made available in case Stripe creates a new test card number without creating a +corresponding SCPSimulatedCardType. The card number entered here must +be in the list of test card numbers.

    +
    +

    See

    + https://stripe.com/docs/terminal/testing#simulated-test-cards + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithTestCardNumber:
+    (nonnull NSString *)testCardNumber;
    + +
    +
    +

    Swift

    + 
    init(testCardNumber: String)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot instantiate this class without specifying a type or testcard number.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -isOnlinePin + +
    +
    +
    +
    +
    +
    +

    Returns true if the card is online pin enabled.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (BOOL)isOnlinePin;
    + +
    +
    +

    Swift

    + 
    func isOnlinePin() -> Bool
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -isOfflinePin + +
    +
    +
    +
    +
    +
    +

    Returns true if the card is offline pin enabled.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (BOOL)isOfflinePin;
    + +
    +
    +

    Swift

    + 
    func isOfflinePin() -> Bool
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot instantiate this class without specifying a type or testcard number.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPSimulatorConfiguration.html b/docs/2.19.0/Classes/SCPSimulatorConfiguration.html new file mode 100644 index 00000000..5de8a38b --- /dev/null +++ b/docs/2.19.0/Classes/SCPSimulatorConfiguration.html @@ -0,0 +1,625 @@ + + + + SCPSimulatorConfiguration Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPSimulatorConfiguration Class Reference +

+ +
+ +
+ +
+
+

SCPSimulatorConfiguration

+
+
+

Objective-C

+ 

+@interface SCPSimulatorConfiguration : NSObject
+ +
+
+

Swift

+ 
class SimulatorConfiguration : NSObject
+ +
+
+

Simulator specific configurations you can set to test your integration’s +behavior in different scenarios. We recommend changing these properties during +testing to ensure your app works as expected for different reader updates +and for different presented cards.

+ +

Do not create new instances of this class. Instead, set the properties via +SCPTerminal.shared.simulatorConfiguration.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + availableReaderUpdate + +
    +
    +
    +
    +
    +
    +

    Set this to different values of the SCPSimulateReaderUpdate enum to +test your integration with different reader software update scenarios.

    +
    +

    Note

    + This is only valid for simulated Bluetooth readers. + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) SCPSimulateReaderUpdate availableReaderUpdate;
    + +
    +
    +

    Swift

    + 
    var availableReaderUpdate: SimulateReaderUpdate { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + simulatedCard + +
    +
    +
    +
    +
    +
    +

    Create a SCPSimulatedCard and set it on the shared configuration object to +test your integration with different card brands and in error scenarios.

    +
    +

    Note

    +

    Simulated Internet reader refunds do not use the specified simulated card.

    + +
    +

    See

    +

    https://stripe.com/docs/terminal/testing#simulated-test-cards

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) SCPSimulatedCard *_Nonnull simulatedCard;
    + +
    +
    +

    Swift

    + 
    var simulatedCard: SimulatedCard { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + simulatedTipAmount + +
    +
    +
    +
    +
    +
    +

    Set this to simulate a Terminal configuration object with this fixed tip +amount for all currencies.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, nullable) NSNumber *simulatedTipAmount;
    + +
    +
    +

    Swift

    + 
    var simulatedTipAmount: NSNumber? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class. +Set exposed properties via SCPTerminal.shared.simulatorConfiguration

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class. +Set exposed properties via SCPTerminal.shared.simulatorConfiguration

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPTerminal.html b/docs/2.19.0/Classes/SCPTerminal.html new file mode 100644 index 00000000..2774e155 --- /dev/null +++ b/docs/2.19.0/Classes/SCPTerminal.html @@ -0,0 +1,3387 @@ + + + + SCPTerminal Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPTerminal Class Reference +

+ +
+ +
+ +
+
+

SCPTerminal

+
+
+

Objective-C

+ 

+@interface SCPTerminal : NSObject
+ +
+
+

Swift

+ 
class Terminal : NSObject
+ +
+
+

The SCPTerminal singleton object exposes an interface for discovering readers, +connecting to a reader, creating payments, and saving card information for later +use.

+ +

Before accessing the singleton object using the shared property, you must set +a ConnectionToken provider: an object that implements the SCPConnectionTokenProvider +protocol. This object should authenticate with your backend, then fetch the secret +from a freshly minted ConnectionToken.

+ +

The SCPTerminal singleton can only be connected to one reader at a time, and +can only perform one operation at a time. As a general rule, make sure the +completion handler of one operation has been called before calling another +operation from within your app.

+ +

The Stripe Terminal SDK sends updates to your app by using the delegate pattern. +You may want multiple views in your app to respond to these delegate calls. +We recommend creating a central delegate announcer which broadcasts all delegate +calls to views and ViewControllers that register themselves with that announcer. +We have an example implementation of a TerminalDelegateAnnouncer as part of our +example application.

+ +
+
+ +
+
+
+
+ + +
+ +

Initializing and accessing the SCPTerminal singleton +

+
+
+
    +
  • +
    + + + + +setTokenProvider: + +
    +
    +
    +
    +
    +
    +

    Sets the token provider for the shared (singleton) SCPTerminal instance.

    + +

    You must set a token provider before calling shared to initialize the +Terminal singleton. We recommend calling setTokenProvider: in your +AppDelegate’s application:didFinishLaunchingWithOptions: method. +Alternatively, you can wrap your call to setTokenProvider: with a +dispatch_once in Objective-C, or use a static constructor in Swift.

    + +

    Note that you may only set a token provider before requesting the shared +Terminal instance for the first time. In order to switch accounts in your app, +e.g. to switch between live and test Stripe API keys on your backend, refer +to the documentation for the clearCachedCredentials method on the shared +Terminal instance.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (void)setTokenProvider:(nonnull id<SCPConnectionTokenProvider>)tokenProvider;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +hasTokenProvider + +
    +
    +
    +
    +
    +
    +

    Returns true if a token provider has been set, through setTokenProvider:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (BOOL)hasTokenProvider;
    + +
    +
    +

    Swift

    + 
    class func hasTokenProvider() -> Bool
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +setLogListener: + +
    +
    +
    +
    +
    +
    +

    Sets a block to listen for logs from the shared Terminal instance (optional).

    + +

    You can use this optional method to listen for logs from the Stripe Terminal +SDK and incorporate them into your own remote logs. Note that these logs +are subject to change, and provided for informational and debugging purposes +only. You should not depend on them for behavior in your app. Also note that +the block you provide may be called from any thread.

    + +

    To print internal logs from the SDK to the console, you can set logLevel to +SCPLogLevelVerbose on the Terminal instance.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (void)setLogListener:(nonnull SCPLogListenerBlock)listener;
    + +
    +
    +

    Swift

    + 
    class func setLogListener(_ listener: @escaping LogListenerBlock)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + shared + +
    +
    +
    +
    +
    +
    +

    Returns the shared (singleton) Terminal instance.

    + +

    Before accessing the singleton for the first time, you must first call +setTokenProvider:.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (class, nonatomic, readonly) SCPTerminal *_Nonnull shared;
    + +
    +
    +

    Swift

    + 
    class var shared: Terminal { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + delegate + +
    +
    +
    +
    +
    +
    +

    The Terminal singleton object’s primary delegate. This delegate announces +connection and payment status updates to your app.

    + +

    Setting this property is mandatory before connecting to a Bluetooth reader, +like the BBPOS Chipper 2X BT or the BBPOS WisePad 3. Setting this property +is optional before connecting to an internet reader, like the Verifone P400.

    + +

    A runtime assert will fire if your app attempts to connect to a reader that +requires the delegate.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, nullable) id<SCPTerminalDelegate> delegate;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Accessing the current state of the singleton +

+
+
+
    +
  • +
    + + + + connectedReader + +
    +
    +
    +
    +
    +
    +

    Information about the connected SCPReader, or nil if no reader is connected.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPReader *connectedReader;
    + +
    +
    +

    Swift

    + 
    var connectedReader: SCPReader? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + connectionStatus + +
    +
    +
    +
    +
    +
    +

    The Terminal instance’s current connection status.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPConnectionStatus connectionStatus;
    + +
    +
    +

    Swift

    + 
    var connectionStatus: ConnectionStatus { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + logLevel + +
    +
    +
    +
    +
    +
    +

    The log level for the SDK. The default value is .none.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) SCPLogLevel logLevel;
    + +
    +
    +

    Swift

    + 
    var logLevel: LogLevel { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The simulator configuration settings that will be used when connecting to +and creating payments with a simulated reader. This object will always exist; +to set the configuration settings, set the readwrite properties on +Terminal.shared.simulatorConfiguration.

    +
    +

    See

    + SCPSimulatorConfiguration + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPSimulatorConfiguration *_Nonnull simulatorConfiguration;
    + +
    +
    +

    Swift

    + 
    var simulatorConfiguration: SimulatorConfiguration { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentStatus + +
    +
    +
    +
    +
    +
    +

    The Terminal instance’s current payment status.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPPaymentStatus paymentStatus;
    + +
    +
    +

    Swift

    + 
    var paymentStatus: PaymentStatus { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Clears the current connection token, saved reader sessions, and any other +cached credentials. You can use this method to switch accounts in your app, +e.g. to switch between live and test Stripe API keys on your backend.

    + +

    In order to switch accounts in your app:

    + +
      +
    • if a reader is connected, call disconnectReader:
      • +
    • configure the tokenProvider object to return connection tokens for the new account. +The tokenProvider is implemented by your code, and you can do this however you want.
      • +
    • call clearCachedCredentials
      • +
    • call discoverReaders and connectReader to connect to a reader. The connect call +will request a new connection token from your backend server via the token provider.
      • +
    + +

    An overview of the lifecycle of a connection token under the hood:

    + +
      +
    • When the Terminal singleton is initialized, the SDK attempts to proactively request +a connection token from your backend server.
      • +
    • When connect is called, the SDK uses the connection token and reader +information to create a reader session.
      • +
    • Subsequent calls to connect will re-use the reader session if the SDK +has successfully connected to the reader already. Otherwise, it will require a +new connection token when you call connect again.
      • +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)clearCachedCredentials;
    + +
    +
    +

    Swift

    + 
    func clearCachedCredentials()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Reader discovery, connection, and updates +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Use this method to determine whether the mobile device supports a given reader type +using a particular discovery method. This is useful for the Local Mobile reader +discovery method where support will vary according to operating system +and hardware capabilities.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (BOOL)supportsReadersOfType:(SCPDeviceType)deviceType
+              discoveryMethod:(SCPDiscoveryMethod)discoveryMethod
+                    simulated:(BOOL)simulated
+                        error:(NSError *_Nullable *_Nullable)error;
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + deviceType + + +
    +

    Reader device type to determine support for.

    +
    +
    + + discoveryMethod + + +
    +

    Associated discovery method.

    +
    +
    + + simulated + + +
    +

    Determines whether to check for availability of + simulated discovery to discover a device simulator. + The Terminal SDK comes with the ability to simulate behavior + without using physical hardware. This makes it easy to + quickly test your integration end-to-end, + from pairing with a reader to taking payments.

    +
    +
    + + error + + +
    +

    If not supported, an error indicating the reason. +@returns YES if supported, NO otherwise.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Begins discovering readers based on the given discovery configuration.

    + +

    When discoverReaders is called, the terminal begins scanning for readers using +the settings in the given SCPDiscoveryConfiguration. You must implement +SCPDiscoveryDelegate to get notified of discovered readers and display +discovery results to your user.

    + +

    You must call connectBluetoothReader or connectInternetReader while +a discovery is taking place. You can only connect to a reader that was +returned from the SCPDiscoveryDelegate‘s didUpdateDiscoveredReaders method.

    + +

    The discovery process will stop on its own when the terminal successfully +connects to a reader, if the command is canceled, or if a discovery error occurs.

    +
    +

    Note

    +

    If discoverReaders is canceled, the completion block will be called +with nil (rather than an SCPErrorCanceled error).

    + +
    +

    See

    +

    https://stripe.com/docs/terminal/readers/connecting

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable SCPCancelable *)
+    discoverReaders:(nonnull SCPDiscoveryConfiguration *)configuration
+           delegate:(nonnull id<SCPDiscoveryDelegate>)delegate
+         completion:(nonnull SCPErrorCompletionBlock)completion;
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + configuration + + +
    +

    The configuration for reader discovery.

    +
    +
    + + delegate + + +
    +

    Your delegate for reader discovery.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Attempts to connect to the given Bluetooth reader with a given connection +configuration.

    + +

    To connect to a Bluetooth reader, your app must register that reader to a +Location upon connection. +You should create a SCPBluetoothConnectionConfiguration +at some point before connecting which specifies the location to which this +reader belongs.

    + +

    Throughout the lifetime of the connection, the reader will communicate +with your app via the SCPBluetoothReaderDelegate to announce transaction +status, battery level, and software update information.

    + +

    If the connection succeeds, the completion block will be called with the +connected reader, and SCPTerminal.connectionStatus will change to .connected.

    + +

    If the connection fails, the completion block will be called with an error.

    + +

    The SDK must be actively discovering readers in order to connect to one. +The discovery process will stop if this connection request succeeds, otherwise +the SDK will continue discovering.

    + +

    When this method is called, the SDK uses a connection token and the given +reader information to register the reader to your Stripe account. If the SDK +does not already have a connection token, it will call the fetchConnectionToken +method in your SCPConnectionTokenProvider implementation.

    + +

    If the reader’s battery is critically low the connect call will fail with +SCPErrorBluetoothDisconnected. Plug your reader in to start charging and +try again.

    +
    +

    See

    +

    https://stripe.com/docs/terminal/readers/connecting

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)connectBluetoothReader:(nonnull SCPReader *)reader
+                      delegate:(nonnull id<SCPBluetoothReaderDelegate>)delegate
+              connectionConfig:(nonnull SCPBluetoothConnectionConfiguration *)
+                                   connectionConfig
+                    completion:(nonnull SCPReaderCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func connectBluetoothReader(_ reader: SCPReader, delegate: BluetoothReaderDelegate, connectionConfig: SCPBluetoothConnectionConfiguration) async throws -> SCPReader
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + reader + + +
    +

    The reader to connect to. This should be a reader +recently returned to the didUpdateDiscoveredReaders: method in the discovery delegate.

    +
    +
    + + delegate + + +
    +

    The delegate used during the lifetime of the connection. +See SCPBluetoothReaderDelegate.

    +
    +
    + + connectionConfig + + +
    +

    The connection configuration for options while +connecting to a reader. See SCPBluetoothConnectionConfiguration for more details.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Attempts to connect to the given Internet reader with a given connection +configuration.

    + +

    If the connect succeeds, the completion block will be called with the +connected reader, and SCPTerminal.connectionStatus will change to .connected.

    + +

    If the connect fails, the completion block will be called with an error.

    + +

    The SDK must be actively discovering readers in order to connect to one. +The discovery process will stop if this connection request succeeds, otherwise +the SDK will continue discovering.

    + +

    When this method is called, the SDK uses a connection token and the given +reader information to create a reader session. If the SDK does not already +have a connection token, it will call the `fetchConnectionToken method you +defined to fetch one.

    + +

    If connectionConfig is set to nil, the SDK will resort to +default connection behavior; see the SCPInternetConnectionConfiguration +header documentation for more details.

    +
    +

    See

    +

    https://stripe.com/docs/terminal/readers/connecting

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)connectInternetReader:(nonnull SCPReader *)reader
+             connectionConfig:
+                 (nullable SCPInternetConnectionConfiguration *)connectionConfig
+                   completion:(nonnull SCPReaderCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func connectInternetReader(_ reader: SCPReader, connectionConfig: SCPInternetConnectionConfiguration?) async throws -> SCPReader
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + reader + + +
    +

    The reader to connect to. This should be a reader +recently returned to the didUpdateDiscoveredReaders: method in the discovery delegate.

    +
    +
    + + connectionConfig + + +
    +

    The connection configuration for options while +connecting to a reader. See SCPInternetConnectionConfiguration for more details.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Attempts to connect to the given Local Mobile reader with a given + connection configuration.

    + +

    To connect to a Local Mobile reader, your app must register that reader to a + Location upon connection. + You should create a SCPLocalMobileConnectionConfiguration +before connecting which specifies the location to which this + reader belongs.

    + +

    Throughout the lifetime of the connection, the reader will communicate + with your app via the SCPLocalMobileReaderDelegate as appropriate.

    + +

    If the connection succeeds, the completion block will be called with the + connected reader, and SCPTerminal.connectionStatus will change to .connected.

    + +

    If the connection fails, the completion block will be called with an error.

    + +

    The SDK must be actively discovering readers in order to connect to one. + The discovery process will stop if this connection request succeeds, otherwise + the SDK will continue discovering.

    + +

    When this method is called, the SDK uses a connection token and the given + reader information to register the reader to your Stripe account. If the SDK + does not already have a connection token, it will call the fetchConnectionToken + method in your SCPConnectionTokenProvider implementation.

    + +

    Note that during connection, an update may occur to ensure that the + local mobile reader has the most up to date software and configurations.

    +
    +

    See

    +

    https://stripe.com/docs/terminal/readers/connecting

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)
+    connectLocalMobileReader:(nonnull SCPReader *)reader
+                    delegate:(nonnull id<SCPLocalMobileReaderDelegate>)delegate
+            connectionConfig:(nonnull SCPLocalMobileConnectionConfiguration *)
+                                 connectionConfig
+                  completion:(nonnull SCPReaderCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func connectLocalMobileReader(_ reader: SCPReader, delegate: LocalMobileReaderDelegate, connectionConfig: SCPLocalMobileConnectionConfiguration) async throws -> SCPReader
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + reader + + +
    +

    The reader to connect to. This should be a reader + recently returned to the didUpdateDiscoveredReaders: method in + the discovery delegate.

    +
    +
    + + delegate + + +
    +

    The delegate used during the lifetime of the connection. + See SCPLocalMobileReaderDelegate.

    +
    +
    + + connectionConfig + + +
    +

    The connection configuration for options while + connecting to a reader. + See SCPLocalMobileConnectionConfiguration for more details.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Retrieves a list of SCPLocation objects belonging to your merchant. You must specify +the ID of one of these locations to register the reader to while connecting to a Bluetooth reader.

    +
    +

    See

    +

    https://stripe.com/docs/terminal/readers/fleet-management#bluetooth-readers

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)listLocations:(nullable SCPListLocationsParameters *)parameters
+           completion:(nonnull SCPLocationsCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func listLocations(parameters: SCPListLocationsParameters?) async throws -> ([SCPLocation], Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + parameters + + +
    +

    The optional parameters to pass to the List all Locations API endpoint. Pass nil to use the default parameters.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Installs the available update for the connected reader.

    + +

    Stripe Terminal reader updates will either be updated automatically upon connection, +or announced as available but not automatically installed. When the Stripe Terminal +SDK announces an optional update, you can present that update to your app’s user +and let them decide when to perform that update. When your user chooses to perform +a reader update, call this method to start the installation.

    + +

    In your app you should display the progress of the update to the user. +You should also instruct the user to wait for the update to complete: +“Do not leave this page, and keep the reader in range and powered on until +the update is complete.” You can set UIApplication.shared.isIdleTimerDisabled +to true while the update is being installed to prevent the device from automatically +locking.

    + +

    If an error occurs while installing the update (e.g. because the update was +interrupted), the SCPBluetoothReaderDelegate will receive +reader:didFinishInstallingUpdate:error: with the error. If the update +completed successfully, the same method will be called with nil error.

    + +

    You must implement the ability to update your reader’s software in your app. +Though we expect required software updates to be very rare, by using Stripe +Terminal, you are obligated to include this functionality.

    +
    +

    Note

    +

    It is an error to call this method when the SDK is connected to the Verifone +P400 or WisePOS E readers.

    + +
    +

    See

    +

    https://stripe.com/docs/terminal/readers/bbpos-chipper2xbt#updating-reader-software

    + +
    +

    See

    +

    https://stripe.com/docs/terminal/readers/bbpos-wisepad3#updating-reader-software

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)installAvailableUpdate;
    + +
    +
    +

    Swift

    + 
    func installAvailableUpdate()
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -disconnectReader: + +
    +
    +
    +
    +
    +
    +

    Attempts to disconnect from the currently connected reader.

    + +

    If the disconnect succeeds, the completion block is called with nil. If the +disconnect fails, the completion block is called with an error.

    +
    +

    See

    +

    https://stripe.com/docs/terminal/readers/connecting

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)disconnectReader:(nonnull SCPErrorCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func disconnectReader() async throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Taking payments +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Creates a new SCPPaymentIntent with the given parameters.

    + +

    Note: If the information required to create a PaymentIntent isn’t readily +available in your app, you can create the PaymentIntent on your server and use +the retrievePaymentIntent method to retrieve the PaymentIntent in your app.

    +
    - - note: This cannot be used with the Verifone P400. If used with the
+Verifone P400, the completion handler will be called with
+an SCPErrorFeatureNotAvailableWithConnectedReader error.
+
    +
    +

    See

    +

    https://stripe.com/docs/terminal/payments#create

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)createPaymentIntent:(nonnull SCPPaymentIntentParameters *)parameters
+                 completion:(nonnull SCPPaymentIntentCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func createPaymentIntent(_ parameters: PaymentIntentParameters) async throws -> PaymentIntent
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + parameters + + +
    +

    The parameters for the PaymentIntent to be created.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Retrieves a SCPPaymentIntent with a client secret.

    + +

    If the information required to create a PaymentIntent isn’t readily available +in your app, you can create the PaymentIntent on your server and use this +method to retrieve the PaymentIntent in your app.

    +
    +

    See

    +

    https://stripe.com/docs/terminal/payments#create

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)retrievePaymentIntent:(nonnull NSString *)clientSecret
+                   completion:
+                       (nonnull SCPPaymentIntentCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func retrievePaymentIntent(clientSecret: String) async throws -> PaymentIntent
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + clientSecret + + +
    +

    The client secret of the PaymentIntent to be retrieved.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Collects a payment method for the given SCPPaymentIntent.

    + +

    Note: collectPaymentMethod does not apply any changes to the PaymentIntent +API object. Updates to the PaymentIntent are local to the SDK, and persisted +in-memory.

    + +

    If collecting a payment method fails, the completion block will be called with +an error. After resolving the error, you may call collectPaymentMethod again +to either try the same card again, or try a different card.

    + +

    If collecting a payment method succeeds, the completion block will be called +with a PaymentIntent with status .requiresConfirmation, indicating that you +should call processPayment:completion: to finish the payment.

    + +

    Note that if collectPaymentMethod is canceled, the completion block will be +called with a Canceled error.

    +
    +

    See

    +

    https://stripe.com/docs/terminal/payments#collect

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable SCPCancelable *)
+    collectPaymentMethod:(nonnull SCPPaymentIntent *)paymentIntent
+              completion:(nonnull SCPPaymentIntentCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func collectPaymentMethod(_ paymentIntent: PaymentIntent, completion: @escaping PaymentIntentCompletionBlock) -> SCPCancelable?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + paymentIntent + + +
    +

    The PaymentIntent to collect a payment method for.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Collects a payment method for the given PaymentIntent, with the specified configuration.

    + +

    Note: collectPaymentMethod does not apply any changes to the PaymentIntent +API object. Updates to the PaymentIntent are local to the SDK, and persisted +in-memory.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable SCPCancelable *)
+    collectPaymentMethod:(nonnull SCPPaymentIntent *)paymentIntent
+           collectConfig:(nullable SCPCollectConfiguration *)collectConfig
+              completion:(nonnull SCPPaymentIntentCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func collectPaymentMethod(_ paymentIntent: PaymentIntent, collectConfig: CollectConfiguration?, completion: @escaping PaymentIntentCompletionBlock) -> SCPCancelable?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + paymentIntent + + +
    +

    The PaymentIntent to collect a payment method for.

    +
    +
    + + collectConfig + + +
    +

    The CollectConfiguration object that contains settings for this call.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Processes a payment after collecting a payment method succeeds.

    +

    Synchronous capture

    + +

    Stripe Terminal uses two-step card payments to prevent unintended and duplicate +payments. When processPayment completes successfully, a charge has been +authorized on the customer’s card, but not yet been “captured”. Your app must +synchronously notify your backend to capture the PaymentIntent +in order to settle the funds to your account.

    +

    Handling failures

    + +

    When processPayment fails, the SDK returns an error that includes the +updated SCPPaymentIntent. Your app should inspect the updated PaymentIntent +to decide how to retry the payment.

    + +
      +

    1. If the updated PaymentIntent is nil, the request to Stripe’s servers timed +out and the PaymentIntent’s status is unknown. We recommend that you retry +processPayment with the original PaymentIntent. If you instead choose to +abandon the original PaymentIntent and create a new one, do not capture +the original PaymentIntent. If you do, you might charge your customer twice.

      2. +

    2. If the updated PaymentIntent’s status is still .requiresConfirmation (e.g., +the request failed because your app is not connected to the internet), you +can call processPayment again with the updated PaymentIntent to retry +the request.

      3. +

    3. If the updated PaymentIntent’s status changes to .requiresPaymentMethod (e.g., the +request failed because the card was declined), call collectPaymentMethod with the +updated PaymentIntent to try charging another card.

      4. +
    +
    +

    See

    +

    https://stripe.com/docs/terminal/payments#process

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)processPayment:(nonnull SCPPaymentIntent *)paymentIntent
+            completion:(nonnull SCPProcessPaymentCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func processPayment(_ paymentIntent: PaymentIntent) async -> (PaymentIntent?, SCPProcessPaymentError?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + paymentIntent + + +
    +

    The PaymentIntent to confirm.

    +
    +
    + + completion + + +
    +

    The completion block called when the confirm completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Cancels an SCPPaymentIntent.

    + +

    If the cancel request succeeds, the completion block will be called with the +updated PaymentIntent object with status Canceled. If the cancel request +fails, the completion block will be called with an error.

    +
    +

    Note

    +

    This cannot be used with the Verifone P400 reader. If used with the +Verifone P400, the completion handler will be called with +an SCPErrorFeatureNotAvailableWithConnectedReader error.

    + +
    +

    See

    +

    https://stripe.com/docs/terminal/payments/refunds

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)cancelPaymentIntent:(nonnull SCPPaymentIntent *)paymentIntent
+                 completion:(nonnull SCPPaymentIntentCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func cancelPaymentIntent(_ paymentIntent: PaymentIntent) async throws -> PaymentIntent
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + paymentIntent + + +
    +

    The PaymentIntent to cancel.

    +
    +
    + + completion + + +
    +

    The completion block called when the cancel completes.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Saving payment details for later use +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Reads a card with the given parameters and returns a PaymentMethod.

    + +

    NOTE: Most integrations should not use readReusableCard.

    + +

    You should create a SCPPaymentIntent and use the associated collectPaymentMethod +and processPayment methods if you are simply collecting a payment from +a customer.

    + +

    You can use readReusableCard to read payment details and defer payment for later. +The PaymentMethod created by this method will have type card, suitable for +use with online payments.

    + +

    Note that if you use this method to defer a payment, the transaction will +not receive the beneficial rates and liability shift associated with card +present transactions.

    + +

    If reading a card fails, the completion block will be called with an error +containing details about the failure. If reading a card succeeds, the +completion block will be called with a PaymentMethod. You should send +the ID of the payment method to your backend for further processing. For example, +you can use the fingerprint to look up charges created using the same +card.

    +
    +

    Note

    +

    This functionality is only available in the US, with either a +Chipper 2X BT or Verifone P400 reader.

    + +
    +

    See

    +

    https://stripe.com/docs/terminal/online-payments

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable SCPCancelable *)
+    readReusableCard:(nonnull SCPReadReusableCardParameters *)parameters
+          completion:(nonnull SCPPaymentMethodCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func readReusableCard(_ parameters: SCPReadReusableCardParameters, completion: @escaping PaymentMethodCompletionBlock) -> SCPCancelable?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + parameters + + +
    +

    The parameters for reading the card.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a new SCPSetupIntent with the given parameters.

    +
    +

    See

    +

    https://stripe.com/docs/api/setup_intents/create

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)createSetupIntent:(nonnull SCPSetupIntentParameters *)setupIntentParams
+               completion:(nonnull SCPSetupIntentCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func createSetupIntent(_ setupIntentParams: SCPSetupIntentParameters) async throws -> SCPSetupIntent
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + setupIntentParams + + +
    +

    The parameters that control the creation of the SetupIntent.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Retrieves an SCPSetupIntent with a client secret.

    + +

    If you’ve created a SetupIntent on your backend, you must retrieve it in the +Stripe Terminal SDK before calling collectSetupIntentPaymentMethod.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)retrieveSetupIntent:(nonnull NSString *)clientSecret
+                 completion:(nonnull SCPSetupIntentCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func retrieveSetupIntent(clientSecret: String) async throws -> SCPSetupIntent
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + clientSecret + + +
    +

    The client secret of the SetupIntent to be retrieved.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Cancels an SCPPaymentIntent.

    + +

    If the cancel request succeeds, the completion block will be called with the +updated PaymentIntent object with status Canceled. If the cancel request +fails, the completion block will be called with an error.

    +
    +

    See

    +

    https://stripe.com/docs/api/setup_intents/cancel

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)cancelSetupIntent:(nonnull SCPSetupIntent *)intent
+               completion:(nonnull SCPSetupIntentCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func cancelSetupIntent(_ intent: SCPSetupIntent) async throws -> SCPSetupIntent
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + intent + + +
    +

    The SetupIntent to cancel.

    +
    +
    + + completion + + +
    +

    The completion block called when cancellation completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Collects a payment method for the given SCPSetupIntent.

    + +

    This method does not update the SetupIntent API object. All updates are local +to the SDK and only persisted in memory. You must confirm the SetupIntent to +create a PaymentMethod API object and (optionally) attach that PaymentMethod +to a customer.

    + +

    If collecting a payment method fails, the completion block will be called with +an error. After resolving the error, you may call collectSetupIntentPaymentMethod +again to either try the same card again, or try a different card.

    + +

    If collecting a payment method succeeds, the completion block will be called +with a SetupIntent with status .requiresConfirmation, indicating that you +should call confirmSetupIntent:customerConsentCollected:completion: to +finish the payment.

    + +

    Note that if collectSetupIntentPaymentMethod is canceled, the completion +block will be called with a Canceled error.

    + + +

    Card networks require that you collect consent from the customer before saving +and reusing their card information. The SetupIntent confirmation API method +normally takes a mandate_data hash that lets you specify details about the +customer’s consent. The Stripe Terminal SDK will fill in the mandate_data +hash with relevant information, but in order for it to do so, you must specify +whether you have gathered consent from the cardholder to collect their payment +information in this method’s second parameter.

    + +

    The payment method will not be collected without the cardholder’s consent.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable SCPCancelable *)
+    collectSetupIntentPaymentMethod:(nonnull SCPSetupIntent *)setupIntent
+           customerConsentCollected:(BOOL)customerConsentCollected
+                         completion:
+                             (nonnull SCPSetupIntentCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func collectSetupIntentPaymentMethod(_ setupIntent: SCPSetupIntent, customerConsentCollected: Bool, completion: @escaping SetupIntentCompletionBlock) -> SCPCancelable?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + setupIntent + + +
    +

    The SetupIntent to which payment method information is attached.

    +
    +
    + + customerConsentCollected + + +
    +

    A boolean that should be set to true if you +have successfully collected consent from the cardholder to save their payment information.

    +
    +
    + + completion + + +
    +

    The completion block called when collection completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Confirms a SetupIntent after the payment method has been successfully collected.

    +

    Handling failures

    + +

    When confirmSetupIntent fails, the SDK returns an error that includes the +updated SCPSetupIntent. Your app should inspect the updated SetupIntent +to decide how to proceed.

    + +
      +

    1. If the updated SetupIntent is nil, the request to Stripe’s servers timed +out and the SetupIntent’s status is unknown. We recommend that you retry +confirmSetupIntent with the original SetupIntent.

      2. +

    2. If the updated SetupIntent’s status is still .requiresConfirmation (e.g., +the request failed because your app is not connected to the internet), you +can call confirmSetupIntent again with the updated SetupIntent to retry +the request.

      3. +

    3. If the updated SetupIntent’s status is .requiresAction, there might be +authentication the cardholder must perform offline before the saved +PaymentMethod can be used.

      4. +
    +
    +

    See

    +

    https://stripe.com/docs/api/setup_intents/confirm

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)confirmSetupIntent:(nonnull SCPSetupIntent *)setupIntent
+                completion:
+                    (nonnull SCPConfirmSetupIntentCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func confirmSetupIntent(_ setupIntent: SCPSetupIntent) async -> (SCPSetupIntent?, SCPConfirmSetupIntentError?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + setupIntent + + +
    +

    The SetupIntent to confirm

    +
    +
    + + completion + + +
    +

    The completion block called when the confirmation completes

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Card-present refunds +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Initiates an in-person refund with a given set of SCPRefundParameters by +collecting the payment method that is to be refunded.

    + +

    Some payment methods, like Interac Debit payments, require that in-person payments +also be refunded while the cardholder is present. The cardholder must present +the Interac card to the card reader; these payments cannot be refunded via the +dashboard or the API.

    + +

    For payment methods that don’t require the cardholder be present, see +https://stripe.com/docs/terminal/payments/refunds

    + +

    This method, along with processRefund, allow you to design an in-person refund +flow into your app.

    + +

    If collecting a payment method fails, the completion block will be called with +an error. After resolving the error, you may call collectRefundPaymentMethod +again to either try the same card again, or try a different card.

    + +

    If collecting a payment method succeeds, the completion block will be called +with an nil error. At that point, you can call processRefund to finish +refunding the payment method.

    + +

    Calling any other SDK methods between collectRefundPaymentMethod and +processRefund will result in undefined behavior.

    + +

    Note that if collectRefundPaymentMethod is canceled, the completion block +will be called with a Canceled error.

    +
    +

    See

    +

    https://stripe.com/docs/terminal/canada#interac-refunds

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable SCPCancelable *)
+    collectRefundPaymentMethod:(nonnull SCPRefundParameters *)refundParams
+                    completion:(nonnull SCPErrorCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func collectRefundPaymentMethod(_ refundParams: RefundParameters, completion: @escaping ErrorCompletionBlock) -> SCPCancelable?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + refundParams + + +
    +

    The SCPRefundParameters object that describes how the +refund will be created.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + -processRefund: + +
    +
    +
    +
    +
    +
    +

    Processes an in-person refund after the refund payment method has been collected.

    + +

    The completion block will either be called with the successful SCPRefund or +with an SCPProcessRefundError.

    + +

    When processRefund fails, the SDK returns an error that either includes the +failed SCPRefund or the SCPRefundParameters that led to a failure. +Your app should inspect the SCPProcessRefundError to decide how to proceed.

    + +
      +

    1. If the refund property is nil, the request to Stripe’s servers timed +out and the refund’s status is unknown. We recommend that you retry +processRefund with the original SCPRefundParameters.

      2. +

    2. If the SCPProcessRefundError has a failure_reason, the refund was declined. +We recommend that you take action based on the decline code you received.

      3. +
    +
    +

    Note

    +

    collectRefundPaymentMethod:completion and processRefund are only +available for payment methods that require in-person refunds. For all other +refunds, use the Stripe Dashboard or the Stripe API.

    + +
    +

    See

    +

    https://stripe.com/docs/terminal/canada#interac-refunds

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)processRefund:(nonnull SCPProcessRefundCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func processRefund() async -> (SCPRefund?, SCPProcessRefundError?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Displaying information to customers +

+
+
+
    +
  • +
    + + + + -clearReaderDisplay: + +
    +
    +
    +
    +
    +
    +

    Clears the reader display and resets it to the splash screen.

    +
    +

    Note

    +

    Only available for the Verifone P400 and BBPOS WisePOS E.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)clearReaderDisplay:(nonnull SCPErrorCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func clearReaderDisplay() async throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updates the reader display with cart information. +This method is for display purposes only and has no correlation with what the customer is +actually charged. Tax and total are also not automatically calculated and must be set in SCPCart.

    +
    +

    Note

    +

    Only available for the Verifone P400 and BBPOS WisePOS E.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)setReaderDisplay:(nonnull SCPCart *)cart
+              completion:(nonnull SCPErrorCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func setReaderDisplay(_ cart: Cart) async throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + cart + + +
    +

    The cart containing the information that will be displayed.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns an unlocalized string for the given reader input options, e.g. +“Swipe / Insert”

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSString *)stringFromReaderInputOptions:
+    (SCPReaderInputOptions)options;
    + +
    +
    +

    Swift

    + 
    class func stringFromReaderInputOptions(_ options: ReaderInputOptions = []) -> String
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns an unlocalized string for the given reader display message, e.g. +“Retry Card”

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSString *)stringFromReaderDisplayMessage:
+    (SCPReaderDisplayMessage)message;
    + +
    +
    +

    Swift

    + 
    class func stringFromReaderDisplayMessage(_ message: ReaderDisplayMessage) -> String
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns an unlocalized string for the given reader event, e.g. +“Card Inserted”

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSString *)stringFromReaderEvent:(SCPReaderEvent)event;
    + +
    +
    +

    Swift

    + 
    class func stringFromReaderEvent(_ event: ReaderEvent) -> String
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns an unlocalized string for the given connection status, e.g. +“Connecting”

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSString *)stringFromConnectionStatus:(SCPConnectionStatus)status;
    + +
    +
    +

    Swift

    + 
    class func stringFromConnectionStatus(_ status: ConnectionStatus) -> String
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns an unlocalized string for the given payment status, e.g. +“Not Ready”

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSString *)stringFromPaymentStatus:(SCPPaymentStatus)status;
    + +
    +
    +

    Swift

    + 
    class func stringFromPaymentStatus(_ status: PaymentStatus) -> String
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns an unlocalized string for the given device type.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSString *)stringFromDeviceType:(SCPDeviceType)deviceType;
    + +
    +
    +

    Swift

    + 
    class func stringFromDeviceType(_ deviceType: DeviceType) -> String
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns an unlocalized string for the given discovery method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSString *)stringFromDiscoveryMethod:(SCPDiscoveryMethod)method;
    + +
    +
    +

    Swift

    + 
    class func stringFromDiscoveryMethod(_ method: DiscoveryMethod) -> String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +stringFromCardBrand: + +
    +
    +
    +
    +
    +
    +

    Returns an unlocalized string for the given card brand.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSString *)stringFromCardBrand:(SCPCardBrand)cardBrand;
    + +
    +
    +

    Swift

    + 
    class func stringFromCardBrand(_ cardBrand: CardBrand) -> String
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns an unlocalized string for the given payment intent status.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSString *)stringFromPaymentIntentStatus:
+    (SCPPaymentIntentStatus)paymentIntentStatus;
    + +
    +
    +

    Swift

    + 
    class func stringFromPaymentIntentStatus(_ paymentIntentStatus: PaymentIntentStatus) -> String
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns an unlocalized string for the given capture method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSString *)stringFromCaptureMethod:(SCPCaptureMethod)captureMethod;
    + +
    +
    +

    Swift

    + 
    class func stringFromCaptureMethod(_ captureMethod: CaptureMethod) -> String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithConfiguration:tokenProvider:delegate:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithConfiguration:tokenProvider:delegate:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPTip.html b/docs/2.19.0/Classes/SCPTip.html new file mode 100644 index 00000000..ffc2ce76 --- /dev/null +++ b/docs/2.19.0/Classes/SCPTip.html @@ -0,0 +1,547 @@ + + + + SCPTip Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPTip Class Reference +

+ +
+ +
+ +
+
+

SCPTip

+
+
+

Objective-C

+ 
@interface SCPTip : NSObject <SCPJSONDecodable, NSCopying>
+ +
+
+

Swift

+ 
class SCPTip : NSObject, JSONDecodable, NSCopying
+ +
+
+

Contains details about tips

+ +

For more information, see the official Stripe docs: Collect on-reader tips

+ +
+
+ +
+
+
+
    +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    Portion of the amount that corresponds to a tip

    + +

    The value will be null in the following scenarios:

    + +
      +
    • tipping is skipped by using the CollectConfiguration.skipTipping flag or by setting +TippingConfiguration.eligibleAmount to 0
      • +
    • current reader location does not have a tipping config set
      • +
    + +

    If “No tip” is selected on the reader, the value will be 0

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSNumber *amount;
    + +
    +
    +

    Swift

    + 
    var amount: NSNumber? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate SCPTip.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate SCPTip.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Classes/SCPTippingConfiguration.html b/docs/2.19.0/Classes/SCPTippingConfiguration.html new file mode 100644 index 00000000..09b1b1ac --- /dev/null +++ b/docs/2.19.0/Classes/SCPTippingConfiguration.html @@ -0,0 +1,587 @@ + + + + SCPTippingConfiguration Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPTippingConfiguration Class Reference +

+ +
+ +
+ +
+
+

SCPTippingConfiguration

+
+
+

Objective-C

+ 

+@interface SCPTippingConfiguration : NSObject <NSCopying>
+ +
+
+

Swift

+ 
class TippingConfiguration : NSObject, NSCopying
+ +
+
+

The TippingConfiguration contains configuration information relevant to collecting tips.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + eligibleAmount + +
    +
    +
    +
    +
    +
    +

    The amount of the payment total eligible for tips.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) NSInteger eligibleAmount;
    + +
    +
    +

    Swift

    + 
    var eligibleAmount: Int { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize a TippingConfiguration instance.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithEligibleAmount:(NSInteger)eligibleAmount;
    + +
    +
    +

    Swift

    + 
    init(eligibleAmount: Int)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + eligibleAmount + + +
    +

    Amount eligible for tips.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithEligibleAmount:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithEligibleAmount:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPBatteryStatus.html b/docs/2.19.0/Enums/SCPBatteryStatus.html new file mode 100644 index 00000000..ebcce066 --- /dev/null +++ b/docs/2.19.0/Enums/SCPBatteryStatus.html @@ -0,0 +1,569 @@ + + + + SCPBatteryStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPBatteryStatus Enumeration Reference +

+ +
+ +
+ +
+
+

SCPBatteryStatus

+
+
+

Objective-C

+ 
enum SCPBatteryStatus : NSUInteger {}
+ +
+
+

Swift

+ 
enum BatteryStatus : UInt, @unchecked Sendable
+ +
+
+

A categorization of a reader’s battery charge level.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Battery state is not yet known or not available for the connected reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPBatteryStatusUnknown
    + +
    +
    +

    Swift

    + 
    case unknown = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The device’s battery is less than or equal to 5%.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPBatteryStatusCritical
    + +
    +
    +

    Swift

    + 
    case critical = 1
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPBatteryStatusLow + +
    +
    +
    +
    +
    +
    +

    The device’s battery is between 5% and 20%.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPBatteryStatusLow
    + +
    +
    +

    Swift

    + 
    case low = 2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The device’s battery is greater than 20%.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPBatteryStatusNominal
    + +
    +
    +

    Swift

    + 
    case nominal = 3
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPCaptureMethod.html b/docs/2.19.0/Enums/SCPCaptureMethod.html new file mode 100644 index 00000000..8ac8c405 --- /dev/null +++ b/docs/2.19.0/Enums/SCPCaptureMethod.html @@ -0,0 +1,512 @@ + + + + SCPCaptureMethod Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCaptureMethod Enumeration Reference +

+ +
+ +
+ +
+
+

SCPCaptureMethod

+
+
+

Objective-C

+ 
enum SCPCaptureMethod : NSUInteger {}
+ +
+
+

Swift

+ 
enum CaptureMethod : UInt, @unchecked Sendable
+ +
+
+

@abstract Controls when the funds will be captured from the customer’s account.

+
+

See

+ https://stripe.com/docs/terminal/payments/collect-payment?terminal-sdk-platform=ios#capture-payment + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Place a hold on the funds when the customer authorizes the payment, but don’t + capture the funds until later. Will require an explicit call to capture payments. + (Not all payment methods support this.)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCaptureMethodManual
    + +
    +
    +

    Swift

    + 
    case manual = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Stripe automatically captures funds when the customer authorizes the payment.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCaptureMethodAutomatic
    + +
    +
    +

    Swift

    + 
    case automatic = 1
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPCardBrand.html b/docs/2.19.0/Enums/SCPCardBrand.html new file mode 100644 index 00000000..d408676b --- /dev/null +++ b/docs/2.19.0/Enums/SCPCardBrand.html @@ -0,0 +1,766 @@ + + + + SCPCardBrand Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCardBrand Enumeration Reference +

+ +
+ +
+ +
+
+

SCPCardBrand

+
+
+

Objective-C

+ 
enum SCPCardBrand : NSInteger {}
+ +
+
+

Swift

+ 
enum CardBrand : Int, @unchecked Sendable
+ +
+
+

The various card brands for a card.

+
+

See

+ https://stripe.com/docs/api/cards/object#card_object-brand + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + SCPCardBrandVisa + +
    +
    +
    +
    +
    +
    +

    Visa card

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardBrandVisa
    + +
    +
    +

    Swift

    + 
    case visa = 0
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPCardBrandAmex + +
    +
    +
    +
    +
    +
    +

    American Express card

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardBrandAmex
    + +
    +
    +

    Swift

    + 
    case amex = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    MasterCard card

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardBrandMasterCard
    + +
    +
    +

    Swift

    + 
    case masterCard = 2
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPCardBrandDiscover + +
    +
    +
    +
    +
    +
    +

    Discover card

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardBrandDiscover
    + +
    +
    +

    Swift

    + 
    case discover = 3
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPCardBrandJCB + +
    +
    +
    +
    +
    +
    +

    JCB card

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardBrandJCB
    + +
    +
    +

    Swift

    + 
    case JCB = 4
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Diners Club card

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardBrandDinersClub
    + +
    +
    +

    Swift

    + 
    case dinersClub = 5
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPCardBrandInterac + +
    +
    +
    +
    +
    +
    +

    Interac card

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardBrandInterac
    + +
    +
    +

    Swift

    + 
    case interac = 6
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPCardBrandUnionPay + +
    +
    +
    +
    +
    +
    +

    Union Pay card

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardBrandUnionPay
    + +
    +
    +

    Swift

    + 
    case unionPay = 7
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPCardBrandEftposAu + +
    +
    +
    +
    +
    +
    +

    Eftpos Australia card

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardBrandEftposAu
    + +
    +
    +

    Swift

    + 
    case eftposAu = 8
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPCardBrandUnknown + +
    +
    +
    +
    +
    +
    +

    An unknown card brand

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardBrandUnknown
    + +
    +
    +

    Swift

    + 
    case unknown = 9
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPCardFundingType.html b/docs/2.19.0/Enums/SCPCardFundingType.html new file mode 100644 index 00000000..694be8cc --- /dev/null +++ b/docs/2.19.0/Enums/SCPCardFundingType.html @@ -0,0 +1,574 @@ + + + + SCPCardFundingType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCardFundingType Enumeration Reference +

+ +
+ +
+ +
+
+

SCPCardFundingType

+
+
+

Objective-C

+ 
enum SCPCardFundingType : NSInteger {}
+ +
+
+

Swift

+ 
enum CardFundingType : Int, @unchecked Sendable
+ +
+
+

The various funding sources for a card.

+
+

See

+ https://stripe.com/docs/api/cards/object#card_object-funding + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Debit

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardFundingTypeDebit
    + +
    +
    +

    Swift

    + 
    case debit = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Credit

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardFundingTypeCredit
    + +
    +
    +

    Swift

    + 
    case credit = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Prepaid

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardFundingTypePrepaid
    + +
    +
    +

    Swift

    + 
    case prepaid = 2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    An other or unknown type of funding source

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardFundingTypeOther
    + +
    +
    +

    Swift

    + 
    case other = 3
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPCardPresentCaptureMethod.html b/docs/2.19.0/Enums/SCPCardPresentCaptureMethod.html new file mode 100644 index 00000000..a62f6068 --- /dev/null +++ b/docs/2.19.0/Enums/SCPCardPresentCaptureMethod.html @@ -0,0 +1,474 @@ + + + + SCPCardPresentCaptureMethod Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCardPresentCaptureMethod Enumeration Reference +

+ +
+ +
+ +
+
+

SCPCardPresentCaptureMethod

+
+
+

Objective-C

+ 
enum SCPCardPresentCaptureMethod : NSUInteger {}
+ +
+
+

Swift

+ 
enum CardPresentCaptureMethod : UInt, @unchecked Sendable
+ +
+
+

Capture Method values that can be used as card-present payment method options.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Use manual_preferred if you prefer manual capture_method for the SCPPaymentIntent’s capture_method but support +falling back to automatic based on the presented payment method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardPresentCaptureMethodManualPreferred
    + +
    +
    +

    Swift

    + 
    case manualPreferred = 0
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPCardPresentRouting.html b/docs/2.19.0/Enums/SCPCardPresentRouting.html new file mode 100644 index 00000000..0b7e2508 --- /dev/null +++ b/docs/2.19.0/Enums/SCPCardPresentRouting.html @@ -0,0 +1,505 @@ + + + + SCPCardPresentRouting Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCardPresentRouting Enumeration Reference +

+ +
+ +
+ +
+
+

SCPCardPresentRouting

+
+
+

Objective-C

+ 
enum SCPCardPresentRouting : NSUInteger {}
+ +
+
+

Swift

+ 
enum CardPresentRouting : UInt, @unchecked Sendable
+ +
+
+

Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Prioritize domestic debit network routing on payment method collection.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardPresentRoutingDomestic
    + +
    +
    +

    Swift

    + 
    case domestic = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Prioritize international network routing on payment method collection.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardPresentRoutingInternational
    + +
    +
    +

    Swift

    + 
    case international = 1
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPChargeStatus.html b/docs/2.19.0/Enums/SCPChargeStatus.html new file mode 100644 index 00000000..5143797b --- /dev/null +++ b/docs/2.19.0/Enums/SCPChargeStatus.html @@ -0,0 +1,537 @@ + + + + SCPChargeStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPChargeStatus Enumeration Reference +

+ +
+ +
+ +
+
+

SCPChargeStatus

+
+
+

Objective-C

+ 
enum SCPChargeStatus : NSUInteger {}
+ +
+
+

Swift

+ 
enum ChargeStatus : UInt, @unchecked Sendable
+ +
+
+

The possible statuses for a charge

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The charge succeeded.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPChargeStatusSucceeded
    + +
    +
    +

    Swift

    + 
    case succeeded = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The charge succeeded.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPChargeStatusPending
    + +
    +
    +

    Swift

    + 
    case pending = 1
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPChargeStatusFailed + +
    +
    +
    +
    +
    +
    +

    The charge failed.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPChargeStatusFailed
    + +
    +
    +

    Swift

    + 
    case failed = 2
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPConnectionStatus.html b/docs/2.19.0/Enums/SCPConnectionStatus.html new file mode 100644 index 00000000..f23fe5d3 --- /dev/null +++ b/docs/2.19.0/Enums/SCPConnectionStatus.html @@ -0,0 +1,542 @@ + + + + SCPConnectionStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPConnectionStatus Enumeration Reference +

+ +
+ +
+ +
+
+

SCPConnectionStatus

+
+
+

Objective-C

+ 
enum SCPConnectionStatus : NSUInteger {}
+ +
+
+

Swift

+ 
enum ConnectionStatus : UInt, @unchecked Sendable
+ +
+
+

The possible reader connection statuses for the SDK.

+
+

See

+ https://stripe.com/docs/terminal/readers/connecting + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The SDK is not connected to a reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPConnectionStatusNotConnected
    + +
    +
    +

    Swift

    + 
    case notConnected = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SDK is connected to a reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPConnectionStatusConnected
    + +
    +
    +

    Swift

    + 
    case connected = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SDK is currently connecting to a reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPConnectionStatusConnecting
    + +
    +
    +

    Swift

    + 
    case connecting = 2
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPDeviceType.html b/docs/2.19.0/Enums/SCPDeviceType.html new file mode 100644 index 00000000..4471c9e1 --- /dev/null +++ b/docs/2.19.0/Enums/SCPDeviceType.html @@ -0,0 +1,764 @@ + + + + SCPDeviceType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPDeviceType Enumeration Reference +

+ +
+ +
+ +
+
+

SCPDeviceType

+
+
+

Objective-C

+ 
enum SCPDeviceType : NSUInteger {}
+ +
+
+

Swift

+ 
enum DeviceType : UInt, @unchecked Sendable
+ +
+
+

The possible device types for a reader.

+
+

See

+ https://stripe.com/docs/terminal/readers + +
+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPDiscoveryMethod.html b/docs/2.19.0/Enums/SCPDiscoveryMethod.html new file mode 100644 index 00000000..087b7f7e --- /dev/null +++ b/docs/2.19.0/Enums/SCPDiscoveryMethod.html @@ -0,0 +1,635 @@ + + + + SCPDiscoveryMethod Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPDiscoveryMethod Enumeration Reference +

+ +
+ +
+ +
+
+

SCPDiscoveryMethod

+
+
+

Objective-C

+ 
enum SCPDiscoveryMethod : NSUInteger {}
+ +
+
+

Swift

+ 
enum DiscoveryMethod : UInt, @unchecked Sendable
+ +
+
+

The possible methods for discovering a reader. Pass a variant of this enum +into your SCPDiscoveryConfiguration.

+
+

See

+ https://stripe.com/docs/terminal/readers/connecting + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The Bluetooth Scan discovery method searches for Stripe Terminal’s +Bluetooth-capable readers.

    + +

    When discovering a reader using this method, the didUpdateDiscoveredReaders +delegate method will be called multiple times as the Bluetooth scan +proceeds.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPDiscoveryMethodBluetoothScan
    + +
    +
    +

    Swift

    + 
    case bluetoothScan = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The Bluetooth Proximity discovery method searches for a subset of +Stripe Terminal’s Bluetooth-capable readers.

    + +

    If your app will be used in a busy environment with multiple iOS +devices pairing to multiple available readers at the same time, we +recommend using this discovery method.

    + +

    After a reader has been discovered using this method, the LEDs located +above the reader’s power button will start flashing multiple colors. +After discovering the reader, your app should prompt the user to confirm +that the reader is flashing, and require a user action (e.g. tapping a +button) to connect to the reader.

    + +

    When discovering a reader using this method, the didUpdateDiscoveredReaders +delegate method will be called twice. It will be called for the first time +when the reader is initially discovered. The reader’s LEDs will begin +flashing. After a short delay, didUpdateDiscoveredReaders will be called +a second time with an updated reader object, populated with additional +info about the device, like its battery level.

    +
    +

    Note

    +

    The Bluetooth Proximity discovery method can only discover +Stripe Reader M2 and BBPOS Chipper 2X BT readers.

    + +
    +

    Note

    +

    The simulated Bluetooth Proximity discovery method will always return +a Stripe Reader M2 simulated device.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPDiscoveryMethodBluetoothProximity
    + +
    +
    +

    Swift

    + 
    case bluetoothProximity = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The Internet discovery method searches for internet-connected readers, +such as the Verifone P400 or the BBPOS WisePOS E.

    + +

    When discovering a reader with this method didUpdateDiscoveredReaders +will only be called once with a list of readers from /v1/terminal/readers. +Note that this will include readers that are both online and offline.

    + +

    Because the discovery process continues if connecting to a discovered +reader fails, the SDK will refresh the list of SCPReaders and call +didUpdateDiscoveredReaders with the results. For more details about failed +connect calls, see -[SCPTerminal connectReader:connectionConfig:completion:]

    +
    +

    See

    + https://stripe.com/docs/api/terminal/readers/list + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPDiscoveryMethodInternet
    + +
    +
    +

    Swift

    + 
    case internet = 2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The Local Mobile discovery method searches for any readers built into the +merchant device that are supported by Stripe Terminal. +When discovering a reader with this method didUpdateDiscoveredReaders +will only be called once with a list of discovered readers, if any. +An error may be provided if a discovery attempt is made in an +on a device without hardware support for the Apple Built-In reader or +one running an unsupported version of iOS.

    +
    +

    See

    + https://stripe.com/docs/terminal/payments/setup-reader/tap-on-mobile-ios + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPDiscoveryMethodLocalMobile
    + +
    +
    +

    Swift

    + 
    case localMobile = 3
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPError.html b/docs/2.19.0/Enums/SCPError.html new file mode 100644 index 00000000..d578f6cb --- /dev/null +++ b/docs/2.19.0/Enums/SCPError.html @@ -0,0 +1,3317 @@ + + + + SCPError Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPError Enumeration Reference +

+ +
+ +
+ +
+
+

SCPError

+
+
+

Objective-C

+ 
enum SCPError : NSInteger {}
+ +
+
+

Swift

+ 
typealias ErrorCode.Code._ErrorType = ErrorCode
+ +
+
+

Possible error codes for NSError objects under the SCPErrorDomain domain.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + SCPErrorBusy + +
    +
    +
    +
    +
    +
    +

    The SDK is busy executing another command. The SDK can only execute a +single command at a time. You can use the paymentStatus or +connectionStatus properties on your SCPTerminal instance (or the +corresponding delegate methods) to determine if the SDK is ready to accept +another command.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBusy = 1000
    + +
    +
    +

    Swift

    + 
    case busy = 1000
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Canceling a command failed because the command already completed.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorCancelFailedAlreadyCompleted = 1010
    + +
    +
    +

    Swift

    + 
    case cancelFailedAlreadyCompleted = 1010
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    No reader is connected. Connect to a reader before trying again.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorNotConnectedToReader = 1100
    + +
    +
    +

    Swift

    + 
    case notConnectedToReader = 1100
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Already connected to a reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorAlreadyConnectedToReader = 1110
    + +
    +
    +

    Swift

    + 
    case alreadyConnectedToReader = 1110
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Your implementation of fetchConnectionToken called the completion block +with (nil, nil). Please make sure your integration completes with either +a connection token or an error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorConnectionTokenProviderCompletedWithNothing = 1510
    + +
    +
    +

    Swift

    + 
    case connectionTokenProviderCompletedWithNothing = 1510
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    processPayment was called with an unknown or invalid PaymentIntent. +You must process a payment immediately after collecting a payment method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorProcessInvalidPaymentIntent = 1530
    + +
    +
    +

    Swift

    + 
    case processInvalidPaymentIntent = 1530
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    collectPaymentMethod or processPayment was called with a nil PaymentIntent.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorNilPaymentIntent = 1540
    + +
    +
    +

    Swift

    + 
    case nilPaymentIntent = 1540
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    collectSetupIntentPaymentMethod or processSetupIntent was called with +a nil SetupIntent.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorNilSetupIntent = 1542
    + +
    +
    +

    Swift

    + 
    case nilSetupIntent = 1542
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    processRefund was called without calling collectRefundPaymentMethod +beforehand.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorNilRefundPaymentMethod = 1550
    + +
    +
    +

    Swift

    + 
    case nilRefundPaymentMethod = 1550
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The RefundParameters object has invalid values. The Charge ID (ch_123abc) +can be found on the PaymentIntent object, which you should get from +your backend.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorInvalidRefundParameters = 1555
    + +
    +
    +

    Swift

    + 
    case invalidRefundParameters = 1555
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A PaymentIntent or SetupIntent was referenced using an invalid client secret.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorInvalidClientSecret = 1560
    + +
    +
    +

    Swift

    + 
    case invalidClientSecret = 1560
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SDK must be actively Discovering Readers in order to successfully +connect to a reader. See documentation on +-[SCPTerminal discoverReaders:delegate:completion:] +and -[SCPTerminal connectReader:completion:]

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorMustBeDiscoveringToConnect = 1570
    + +
    +
    +

    Swift

    + 
    case mustBeDiscoveringToConnect = 1570
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Before connecting to a reader, it must have already been discovered in the +current discovery session. Trying to connect to a reader from a previous +discovery session is not supported.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorCannotConnectToUndiscoveredReader = 1580
    + +
    +
    +

    Swift

    + 
    case cannotConnectToUndiscoveredReader = 1580
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    discoverReaders was called using an invalid SCPDiscoveryConfiguration. +Your app selected a discovery method that is either incompatible with the +selected device type or attemped to use simulated or locationId with a +reader which does not support simulated or locationId. Currently +chipper2X is the only reader which supports simulated and +verifoneP400 is the only reader which supports use of locationId for +location filtering.

    +
    +

    See

    + SCPDiscoveryConfiguration for valid configurations. + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorInvalidDiscoveryConfiguration = 1590
    + +
    +
    +

    Swift

    + 
    case invalidDiscoveryConfiguration = 1590
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    installUpdate was passed an update that is for a different reader. Updates can only +be installed on the reader that was connected when the update was announced.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorInvalidReaderForUpdate = 1861
    + +
    +
    +

    Swift

    + 
    case invalidReaderForUpdate = 1861
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    -[SCPTerminal connectReader:completion:] was called from an unsupported version +of the SDK. In order to fix this you will need to update your app to the most recent +version of the SDK. We suggest you prompt your user to update their app, +assuming there is an update app version with a supported version of our SDK.

    +
    +

    See

    + https://github.com/stripe/stripe-terminal-ios/releases/latest + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorUnsupportedSDK = 1870
    + +
    +
    +

    Swift

    + 
    case unsupportedSDK = 1870
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This feature is currently not available for the selected reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorFeatureNotAvailableWithConnectedReader = 1880
    + +
    +
    +

    Swift

    + 
    case featureNotAvailableWithConnectedReader = 1880
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This feature is not currently available.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorFeatureNotAvailable = 1890
    + +
    +
    +

    Swift

    + 
    case featureNotAvailable = 1890
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The ListLocationsParameters object has invalid values.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorInvalidListLocationsLimitParameter = 1900
    + +
    +
    +

    Swift

    + 
    case invalidListLocationsLimitParameter = 1900
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The locationId parameter to BluetoothConnectionConfiguration is required but a valid one was not provided.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBluetoothConnectionInvalidLocationIdParameter = 1910
    + +
    +
    +

    Swift

    + 
    case bluetoothConnectionInvalidLocationIdParameter = 1910
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A required parameter was invalid or missing.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorInvalidRequiredParameter = 1920
    + +
    +
    +

    Swift

    + 
    case invalidRequiredParameter = 1920
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    An invalid ConnectionConfiguration was passed through connect.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorReaderConnectionConfigurationInvalid = 1940
    + +
    +
    +

    Swift

    + 
    case readerConnectionConfigurationInvalid = 1940
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    An invalid usage of eligibleAmount or skipTipping was passed into collect.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorReaderTippingParameterInvalid = 1950
    + +
    +
    +

    Swift

    + 
    case readerTippingParameterInvalid = 1950
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The provided location ID parameter was invalid.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorInvalidLocationIdParameter = 1960
    + +
    +
    +

    Swift

    + 
    case invalidLocationIdParameter = 1960
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPErrorCanceled + +
    +
    +
    +
    +
    +
    +

    The command was canceled by your app.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorCanceled = 2020
    + +
    +
    +

    Swift

    + 
    case canceled = 2020
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Access to location services is currently disabled. This may be because:

    + +
      +
    • The user disabled location services in the system settings.
      • +
    • The user denied access to location services for your app.
      • +
    • The user’s device is in Airplane Mode and unable to gather location data.
      • +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorLocationServicesDisabled = 2200
    + +
    +
    +

    Swift

    + 
    case locationServicesDisabled = 2200
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This error indicates that Bluetooth is turned off, and the user should use +Settings to turn Bluetooth on.

    + +

    If Bluetooth is on but the app does not have permission to use it, +a different error (SCPErrorBluetoothError) occurs.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBluetoothDisabled = 2320
    + +
    +
    +

    Swift

    + 
    case bluetoothDisabled = 2320
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Bluetooth is turned on on the device, but access to Bluetooth has been denied +for your app. The user needs to go to Settings > Your App > and enable Bluetooth

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBluetoothAccessDenied = 2321
    + +
    +
    +

    Swift

    + 
    case bluetoothAccessDenied = 2321
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Scanning for bluetooth devices timed out.

    +
    +

    See

    + SCPDiscoveryConfiguration.timeout + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBluetoothScanTimedOut = 2330
    + +
    +
    +

    Swift

    + 
    case bluetoothScanTimedOut = 2330
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Bluetooth Low Energy is unsupported on this iOS device. Use a different +iOS device that supports BLE (also known as Bluetooth 4.0)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBluetoothLowEnergyUnsupported = 2340
    + +
    +
    +

    Swift

    + 
    case bluetoothLowEnergyUnsupported = 2340
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updating the reader software failed because the reader’s battery is +too low. Charge the reader before trying again.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorReaderSoftwareUpdateFailedBatteryLow = 2650
    + +
    +
    +

    Swift

    + 
    case readerSoftwareUpdateFailedBatteryLow = 2650
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updating the reader software failed because the update was interrupted.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorReaderSoftwareUpdateFailedInterrupted = 2660
    + +
    +
    +

    Swift

    + 
    case readerSoftwareUpdateFailedInterrupted = 2660
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updating the reader software failed because the update has expired. Please disconnect and +reconnect from the reader to retrieve a new update.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorReaderSoftwareUpdateFailedExpiredUpdate = 2670
    + +
    +
    +

    Swift

    + 
    case readerSoftwareUpdateFailedExpiredUpdate = 2670
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The reader has a critically low battery and cannot connect to the +iOS device. Charge the reader before trying again.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBluetoothConnectionFailedBatteryCriticallyLow = 2680
    + +
    +
    +

    Swift

    + 
    case bluetoothConnectionFailedBatteryCriticallyLow = 2680
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The card is not a chip card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorCardInsertNotRead = 2810
    + +
    +
    +

    Swift

    + 
    case cardInsertNotRead = 2810
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The swipe could not be read.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorCardSwipeNotRead = 2820
    + +
    +
    +

    Swift

    + 
    case cardSwipeNotRead = 2820
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Reading a card timed out.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorCardReadTimedOut = 2830
    + +
    +
    +

    Swift

    + 
    case cardReadTimedOut = 2830
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPErrorCardRemoved + +
    +
    +
    +
    +
    +
    +

    The card was removed during the transaction.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorCardRemoved = 2840
    + +
    +
    +

    Swift

    + 
    case cardRemoved = 2840
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A card can only be used for one transaction, and must be removed after +being read. Otherwise, subsequent collectPaymentMethod attempts will fail +with this error.

    + +

    Your terminal delegate will receive -[SCPTerminalDelegate terminal:didReportReaderEvent:info:] +with SCPReaderEventCardRemoved when the card is removed.

    + +

    The Chipper 2x and WisePad 3 will beep until the card is removed.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorCardLeftInReader = 2850
    + +
    +
    +

    Swift

    + 
    case cardLeftInReader = 2850
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The reader failed to read the data from the presented payment method. If you encounter +this error repeatedly, the reader may be faulty.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorMissingEMVData = 2892
    + +
    +
    +

    Swift

    + 
    case missingEMVData = 2892
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The command was not permitted to execute by the operating system. +This can happen for a number of reasons, but most commonly:

    + +
      +
    • Your application does not have the necessary entitlements.
      • +
    • Your application bundle is invalid.
      • +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorCommandNotAllowed = 2900
    + +
    +
    +

    Swift

    + 
    case commandNotAllowed = 2900
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The mobile device on which the app is running is in an unsupported +configuration. Verify that the device is running a supported version of +iOS and that the mobile device has the capability you are attempting to use.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorUnsupportedMobileDeviceConfiguration = 2910
    + +
    +
    +

    Swift

    + 
    case unsupportedMobileDeviceConfiguration = 2910
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The mobile device on which the app is running must have a passcode set.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorPasscodeNotEnabled = 2920
    + +
    +
    +

    Swift

    + 
    case passcodeNotEnabled = 2920
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The card reader cannot be used while a phone call is active.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorCommandNotAllowedDuringCall = 2930
    + +
    +
    +

    Swift

    + 
    case commandNotAllowedDuringCall = 2930
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPErrorInvalidAmount + +
    +
    +
    +
    +
    +
    +

    An attempt was made to charge an amount not supported by the reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorInvalidAmount = 2940
    + +
    +
    +

    Swift

    + 
    case invalidAmount = 2940
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    An attempt was made to charge an amount in a currency not supported by the reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorInvalidCurrency = 2950
    + +
    +
    +

    Swift

    + 
    case invalidCurrency = 2950
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Failed to accept reader-specific terms of service because there is no iCloud +user signed in. Direct the user to sign into an appropriate iCloud account +via iOS Settings and try again.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorAppleBuiltInReaderTOSAcceptanceRequiresiCloudSignIn = 2960
    + +
    +
    +

    Swift

    + 
    case appleBuiltInReaderTOSAcceptanceRequiresiCloudSignIn = 2960
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The user cancelled reader-specific terms of service acceptance.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorAppleBuiltInReaderTOSAcceptanceCanceled = 2970
    + +
    +
    +

    Swift

    + 
    case appleBuiltInReaderTOSAcceptanceCanceled = 2970
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPErrorReaderBusy + +
    +
    +
    +
    +
    +
    +

    The reader is busy.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorReaderBusy = 3010
    + +
    +
    +

    Swift

    + 
    case readerBusy = 3010
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    An incompatible reader was detected. You can only use the Stripe Terminal +iOS SDK with one of Stripe’s pre-certified readers.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorIncompatibleReader = 3030
    + +
    +
    +

    Swift

    + 
    case incompatibleReader = 3030
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Could not communicate with the reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorReaderCommunicationError = 3060
    + +
    +
    +

    Swift

    + 
    case readerCommunicationError = 3060
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPErrorNFCDisabled + +
    +
    +
    +
    +
    +
    +

    NFC functionality is disabled. +Among other things, it may indicate that the app does not have permission to use NFC.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorNFCDisabled = 3100
    + +
    +
    +

    Swift

    + 
    case nfcDisabled = 3100
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Generic Bluetooth error.

    + +

    Among other things, it may indicate that the app does not have permission +to use Bluetooth (iOS 13+).

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBluetoothError = 3200
    + +
    +
    +

    Swift

    + 
    case bluetoothError = 3200
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Connecting to the bluetooth device timed out. Make sure the device is +powered on, in range, and not connected to another app or device. If this +error continues to occur, you may need to charge the device.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBluetoothConnectTimedOut = 3210
    + +
    +
    +

    Swift

    + 
    case bluetoothConnectTimedOut = 3210
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The Bluetooth device was disconnected unexpectedly.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBluetoothDisconnected = 3230
    + +
    +
    +

    Swift

    + 
    case bluetoothDisconnected = 3230
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Bluetooth pairing error, the reader has removed this device pairing information. +Forget the reader in iOS Settings.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBluetoothPeerRemovedPairingInformation = 3240
    + +
    +
    +

    Swift

    + 
    case bluetoothPeerRemovedPairingInformation = 3240
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The Bluetooth reader is already paired to another device. The Bluetooth reader +must have its pairing reset to connect to this device.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBluetoothAlreadyPairedWithAnotherDevice = 3241
    + +
    +
    +

    Swift

    + 
    case bluetoothAlreadyPairedWithAnotherDevice = 3241
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Generic reader software update error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorReaderSoftwareUpdateFailed = 3800
    + +
    +
    +

    Swift

    + 
    case readerSoftwareUpdateFailed = 3800
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updating the reader software failed because there was an error +communicating with the reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorReaderSoftwareUpdateFailedReaderError = 3830
    + +
    +
    +

    Swift

    + 
    case readerSoftwareUpdateFailedReaderError = 3830
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updating the reader software failed because there was an error +communicating with the update server.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorReaderSoftwareUpdateFailedServerError = 3840
    + +
    +
    +

    Swift

    + 
    case readerSoftwareUpdateFailedServerError = 3840
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    processPayment was called from a reader with an unsupported reader +version. You will need to update your reader to the most recent version in +order to accept payments. We suggest you prompt your user +to disconnect and reconnect their reader in order to update the reader.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers/bbpos-chipper2xbt#updating-reader-software + +
    +

    See

    + https://stripe.com/docs/terminal/readers/bbpos-wisepad3#updating-reader-software + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorUnsupportedReaderVersion = 3850
    + +
    +
    +

    Swift

    + 
    case unsupportedReaderVersion = 3850
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The reader returned from discovery does not have an IP address and cannot +be connected to. The IP address should have been set by the SDK during +registration of the reader. Try registering the reader again.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers/connecting/verifone-p400#register-reader + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorUnknownReaderIpAddress = 3860
    + +
    +
    +

    Swift

    + 
    case unknownReaderIpAddress = 3860
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Connecting to reader over the internet timed out. Make sure your device and +reader are on the same Wifi network and your reader is connected to the +Wifi network.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers/verifone-p400#troubleshooting + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorInternetConnectTimeOut = 3870
    + +
    +
    +

    Swift

    + 
    case internetConnectTimeOut = 3870
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Connecting to the reader failed because it is currently in use +and SCPConnectionConfiguration.failIfInUse was set to true.

    + +

    Try to connect again with failIfInUse = false, or choose a different +reader.

    + +

    A reader is in use while it’s collecting a payment.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers/connecting/verifone-p400#connect-reader-ios + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorConnectFailedReaderIsInUse = 3880
    + +
    +
    +

    Swift

    + 
    case connectFailedReaderIsInUse = 3880
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The Bluetooth reader has disconnected and we are attempting to reconnect.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBluetoothReconnectStarted = 3890
    + +
    +
    +

    Swift

    + 
    case bluetoothReconnectStarted = 3890
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    An attempt was made to interact with the reader while the the app is in the background.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorReaderNotAccessibleInBackground = 3900
    + +
    +
    +

    Swift

    + 
    case readerNotAccessibleInBackground = 3900
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Preparing the Apple Built-In reader to collect payments failed. +Try connecting again.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorAppleBuiltInReaderFailedToPrepare = 3910
    + +
    +
    +

    Swift

    + 
    case appleBuiltInReaderFailedToPrepare = 3910
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This device cannot be used to process using the Apple Built-In reader as it has been banned.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorAppleBuiltInReaderDeviceBanned = 3920
    + +
    +
    +

    Swift

    + 
    case appleBuiltInReaderDeviceBanned = 3920
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The operation could not be completed because the reader-specific terms of service have +not yet been accepted. Try connecting again.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorAppleBuiltInReaderTOSNotYetAccepted = 3930
    + +
    +
    +

    Swift

    + 
    case appleBuiltInReaderTOSNotYetAccepted = 3930
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Failed to accept reader-specific terms of service using the signed-in Apple ID. +Ensure the Apple ID is still active and in a good standing and try again.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorAppleBuiltInReaderTOSAcceptanceFailed = 3940
    + +
    +
    +

    Swift

    + 
    case appleBuiltInReaderTOSAcceptanceFailed = 3940
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This merchant account cannot be used with Apple Built-In reader as it has been blocked.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorAppleBuiltInReaderMerchantBlocked = 3950
    + +
    +
    +

    Swift

    + 
    case appleBuiltInReaderMerchantBlocked = 3950
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This merchant account cannot be used with the Apple Built-In reader as it is invalid.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorAppleBuiltInReaderInvalidMerchant = 3960
    + +
    +
    +

    Swift

    + 
    case appleBuiltInReaderInvalidMerchant = 3960
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Unexpected SDK error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorUnexpectedSdkError = 5000
    + +
    +
    +

    Swift

    + 
    case unexpectedSdkError = 5000
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Unexpected reader error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorUnexpectedReaderError = 5001
    + +
    +
    +

    Swift

    + 
    case unexpectedReaderError = 5001
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The Stripe API declined the transaction. +Inspect the error’s requestError property for more information about +the decline, including the decline code.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorDeclinedByStripeAPI = 6000
    + +
    +
    +

    Swift

    + 
    case declinedByStripeAPI = 6000
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The reader declined the transaction. Try another card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorDeclinedByReader = 6500
    + +
    +
    +

    Swift

    + 
    case declinedByReader = 6500
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The cardholder must give consent in order for this operation to succeed.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorCommandRequiresCardholderConsent = 6700
    + +
    +
    +

    Swift

    + 
    case commandRequiresCardholderConsent = 6700
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPErrorRefundFailed + +
    +
    +
    +
    +
    +
    +

    The refund failed. The customer’s bank or card issuer was unable to process +it correctly (e.g., a closed bank account or a problem with the card)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorRefundFailed = 6800
    + +
    +
    +

    Swift

    + 
    case refundFailed = 6800
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SDK is not connected to the internet.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorNotConnectedToInternet = 9000
    + +
    +
    +

    Swift

    + 
    case notConnectedToInternet = 9000
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The underlying request timed out.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorRequestTimedOut = 9010
    + +
    +
    +

    Swift

    + 
    case requestTimedOut = 9010
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The underlying request returned an API error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorStripeAPIError = 9020
    + +
    +
    +

    Swift

    + 
    case stripeAPIError = 9020
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The API response from Stripe could not be decoded.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorStripeAPIResponseDecodingError = 9030
    + +
    +
    +

    Swift

    + 
    case stripeAPIResponseDecodingError = 9030
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Generic network error

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorInternalNetworkError = 9040
    + +
    +
    +

    Swift

    + 
    case internalNetworkError = 9040
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Your implementation of -[SCPConnectionTokenProvider fetchConnectionToken:] +called the completion block with an error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorConnectionTokenProviderCompletedWithError = 9050
    + +
    +
    +

    Swift

    + 
    case connectionTokenProviderCompletedWithError = 9050
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The current session has expired and the reader must be disconnected and +reconnected. The SDK will attempt to auto-disconnect for you and you should +instruct your user to reconnect it. +-[SCPTerminalDelegate terminal:didReportUnexpectedReaderDisconnect:] +will be called if the SDK is able to successfully auto-disconnect. If it +does not successfully auto-disconnect (didReportUnexpectedReaderDisconnect +will not be called and SCPTerminal.connectionStatus will still be +SCPConnectionStatusConnected) you can attempt again via +-[SCPTerminal disconnectReader:] or you can instruct your user +to disconnect manually by turning the reader off.

    + +

    Note this error will only occur in one of the following calls:

    + + + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorSessionExpired = 9060
    + +
    +
    +

    Swift

    + 
    case sessionExpired = 9060
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPIncrementalAuthorizationStatus.html b/docs/2.19.0/Enums/SCPIncrementalAuthorizationStatus.html new file mode 100644 index 00000000..d757f280 --- /dev/null +++ b/docs/2.19.0/Enums/SCPIncrementalAuthorizationStatus.html @@ -0,0 +1,543 @@ + + + + SCPIncrementalAuthorizationStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPIncrementalAuthorizationStatus Enumeration Reference +

+ +
+ +
+ +
+
+

SCPIncrementalAuthorizationStatus

+
+
+

Objective-C

+ 
enum SCPIncrementalAuthorizationStatus : NSUInteger {}
+ +
+
+

Swift

+ 
enum SCPIncrementalAuthorizationStatus : UInt, @unchecked Sendable
+ +
+
+

Represents the ability for a PaymentIntent to be incrementally authorized.

+
+

See

+ https://stripe.com/docs/terminal/features/incremental-authorizations + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    It is undetermined whether or not this PaymentIntent will be eligible for incremental authorizations. +You can only perform incremental authorizations on uncaptured payments after confirmation.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPIncrementalAuthorizationStatusUnknown
    + +
    +
    +

    Swift

    + 
    case unknown = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This PaymentIntent is not eligible for incremental authorizations, or it was not requested.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPIncrementalAuthorizationStatusNotSupported
    + +
    +
    +

    Swift

    + 
    case notSupported = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This PaymentIntent is eligible for incremental authorizations.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPIncrementalAuthorizationStatusSupported
    + +
    +
    +

    Swift

    + 
    case supported = 2
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPLocationStatus.html b/docs/2.19.0/Enums/SCPLocationStatus.html new file mode 100644 index 00000000..682ae40d --- /dev/null +++ b/docs/2.19.0/Enums/SCPLocationStatus.html @@ -0,0 +1,547 @@ + + + + SCPLocationStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPLocationStatus Enumeration Reference +

+ +
+ +
+ +
+
+

SCPLocationStatus

+
+
+

Objective-C

+ 
enum SCPLocationStatus : NSUInteger {}
+ +
+
+

Swift

+ 
enum LocationStatus : UInt, @unchecked Sendable
+ +
+
+

Represents the possible states of the location object for a +discovered reader.

+
+

See

+ SCPReader + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The location is not known. location will be nil.

    + +

    A reader will only have a location status of unknown when a Bluetooth +reader’s full location information failed to fetch properly during discovery.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPLocationStatusUnknown
    + +
    +
    +

    Swift

    + 
    case unknown = 0
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPLocationStatusSet + +
    +
    +
    +
    +
    +
    +

    The location was successfully set to a known location. +location is a valid SCPLocation.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPLocationStatusSet
    + +
    +
    +

    Swift

    + 
    case set = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This location is known to be not set. location will be nil.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPLocationStatusNotSet
    + +
    +
    +

    Swift

    + 
    case notSet = 2
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPLogLevel.html b/docs/2.19.0/Enums/SCPLogLevel.html new file mode 100644 index 00000000..e65b3157 --- /dev/null +++ b/docs/2.19.0/Enums/SCPLogLevel.html @@ -0,0 +1,505 @@ + + + + SCPLogLevel Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPLogLevel Enumeration Reference +

+ +
+ +
+ +
+
+

SCPLogLevel

+
+
+

Objective-C

+ 
enum SCPLogLevel : NSUInteger {}
+ +
+
+

Swift

+ 
enum LogLevel : UInt, @unchecked Sendable
+ +
+
+

The various log levels for the SDK.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + SCPLogLevelNone + +
    +
    +
    +
    +
    +
    +

    No logs will printed to the console.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPLogLevelNone
    + +
    +
    +

    Swift

    + 
    case none = 0
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPLogLevelVerbose + +
    +
    +
    +
    +
    +
    +

    Verbose logs will be printed to the console.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPLogLevelVerbose
    + +
    +
    +

    Swift

    + 
    case verbose = 1
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPPaymentIntentStatus.html b/docs/2.19.0/Enums/SCPPaymentIntentStatus.html new file mode 100644 index 00000000..5d0481ca --- /dev/null +++ b/docs/2.19.0/Enums/SCPPaymentIntentStatus.html @@ -0,0 +1,635 @@ + + + + SCPPaymentIntentStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPPaymentIntentStatus Enumeration Reference +

+ +
+ +
+ +
+
+

SCPPaymentIntentStatus

+
+
+

Objective-C

+ 
enum SCPPaymentIntentStatus : NSUInteger {}
+ +
+
+

Swift

+ 
enum PaymentIntentStatus : UInt, @unchecked Sendable
+ +
+
+

The possible statuses for a PaymentIntent.

+ +

https://stripe.com/docs/api/payment_intents/object#payment_intent_object-status

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Next step: collect a payment method by calling collectPaymentMethod.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentIntentStatusRequiresPaymentMethod
    + +
    +
    +

    Swift

    + 
    case requiresPaymentMethod = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Next step: process the payment by calling processPayment.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentIntentStatusRequiresConfirmation
    + +
    +
    +

    Swift

    + 
    case requiresConfirmation = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Next step: capture the PaymentIntent on your backend via the Stripe API.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentIntentStatusRequiresCapture
    + +
    +
    +

    Swift

    + 
    case requiresCapture = 2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The PaymentIntent is in the middle of full EMV processing.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentIntentStatusProcessing
    + +
    +
    +

    Swift

    + 
    case processing = 3
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The PaymentIntent was canceled.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentIntentStatusCanceled
    + +
    +
    +

    Swift

    + 
    case canceled = 4
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The PaymentIntent succeeded.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentIntentStatusSucceeded
    + +
    +
    +

    Swift

    + 
    case succeeded = 5
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPPaymentMethodType.html b/docs/2.19.0/Enums/SCPPaymentMethodType.html new file mode 100644 index 00000000..66b1ed0a --- /dev/null +++ b/docs/2.19.0/Enums/SCPPaymentMethodType.html @@ -0,0 +1,574 @@ + + + + SCPPaymentMethodType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPPaymentMethodType Enumeration Reference +

+ +
+ +
+ +
+
+

SCPPaymentMethodType

+
+
+

Objective-C

+ 
enum SCPPaymentMethodType : NSUInteger {}
+ +
+
+

Swift

+ 
enum PaymentMethodType : UInt, @unchecked Sendable
+ +
+
+

The type of the PaymentMethod.

+
+

See

+ https://stripe.com/docs/api/payment_methods/object#payment_method_object-type + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    A card payment method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentMethodTypeCard
    + +
    +
    +

    Swift

    + 
    case card = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A card present payment method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentMethodTypeCardPresent
    + +
    +
    +

    Swift

    + 
    case cardPresent = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    An Interac Present payment method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentMethodTypeInteracPresent
    + +
    +
    +

    Swift

    + 
    case interacPresent = 2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    An unknown type.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentMethodTypeUnknown
    + +
    +
    +

    Swift

    + 
    case unknown = 3
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPPaymentStatus.html b/docs/2.19.0/Enums/SCPPaymentStatus.html new file mode 100644 index 00000000..5b5fcd7b --- /dev/null +++ b/docs/2.19.0/Enums/SCPPaymentStatus.html @@ -0,0 +1,576 @@ + + + + SCPPaymentStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPPaymentStatus Enumeration Reference +

+ +
+ +
+ +
+
+

SCPPaymentStatus

+
+
+

Objective-C

+ 
enum SCPPaymentStatus : NSUInteger {}
+ +
+
+

Swift

+ 
enum PaymentStatus : UInt, @unchecked Sendable
+ +
+
+

The possible payment statuses for the SDK.

+
+

See

+ https://stripe.com/docs/terminal/payments + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The SDK is not ready to start a payment. It may be busy with another +command, or a reader may not be connected.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentStatusNotReady
    + +
    +
    +

    Swift

    + 
    case notReady = 0
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPPaymentStatusReady + +
    +
    +
    +
    +
    +
    +

    The SDK is ready to start a payment.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentStatusReady
    + +
    +
    +

    Swift

    + 
    case ready = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SDK is waiting for input from the customer (e.g., for a card to +be presented to the reader)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentStatusWaitingForInput
    + +
    +
    +

    Swift

    + 
    case waitingForInput = 2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SDK is processing a payment.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentStatusProcessing
    + +
    +
    +

    Swift

    + 
    case processing = 3
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPReaderDisplayMessage.html b/docs/2.19.0/Enums/SCPReaderDisplayMessage.html new file mode 100644 index 00000000..0933ea7a --- /dev/null +++ b/docs/2.19.0/Enums/SCPReaderDisplayMessage.html @@ -0,0 +1,699 @@ + + + + SCPReaderDisplayMessage Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPReaderDisplayMessage Enumeration Reference +

+ +
+ +
+ +
+
+

SCPReaderDisplayMessage

+
+
+

Objective-C

+ 
enum SCPReaderDisplayMessage : NSUInteger {}
+ +
+
+

Swift

+ 
enum ReaderDisplayMessage : UInt, @unchecked Sendable
+ +
+
+

The display messages that a reader may request be displayed by your app. Used by [SCPBluetoothReaderDelegate reader:didRequestReaderDisplayMessage:].

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Retry the presented card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderDisplayMessageRetryCard
    + +
    +
    +

    Swift

    + 
    case retryCard = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Insert the presented card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderDisplayMessageInsertCard
    + +
    +
    +

    Swift

    + 
    case insertCard = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Insert or swipe the presented card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderDisplayMessageInsertOrSwipeCard
    + +
    +
    +

    Swift

    + 
    case insertOrSwipeCard = 2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Swipe the presented card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderDisplayMessageSwipeCard
    + +
    +
    +

    Swift

    + 
    case swipeCard = 3
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Remove the presented card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderDisplayMessageRemoveCard
    + +
    +
    +

    Swift

    + 
    case removeCard = 4
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The reader detected multiple contactless cards. Make sure only one +contactless card or NFC device is near the reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderDisplayMessageMultipleContactlessCardsDetected
    + +
    +
    +

    Swift

    + 
    case multipleContactlessCardsDetected = 5
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The card could not be read. Try another read method on the same card, or +use a different card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderDisplayMessageTryAnotherReadMethod
    + +
    +
    +

    Swift

    + 
    case tryAnotherReadMethod = 6
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The card is invalid. Try another card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderDisplayMessageTryAnotherCard
    + +
    +
    +

    Swift

    + 
    case tryAnotherCard = 7
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPReaderEvent.html b/docs/2.19.0/Enums/SCPReaderEvent.html new file mode 100644 index 00000000..35708369 --- /dev/null +++ b/docs/2.19.0/Enums/SCPReaderEvent.html @@ -0,0 +1,505 @@ + + + + SCPReaderEvent Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPReaderEvent Enumeration Reference +

+ +
+ +
+ +
+
+

SCPReaderEvent

+
+
+

Objective-C

+ 
enum SCPReaderEvent : NSUInteger {}
+ +
+
+

Swift

+ 
enum ReaderEvent : UInt, @unchecked Sendable
+ +
+
+

The possible events from a connected reader. Used by [SCPBluetoothReaderDelegate reader:didReportReaderEvent:info:].

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    A card was inserted.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderEventCardInserted
    + +
    +
    +

    Swift

    + 
    case cardInserted = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A card was removed.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderEventCardRemoved
    + +
    +
    +

    Swift

    + 
    case cardRemoved = 1
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPReaderInputOptions.html b/docs/2.19.0/Enums/SCPReaderInputOptions.html new file mode 100644 index 00000000..80a96d0d --- /dev/null +++ b/docs/2.19.0/Enums/SCPReaderInputOptions.html @@ -0,0 +1,565 @@ + + + + SCPReaderInputOptions Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPReaderInputOptions Enumeration Reference +

+ +
+ +
+ +
+
+

SCPReaderInputOptions

+
+
+

Objective-C

+ 
enum SCPReaderInputOptions : NSUInteger {}
+ +
+
+

Swift

+ 
struct ReaderInputOptions : OptionSet, @unchecked Sendable
+ +
+
+

This OptionSet represents all of the input methods available to your user when +the reader begins waiting for input. Used by [SCPBluetoothReaderDelegate reader:didRequestReaderInput:].

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    No input options are available on the reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderInputOptionNone = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Swipe a magstripe card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderInputOptionSwipeCard = 1 << 0
    + +
    +
    +

    Swift

    + 
    static var swipeCard: ReaderInputOptions { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Insert a chip card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderInputOptionInsertCard = 1 << 1
    + +
    +
    +

    Swift

    + 
    static var insertCard: ReaderInputOptions { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Tap a contactless card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderInputOptionTapCard = 1 << 2
    + +
    +
    +

    Swift

    + 
    static var tapCard: ReaderInputOptions { get }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPReaderNetworkStatus.html b/docs/2.19.0/Enums/SCPReaderNetworkStatus.html new file mode 100644 index 00000000..d9700139 --- /dev/null +++ b/docs/2.19.0/Enums/SCPReaderNetworkStatus.html @@ -0,0 +1,511 @@ + + + + SCPReaderNetworkStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPReaderNetworkStatus Enumeration Reference +

+ +
+ +
+ +
+
+

SCPReaderNetworkStatus

+
+
+

Objective-C

+ 
enum SCPReaderNetworkStatus : NSUInteger {}
+ +
+
+

Swift

+ 
enum ReaderNetworkStatus : UInt, @unchecked Sendable
+ +
+
+

The possible networking statuses for a reader.

+
+

See

+ https://stripe.com/docs/api/terminal/readers/object + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The reader is offline. Note that Chipper 2x and WisePad 3 will always report +offline.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderNetworkStatusOffline
    + +
    +
    +

    Swift

    + 
    case offline = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The reader is online.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderNetworkStatusOnline
    + +
    +
    +

    Swift

    + 
    case online = 1
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPRefundStatus.html b/docs/2.19.0/Enums/SCPRefundStatus.html new file mode 100644 index 00000000..3a66c318 --- /dev/null +++ b/docs/2.19.0/Enums/SCPRefundStatus.html @@ -0,0 +1,574 @@ + + + + SCPRefundStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPRefundStatus Enumeration Reference +

+ +
+ +
+ +
+
+

SCPRefundStatus

+
+
+

Objective-C

+ 
enum SCPRefundStatus : NSUInteger {}
+ +
+
+

Swift

+ 
enum RefundStatus : UInt, @unchecked Sendable
+ +
+
+

The possible statuses for a refund.

+
+

See

+ https://stripe.com/docs/api/refunds/object#refund_object-status + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The refund succeeded.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPRefundStatusSucceeded
    + +
    +
    +

    Swift

    + 
    case succeeded = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The refund is pending.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPRefundStatusPending
    + +
    +
    +

    Swift

    + 
    case pending = 1
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPRefundStatusFailed + +
    +
    +
    +
    +
    +
    +

    The refund failed.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPRefundStatusFailed
    + +
    +
    +

    Swift

    + 
    case failed = 2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Unknown refund state.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPRefundStatusUnknown
    + +
    +
    +

    Swift

    + 
    case unknown = 3
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPSetupIntentStatus.html b/docs/2.19.0/Enums/SCPSetupIntentStatus.html new file mode 100644 index 00000000..e31fef63 --- /dev/null +++ b/docs/2.19.0/Enums/SCPSetupIntentStatus.html @@ -0,0 +1,641 @@ + + + + SCPSetupIntentStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPSetupIntentStatus Enumeration Reference +

+ +
+ +
+ +
+
+

SCPSetupIntentStatus

+
+
+

Objective-C

+ 
enum SCPSetupIntentStatus : NSUInteger {}
+ +
+
+

Swift

+ 
enum SetupIntentStatus : UInt, @unchecked Sendable
+ +
+
+

The possible statuses of the SetupIntent.

+
+

See

+ https://stripe.com/docs/api/setup_intents/object#setup_intent_object-status + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Next step: collect a payment method by calling collectPaymentMethod.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSetupIntentStatusRequiresPaymentMethod
    + +
    +
    +

    Swift

    + 
    case requiresPaymentMethod = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Next step: confirm the SetupIntent by calling confirmSetupIntent.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSetupIntentStatusRequiresConfirmation
    + +
    +
    +

    Swift

    + 
    case requiresConfirmation = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    If the setup requires additional actions, such as authenticating with +3D Secure, the SetupIntent has a status of requires_action.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSetupIntentStatusRequiresAction
    + +
    +
    +

    Swift

    + 
    case requiresAction = 2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Once required actions are handled, the SetupIntent moves to processing. +While for certain payment methods (e.g., cards) processing can be quick, +other payment methods can take up to a few days to process.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSetupIntentStatusProcessing
    + +
    +
    +

    Swift

    + 
    case processing = 3
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SetupIntent was canceled.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSetupIntentStatusCanceled
    + +
    +
    +

    Swift

    + 
    case canceled = 4
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SetupIntent succeeded.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSetupIntentStatusSucceeded
    + +
    +
    +

    Swift

    + 
    case succeeded = 5
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPSetupIntentUsage.html b/docs/2.19.0/Enums/SCPSetupIntentUsage.html new file mode 100644 index 00000000..46f3b727 --- /dev/null +++ b/docs/2.19.0/Enums/SCPSetupIntentUsage.html @@ -0,0 +1,517 @@ + + + + SCPSetupIntentUsage Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPSetupIntentUsage Enumeration Reference +

+ +
+ +
+ +
+
+

SCPSetupIntentUsage

+
+
+

Objective-C

+ 
enum SCPSetupIntentUsage : NSUInteger {}
+ +
+
+

Swift

+ 
enum SetupIntentUsage : UInt, @unchecked Sendable
+ +
+
+

The SetupIntent usage options tell Stripe how the payment method is intended to be used in the future. +Stripe will use the chosen option to pick the most frictionless flow for the customer.

+
+

See

+ https://stripe.com/docs/payments/setup-intents#increasing-success-rate-by-specifying-usage + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    An off-session usage indicates to Stripe that future payments will take place +without the direct involvement of the customer. Creating an off-session SetupIntent +might incur some initial friction from additional authentication steps, +but can reduce customer intervention in later off-session payments.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSetupIntentUsageOffSession
    + +
    +
    +

    Swift

    + 
    case offSession = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    An on-session usage indicates to Stripe that future payments will take place +while the customer is actively in your checkout flow and able to authenticate +the payment method. With the on-session option, you can postpone authenticating +the card details until a future checkout to avoid upfront friction.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSetupIntentUsageOnSession
    + +
    +
    +

    Swift

    + 
    case onSession = 1
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPSimulateReaderUpdate.html b/docs/2.19.0/Enums/SCPSimulateReaderUpdate.html new file mode 100644 index 00000000..91360cb3 --- /dev/null +++ b/docs/2.19.0/Enums/SCPSimulateReaderUpdate.html @@ -0,0 +1,630 @@ + + + + SCPSimulateReaderUpdate Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPSimulateReaderUpdate Enumeration Reference +

+ +
+ +
+ +
+
+

SCPSimulateReaderUpdate

+
+
+

Objective-C

+ 
enum SCPSimulateReaderUpdate : NSUInteger {}
+ +
+
+

Swift

+ 
enum SimulateReaderUpdate : UInt, @unchecked Sendable
+ +
+
+

Enum used to simulate various types of reader updates being available for +a simulated bluetooth or local mobile reader.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Default value.

    + +
      +
    • When connecting to a Bluetooth reader, an update is available that is marked +as needing to be installed within 7 days.
      • +
    • When connecting to a Local Mobile reader, a mandatory update will complete +during the connection flow.
      • +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulateReaderUpdateAvailable = 0
    + +
    +
    +

    Swift

    + 
    case available = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    No updates are available

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulateReaderUpdateNone
    + +
    +
    +

    Swift

    + 
    case none = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A required full reader software update exists. Use this to simulate the +auto-install of a required update that will be applied during connect. +This simulated update will take 1 minute and progress will be provided +to the delegate provided to connectBluetoothReader or +connectLocalMobileReader as appropriate.

    +
    +

    See

    + SCPBluetoothReaderReaderDelegate + +
    +

    See

    + SCPLocalMobileReaderDelegate + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulateReaderUpdateRequired
    + +
    +
    +

    Swift

    + 
    case required = 2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A required update exists.

    + +
      +
    • When connecting to a Bluetooth reader, the connection will fail because +the reader’s battery is too low for an update to begin.
      • +
    • When connecting to a Local Mobile reader, a mandatory update will +complete during the connection flow.
      • +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulateReaderUpdateLowBattery
    + +
    +
    +

    Swift

    + 
    case lowBattery = 3
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Randomly picks a type of update for the reader to help exercise the +various states.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulateReaderUpdateRandom
    + +
    +
    +

    Swift

    + 
    case random = 4
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPSimulatedCardType.html b/docs/2.19.0/Enums/SCPSimulatedCardType.html new file mode 100644 index 00000000..092d3a17 --- /dev/null +++ b/docs/2.19.0/Enums/SCPSimulatedCardType.html @@ -0,0 +1,1359 @@ + + + + SCPSimulatedCardType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPSimulatedCardType Enumeration Reference +

+ +
+ +
+ +
+
+

SCPSimulatedCardType

+
+
+

Objective-C

+ 
enum SCPSimulatedCardType : NSUInteger {}
+ +
+
+

Swift

+ 
enum SimulatedCardType : UInt, @unchecked Sendable
+ +
+
+

Enum used to simulate various types of cards and error cases.

+
+

See

+ https://stripe.com/docs/terminal/testing#simulated-test-cards + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Visa

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeVisa = 0
    + +
    +
    +

    Swift

    + 
    case visa = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Visa (debit)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeVisaDebit
    + +
    +
    +

    Swift

    + 
    case visaDebit = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Mastercard

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeMastercard
    + +
    +
    +

    Swift

    + 
    case mastercard = 2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Mastercard (debit)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeMasterDebit
    + +
    +
    +

    Swift

    + 
    case masterDebit = 3
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Mastercard (prepaid)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeMastercardPrepaid
    + +
    +
    +

    Swift

    + 
    case mastercardPrepaid = 4
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    American Express

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeAmex
    + +
    +
    +

    Swift

    + 
    case amex = 5
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    American Express

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeAmex2
    + +
    +
    +

    Swift

    + 
    case amex2 = 6
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Discover

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeDiscover
    + +
    +
    +

    Swift

    + 
    case discover = 7
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Discover

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeDiscover2
    + +
    +
    +

    Swift

    + 
    case discover2 = 8
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Diners Club

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeDiners
    + +
    +
    +

    Swift

    + 
    case diners = 9
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Diners Club (14 digit card)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeDiners14Digit
    + +
    +
    +

    Swift

    + 
    case diners14Digit = 10
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    JCB

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeJcb
    + +
    +
    +

    Swift

    + 
    case jcb = 11
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    UnionPay

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeUnionPay
    + +
    +
    +

    Swift

    + 
    case unionPay = 12
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Interac

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeInterac
    + +
    +
    +

    Swift

    + 
    case interac = 13
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Eftpos Australia

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeEftposAuDebit
    + +
    +
    +

    Swift

    + 
    case eftposAuDebit = 14
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Eftpos Australia/Visa

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeEftposAuVisaDebit
    + +
    +
    +

    Swift

    + 
    case eftposAuVisaDebit = 15
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Eftpos Australia/Mastercard

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeEftposAuDebitMastercard
    + +
    +
    +

    Swift

    + 
    case eftposAuDebitMastercard = 16
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Charge is declined with a card_declined code.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeChargeDeclined
    + +
    +
    +

    Swift

    + 
    case chargeDeclined = 17
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Charge is declined with a card_declined code. The decline_code + attribute is insufficient_funds.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeChargeDeclinedInsufficientFunds
    + +
    +
    +

    Swift

    + 
    case chargeDeclinedInsufficientFunds = 18
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Charge is declined with a card_declined code. The decline_code + attribute is lost_card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeChargeDeclinedLostCard
    + +
    +
    +

    Swift

    + 
    case chargeDeclinedLostCard = 19
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Charge is declined with a card_declined code. The decline_code + attribute is stolen_card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeChargeDeclinedStolenCard
    + +
    +
    +

    Swift

    + 
    case chargeDeclinedStolenCard = 20
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Charge is declined with an expired_card code.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeChargeDeclinedExpiredCard
    + +
    +
    +

    Swift

    + 
    case chargeDeclinedExpiredCard = 21
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Charge is declined with a processing_error code.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeChargeDeclinedProcessingError
    + +
    +
    +

    Swift

    + 
    case chargeDeclinedProcessingError = 22
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Refund is declined with a refund_fail error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeRefundFailed
    + +
    +
    +

    Swift

    + 
    case refundFailed = 23
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Payment attaches Online Pin to the transaction. + cardholder_verification_method will be set to online_pin in the resulting paymentIntent + WisePad3 only

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeOnlinePinCvm
    + +
    +
    +

    Swift

    + 
    case onlinePinCvm = 24
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This flow simulates an Online Pin scenario with SCA compliance. + Payment is retried and user is prompted to input their pin. + Next an online pin being entered is simulated.

    +
    cardholder_verification_method will be set to online_pin in the resulting paymentIntent.
+WisePad3 only
+
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeOnlinePinScaRetry
    + +
    +
    +

    Swift

    + 
    case onlinePinScaRetry = 25
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Payment attaches Offline Pin to the transaction. + cardholder_verification_method will be set to offline_pin in the resulting paymentIntent + WisePad3 only

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeOfflinePinCvm
    + +
    +
    +

    Swift

    + 
    case offlinePinCvm = 26
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This flow simulates an Offline Pin scenario with SCA compliance. + Payment is retried and user is prompted to insert their card. + Next a contact retry and an offline pin being entered are simulated.

    +
    cardholder_verification_method will be set to offline_pin in the resulting paymentIntent.
+WisePad3 only
+
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeOfflinePinScaRetry
    + +
    +
    +

    Swift

    + 
    case offlinePinScaRetry = 27
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPUpdateComponent.html b/docs/2.19.0/Enums/SCPUpdateComponent.html new file mode 100644 index 00000000..187d0b98 --- /dev/null +++ b/docs/2.19.0/Enums/SCPUpdateComponent.html @@ -0,0 +1,589 @@ + + + + SCPUpdateComponent Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPUpdateComponent Enumeration Reference +

+ +
+ +
+ +
+
+

SCPUpdateComponent

+
+
+

Objective-C

+ 
enum SCPUpdateComponent : NSUInteger {}
+ +
+
+

Swift

+ 
struct UpdateComponent : OptionSet, @unchecked Sendable
+ +
+
+

A bitmask identifying what exact updates are contained within this update.

+ +

Note that the time estimates documented here are for each individual piece. Updates +will often contain multiple components together. Check the estimatedUpdateTime to +see how long the entire update process is expected to take for all components.

+
+

See

+ https://stripe.com/docs/terminal/readers/bbpos-chipper2xbt#reader-software-releases + +
+

See

+ https://stripe.com/docs/terminal/readers/bbpos-wisepad3#reader-software-releases + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    If set, the update contains incremental changes to the reader. If this is +the only component being updated, the deviceSoftwareVersion will not +differ from the existing installed version. Incremental updates should take +less than 1 minute.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPUpdateComponentIncremental = 1 << 0
    + +
    +
    +

    Swift

    + 
    static var incremental: UpdateComponent { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    If set, this update contains updated firmware for this reader. Firmware updates +can take 5 to 15 minutes.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPUpdateComponentFirmware = 1 << 1
    + +
    +
    +

    Swift

    + 
    static var firmware: UpdateComponent { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    If set, this update contains a new configuration for this reader. These may +contain regional changes or other card network updates. Configuration updates +are expected to take 1 to 2 minutes.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPUpdateComponentConfig = 1 << 2
    + +
    +
    +

    Swift

    + 
    static var config: UpdateComponent { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    If set, this update contains updated encryption keys for the reader. +Updating keys should take less than 1 minute.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPUpdateComponentKeys = 1 << 3
    + +
    +
    +

    Swift

    + 
    static var keys: UpdateComponent { get }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Enums/SCPUpdateTimeEstimate.html b/docs/2.19.0/Enums/SCPUpdateTimeEstimate.html new file mode 100644 index 00000000..9305f057 --- /dev/null +++ b/docs/2.19.0/Enums/SCPUpdateTimeEstimate.html @@ -0,0 +1,579 @@ + + + + SCPUpdateTimeEstimate Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPUpdateTimeEstimate Enumeration Reference +

+ +
+ +
+ +
+
+

SCPUpdateTimeEstimate

+
+
+

Objective-C

+ 
enum SCPUpdateTimeEstimate : NSUInteger {}
+ +
+
+

Swift

+ 
enum UpdateTimeEstimate : UInt, @unchecked Sendable
+ +
+
+

The estimated amount of time for an update. Note that these times are estimates; +actual times may vary depending on your network and Bluetooth connection.

+
+

See

+ https://stripe.com/docs/terminal/readers/bbpos-chipper2xbt#reader-software-releases + +
+

See

+ https://stripe.com/docs/terminal/readers/bbpos-wisepad3#reader-software-releases + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The update should take less than 1 minute to complete.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPUpdateTimeEstimateLessThan1Minute
    + +
    +
    +

    Swift

    + 
    case estimateLessThan1Minute = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The update should take 1-2 minutes to complete.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPUpdateTimeEstimate1To2Minutes
    + +
    +
    +

    Swift

    + 
    case estimate1To2Minutes = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The update should take 2-5 minutes to complete.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPUpdateTimeEstimate2To5Minutes
    + +
    +
    +

    Swift

    + 
    case estimate2To5Minutes = 2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The update should take 5-15 minutes to complete.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPUpdateTimeEstimate5To15Minutes
    + +
    +
    +

    Swift

    + 
    case estimate5To15Minutes = 3
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Errors.html b/docs/2.19.0/Errors.html new file mode 100644 index 00000000..44e7d31f --- /dev/null +++ b/docs/2.19.0/Errors.html @@ -0,0 +1,964 @@ + + + + Errors Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + Errors Reference +

+ +
+ +
+ +
+
+

Errors

+ +
+
+ +
+
+
+
+ + +
+ +

SCPError +

+
+
+
    +
  • +
    + + + + SCPError + +
    +
    +
    +
    +
    +
    +

    Possible error codes for NSError objects under the SCPErrorDomain domain.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPError : NSInteger {}
    + +
    +
    +

    Swift

    + 
    typealias ErrorCode.Code._ErrorType = ErrorCode
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPErrorDomain + +
    +
    +
    +
    +
    +
    +

    The error domain for all errors originating from the Stripe Terminal SDK.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern NSString *const _Nonnull SCPErrorDomain
    + +
    +
    +

    Swift

    + 
    let ErrorDomain: String
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

UserInfo keys +

+
+
+
    +
  • +
    + + + + SCPErrorKey + +
    +
    +
    +
    +
    +
    +

    Use this enum to access userInfo keys for NSError objects under the +SCPErrorDomain domain.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef NSString *const SCPErrorKey
    + +
    +
    +

    Swift

    + 
    struct ErrorKey : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPErrorKeyMessage + +
    +
    +
    +
    +
    +
    +

    An error message explaining what went wrong. You probably shouldn’t show this +to your users, but may want to use it yourself.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern SCPErrorKey _Nonnull SCPErrorKeyMessage
    + +
    +
    +

    Swift

    + 
    static let message: ErrorKey
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The HTTP status code of the response.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern SCPErrorKey _Nonnull SCPErrorKeyHttpStatusCode
    + +
    +
    +

    Swift

    + 
    static let httpStatusCode: ErrorKey
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This error message comes from the reader. You probably shouldn’t show this +to your users, but may want to inspect it yourself.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern SCPErrorKey _Nonnull SCPErrorKeyReaderMessage
    + +
    +
    +

    Swift

    + 
    static let readerMessage: ErrorKey
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    If an Apple Built-In reader fails to connect due to a device ban and the error +has an associated ban expiry date, the NSDate will be returned +under this key.

    +
    +

    See

    + SCPErrorAppleBuiltInReaderDeviceBanned + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern SCPErrorKey _Nonnull SCPErrorKeyDeviceBannedUntilDate
    + +
    +
    +

    Swift

    + 
    static let deviceBannedUntilDate: ErrorKey
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    If a Stripe API request failed, the failed request’s id will be returned in the +error under this key.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern SCPErrorKey _Nonnull SCPErrorKeyStripeAPIRequestId
    + +
    +
    +

    Swift

    + 
    static let stripeAPIRequestId: ErrorKey
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The decline code returned by the Stripe API.

    +
    +

    See

    + https://stripe.com/docs/api#errors-decline_code + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern SCPErrorKey _Nonnull SCPErrorKeyStripeAPIDeclineCode
    + +
    +
    +

    Swift

    + 
    static let stripeAPIDeclineCode: ErrorKey
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The error code returned by the Stripe API.

    +
    +

    See

    + https://stripe.com/docs/api#errors-code + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern SCPErrorKey _Nonnull SCPErrorKeyStripeAPIErrorCode
    + +
    +
    +

    Swift

    + 
    static let stripeAPIErrorCode: ErrorKey
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The parameter the error relates to if the error is parameter-specific.

    +
    +

    See

    + https://stripe.com/docs/api#errors-param + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern SCPErrorKey _Nonnull SCPErrorKeyStripeAPIErrorParameter
    + +
    +
    +

    Swift

    + 
    static let stripeAPIErrorParameter: ErrorKey
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The error type returned by the Stripe API.

    +
    +

    See

    + https://stripe.com/docs/api#errors-type + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern SCPErrorKey _Nonnull SCPErrorKeyStripeAPIErrorType
    + +
    +
    +

    Swift

    + 
    static let stripeAPIErrorType: ErrorKey
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    If a Stripe API request failed and the error has an associated PaymentIntent, +the SCPPaymentIntent will be returned under this key.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern SCPErrorKey _Nonnull SCPErrorKeyStripeAPIPaymentIntent
    + +
    +
    +

    Swift

    + 
    static let stripeAPIPaymentIntent: ErrorKey
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The documentation URL for the error returned by the Stripe API.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern SCPErrorKey _Nonnull SCPErrorKeyStripeAPIDocUrl
    + +
    +
    +

    Swift

    + 
    static let stripeAPIDocUrl: ErrorKey
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    If a refund fails, the reason for refund failure if known. Possible values +are lost_or_stolen_card, expired_or_canceled_card, or unknown.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern SCPErrorKey _Nonnull SCPErrorKeyStripeAPIFailureReason
    + +
    +
    +

    Swift

    + 
    static let stripeAPIFailureReason: ErrorKey
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Payment.html b/docs/2.19.0/Payment.html new file mode 100644 index 00000000..67ae82e8 --- /dev/null +++ b/docs/2.19.0/Payment.html @@ -0,0 +1,1404 @@ + + + + Payment Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + Payment Reference +

+ +
+ +
+ +
+
+

Payment

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Protocols/SCPBluetoothReaderDelegate.html b/docs/2.19.0/Protocols/SCPBluetoothReaderDelegate.html new file mode 100644 index 00000000..d34121ac --- /dev/null +++ b/docs/2.19.0/Protocols/SCPBluetoothReaderDelegate.html @@ -0,0 +1,1135 @@ + + + + SCPBluetoothReaderDelegate Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPBluetoothReaderDelegate Protocol Reference +

+ +
+ +
+ +
+
+

SCPBluetoothReaderDelegate

+
+
+

Objective-C

+ 
@protocol SCPBluetoothReaderDelegate <NSObject>
+ +
+
+

Swift

+ 
protocol BluetoothReaderDelegate : NSObjectProtocol
+ +
+
+

Implement this protocol to handle a connected Bluetooth reader’s events throughout +the lifetime of its connection.

+ +

Implementing this delegate is required when connecting to any Bluetooth connected +reader, such as the Chipper 2X BT and the WisePad 3.

+ +

The provided delegate must be retained by your application until the reader disconnects.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The SDK is reporting that an update is available for the reader. +This update should be installed at the earliest convenience via +-[SCPTerminal installUpdate:]

    + +

    Check the SCPReaderSoftwareUpdate.requiredAt field to see when this update +will be a required update. Required updates are installed immediately upon connection.

    + +

    This delegate method is most likely to be called right after connectReader: but +applications that stay connected to the reader for long periods of time should expect +this method to be called any time the reader is not busy performing a transaction.

    +
    +

    See

    +

    https://stripe.com/docs/terminal/readers/bbpos-chipper2xbt#updating-reader-software

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)reader:(nonnull SCPReader *)reader
+    didReportAvailableUpdate:(nonnull SCPReaderSoftwareUpdate *)update;
    + +
    +
    +

    Swift

    + 
    func reader(_ reader: SCPReader, didReportAvailableUpdate update: SCPReaderSoftwareUpdate)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + update + + +
    +

    An SCPReaderSoftwareUpdate object representing the update to be installed.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SDK is reporting that the reader has started installing a software update.

    + +

    There are two scenarios when a reader’s software update can be installed. Some +updates must be installed immediately, and may be being installed automatically +during connectReader:. Other updates can be delayed, and will be installed +when your integration calls installAvailableUpdate.

    + +

    Required updates will only start installing during connectReader:. Once your app’s +connectReader: completion is called, didStartInstallingUpdate: will only fire +from requests to install via installUpdate:.

    + +

    Note that required updates are critical for the reader to have the +correct configuration and prevent receiving SCPErrorUnsupportedReaderVersion. +Updates that aren’t yet required are reported by reader:didReportUpdateAvailable:.

    +
    +

    See

    +

    https://stripe.com/docs/terminal/readers/bbpos-chipper2xbt#updating-reader-software

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)reader:(nonnull SCPReader *)reader
+    didStartInstallingUpdate:(nonnull SCPReaderSoftwareUpdate *)update
+                  cancelable:(nullable SCPCancelable *)cancelable;
    + +
    +
    +

    Swift

    + 
    func reader(_ reader: SCPReader, didStartInstallingUpdate update: SCPReaderSoftwareUpdate, cancelable: SCPCancelable?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + update + + +
    +

    The SCPReaderSoftwareUpdate with an estimatedUpdateTime that +can be used to communicate how long the update is expected to take.

    +
    +
    + + cancelable + + +
    +

    This cancelable is provided to cancel the +installation if needed. Canceling a required update will result in a failed +connect with error SCPErrorUnsupportedReaderVersion. Incremental only updates will +have a nil cancelable because these updates can not be canceled.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The reader reported progress on a software update.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)reader:(nonnull SCPReader *)reader
+    didReportReaderSoftwareUpdateProgress:(float)progress;
    + +
    +
    +

    Swift

    + 
    func reader(_ reader: SCPReader, didReportReaderSoftwareUpdateProgress progress: Float)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + progress + + +
    +

    An estimate of the progress of the software update +(in the range [0, 1]).

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The reader is reporting that an installation has finished. If the install was +successful, error will be nil.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)reader:(nonnull SCPReader *)reader
+    didFinishInstallingUpdate:(nullable SCPReaderSoftwareUpdate *)update
+                        error:(nullable NSError *)error;
    + +
    +
    +

    Swift

    + 
    func reader(_ reader: SCPReader, didFinishInstallingUpdate update: SCPReaderSoftwareUpdate?, error: Error?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + update + + +
    +

    The update that was being installed, if any. Calls to installAvailableUpdate + when no update is available will still report didFinishInstallingUpdate, but with + a nil update.

    +
    +
    + + error + + +
    +

    If the installed failed, this will describe the error preventing install.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method is called when the reader begins waiting for input. Your app +should prompt the customer to present a payment method using one of the given input +options. If the reader emits a prompt, the didRequestReaderDisplayMessage method +will be called.

    + +

    Use - [SCPTerminal stringFromReaderInputOptions] to get a user facing string for the input +options.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)reader:(nonnull SCPReader *)reader
+    didRequestReaderInput:(SCPReaderInputOptions)inputOptions;
    + +
    +
    +

    Swift

    + 
    func reader(_ reader: SCPReader, didRequestReaderInput inputOptions: ReaderInputOptions = [])
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + inputOptions + + +
    +

    The armed input options on the reader.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method is called to request that a prompt be displayed in your app. +For example, if the prompt is SwipeCard, your app should instruct the +user to present the card again by swiping it.

    + +

    Use - [SCPTerminal stringFromReaderDisplayMessage] to get a user facing string for the prompt.

    +
    +

    See

    +

    SCPReaderDisplayMessage

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)reader:(nonnull SCPReader *)reader
+    didRequestReaderDisplayMessage:(SCPReaderDisplayMessage)displayMessage;
    + +
    +
    +

    Swift

    + 
    func reader(_ reader: SCPReader, didRequestReaderDisplayMessage displayMessage: ReaderDisplayMessage)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + displayMessage + + +
    +

    The message to display to the user.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SDK reported an event from the reader (e.g. a card was inserted).

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)reader:(nonnull SCPReader *)reader
+    didReportReaderEvent:(SCPReaderEvent)event
+                    info:(nullable NSDictionary *)info;
    + +
    +
    +

    Swift

    + 
    optional func reader(_ reader: SCPReader, didReportReaderEvent event: ReaderEvent, info: [AnyHashable : Any]?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + event + + +
    +

    The reader event.

    +
    +
    + + info + + +
    +

    Additional info associated with the event, or nil.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SDK reported the reader’s battery level or charging state has changed.

    +
    +

    See

    +

    SCPBatteryStatus

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)reader:(nonnull SCPReader *)reader
+    didReportBatteryLevel:(float)batteryLevel
+                   status:(SCPBatteryStatus)status
+               isCharging:(BOOL)isCharging;
    + +
    +
    +

    Swift

    + 
    optional func reader(_ reader: SCPReader, didReportBatteryLevel batteryLevel: Float, status: BatteryStatus, isCharging: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + batteryLevel + + +
    +

    The new battery level of the reader, a float from 0.0 to 1.0

    +
    +
    + + status + + +
    +

    The classification of the battery level. - see: SCPBatteryStatus

    +
    +
    + + isCharging + + +
    +

    YES if the reader is plugged in and charging.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method is called when the SDK’s currently connected reader has a low battery.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)readerDidReportLowBatteryWarning:(nonnull SCPReader *)reader;
    + +
    +
    +

    Swift

    + 
    optional func readerDidReportLowBatteryWarning(_ reader: SCPReader)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Protocols/SCPConnectionTokenProvider.html b/docs/2.19.0/Protocols/SCPConnectionTokenProvider.html new file mode 100644 index 00000000..4572eccc --- /dev/null +++ b/docs/2.19.0/Protocols/SCPConnectionTokenProvider.html @@ -0,0 +1,524 @@ + + + + SCPConnectionTokenProvider Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPConnectionTokenProvider Protocol Reference +

+ +
+ +
+ +
+
+

SCPConnectionTokenProvider

+
+
+

Objective-C

+ 
@protocol SCPConnectionTokenProvider
+ +
+
+

Swift

+ 
protocol ConnectionTokenProvider
+ +
+
+

Before integrating the SDK, you should create an endpoint on your backend +server that creates a new connection token via the Stripe Terminal API. The +connection token is used by the SDK to connect to a reader.

+ +

An overview of the lifecycle of a connection token:

+ +
    +
  • When Stripe Terminal is initialized, the SDK attempts to proactively request +an connection token from your backend server.
    • +
  • The SDK uses the connection to connect to a reader.
    • +
  • Subsequent calls to connect require a new connection token. If you disconnect +from a reader, and then call connect again, the SDK will need a new connection +token from your backend server.
    • +
+ +

We suggest making your application’s API client conform to this protocol.

+
+

See

+ https://stripe.com/docs/terminal/sdk/ios#connection-token + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Fetches a connection token from your backend server.

    + +

    On your backend server, use Stripe’s /v1/terminal/connection_tokens endpoint to +create a connection token, and return the connection_token string from the response +to your app. In your app, call the completion block with the connection token, +or an error if fetching the token failed.

    +
    +

    See

    +

    https://stripe.com/docs/api/terminal/connection_tokens/create

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)fetchConnectionToken:
+    (nonnull SCPConnectionTokenCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func fetchConnectionToken() async throws -> String
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    Call this with a connection token, or an error if +creating the connection token failed.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Protocols/SCPDiscoveryDelegate.html b/docs/2.19.0/Protocols/SCPDiscoveryDelegate.html new file mode 100644 index 00000000..5858a273 --- /dev/null +++ b/docs/2.19.0/Protocols/SCPDiscoveryDelegate.html @@ -0,0 +1,552 @@ + + + + SCPDiscoveryDelegate Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPDiscoveryDelegate Protocol Reference +

+ +
+ +
+ +
+
+

SCPDiscoveryDelegate

+
+
+

Objective-C

+ 
@protocol SCPDiscoveryDelegate <NSObject>
+ +
+
+

Swift

+ 
protocol DiscoveryDelegate : NSObjectProtocol
+ +
+
+

Implement this protocol to handle a continually updating list +of discovered readers. You must pass an SCPDiscoveryDelegate +when calling -[SCPTerminal discoverReaders:delegate:completion:].

+
+

See

+ https://stripe.com/docs/terminal/readers/connecting + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    This method will be called repeatedly until:

    + + + +

    You should not cache the SCPReader objects in the readers array. In other +words, after calling connectReader: with a discovered reader, you should not +attempt to cache and re-use the Reader object. The connectivity information +associated with the discovered Reader object will become stale. If no readers +have been found didUpdateDiscoveredReaders will be called with an empty +array.

    +

    Bluetooth Scan

    + +

    When discovering a reader using this method, this didUpdateDiscoveredReaders +delegate method will be called multiple times as the Bluetooth scan +proceeds.

    + +

    Your app should display an updating list of discovered readers if +your user is connecting to a reader for the first time.

    + +

    Otherwise, you may automatically select a previously saved reader. +Once a selection has been made, call the connectReader method to begin +connecting to the reader.

    +

    Bluetooth Proximity

    + +

    When discovering a reader using this method, this didUpdateDiscoveredReaders +delegate method will be called once. The reader’s LEDs will begin +flashing.

    +

    Internet

    + +

    When discovering a reader using this method, the didUpdateDiscoveredReaders +delegate method will only be called once. Both readers online and offline will +be sent to didUpdateDiscoveredReaders. Only an online reader can be connected +to, so it will be up to you to check its network status. If you have not +registered any readers to your account didUpdateDiscoveredReaders will be +called with an empty array. Note that this discovery method is currently only +compatable with VerifoneP400.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)terminal:(nonnull SCPTerminal *)terminal
+    didUpdateDiscoveredReaders:(nonnull NSArray<SCPReader *> *)readers;
    + +
    +
    +

    Swift

    + 
    func terminal(_ terminal: Terminal, didUpdateDiscoveredReaders readers: [SCPReader])
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + terminal + + +
    +

    The originating SCPTerminal.

    +
    +
    + + readers + + +
    +

    The discovered readers.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Protocols/SCPJSONDecodable.html b/docs/2.19.0/Protocols/SCPJSONDecodable.html new file mode 100644 index 00000000..5a5c39cc --- /dev/null +++ b/docs/2.19.0/Protocols/SCPJSONDecodable.html @@ -0,0 +1,508 @@ + + + + SCPJSONDecodable Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPJSONDecodable Protocol Reference +

+ +
+ +
+ +
+
+

SCPJSONDecodable

+
+
+

Objective-C

+ 
@protocol SCPJSONDecodable <NSObject>
+ +
+
+

Swift

+ 
protocol JSONDecodable : NSObjectProtocol
+ +
+
+

Objects conforming to this protocol can be instantiated by decoding a JSON +dictionary.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Parses a JSON dictionary into an instance of the class. Returns nil if the +object could not be decoded.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nullable instancetype)decodedObjectFromJSON:(nullable NSDictionary *)json;
    + +
    +
    +

    Swift

    + 
    static func decodedObject(fromJSON json: [AnyHashable : Any]?) -> Self?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + originalJSON + +
    +
    +
    +
    +
    +
    +

    The raw JSON used to create the object. This may be useful for accessing +fields that haven’t yet been made into properties in the SDK.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSDictionary *_Nonnull originalJSON;
    + +
    +
    +

    Swift

    + 
    var originalJSON: [AnyHashable : Any] { get }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Protocols/SCPLocalMobileReaderDelegate.html b/docs/2.19.0/Protocols/SCPLocalMobileReaderDelegate.html new file mode 100644 index 00000000..021f453e --- /dev/null +++ b/docs/2.19.0/Protocols/SCPLocalMobileReaderDelegate.html @@ -0,0 +1,859 @@ + + + + SCPLocalMobileReaderDelegate Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPLocalMobileReaderDelegate Protocol Reference +

+ +
+ +
+ +
+
+

SCPLocalMobileReaderDelegate

+
+
+

Objective-C

+ 
@protocol SCPLocalMobileReaderDelegate <NSObject>
+ +
+
+

Swift

+ 
protocol LocalMobileReaderDelegate : NSObjectProtocol
+ +
+
+

Implement this protocol to handle a connected local mobile reader’s events throughout +the lifetime of its connection.

+ +

Implementing this delegate is required when connecting to any Local Mobile reader.

+ +

The provided delegate must be retained by your application until the reader disconnects.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The reader has started installing a software update.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)localMobileReader:(nonnull SCPReader *)reader
+    didStartInstallingUpdate:(nonnull SCPReaderSoftwareUpdate *)update
+                  cancelable:(nullable SCPCancelable *)cancelable;
    + +
    +
    +

    Swift

    + 
    func localMobileReader(_ reader: SCPReader, didStartInstallingUpdate update: SCPReaderSoftwareUpdate, cancelable: SCPCancelable?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + update + + +
    +

    The SCPReaderSoftwareUpdate with an estimatedUpdateTime that +can be used to communicate how long the update is expected to take.

    +
    +
    + + cancelable + + +
    +

    This cancelable is provided to cancel the +installation if needed. Canceling a required update will result in a failed +connect with error SCPErrorUnsupportedReaderVersion. Some updates will +have a nil cancelable because these updates can not be canceled.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The reader reported progress on a software update.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)localMobileReader:(nonnull SCPReader *)reader
+    didReportReaderSoftwareUpdateProgress:(float)progress;
    + +
    +
    +

    Swift

    + 
    func localMobileReader(_ reader: SCPReader, didReportReaderSoftwareUpdateProgress progress: Float)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + progress + + +
    +

    An estimate of the progress of the software update +(in the range [0.0, 1.0]).

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The reader has finished installing an update.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)localMobileReader:(nonnull SCPReader *)reader
+    didFinishInstallingUpdate:(nullable SCPReaderSoftwareUpdate *)update
+                        error:(nullable NSError *)error;
    + +
    +
    +

    Swift

    + 
    func localMobileReader(_ reader: SCPReader, didFinishInstallingUpdate update: SCPReaderSoftwareUpdate?, error: Error?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + update + + +
    +

    The update that was being installed, if any.

    +
    +
    + + error + + +
    +

    If the installed failed, this will describe the error +preventing install. If it succeeded, the error will be nil.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method is called when the reader begins waiting for input. +Use - [SCPTerminal stringFromReaderInputOptions:] to get a user facing string +for the input options.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)localMobileReader:(nonnull SCPReader *)reader
+    didRequestReaderInput:(SCPReaderInputOptions)inputOptions;
    + +
    +
    +

    Swift

    + 
    func localMobileReader(_ reader: SCPReader, didRequestReaderInput inputOptions: ReaderInputOptions = [])
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + inputOptions + + +
    +

    The armed input options on the reader.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method is called to request that a prompt be displayed in your app. +Use - [SCPTerminal stringFromReaderDisplayMessage:] to get a user +facing string for the prompt.

    +
    +

    See

    + SCPReaderDisplayMessage + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)localMobileReader:(nonnull SCPReader *)reader
+    didRequestReaderDisplayMessage:(SCPReaderDisplayMessage)displayMessage;
    + +
    +
    +

    Swift

    + 
    func localMobileReader(_ reader: SCPReader, didRequestReaderDisplayMessage displayMessage: ReaderDisplayMessage)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + displayMessage + + +
    +

    The message to display to the user.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The reader is reporting that, as part of preparing to accept payments, +the terms of service has been accepted.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)localMobileReaderDidAcceptTermsOfService:(nonnull SCPReader *)reader;
    + +
    +
    +

    Swift

    + 
    optional func localMobileReaderDidAcceptTermsOfService(_ reader: SCPReader)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Protocols/SCPReconnectionDelegate.html b/docs/2.19.0/Protocols/SCPReconnectionDelegate.html new file mode 100644 index 00000000..5c6cc982 --- /dev/null +++ b/docs/2.19.0/Protocols/SCPReconnectionDelegate.html @@ -0,0 +1,622 @@ + + + + SCPReconnectionDelegate Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPReconnectionDelegate Protocol Reference +

+ +
+ +
+ +
+
+

SCPReconnectionDelegate

+
+
+

Objective-C

+ 
@protocol SCPReconnectionDelegate <NSObject>
+ +
+
+

Swift

+ 
protocol ReconnectionDelegate : NSObjectProtocol
+ +
+
+

Implement this protocol to handle bluetooth auto-reconnection.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The reader has lost Bluetooth connection to the SDK and reconnection attempts have been started.

    + +

    In your implementation of this method, you should notify your user that +the reader disconnected and that reconnection attempts are being made.

    + +

    Requires autoReconnectOnUnexpectedDisconnect is set to true in the SCPBluetoothConnectionConfig

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)terminal:(nonnull SCPTerminal *)terminal
+    didStartReaderReconnect:(nonnull SCPCancelable *)cancelable;
    + +
    +
    +

    Swift

    + 
    func terminal(_ terminal: Terminal, didStartReaderReconnect cancelable: SCPCancelable)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + terminal + + +
    +

    The originating terminal.

    +
    +
    + + cancelable + + +
    +

    A cancelable that can be used to stop reconnection

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SDK was able to reconnect to the previously connected Bluetooth reader.

    + +

    In your implementation of this method, you should notify your user that +reader connection has been re-established.

    + +

    Requires autoReconnectOnUnexpectedDisconnect is set to true in the SCPBluetoothConnectionConfig

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)terminalDidSucceedReaderReconnect:(nonnull SCPTerminal *)terminal;
    + +
    +
    +

    Swift

    + 
    func terminalDidSucceedReaderReconnect(_ terminal: Terminal)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + terminal + + +
    +

    The originating terminal.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SDK was not able to reconnect to the previously connected bluetooth reader. The SDK is now disconnected from any readers.

    + +

    In your implementation of this method, you should notify your user that +the reader has disconnected.

    + +

    Requires autoReconnectOnUnexpectedDisconnect is set to true in the SCPBluetoothConnectionConfig

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)terminalDidFailReaderReconnect:(nonnull SCPTerminal *)terminal;
    + +
    +
    +

    Swift

    + 
    func terminalDidFailReaderReconnect(_ terminal: Terminal)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + terminal + + +
    +

    The originating terminal.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Protocols/SCPTerminalDelegate.html b/docs/2.19.0/Protocols/SCPTerminalDelegate.html new file mode 100644 index 00000000..659864e3 --- /dev/null +++ b/docs/2.19.0/Protocols/SCPTerminalDelegate.html @@ -0,0 +1,653 @@ + + + + SCPTerminalDelegate Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPTerminalDelegate Protocol Reference +

+ +
+ +
+ +
+
+

SCPTerminalDelegate

+
+
+

Objective-C

+ 
@protocol SCPTerminalDelegate <NSObject>
+ +
+
+

Swift

+ 
protocol TerminalDelegate : NSObjectProtocol
+ +
+
+

Implement this protocol to handle connection and payment updates from the +Stripe Terminal iOS SDK.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The reader disconnected unexpectedly (that is, without your app explicitly +calling disconnectReader).

    + +

    In your implementation of this method, you should notify your user that +the reader disconnected. You may also want to call discoverReaders to begin +scanning for readers. Your app can attempt to automatically reconnect to the +disconnected reader, or display UI for your user to re-connect to a reader.

    + +

    You can trigger this call in your app by powering off the connected reader.

    +
    +

    See

    +

    https://stripe.com/docs/terminal/readers/connecting

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)terminal:(nonnull SCPTerminal *)terminal
+    didReportUnexpectedReaderDisconnect:(nonnull SCPReader *)reader;
    + +
    +
    +

    Swift

    + 
    func terminal(_ terminal: Terminal, didReportUnexpectedReaderDisconnect reader: SCPReader)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + terminal + + +
    +

    The originating terminal.

    +
    +
    + + reader + + +
    +

    The previously connected reader.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The currently connected reader’s connectionStatus changed.

    + +

    You should not use this method to detect when a reader unexpectedly +disconnects from your app, as it cannot be used to accurately distinguish +between expected and unexpected disconnect events. To detect unexpect +disconnects (e.g. to automatically notify your user), you should instead use +the -[SCPTerminalDelegate terminal:didReportUnexpectedReaderDisconnect:] method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)terminal:(nonnull SCPTerminal *)terminal
+    didChangeConnectionStatus:(SCPConnectionStatus)status;
    + +
    +
    +

    Swift

    + 
    optional func terminal(_ terminal: Terminal, didChangeConnectionStatus status: ConnectionStatus)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + terminal + + +
    +

    The originating terminal.

    +
    +
    + + status + + +
    +

    The SDK’s new connection status.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The currently connected reader’s paymentStatus changed.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)terminal:(nonnull SCPTerminal *)terminal
+    didChangePaymentStatus:(SCPPaymentStatus)status;
    + +
    +
    +

    Swift

    + 
    optional func terminal(_ terminal: Terminal, didChangePaymentStatus status: PaymentStatus)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + terminal + + +
    +

    The originating terminal.

    +
    +
    + + status + + +
    +

    The SDK’s new payment status.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Reader Discovery & Connection.html b/docs/2.19.0/Reader Discovery & Connection.html new file mode 100644 index 00000000..5b3f7fd0 --- /dev/null +++ b/docs/2.19.0/Reader Discovery & Connection.html @@ -0,0 +1,1023 @@ + + + + Reader Discovery & Connection Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + Reader Discovery & Connection Reference +

+ +
+ +
+ +
+
+

Reader Discovery & Connection

+ +
+
+ +
+
+
+
    +
  • +
    + + + + SCPDiscoveryMethod + +
    +
    +
    +
    +
    +
    +

    The possible methods for discovering a reader. Pass a variant of this enum +into your SCPDiscoveryConfiguration.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers/connecting + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPDiscoveryMethod : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum DiscoveryMethod : UInt, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPDiscoveryDelegate + +
    +
    +
    +
    +
    +
    +

    Implement this protocol to handle a continually updating list +of discovered readers. You must pass an SCPDiscoveryDelegate +when calling -[SCPTerminal discoverReaders:delegate:completion:].

    +
    +

    See

    + https://stripe.com/docs/terminal/readers/connecting + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @protocol SCPDiscoveryDelegate <NSObject>
    + +
    +
    +

    Swift

    + 
    protocol DiscoveryDelegate : NSObjectProtocol
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Configuration options for discovering readers.

    + +

    Objects of this type get passed into the Terminal.shared.discoverReaders() +method to control which devices get discovered, and how.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers/connecting + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPDiscoveryConfiguration : NSObject
    + +
    +
    +

    Swift

    + 
    class DiscoveryConfiguration : NSObject
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This class lets you define Bluetooth reader connection options.

    + +

    An object of this class should get passed into Terminal.shared.connectBluetoothReader().

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPBluetoothConnectionConfiguration : SCPConnectionConfiguration
    + +
    +
    +

    Swift

    + 
    class BluetoothConnectionConfiguration : ConnectionConfiguration
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This class lets you set options that define internet reader behavior throughout a given +reader-to-SDK connection session.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPInternetConnectionConfiguration : SCPConnectionConfiguration
    + +
    +
    +

    Swift

    + 
    class InternetConnectionConfiguration : ConnectionConfiguration
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This class lets you set options that define local mobile reader behavior throughout a given +reader-to-SDK connection session.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPLocalMobileConnectionConfiguration : SCPConnectionConfiguration
    + +
    +
    +

    Swift

    + 
    class LocalMobileConnectionConfiguration : ConnectionConfiguration
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPConnectionStatus + +
    +
    +
    +
    +
    +
    +

    The possible reader connection statuses for the SDK.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers/connecting + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPConnectionStatus : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum ConnectionStatus : UInt, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Parameters to be used when calling Terminal.shared.listLocations() to list +the Location objects associated with an account.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers/connecting + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPListLocationsParameters : NSObject
    + +
    +
    +

    Swift

    + 
    class ListLocationsParameters : NSObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPLocation + +
    +
    +
    +
    +
    +
    +

    A Location is used to group readers in the Stripe Terminal ecosystem. The +Location to which a reader is registered can control regional behavior +for that particular reader.

    + +

    You cannot create locations through the SDK. Instead, use the Stripe API +from your backend to manage your account’s locations.

    + +

    To fetch the Location objects associated with your account, call +Terminal.shared.listLocations().

    +
    +

    See

    + https://stripe.com/docs/api/terminal/locations + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPLocation : NSObject <SCPJSONDecodable>
    + +
    +
    +

    Swift

    + 
    class Location : NSObject, JSONDecodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPLocationStatus + +
    +
    +
    +
    +
    +
    +

    Represents the possible states of the location object for a +discovered reader.

    +
    +

    See

    + SCPReader + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPLocationStatus : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum LocationStatus : UInt, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPAddress + +
    +
    +
    +
    +
    +
    +

    Holds address data associated with a given SCPLocation.

    + +

    You cannot create SCPAddress objects from within the SDK. Instead, they will +be returned as an address property on an SCPLocation object retrieved +by the SDK.

    +
    +

    See

    + https://stripe.com/docs/api/terminal/locations/object#terminal_location_object-address + +
    +

    See

    + SCPLocation + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPAddress : NSObject <SCPJSONDecodable>
    + +
    +
    +

    Swift

    + 
    class Address : NSObject, JSONDecodable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Simulator specific configurations you can set to test your integration’s +behavior in different scenarios. We recommend changing these properties during +testing to ensure your app works as expected for different reader updates +and for different presented cards.

    + +

    Do not create new instances of this class. Instead, set the properties via +SCPTerminal.shared.simulatorConfiguration.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPSimulatorConfiguration : NSObject
    + +
    +
    +

    Swift

    + 
    class SimulatorConfiguration : NSObject
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Enum used to simulate various types of reader updates being available for +a simulated bluetooth or local mobile reader.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPSimulateReaderUpdate : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum SimulateReaderUpdate : UInt, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPSimulatedCard + +
    +
    +
    +
    +
    +
    +

    Simulated Card objects can be used with the shared SCPSimulatorConfiguration +to simulate different card brand and error cases with a simulated Reader.

    + +

    Simulated Card objects are backed by one of Stripe’s test card numbers, which +are hardcoded to provide certain behavior within Stripe’s backend. The +Terminal SDK provides an SCPSimulatedCardType enum that automatically maps +to the card numbers for convenience.

    +
    +

    See

    + https://stripe.com/docs/terminal/testing#simulated-test-cards + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPSimulatedCard : NSObject
    + +
    +
    +

    Swift

    + 
    class SimulatedCard : NSObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPSimulatedCardType + +
    +
    +
    +
    +
    +
    +

    Enum used to simulate various types of cards and error cases.

    +
    +

    See

    + https://stripe.com/docs/terminal/testing#simulated-test-cards + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPSimulatedCardType : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum SimulatedCardType : UInt, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Reader Updates.html b/docs/2.19.0/Reader Updates.html new file mode 100644 index 00000000..9b5a9e44 --- /dev/null +++ b/docs/2.19.0/Reader Updates.html @@ -0,0 +1,560 @@ + + + + Reader Updates Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + Reader Updates Reference +

+ +
+ +
+ +
+
+

Reader Updates

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Reader.html b/docs/2.19.0/Reader.html new file mode 100644 index 00000000..d62be28f --- /dev/null +++ b/docs/2.19.0/Reader.html @@ -0,0 +1,842 @@ + + + + Reader Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + Reader Reference +

+ +
+ +
+ +
+
+

Reader

+ +
+
+ +
+
+
+
    +
  • +
    + + + + SCPReader + +
    +
    +
    +
    +
    +
    +

    Information about a card reader that has been discovered by or connected to +the SDK.

    + +

    Some of the properties are only applicable to a certain device type. +These properties are labeled with the reader or reader type to which they apply.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPReader : NSObject <SCPJSONDecodable>
    + +
    +
    +

    Swift

    + 
    class Reader : NSObject, JSONDecodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPDeviceType + +
    +
    +
    +
    +
    +
    +

    The possible device types for a reader.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPDeviceType : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum DeviceType : UInt, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Implement this protocol to handle a connected Bluetooth reader’s events throughout +the lifetime of its connection.

    + +

    Implementing this delegate is required when connecting to any Bluetooth connected +reader, such as the Chipper 2X BT and the WisePad 3.

    + +

    The provided delegate must be retained by your application until the reader disconnects.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @protocol SCPBluetoothReaderDelegate <NSObject>
    + +
    +
    +

    Swift

    + 
    protocol BluetoothReaderDelegate : NSObjectProtocol
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Implement this protocol to handle a connected local mobile reader’s events throughout +the lifetime of its connection.

    + +

    Implementing this delegate is required when connecting to any Local Mobile reader.

    + +

    The provided delegate must be retained by your application until the reader disconnects.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @protocol SCPLocalMobileReaderDelegate <NSObject>
    + +
    +
    +

    Swift

    + 
    protocol LocalMobileReaderDelegate : NSObjectProtocol
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPReaderEvent + +
    +
    +
    +
    +
    +
    +

    The possible events from a connected reader. Used by [SCPBluetoothReaderDelegate reader:didReportReaderEvent:info:].

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPReaderEvent : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum ReaderEvent : UInt, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPReaderInputOptions + +
    +
    +
    +
    +
    +
    +

    This OptionSet represents all of the input methods available to your user when +the reader begins waiting for input. Used by [SCPBluetoothReaderDelegate reader:didRequestReaderInput:].

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPReaderInputOptions : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    struct ReaderInputOptions : OptionSet, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The display messages that a reader may request be displayed by your app. Used by [SCPBluetoothReaderDelegate reader:didRequestReaderDisplayMessage:].

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPReaderDisplayMessage : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum ReaderDisplayMessage : UInt, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The possible networking statuses for a reader.

    +
    +

    See

    + https://stripe.com/docs/api/terminal/readers/object + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPReaderNetworkStatus : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum ReaderNetworkStatus : UInt, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPBatteryStatus + +
    +
    +
    +
    +
    +
    +

    A categorization of a reader’s battery charge level.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPBatteryStatus : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum BatteryStatus : UInt, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPCart + +
    +
    +
    +
    +
    +
    +

    An SCPCart object contains information about what line items are included in +the current transaction. A cart object should be created and then passed into +Terminal.shared.setReaderDisplay(), which will display the cart’s contents +on the reader’s screen.

    + +

    The SCPCart only represents exactly what will be shown on the screen, and is +not reflective of what the customer is actually charged. You are +responsible for making sure that tax and total reflect what is in the cart.

    +
    +

    Note

    +

    Only Internet readers support setReaderDisplay functionality

    + +
    +

    See

    +

    https://stripe.com/docs/terminal/checkout/cart-display

    + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPCart : NSObject
    + +
    +
    +

    Swift

    + 
    class Cart : NSObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPCartLineItem + +
    +
    +
    +
    +
    +
    +

    Represents a single line item in an SCPCart, displayed on the reader’s screen +during checkout.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPCartLineItem : NSObject
    + +
    +
    +

    Swift

    + 
    class CartLineItem : NSObject
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Saving Cards.html b/docs/2.19.0/Saving Cards.html new file mode 100644 index 00000000..670b4327 --- /dev/null +++ b/docs/2.19.0/Saving Cards.html @@ -0,0 +1,798 @@ + + + + Saving Cards Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + Saving Cards Reference +

+ +
+ +
+ +
+
+

Saving Cards

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/Terminal.html b/docs/2.19.0/Terminal.html new file mode 100644 index 00000000..5bc370ad --- /dev/null +++ b/docs/2.19.0/Terminal.html @@ -0,0 +1,734 @@ + + + + Terminal Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + Terminal Reference +

+ +
+ +
+ +
+
+

Terminal

+ +
+
+ +
+
+
+
    +
  • +
    + + + + SCPTerminal + +
    +
    +
    +
    +
    +
    +

    The SCPTerminal singleton object exposes an interface for discovering readers, +connecting to a reader, creating payments, and saving card information for later +use.

    + +

    Before accessing the singleton object using the shared property, you must set +a ConnectionToken provider: an object that implements the SCPConnectionTokenProvider +protocol. This object should authenticate with your backend, then fetch the secret +from a freshly minted ConnectionToken.

    + +

    The SCPTerminal singleton can only be connected to one reader at a time, and +can only perform one operation at a time. As a general rule, make sure the +completion handler of one operation has been called before calling another +operation from within your app.

    + +

    The Stripe Terminal SDK sends updates to your app by using the delegate pattern. +You may want multiple views in your app to respond to these delegate calls. +We recommend creating a central delegate announcer which broadcasts all delegate +calls to views and ViewControllers that register themselves with that announcer. +We have an example implementation of a TerminalDelegateAnnouncer as part of our +example application.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPTerminal : NSObject
    + +
    +
    +

    Swift

    + 
    class Terminal : NSObject
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Before integrating the SDK, you should create an endpoint on your backend +server that creates a new connection token via the Stripe Terminal API. The +connection token is used by the SDK to connect to a reader.

    + +

    An overview of the lifecycle of a connection token:

    + +
      +
    • When Stripe Terminal is initialized, the SDK attempts to proactively request +an connection token from your backend server.
      • +
    • The SDK uses the connection to connect to a reader.
      • +
    • Subsequent calls to connect require a new connection token. If you disconnect +from a reader, and then call connect again, the SDK will need a new connection +token from your backend server.
      • +
    + +

    We suggest making your application’s API client conform to this protocol.

    +
    +

    See

    + https://stripe.com/docs/terminal/sdk/ios#connection-token + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @protocol SCPConnectionTokenProvider
    + +
    +
    +

    Swift

    + 
    protocol ConnectionTokenProvider
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPTerminalDelegate + +
    +
    +
    +
    +
    +
    +

    Implement this protocol to handle connection and payment updates from the +Stripe Terminal iOS SDK.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @protocol SCPTerminalDelegate <NSObject>
    + +
    +
    +

    Swift

    + 
    protocol TerminalDelegate : NSObjectProtocol
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Implement this protocol to handle bluetooth auto-reconnection.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @protocol SCPReconnectionDelegate <NSObject>
    + +
    +
    +

    Swift

    + 
    protocol ReconnectionDelegate : NSObjectProtocol
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPLogLevel + +
    +
    +
    +
    +
    +
    +

    The various log levels for the SDK.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPLogLevel : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum LogLevel : UInt, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPCancelable + +
    +
    +
    +
    +
    +
    +

    An object representing an action that can be canceled.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPCancelable : NSObject
    + +
    +
    +

    Swift

    + 
    class Cancelable : NSObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPJSONDecodable + +
    +
    +
    +
    +
    +
    +

    Objects conforming to this protocol can be instantiated by decoding a JSON +dictionary.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @protocol SCPJSONDecodable <NSObject>
    + +
    +
    +

    Swift

    + 
    protocol JSONDecodable : NSObjectProtocol
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPSDKVersion + +
    +
    +
    +
    +
    +
    +

    The current version of this library.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    static NSString *const _Nonnull SCPSDKVersion = @"2.19.0"
    + +
    +
    +

    Swift

    + 
    let SCPSDKVersion: String
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/css/highlight.css b/docs/2.19.0/css/highlight.css new file mode 100644 index 00000000..c170357c --- /dev/null +++ b/docs/2.19.0/css/highlight.css @@ -0,0 +1,202 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ +/* Credit to https://gist.github.com/wataru420/2048287 */ +.highlight .c { + color: #999988; + font-style: italic; } + +.highlight .err { + color: #a61717; + background-color: #e3d2d2; } + +.highlight .k { + color: #000000; + font-weight: bold; } + +.highlight .o { + color: #000000; + font-weight: bold; } + +.highlight .cm { + color: #999988; + font-style: italic; } + +.highlight .cp { + color: #999999; + font-weight: bold; } + +.highlight .c1 { + color: #999988; + font-style: italic; } + +.highlight .cs { + color: #999999; + font-weight: bold; + font-style: italic; } + +.highlight .gd { + color: #000000; + background-color: #ffdddd; } + +.highlight .gd .x { + color: #000000; + background-color: #ffaaaa; } + +.highlight .ge { + color: #000000; + font-style: italic; } + +.highlight .gr { + color: #aa0000; } + +.highlight .gh { + color: #999999; } + +.highlight .gi { + color: #000000; + background-color: #ddffdd; } + +.highlight .gi .x { + color: #000000; + background-color: #aaffaa; } + +.highlight .go { + color: #888888; } + +.highlight .gp { + color: #555555; } + +.highlight .gs { + font-weight: bold; } + +.highlight .gu { + color: #aaaaaa; } + +.highlight .gt { + color: #aa0000; } + +.highlight .kc { + color: #000000; + font-weight: bold; } + +.highlight .kd { + color: #000000; + font-weight: bold; } + +.highlight .kp { + color: #000000; + font-weight: bold; } + +.highlight .kr { + color: #000000; + font-weight: bold; } + +.highlight .kt { + color: #445588; } + +.highlight .m { + color: #009999; } + +.highlight .s { + color: #d14; } + +.highlight .na { + color: #008080; } + +.highlight .nb { + color: #0086B3; } + +.highlight .nc { + color: #445588; + font-weight: bold; } + +.highlight .no { + color: #008080; } + +.highlight .ni { + color: #800080; } + +.highlight .ne { + color: #990000; + font-weight: bold; } + +.highlight .nf { + color: #990000; } + +.highlight .nn { + color: #555555; } + +.highlight .nt { + color: #000080; } + +.highlight .nv { + color: #008080; } + +.highlight .ow { + color: #000000; + font-weight: bold; } + +.highlight .w { + color: #bbbbbb; } + +.highlight .mf { + color: #009999; } + +.highlight .mh { + color: #009999; } + +.highlight .mi { + color: #009999; } + +.highlight .mo { + color: #009999; } + +.highlight .sb { + color: #d14; } + +.highlight .sc { + color: #d14; } + +.highlight .sd { + color: #d14; } + +.highlight .s2 { + color: #d14; } + +.highlight .se { + color: #d14; } + +.highlight .sh { + color: #d14; } + +.highlight .si { + color: #d14; } + +.highlight .sx { + color: #d14; } + +.highlight .sr { + color: #009926; } + +.highlight .s1 { + color: #d14; } + +.highlight .ss { + color: #990073; } + +.highlight .bp { + color: #999999; } + +.highlight .vc { + color: #008080; } + +.highlight .vg { + color: #008080; } + +.highlight .vi { + color: #008080; } + +.highlight .il { + color: #009999; } diff --git a/docs/2.19.0/css/jazzy.css b/docs/2.19.0/css/jazzy.css new file mode 100644 index 00000000..c7bb9fe2 --- /dev/null +++ b/docs/2.19.0/css/jazzy.css @@ -0,0 +1,404 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ +*, *:before, *:after { + box-sizing: inherit; } + +body { + margin: 0; + background: #fff; + color: #333; + font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif; + letter-spacing: .2px; + -webkit-font-smoothing: antialiased; + box-sizing: border-box; } + +h1 { + font-size: 2rem; + font-weight: 700; + margin: 1.275em 0 0.6em; } + +h2 { + font-size: 1.75rem; + font-weight: 700; + margin: 1.275em 0 0.3em; } + +h3 { + font-size: 1.5rem; + font-weight: 700; + margin: 1em 0 0.3em; } + +h4 { + font-size: 1.25rem; + font-weight: 700; + margin: 1.275em 0 0.85em; } + +h5 { + font-size: 1rem; + font-weight: 700; + margin: 1.275em 0 0.85em; } + +h6 { + font-size: 1rem; + font-weight: 700; + margin: 1.275em 0 0.85em; + color: #777; } + +p { + margin: 0 0 1em; } + +ul, ol { + padding: 0 0 0 2em; + margin: 0 0 0.85em; } + +blockquote { + margin: 0 0 0.85em; + padding: 0 15px; + color: #858585; + border-left: 4px solid #e5e5e5; } + +img { + max-width: 100%; } + +a { + color: #4183c4; + text-decoration: none; } + a:hover, a:focus { + outline: 0; + text-decoration: underline; } + a.discouraged { + text-decoration: line-through; } + a.discouraged:hover, a.discouraged:focus { + text-decoration: underline line-through; } + +table { + background: #fff; + width: 100%; + border-collapse: collapse; + border-spacing: 0; + overflow: auto; + margin: 0 0 0.85em; } + +tr:nth-child(2n) { + background-color: #fbfbfb; } + +th, td { + padding: 6px 13px; + border: 1px solid #ddd; } + +hr { + height: 1px; + border: none; + background-color: #ddd; } + +pre { + margin: 0 0 1.275em; + padding: .85em 1em; + overflow: auto; + background: #f7f7f7; + font-size: .85em; + font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace; } + +code { + font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace; } + +.item-container p > code, .item-container li > code, .top-matter p > code, .top-matter li > code { + background: #f7f7f7; + padding: .2em; } + .item-container p > code:before, .item-container p > code:after, .item-container li > code:before, .item-container li > code:after, .top-matter p > code:before, .top-matter p > code:after, .top-matter li > code:before, .top-matter li > code:after { + letter-spacing: -.2em; + content: "\00a0"; } + +pre code { + padding: 0; + white-space: pre; } + +.content-wrapper { + display: flex; + flex-direction: column; } + @media (min-width: 768px) { + .content-wrapper { + flex-direction: row; } } +.header { + display: flex; + padding: 8px; + font-size: 0.875em; + background: #444; + color: #999; } + +.header-col { + margin: 0; + padding: 0 8px; } + +.header-col--primary { + flex: 1; } + +.header-link { + color: #fff; } + +.header-icon { + padding-right: 2px; + vertical-align: -3px; + height: 16px; } + +.breadcrumbs { + font-size: 0.875em; + padding: 8px 16px; + margin: 0; + background: #fbfbfb; + border-bottom: 1px solid #ddd; } + +.carat { + height: 10px; + margin: 0 5px; } + +.navigation { + order: 2; } + @media (min-width: 768px) { + .navigation { + order: 1; + width: 25%; + max-width: 300px; + padding-bottom: 64px; + overflow: hidden; + word-wrap: normal; + background: #fbfbfb; + border-right: 1px solid #ddd; } } +.nav-groups { + list-style-type: none; + padding-left: 0; } + +.nav-group-name { + border-bottom: 1px solid #ddd; + padding: 8px 0 8px 16px; } + +.nav-group-name-link { + color: #333; } + +.nav-group-tasks { + margin: 8px 0; + padding: 0 0 0 8px; } + +.nav-group-task { + font-size: 1em; + list-style-type: none; + white-space: nowrap; } + +.nav-group-task-link { + color: #808080; } + +.main-content { + order: 1; } + @media (min-width: 768px) { + .main-content { + order: 2; + flex: 1; + padding-bottom: 60px; } } +.section { + padding: 0 32px; + border-bottom: 1px solid #ddd; } + +.section-content { + max-width: 834px; + margin: 0 auto; + padding: 16px 0; } + +.section-name { + color: #666; + display: block; } + .section-name p { + margin-bottom: inherit; } + +.declaration .highlight { + overflow-x: initial; + padding: 8px 0; + margin: 0; + background-color: transparent; + border: none; } + +.task-group-section { + border-top: 1px solid #ddd; } + +.task-group { + padding-top: 0px; } + +.task-name-container a[name]:before { + content: ""; + display: block; } + +.section-name-container { + position: relative; } + .section-name-container .section-name-link { + position: absolute; + top: 0; + left: 0; + bottom: 0; + right: 0; + margin-bottom: 0; } + .section-name-container .section-name { + position: relative; + pointer-events: none; + z-index: 1; } + .section-name-container .section-name a { + pointer-events: auto; } + +.item-container { + padding: 0; } + +.item { + padding-top: 8px; + width: 100%; + list-style-type: none; } + .item a[name]:before { + content: ""; + display: block; } + .item .token, .item .direct-link { + display: inline-block; + text-indent: -20px; + padding-left: 3px; + margin-left: 20px; + font-size: 1rem; } + .item .declaration-note { + font-size: .85em; + color: #808080; + font-style: italic; } + +.pointer-container { + border-bottom: 1px solid #ddd; + left: -23px; + padding-bottom: 13px; + position: relative; + width: 110%; } + +.pointer { + left: 21px; + top: 7px; + display: block; + position: absolute; + width: 12px; + height: 12px; + border-left: 1px solid #ddd; + border-top: 1px solid #ddd; + background: #fff; + transform: rotate(45deg); } + +.height-container { + display: none; + position: relative; + width: 100%; + overflow: hidden; } + .height-container .section { + background: #fff; + border: 1px solid #ddd; + border-top-width: 0; + padding-top: 10px; + padding-bottom: 5px; + padding: 8px 16px; } + +.aside, .language { + padding: 6px 12px; + margin: 12px 0; + border-left: 5px solid #dddddd; + overflow-y: hidden; } + .aside .aside-title, .language .aside-title { + font-size: 9px; + letter-spacing: 2px; + text-transform: uppercase; + padding-bottom: 0; + margin: 0; + color: #aaa; + -webkit-user-select: none; } + .aside p:last-child, .language p:last-child { + margin-bottom: 0; } + +.language { + border-left: 5px solid #cde9f4; } + .language .aside-title { + color: #4183c4; } + +.aside-warning, .aside-deprecated, .aside-unavailable { + border-left: 5px solid #ff6666; } + .aside-warning .aside-title, .aside-deprecated .aside-title, .aside-unavailable .aside-title { + color: #ff0000; } + +.graybox { + border-collapse: collapse; + width: 100%; } + .graybox p { + margin: 0; + word-break: break-word; + min-width: 50px; } + .graybox td { + border: 1px solid #ddd; + padding: 5px 25px 5px 10px; + vertical-align: middle; } + .graybox tr td:first-of-type { + text-align: right; + padding: 7px; + vertical-align: top; + word-break: normal; + width: 40px; } + +.slightly-smaller { + font-size: 0.9em; } + +.footer { + padding: 8px 16px; + background: #444; + color: #ddd; + font-size: 0.8em; } + .footer p { + margin: 8px 0; } + .footer a { + color: #fff; } + +html.dash .header, html.dash .breadcrumbs, html.dash .navigation { + display: none; } + +html.dash .height-container { + display: block; } + +form[role=search] input { + font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif; + font-size: 14px; + line-height: 24px; + padding: 0 10px; + margin: 0; + border: none; + border-radius: 1em; } + .loading form[role=search] input { + background: white url(../img/spinner.gif) center right 4px no-repeat; } + +form[role=search] .tt-menu { + margin: 0; + min-width: 300px; + background: #fbfbfb; + color: #333; + border: 1px solid #ddd; } + +form[role=search] .tt-highlight { + font-weight: bold; } + +form[role=search] .tt-suggestion { + font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif; + padding: 0 8px; } + form[role=search] .tt-suggestion span { + display: table-cell; + white-space: nowrap; } + form[role=search] .tt-suggestion .doc-parent-name { + width: 100%; + text-align: right; + font-weight: normal; + font-size: 0.9em; + padding-left: 16px; } + +form[role=search] .tt-suggestion:hover, +form[role=search] .tt-suggestion.tt-cursor { + cursor: pointer; + background-color: #4183c4; + color: #fff; } + +form[role=search] .tt-suggestion:hover .doc-parent-name, +form[role=search] .tt-suggestion.tt-cursor .doc-parent-name { + color: #fff; } diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Info.plist b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Info.plist new file mode 100644 index 00000000..4b1e27d0 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Info.plist @@ -0,0 +1,20 @@ + + + + + CFBundleIdentifier + com.jazzy.stripeterminal + CFBundleName + StripeTerminal + DocSetPlatformFamily + stripeterminal + isDashDocset + + dashIndexFilePath + index.html + isJavaScriptEnabled + + DashDocSetFamily + dashtoc + + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Blocks.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Blocks.html new file mode 100644 index 00000000..1ae50c86 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Blocks.html @@ -0,0 +1,1187 @@ + + + + Blocks Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + Blocks Reference +

+ +
+ +
+ +
+
+

Blocks

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    A block called with a connection token or an error from your backend.

    +
    +

    See

    +

    SCPConnectionTokenProvider

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^SCPConnectionTokenCompletionBlock)(NSString *_Nullable,
+                                                  NSError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias ConnectionTokenCompletionBlock = (String?, Error?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + token + + +
    +

    The connection token from your backend server.

    +
    +
    + + error + + +
    +

    An error if one occurred, or nil.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A block called with an optional error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^SCPErrorCompletionBlock)(NSError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias ErrorCompletionBlock = (Error?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + error + + +
    +

    The error, or nil if no error occured.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPLogListenerBlock + +
    +
    +
    +
    +
    +
    +

    A block called with a logline from the SDK.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^SCPLogListenerBlock)(NSString *_Nonnull)
    + +
    +
    +

    Swift

    + 
    typealias LogListenerBlock = (String) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + logline + + +
    +

    An internal logline from the SDK.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A block called with a PaymentIntent or an error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^SCPPaymentIntentCompletionBlock)(SCPPaymentIntent *_Nullable,
+                                                NSError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias PaymentIntentCompletionBlock = (SCPPaymentIntent?, Error?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + intent + + +
    +

    The PaymentIntent, or nil.

    +
    +
    + + error + + +
    +

    An error if one occurred, or nil.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A block called with a PaymentMethod.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^SCPPaymentMethodCompletionBlock)(SCPPaymentMethod *_Nullable,
+                                                NSError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias PaymentMethodCompletionBlock = (SCPPaymentMethod?, Error?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + paymentMethod + + +
    +

    A PaymentMethod object, or nil if an error occurred.

    +
    +
    + + error + + +
    +

    An error if one occurred, or nil.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A block called with a PaymentIntent or a ProcessPaymentError

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^SCPProcessPaymentCompletionBlock)(
+    SCPPaymentIntent *_Nullable, SCPProcessPaymentError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias ProcessPaymentCompletionBlock = (SCPPaymentIntent?, SCPProcessPaymentError?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + intent + + +
    +

    The PaymentIntent, or nil.

    +
    +
    + + error + + +
    +

    An error if one occurred, or nil.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A block called with a reader object or an error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^SCPReaderCompletionBlock)(SCPReader *_Nullable,
+                                         NSError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias ReaderCompletionBlock = (SCPReader?, Error?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + reader + + +
    +

    A reader object, or nil.

    +
    +
    + + error + + +
    +

    An error if one occurred, or nil.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A block called with a Refund or a ProcessRefundError.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^SCPProcessRefundCompletionBlock)(
+    SCPRefund *_Nullable, SCPProcessRefundError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias ProcessRefundCompletionBlock = (SCPRefund?, SCPProcessRefundError?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + refund + + +
    +

    The Refund, or nil.

    +
    +
    + + error + + +
    +

    An error if one occurred, or nil.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A block called with a SetupIntent or a ConfirmSetupIntentError.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^SCPConfirmSetupIntentCompletionBlock)(
+    SCPSetupIntent *_Nullable, SCPConfirmSetupIntentError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias ConfirmSetupIntentCompletionBlock = (SCPSetupIntent?, SCPConfirmSetupIntentError?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + intent + + +
    +

    The SetupIntent, or nil.

    +
    +
    + + error + + +
    +

    An error if one occurred, or nil.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A block called with a list of Locations or an error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^SCPLocationsCompletionBlock)(NSArray<SCPLocation *> *_Nullable,
+                                            BOOL, NSError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias LocationsCompletionBlock = ([SCPLocation]?, Bool, Error?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + locations + + +
    +

    A list of Locations, or nil.

    +
    +
    + + hasMore + + +
    +

    Indicates whether there are more locations for the account; use the pagination parameters in SCPListLocationsParameters to fetch more locations

    +
    +
    + + error + + +
    +

    An error if one occurred, or nil.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A block called with a Refund or an error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^SCPRefundCompletionBlock)(SCPRefund *_Nullable,
+                                         NSError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias RefundCompletionBlock = (SCPRefund?, Error?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + refund + + +
    +

    The Refund, or nil.

    +
    +
    + + error + + +
    +

    An error if one occurred, or nil.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A block called with a SetupIntent or an error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^SCPSetupIntentCompletionBlock)(SCPSetupIntent *_Nullable,
+                                              NSError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias SetupIntentCompletionBlock = (SCPSetupIntent?, Error?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + intent + + +
    +

    The SetupIntent, or nil.

    +
    +
    + + error + + +
    +

    An error if one occurred, or nil.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Card-Present Refunds.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Card-Present Refunds.html new file mode 100644 index 00000000..8dfab0e8 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Card-Present Refunds.html @@ -0,0 +1,600 @@ + + + + Card-Present Refunds Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + Card-Present Refunds Reference +

+ +
+ +
+ +
+
+

Card-Present Refunds

+ +
+
+ +
+
+
+
    +
  • +
    + + + + SCPRefund + +
    +
    +
    +
    +
    +
    +

    An object representing a Stripe refund.

    + +

    Some payment methods, like Interac Debit payments, require that in-person payments +also be refunded while the cardholder is present. The cardholder must present +the Interac card to the card reader; these payments cannot be refunded via the +dashboard or the API.

    +
    +

    See

    + https://stripe.com/docs/terminal/canada#interac-refunds + +
    + +

    The collectRefundPaymentMethod:completion and processRefund SDK methods +allow you to build an in-person refund interface into your app.

    + +

    The refund SDK methods and the SCPRefund class are only available for +payment methods that require in-person refunds, such as Interac Debit. For +all other refunds, use the Stripe Dashboard or the Stripe API.

    +
    +

    See

    + https://stripe.com/docs/api#refunds + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPRefund : NSObject <SCPJSONDecodable>
    + +
    +
    +

    Swift

    + 
    class Refund : NSObject, JSONDecodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPRefundParameters + +
    +
    +
    +
    +
    +
    +

    Parameters for creating an SCPRefund.

    +
    +

    See

    + https://stripe.com/docs/api/refunds/create + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPRefundParameters : NSObject
    + +
    +
    +

    Swift

    + 
    class RefundParameters : NSObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPProcessRefundError + +
    +
    +
    +
    +
    +
    +

    An error from -[SCPTerminal processRefund:completion:].

    +
    +

    See

    + https://stripe.com/docs/terminal/canada#interac-refunds + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPProcessRefundError : NSError
    + +
    +
    +

    Swift

    + 
    class ProcessRefundError : NSError
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPRefundStatus + +
    +
    +
    +
    +
    +
    +

    The possible statuses for a refund.

    +
    +

    See

    + https://stripe.com/docs/api/refunds/object#refund_object-status + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPRefundStatus : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum RefundStatus : UInt, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPAddress.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPAddress.html new file mode 100644 index 00000000..1cc43df7 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPAddress.html @@ -0,0 +1,709 @@ + + + + SCPAddress Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPAddress Class Reference +

+ +
+ +
+ +
+
+

SCPAddress

+
+
+

Objective-C

+ 

+@interface SCPAddress : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class Address : NSObject, JSONDecodable
+ +
+
+

Holds address data associated with a given SCPLocation.

+ +

You cannot create SCPAddress objects from within the SDK. Instead, they will +be returned as an address property on an SCPLocation object retrieved +by the SDK.

+
+

See

+ https://stripe.com/docs/api/terminal/locations/object#terminal_location_object-address + +
+

See

+ SCPLocation + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + city + +
    +
    +
    +
    +
    +
    +

    The city name

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSString *city;
    + +
    +
    +

    Swift

    + 
    var city: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + country + +
    +
    +
    +
    +
    +
    +

    The country code

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSString *country;
    + +
    +
    +

    Swift

    + 
    var country: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + line1 + +
    +
    +
    +
    +
    +
    +

    The first line of the address

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSString *line1;
    + +
    +
    +

    Swift

    + 
    var line1: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + line2 + +
    +
    +
    +
    +
    +
    +

    The second line of the address

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSString *line2;
    + +
    +
    +

    Swift

    + 
    var line2: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + postalCode + +
    +
    +
    +
    +
    +
    +

    The postal code of the address

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSString *postalCode;
    + +
    +
    +

    Swift

    + 
    var postalCode: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + state + +
    +
    +
    +
    +
    +
    +

    The state of the address

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSString *state;
    + +
    +
    +

    Swift

    + 
    var state: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPAmountDetails.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPAmountDetails.html new file mode 100644 index 00000000..01e45108 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPAmountDetails.html @@ -0,0 +1,535 @@ + + + + SCPAmountDetails Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPAmountDetails Class Reference +

+ +
+ +
+ +
+
+

SCPAmountDetails

+
+
+

Objective-C

+ 
@interface SCPAmountDetails : NSObject <SCPJSONDecodable, NSCopying>
+ +
+
+

Swift

+ 
class SCPAmountDetails : NSObject, JSONDecodable, NSCopying
+ +
+
+

Contains details about items included in the [PaymentIntent] amount

+ +
+
+ +
+
+
+
    +
  • +
    + + + + tip + +
    +
    +
    +
    +
    +
    +

    Details about the tip

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPTip *tip;
    + +
    +
    +

    Swift

    + 
    var tip: SCPTip? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate SCPAmountDetails.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate SCPAmountDetails.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPBluetoothConnectionConfiguration.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPBluetoothConnectionConfiguration.html new file mode 100644 index 00000000..8b1d745d --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPBluetoothConnectionConfiguration.html @@ -0,0 +1,627 @@ + + + + SCPBluetoothConnectionConfiguration Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPBluetoothConnectionConfiguration Class Reference +

+ +
+ +
+ +
+
+

SCPBluetoothConnectionConfiguration

+
+
+

Objective-C

+ 

+@interface SCPBluetoothConnectionConfiguration : SCPConnectionConfiguration
+ +
+
+

Swift

+ 
class BluetoothConnectionConfiguration : ConnectionConfiguration
+ +
+
+

This class lets you define Bluetooth reader connection options.

+ +

An object of this class should get passed into Terminal.shared.connectBluetoothReader().

+ +
+
+ +
+
+
+
    +
  • +
    + + + + locationId + +
    +
    +
    +
    +
    +
    +

    The ID of the Location which the reader should be registered to during connection.

    + +

    If the provided ID matches the location the reader is already registered to, the +location will not be changed.

    + +

    When connecting to a simulated reader, pass in the reader’s pre-existing mock location. +You can find the mock location ID on the reader object returned to the DiscoveryDelegate, +on the locationId property.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers/fleet-management#bbpos-wisepad3-discovery + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull locationId;
    + +
    +
    +

    Swift

    + 
    var locationId: String { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    When set to true, the Terminal SDK will attempt a Bluetooth auto-reconnection on any unexpected disconnect. +You must also set an autoReconnectionDelegate for your application to respond accordingly to reconnection attempts. +Enabling autoReconnectOnUnexpectedDisconnect without providing an autoReconnectionDelegate will error with SCPErrorReaderConnectionConfigurationInvalid.

    + +

    When set to false, we will immediately surface any disconnection through TerminalDelegate.

    + +

    Defaults to false.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) BOOL autoReconnectOnUnexpectedDisconnect;
    + +
    +
    +

    Swift

    + 
    var autoReconnectOnUnexpectedDisconnect: Bool { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Contains callback methods for Bluetooth auto-reconnection.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, weak, readonly, nullable) id<SCPReconnectionDelegate> autoReconnectionDelegate;
    + +
    +
    +

    Swift

    + 
    weak var autoReconnectionDelegate: ReconnectionDelegate? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -initWithLocationId: + +
    +
    +
    +
    +
    +
    +

    Initialize your connect options with a location ID.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithLocationId:(nonnull NSString *)locationId;
    + +
    +
    +

    Swift

    + 
    init(locationId: String)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize your connect options with a location ID and an expected behavior for unexpected disconnects.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithLocationId:(nonnull NSString *)locationId
+       autoReconnectOnUnexpectedDisconnect:
+           (BOOL)autoReconnectOnUnexpectedDisconnect
+                  autoReconnectionDelegate:
+                      (nullable id<SCPReconnectionDelegate>)
+                          autoReconnectionDelegate;
    + +
    +
    +

    Swift

    + 
    init(locationId: String, autoReconnectOnUnexpectedDisconnect: Bool, autoReconnectionDelegate: ReconnectionDelegate?)
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCancelable.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCancelable.html new file mode 100644 index 00000000..12f88a0f --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCancelable.html @@ -0,0 +1,509 @@ + + + + SCPCancelable Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCancelable Class Reference +

+ +
+ +
+ +
+
+

SCPCancelable

+
+
+

Objective-C

+ 

+@interface SCPCancelable : NSObject
+ +
+
+

Swift

+ 
class Cancelable : NSObject
+ +
+
+

An object representing an action that can be canceled.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + completed + +
    +
    +
    +
    +
    +
    +

    Indicates whether the command has completed. After the command has completed, +subsequent calls to cancel will fail.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) BOOL completed;
    + +
    +
    +

    Swift

    + 
    var completed: Bool { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -cancel: + +
    +
    +
    +
    +
    +
    +

    Attempts to cancel the action in progress. If the action could not be canceled, +e.g. it has already completed, the completion block will be called with an +error. Otherwise, the completion block will be called with nil.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)cancel:(nonnull SCPErrorCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func cancel() async throws
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCardDetails.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCardDetails.html new file mode 100644 index 00000000..03455eea --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCardDetails.html @@ -0,0 +1,706 @@ + + + + SCPCardDetails Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCardDetails Class Reference +

+ +
+ +
+ +
+
+

SCPCardDetails

+
+
+

Objective-C

+ 

+@interface SCPCardDetails : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class CardDetails : NSObject, JSONDecodable
+ +
+
+

Contains details about a user’s credit card.

+
+

See

+ https://stripe.com/docs/api/payment_methods/object#payment_method_object-card + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + brand + +
    +
    +
    +
    +
    +
    +

    The issuer of the card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPCardBrand brand;
    + +
    +
    +

    Swift

    + 
    var brand: CardBrand { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + country + +
    +
    +
    +
    +
    +
    +

    Two-letter ISO code representing the country of the card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *country;
    + +
    +
    +

    Swift

    + 
    var country: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + expMonth + +
    +
    +
    +
    +
    +
    +

    Two-digit number representing the card’s expiration month. +0 if the expiration month was missing.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSInteger expMonth;
    + +
    +
    +

    Swift

    + 
    var expMonth: Int { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + expYear + +
    +
    +
    +
    +
    +
    +

    Four-digit number representing the card’s expiration year. +0 if the expiration year was missing.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSInteger expYear;
    + +
    +
    +

    Swift

    + 
    var expYear: Int { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + funding + +
    +
    +
    +
    +
    +
    +

    Card funding type. Ex: credit, debit, etc.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPCardFundingType funding;
    + +
    +
    +

    Swift

    + 
    var funding: CardFundingType { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + last4 + +
    +
    +
    +
    +
    +
    +

    The last four digits of the card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *last4;
    + +
    +
    +

    Swift

    + 
    var last4: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + fingerprint + +
    +
    +
    +
    +
    +
    +

    Uniquely identifies this particular card number. You can use this attribute +to check whether two customers who’ve signed up with you are using the +same card number, for example.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *fingerprint;
    + +
    +
    +

    Swift

    + 
    var fingerprint: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCardPresentDetails.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCardPresentDetails.html new file mode 100644 index 00000000..1c726500 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCardPresentDetails.html @@ -0,0 +1,977 @@ + + + + SCPCardPresentDetails Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCardPresentDetails Class Reference +

+ +
+ +
+ +
+
+

SCPCardPresentDetails

+
+
+

Objective-C

+ 

+@interface SCPCardPresentDetails : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class CardPresentDetails : NSObject, JSONDecodable
+ +
+
+

An object representing details from a transaction using a card_present +payment method.

+
+

See

+ https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + last4 + +
    +
    +
    +
    +
    +
    +

    The last 4 digits of the card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull last4;
    + +
    +
    +

    Swift

    + 
    var last4: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + expMonth + +
    +
    +
    +
    +
    +
    +

    The card’s expiration month. 1-indexed (i.e. 1 == January)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSInteger expMonth;
    + +
    +
    +

    Swift

    + 
    var expMonth: Int { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + expYear + +
    +
    +
    +
    +
    +
    +

    The card’s expiration year.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSInteger expYear;
    + +
    +
    +

    Swift

    + 
    var expYear: Int { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardholderName + +
    +
    +
    +
    +
    +
    +

    The cardholder name as read from the card, in ISO 7813 format. May include +alphanumeric characters, special characters and first/last name separator (/).

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *cardholderName;
    + +
    +
    +

    Swift

    + 
    var cardholderName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + funding + +
    +
    +
    +
    +
    +
    +

    The card’s funding type.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPCardFundingType funding;
    + +
    +
    +

    Swift

    + 
    var funding: CardFundingType { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + brand + +
    +
    +
    +
    +
    +
    +

    The issuing brand of the card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPCardBrand brand;
    + +
    +
    +

    Swift

    + 
    var brand: CardBrand { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + fingerprint + +
    +
    +
    +
    +
    +
    +

    A string uniquely identifying this card number.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull fingerprint;
    + +
    +
    +

    Swift

    + 
    var fingerprint: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + generatedCard + +
    +
    +
    +
    +
    +
    +

    ID of a card PaymentMethod that may be attached to a Customer for future +transactions. Only present if it was possible to generate a card +PaymentMethod.

    +
    +

    See

    + https://stripe.com/docs/terminal/payments/saving-cards#saving-payment-intent-card + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *generatedCard;
    + +
    +
    +

    Swift

    + 
    var generatedCard: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + receipt + +
    +
    +
    +
    +
    +
    +

    Receipt information for the card present transaction. Only present for EMV +transactions.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPReceiptDetails *receipt;
    + +
    +
    +

    Swift

    + 
    var receipt: SCPReceiptDetails? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + emvAuthData + +
    +
    +
    +
    +
    +
    +

    (Only applicable to EMV payments) The authorization data from the card +issuer.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *emvAuthData;
    + +
    +
    +

    Swift

    + 
    var emvAuthData: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + country + +
    +
    +
    +
    +
    +
    +

    Two-letter ISO code representing the country of the card. You could use this +attribute to get a sense of the international breakdown of cards you’ve collected.

    + +

    Only available for interac_present payments.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSString *country;
    + +
    +
    +

    Swift

    + 
    var country: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + preferredLocales + +
    +
    +
    +
    +
    +
    +

    EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.

    + +

    Only available for interac_present payments.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSArray<NSString *> *preferredLocales;
    + +
    +
    +

    Swift

    + 
    var preferredLocales: [String]? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + networks + +
    +
    +
    +
    +
    +
    +

    Contains information about card networks that can be used to process the payment.

    + +

    Only available after collectPaymentMethod when using updatePaymentIntent on the CollectConfiguration.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) SCPNetworks *networks;
    + +
    +
    +

    Swift

    + 
    @NSCopying var networks: SCPNetworks? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Whether this payment method is eligible for incremental authorizations.

    + +

    Note: This is only known if the PaymentIntent was confirmed.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPIncrementalAuthorizationStatus incrementalAuthorizationStatus;
    + +
    +
    +

    Swift

    + 
    var incrementalAuthorizationStatus: SCPIncrementalAuthorizationStatus { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCardPresentParameters.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCardPresentParameters.html new file mode 100644 index 00000000..9dead429 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCardPresentParameters.html @@ -0,0 +1,1342 @@ + + + + SCPCardPresentParameters Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCardPresentParameters Class Reference +

+ +
+ +
+ +
+
+

SCPCardPresentParameters

+
+
+

Objective-C

+ 

+@interface SCPCardPresentParameters : NSObject
+ +
+
+

Swift

+ 
class CardPresentParameters : NSObject
+ +
+
+

Parameters that will be applied to the card present PaymentIntent.

+
+

See

+ https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Using the extended authorizations feature, users in eligible categories can capture up to 31 days later, depending on the card brand.

    +
    +

    See

    + https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) BOOL requestExtendedAuthorization;
    + +
    +
    +

    Swift

    + 
    var requestExtendedAuthorization: Bool { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Allows you to increase the authorized amount on a confirmed PaymentIntent before you capture it. This means you can update the amount on a payment if the estimated price changes or goods and services are added. Before capture, each incremental authorization appears on your customer’s credit card statement as an additional pending charge.

    +
    +

    See

    + https://stripe.com/docs/terminal/features/incremental-authorizations + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) BOOL requestIncrementalAuthorizationSupport;
    + +
    +
    +

    Swift

    + 
    var requestIncrementalAuthorizationSupport: Bool { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + captureMethod + +
    +
    +
    +
    +
    +
    +

    SCPCardPresentCaptureMethod as a nullable NSNumber.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, strong, nullable) NSNumber *captureMethod;
    + +
    +
    +

    Swift

    + 
    var captureMethod: NSNumber? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + requestedPriority + +
    +
    +
    +
    +
    +
    +

    The requested routing priority as a nullable NSNumber.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, strong, nullable) NSNumber *requestedPriority;
    + +
    +
    +

    Swift

    + 
    var requestedPriority: NSNumber? { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a CardPresentParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithRequestExtendedAuthorization:
+                            (BOOL)requestExtendedAuthorization
+                      requestIncrementalAuthorizationSupport:
+                          (BOOL)requestIncrementalAuthorizationSupport;
    + +
    +
    +

    Swift

    + 
    init(requestExtendedAuthorization: Bool, requestIncrementalAuthorizationSupport: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + requestExtendedAuthorization + + +
    +

    Uses the extended authorization feature to extend capture elgibility

    +
    +
    + + requestIncrementalAuthorizationSupport + + +
    +

    Uses the incremental authorization feature to allow additional charges before capture

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a CardPresentParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithRequestExtendedAuthorization:
+    (BOOL)requestExtendedAuthorization;
    + +
    +
    +

    Swift

    + 
    init(requestExtendedAuthorization: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + requestExtendedAuthorization + + +
    +

    Uses the extended authorization feature to extend capture elgibility

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a CardPresentParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithRequestIncrementalAuthorizationSupport:
+    (BOOL)requestIncrementalAuthorizationSupport;
    + +
    +
    +

    Swift

    + 
    init(requestIncrementalAuthorizationSupport: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + requestIncrementalAuthorizationSupport + + +
    +

    Uses the incremental authorization feature to allow additional charges before capture

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a CardPresentParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)
+      initWithRequestExtendedAuthorization:(BOOL)requestExtendedAuthorization
+    requestIncrementalAuthorizationSupport:
+        (BOOL)requestIncrementalAuthorizationSupport
+                             captureMethod:
+                                 (SCPCardPresentCaptureMethod)captureMethod;
    + +
    +
    +

    Swift

    + 
    init(requestExtendedAuthorization: Bool, requestIncrementalAuthorizationSupport: Bool, captureMethod: CardPresentCaptureMethod)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + requestExtendedAuthorization + + +
    +

    Uses the extended authorization feature to extend capture elgibility

    +
    +
    + + requestIncrementalAuthorizationSupport + + +
    +

    Uses the incremental authorization feature to allow additional charges before capture

    +
    +
    + + captureMethod + + +
    +

    Card present capture method.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a CardPresentParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)
+    initWithRequestExtendedAuthorization:(BOOL)requestExtendedAuthorization
+                           captureMethod:
+                               (SCPCardPresentCaptureMethod)captureMethod;
    + +
    +
    +

    Swift

    + 
    init(requestExtendedAuthorization: Bool, captureMethod: CardPresentCaptureMethod)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + requestExtendedAuthorization + + +
    +

    Uses the extended authorization feature to extend capture elgibility

    +
    +
    + + captureMethod + + +
    +

    Card present capture method.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a CardPresentParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)
+    initWithRequestIncrementalAuthorizationSupport:
+        (BOOL)requestIncrementalAuthorizationSupport
+                                     captureMethod:(SCPCardPresentCaptureMethod)
+                                                       captureMethod;
    + +
    +
    +

    Swift

    + 
    init(requestIncrementalAuthorizationSupport: Bool, captureMethod: CardPresentCaptureMethod)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + requestIncrementalAuthorizationSupport + + +
    +

    Uses the incremental authorization feature to allow additional charges before capture

    +
    +
    + + captureMethod + + +
    +

    Card present capture method.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a CardPresentParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithCaptureMethod:
+    (SCPCardPresentCaptureMethod)captureMethod;
    + +
    +
    +

    Swift

    + 
    init(captureMethod: CardPresentCaptureMethod)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + captureMethod + + +
    +

    Card present capture method.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a CardPresentParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)
+      initWithRequestExtendedAuthorization:(BOOL)requestExtendedAuthorization
+    requestIncrementalAuthorizationSupport:
+        (BOOL)requestIncrementalAuthorizationSupport
+                             captureMethod:
+                                 (SCPCardPresentCaptureMethod)captureMethod
+                         requestedPriority:
+                             (SCPCardPresentRouting)requestedPriority;
    + +
    +
    +

    Swift

    + 
    init(requestExtendedAuthorization: Bool, requestIncrementalAuthorizationSupport: Bool, captureMethod: CardPresentCaptureMethod, requestedPriority: CardPresentRouting)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + requestExtendedAuthorization + + +
    +

    Uses the extended authorization feature to extend capture elgibility

    +
    +
    + + requestIncrementalAuthorizationSupport + + +
    +

    Uses the incremental authorization feature to allow additional charges before capture

    +
    +
    + + captureMethod + + +
    +

    Card present capture method.

    +
    +
    + + requestedPriority + + +
    +

    Requested card present routing option.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a CardPresentParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)
+      initWithRequestExtendedAuthorization:(BOOL)requestExtendedAuthorization
+    requestIncrementalAuthorizationSupport:
+        (BOOL)requestIncrementalAuthorizationSupport
+                         requestedPriority:
+                             (SCPCardPresentRouting)requestedPriority;
    + +
    +
    +

    Swift

    + 
    init(requestExtendedAuthorization: Bool, requestIncrementalAuthorizationSupport: Bool, requestedPriority: CardPresentRouting)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + requestExtendedAuthorization + + +
    +

    Uses the extended authorization feature to extend capture elgibility

    +
    +
    + + requestIncrementalAuthorizationSupport + + +
    +

    Uses the incremental authorization feature to allow additional charges before capture

    +
    +
    + + requestedPriority + + +
    +

    Requested card present routing option.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a CardPresentParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)
+    initWithCaptureMethod:(SCPCardPresentCaptureMethod)captureMethod
+        requestedPriority:(SCPCardPresentRouting)requestedPriority;
    + +
    +
    +

    Swift

    + 
    init(captureMethod: CardPresentCaptureMethod, requestedPriority: CardPresentRouting)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + captureMethod + + +
    +

    Card present capture method.

    +
    +
    + + requestedPriority + + +
    +

    Requested card present routing option.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes a CardPresentParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithRequestedPriority:
+    (SCPCardPresentRouting)requestedPriority;
    + +
    +
    +

    Swift

    + 
    init(requestedPriority: CardPresentRouting)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + requestedPriority + + +
    +

    Requested card present routing option.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use alternative initializer.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCart.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCart.html new file mode 100644 index 00000000..d75a2035 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCart.html @@ -0,0 +1,730 @@ + + + + SCPCart Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCart Class Reference +

+ +
+ +
+ +
+
+

SCPCart

+
+
+

Objective-C

+ 

+@interface SCPCart : NSObject
+ +
+
+

Swift

+ 
class Cart : NSObject
+ +
+
+

An SCPCart object contains information about what line items are included in +the current transaction. A cart object should be created and then passed into +Terminal.shared.setReaderDisplay(), which will display the cart’s contents +on the reader’s screen.

+ +

The SCPCart only represents exactly what will be shown on the screen, and is +not reflective of what the customer is actually charged. You are +responsible for making sure that tax and total reflect what is in the cart.

+
+

Note

+

Only Internet readers support setReaderDisplay functionality

+ +
+

See

+

https://stripe.com/docs/terminal/checkout/cart-display

+ +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + lineItems + +
    +
    +
    +
    +
    +
    +

    You can add or remove line items from this array individually or reassign the array entirely. + After making your desired changes, call setReaderDisplay to update the cart on the reader’s screen.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, strong) NSMutableArray<SCPCartLineItem *> *_Nonnull lineItems;
    + +
    +
    +

    Swift

    + 
    var lineItems: NSMutableArray { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + tax + +
    +
    +
    +
    +
    +
    +

    The displayed tax amount, provided in the currency’s smallest unit.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) NSInteger tax;
    + +
    +
    +

    Swift

    + 
    var tax: Int { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + total + +
    +
    +
    +
    +
    +
    +

    The cart’s total balance, provided in the currency’s smallest unit.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) NSInteger total;
    + +
    +
    +

    Swift

    + 
    var total: Int { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    The currency of the cart.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy) NSString *_Nonnull currency;
    + +
    +
    +

    Swift

    + 
    var currency: String { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes an SCPCart with tax and total, in cents, as well as the currency. +These values are exactly what will be shown on the screen and do not reflect +what the user is actually charged.

    + +

    This initializer will initialize lineItems as an empty array.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithCurrency:(nonnull NSString *)currency
+                                     tax:(NSInteger)tax
+                                   total:(NSInteger)total;
    + +
    +
    +

    Swift

    + 
    init(currency: String, tax: Int, total: Int)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + tax + + +
    +

    The tax in cents

    +
    +
    + + total + + +
    +

    The total in cents

    +
    +
    + + currency + + +
    +

    The currency of the basket (i.e. USD or AUD)

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithTax:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithTax:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCartLineItem.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCartLineItem.html new file mode 100644 index 00000000..0e13cb38 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCartLineItem.html @@ -0,0 +1,625 @@ + + + + SCPCartLineItem Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCartLineItem Class Reference +

+ +
+ +
+ +
+
+

SCPCartLineItem

+
+
+

Objective-C

+ 

+@interface SCPCartLineItem : NSObject
+ +
+
+

Swift

+ 
class CartLineItem : NSObject
+ +
+
+

Represents a single line item in an SCPCart, displayed on the reader’s screen +during checkout.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + quantity + +
    +
    +
    +
    +
    +
    +

    The quantity of the line item being purchased.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) NSInteger quantity;
    + +
    +
    +

    Swift

    + 
    var quantity: Int { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + displayName + +
    +
    +
    +
    +
    +
    +

    The description or name of the item.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy) NSString *_Nonnull displayName;
    + +
    +
    +

    Swift

    + 
    var displayName: String { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    The price of the item, provided in the cart’s currency’s smallest unit.

    +
    +

    See

    + https://stripe.com/docs/currencies#zero-decimal + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) NSInteger amount;
    + +
    +
    +

    Swift

    + 
    var amount: Int { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The values set here will be shown on the screen as-is. Make sure you’re +correctly calculating and setting the SCPCart’s tax and total – the reader +will not calculate tax or total for you. Similarly, make sure the values +displayed reflect what the customer is actually charged.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithDisplayName:(nonnull NSString *)displayName
+                                   quantity:(NSInteger)quantity
+                                     amount:(NSInteger)amount;
    + +
    +
    +

    Swift

    + 
    init(displayName: String, quantity: Int, amount: Int)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + displayName + + +
    +

    The description or name of the item.

    +
    +
    + + quantity + + +
    +

    The quanitity of the item that should show in the cart.

    +
    +
    + + amount + + +
    +

    The price in the currency’s smallest unit. The line item + will assume the currency of the parent SCPCart.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCharge.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCharge.html new file mode 100644 index 00000000..97b56c17 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCharge.html @@ -0,0 +1,805 @@ + + + + SCPCharge Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCharge Class Reference +

+ +
+ +
+ +
+
+

SCPCharge

+
+
+

Objective-C

+ 

+@interface SCPCharge : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class Charge : NSObject, JSONDecodable
+ +
+
+

An object representing a Stripe charge.

+
+

See

+ https://stripe.com/docs/api#charges + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    The amount of the charge.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSUInteger amount;
    + +
    +
    +

    Swift

    + 
    var amount: UInt { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    The currency of the charge.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull currency;
    + +
    +
    +

    Swift

    + 
    var currency: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    The status of the charge.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPChargeStatus status;
    + +
    +
    +

    Swift

    + 
    var status: ChargeStatus { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentMethodDetails + +
    +
    +
    +
    +
    +
    +

    The payment method details associated with the charge.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPPaymentMethodDetails *paymentMethodDetails;
    + +
    +
    +

    Swift

    + 
    var paymentMethodDetails: SCPPaymentMethodDetails? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + stripeDescription + +
    +
    +
    +
    +
    +
    +

    A string describing the charge, displayed in the Stripe dashboard and in +email receipts.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *stripeDescription;
    + +
    +
    +

    Swift

    + 
    var stripeDescription: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Metadata associated with the charge.

    +
    +

    See

    + https://stripe.com/docs/api#metadata + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSDictionary<NSString *, NSString *> *_Nonnull metadata;
    + +
    +
    +

    Swift

    + 
    var metadata: [String : String] { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + stripeId + +
    +
    +
    +
    +
    +
    +

    The unique identifier for the charge.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull stripeId;
    + +
    +
    +

    Swift

    + 
    var stripeId: String { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Extra dynamic information about a Charge. This will appear concatenated with the statementDescriptor on +your customer’s credit card’s statement.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *statementDescriptorSuffix;
    + +
    +
    +

    Swift

    + 
    var statementDescriptorSuffix: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The full statement descriptor that is displayed on your customer’s credit card’s statement, after the +static statementDescriptor and dynamic statementDescriptorSuffix portions are combined.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *calculatedStatementDescriptor;
    + +
    +
    +

    Swift

    + 
    var calculatedStatementDescriptor: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCollectConfiguration.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCollectConfiguration.html new file mode 100644 index 00000000..273cb8f0 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCollectConfiguration.html @@ -0,0 +1,1042 @@ + + + + SCPCollectConfiguration Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCollectConfiguration Class Reference +

+ +
+ +
+ +
+
+

SCPCollectConfiguration

+
+
+

Objective-C

+ 

+@interface SCPCollectConfiguration : NSObject <NSCopying>
+ +
+
+

Swift

+ 
class CollectConfiguration : NSObject, NSCopying
+ +
+
+

The CollectConfiguration contains configuration information relevant to collecting a payment +method.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + skipTipping + +
    +
    +
    +
    +
    +
    +

    Bypass tipping selection if it would have otherwise been shown.

    + +

    Defaults to NO.

    +
    +

    See

    + https://stripe.com/docs/terminal/features/collecting-tips/on-reader + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) BOOL skipTipping;
    + +
    +
    +

    Swift

    + 
    var skipTipping: Bool { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + tippingConfiguration + +
    +
    +
    +
    +
    +
    +

    The tipping configuration for this payment collection.

    +
    +

    See

    + https://stripe.com/docs/terminal/features/collecting-tips/on-reader#tip-eligible + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, strong, nullable) SCPTippingConfiguration *tippingConfiguration;
    + +
    +
    +

    Swift

    + 
    var tippingConfiguration: SCPTippingConfiguration? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + updatePaymentIntent + +
    +
    +
    +
    +
    +
    +

    Whether or not to update the PaymentIntent server side during collectPaymentMethod.

    + +

    Defaults to NO.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) BOOL updatePaymentIntent;
    + +
    +
    +

    Swift

    + 
    var updatePaymentIntent: Bool { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -initWithSkipTipping: + +
    +
    +
    +
    +
    +
    +

    Initialize a CollectConfiguration

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithSkipTipping:(BOOL)skipTipping;
    + +
    +
    +

    Swift

    + 
    convenience init(skipTipping: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + skipTipping + + +
    +

    Bypass tipping selection if it would have otherwise been shown.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize a CollectConfiguration

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithUpdatePaymentIntent:(BOOL)updatePaymentIntent;
    + +
    +
    +

    Swift

    + 
    convenience init(updatePaymentIntent: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + updatePaymentIntent + + +
    +

    Whether or not to update the PaymentIntent server side during collectPaymentMethod.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize a CollectConfiguration.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithTippingConfiguration:
+    (nonnull SCPTippingConfiguration *)tippingConfiguration;
    + +
    +
    +

    Swift

    + 
    convenience init(tippingConfiguration: SCPTippingConfiguration)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + tippingConfiguration + + +
    +

    Tipping configuration for the payment method collection.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize a CollectConfiguration

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithSkipTipping:(BOOL)skipTipping
+                        updatePaymentIntent:(BOOL)updatePaymentIntent;
    + +
    +
    +

    Swift

    + 
    convenience init(skipTipping: Bool, updatePaymentIntent: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + skipTipping + + +
    +

    Bypass tipping selection if it would have otherwise been shown.

    +
    +
    + + updatePaymentIntent + + +
    +

    Whether or not to update the PaymentIntent server side during collectPaymentMethod.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize a CollectConfiguration.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithSkipTipping:(BOOL)skipTipping
+                       tippingConfiguration:(nullable SCPTippingConfiguration *)
+                                                tippingConfiguration;
    + +
    +
    +

    Swift

    + 
    convenience init(skipTipping: Bool, tippingConfiguration: SCPTippingConfiguration?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + skipTipping + + +
    +

    Bypass tipping selection if it would have otherwise been shown.

    +
    +
    + + tippingConfiguration + + +
    +

    Tipping configuration for the payment method collection.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize a CollectConfiguration.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithUpdatePaymentIntent:(BOOL)updatePaymentIntent
+                               tippingConfiguration:
+                                   (nullable SCPTippingConfiguration *)
+                                       tippingConfiguration;
    + +
    +
    +

    Swift

    + 
    convenience init(updatePaymentIntent: Bool, tippingConfiguration: SCPTippingConfiguration?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + updatePaymentIntent + + +
    +

    Whether or not to update the PaymentIntent server side during collectPaymentMethod.

    +
    +
    + + tippingConfiguration + + +
    +

    Tipping configuration for the payment method collection.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize a CollectConfiguration.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithSkipTipping:(BOOL)skipTipping
+                        updatePaymentIntent:(BOOL)updatePaymentIntent
+                       tippingConfiguration:(nullable SCPTippingConfiguration *)
+                                                tippingConfiguration;
    + +
    +
    +

    Swift

    + 
    init(skipTipping: Bool, updatePaymentIntent: Bool, tippingConfiguration: SCPTippingConfiguration?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + skipTipping + + +
    +

    Bypass tipping selection if it would have otherwise been shown.

    +
    +
    + + updatePaymentIntent + + +
    +

    Whether or not to update the PaymentIntent server side during collectPaymentMethod.

    +
    +
    + + tippingConfiguration + + +
    +

    Tipping configuration for the payment method collection.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithSkipTipping:updatePaymentIntent:tippingConfiguration: or helper initializers.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithSkipTipping:updatePaymentIntent:tippingConfiguration: or helper initializers.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPConfirmSetupIntentError.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPConfirmSetupIntentError.html new file mode 100644 index 00000000..41bf695c --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPConfirmSetupIntentError.html @@ -0,0 +1,602 @@ + + + + SCPConfirmSetupIntentError Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPConfirmSetupIntentError Class Reference +

+ +
+ +
+ +
+
+

SCPConfirmSetupIntentError

+
+
+

Objective-C

+ 

+@interface SCPConfirmSetupIntentError : NSError
+ +
+
+

Swift

+ 
class ConfirmSetupIntentError : NSError
+ +
+
+

An error from -[SCPTerminal confirmSetupIntent:completion:]

+ +
+
+ +
+
+
+
    +
  • +
    + + + + setupIntent + +
    +
    +
    +
    +
    +
    +

    The updated SetupIntent after confirmSetupIntent failed.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPSetupIntent *setupIntent;
    + +
    +
    +

    Swift

    + 
    var setupIntent: SCPSetupIntent? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + requestError + +
    +
    +
    +
    +
    +
    +

    If confirmSetupIntent failed because the underlying network request errored, +this property contains additional details about the error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSError *requestError;
    + +
    +
    +

    Swift

    + 
    var requestError: Error? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + declineCode + +
    +
    +
    +
    +
    +
    +

    If confirmSetupIntent failed because the payment method was declined, this +property contains the decline code.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *declineCode;
    + +
    +
    +

    Swift

    + 
    var declineCode: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPDiscoveryConfiguration.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPDiscoveryConfiguration.html new file mode 100644 index 00000000..854a42e2 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPDiscoveryConfiguration.html @@ -0,0 +1,811 @@ + + + + SCPDiscoveryConfiguration Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPDiscoveryConfiguration Class Reference +

+ +
+ +
+ +
+
+

SCPDiscoveryConfiguration

+
+
+

Objective-C

+ 

+@interface SCPDiscoveryConfiguration : NSObject
+ +
+
+

Swift

+ 
class DiscoveryConfiguration : NSObject
+ +
+
+

Configuration options for discovering readers.

+ +

Objects of this type get passed into the Terminal.shared.discoverReaders() +method to control which devices get discovered, and how.

+
+

See

+ https://stripe.com/docs/terminal/readers/connecting + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Initializes a discovery configuration with the given discovery method. All discoverable readers +for that method will be discovered.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithDiscoveryMethod:
+                            (SCPDiscoveryMethod)discoveryMethod
+                                      simulated:(BOOL)simulated;
    + +
    +
    +

    Swift

    + 
    init(discoveryMethod: DiscoveryMethod, simulated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + discoveryMethod + + +
    +

    The discovery method to use.

    +
    +
    + + simulated + + +
    +

    Whether to use simulated discovery to discover a +device simulator. The SDK comes with the ability to simulate behavior without +using physical hardware. This makes it easy to quickly test your integration +end-to-end, from pairing with a reader to taking payments.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This variant of the initializer lets you specify a Location to filter the +list of discovered readers.

    + +

    This filtering behavior is only available when discovering internet readers. +Starting a discoverReaders call with a bluetooth discovery method will +discover all bluetooth readers that can be found, regardless of the location +to which those readers have been registered.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithDiscoveryMethod:
+                            (SCPDiscoveryMethod)discoveryMethod
+                                     locationId:(nullable NSString *)locationId
+                                      simulated:(BOOL)simulated;
    + +
    +
    +

    Swift

    + 
    init(discoveryMethod: DiscoveryMethod, locationId: String?, simulated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + discoveryMethod + + +
    +

    The discovery method to use.

    +
    +
    + + locationId + + +
    +

    The optional location ID to filter the discovered +list to only readers at the specific location. Currently updating and creating +locations is not supported by this SDK and will need to take place on the +backend. Only available for the Internet discovery method.

    +
    +
    + + simulated + + +
    +

    Whether to use simulated discovery to discover a +device simulator. The SDK comes with the ability to simulate behavior without +using physical hardware. This makes it easy to quickly test your integration +end-to-end, from pairing with a reader to taking payments.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + timeout + +
    +
    +
    +
    +
    +
    +

    The timeout (in seconds) after which discoverReaders: should fail. If the +value is 0 (the default), discoverReaders will never timeout.

    + +

    Note that setting a timeout is not currently supported when using +SCPDiscoveryMethodBluetoothProximity, or any simulated discovery. If you set +a timeout when using these configurations, the timeout will be ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) NSUInteger timeout;
    + +
    +
    +

    Swift

    + 
    var timeout: UInt { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + discoveryMethod + +
    +
    +
    +
    +
    +
    +

    The method by which to discover readers.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPDiscoveryMethod discoveryMethod;
    + +
    +
    +

    Swift

    + 
    var discoveryMethod: DiscoveryMethod { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + simulated + +
    +
    +
    +
    +
    +
    +

    Whether to use simulated discovery to discover a device simulator.

    + +

    The Terminal SDK comes with the ability to simulate behavior without using +physical hardware. This makes it easy to quickly test your integration +end-to-end, from pairing with a reader to taking payments.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) BOOL simulated;
    + +
    +
    +

    Swift

    + 
    var simulated: Bool { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + locationId + +
    +
    +
    +
    +
    +
    +

    A location ID that can be used to filter discovery result so only readers +registered to that location are returned. Filtering discovery by a location is +only applicable to Internet readers; this parameter must be nil when discovering +Bluetooth readers.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSString *locationId;
    + +
    +
    +

    Swift

    + 
    var locationId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithDiscoveryMethod:simulated:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithDiscoveryMethod:simulated:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPInternetConnectionConfiguration.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPInternetConnectionConfiguration.html new file mode 100644 index 00000000..7f83eca2 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPInternetConnectionConfiguration.html @@ -0,0 +1,631 @@ + + + + SCPInternetConnectionConfiguration Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPInternetConnectionConfiguration Class Reference +

+ +
+ +
+ +
+
+

SCPInternetConnectionConfiguration

+
+
+

Objective-C

+ 

+@interface SCPInternetConnectionConfiguration : SCPConnectionConfiguration
+ +
+
+

Swift

+ 
class InternetConnectionConfiguration : ConnectionConfiguration
+ +
+
+

This class lets you set options that define internet reader behavior throughout a given +reader-to-SDK connection session.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + failIfInUse + +
    +
    +
    +
    +
    +
    +

    When set to true, the connection will automatically error if the reader is already +connected to a device and collecting payment. When set to false, this will allow +you to connect to a reader already connected to another device, and will break +the existing reader-to-SDK connection on the other device when it attempts to +collect payment.

    + +

    If Terminal.connectReader is invoked without a SCPInternetConnectionConfiguration, +then failIfInUse defaults to NO.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers/connecting/verifone-p400#connect-reader-ios + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) BOOL failIfInUse;
    + +
    +
    +

    Swift

    + 
    var failIfInUse: Bool { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + allowCustomerCancel + +
    +
    +
    +
    +
    +
    +

    If set to true, the customer will be able to press the red X button on the +Verifone P400 to cancel a collectPaymentMethod, collectReusableCard, or +collectRefundPaymentMethod command.

    + +

    The property defaults to NO if not set.

    +
    +

    Note

    + This behavior is part of a private beta. Setting this property will have +no effect if you are not part of the allowCustomerCancel beta program. + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) BOOL allowCustomerCancel;
    + +
    +
    +

    Swift

    + 
    var allowCustomerCancel: Bool { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize an InternetConnectionConfiguration object with all possible properties.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithFailIfInUse:(BOOL)failIfInUse
+                        allowCustomerCancel:(BOOL)allowCustomerCancel;
    + +
    +
    +

    Swift

    + 
    init(failIfInUse: Bool, allowCustomerCancel: Bool)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -initWithFailIfInUse: + +
    +
    +
    +
    +
    +
    +

    Initalize an InternetConnectionConfiguration object and set the failIfInUse +property.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithFailIfInUse:(BOOL)failIfInUse;
    + +
    +
    +

    Swift

    + 
    init(failIfInUse: Bool)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize an InternetConnectionConfiguration object and set the +allowCustomerCancel property.

    + +

    This property is in private beta, and will have no effect if you are not part +of the allowCustomerCancel beta program.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithAllowCustomerCancel:(BOOL)allowCustomerCancel;
    + +
    +
    +

    Swift

    + 
    init(allowCustomerCancel: Bool)
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPListLocationsParameters.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPListLocationsParameters.html new file mode 100644 index 00000000..334e6957 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPListLocationsParameters.html @@ -0,0 +1,648 @@ + + + + SCPListLocationsParameters Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPListLocationsParameters Class Reference +

+ +
+ +
+ +
+
+

SCPListLocationsParameters

+
+
+

Objective-C

+ 

+@interface SCPListLocationsParameters : NSObject
+ +
+
+

Swift

+ 
class ListLocationsParameters : NSObject
+ +
+
+

Parameters to be used when calling Terminal.shared.listLocations() to list +the Location objects associated with an account.

+
+

See

+ https://stripe.com/docs/terminal/readers/connecting + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + limit + +
    +
    +
    +
    +
    +
    +

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    +
    +

    See

    + https://stripe.com/docs/api/terminal/locations/list#list_terminal_locations-limit + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, nullable) NSNumber *limit;
    + +
    +
    +

    Swift

    + 
    var limit: NSNumber? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + endingBefore + +
    +
    +
    +
    +
    +
    +

    A cursor for use in pagination. ending_before is an object ID that defines +your place in the list. For instance, if you make a list request and receive 100 +objects, starting with obj_bar, your subsequent call can include +ending_before=obj_bar in order to fetch the previous page of the list.

    +
    +

    See

    + https://stripe.com/docs/api/terminal/locations/list#list_terminal_locations-ending_before + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *endingBefore;
    + +
    +
    +

    Swift

    + 
    var endingBefore: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + startingAfter + +
    +
    +
    +
    +
    +
    +

    A cursor for use in pagination. starting_after is an object ID that defines +your place in the list. For instance, if you make a list request and receive 100 +objects, ending with obj_foo, your subsequent call can include +starting_after=obj_foo in order to fetch the next page of the list.

    +
    +

    See

    + https://stripe.com/docs/api/terminal/locations/list#list_terminal_locations-starting_after + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *startingAfter;
    + +
    +
    +

    Swift

    + 
    var startingAfter: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes SCPListLocationsParameters with the given parameters.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithLimit:(nullable NSNumber *)limit
+                         endingBefore:(nullable NSString *)endingBefore
+                        startingAfter:(nullable NSString *)startingAfter;
    + +
    +
    +

    Swift

    + 
    init(limit: NSNumber?, endingBefore: String?, startingAfter: String?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + limit + + +
    +

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    +
    +
    + + endingBefore + + +
    +

    A cursor for use in pagination. ending_before is an object ID that defines +your place in the list. For instance, if you make a list request and receive 100 +objects, starting with obj_bar, your subsequent call can include +ending_before=obj_bar in order to fetch the previous page of the list.

    +
    +
    + + startingAfter + + +
    +

    A cursor for use in pagination. starting_after is an object ID that defines +your place in the list. For instance, if you make a list request and receive 100 +objects, ending with obj_foo, your subsequent call can include +starting_after=obj_foo in order to fetch the next page of the list.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPLocalMobileConnectionConfiguration.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPLocalMobileConnectionConfiguration.html new file mode 100644 index 00000000..04b672f2 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPLocalMobileConnectionConfiguration.html @@ -0,0 +1,836 @@ + + + + SCPLocalMobileConnectionConfiguration Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPLocalMobileConnectionConfiguration Class Reference +

+ +
+ +
+ +
+
+

SCPLocalMobileConnectionConfiguration

+
+
+

Objective-C

+ 

+@interface SCPLocalMobileConnectionConfiguration : SCPConnectionConfiguration
+ +
+
+

Swift

+ 
class LocalMobileConnectionConfiguration : ConnectionConfiguration
+ +
+
+

This class lets you set options that define local mobile reader behavior throughout a given +reader-to-SDK connection session.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + locationId + +
    +
    +
    +
    +
    +
    +

    The ID of the Location which the reader should be +registered to during connection. +If the provided ID matches the location the reader is already registered to, the location field on the reader +object will not be changed.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly) NSString *_Nonnull locationId;
    + +
    +
    +

    Swift

    + 
    var locationId: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + onBehalfOf + +
    +
    +
    +
    +
    +
    +

    If your integration is creating destination charges and using on_behalf_of, you must provide the +connected_account_id in the onBehalfOf parameter as part of the +SCPLocalMobileConnectionConfiguration. +Unlike other reader types which require this information on a per-transaction basis, the Apple Built-In reader +requires this on a per-connection basis as well in order to establish a reader connection.

    +
    +

    See

    + https://stripe.com/docs/terminal/features/connect#destination-payment-intents + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSString *onBehalfOf;
    + +
    +
    +

    Swift

    + 
    var onBehalfOf: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + merchantDisplayName + +
    +
    +
    +
    +
    +
    +

    Optional cardholder facing merchant display name that will be used in the prompt for the cardholder +to present their card. If this value is not provided, the merchant display name will be taken from +the Terminal Location.display_name associated with the connection.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSString *merchantDisplayName;
    + +
    +
    +

    Swift

    + 
    var merchantDisplayName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    In order to connect to a reader, merchant-specific terms of service may need to be accepted. +Presenting the flow requires iCloud sign-in and an authorized individual. This attribute +determines how the connection process should proceed if this situation is +encountered.

    + +
      +
    • If YES, the terms the terms of service should be presented during connection. +If accepted successfully, the connection process will resume. +If not accepted succesfully, the connection will fail with an error.
      • +

    • If NO, the terms of service will not be presented and the connection will fail with an error.

      • +
    +

    See

    +

    SCPErrorAppleBuiltInReaderTOSNotYetAccepted

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, assign, unsafe_unretained, readonly,
+          getter=isTOSAcceptancePermitted) BOOL tosAcceptancePermitted;
    + +
    +
    +

    Swift

    + 
    var isTOSAcceptancePermitted: Bool { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -initWithLocationId: + +
    +
    +
    +
    +
    +
    +

    Initialize ConnectionConfiguration with a location ID.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithLocationId:(nonnull NSString *)locationId;
    + +
    +
    +

    Swift

    + 
    convenience init(locationId: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + locationId + + +
    +

    The ID of the location to be associated with the reader.

    +
    +
    +
    +
    +

    Return Value

    +

    A new instance of the receiver configured with a location ID.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize ConnectionConfiguration with a location ID, custom merchant display name, and ‘on behalf of’ +connected account ID.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithLocationId:(nonnull NSString *)locationId
+                       merchantDisplayName:
+                           (nullable NSString *)merchantDisplayName
+                                onBehalfOf:(nullable NSString *)onBehalfOf;
    + +
    +
    +

    Swift

    + 
    convenience init(locationId: String, merchantDisplayName: String?, onBehalfOf: String?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + locationId + + +
    +

    ID of the location to be associated with the reader.

    +
    +
    + + merchantDisplayName + + +
    +

    Cardholder facing merchant display name that will be used in the prompt +for the cardholder to present their card.

    +
    +
    + + onBehalfOf + + +
    +

    Connected account id that the merchant is taking payments on behalf of.

    +
    +
    +
    +
    +

    Return Value

    +

    A new instance of the receiver configured with a location ID, merchant +display name, and the ‘on behalf of’ connected account ID.

    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize ConnectionConfiguration with a location ID, custom merchant display name, ‘on behalf of’ +connected account ID and terms of service acceptance configuration.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithLocationId:(nonnull NSString *)locationId
+                       merchantDisplayName:
+                           (nullable NSString *)merchantDisplayName
+                                onBehalfOf:(nullable NSString *)onBehalfOf
+                    tosAcceptancePermitted:(BOOL)tosAcceptancePermitted;
    + +
    +
    +

    Swift

    + 
    init(locationId: String, merchantDisplayName: String?, onBehalfOf: String?, tosAcceptancePermitted: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + locationId + + +
    +

    ID of the location to be associated with the reader.

    +
    +
    + + merchantDisplayName + + +
    +

    Cardholder facing merchant display name that will be used in the prompt +for the cardholder to present their card.

    +
    +
    + + onBehalfOf + + +
    +

    Connected account id that the merchant is taking payments on behalf of.

    +
    +
    + + tosAcceptancePermitted + + +
    +

    Determines how to handle the situation where merchant-specific +terms of service need to be presented in order to connect to a reader. +@returns A new instance of the receiver configured with a location ID, merchant +display name, ‘on behalf of’ connected account ID and terms of service acceptance configuration.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPLocation.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPLocation.html new file mode 100644 index 00000000..08d41ac9 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPLocation.html @@ -0,0 +1,687 @@ + + + + SCPLocation Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPLocation Class Reference +

+ +
+ +
+ +
+
+

SCPLocation

+
+
+

Objective-C

+ 

+@interface SCPLocation : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class Location : NSObject, JSONDecodable
+ +
+
+

A Location is used to group readers in the Stripe Terminal ecosystem. The +Location to which a reader is registered can control regional behavior +for that particular reader.

+ +

You cannot create locations through the SDK. Instead, use the Stripe API +from your backend to manage your account’s locations.

+ +

To fetch the Location objects associated with your account, call +Terminal.shared.listLocations().

+
+

See

+ https://stripe.com/docs/api/terminal/locations + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + stripeId + +
    +
    +
    +
    +
    +
    +

    The ID of the Location

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly) NSString *_Nonnull stripeId;
    + +
    +
    +

    Swift

    + 
    var stripeId: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    The address of this Location

    +
    +

    See

    + SCPAddress + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, strong, readonly, nullable) SCPAddress *address;
    + +
    +
    +

    Swift

    + 
    var address: SCPAddress? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + displayName + +
    +
    +
    +
    +
    +
    +

    The display name of this Location

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSString *displayName;
    + +
    +
    +

    Swift

    + 
    var displayName: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + livemode + +
    +
    +
    +
    +
    +
    +

    Whether this Location was created in livemode

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) BOOL livemode;
    + +
    +
    +

    Swift

    + 
    var livemode: Bool { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Any metadata attached to this Location

    +
    +

    See

    + https://stripe.com/docs/api/terminal/locations/create#create_terminal_location-metadata + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, strong, readonly, nullable) NSDictionary<NSString *, NSString *> *metadata;
    + +
    +
    +

    Swift

    + 
    var metadata: [String : String]? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPNetworks.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPNetworks.html new file mode 100644 index 00000000..930d0cb4 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPNetworks.html @@ -0,0 +1,542 @@ + + + + SCPNetworks Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPNetworks Class Reference +

+ +
+ +
+ +
+
+

SCPNetworks

+
+
+

Objective-C

+ 
@interface SCPNetworks : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class SCPNetworks : NSObject, JSONDecodable
+ +
+
+

Contains information about card networks that can be used to process the payment.

+
+

See

+ https://stripe.com/docs/api/payment_methods/object#payment_method_object-card-networks-available + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + available + +
    +
    +
    +
    +
    +
    +

    All available networks for the card.

    + +

    Contains SCPCardBrand’s represented as NSNumber.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly, nullable) NSArray<NSNumber *> *available;
    + +
    +
    +

    Swift

    + 
    var available: [NSNumber]? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentIntent.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentIntent.html new file mode 100644 index 00000000..a05eba8c --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentIntent.html @@ -0,0 +1,960 @@ + + + + SCPPaymentIntent Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPPaymentIntent Class Reference +

+ +
+ +
+ +
+
+

SCPPaymentIntent

+
+
+

Objective-C

+ 

+@interface SCPPaymentIntent : NSObject <SCPJSONDecodable, NSCopying>
+ +
+
+

Swift

+ 
class PaymentIntent : NSObject, JSONDecodable, NSCopying
+ +
+
+

A PaymentIntent tracks the process of collecting a payment from your customer. +We recommend that you create exactly one PaymentIntent for each order or +customer session in your system. You can reference the PaymentIntent later to +see the history of payment attempts for a particular session.

+ +

A PaymentIntent transitions through multiple statuses throughout its lifetime +and ultimately creates at most one successful charge.

+ +

https://stripe.com/docs/api/payment_intents

+ +
+
+ +
+
+
+
    +
  • +
    + + + + stripeId + +
    +
    +
    +
    +
    +
    +

    The unique identifier for the intent.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly) NSString *_Nonnull stripeId;
    + +
    +
    +

    Swift

    + 
    var stripeId: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + created + +
    +
    +
    +
    +
    +
    +

    When the intent was created.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSDate *_Nonnull created;
    + +
    +
    +

    Swift

    + 
    var created: Date { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    The status of the PaymentIntent.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPPaymentIntentStatus status;
    + +
    +
    +

    Swift

    + 
    var status: PaymentIntentStatus { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    The amount to be collected by this PaymentIntent, provided in the currency’s +smallest unit.

    +
    +

    See

    + https://stripe.com/docs/currencies#zero-decimal + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSUInteger amount;
    + +
    +
    +

    Swift

    + 
    var amount: UInt { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + captureMethod + +
    +
    +
    +
    +
    +
    +

    Controls when the funds will be captured from the customer’s account.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPCaptureMethod captureMethod;
    + +
    +
    +

    Swift

    + 
    var captureMethod: CaptureMethod { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    The currency of the payment.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull currency;
    + +
    +
    +

    Swift

    + 
    var currency: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Set of key-value pairs attached to the object.

    +
    +

    See

    + https://stripe.com/docs/api#metadata + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSDictionary<NSString *, NSString *> *metadata;
    + +
    +
    +

    Swift

    + 
    var metadata: [String : String]? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + charges + +
    +
    +
    +
    +
    +
    +

    Charges that were created by this PaymentIntent, if any.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSArray<SCPCharge *> *_Nonnull charges;
    + +
    +
    +

    Swift

    + 
    var charges: [SCPCharge] { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentMethod + +
    +
    +
    +
    +
    +
    +

    The payment method to be used in this PaymentIntent. Only valid in the +intent returned during collectPaymentMethod when using the updatePaymentIntent +option in the SCPCollectConfiguration.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPPaymentMethod *paymentMethod;
    + +
    +
    +

    Swift

    + 
    var paymentMethod: SCPPaymentMethod? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + amountDetails + +
    +
    +
    +
    +
    +
    +

    Details about items included in the amount after confirmation.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPAmountDetails *amountDetails;
    + +
    +
    +

    Swift

    + 
    var amountDetails: SCPAmountDetails? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + amountTip + +
    +
    +
    +
    +
    +
    +

    Indicates how much the user intends to tip in addition to the amount by at confirmation time. +This is only non-null in the PaymentIntent instance returned during collect when using +updatePaymentIntent set to true in the CollectConfiguration.

    + +

    After processPaymentIntent the amount will have this tip amount added to it and the +amountDetails will contain the breakdown of how much of the amount was a tip.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSNumber *amountTip;
    + +
    +
    +

    Swift

    + 
    var amountTip: NSNumber? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + statementDescriptor + +
    +
    +
    +
    +
    +
    +

    Extra information about a PaymentIntent. This will appear on your customer’s statement when +this PaymentIntent succeeds in creating a charge.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *statementDescriptor;
    + +
    +
    +

    Swift

    + 
    var statementDescriptor: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Extra dynamic information about a PaymentIntent. This will appear concatenated with the statementDescriptor on +your customer’s statement when this PaymentIntent succeeds in creating a charge.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *statementDescriptorSuffix;
    + +
    +
    +

    Swift

    + 
    var statementDescriptorSuffix: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate SCPPaymentIntent. You should only use +one that has been returned by our SDK.

    +
    +

    See

    + SCPTerminal.shared.createPaymentIntent() + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate SCPPaymentIntent. You should only use +one that has been returned by our SDK.

    +
    +

    See

    + SCPTerminal.shared.createPaymentIntent() + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentIntentParameters.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentIntentParameters.html new file mode 100644 index 00000000..85be4f22 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentIntentParameters.html @@ -0,0 +1,1485 @@ + + + + SCPPaymentIntentParameters Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPPaymentIntentParameters Class Reference +

+ +
+ +
+ +
+
+

SCPPaymentIntentParameters

+
+
+

Objective-C

+ 

+@interface SCPPaymentIntentParameters : NSObject
+ +
+
+

Swift

+ 
class PaymentIntentParameters : NSObject
+ +
+
+

Parameters for creating an SCPPaymentIntent. Pass an object of this type +into Terminal.shared.createPaymentIntent().

+
+

See

+ https://stripe.com/docs/api/payment_intents/create + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    The amount of the payment, provided in the currency’s smallest unit.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSUInteger amount;
    + +
    +
    +

    Swift

    + 
    var amount: UInt { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull currency;
    + +
    +
    +

    Swift

    + 
    var currency: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentMethodTypes + +
    +
    +
    +
    +
    +
    +

    The list of payment method types that this PaymentIntent is allowed to use. +The default is value for this is [“card_present”].

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSArray<NSString *> *_Nonnull paymentMethodTypes;
    + +
    +
    +

    Swift

    + 
    var paymentMethodTypes: [String] { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + captureMethod + +
    +
    +
    +
    +
    +
    +

    The capture method that this PaymentIntent should use. Defaults to SCPCaptureMethodManual.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPCaptureMethod captureMethod;
    + +
    +
    +

    Swift

    + 
    var captureMethod: CaptureMethod { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Set of key-value pairs that you can attach to an object. This can be useful for +storing additional information about the object in a structured format.

    +
    +

    See

    + https://stripe.com/docs/api#metadata + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSDictionary<NSString *, NSString *> *metadata;
    + +
    +
    +

    Swift

    + 
    var metadata: [String : String]? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + stripeDescription + +
    +
    +
    +
    +
    +
    +

    An arbitrary string attached to the object. If you send a receipt email for +this payment, the email will include the description.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *stripeDescription;
    + +
    +
    +

    Swift

    + 
    var stripeDescription: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + statementDescriptor + +
    +
    +
    +
    +
    +
    +

    A string to be displayed on your customer’s credit card statement. This may be +up to 22 characters. The statement descriptor must contain at least one letter, +may not include <>"' characters, and will appear on your customer’s statement +in capital letters. Non-ASCII characters are automatically stripped. While +most banks and card issuers display this information consistently, some may +display it incorrectly or not at all.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *statementDescriptor;
    + +
    +
    +

    Swift

    + 
    var statementDescriptor: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A string to specify details about the transaction so your customer can understand it clearly on their statement. +The suffix is concatenated with the statementDescriptor, the * symbol, and a space to form the complete statement +descriptor that your customer sees. Maximum 22 characters for the final concatenated descriptor.

    +
    +

    See

    + https://stripe.com/docs/account/statement-descriptors + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *statementDescriptorSuffix;
    + +
    +
    +

    Swift

    + 
    var statementDescriptorSuffix: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + receiptEmail + +
    +
    +
    +
    +
    +
    +

    Email address that the receipt for the resulting payment will be sent to.

    +
    +

    See

    + https://stripe.com/docs/terminal/checkout/receipts + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *receiptEmail;
    + +
    +
    +

    Swift

    + 
    var receiptEmail: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + customer + +
    +
    +
    +
    +
    +
    +

    The ID of the Customer this PaymentIntent is for, if one exists.

    +
    +

    See

    + https://stripe.com/docs/api/customers + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *customer;
    + +
    +
    +

    Swift

    + 
    var customer: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + applicationFeeAmount + +
    +
    +
    +
    +
    +
    +

    The amount of the application fee (if any) that will be applied to the +payment and transferred to the application owner’s Stripe account. To use an +application fee, the request must be made on behalf of another account, +using the stripeAccount property or an OAuth key.

    + +

    The amount must be provided as a boxed UInt in the currency’s smallest unit.

    +
    +

    See

    + https://stripe.com/docs/connect/direct-charges#collecting-fees + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSNumber *applicationFeeAmount;
    + +
    +
    +

    Swift

    + 
    @NSCopying var applicationFeeAmount: NSNumber? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + transferGroup + +
    +
    +
    +
    +
    +
    +

    A string that identifies the resulting payment as part of a group.

    +
    +

    See

    + https://stripe.com/docs/connect/charges-transfers#grouping-transactions + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *transferGroup;
    + +
    +
    +

    Swift

    + 
    var transferGroup: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The account (if any) the payment will be attributed to for tax reporting, and +where funds from the payment will be transferred to upon payment success.

    + +

    At capture time, use transfer_data[amount] to specify the amount that will be +transferred automatically when a charge succeeds.

    + +

    When transferDataDestination is specified, onBehalfOf must also be +specified and must match the destination of the transfer.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *transferDataDestination;
    + +
    +
    +

    Swift

    + 
    var transferDataDestination: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + onBehalfOf + +
    +
    +
    +
    +
    +
    +

    The Stripe account ID for which these funds are intended.

    + +

    When transferDataDestination is specified, onBehalfOf must also be +specified and must match the destination of the transfer.

    +
    +

    See

    + https://stripe.com/docs/connect/charges-transfers#on-behalf-of + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *onBehalfOf;
    + +
    +
    +

    Swift

    + 
    var onBehalfOf: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + setupFutureUsage + +
    +
    +
    +
    +
    +
    +

    Indicates that you intend to make future payments with this PaymentIntent’s payment method.

    + +

    Providing this parameter will attach the payment method to the PaymentIntent’s Customer, +after the PaymentIntent is confirmed and any required actions from the user are complete. +If no Customer was provided, the payment method can still be attached to a Customer after +the transaction completes.

    + +

    Possible values: +“on_session”: Use “on_session” if you intend to only reuse the payment method when your +customer is present in your checkout flow. +“off_session”: Use “off_session” if your customer may or may not be present in your checkout flow.

    +
    +

    See

    + https://stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *setupFutureUsage;
    + +
    +
    +

    Swift

    + 
    var setupFutureUsage: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Specific options used during the creation of the PaymentMethod.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) SCPPaymentMethodOptionsParameters *_Nonnull paymentMethodOptionsParameters;
    + +
    +
    +

    Swift

    + 
    var paymentMethodOptionsParameters: PaymentMethodOptionsParameters { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes SCPPaymentIntentParameters with the given parameters.

    + +

    Note: in testmode, only amounts ending in “00” will be approved. All other +amounts will be declined by the Stripe API. For more information about this +feature, see https://stripe.com/docs/terminal/testing#test-card

    + +

    This initializer will use the default paymentMethodTypes value: [“card_present”]

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithAmount:(NSUInteger)amount
+                              currency:(nonnull NSString *)currency;
    + +
    +
    +

    Swift

    + 
    init(amount: UInt, currency: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + amount + + +
    +

    The amount of the payment, provided in the currency’s +smallest unit.

    +
    +
    + + currency + + +
    +

    The currency of the payment.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes SCPPaymentIntentParameters with the given parameters.

    +
    +

    Note

    +

    In testmode, only amounts ending in “00” will be approved. All other +amounts will be declined by the Stripe API. For more information about this +feature, see https://stripe.com/docs/terminal/testing#test-card

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithAmount:(NSUInteger)amount
+                              currency:(nonnull NSString *)currency
+                    paymentMethodTypes:
+                        (nonnull NSArray<NSString *> *)paymentMethodTypes;
    + +
    +
    +

    Swift

    + 
    init(amount: UInt, currency: String, paymentMethodTypes: [String])
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + amount + + +
    +

    The amount of the payment, provided in the currency’s +smallest unit.

    +
    +
    + + currency + + +
    +

    The currency of the payment.

    +
    +
    + + paymentMethodTypes + + +
    +

    The payment method types allowed for this +payment. Currently allowed payment method types for a Terminal transaction are +“card_present” and “interac_present”.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes SCPPaymentIntentParameters with the given parameters.

    +
    +

    Note

    +

    In testmode, only amounts ending in “00” will be approved. All other +amounts will be declined by the Stripe API. For more information about this +feature, see https://stripe.com/docs/terminal/testing#test-card

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithAmount:(NSUInteger)amount
+                              currency:(nonnull NSString *)currency
+                         captureMethod:(SCPCaptureMethod)captureMethod;
    + +
    +
    +

    Swift

    + 
    init(amount: UInt, currency: String, captureMethod: CaptureMethod)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + amount + + +
    +

    The amount of the payment, provided in the currency’s +smallest unit.

    +
    +
    + + currency + + +
    +

    The currency of the payment.

    +
    +
    + + captureMethod + + +
    +

    The type of capture method used for this payment. +Passing in SCPCaptureMethodAutomatic will result in a capture occurring automatically +whereas SCPCaptureMethodManual will require an explicit call to capture payments +(see: https://stripe.com/docs/terminal/payments/collect-payment?terminal-sdk-platform=ios#capture-payment)

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes SCPPaymentIntentParameters with the given parameters.

    +
    +

    Note

    +

    In testmode, only amounts ending in “00” will be approved. All other +amounts will be declined by the Stripe API. For more information about this +feature, see https://stripe.com/docs/terminal/testing#test-card

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithAmount:(NSUInteger)amount
+                              currency:(nonnull NSString *)currency
+                    paymentMethodTypes:
+                        (nonnull NSArray<NSString *> *)paymentMethodTypes
+                         captureMethod:(SCPCaptureMethod)captureMethod;
    + +
    +
    +

    Swift

    + 
    init(amount: UInt, currency: String, paymentMethodTypes: [String], captureMethod: CaptureMethod)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + amount + + +
    +

    The amount of the payment, provided in the currency’s +smallest unit.

    +
    +
    + + currency + + +
    +

    The currency of the payment.

    +
    +
    + + paymentMethodTypes + + +
    +

    The payment method types allowed for this +payment. Currently allowed payment method types for a Terminal transaction are +“card_present” and “interac_present”.

    +
    +
    + + captureMethod + + +
    +

    The type of capture method used for this payment. +Passing in SCPCaptureMethodAutomatic will result in a capture occuring automatically +whereas SCPCaptureMethodManual will require an explicit call to capture payments +(see: https://stripe.com/docs/terminal/payments/collect-payment?terminal-sdk-platform=ios#capture-payment)

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithAmount:currency:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithAmount:currency:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + description + +
    +
    +
    +
    +
    +
    +

    Deprecated

    +

    Did you mean to use stripeDescription?

    + +
    +
    +

    Use stripeDescription for the string attached to the object.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly) DEPRECATED_MSG_ATTRIBUTE("Did you mean to use stripeDescription?") NSString *description;
    + +
    +
    +

    Swift

    + 
    var description: String { get }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentMethod.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentMethod.html new file mode 100644 index 00000000..0cc3a9cd --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentMethod.html @@ -0,0 +1,777 @@ + + + + SCPPaymentMethod Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPPaymentMethod Class Reference +

+ +
+ +
+ +
+
+

SCPPaymentMethod

+
+
+

Objective-C

+ 

+@interface SCPPaymentMethod : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class PaymentMethod : NSObject, JSONDecodable
+ +
+
+

PaymentMethod objects represent your customer’s payment instruments. +They can be used with PaymentIntents to collect payments, or saved +to Customer objects to store instrument details for future payments.

+
+

See

+ https://stripe.com/docs/api/payment_methods + +
+

See

+ https://stripe.com/docs/payments/payment-methods/saving#attach-method + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + stripeId + +
    +
    +
    +
    +
    +
    +

    The unique identifier for the PaymentMethod

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull stripeId;
    + +
    +
    +

    Swift

    + 
    var stripeId: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + created + +
    +
    +
    +
    +
    +
    +

    Time at which the object was created. Measured in seconds since the Unix epoch.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSDate *created;
    + +
    +
    +

    Swift

    + 
    var created: Date? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    The type of the PaymentMethod. The corresponding, similarly named property contains additional information specific to the PaymentMethod type. +e.g. if the type is SCPPaymentMethodTypeCard, the card property is also populated.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPPaymentMethodType type;
    + +
    +
    +

    Swift

    + 
    var type: PaymentMethodType { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + card + +
    +
    +
    +
    +
    +
    +

    If this is a card PaymentMethod (ie self.type == SCPPaymentMethodTypeCard), this contains additional details.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPCardDetails *card;
    + +
    +
    +

    Swift

    + 
    var card: SCPCardDetails? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardPresent + +
    +
    +
    +
    +
    +
    +

    If this is a card_present PaymentMethod (ie self.type == SCPPaymentMethodTypeCardPresent), this contains additional details.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPCardPresentDetails *cardPresent;
    + +
    +
    +

    Swift

    + 
    var cardPresent: SCPCardPresentDetails? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + interacPresent + +
    +
    +
    +
    +
    +
    +

    If this is an Interac_present PaymentMethod (ie self.type == SCPPaymentMethodTypeInteracPresent), this contains additional details.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPCardPresentDetails *interacPresent;
    + +
    +
    +

    Swift

    + 
    var interacPresent: SCPCardPresentDetails? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + customer + +
    +
    +
    +
    +
    +
    +

    The Customer that this PaymentMethod is attached to, or nil.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *customer;
    + +
    +
    +

    Swift

    + 
    var customer: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    +
    +

    See

    + https://stripe.com/docs/api#metadata + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSDictionary<NSString *, NSString *> *_Nonnull metadata;
    + +
    +
    +

    Swift

    + 
    var metadata: [String : String] { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentMethodDetails.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentMethodDetails.html new file mode 100644 index 00000000..47f84137 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentMethodDetails.html @@ -0,0 +1,583 @@ + + + + SCPPaymentMethodDetails Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPPaymentMethodDetails Class Reference +

+ +
+ +
+ +
+
+

SCPPaymentMethodDetails

+
+
+

Objective-C

+ 

+@interface SCPPaymentMethodDetails : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class PaymentMethodDetails : NSObject, JSONDecodable
+ +
+
+

Details about a PaymentMethod at a specific time. ex: at time of transaction +for a Charge.

+
+

See

+ https://stripe.com/docs/api/charges/object#charge_object-payment_method_details + +
+ +

Unlike an SCPPaymentMethod, the details object does not have a stripeId, +and only exists as a sub-object of another Stripe object.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    The type of the PaymentMethod. The corresponding, similarly named property +contains additional information specific to the PaymentMethod type. +e.g. if the type is SCPPaymentMethodTypeCardPresent, the cardPresent +property is also populated.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPPaymentMethodType type;
    + +
    +
    +

    Swift

    + 
    var type: PaymentMethodType { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardPresent + +
    +
    +
    +
    +
    +
    +

    If this is a card present payment method (ie self.type == SCPPaymentMethodTypeCardPresent), +this contains additional information.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPCardPresentDetails *cardPresent;
    + +
    +
    +

    Swift

    + 
    var cardPresent: SCPCardPresentDetails? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + interacPresent + +
    +
    +
    +
    +
    +
    +

    If this is an Interac present payment method (ie self.type == SCPPaymentMethodTypeInteracPresent), +this contains additional information.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPCardPresentDetails *interacPresent;
    + +
    +
    +

    Swift

    + 
    var interacPresent: SCPCardPresentDetails? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentMethodOptionsParameters.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentMethodOptionsParameters.html new file mode 100644 index 00000000..f4b01067 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentMethodOptionsParameters.html @@ -0,0 +1,562 @@ + + + + SCPPaymentMethodOptionsParameters Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPPaymentMethodOptionsParameters Class Reference +

+ +
+ +
+ +
+
+

SCPPaymentMethodOptionsParameters

+
+
+

Objective-C

+ 

+@interface SCPPaymentMethodOptionsParameters : NSObject
+ +
+
+

Swift

+ 
class PaymentMethodOptionsParameters : NSObject
+ +
+
+

The PaymentMethodOptionsParameters contains options for PaymentMethod creation.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + cardPresentParameters + +
    +
    +
    +
    +
    +
    +

    Card-present-specific configuration for this PaymentMethod.

    +
    +

    See

    + https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method_options-card_present + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, strong) SCPCardPresentParameters *_Nonnull cardPresentParameters;
    + +
    +
    +

    Swift

    + 
    var cardPresentParameters: CardPresentParameters { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize a PaymentMethodOptionsParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithCardPresentParameters:
+    (nonnull SCPCardPresentParameters *)cardPresentParameters;
    + +
    +
    +

    Swift

    + 
    init(cardPresentParameters: CardPresentParameters)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + cardPresentParameters + + +
    +

    Payment-method-specific configuration for this PaymentIntent.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithCardPresentParameters:(SCPCardPresentParameters)cardPresentParameters

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPProcessPaymentError.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPProcessPaymentError.html new file mode 100644 index 00000000..dbe0e5b2 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPProcessPaymentError.html @@ -0,0 +1,623 @@ + + + + SCPProcessPaymentError Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPProcessPaymentError Class Reference +

+ +
+ +
+ +
+
+

SCPProcessPaymentError

+
+
+

Objective-C

+ 

+@interface SCPProcessPaymentError : NSError
+ +
+
+

Swift

+ 
class ProcessPaymentError : NSError
+ +
+
+

An error from -[SCPTerminal processPayment:completion:].

+
+

See

+ https://stripe.com/docs/terminal/payments#process + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + paymentIntent + +
    +
    +
    +
    +
    +
    +

    The updated PaymentIntent after processPayment failed.

    + +
      +

    1. If the status of the updated PaymentIntent is still .requiresConfirmation +(e.g the request failed because your app is not connected to the internet), +you may call processPayment again with the updated PaymentIntent to +retry the request.

      2. +

    2. If the status of the updated PaymentIntent is .requiresPaymentMethod (e.g. the +request failed because the card was declined), you should call +collectPaymentMethod with the updated PaymentIntent to try charging another +card.

      3. +

    3. If this value is nil, the request timed out, and the status of the +PaymentIntent is unknown. We recommend that you retry processPayment using +the original PaymentIntent. If you instead choose to abandon the original +PaymentIntent and create a new one, you should be sure not to capture the +original PaymentIntent.

      4. +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPPaymentIntent *paymentIntent;
    + +
    +
    +

    Swift

    + 
    var paymentIntent: SCPPaymentIntent? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + requestError + +
    +
    +
    +
    +
    +
    +

    If processPayment failed because the underlying network request errored, +this property contains additional details about the error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSError *requestError;
    + +
    +
    +

    Swift

    + 
    var requestError: Error? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + declineCode + +
    +
    +
    +
    +
    +
    +

    If processPayment failed because the payment method was declined, this +property contains the decline code.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *declineCode;
    + +
    +
    +

    Swift

    + 
    var declineCode: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPProcessRefundError.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPProcessRefundError.html new file mode 100644 index 00000000..fbdca4ef --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPProcessRefundError.html @@ -0,0 +1,580 @@ + + + + SCPProcessRefundError Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPProcessRefundError Class Reference +

+ +
+ +
+ +
+
+

SCPProcessRefundError

+
+
+

Objective-C

+ 

+@interface SCPProcessRefundError : NSError
+ +
+
+

Swift

+ 
class ProcessRefundError : NSError
+ +
+
+

An error from -[SCPTerminal processRefund:completion:].

+
+

See

+ https://stripe.com/docs/terminal/canada#interac-refunds + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + refund + +
    +
    +
    +
    +
    +
    +

    If processRefund failed after the refund was created, this property contains +the failing refund.

    +
    +

    See

    + https://stripe.com/docs/api/refunds/object + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPRefund *refund;
    + +
    +
    +

    Swift

    + 
    var refund: SCPRefund? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + requestError + +
    +
    +
    +
    +
    +
    +

    If processRefund failed because the underlying network request errored, +this property contains additional details about the error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSError *requestError;
    + +
    +
    +

    Swift

    + 
    var requestError: Error? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReadReusableCardParameters.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReadReusableCardParameters.html new file mode 100644 index 00000000..ee8243fb --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReadReusableCardParameters.html @@ -0,0 +1,530 @@ + + + + SCPReadReusableCardParameters Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPReadReusableCardParameters Class Reference +

+ +
+ +
+ +
+
+

SCPReadReusableCardParameters

+
+
+

Objective-C

+ 

+@interface SCPReadReusableCardParameters : NSObject
+ +
+
+

Swift

+ 
class ReadReusableCardParameters : NSObject
+ +
+
+

Parameters for reading a reusable card.

+ +

NOTE: Most integrations should not use readReusableCard.

+ +

You should create a PaymentIntent and use the associated collectPaymentMethod +and processPayment methods if you are simply collecting a payment from +a customer.

+ +

You can use -[SCPTerminal readReusableCard:delegate:completion:] to read +payment details and defer payment for later. The SCPPaymentMethod created by +this method will have type card, suitable for use with online payments.

+ +

Note that if you use this method to defer a payment, the transaction will +not receive the beneficial rates and liability shift associated with card +present transactions.

+
+

See

+ https://stripe.com/docs/terminal/online-payments + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + customer + +
    +
    +
    +
    +
    +
    +

    Optional parameter: attach the new PaymentMethod to Customer with this id

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *customer;
    + +
    +
    +

    Swift

    + 
    var customer: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Optional set of key-value pairs attached to the object. The default is nil.

    +
    +

    See

    + https://stripe.com/docs/api#metadata + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSDictionary<NSString *, NSString *> *metadata;
    + +
    +
    +

    Swift

    + 
    var metadata: [String : String]? { get set }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReader.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReader.html new file mode 100644 index 00000000..32b7bf17 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReader.html @@ -0,0 +1,1102 @@ + + + + SCPReader Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPReader Class Reference +

+ +
+ +
+ +
+
+

SCPReader

+
+
+

Objective-C

+ 

+@interface SCPReader : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class Reader : NSObject, JSONDecodable
+ +
+
+

Information about a card reader that has been discovered by or connected to +the SDK.

+ +

Some of the properties are only applicable to a certain device type. +These properties are labeled with the reader or reader type to which they apply.

+
+

See

+ https://stripe.com/docs/terminal/readers + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + deviceType + +
    +
    +
    +
    +
    +
    +

    The reader’s device type.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPDeviceType deviceType;
    + +
    +
    +

    Swift

    + 
    var deviceType: DeviceType { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + simulated + +
    +
    +
    +
    +
    +
    +

    True if this is a simulated reader.

    + +

    SCPDiscoveryConfiguration objects with simulated set to true produce simulated +readers.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) BOOL simulated;
    + +
    +
    +

    Swift

    + 
    var simulated: Bool { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + stripeId + +
    +
    +
    +
    +
    +
    +

    The Stripe unique identifier for the reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *stripeId;
    + +
    +
    +

    Swift

    + 
    var stripeId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + locationId + +
    +
    +
    +
    +
    +
    +

    The ID of the reader’s Location.

    + +

    Internet readers remain registered to the location specified when registering +the reader to your account. For internet readers, this field represents that location. +If you need to change your internet reader’s location, re-register the reader and +specify the new location id in the location param. +See https://stripe.com/docs/api/terminal/readers/create

    + +

    Bluetooth and Apple Built-In readers are designed to be more mobile and must be +registered to a location upon each connection. This field represents the last +location that the reader was registered to. If the reader has not been used before, +this field will be nil. If you associate the reader to a different location while calling +connectBluetoothReader, this field will update to that new location’s ID.

    +
    +

    See

    + https://stripe.com/docs/api/terminal/locations + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nullable) NSString *locationId;
    + +
    +
    +

    Swift

    + 
    var locationId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + locationStatus + +
    +
    +
    +
    +
    +
    +

    Used to tell whether the location field has been set. +Note that the Internet and simulated readers will always +have an unknown locationStatus.

    + +

    (Bluetooth and Apple Built-In readers only.)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly) SCPLocationStatus locationStatus;
    + +
    +
    +

    Swift

    + 
    var locationStatus: LocationStatus { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + location + +
    +
    +
    +
    +
    +
    +

    The details of the location this reader is registered to, if any.

    + +

    During discovery, location will be nil for Bluetooth readers that have never +been connected to.

    + +

    You must assign a Bluetooth reader to a location from the SDK during connectBluetoothReader. +See locationId in SCPBluetoothConnectionConfiguration.

    + +

    After connecting to a reader, location will be nil if the reader has been +registered to a new location. See https://stripe.com/docs/api/terminal/locations/retrieve +for documentation on retrieving location details in your app.

    + +

    (Bluetooth and Apple Built-In readers only.)

    +
    +

    See

    + https://stripe.com/docs/api/terminal/locations + +
    +

    See

    + https://stripe.com/docs/terminal/readers/fleet-management#bbpos-wisepad3 + +
    +

    See

    + SCPConnectionConfiguration + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nullable) SCPLocation *location;
    + +
    +
    +

    Swift

    + 
    var location: Location? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + serialNumber + +
    +
    +
    +
    +
    +
    +

    The reader’s serial number.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull serialNumber;
    + +
    +
    +

    Swift

    + 
    var serialNumber: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + deviceSoftwareVersion + +
    +
    +
    +
    +
    +
    +

    The reader’s current device software version, or nil if this information is +unavailable.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nullable) NSString *deviceSoftwareVersion;
    + +
    +
    +

    Swift

    + 
    var deviceSoftwareVersion: String? { get }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Bluetooth Reader Properties +

+
+
+
    +
  • +
    + + + + availableUpdate + +
    +
    +
    +
    +
    +
    +

    The available update for this reader, or nil if no update is available. +This update will also have been announced via +- [BluetoothReaderDelegate reader:didReportAvailableUpdate:]

    + +

    Install this update with - [Terminal installAvailableUpdate]

    + +

    calls to installAvailableUpdate when availableUpdate is nil will result +in - [BluetoothReaderDelegate reader:didFinishInstallingUpdate:error:] called +immediately with a nil update and nil error.

    + +

    (Bluetooth readers only.)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nullable) SCPReaderSoftwareUpdate *availableUpdate;
    + +
    +
    +

    Swift

    + 
    var availableUpdate: SCPReaderSoftwareUpdate? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + batteryLevel + +
    +
    +
    +
    +
    +
    +

    The reader’s battery level, represented as a boxed float in the range [0, 1]. +If the reader does not have a battery, or the battery level is unknown, this +value is nil.

    + +

    (Bluetooth readers only.)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nullable) NSNumber *batteryLevel;
    + +
    +
    +

    Swift

    + 
    var batteryLevel: NSNumber? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + batteryStatus + +
    +
    +
    +
    +
    +
    +

    The reader’s battery status. Usable as a general classification for the current +battery state.

    + +

    (Bluetooth readers only.)

    +
    +

    See

    + SCPBatteryStatus + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly) SCPBatteryStatus batteryStatus;
    + +
    +
    +

    Swift

    + 
    var batteryStatus: BatteryStatus { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + isCharging + +
    +
    +
    +
    +
    +
    +

    The reader’s charging state, represented as a BOOL +If the reader does not have a battery, or the battery level is unknown, this +value is nil.

    + +

    (Bluetooth readers only.)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nullable) NSNumber *isCharging;
    + +
    +
    +

    Swift

    + 
    var isCharging: NSNumber? { get }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Internet Reader Properties +

+
+
+
    +
  • +
    + + + + ipAddress + +
    +
    +
    +
    +
    +
    +

    The IP address of the reader.

    + +

    (Internet readers only.)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *ipAddress;
    + +
    +
    +

    Swift

    + 
    var ipAddress: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    The networking status of the reader: either offline or online. Note that +non-Internet readers status will always be offline.

    + +

    (Internet readers only).

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPReaderNetworkStatus status;
    + +
    +
    +

    Swift

    + 
    var status: ReaderNetworkStatus { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + label + +
    +
    +
    +
    +
    +
    +

    A custom label that may be given to a reader for easier identification.

    + +

    (Internet readers only.)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *label;
    + +
    +
    +

    Swift

    + 
    var label: String? { get }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReaderSoftwareUpdate.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReaderSoftwareUpdate.html new file mode 100644 index 00000000..c77821cb --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReaderSoftwareUpdate.html @@ -0,0 +1,681 @@ + + + + SCPReaderSoftwareUpdate Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPReaderSoftwareUpdate Class Reference +

+ +
+ +
+ +
+
+

SCPReaderSoftwareUpdate

+
+
+

Objective-C

+ 

+@interface SCPReaderSoftwareUpdate : NSObject
+ +
+
+

Swift

+ 
class ReaderSoftwareUpdate : NSObject
+ +
+
+

An object representing a reader update.

+
+

See

+ https://stripe.com/docs/terminal/readers/bbpos-chipper2xbt#reader-software-releases + +
+

See

+ https://stripe.com/docs/terminal/readers/bbpos-wisepad3#reader-software-releases + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + estimatedUpdateTime + +
    +
    +
    +
    +
    +
    +

    The estimated amount of time for the update.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPUpdateTimeEstimate estimatedUpdateTime;
    + +
    +
    +

    Swift

    + 
    var estimatedUpdateTime: UpdateTimeEstimate { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + deviceSoftwareVersion + +
    +
    +
    +
    +
    +
    +

    The target version for the update.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull deviceSoftwareVersion;
    + +
    +
    +

    Swift

    + 
    var deviceSoftwareVersion: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + components + +
    +
    +
    +
    +
    +
    +

    The components that will be installed in this update.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPUpdateComponent components;
    + +
    +
    +

    Swift

    + 
    var components: UpdateComponent { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + requiredAt + +
    +
    +
    +
    +
    +
    +

    The date at which this update will be required to be installed. If this date +is in the past, the SDK will automatically update the reader upon connection. +The reader will not be able to transact until the update is complete.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers/bbpos-wisepad3#updating-reader-software + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSDate *_Nonnull requiredAt;
    + +
    +
    +

    Swift

    + 
    var requiredAt: Date { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns an unlocalized string for the given update time estimate.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSString *)stringFromUpdateTimeEstimate:
+    (SCPUpdateTimeEstimate)estimate;
    + +
    +
    +

    Swift

    + 
    class func string(from estimate: UpdateTimeEstimate) -> String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReceiptDetails.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReceiptDetails.html new file mode 100644 index 00000000..ecc9a2d0 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReceiptDetails.html @@ -0,0 +1,765 @@ + + + + SCPReceiptDetails Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPReceiptDetails Class Reference +

+ +
+ +
+ +
+
+

SCPReceiptDetails

+
+
+

Objective-C

+ 

+@interface SCPReceiptDetails : NSObject <SCPJSONDecodable, NSCopying>
+ +
+
+

Swift

+ 
class ReceiptDetails : NSObject, JSONDecodable, NSCopying
+ +
+
+

Receipt details associated with a card present transaction.

+
+

See

+ https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-receipt + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + accountType + +
    +
    +
    +
    +
    +
    +

    The type of account being debited or credited

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *accountType;
    + +
    +
    +

    Swift

    + 
    var accountType: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Also known as “Application Name”. Required on EMV receipts.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull applicationPreferredName;
    + +
    +
    +

    Swift

    + 
    var applicationPreferredName: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + dedicatedFileName + +
    +
    +
    +
    +
    +
    +

    Also known as “AID”. Required on EMV receipts.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull dedicatedFileName;
    + +
    +
    +

    Swift

    + 
    var dedicatedFileName: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + authorizationCode + +
    +
    +
    +
    +
    +
    +

    Identifier for this transaction

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *authorizationCode;
    + +
    +
    +

    Swift

    + 
    var authorizationCode: String? { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Authorization Response Code

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull authorizationResponseCode;
    + +
    +
    +

    Swift

    + 
    var authorizationResponseCode: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + applicationCryptogram + +
    +
    +
    +
    +
    +
    +

    Application Cryptogram

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull applicationCryptogram;
    + +
    +
    +

    Swift

    + 
    var applicationCryptogram: String { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    TVR

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull terminalVerificationResults;
    + +
    +
    +

    Swift

    + 
    var terminalVerificationResults: String { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    TSI

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull transactionStatusInformation;
    + +
    +
    +

    Swift

    + 
    var transactionStatusInformation: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPRefund.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPRefund.html new file mode 100644 index 00000000..9ac10c01 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPRefund.html @@ -0,0 +1,853 @@ + + + + SCPRefund Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPRefund Class Reference +

+ +
+ +
+ +
+
+

SCPRefund

+
+
+

Objective-C

+ 

+@interface SCPRefund : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class Refund : NSObject, JSONDecodable
+ +
+
+

An object representing a Stripe refund.

+ +

Some payment methods, like Interac Debit payments, require that in-person payments +also be refunded while the cardholder is present. The cardholder must present +the Interac card to the card reader; these payments cannot be refunded via the +dashboard or the API.

+
+

See

+ https://stripe.com/docs/terminal/canada#interac-refunds + +
+ +

The collectRefundPaymentMethod:completion and processRefund SDK methods +allow you to build an in-person refund interface into your app.

+ +

The refund SDK methods and the SCPRefund class are only available for +payment methods that require in-person refunds, such as Interac Debit. For +all other refunds, use the Stripe Dashboard or the Stripe API.

+
+

See

+ https://stripe.com/docs/api#refunds + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + stripeId + +
    +
    +
    +
    +
    +
    +

    The unique identifier for the refund.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull stripeId;
    + +
    +
    +

    Swift

    + 
    var stripeId: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    The amount that was refunded.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSUInteger amount;
    + +
    +
    +

    Swift

    + 
    var amount: UInt { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + charge + +
    +
    +
    +
    +
    +
    +

    The ID of the charge that was refunded

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull charge;
    + +
    +
    +

    Swift

    + 
    var charge: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + created + +
    +
    +
    +
    +
    +
    +

    When the refund object was created.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSDate *_Nonnull created;
    + +
    +
    +

    Swift

    + 
    var created: Date { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    The currency of the amount refunded.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull currency;
    + +
    +
    +

    Swift

    + 
    var currency: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Metadata associated with the refund.

    +
    +

    See

    + https://stripe.com/docs/api#metadata + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSDictionary<NSString *, NSString *> *_Nonnull metadata;
    + +
    +
    +

    Swift

    + 
    var metadata: [String : String] { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + reason + +
    +
    +
    +
    +
    +
    +

    Reason for the refund, either user-provided (duplicate, fraudulent, or +requested_by_customer) or generated by Stripe internally +(expired_uncaptured_charge).

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *reason;
    + +
    +
    +

    Swift

    + 
    var reason: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    The status of the refund.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPRefundStatus status;
    + +
    +
    +

    Swift

    + 
    var status: RefundStatus { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentMethodDetails + +
    +
    +
    +
    +
    +
    +

    The payment method details associated with the refund.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPPaymentMethodDetails *paymentMethodDetails;
    + +
    +
    +

    Swift

    + 
    var paymentMethodDetails: SCPPaymentMethodDetails? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + failureReason + +
    +
    +
    +
    +
    +
    +

    If the refund failed, the reason for refund failure if known.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *failureReason;
    + +
    +
    +

    Swift

    + 
    var failureReason: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPRefundParameters.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPRefundParameters.html new file mode 100644 index 00000000..3336fc40 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPRefundParameters.html @@ -0,0 +1,817 @@ + + + + SCPRefundParameters Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPRefundParameters Class Reference +

+ +
+ +
+ +
+
+

SCPRefundParameters

+
+
+

Objective-C

+ 

+@interface SCPRefundParameters : NSObject
+ +
+
+

Swift

+ 
class RefundParameters : NSObject
+ +
+
+

Parameters for creating an SCPRefund.

+
+

See

+ https://stripe.com/docs/api/refunds/create + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + chargeId + +
    +
    +
    +
    +
    +
    +

    The ID of the charge to be refunded.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *chargeId;
    + +
    +
    +

    Swift

    + 
    var chargeId: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    The amount of the refund, provided in the currency’s smallest unit.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSUInteger amount;
    + +
    +
    +

    Swift

    + 
    var amount: UInt { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    Three-letter ISO currency code. Must be a supported currency.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull currency;
    + +
    +
    +

    Swift

    + 
    var currency: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Set of key-value pairs that you can attach to an object. This can be useful for +storing additional information about the object in a structured format.

    +
    +

    Note

    +

    The metadata property is not set when issuing refunds with the Verifone P400 reader.

    + +
    +

    See

    +

    https://stripe.com/docs/api#metadata

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSDictionary<NSString *, NSString *> *metadata;
    + +
    +
    +

    Swift

    + 
    var metadata: [String : String]? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + reverseTransfer + +
    +
    +
    +
    +
    +
    +

    Connect only: Nullable boolean indicating whether the transfer should be +reversed when refunding this charge. The transfer will be reversed proportionally +to the amount being refunded (either the entire or partial amount).

    +
    +

    Note

    +

    This property is a nullable NSNumber being used to represent a nullable +boolean. A value of 0 represents false, while any non-zero value represents +true.

    + +
    +

    See

    +

    https://stripe.com/docs/api/refunds/create#create_refund-reverse_transfer

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, nullable) NSNumber *reverseTransfer;
    + +
    +
    +

    Swift

    + 
    var reverseTransfer: NSNumber? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + refundApplicationFee + +
    +
    +
    +
    +
    +
    +

    Connect only: Nullable boolean indicating whether the application fee should be +refunded when refunding this charge. If a full charge refund is given, the +full application fee will be refunded. Otherwise, the application fee will be +refunded in an amount proportional to the amount of the charge refunded.

    +
    +

    Note

    +

    This property is a nullable NSNumber being used to represent a nullable +boolean. A value of 0 represents false, while any non-zero value represents +true.

    + +
    +

    See

    +

    https://stripe.com/docs/api/refunds/create#create_refund-refund_application_fee

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, nullable) NSNumber *refundApplicationFee;
    + +
    +
    +

    Swift

    + 
    var refundApplicationFee: NSNumber? { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initializes SCPRefundParameters with the given charge, amount, and currency.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithChargeId:(nonnull NSString *)chargeId
+                                  amount:(NSUInteger)amount
+                                currency:(nonnull NSString *)currency;
    + +
    +
    +

    Swift

    + 
    init(chargeId: String, amount: UInt, currency: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + chargeId + + +
    +

    The ID of the charge to be refunded.

    +
    +
    + + amount + + +
    +

    The amount to be refunded, provided in the currency’s +smallest unit.

    +
    +
    + + currency + + +
    +

    The currency of the original charge. You cannot refund a charge +with a different currency than the currency that was used to create the charge.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithChargeId:amount:currency:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithChargeId:amount:currency:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupAttempt.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupAttempt.html new file mode 100644 index 00000000..5d2a7650 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupAttempt.html @@ -0,0 +1,739 @@ + + + + SCPSetupAttempt Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPSetupAttempt Class Reference +

+ +
+ +
+ +
+
+

SCPSetupAttempt

+
+
+

Objective-C

+ 

+@interface SCPSetupAttempt : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class SetupAttempt : NSObject, JSONDecodable
+ +
+
+

A SetupAttempt describes one attempted confirmation of a SetupIntent, +whether that confirmation was successful or unsuccessful. You can use +SetupAttempts to inspect details of a specific attempt at setting up a +payment method using a SetupIntent.

+
+

See

+ https://stripe.com/docs/api/setup_attempts + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + application + +
    +
    +
    +
    +
    +
    +

    The ID of the Connect application that created the SetupIntent.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *application;
    + +
    +
    +

    Swift

    + 
    var application: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + created + +
    +
    +
    +
    +
    +
    +

    Time at which the object was created.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSDate *_Nonnull created;
    + +
    +
    +

    Swift

    + 
    var created: Date { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + customer + +
    +
    +
    +
    +
    +
    +

    ID of the Customer this SetupIntent belongs to, if one exists.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *customer;
    + +
    +
    +

    Swift

    + 
    var customer: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + onBehalfOf + +
    +
    +
    +
    +
    +
    +

    (Connect) The account (if any) for which the setup is intended.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *onBehalfOf;
    + +
    +
    +

    Swift

    + 
    var onBehalfOf: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentMethod + +
    +
    +
    +
    +
    +
    +

    ID of the payment method used with this SetupAttempt.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *paymentMethod;
    + +
    +
    +

    Swift

    + 
    var paymentMethod: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentMethodDetails + +
    +
    +
    +
    +
    +
    +

    Details about the payment method at the time of SetupIntent confirmation.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPSetupAttemptPaymentMethodDetails *paymentMethodDetails;
    + +
    +
    +

    Swift

    + 
    var paymentMethodDetails: SCPSetupAttemptPaymentMethodDetails? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + setupIntent + +
    +
    +
    +
    +
    +
    +

    ID of the SetupIntent that this attempt belongs to.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull setupIntent;
    + +
    +
    +

    Swift

    + 
    var setupIntent: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    The status of this SetupAttempt. One of: requires_confirmation, +requires_action, processing, succeeded, failed, or abandoned.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull status;
    + +
    +
    +

    Swift

    + 
    var status: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + stripeId + +
    +
    +
    +
    +
    +
    +

    The unique identifier for the SetupAttempt.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull stripeId;
    + +
    +
    +

    Swift

    + 
    var stripeId: String { get }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupAttemptCardPresentDetails.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupAttemptCardPresentDetails.html new file mode 100644 index 00000000..3ed97167 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupAttemptCardPresentDetails.html @@ -0,0 +1,574 @@ + + + + SCPSetupAttemptCardPresentDetails Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPSetupAttemptCardPresentDetails Class Reference +

+ +
+ +
+ +
+
+

SCPSetupAttemptCardPresentDetails

+
+
+

Objective-C

+ 

+@interface SCPSetupAttemptCardPresentDetails : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class SetupAttemptCardPresentDetails : NSObject, JSONDecodable
+ +
+
+

An object representing details from a transaction using a card_present +payment method.

+
+

See

+ https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + generatedCard + +
    +
    +
    +
    +
    +
    +

    The ID of the Card PaymentMethod which was generated by this SetupAttempt.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull generatedCard;
    + +
    +
    +

    Swift

    + 
    var generatedCard: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + emvAuthData + +
    +
    +
    +
    +
    +
    +

    The Authorization Response Cryptogram (ARPC) from the issuer.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull emvAuthData;
    + +
    +
    +

    Swift

    + 
    var emvAuthData: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupAttemptPaymentMethodDetails.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupAttemptPaymentMethodDetails.html new file mode 100644 index 00000000..2c61e973 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupAttemptPaymentMethodDetails.html @@ -0,0 +1,583 @@ + + + + SCPSetupAttemptPaymentMethodDetails Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPSetupAttemptPaymentMethodDetails Class Reference +

+ +
+ +
+ +
+
+

SCPSetupAttemptPaymentMethodDetails

+
+
+

Objective-C

+ 

+@interface SCPSetupAttemptPaymentMethodDetails : NSObject <SCPJSONDecodable>
+ +
+
+

Swift

+ 
class SetupAttemptPaymentMethodDetails : NSObject, JSONDecodable
+ +
+
+

Details about a PaymentMethod at a specific time. ex: at time of transaction +for a SetupAttempt.

+
+

See

+ https://stripe.com/docs/api/setup_attempts/object#setup_attempt_object-payment_method_details + +
+ +

Unlike an SCPPaymentMethod, the details object does not have a stripeId, +and only exists as a sub-object of another Stripe object.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    The type of the PaymentMethod. The corresponding, similarly named property +contains additional information specific to the PaymentMethod type. +e.g. if the type is SCPPaymentMethodTypeCardPresent, the cardPresent +property is also populated.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPPaymentMethodType type;
    + +
    +
    +

    Swift

    + 
    var type: PaymentMethodType { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + cardPresent + +
    +
    +
    +
    +
    +
    +

    If this is a card present payment method (ie self.type == SCPPaymentMethodTypeCardPresent), +this contains additional information.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPSetupAttemptCardPresentDetails *cardPresent;
    + +
    +
    +

    Swift

    + 
    var cardPresent: SCPSetupAttemptCardPresentDetails? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + interacPresent + +
    +
    +
    +
    +
    +
    +

    If this is a card present payment method (ie self.type == SCPPaymentMethodTypeInteracPresent), +this contains additional information.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPSetupAttemptCardPresentDetails *interacPresent;
    + +
    +
    +

    Swift

    + 
    var interacPresent: SCPSetupAttemptCardPresentDetails? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupIntent.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupIntent.html new file mode 100644 index 00000000..f265e94b --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupIntent.html @@ -0,0 +1,744 @@ + + + + SCPSetupIntent Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPSetupIntent Class Reference +

+ +
+ +
+ +
+
+

SCPSetupIntent

+
+
+

Objective-C

+ 

+@interface SCPSetupIntent : NSObject <SCPJSONDecodable, NSCopying>
+ +
+
+

Swift

+ 
class SetupIntent : NSObject, JSONDecodable, NSCopying
+ +
+
+

A SetupIntent guides you through the process of setting up and saving a +customer’s payment credentials for future payments. For example, you could use +a SetupIntent to set up and save your customer’s card without immediately +collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

+
+

See

+ https://stripe.com/docs/api/setup_intents + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + stripeId + +
    +
    +
    +
    +
    +
    +

    The unique identifier for the intent.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSString *_Nonnull stripeId;
    + +
    +
    +

    Swift

    + 
    var stripeId: String { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + created + +
    +
    +
    +
    +
    +
    +

    When the intent was created.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSDate *_Nonnull created;
    + +
    +
    +

    Swift

    + 
    var created: Date { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + customer + +
    +
    +
    +
    +
    +
    +

    The identifier of a customer object to which the SetupIntent is attached, if applicable.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *customer;
    + +
    +
    +

    Swift

    + 
    var customer: String? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Set of key-value pairs attached to the object.

    +
    +

    See

    + https://stripe.com/docs/api#metadata + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSDictionary<NSString *, NSString *> *metadata;
    + +
    +
    +

    Swift

    + 
    var metadata: [String : String]? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + usage + +
    +
    +
    +
    +
    +
    +

    An SCPSetupIntentUsage value describing how the SetupIntent will be used. +Defaults to off-session if not set.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPSetupIntentUsage usage;
    + +
    +
    +

    Swift

    + 
    var usage: SetupIntentUsage { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    The status of the intent.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPSetupIntentStatus status;
    + +
    +
    +

    Swift

    + 
    var status: SetupIntentStatus { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + latestAttempt + +
    +
    +
    +
    +
    +
    +

    The most recent SetupAttempt for this SetupIntent

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPSetupAttempt *latestAttempt;
    + +
    +
    +

    Swift

    + 
    var latestAttempt: SCPSetupAttempt? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class. You should only use SetupIntents +that have been returned by other methods in our SDK.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class. You should only use SetupIntents +that have been returned by other methods in our SDK.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupIntentParameters.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupIntentParameters.html new file mode 100644 index 00000000..9b5e65b8 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupIntentParameters.html @@ -0,0 +1,769 @@ + + + + SCPSetupIntentParameters Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPSetupIntentParameters Class Reference +

+ +
+ +
+ +
+
+

SCPSetupIntentParameters

+
+
+

Objective-C

+ 

+@interface SCPSetupIntentParameters : NSObject
+ +
+
+

Swift

+ 
class SetupIntentParameters : NSObject
+ +
+
+

Parameters for creating an SCPSetupIntent.

+
+

See

+ https://stripe.com/docs/api/setup_intents/create + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + customer + +
    +
    +
    +
    +
    +
    +

    ID of the customer this SetupIntent belongs to, if one exists.

    + +

    If present, the SetupIntent’s payment method will be attached to the Customer +on successful setup. Payment methods attached to other Customers cannot be +used with this SetupIntent.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *customer;
    + +
    +
    +

    Swift

    + 
    var customer: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + stripeDescription + +
    +
    +
    +
    +
    +
    +

    An arbitrary string attached to the object. Often useful for displaying to users.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *stripeDescription;
    + +
    +
    +

    Swift

    + 
    var stripeDescription: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Set of key-value pairs that you can attach to an object. This can be useful for +storing additional information about the object in a structured format.

    +
    +

    See

    + https://stripe.com/docs/api#metadata + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSDictionary<NSString *, NSString *> *metadata;
    + +
    +
    +

    Swift

    + 
    var metadata: [String : String]? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + usage + +
    +
    +
    +
    +
    +
    +

    Indicates how the payment method is intended to be used in the future. If not +provided, this value defaults to SCPSetupIntentUsageOffSession.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) SCPSetupIntentUsage usage;
    + +
    +
    +

    Swift

    + 
    var usage: SetupIntentUsage { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + onBehalfOf + +
    +
    +
    +
    +
    +
    +

    Connect Only:** The Stripe account ID for which this SetupIntent is created.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, nullable) NSString *onBehalfOf;
    + +
    +
    +

    Swift

    + 
    var onBehalfOf: String? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -initWithCustomer: + +
    +
    +
    +
    +
    +
    +

    Initializes SCPSetupIntentParameters with the given customer ID.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithCustomer:(NSString *_Nullable)customerId;
    + +
    +
    +

    Swift

    + 
    init(customer customerId: String?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + customerId + + +
    +

    ID of the customer this SetupIntent belongs to, if one exists. +Stripe will attach this SetupIntent to the customer on successful creation.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithCustomer:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithCustomer:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + description + +
    +
    +
    +
    +
    +
    +

    Deprecated

    +

    Did you mean to use stripeDescription?

    + +
    +
    +

    Use stripeDescription for the string attached to the object.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, copy, readonly) DEPRECATED_MSG_ATTRIBUTE("Did you mean to use stripeDescription?") NSString *description;
    + +
    +
    +

    Swift

    + 
    var description: String { get }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSimulatedCard.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSimulatedCard.html new file mode 100644 index 00000000..c048b926 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSimulatedCard.html @@ -0,0 +1,657 @@ + + + + SCPSimulatedCard Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPSimulatedCard Class Reference +

+ +
+ +
+ +
+
+

SCPSimulatedCard

+
+
+

Objective-C

+ 

+@interface SCPSimulatedCard : NSObject
+ +
+
+

Swift

+ 
class SimulatedCard : NSObject
+ +
+
+

Simulated Card objects can be used with the shared SCPSimulatorConfiguration +to simulate different card brand and error cases with a simulated Reader.

+ +

Simulated Card objects are backed by one of Stripe’s test card numbers, which +are hardcoded to provide certain behavior within Stripe’s backend. The +Terminal SDK provides an SCPSimulatedCardType enum that automatically maps +to the card numbers for convenience.

+
+

See

+ https://stripe.com/docs/terminal/testing#simulated-test-cards + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + -initWithType: + +
    +
    +
    +
    +
    +
    +

    Create a Simulated Card object with a given simulated card type.

    +
    +

    See

    + SCPSimulatedCardType + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithType:(SCPSimulatedCardType)type;
    + +
    +
    +

    Swift

    + 
    init(type: SimulatedCardType)
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Create a Simulated Card object with a raw card number. This initializer is +made available in case Stripe creates a new test card number without creating a +corresponding SCPSimulatedCardType. The card number entered here must +be in the list of test card numbers.

    +
    +

    See

    + https://stripe.com/docs/terminal/testing#simulated-test-cards + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithTestCardNumber:
+    (nonnull NSString *)testCardNumber;
    + +
    +
    +

    Swift

    + 
    init(testCardNumber: String)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot instantiate this class without specifying a type or testcard number.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -isOnlinePin + +
    +
    +
    +
    +
    +
    +

    Returns true if the card is online pin enabled.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (BOOL)isOnlinePin;
    + +
    +
    +

    Swift

    + 
    func isOnlinePin() -> Bool
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -isOfflinePin + +
    +
    +
    +
    +
    +
    +

    Returns true if the card is offline pin enabled.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (BOOL)isOfflinePin;
    + +
    +
    +

    Swift

    + 
    func isOfflinePin() -> Bool
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot instantiate this class without specifying a type or testcard number.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSimulatorConfiguration.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSimulatorConfiguration.html new file mode 100644 index 00000000..5de8a38b --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSimulatorConfiguration.html @@ -0,0 +1,625 @@ + + + + SCPSimulatorConfiguration Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPSimulatorConfiguration Class Reference +

+ +
+ +
+ +
+
+

SCPSimulatorConfiguration

+
+
+

Objective-C

+ 

+@interface SCPSimulatorConfiguration : NSObject
+ +
+
+

Swift

+ 
class SimulatorConfiguration : NSObject
+ +
+
+

Simulator specific configurations you can set to test your integration’s +behavior in different scenarios. We recommend changing these properties during +testing to ensure your app works as expected for different reader updates +and for different presented cards.

+ +

Do not create new instances of this class. Instead, set the properties via +SCPTerminal.shared.simulatorConfiguration.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + availableReaderUpdate + +
    +
    +
    +
    +
    +
    +

    Set this to different values of the SCPSimulateReaderUpdate enum to +test your integration with different reader software update scenarios.

    +
    +

    Note

    + This is only valid for simulated Bluetooth readers. + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) SCPSimulateReaderUpdate availableReaderUpdate;
    + +
    +
    +

    Swift

    + 
    var availableReaderUpdate: SimulateReaderUpdate { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + simulatedCard + +
    +
    +
    +
    +
    +
    +

    Create a SCPSimulatedCard and set it on the shared configuration object to +test your integration with different card brands and in error scenarios.

    +
    +

    Note

    +

    Simulated Internet reader refunds do not use the specified simulated card.

    + +
    +

    See

    +

    https://stripe.com/docs/terminal/testing#simulated-test-cards

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) SCPSimulatedCard *_Nonnull simulatedCard;
    + +
    +
    +

    Swift

    + 
    var simulatedCard: SimulatedCard { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + simulatedTipAmount + +
    +
    +
    +
    +
    +
    +

    Set this to simulate a Terminal configuration object with this fixed tip +amount for all currencies.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, nullable) NSNumber *simulatedTipAmount;
    + +
    +
    +

    Swift

    + 
    var simulatedTipAmount: NSNumber? { get set }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class. +Set exposed properties via SCPTerminal.shared.simulatorConfiguration

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate this class. +Set exposed properties via SCPTerminal.shared.simulatorConfiguration

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTerminal.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTerminal.html new file mode 100644 index 00000000..2774e155 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTerminal.html @@ -0,0 +1,3387 @@ + + + + SCPTerminal Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPTerminal Class Reference +

+ +
+ +
+ +
+
+

SCPTerminal

+
+
+

Objective-C

+ 

+@interface SCPTerminal : NSObject
+ +
+
+

Swift

+ 
class Terminal : NSObject
+ +
+
+

The SCPTerminal singleton object exposes an interface for discovering readers, +connecting to a reader, creating payments, and saving card information for later +use.

+ +

Before accessing the singleton object using the shared property, you must set +a ConnectionToken provider: an object that implements the SCPConnectionTokenProvider +protocol. This object should authenticate with your backend, then fetch the secret +from a freshly minted ConnectionToken.

+ +

The SCPTerminal singleton can only be connected to one reader at a time, and +can only perform one operation at a time. As a general rule, make sure the +completion handler of one operation has been called before calling another +operation from within your app.

+ +

The Stripe Terminal SDK sends updates to your app by using the delegate pattern. +You may want multiple views in your app to respond to these delegate calls. +We recommend creating a central delegate announcer which broadcasts all delegate +calls to views and ViewControllers that register themselves with that announcer. +We have an example implementation of a TerminalDelegateAnnouncer as part of our +example application.

+ +
+
+ +
+
+
+
+ + +
+ +

Initializing and accessing the SCPTerminal singleton +

+
+
+
    +
  • +
    + + + + +setTokenProvider: + +
    +
    +
    +
    +
    +
    +

    Sets the token provider for the shared (singleton) SCPTerminal instance.

    + +

    You must set a token provider before calling shared to initialize the +Terminal singleton. We recommend calling setTokenProvider: in your +AppDelegate’s application:didFinishLaunchingWithOptions: method. +Alternatively, you can wrap your call to setTokenProvider: with a +dispatch_once in Objective-C, or use a static constructor in Swift.

    + +

    Note that you may only set a token provider before requesting the shared +Terminal instance for the first time. In order to switch accounts in your app, +e.g. to switch between live and test Stripe API keys on your backend, refer +to the documentation for the clearCachedCredentials method on the shared +Terminal instance.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (void)setTokenProvider:(nonnull id<SCPConnectionTokenProvider>)tokenProvider;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +hasTokenProvider + +
    +
    +
    +
    +
    +
    +

    Returns true if a token provider has been set, through setTokenProvider:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (BOOL)hasTokenProvider;
    + +
    +
    +

    Swift

    + 
    class func hasTokenProvider() -> Bool
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +setLogListener: + +
    +
    +
    +
    +
    +
    +

    Sets a block to listen for logs from the shared Terminal instance (optional).

    + +

    You can use this optional method to listen for logs from the Stripe Terminal +SDK and incorporate them into your own remote logs. Note that these logs +are subject to change, and provided for informational and debugging purposes +only. You should not depend on them for behavior in your app. Also note that +the block you provide may be called from any thread.

    + +

    To print internal logs from the SDK to the console, you can set logLevel to +SCPLogLevelVerbose on the Terminal instance.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (void)setLogListener:(nonnull SCPLogListenerBlock)listener;
    + +
    +
    +

    Swift

    + 
    class func setLogListener(_ listener: @escaping LogListenerBlock)
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + shared + +
    +
    +
    +
    +
    +
    +

    Returns the shared (singleton) Terminal instance.

    + +

    Before accessing the singleton for the first time, you must first call +setTokenProvider:.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (class, nonatomic, readonly) SCPTerminal *_Nonnull shared;
    + +
    +
    +

    Swift

    + 
    class var shared: Terminal { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + delegate + +
    +
    +
    +
    +
    +
    +

    The Terminal singleton object’s primary delegate. This delegate announces +connection and payment status updates to your app.

    + +

    Setting this property is mandatory before connecting to a Bluetooth reader, +like the BBPOS Chipper 2X BT or the BBPOS WisePad 3. Setting this property +is optional before connecting to an internet reader, like the Verifone P400.

    + +

    A runtime assert will fire if your app attempts to connect to a reader that +requires the delegate.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, nullable) id<SCPTerminalDelegate> delegate;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Accessing the current state of the singleton +

+
+
+
    +
  • +
    + + + + connectedReader + +
    +
    +
    +
    +
    +
    +

    Information about the connected SCPReader, or nil if no reader is connected.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) SCPReader *connectedReader;
    + +
    +
    +

    Swift

    + 
    var connectedReader: SCPReader? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + connectionStatus + +
    +
    +
    +
    +
    +
    +

    The Terminal instance’s current connection status.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPConnectionStatus connectionStatus;
    + +
    +
    +

    Swift

    + 
    var connectionStatus: ConnectionStatus { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + logLevel + +
    +
    +
    +
    +
    +
    +

    The log level for the SDK. The default value is .none.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) SCPLogLevel logLevel;
    + +
    +
    +

    Swift

    + 
    var logLevel: LogLevel { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The simulator configuration settings that will be used when connecting to +and creating payments with a simulated reader. This object will always exist; +to set the configuration settings, set the readwrite properties on +Terminal.shared.simulatorConfiguration.

    +
    +

    See

    + SCPSimulatorConfiguration + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPSimulatorConfiguration *_Nonnull simulatorConfiguration;
    + +
    +
    +

    Swift

    + 
    var simulatorConfiguration: SimulatorConfiguration { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + paymentStatus + +
    +
    +
    +
    +
    +
    +

    The Terminal instance’s current payment status.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPPaymentStatus paymentStatus;
    + +
    +
    +

    Swift

    + 
    var paymentStatus: PaymentStatus { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Clears the current connection token, saved reader sessions, and any other +cached credentials. You can use this method to switch accounts in your app, +e.g. to switch between live and test Stripe API keys on your backend.

    + +

    In order to switch accounts in your app:

    + +
      +
    • if a reader is connected, call disconnectReader:
      • +
    • configure the tokenProvider object to return connection tokens for the new account. +The tokenProvider is implemented by your code, and you can do this however you want.
      • +
    • call clearCachedCredentials
      • +
    • call discoverReaders and connectReader to connect to a reader. The connect call +will request a new connection token from your backend server via the token provider.
      • +
    + +

    An overview of the lifecycle of a connection token under the hood:

    + +
      +
    • When the Terminal singleton is initialized, the SDK attempts to proactively request +a connection token from your backend server.
      • +
    • When connect is called, the SDK uses the connection token and reader +information to create a reader session.
      • +
    • Subsequent calls to connect will re-use the reader session if the SDK +has successfully connected to the reader already. Otherwise, it will require a +new connection token when you call connect again.
      • +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)clearCachedCredentials;
    + +
    +
    +

    Swift

    + 
    func clearCachedCredentials()
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Reader discovery, connection, and updates +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Use this method to determine whether the mobile device supports a given reader type +using a particular discovery method. This is useful for the Local Mobile reader +discovery method where support will vary according to operating system +and hardware capabilities.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (BOOL)supportsReadersOfType:(SCPDeviceType)deviceType
+              discoveryMethod:(SCPDiscoveryMethod)discoveryMethod
+                    simulated:(BOOL)simulated
+                        error:(NSError *_Nullable *_Nullable)error;
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + deviceType + + +
    +

    Reader device type to determine support for.

    +
    +
    + + discoveryMethod + + +
    +

    Associated discovery method.

    +
    +
    + + simulated + + +
    +

    Determines whether to check for availability of + simulated discovery to discover a device simulator. + The Terminal SDK comes with the ability to simulate behavior + without using physical hardware. This makes it easy to + quickly test your integration end-to-end, + from pairing with a reader to taking payments.

    +
    +
    + + error + + +
    +

    If not supported, an error indicating the reason. +@returns YES if supported, NO otherwise.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Begins discovering readers based on the given discovery configuration.

    + +

    When discoverReaders is called, the terminal begins scanning for readers using +the settings in the given SCPDiscoveryConfiguration. You must implement +SCPDiscoveryDelegate to get notified of discovered readers and display +discovery results to your user.

    + +

    You must call connectBluetoothReader or connectInternetReader while +a discovery is taking place. You can only connect to a reader that was +returned from the SCPDiscoveryDelegate‘s didUpdateDiscoveredReaders method.

    + +

    The discovery process will stop on its own when the terminal successfully +connects to a reader, if the command is canceled, or if a discovery error occurs.

    +
    +

    Note

    +

    If discoverReaders is canceled, the completion block will be called +with nil (rather than an SCPErrorCanceled error).

    + +
    +

    See

    +

    https://stripe.com/docs/terminal/readers/connecting

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable SCPCancelable *)
+    discoverReaders:(nonnull SCPDiscoveryConfiguration *)configuration
+           delegate:(nonnull id<SCPDiscoveryDelegate>)delegate
+         completion:(nonnull SCPErrorCompletionBlock)completion;
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + configuration + + +
    +

    The configuration for reader discovery.

    +
    +
    + + delegate + + +
    +

    Your delegate for reader discovery.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Attempts to connect to the given Bluetooth reader with a given connection +configuration.

    + +

    To connect to a Bluetooth reader, your app must register that reader to a +Location upon connection. +You should create a SCPBluetoothConnectionConfiguration +at some point before connecting which specifies the location to which this +reader belongs.

    + +

    Throughout the lifetime of the connection, the reader will communicate +with your app via the SCPBluetoothReaderDelegate to announce transaction +status, battery level, and software update information.

    + +

    If the connection succeeds, the completion block will be called with the +connected reader, and SCPTerminal.connectionStatus will change to .connected.

    + +

    If the connection fails, the completion block will be called with an error.

    + +

    The SDK must be actively discovering readers in order to connect to one. +The discovery process will stop if this connection request succeeds, otherwise +the SDK will continue discovering.

    + +

    When this method is called, the SDK uses a connection token and the given +reader information to register the reader to your Stripe account. If the SDK +does not already have a connection token, it will call the fetchConnectionToken +method in your SCPConnectionTokenProvider implementation.

    + +

    If the reader’s battery is critically low the connect call will fail with +SCPErrorBluetoothDisconnected. Plug your reader in to start charging and +try again.

    +
    +

    See

    +

    https://stripe.com/docs/terminal/readers/connecting

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)connectBluetoothReader:(nonnull SCPReader *)reader
+                      delegate:(nonnull id<SCPBluetoothReaderDelegate>)delegate
+              connectionConfig:(nonnull SCPBluetoothConnectionConfiguration *)
+                                   connectionConfig
+                    completion:(nonnull SCPReaderCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func connectBluetoothReader(_ reader: SCPReader, delegate: BluetoothReaderDelegate, connectionConfig: SCPBluetoothConnectionConfiguration) async throws -> SCPReader
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + reader + + +
    +

    The reader to connect to. This should be a reader +recently returned to the didUpdateDiscoveredReaders: method in the discovery delegate.

    +
    +
    + + delegate + + +
    +

    The delegate used during the lifetime of the connection. +See SCPBluetoothReaderDelegate.

    +
    +
    + + connectionConfig + + +
    +

    The connection configuration for options while +connecting to a reader. See SCPBluetoothConnectionConfiguration for more details.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Attempts to connect to the given Internet reader with a given connection +configuration.

    + +

    If the connect succeeds, the completion block will be called with the +connected reader, and SCPTerminal.connectionStatus will change to .connected.

    + +

    If the connect fails, the completion block will be called with an error.

    + +

    The SDK must be actively discovering readers in order to connect to one. +The discovery process will stop if this connection request succeeds, otherwise +the SDK will continue discovering.

    + +

    When this method is called, the SDK uses a connection token and the given +reader information to create a reader session. If the SDK does not already +have a connection token, it will call the `fetchConnectionToken method you +defined to fetch one.

    + +

    If connectionConfig is set to nil, the SDK will resort to +default connection behavior; see the SCPInternetConnectionConfiguration +header documentation for more details.

    +
    +

    See

    +

    https://stripe.com/docs/terminal/readers/connecting

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)connectInternetReader:(nonnull SCPReader *)reader
+             connectionConfig:
+                 (nullable SCPInternetConnectionConfiguration *)connectionConfig
+                   completion:(nonnull SCPReaderCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func connectInternetReader(_ reader: SCPReader, connectionConfig: SCPInternetConnectionConfiguration?) async throws -> SCPReader
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + reader + + +
    +

    The reader to connect to. This should be a reader +recently returned to the didUpdateDiscoveredReaders: method in the discovery delegate.

    +
    +
    + + connectionConfig + + +
    +

    The connection configuration for options while +connecting to a reader. See SCPInternetConnectionConfiguration for more details.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Attempts to connect to the given Local Mobile reader with a given + connection configuration.

    + +

    To connect to a Local Mobile reader, your app must register that reader to a + Location upon connection. + You should create a SCPLocalMobileConnectionConfiguration +before connecting which specifies the location to which this + reader belongs.

    + +

    Throughout the lifetime of the connection, the reader will communicate + with your app via the SCPLocalMobileReaderDelegate as appropriate.

    + +

    If the connection succeeds, the completion block will be called with the + connected reader, and SCPTerminal.connectionStatus will change to .connected.

    + +

    If the connection fails, the completion block will be called with an error.

    + +

    The SDK must be actively discovering readers in order to connect to one. + The discovery process will stop if this connection request succeeds, otherwise + the SDK will continue discovering.

    + +

    When this method is called, the SDK uses a connection token and the given + reader information to register the reader to your Stripe account. If the SDK + does not already have a connection token, it will call the fetchConnectionToken + method in your SCPConnectionTokenProvider implementation.

    + +

    Note that during connection, an update may occur to ensure that the + local mobile reader has the most up to date software and configurations.

    +
    +

    See

    +

    https://stripe.com/docs/terminal/readers/connecting

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)
+    connectLocalMobileReader:(nonnull SCPReader *)reader
+                    delegate:(nonnull id<SCPLocalMobileReaderDelegate>)delegate
+            connectionConfig:(nonnull SCPLocalMobileConnectionConfiguration *)
+                                 connectionConfig
+                  completion:(nonnull SCPReaderCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func connectLocalMobileReader(_ reader: SCPReader, delegate: LocalMobileReaderDelegate, connectionConfig: SCPLocalMobileConnectionConfiguration) async throws -> SCPReader
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + reader + + +
    +

    The reader to connect to. This should be a reader + recently returned to the didUpdateDiscoveredReaders: method in + the discovery delegate.

    +
    +
    + + delegate + + +
    +

    The delegate used during the lifetime of the connection. + See SCPLocalMobileReaderDelegate.

    +
    +
    + + connectionConfig + + +
    +

    The connection configuration for options while + connecting to a reader. + See SCPLocalMobileConnectionConfiguration for more details.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Retrieves a list of SCPLocation objects belonging to your merchant. You must specify +the ID of one of these locations to register the reader to while connecting to a Bluetooth reader.

    +
    +

    See

    +

    https://stripe.com/docs/terminal/readers/fleet-management#bluetooth-readers

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)listLocations:(nullable SCPListLocationsParameters *)parameters
+           completion:(nonnull SCPLocationsCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func listLocations(parameters: SCPListLocationsParameters?) async throws -> ([SCPLocation], Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + parameters + + +
    +

    The optional parameters to pass to the List all Locations API endpoint. Pass nil to use the default parameters.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Installs the available update for the connected reader.

    + +

    Stripe Terminal reader updates will either be updated automatically upon connection, +or announced as available but not automatically installed. When the Stripe Terminal +SDK announces an optional update, you can present that update to your app’s user +and let them decide when to perform that update. When your user chooses to perform +a reader update, call this method to start the installation.

    + +

    In your app you should display the progress of the update to the user. +You should also instruct the user to wait for the update to complete: +“Do not leave this page, and keep the reader in range and powered on until +the update is complete.” You can set UIApplication.shared.isIdleTimerDisabled +to true while the update is being installed to prevent the device from automatically +locking.

    + +

    If an error occurs while installing the update (e.g. because the update was +interrupted), the SCPBluetoothReaderDelegate will receive +reader:didFinishInstallingUpdate:error: with the error. If the update +completed successfully, the same method will be called with nil error.

    + +

    You must implement the ability to update your reader’s software in your app. +Though we expect required software updates to be very rare, by using Stripe +Terminal, you are obligated to include this functionality.

    +
    +

    Note

    +

    It is an error to call this method when the SDK is connected to the Verifone +P400 or WisePOS E readers.

    + +
    +

    See

    +

    https://stripe.com/docs/terminal/readers/bbpos-chipper2xbt#updating-reader-software

    + +
    +

    See

    +

    https://stripe.com/docs/terminal/readers/bbpos-wisepad3#updating-reader-software

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)installAvailableUpdate;
    + +
    +
    +

    Swift

    + 
    func installAvailableUpdate()
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -disconnectReader: + +
    +
    +
    +
    +
    +
    +

    Attempts to disconnect from the currently connected reader.

    + +

    If the disconnect succeeds, the completion block is called with nil. If the +disconnect fails, the completion block is called with an error.

    +
    +

    See

    +

    https://stripe.com/docs/terminal/readers/connecting

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)disconnectReader:(nonnull SCPErrorCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func disconnectReader() async throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Taking payments +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Creates a new SCPPaymentIntent with the given parameters.

    + +

    Note: If the information required to create a PaymentIntent isn’t readily +available in your app, you can create the PaymentIntent on your server and use +the retrievePaymentIntent method to retrieve the PaymentIntent in your app.

    +
    - - note: This cannot be used with the Verifone P400. If used with the
+Verifone P400, the completion handler will be called with
+an SCPErrorFeatureNotAvailableWithConnectedReader error.
+
    +
    +

    See

    +

    https://stripe.com/docs/terminal/payments#create

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)createPaymentIntent:(nonnull SCPPaymentIntentParameters *)parameters
+                 completion:(nonnull SCPPaymentIntentCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func createPaymentIntent(_ parameters: PaymentIntentParameters) async throws -> PaymentIntent
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + parameters + + +
    +

    The parameters for the PaymentIntent to be created.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Retrieves a SCPPaymentIntent with a client secret.

    + +

    If the information required to create a PaymentIntent isn’t readily available +in your app, you can create the PaymentIntent on your server and use this +method to retrieve the PaymentIntent in your app.

    +
    +

    See

    +

    https://stripe.com/docs/terminal/payments#create

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)retrievePaymentIntent:(nonnull NSString *)clientSecret
+                   completion:
+                       (nonnull SCPPaymentIntentCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func retrievePaymentIntent(clientSecret: String) async throws -> PaymentIntent
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + clientSecret + + +
    +

    The client secret of the PaymentIntent to be retrieved.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Collects a payment method for the given SCPPaymentIntent.

    + +

    Note: collectPaymentMethod does not apply any changes to the PaymentIntent +API object. Updates to the PaymentIntent are local to the SDK, and persisted +in-memory.

    + +

    If collecting a payment method fails, the completion block will be called with +an error. After resolving the error, you may call collectPaymentMethod again +to either try the same card again, or try a different card.

    + +

    If collecting a payment method succeeds, the completion block will be called +with a PaymentIntent with status .requiresConfirmation, indicating that you +should call processPayment:completion: to finish the payment.

    + +

    Note that if collectPaymentMethod is canceled, the completion block will be +called with a Canceled error.

    +
    +

    See

    +

    https://stripe.com/docs/terminal/payments#collect

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable SCPCancelable *)
+    collectPaymentMethod:(nonnull SCPPaymentIntent *)paymentIntent
+              completion:(nonnull SCPPaymentIntentCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func collectPaymentMethod(_ paymentIntent: PaymentIntent, completion: @escaping PaymentIntentCompletionBlock) -> SCPCancelable?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + paymentIntent + + +
    +

    The PaymentIntent to collect a payment method for.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Collects a payment method for the given PaymentIntent, with the specified configuration.

    + +

    Note: collectPaymentMethod does not apply any changes to the PaymentIntent +API object. Updates to the PaymentIntent are local to the SDK, and persisted +in-memory.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable SCPCancelable *)
+    collectPaymentMethod:(nonnull SCPPaymentIntent *)paymentIntent
+           collectConfig:(nullable SCPCollectConfiguration *)collectConfig
+              completion:(nonnull SCPPaymentIntentCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func collectPaymentMethod(_ paymentIntent: PaymentIntent, collectConfig: CollectConfiguration?, completion: @escaping PaymentIntentCompletionBlock) -> SCPCancelable?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + paymentIntent + + +
    +

    The PaymentIntent to collect a payment method for.

    +
    +
    + + collectConfig + + +
    +

    The CollectConfiguration object that contains settings for this call.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Processes a payment after collecting a payment method succeeds.

    +

    Synchronous capture

    + +

    Stripe Terminal uses two-step card payments to prevent unintended and duplicate +payments. When processPayment completes successfully, a charge has been +authorized on the customer’s card, but not yet been “captured”. Your app must +synchronously notify your backend to capture the PaymentIntent +in order to settle the funds to your account.

    +

    Handling failures

    + +

    When processPayment fails, the SDK returns an error that includes the +updated SCPPaymentIntent. Your app should inspect the updated PaymentIntent +to decide how to retry the payment.

    + +
      +

    1. If the updated PaymentIntent is nil, the request to Stripe’s servers timed +out and the PaymentIntent’s status is unknown. We recommend that you retry +processPayment with the original PaymentIntent. If you instead choose to +abandon the original PaymentIntent and create a new one, do not capture +the original PaymentIntent. If you do, you might charge your customer twice.

      2. +

    2. If the updated PaymentIntent’s status is still .requiresConfirmation (e.g., +the request failed because your app is not connected to the internet), you +can call processPayment again with the updated PaymentIntent to retry +the request.

      3. +

    3. If the updated PaymentIntent’s status changes to .requiresPaymentMethod (e.g., the +request failed because the card was declined), call collectPaymentMethod with the +updated PaymentIntent to try charging another card.

      4. +
    +
    +

    See

    +

    https://stripe.com/docs/terminal/payments#process

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)processPayment:(nonnull SCPPaymentIntent *)paymentIntent
+            completion:(nonnull SCPProcessPaymentCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func processPayment(_ paymentIntent: PaymentIntent) async -> (PaymentIntent?, SCPProcessPaymentError?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + paymentIntent + + +
    +

    The PaymentIntent to confirm.

    +
    +
    + + completion + + +
    +

    The completion block called when the confirm completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Cancels an SCPPaymentIntent.

    + +

    If the cancel request succeeds, the completion block will be called with the +updated PaymentIntent object with status Canceled. If the cancel request +fails, the completion block will be called with an error.

    +
    +

    Note

    +

    This cannot be used with the Verifone P400 reader. If used with the +Verifone P400, the completion handler will be called with +an SCPErrorFeatureNotAvailableWithConnectedReader error.

    + +
    +

    See

    +

    https://stripe.com/docs/terminal/payments/refunds

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)cancelPaymentIntent:(nonnull SCPPaymentIntent *)paymentIntent
+                 completion:(nonnull SCPPaymentIntentCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func cancelPaymentIntent(_ paymentIntent: PaymentIntent) async throws -> PaymentIntent
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + paymentIntent + + +
    +

    The PaymentIntent to cancel.

    +
    +
    + + completion + + +
    +

    The completion block called when the cancel completes.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Saving payment details for later use +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Reads a card with the given parameters and returns a PaymentMethod.

    + +

    NOTE: Most integrations should not use readReusableCard.

    + +

    You should create a SCPPaymentIntent and use the associated collectPaymentMethod +and processPayment methods if you are simply collecting a payment from +a customer.

    + +

    You can use readReusableCard to read payment details and defer payment for later. +The PaymentMethod created by this method will have type card, suitable for +use with online payments.

    + +

    Note that if you use this method to defer a payment, the transaction will +not receive the beneficial rates and liability shift associated with card +present transactions.

    + +

    If reading a card fails, the completion block will be called with an error +containing details about the failure. If reading a card succeeds, the +completion block will be called with a PaymentMethod. You should send +the ID of the payment method to your backend for further processing. For example, +you can use the fingerprint to look up charges created using the same +card.

    +
    +

    Note

    +

    This functionality is only available in the US, with either a +Chipper 2X BT or Verifone P400 reader.

    + +
    +

    See

    +

    https://stripe.com/docs/terminal/online-payments

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable SCPCancelable *)
+    readReusableCard:(nonnull SCPReadReusableCardParameters *)parameters
+          completion:(nonnull SCPPaymentMethodCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func readReusableCard(_ parameters: SCPReadReusableCardParameters, completion: @escaping PaymentMethodCompletionBlock) -> SCPCancelable?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + parameters + + +
    +

    The parameters for reading the card.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a new SCPSetupIntent with the given parameters.

    +
    +

    See

    +

    https://stripe.com/docs/api/setup_intents/create

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)createSetupIntent:(nonnull SCPSetupIntentParameters *)setupIntentParams
+               completion:(nonnull SCPSetupIntentCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func createSetupIntent(_ setupIntentParams: SCPSetupIntentParameters) async throws -> SCPSetupIntent
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + setupIntentParams + + +
    +

    The parameters that control the creation of the SetupIntent.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Retrieves an SCPSetupIntent with a client secret.

    + +

    If you’ve created a SetupIntent on your backend, you must retrieve it in the +Stripe Terminal SDK before calling collectSetupIntentPaymentMethod.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)retrieveSetupIntent:(nonnull NSString *)clientSecret
+                 completion:(nonnull SCPSetupIntentCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func retrieveSetupIntent(clientSecret: String) async throws -> SCPSetupIntent
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + clientSecret + + +
    +

    The client secret of the SetupIntent to be retrieved.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Cancels an SCPPaymentIntent.

    + +

    If the cancel request succeeds, the completion block will be called with the +updated PaymentIntent object with status Canceled. If the cancel request +fails, the completion block will be called with an error.

    +
    +

    See

    +

    https://stripe.com/docs/api/setup_intents/cancel

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)cancelSetupIntent:(nonnull SCPSetupIntent *)intent
+               completion:(nonnull SCPSetupIntentCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func cancelSetupIntent(_ intent: SCPSetupIntent) async throws -> SCPSetupIntent
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + intent + + +
    +

    The SetupIntent to cancel.

    +
    +
    + + completion + + +
    +

    The completion block called when cancellation completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Collects a payment method for the given SCPSetupIntent.

    + +

    This method does not update the SetupIntent API object. All updates are local +to the SDK and only persisted in memory. You must confirm the SetupIntent to +create a PaymentMethod API object and (optionally) attach that PaymentMethod +to a customer.

    + +

    If collecting a payment method fails, the completion block will be called with +an error. After resolving the error, you may call collectSetupIntentPaymentMethod +again to either try the same card again, or try a different card.

    + +

    If collecting a payment method succeeds, the completion block will be called +with a SetupIntent with status .requiresConfirmation, indicating that you +should call confirmSetupIntent:customerConsentCollected:completion: to +finish the payment.

    + +

    Note that if collectSetupIntentPaymentMethod is canceled, the completion +block will be called with a Canceled error.

    + + +

    Card networks require that you collect consent from the customer before saving +and reusing their card information. The SetupIntent confirmation API method +normally takes a mandate_data hash that lets you specify details about the +customer’s consent. The Stripe Terminal SDK will fill in the mandate_data +hash with relevant information, but in order for it to do so, you must specify +whether you have gathered consent from the cardholder to collect their payment +information in this method’s second parameter.

    + +

    The payment method will not be collected without the cardholder’s consent.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable SCPCancelable *)
+    collectSetupIntentPaymentMethod:(nonnull SCPSetupIntent *)setupIntent
+           customerConsentCollected:(BOOL)customerConsentCollected
+                         completion:
+                             (nonnull SCPSetupIntentCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func collectSetupIntentPaymentMethod(_ setupIntent: SCPSetupIntent, customerConsentCollected: Bool, completion: @escaping SetupIntentCompletionBlock) -> SCPCancelable?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + setupIntent + + +
    +

    The SetupIntent to which payment method information is attached.

    +
    +
    + + customerConsentCollected + + +
    +

    A boolean that should be set to true if you +have successfully collected consent from the cardholder to save their payment information.

    +
    +
    + + completion + + +
    +

    The completion block called when collection completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Confirms a SetupIntent after the payment method has been successfully collected.

    +

    Handling failures

    + +

    When confirmSetupIntent fails, the SDK returns an error that includes the +updated SCPSetupIntent. Your app should inspect the updated SetupIntent +to decide how to proceed.

    + +
      +

    1. If the updated SetupIntent is nil, the request to Stripe’s servers timed +out and the SetupIntent’s status is unknown. We recommend that you retry +confirmSetupIntent with the original SetupIntent.

      2. +

    2. If the updated SetupIntent’s status is still .requiresConfirmation (e.g., +the request failed because your app is not connected to the internet), you +can call confirmSetupIntent again with the updated SetupIntent to retry +the request.

      3. +

    3. If the updated SetupIntent’s status is .requiresAction, there might be +authentication the cardholder must perform offline before the saved +PaymentMethod can be used.

      4. +
    +
    +

    See

    +

    https://stripe.com/docs/api/setup_intents/confirm

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)confirmSetupIntent:(nonnull SCPSetupIntent *)setupIntent
+                completion:
+                    (nonnull SCPConfirmSetupIntentCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func confirmSetupIntent(_ setupIntent: SCPSetupIntent) async -> (SCPSetupIntent?, SCPConfirmSetupIntentError?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + setupIntent + + +
    +

    The SetupIntent to confirm

    +
    +
    + + completion + + +
    +

    The completion block called when the confirmation completes

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Card-present refunds +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Initiates an in-person refund with a given set of SCPRefundParameters by +collecting the payment method that is to be refunded.

    + +

    Some payment methods, like Interac Debit payments, require that in-person payments +also be refunded while the cardholder is present. The cardholder must present +the Interac card to the card reader; these payments cannot be refunded via the +dashboard or the API.

    + +

    For payment methods that don’t require the cardholder be present, see +https://stripe.com/docs/terminal/payments/refunds

    + +

    This method, along with processRefund, allow you to design an in-person refund +flow into your app.

    + +

    If collecting a payment method fails, the completion block will be called with +an error. After resolving the error, you may call collectRefundPaymentMethod +again to either try the same card again, or try a different card.

    + +

    If collecting a payment method succeeds, the completion block will be called +with an nil error. At that point, you can call processRefund to finish +refunding the payment method.

    + +

    Calling any other SDK methods between collectRefundPaymentMethod and +processRefund will result in undefined behavior.

    + +

    Note that if collectRefundPaymentMethod is canceled, the completion block +will be called with a Canceled error.

    +
    +

    See

    +

    https://stripe.com/docs/terminal/canada#interac-refunds

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable SCPCancelable *)
+    collectRefundPaymentMethod:(nonnull SCPRefundParameters *)refundParams
+                    completion:(nonnull SCPErrorCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func collectRefundPaymentMethod(_ refundParams: RefundParameters, completion: @escaping ErrorCompletionBlock) -> SCPCancelable?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + refundParams + + +
    +

    The SCPRefundParameters object that describes how the +refund will be created.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + -processRefund: + +
    +
    +
    +
    +
    +
    +

    Processes an in-person refund after the refund payment method has been collected.

    + +

    The completion block will either be called with the successful SCPRefund or +with an SCPProcessRefundError.

    + +

    When processRefund fails, the SDK returns an error that either includes the +failed SCPRefund or the SCPRefundParameters that led to a failure. +Your app should inspect the SCPProcessRefundError to decide how to proceed.

    + +
      +

    1. If the refund property is nil, the request to Stripe’s servers timed +out and the refund’s status is unknown. We recommend that you retry +processRefund with the original SCPRefundParameters.

      2. +

    2. If the SCPProcessRefundError has a failure_reason, the refund was declined. +We recommend that you take action based on the decline code you received.

      3. +
    +
    +

    Note

    +

    collectRefundPaymentMethod:completion and processRefund are only +available for payment methods that require in-person refunds. For all other +refunds, use the Stripe Dashboard or the Stripe API.

    + +
    +

    See

    +

    https://stripe.com/docs/terminal/canada#interac-refunds

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)processRefund:(nonnull SCPProcessRefundCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func processRefund() async -> (SCPRefund?, SCPProcessRefundError?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Displaying information to customers +

+
+
+
    +
  • +
    + + + + -clearReaderDisplay: + +
    +
    +
    +
    +
    +
    +

    Clears the reader display and resets it to the splash screen.

    +
    +

    Note

    +

    Only available for the Verifone P400 and BBPOS WisePOS E.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)clearReaderDisplay:(nonnull SCPErrorCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func clearReaderDisplay() async throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updates the reader display with cart information. +This method is for display purposes only and has no correlation with what the customer is +actually charged. Tax and total are also not automatically calculated and must be set in SCPCart.

    +
    +

    Note

    +

    Only available for the Verifone P400 and BBPOS WisePOS E.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)setReaderDisplay:(nonnull SCPCart *)cart
+              completion:(nonnull SCPErrorCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func setReaderDisplay(_ cart: Cart) async throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + cart + + +
    +

    The cart containing the information that will be displayed.

    +
    +
    + + completion + + +
    +

    The completion block called when the command completes.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns an unlocalized string for the given reader input options, e.g. +“Swipe / Insert”

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSString *)stringFromReaderInputOptions:
+    (SCPReaderInputOptions)options;
    + +
    +
    +

    Swift

    + 
    class func stringFromReaderInputOptions(_ options: ReaderInputOptions = []) -> String
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns an unlocalized string for the given reader display message, e.g. +“Retry Card”

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSString *)stringFromReaderDisplayMessage:
+    (SCPReaderDisplayMessage)message;
    + +
    +
    +

    Swift

    + 
    class func stringFromReaderDisplayMessage(_ message: ReaderDisplayMessage) -> String
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns an unlocalized string for the given reader event, e.g. +“Card Inserted”

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSString *)stringFromReaderEvent:(SCPReaderEvent)event;
    + +
    +
    +

    Swift

    + 
    class func stringFromReaderEvent(_ event: ReaderEvent) -> String
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns an unlocalized string for the given connection status, e.g. +“Connecting”

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSString *)stringFromConnectionStatus:(SCPConnectionStatus)status;
    + +
    +
    +

    Swift

    + 
    class func stringFromConnectionStatus(_ status: ConnectionStatus) -> String
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns an unlocalized string for the given payment status, e.g. +“Not Ready”

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSString *)stringFromPaymentStatus:(SCPPaymentStatus)status;
    + +
    +
    +

    Swift

    + 
    class func stringFromPaymentStatus(_ status: PaymentStatus) -> String
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns an unlocalized string for the given device type.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSString *)stringFromDeviceType:(SCPDeviceType)deviceType;
    + +
    +
    +

    Swift

    + 
    class func stringFromDeviceType(_ deviceType: DeviceType) -> String
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns an unlocalized string for the given discovery method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSString *)stringFromDiscoveryMethod:(SCPDiscoveryMethod)method;
    + +
    +
    +

    Swift

    + 
    class func stringFromDiscoveryMethod(_ method: DiscoveryMethod) -> String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +stringFromCardBrand: + +
    +
    +
    +
    +
    +
    +

    Returns an unlocalized string for the given card brand.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSString *)stringFromCardBrand:(SCPCardBrand)cardBrand;
    + +
    +
    +

    Swift

    + 
    class func stringFromCardBrand(_ cardBrand: CardBrand) -> String
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns an unlocalized string for the given payment intent status.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSString *)stringFromPaymentIntentStatus:
+    (SCPPaymentIntentStatus)paymentIntentStatus;
    + +
    +
    +

    Swift

    + 
    class func stringFromPaymentIntentStatus(_ paymentIntentStatus: PaymentIntentStatus) -> String
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Returns an unlocalized string for the given capture method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSString *)stringFromCaptureMethod:(SCPCaptureMethod)captureMethod;
    + +
    +
    +

    Swift

    + 
    class func stringFromCaptureMethod(_ captureMethod: CaptureMethod) -> String
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithConfiguration:tokenProvider:delegate:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithConfiguration:tokenProvider:delegate:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTip.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTip.html new file mode 100644 index 00000000..ffc2ce76 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTip.html @@ -0,0 +1,547 @@ + + + + SCPTip Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPTip Class Reference +

+ +
+ +
+ +
+
+

SCPTip

+
+
+

Objective-C

+ 
@interface SCPTip : NSObject <SCPJSONDecodable, NSCopying>
+ +
+
+

Swift

+ 
class SCPTip : NSObject, JSONDecodable, NSCopying
+ +
+
+

Contains details about tips

+ +

For more information, see the official Stripe docs: Collect on-reader tips

+ +
+
+ +
+
+
+
    +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    Portion of the amount that corresponds to a tip

    + +

    The value will be null in the following scenarios:

    + +
      +
    • tipping is skipped by using the CollectConfiguration.skipTipping flag or by setting +TippingConfiguration.eligibleAmount to 0
      • +
    • current reader location does not have a tipping config set
      • +
    + +

    If “No tip” is selected on the reader, the value will be 0

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSNumber *amount;
    + +
    +
    +

    Swift

    + 
    var amount: NSNumber? { get }
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate SCPTip.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    You cannot directly instantiate SCPTip.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTippingConfiguration.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTippingConfiguration.html new file mode 100644 index 00000000..09b1b1ac --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTippingConfiguration.html @@ -0,0 +1,587 @@ + + + + SCPTippingConfiguration Class Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPTippingConfiguration Class Reference +

+ +
+ +
+ +
+
+

SCPTippingConfiguration

+
+
+

Objective-C

+ 

+@interface SCPTippingConfiguration : NSObject <NSCopying>
+ +
+
+

Swift

+ 
class TippingConfiguration : NSObject, NSCopying
+ +
+
+

The TippingConfiguration contains configuration information relevant to collecting tips.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + eligibleAmount + +
    +
    +
    +
    +
    +
    +

    The amount of the payment total eligible for tips.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic) NSInteger eligibleAmount;
    + +
    +
    +

    Swift

    + 
    var eligibleAmount: Int { get set }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize a TippingConfiguration instance.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithEligibleAmount:(NSInteger)eligibleAmount;
    + +
    +
    +

    Swift

    + 
    init(eligibleAmount: Int)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + eligibleAmount + + +
    +

    Amount eligible for tips.

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + -init + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithEligibleAmount:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)init;
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + +new + +
    +
    +
    +
    +
    +
    +

    Unavailable

    + +
    +
    +

    Use initWithEligibleAmount:

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)new;
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPBatteryStatus.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPBatteryStatus.html new file mode 100644 index 00000000..ebcce066 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPBatteryStatus.html @@ -0,0 +1,569 @@ + + + + SCPBatteryStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPBatteryStatus Enumeration Reference +

+ +
+ +
+ +
+
+

SCPBatteryStatus

+
+
+

Objective-C

+ 
enum SCPBatteryStatus : NSUInteger {}
+ +
+
+

Swift

+ 
enum BatteryStatus : UInt, @unchecked Sendable
+ +
+
+

A categorization of a reader’s battery charge level.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Battery state is not yet known or not available for the connected reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPBatteryStatusUnknown
    + +
    +
    +

    Swift

    + 
    case unknown = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The device’s battery is less than or equal to 5%.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPBatteryStatusCritical
    + +
    +
    +

    Swift

    + 
    case critical = 1
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPBatteryStatusLow + +
    +
    +
    +
    +
    +
    +

    The device’s battery is between 5% and 20%.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPBatteryStatusLow
    + +
    +
    +

    Swift

    + 
    case low = 2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The device’s battery is greater than 20%.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPBatteryStatusNominal
    + +
    +
    +

    Swift

    + 
    case nominal = 3
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCaptureMethod.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCaptureMethod.html new file mode 100644 index 00000000..8ac8c405 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCaptureMethod.html @@ -0,0 +1,512 @@ + + + + SCPCaptureMethod Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCaptureMethod Enumeration Reference +

+ +
+ +
+ +
+
+

SCPCaptureMethod

+
+
+

Objective-C

+ 
enum SCPCaptureMethod : NSUInteger {}
+ +
+
+

Swift

+ 
enum CaptureMethod : UInt, @unchecked Sendable
+ +
+
+

@abstract Controls when the funds will be captured from the customer’s account.

+
+

See

+ https://stripe.com/docs/terminal/payments/collect-payment?terminal-sdk-platform=ios#capture-payment + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Place a hold on the funds when the customer authorizes the payment, but don’t + capture the funds until later. Will require an explicit call to capture payments. + (Not all payment methods support this.)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCaptureMethodManual
    + +
    +
    +

    Swift

    + 
    case manual = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Stripe automatically captures funds when the customer authorizes the payment.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCaptureMethodAutomatic
    + +
    +
    +

    Swift

    + 
    case automatic = 1
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardBrand.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardBrand.html new file mode 100644 index 00000000..d408676b --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardBrand.html @@ -0,0 +1,766 @@ + + + + SCPCardBrand Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCardBrand Enumeration Reference +

+ +
+ +
+ +
+
+

SCPCardBrand

+
+
+

Objective-C

+ 
enum SCPCardBrand : NSInteger {}
+ +
+
+

Swift

+ 
enum CardBrand : Int, @unchecked Sendable
+ +
+
+

The various card brands for a card.

+
+

See

+ https://stripe.com/docs/api/cards/object#card_object-brand + +
+ +
+
+ +
+
+
+
    +
  • +
    + + + + SCPCardBrandVisa + +
    +
    +
    +
    +
    +
    +

    Visa card

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardBrandVisa
    + +
    +
    +

    Swift

    + 
    case visa = 0
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPCardBrandAmex + +
    +
    +
    +
    +
    +
    +

    American Express card

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardBrandAmex
    + +
    +
    +

    Swift

    + 
    case amex = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    MasterCard card

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardBrandMasterCard
    + +
    +
    +

    Swift

    + 
    case masterCard = 2
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPCardBrandDiscover + +
    +
    +
    +
    +
    +
    +

    Discover card

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardBrandDiscover
    + +
    +
    +

    Swift

    + 
    case discover = 3
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPCardBrandJCB + +
    +
    +
    +
    +
    +
    +

    JCB card

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardBrandJCB
    + +
    +
    +

    Swift

    + 
    case JCB = 4
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Diners Club card

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardBrandDinersClub
    + +
    +
    +

    Swift

    + 
    case dinersClub = 5
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPCardBrandInterac + +
    +
    +
    +
    +
    +
    +

    Interac card

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardBrandInterac
    + +
    +
    +

    Swift

    + 
    case interac = 6
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPCardBrandUnionPay + +
    +
    +
    +
    +
    +
    +

    Union Pay card

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardBrandUnionPay
    + +
    +
    +

    Swift

    + 
    case unionPay = 7
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPCardBrandEftposAu + +
    +
    +
    +
    +
    +
    +

    Eftpos Australia card

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardBrandEftposAu
    + +
    +
    +

    Swift

    + 
    case eftposAu = 8
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPCardBrandUnknown + +
    +
    +
    +
    +
    +
    +

    An unknown card brand

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardBrandUnknown
    + +
    +
    +

    Swift

    + 
    case unknown = 9
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardFundingType.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardFundingType.html new file mode 100644 index 00000000..694be8cc --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardFundingType.html @@ -0,0 +1,574 @@ + + + + SCPCardFundingType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCardFundingType Enumeration Reference +

+ +
+ +
+ +
+
+

SCPCardFundingType

+
+
+

Objective-C

+ 
enum SCPCardFundingType : NSInteger {}
+ +
+
+

Swift

+ 
enum CardFundingType : Int, @unchecked Sendable
+ +
+
+

The various funding sources for a card.

+
+

See

+ https://stripe.com/docs/api/cards/object#card_object-funding + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Debit

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardFundingTypeDebit
    + +
    +
    +

    Swift

    + 
    case debit = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Credit

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardFundingTypeCredit
    + +
    +
    +

    Swift

    + 
    case credit = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Prepaid

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardFundingTypePrepaid
    + +
    +
    +

    Swift

    + 
    case prepaid = 2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    An other or unknown type of funding source

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardFundingTypeOther
    + +
    +
    +

    Swift

    + 
    case other = 3
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardPresentCaptureMethod.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardPresentCaptureMethod.html new file mode 100644 index 00000000..a62f6068 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardPresentCaptureMethod.html @@ -0,0 +1,474 @@ + + + + SCPCardPresentCaptureMethod Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCardPresentCaptureMethod Enumeration Reference +

+ +
+ +
+ +
+
+

SCPCardPresentCaptureMethod

+
+
+

Objective-C

+ 
enum SCPCardPresentCaptureMethod : NSUInteger {}
+ +
+
+

Swift

+ 
enum CardPresentCaptureMethod : UInt, @unchecked Sendable
+ +
+
+

Capture Method values that can be used as card-present payment method options.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Use manual_preferred if you prefer manual capture_method for the SCPPaymentIntent’s capture_method but support +falling back to automatic based on the presented payment method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardPresentCaptureMethodManualPreferred
    + +
    +
    +

    Swift

    + 
    case manualPreferred = 0
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardPresentRouting.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardPresentRouting.html new file mode 100644 index 00000000..0b7e2508 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardPresentRouting.html @@ -0,0 +1,505 @@ + + + + SCPCardPresentRouting Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPCardPresentRouting Enumeration Reference +

+ +
+ +
+ +
+
+

SCPCardPresentRouting

+
+
+

Objective-C

+ 
enum SCPCardPresentRouting : NSUInteger {}
+ +
+
+

Swift

+ 
enum CardPresentRouting : UInt, @unchecked Sendable
+ +
+
+

Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Prioritize domestic debit network routing on payment method collection.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardPresentRoutingDomestic
    + +
    +
    +

    Swift

    + 
    case domestic = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Prioritize international network routing on payment method collection.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPCardPresentRoutingInternational
    + +
    +
    +

    Swift

    + 
    case international = 1
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPChargeStatus.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPChargeStatus.html new file mode 100644 index 00000000..5143797b --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPChargeStatus.html @@ -0,0 +1,537 @@ + + + + SCPChargeStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPChargeStatus Enumeration Reference +

+ +
+ +
+ +
+
+

SCPChargeStatus

+
+
+

Objective-C

+ 
enum SCPChargeStatus : NSUInteger {}
+ +
+
+

Swift

+ 
enum ChargeStatus : UInt, @unchecked Sendable
+ +
+
+

The possible statuses for a charge

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The charge succeeded.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPChargeStatusSucceeded
    + +
    +
    +

    Swift

    + 
    case succeeded = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The charge succeeded.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPChargeStatusPending
    + +
    +
    +

    Swift

    + 
    case pending = 1
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPChargeStatusFailed + +
    +
    +
    +
    +
    +
    +

    The charge failed.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPChargeStatusFailed
    + +
    +
    +

    Swift

    + 
    case failed = 2
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPConnectionStatus.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPConnectionStatus.html new file mode 100644 index 00000000..f23fe5d3 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPConnectionStatus.html @@ -0,0 +1,542 @@ + + + + SCPConnectionStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPConnectionStatus Enumeration Reference +

+ +
+ +
+ +
+
+

SCPConnectionStatus

+
+
+

Objective-C

+ 
enum SCPConnectionStatus : NSUInteger {}
+ +
+
+

Swift

+ 
enum ConnectionStatus : UInt, @unchecked Sendable
+ +
+
+

The possible reader connection statuses for the SDK.

+
+

See

+ https://stripe.com/docs/terminal/readers/connecting + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The SDK is not connected to a reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPConnectionStatusNotConnected
    + +
    +
    +

    Swift

    + 
    case notConnected = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SDK is connected to a reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPConnectionStatusConnected
    + +
    +
    +

    Swift

    + 
    case connected = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SDK is currently connecting to a reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPConnectionStatusConnecting
    + +
    +
    +

    Swift

    + 
    case connecting = 2
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPDeviceType.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPDeviceType.html new file mode 100644 index 00000000..4471c9e1 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPDeviceType.html @@ -0,0 +1,764 @@ + + + + SCPDeviceType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPDeviceType Enumeration Reference +

+ +
+ +
+ +
+
+

SCPDeviceType

+
+
+

Objective-C

+ 
enum SCPDeviceType : NSUInteger {}
+ +
+
+

Swift

+ 
enum DeviceType : UInt, @unchecked Sendable
+ +
+
+

The possible device types for a reader.

+
+

See

+ https://stripe.com/docs/terminal/readers + +
+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPDiscoveryMethod.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPDiscoveryMethod.html new file mode 100644 index 00000000..087b7f7e --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPDiscoveryMethod.html @@ -0,0 +1,635 @@ + + + + SCPDiscoveryMethod Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPDiscoveryMethod Enumeration Reference +

+ +
+ +
+ +
+
+

SCPDiscoveryMethod

+
+
+

Objective-C

+ 
enum SCPDiscoveryMethod : NSUInteger {}
+ +
+
+

Swift

+ 
enum DiscoveryMethod : UInt, @unchecked Sendable
+ +
+
+

The possible methods for discovering a reader. Pass a variant of this enum +into your SCPDiscoveryConfiguration.

+
+

See

+ https://stripe.com/docs/terminal/readers/connecting + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The Bluetooth Scan discovery method searches for Stripe Terminal’s +Bluetooth-capable readers.

    + +

    When discovering a reader using this method, the didUpdateDiscoveredReaders +delegate method will be called multiple times as the Bluetooth scan +proceeds.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPDiscoveryMethodBluetoothScan
    + +
    +
    +

    Swift

    + 
    case bluetoothScan = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The Bluetooth Proximity discovery method searches for a subset of +Stripe Terminal’s Bluetooth-capable readers.

    + +

    If your app will be used in a busy environment with multiple iOS +devices pairing to multiple available readers at the same time, we +recommend using this discovery method.

    + +

    After a reader has been discovered using this method, the LEDs located +above the reader’s power button will start flashing multiple colors. +After discovering the reader, your app should prompt the user to confirm +that the reader is flashing, and require a user action (e.g. tapping a +button) to connect to the reader.

    + +

    When discovering a reader using this method, the didUpdateDiscoveredReaders +delegate method will be called twice. It will be called for the first time +when the reader is initially discovered. The reader’s LEDs will begin +flashing. After a short delay, didUpdateDiscoveredReaders will be called +a second time with an updated reader object, populated with additional +info about the device, like its battery level.

    +
    +

    Note

    +

    The Bluetooth Proximity discovery method can only discover +Stripe Reader M2 and BBPOS Chipper 2X BT readers.

    + +
    +

    Note

    +

    The simulated Bluetooth Proximity discovery method will always return +a Stripe Reader M2 simulated device.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPDiscoveryMethodBluetoothProximity
    + +
    +
    +

    Swift

    + 
    case bluetoothProximity = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The Internet discovery method searches for internet-connected readers, +such as the Verifone P400 or the BBPOS WisePOS E.

    + +

    When discovering a reader with this method didUpdateDiscoveredReaders +will only be called once with a list of readers from /v1/terminal/readers. +Note that this will include readers that are both online and offline.

    + +

    Because the discovery process continues if connecting to a discovered +reader fails, the SDK will refresh the list of SCPReaders and call +didUpdateDiscoveredReaders with the results. For more details about failed +connect calls, see -[SCPTerminal connectReader:connectionConfig:completion:]

    +
    +

    See

    + https://stripe.com/docs/api/terminal/readers/list + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPDiscoveryMethodInternet
    + +
    +
    +

    Swift

    + 
    case internet = 2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The Local Mobile discovery method searches for any readers built into the +merchant device that are supported by Stripe Terminal. +When discovering a reader with this method didUpdateDiscoveredReaders +will only be called once with a list of discovered readers, if any. +An error may be provided if a discovery attempt is made in an +on a device without hardware support for the Apple Built-In reader or +one running an unsupported version of iOS.

    +
    +

    See

    + https://stripe.com/docs/terminal/payments/setup-reader/tap-on-mobile-ios + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPDiscoveryMethodLocalMobile
    + +
    +
    +

    Swift

    + 
    case localMobile = 3
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPError.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPError.html new file mode 100644 index 00000000..d578f6cb --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPError.html @@ -0,0 +1,3317 @@ + + + + SCPError Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPError Enumeration Reference +

+ +
+ +
+ +
+
+

SCPError

+
+
+

Objective-C

+ 
enum SCPError : NSInteger {}
+ +
+
+

Swift

+ 
typealias ErrorCode.Code._ErrorType = ErrorCode
+ +
+
+

Possible error codes for NSError objects under the SCPErrorDomain domain.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + SCPErrorBusy + +
    +
    +
    +
    +
    +
    +

    The SDK is busy executing another command. The SDK can only execute a +single command at a time. You can use the paymentStatus or +connectionStatus properties on your SCPTerminal instance (or the +corresponding delegate methods) to determine if the SDK is ready to accept +another command.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBusy = 1000
    + +
    +
    +

    Swift

    + 
    case busy = 1000
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Canceling a command failed because the command already completed.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorCancelFailedAlreadyCompleted = 1010
    + +
    +
    +

    Swift

    + 
    case cancelFailedAlreadyCompleted = 1010
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    No reader is connected. Connect to a reader before trying again.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorNotConnectedToReader = 1100
    + +
    +
    +

    Swift

    + 
    case notConnectedToReader = 1100
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Already connected to a reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorAlreadyConnectedToReader = 1110
    + +
    +
    +

    Swift

    + 
    case alreadyConnectedToReader = 1110
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Your implementation of fetchConnectionToken called the completion block +with (nil, nil). Please make sure your integration completes with either +a connection token or an error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorConnectionTokenProviderCompletedWithNothing = 1510
    + +
    +
    +

    Swift

    + 
    case connectionTokenProviderCompletedWithNothing = 1510
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    processPayment was called with an unknown or invalid PaymentIntent. +You must process a payment immediately after collecting a payment method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorProcessInvalidPaymentIntent = 1530
    + +
    +
    +

    Swift

    + 
    case processInvalidPaymentIntent = 1530
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    collectPaymentMethod or processPayment was called with a nil PaymentIntent.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorNilPaymentIntent = 1540
    + +
    +
    +

    Swift

    + 
    case nilPaymentIntent = 1540
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    collectSetupIntentPaymentMethod or processSetupIntent was called with +a nil SetupIntent.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorNilSetupIntent = 1542
    + +
    +
    +

    Swift

    + 
    case nilSetupIntent = 1542
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    processRefund was called without calling collectRefundPaymentMethod +beforehand.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorNilRefundPaymentMethod = 1550
    + +
    +
    +

    Swift

    + 
    case nilRefundPaymentMethod = 1550
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The RefundParameters object has invalid values. The Charge ID (ch_123abc) +can be found on the PaymentIntent object, which you should get from +your backend.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorInvalidRefundParameters = 1555
    + +
    +
    +

    Swift

    + 
    case invalidRefundParameters = 1555
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A PaymentIntent or SetupIntent was referenced using an invalid client secret.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorInvalidClientSecret = 1560
    + +
    +
    +

    Swift

    + 
    case invalidClientSecret = 1560
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SDK must be actively Discovering Readers in order to successfully +connect to a reader. See documentation on +-[SCPTerminal discoverReaders:delegate:completion:] +and -[SCPTerminal connectReader:completion:]

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorMustBeDiscoveringToConnect = 1570
    + +
    +
    +

    Swift

    + 
    case mustBeDiscoveringToConnect = 1570
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Before connecting to a reader, it must have already been discovered in the +current discovery session. Trying to connect to a reader from a previous +discovery session is not supported.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorCannotConnectToUndiscoveredReader = 1580
    + +
    +
    +

    Swift

    + 
    case cannotConnectToUndiscoveredReader = 1580
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    discoverReaders was called using an invalid SCPDiscoveryConfiguration. +Your app selected a discovery method that is either incompatible with the +selected device type or attemped to use simulated or locationId with a +reader which does not support simulated or locationId. Currently +chipper2X is the only reader which supports simulated and +verifoneP400 is the only reader which supports use of locationId for +location filtering.

    +
    +

    See

    + SCPDiscoveryConfiguration for valid configurations. + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorInvalidDiscoveryConfiguration = 1590
    + +
    +
    +

    Swift

    + 
    case invalidDiscoveryConfiguration = 1590
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    installUpdate was passed an update that is for a different reader. Updates can only +be installed on the reader that was connected when the update was announced.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorInvalidReaderForUpdate = 1861
    + +
    +
    +

    Swift

    + 
    case invalidReaderForUpdate = 1861
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    -[SCPTerminal connectReader:completion:] was called from an unsupported version +of the SDK. In order to fix this you will need to update your app to the most recent +version of the SDK. We suggest you prompt your user to update their app, +assuming there is an update app version with a supported version of our SDK.

    +
    +

    See

    + https://github.com/stripe/stripe-terminal-ios/releases/latest + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorUnsupportedSDK = 1870
    + +
    +
    +

    Swift

    + 
    case unsupportedSDK = 1870
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This feature is currently not available for the selected reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorFeatureNotAvailableWithConnectedReader = 1880
    + +
    +
    +

    Swift

    + 
    case featureNotAvailableWithConnectedReader = 1880
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This feature is not currently available.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorFeatureNotAvailable = 1890
    + +
    +
    +

    Swift

    + 
    case featureNotAvailable = 1890
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The ListLocationsParameters object has invalid values.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorInvalidListLocationsLimitParameter = 1900
    + +
    +
    +

    Swift

    + 
    case invalidListLocationsLimitParameter = 1900
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The locationId parameter to BluetoothConnectionConfiguration is required but a valid one was not provided.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBluetoothConnectionInvalidLocationIdParameter = 1910
    + +
    +
    +

    Swift

    + 
    case bluetoothConnectionInvalidLocationIdParameter = 1910
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A required parameter was invalid or missing.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorInvalidRequiredParameter = 1920
    + +
    +
    +

    Swift

    + 
    case invalidRequiredParameter = 1920
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    An invalid ConnectionConfiguration was passed through connect.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorReaderConnectionConfigurationInvalid = 1940
    + +
    +
    +

    Swift

    + 
    case readerConnectionConfigurationInvalid = 1940
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    An invalid usage of eligibleAmount or skipTipping was passed into collect.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorReaderTippingParameterInvalid = 1950
    + +
    +
    +

    Swift

    + 
    case readerTippingParameterInvalid = 1950
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The provided location ID parameter was invalid.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorInvalidLocationIdParameter = 1960
    + +
    +
    +

    Swift

    + 
    case invalidLocationIdParameter = 1960
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPErrorCanceled + +
    +
    +
    +
    +
    +
    +

    The command was canceled by your app.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorCanceled = 2020
    + +
    +
    +

    Swift

    + 
    case canceled = 2020
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Access to location services is currently disabled. This may be because:

    + +
      +
    • The user disabled location services in the system settings.
      • +
    • The user denied access to location services for your app.
      • +
    • The user’s device is in Airplane Mode and unable to gather location data.
      • +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorLocationServicesDisabled = 2200
    + +
    +
    +

    Swift

    + 
    case locationServicesDisabled = 2200
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This error indicates that Bluetooth is turned off, and the user should use +Settings to turn Bluetooth on.

    + +

    If Bluetooth is on but the app does not have permission to use it, +a different error (SCPErrorBluetoothError) occurs.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBluetoothDisabled = 2320
    + +
    +
    +

    Swift

    + 
    case bluetoothDisabled = 2320
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Bluetooth is turned on on the device, but access to Bluetooth has been denied +for your app. The user needs to go to Settings > Your App > and enable Bluetooth

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBluetoothAccessDenied = 2321
    + +
    +
    +

    Swift

    + 
    case bluetoothAccessDenied = 2321
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Scanning for bluetooth devices timed out.

    +
    +

    See

    + SCPDiscoveryConfiguration.timeout + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBluetoothScanTimedOut = 2330
    + +
    +
    +

    Swift

    + 
    case bluetoothScanTimedOut = 2330
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Bluetooth Low Energy is unsupported on this iOS device. Use a different +iOS device that supports BLE (also known as Bluetooth 4.0)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBluetoothLowEnergyUnsupported = 2340
    + +
    +
    +

    Swift

    + 
    case bluetoothLowEnergyUnsupported = 2340
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updating the reader software failed because the reader’s battery is +too low. Charge the reader before trying again.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorReaderSoftwareUpdateFailedBatteryLow = 2650
    + +
    +
    +

    Swift

    + 
    case readerSoftwareUpdateFailedBatteryLow = 2650
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updating the reader software failed because the update was interrupted.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorReaderSoftwareUpdateFailedInterrupted = 2660
    + +
    +
    +

    Swift

    + 
    case readerSoftwareUpdateFailedInterrupted = 2660
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updating the reader software failed because the update has expired. Please disconnect and +reconnect from the reader to retrieve a new update.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorReaderSoftwareUpdateFailedExpiredUpdate = 2670
    + +
    +
    +

    Swift

    + 
    case readerSoftwareUpdateFailedExpiredUpdate = 2670
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The reader has a critically low battery and cannot connect to the +iOS device. Charge the reader before trying again.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBluetoothConnectionFailedBatteryCriticallyLow = 2680
    + +
    +
    +

    Swift

    + 
    case bluetoothConnectionFailedBatteryCriticallyLow = 2680
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The card is not a chip card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorCardInsertNotRead = 2810
    + +
    +
    +

    Swift

    + 
    case cardInsertNotRead = 2810
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The swipe could not be read.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorCardSwipeNotRead = 2820
    + +
    +
    +

    Swift

    + 
    case cardSwipeNotRead = 2820
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Reading a card timed out.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorCardReadTimedOut = 2830
    + +
    +
    +

    Swift

    + 
    case cardReadTimedOut = 2830
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPErrorCardRemoved + +
    +
    +
    +
    +
    +
    +

    The card was removed during the transaction.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorCardRemoved = 2840
    + +
    +
    +

    Swift

    + 
    case cardRemoved = 2840
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A card can only be used for one transaction, and must be removed after +being read. Otherwise, subsequent collectPaymentMethod attempts will fail +with this error.

    + +

    Your terminal delegate will receive -[SCPTerminalDelegate terminal:didReportReaderEvent:info:] +with SCPReaderEventCardRemoved when the card is removed.

    + +

    The Chipper 2x and WisePad 3 will beep until the card is removed.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorCardLeftInReader = 2850
    + +
    +
    +

    Swift

    + 
    case cardLeftInReader = 2850
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The reader failed to read the data from the presented payment method. If you encounter +this error repeatedly, the reader may be faulty.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorMissingEMVData = 2892
    + +
    +
    +

    Swift

    + 
    case missingEMVData = 2892
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The command was not permitted to execute by the operating system. +This can happen for a number of reasons, but most commonly:

    + +
      +
    • Your application does not have the necessary entitlements.
      • +
    • Your application bundle is invalid.
      • +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorCommandNotAllowed = 2900
    + +
    +
    +

    Swift

    + 
    case commandNotAllowed = 2900
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The mobile device on which the app is running is in an unsupported +configuration. Verify that the device is running a supported version of +iOS and that the mobile device has the capability you are attempting to use.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorUnsupportedMobileDeviceConfiguration = 2910
    + +
    +
    +

    Swift

    + 
    case unsupportedMobileDeviceConfiguration = 2910
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The mobile device on which the app is running must have a passcode set.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorPasscodeNotEnabled = 2920
    + +
    +
    +

    Swift

    + 
    case passcodeNotEnabled = 2920
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The card reader cannot be used while a phone call is active.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorCommandNotAllowedDuringCall = 2930
    + +
    +
    +

    Swift

    + 
    case commandNotAllowedDuringCall = 2930
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPErrorInvalidAmount + +
    +
    +
    +
    +
    +
    +

    An attempt was made to charge an amount not supported by the reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorInvalidAmount = 2940
    + +
    +
    +

    Swift

    + 
    case invalidAmount = 2940
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    An attempt was made to charge an amount in a currency not supported by the reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorInvalidCurrency = 2950
    + +
    +
    +

    Swift

    + 
    case invalidCurrency = 2950
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Failed to accept reader-specific terms of service because there is no iCloud +user signed in. Direct the user to sign into an appropriate iCloud account +via iOS Settings and try again.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorAppleBuiltInReaderTOSAcceptanceRequiresiCloudSignIn = 2960
    + +
    +
    +

    Swift

    + 
    case appleBuiltInReaderTOSAcceptanceRequiresiCloudSignIn = 2960
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The user cancelled reader-specific terms of service acceptance.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorAppleBuiltInReaderTOSAcceptanceCanceled = 2970
    + +
    +
    +

    Swift

    + 
    case appleBuiltInReaderTOSAcceptanceCanceled = 2970
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPErrorReaderBusy + +
    +
    +
    +
    +
    +
    +

    The reader is busy.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorReaderBusy = 3010
    + +
    +
    +

    Swift

    + 
    case readerBusy = 3010
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    An incompatible reader was detected. You can only use the Stripe Terminal +iOS SDK with one of Stripe’s pre-certified readers.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorIncompatibleReader = 3030
    + +
    +
    +

    Swift

    + 
    case incompatibleReader = 3030
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Could not communicate with the reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorReaderCommunicationError = 3060
    + +
    +
    +

    Swift

    + 
    case readerCommunicationError = 3060
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPErrorNFCDisabled + +
    +
    +
    +
    +
    +
    +

    NFC functionality is disabled. +Among other things, it may indicate that the app does not have permission to use NFC.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorNFCDisabled = 3100
    + +
    +
    +

    Swift

    + 
    case nfcDisabled = 3100
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Generic Bluetooth error.

    + +

    Among other things, it may indicate that the app does not have permission +to use Bluetooth (iOS 13+).

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBluetoothError = 3200
    + +
    +
    +

    Swift

    + 
    case bluetoothError = 3200
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Connecting to the bluetooth device timed out. Make sure the device is +powered on, in range, and not connected to another app or device. If this +error continues to occur, you may need to charge the device.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBluetoothConnectTimedOut = 3210
    + +
    +
    +

    Swift

    + 
    case bluetoothConnectTimedOut = 3210
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The Bluetooth device was disconnected unexpectedly.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBluetoothDisconnected = 3230
    + +
    +
    +

    Swift

    + 
    case bluetoothDisconnected = 3230
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Bluetooth pairing error, the reader has removed this device pairing information. +Forget the reader in iOS Settings.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBluetoothPeerRemovedPairingInformation = 3240
    + +
    +
    +

    Swift

    + 
    case bluetoothPeerRemovedPairingInformation = 3240
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The Bluetooth reader is already paired to another device. The Bluetooth reader +must have its pairing reset to connect to this device.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBluetoothAlreadyPairedWithAnotherDevice = 3241
    + +
    +
    +

    Swift

    + 
    case bluetoothAlreadyPairedWithAnotherDevice = 3241
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Generic reader software update error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorReaderSoftwareUpdateFailed = 3800
    + +
    +
    +

    Swift

    + 
    case readerSoftwareUpdateFailed = 3800
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updating the reader software failed because there was an error +communicating with the reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorReaderSoftwareUpdateFailedReaderError = 3830
    + +
    +
    +

    Swift

    + 
    case readerSoftwareUpdateFailedReaderError = 3830
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Updating the reader software failed because there was an error +communicating with the update server.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorReaderSoftwareUpdateFailedServerError = 3840
    + +
    +
    +

    Swift

    + 
    case readerSoftwareUpdateFailedServerError = 3840
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    processPayment was called from a reader with an unsupported reader +version. You will need to update your reader to the most recent version in +order to accept payments. We suggest you prompt your user +to disconnect and reconnect their reader in order to update the reader.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers/bbpos-chipper2xbt#updating-reader-software + +
    +

    See

    + https://stripe.com/docs/terminal/readers/bbpos-wisepad3#updating-reader-software + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorUnsupportedReaderVersion = 3850
    + +
    +
    +

    Swift

    + 
    case unsupportedReaderVersion = 3850
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The reader returned from discovery does not have an IP address and cannot +be connected to. The IP address should have been set by the SDK during +registration of the reader. Try registering the reader again.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers/connecting/verifone-p400#register-reader + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorUnknownReaderIpAddress = 3860
    + +
    +
    +

    Swift

    + 
    case unknownReaderIpAddress = 3860
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Connecting to reader over the internet timed out. Make sure your device and +reader are on the same Wifi network and your reader is connected to the +Wifi network.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers/verifone-p400#troubleshooting + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorInternetConnectTimeOut = 3870
    + +
    +
    +

    Swift

    + 
    case internetConnectTimeOut = 3870
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Connecting to the reader failed because it is currently in use +and SCPConnectionConfiguration.failIfInUse was set to true.

    + +

    Try to connect again with failIfInUse = false, or choose a different +reader.

    + +

    A reader is in use while it’s collecting a payment.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers/connecting/verifone-p400#connect-reader-ios + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorConnectFailedReaderIsInUse = 3880
    + +
    +
    +

    Swift

    + 
    case connectFailedReaderIsInUse = 3880
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The Bluetooth reader has disconnected and we are attempting to reconnect.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorBluetoothReconnectStarted = 3890
    + +
    +
    +

    Swift

    + 
    case bluetoothReconnectStarted = 3890
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    An attempt was made to interact with the reader while the the app is in the background.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorReaderNotAccessibleInBackground = 3900
    + +
    +
    +

    Swift

    + 
    case readerNotAccessibleInBackground = 3900
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Preparing the Apple Built-In reader to collect payments failed. +Try connecting again.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorAppleBuiltInReaderFailedToPrepare = 3910
    + +
    +
    +

    Swift

    + 
    case appleBuiltInReaderFailedToPrepare = 3910
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This device cannot be used to process using the Apple Built-In reader as it has been banned.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorAppleBuiltInReaderDeviceBanned = 3920
    + +
    +
    +

    Swift

    + 
    case appleBuiltInReaderDeviceBanned = 3920
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The operation could not be completed because the reader-specific terms of service have +not yet been accepted. Try connecting again.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorAppleBuiltInReaderTOSNotYetAccepted = 3930
    + +
    +
    +

    Swift

    + 
    case appleBuiltInReaderTOSNotYetAccepted = 3930
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Failed to accept reader-specific terms of service using the signed-in Apple ID. +Ensure the Apple ID is still active and in a good standing and try again.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorAppleBuiltInReaderTOSAcceptanceFailed = 3940
    + +
    +
    +

    Swift

    + 
    case appleBuiltInReaderTOSAcceptanceFailed = 3940
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This merchant account cannot be used with Apple Built-In reader as it has been blocked.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorAppleBuiltInReaderMerchantBlocked = 3950
    + +
    +
    +

    Swift

    + 
    case appleBuiltInReaderMerchantBlocked = 3950
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This merchant account cannot be used with the Apple Built-In reader as it is invalid.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorAppleBuiltInReaderInvalidMerchant = 3960
    + +
    +
    +

    Swift

    + 
    case appleBuiltInReaderInvalidMerchant = 3960
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Unexpected SDK error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorUnexpectedSdkError = 5000
    + +
    +
    +

    Swift

    + 
    case unexpectedSdkError = 5000
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Unexpected reader error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorUnexpectedReaderError = 5001
    + +
    +
    +

    Swift

    + 
    case unexpectedReaderError = 5001
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The Stripe API declined the transaction. +Inspect the error’s requestError property for more information about +the decline, including the decline code.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorDeclinedByStripeAPI = 6000
    + +
    +
    +

    Swift

    + 
    case declinedByStripeAPI = 6000
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The reader declined the transaction. Try another card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorDeclinedByReader = 6500
    + +
    +
    +

    Swift

    + 
    case declinedByReader = 6500
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The cardholder must give consent in order for this operation to succeed.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorCommandRequiresCardholderConsent = 6700
    + +
    +
    +

    Swift

    + 
    case commandRequiresCardholderConsent = 6700
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPErrorRefundFailed + +
    +
    +
    +
    +
    +
    +

    The refund failed. The customer’s bank or card issuer was unable to process +it correctly (e.g., a closed bank account or a problem with the card)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorRefundFailed = 6800
    + +
    +
    +

    Swift

    + 
    case refundFailed = 6800
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SDK is not connected to the internet.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorNotConnectedToInternet = 9000
    + +
    +
    +

    Swift

    + 
    case notConnectedToInternet = 9000
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The underlying request timed out.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorRequestTimedOut = 9010
    + +
    +
    +

    Swift

    + 
    case requestTimedOut = 9010
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The underlying request returned an API error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorStripeAPIError = 9020
    + +
    +
    +

    Swift

    + 
    case stripeAPIError = 9020
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The API response from Stripe could not be decoded.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorStripeAPIResponseDecodingError = 9030
    + +
    +
    +

    Swift

    + 
    case stripeAPIResponseDecodingError = 9030
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Generic network error

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorInternalNetworkError = 9040
    + +
    +
    +

    Swift

    + 
    case internalNetworkError = 9040
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Your implementation of -[SCPConnectionTokenProvider fetchConnectionToken:] +called the completion block with an error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorConnectionTokenProviderCompletedWithError = 9050
    + +
    +
    +

    Swift

    + 
    case connectionTokenProviderCompletedWithError = 9050
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The current session has expired and the reader must be disconnected and +reconnected. The SDK will attempt to auto-disconnect for you and you should +instruct your user to reconnect it. +-[SCPTerminalDelegate terminal:didReportUnexpectedReaderDisconnect:] +will be called if the SDK is able to successfully auto-disconnect. If it +does not successfully auto-disconnect (didReportUnexpectedReaderDisconnect +will not be called and SCPTerminal.connectionStatus will still be +SCPConnectionStatusConnected) you can attempt again via +-[SCPTerminal disconnectReader:] or you can instruct your user +to disconnect manually by turning the reader off.

    + +

    Note this error will only occur in one of the following calls:

    + + + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPErrorSessionExpired = 9060
    + +
    +
    +

    Swift

    + 
    case sessionExpired = 9060
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPIncrementalAuthorizationStatus.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPIncrementalAuthorizationStatus.html new file mode 100644 index 00000000..d757f280 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPIncrementalAuthorizationStatus.html @@ -0,0 +1,543 @@ + + + + SCPIncrementalAuthorizationStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPIncrementalAuthorizationStatus Enumeration Reference +

+ +
+ +
+ +
+
+

SCPIncrementalAuthorizationStatus

+
+
+

Objective-C

+ 
enum SCPIncrementalAuthorizationStatus : NSUInteger {}
+ +
+
+

Swift

+ 
enum SCPIncrementalAuthorizationStatus : UInt, @unchecked Sendable
+ +
+
+

Represents the ability for a PaymentIntent to be incrementally authorized.

+
+

See

+ https://stripe.com/docs/terminal/features/incremental-authorizations + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    It is undetermined whether or not this PaymentIntent will be eligible for incremental authorizations. +You can only perform incremental authorizations on uncaptured payments after confirmation.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPIncrementalAuthorizationStatusUnknown
    + +
    +
    +

    Swift

    + 
    case unknown = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This PaymentIntent is not eligible for incremental authorizations, or it was not requested.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPIncrementalAuthorizationStatusNotSupported
    + +
    +
    +

    Swift

    + 
    case notSupported = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This PaymentIntent is eligible for incremental authorizations.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPIncrementalAuthorizationStatusSupported
    + +
    +
    +

    Swift

    + 
    case supported = 2
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPLocationStatus.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPLocationStatus.html new file mode 100644 index 00000000..682ae40d --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPLocationStatus.html @@ -0,0 +1,547 @@ + + + + SCPLocationStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPLocationStatus Enumeration Reference +

+ +
+ +
+ +
+
+

SCPLocationStatus

+
+
+

Objective-C

+ 
enum SCPLocationStatus : NSUInteger {}
+ +
+
+

Swift

+ 
enum LocationStatus : UInt, @unchecked Sendable
+ +
+
+

Represents the possible states of the location object for a +discovered reader.

+
+

See

+ SCPReader + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The location is not known. location will be nil.

    + +

    A reader will only have a location status of unknown when a Bluetooth +reader’s full location information failed to fetch properly during discovery.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPLocationStatusUnknown
    + +
    +
    +

    Swift

    + 
    case unknown = 0
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPLocationStatusSet + +
    +
    +
    +
    +
    +
    +

    The location was successfully set to a known location. +location is a valid SCPLocation.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPLocationStatusSet
    + +
    +
    +

    Swift

    + 
    case set = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This location is known to be not set. location will be nil.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPLocationStatusNotSet
    + +
    +
    +

    Swift

    + 
    case notSet = 2
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPLogLevel.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPLogLevel.html new file mode 100644 index 00000000..e65b3157 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPLogLevel.html @@ -0,0 +1,505 @@ + + + + SCPLogLevel Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPLogLevel Enumeration Reference +

+ +
+ +
+ +
+
+

SCPLogLevel

+
+
+

Objective-C

+ 
enum SCPLogLevel : NSUInteger {}
+ +
+
+

Swift

+ 
enum LogLevel : UInt, @unchecked Sendable
+ +
+
+

The various log levels for the SDK.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + SCPLogLevelNone + +
    +
    +
    +
    +
    +
    +

    No logs will printed to the console.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPLogLevelNone
    + +
    +
    +

    Swift

    + 
    case none = 0
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPLogLevelVerbose + +
    +
    +
    +
    +
    +
    +

    Verbose logs will be printed to the console.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPLogLevelVerbose
    + +
    +
    +

    Swift

    + 
    case verbose = 1
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPPaymentIntentStatus.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPPaymentIntentStatus.html new file mode 100644 index 00000000..5d0481ca --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPPaymentIntentStatus.html @@ -0,0 +1,635 @@ + + + + SCPPaymentIntentStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPPaymentIntentStatus Enumeration Reference +

+ +
+ +
+ +
+
+

SCPPaymentIntentStatus

+
+
+

Objective-C

+ 
enum SCPPaymentIntentStatus : NSUInteger {}
+ +
+
+

Swift

+ 
enum PaymentIntentStatus : UInt, @unchecked Sendable
+ +
+
+

The possible statuses for a PaymentIntent.

+ +

https://stripe.com/docs/api/payment_intents/object#payment_intent_object-status

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Next step: collect a payment method by calling collectPaymentMethod.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentIntentStatusRequiresPaymentMethod
    + +
    +
    +

    Swift

    + 
    case requiresPaymentMethod = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Next step: process the payment by calling processPayment.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentIntentStatusRequiresConfirmation
    + +
    +
    +

    Swift

    + 
    case requiresConfirmation = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Next step: capture the PaymentIntent on your backend via the Stripe API.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentIntentStatusRequiresCapture
    + +
    +
    +

    Swift

    + 
    case requiresCapture = 2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The PaymentIntent is in the middle of full EMV processing.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentIntentStatusProcessing
    + +
    +
    +

    Swift

    + 
    case processing = 3
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The PaymentIntent was canceled.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentIntentStatusCanceled
    + +
    +
    +

    Swift

    + 
    case canceled = 4
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The PaymentIntent succeeded.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentIntentStatusSucceeded
    + +
    +
    +

    Swift

    + 
    case succeeded = 5
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPPaymentMethodType.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPPaymentMethodType.html new file mode 100644 index 00000000..66b1ed0a --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPPaymentMethodType.html @@ -0,0 +1,574 @@ + + + + SCPPaymentMethodType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPPaymentMethodType Enumeration Reference +

+ +
+ +
+ +
+
+

SCPPaymentMethodType

+
+
+

Objective-C

+ 
enum SCPPaymentMethodType : NSUInteger {}
+ +
+
+

Swift

+ 
enum PaymentMethodType : UInt, @unchecked Sendable
+ +
+
+

The type of the PaymentMethod.

+
+

See

+ https://stripe.com/docs/api/payment_methods/object#payment_method_object-type + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    A card payment method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentMethodTypeCard
    + +
    +
    +

    Swift

    + 
    case card = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A card present payment method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentMethodTypeCardPresent
    + +
    +
    +

    Swift

    + 
    case cardPresent = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    An Interac Present payment method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentMethodTypeInteracPresent
    + +
    +
    +

    Swift

    + 
    case interacPresent = 2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    An unknown type.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentMethodTypeUnknown
    + +
    +
    +

    Swift

    + 
    case unknown = 3
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPPaymentStatus.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPPaymentStatus.html new file mode 100644 index 00000000..5b5fcd7b --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPPaymentStatus.html @@ -0,0 +1,576 @@ + + + + SCPPaymentStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPPaymentStatus Enumeration Reference +

+ +
+ +
+ +
+
+

SCPPaymentStatus

+
+
+

Objective-C

+ 
enum SCPPaymentStatus : NSUInteger {}
+ +
+
+

Swift

+ 
enum PaymentStatus : UInt, @unchecked Sendable
+ +
+
+

The possible payment statuses for the SDK.

+
+

See

+ https://stripe.com/docs/terminal/payments + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The SDK is not ready to start a payment. It may be busy with another +command, or a reader may not be connected.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentStatusNotReady
    + +
    +
    +

    Swift

    + 
    case notReady = 0
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPPaymentStatusReady + +
    +
    +
    +
    +
    +
    +

    The SDK is ready to start a payment.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentStatusReady
    + +
    +
    +

    Swift

    + 
    case ready = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SDK is waiting for input from the customer (e.g., for a card to +be presented to the reader)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentStatusWaitingForInput
    + +
    +
    +

    Swift

    + 
    case waitingForInput = 2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SDK is processing a payment.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPPaymentStatusProcessing
    + +
    +
    +

    Swift

    + 
    case processing = 3
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderDisplayMessage.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderDisplayMessage.html new file mode 100644 index 00000000..0933ea7a --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderDisplayMessage.html @@ -0,0 +1,699 @@ + + + + SCPReaderDisplayMessage Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPReaderDisplayMessage Enumeration Reference +

+ +
+ +
+ +
+
+

SCPReaderDisplayMessage

+
+
+

Objective-C

+ 
enum SCPReaderDisplayMessage : NSUInteger {}
+ +
+
+

Swift

+ 
enum ReaderDisplayMessage : UInt, @unchecked Sendable
+ +
+
+

The display messages that a reader may request be displayed by your app. Used by [SCPBluetoothReaderDelegate reader:didRequestReaderDisplayMessage:].

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Retry the presented card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderDisplayMessageRetryCard
    + +
    +
    +

    Swift

    + 
    case retryCard = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Insert the presented card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderDisplayMessageInsertCard
    + +
    +
    +

    Swift

    + 
    case insertCard = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Insert or swipe the presented card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderDisplayMessageInsertOrSwipeCard
    + +
    +
    +

    Swift

    + 
    case insertOrSwipeCard = 2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Swipe the presented card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderDisplayMessageSwipeCard
    + +
    +
    +

    Swift

    + 
    case swipeCard = 3
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Remove the presented card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderDisplayMessageRemoveCard
    + +
    +
    +

    Swift

    + 
    case removeCard = 4
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The reader detected multiple contactless cards. Make sure only one +contactless card or NFC device is near the reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderDisplayMessageMultipleContactlessCardsDetected
    + +
    +
    +

    Swift

    + 
    case multipleContactlessCardsDetected = 5
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The card could not be read. Try another read method on the same card, or +use a different card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderDisplayMessageTryAnotherReadMethod
    + +
    +
    +

    Swift

    + 
    case tryAnotherReadMethod = 6
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The card is invalid. Try another card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderDisplayMessageTryAnotherCard
    + +
    +
    +

    Swift

    + 
    case tryAnotherCard = 7
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderEvent.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderEvent.html new file mode 100644 index 00000000..35708369 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderEvent.html @@ -0,0 +1,505 @@ + + + + SCPReaderEvent Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPReaderEvent Enumeration Reference +

+ +
+ +
+ +
+
+

SCPReaderEvent

+
+
+

Objective-C

+ 
enum SCPReaderEvent : NSUInteger {}
+ +
+
+

Swift

+ 
enum ReaderEvent : UInt, @unchecked Sendable
+ +
+
+

The possible events from a connected reader. Used by [SCPBluetoothReaderDelegate reader:didReportReaderEvent:info:].

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    A card was inserted.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderEventCardInserted
    + +
    +
    +

    Swift

    + 
    case cardInserted = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A card was removed.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderEventCardRemoved
    + +
    +
    +

    Swift

    + 
    case cardRemoved = 1
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderInputOptions.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderInputOptions.html new file mode 100644 index 00000000..80a96d0d --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderInputOptions.html @@ -0,0 +1,565 @@ + + + + SCPReaderInputOptions Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPReaderInputOptions Enumeration Reference +

+ +
+ +
+ +
+
+

SCPReaderInputOptions

+
+
+

Objective-C

+ 
enum SCPReaderInputOptions : NSUInteger {}
+ +
+
+

Swift

+ 
struct ReaderInputOptions : OptionSet, @unchecked Sendable
+ +
+
+

This OptionSet represents all of the input methods available to your user when +the reader begins waiting for input. Used by [SCPBluetoothReaderDelegate reader:didRequestReaderInput:].

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    No input options are available on the reader.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderInputOptionNone = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Swipe a magstripe card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderInputOptionSwipeCard = 1 << 0
    + +
    +
    +

    Swift

    + 
    static var swipeCard: ReaderInputOptions { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Insert a chip card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderInputOptionInsertCard = 1 << 1
    + +
    +
    +

    Swift

    + 
    static var insertCard: ReaderInputOptions { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Tap a contactless card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderInputOptionTapCard = 1 << 2
    + +
    +
    +

    Swift

    + 
    static var tapCard: ReaderInputOptions { get }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderNetworkStatus.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderNetworkStatus.html new file mode 100644 index 00000000..d9700139 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderNetworkStatus.html @@ -0,0 +1,511 @@ + + + + SCPReaderNetworkStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPReaderNetworkStatus Enumeration Reference +

+ +
+ +
+ +
+
+

SCPReaderNetworkStatus

+
+
+

Objective-C

+ 
enum SCPReaderNetworkStatus : NSUInteger {}
+ +
+
+

Swift

+ 
enum ReaderNetworkStatus : UInt, @unchecked Sendable
+ +
+
+

The possible networking statuses for a reader.

+
+

See

+ https://stripe.com/docs/api/terminal/readers/object + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The reader is offline. Note that Chipper 2x and WisePad 3 will always report +offline.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderNetworkStatusOffline
    + +
    +
    +

    Swift

    + 
    case offline = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The reader is online.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPReaderNetworkStatusOnline
    + +
    +
    +

    Swift

    + 
    case online = 1
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPRefundStatus.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPRefundStatus.html new file mode 100644 index 00000000..3a66c318 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPRefundStatus.html @@ -0,0 +1,574 @@ + + + + SCPRefundStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPRefundStatus Enumeration Reference +

+ +
+ +
+ +
+
+

SCPRefundStatus

+
+
+

Objective-C

+ 
enum SCPRefundStatus : NSUInteger {}
+ +
+
+

Swift

+ 
enum RefundStatus : UInt, @unchecked Sendable
+ +
+
+

The possible statuses for a refund.

+
+

See

+ https://stripe.com/docs/api/refunds/object#refund_object-status + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The refund succeeded.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPRefundStatusSucceeded
    + +
    +
    +

    Swift

    + 
    case succeeded = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The refund is pending.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPRefundStatusPending
    + +
    +
    +

    Swift

    + 
    case pending = 1
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPRefundStatusFailed + +
    +
    +
    +
    +
    +
    +

    The refund failed.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPRefundStatusFailed
    + +
    +
    +

    Swift

    + 
    case failed = 2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Unknown refund state.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPRefundStatusUnknown
    + +
    +
    +

    Swift

    + 
    case unknown = 3
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSetupIntentStatus.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSetupIntentStatus.html new file mode 100644 index 00000000..e31fef63 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSetupIntentStatus.html @@ -0,0 +1,641 @@ + + + + SCPSetupIntentStatus Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPSetupIntentStatus Enumeration Reference +

+ +
+ +
+ +
+
+

SCPSetupIntentStatus

+
+
+

Objective-C

+ 
enum SCPSetupIntentStatus : NSUInteger {}
+ +
+
+

Swift

+ 
enum SetupIntentStatus : UInt, @unchecked Sendable
+ +
+
+

The possible statuses of the SetupIntent.

+
+

See

+ https://stripe.com/docs/api/setup_intents/object#setup_intent_object-status + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Next step: collect a payment method by calling collectPaymentMethod.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSetupIntentStatusRequiresPaymentMethod
    + +
    +
    +

    Swift

    + 
    case requiresPaymentMethod = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Next step: confirm the SetupIntent by calling confirmSetupIntent.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSetupIntentStatusRequiresConfirmation
    + +
    +
    +

    Swift

    + 
    case requiresConfirmation = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    If the setup requires additional actions, such as authenticating with +3D Secure, the SetupIntent has a status of requires_action.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSetupIntentStatusRequiresAction
    + +
    +
    +

    Swift

    + 
    case requiresAction = 2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Once required actions are handled, the SetupIntent moves to processing. +While for certain payment methods (e.g., cards) processing can be quick, +other payment methods can take up to a few days to process.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSetupIntentStatusProcessing
    + +
    +
    +

    Swift

    + 
    case processing = 3
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SetupIntent was canceled.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSetupIntentStatusCanceled
    + +
    +
    +

    Swift

    + 
    case canceled = 4
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SetupIntent succeeded.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSetupIntentStatusSucceeded
    + +
    +
    +

    Swift

    + 
    case succeeded = 5
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSetupIntentUsage.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSetupIntentUsage.html new file mode 100644 index 00000000..46f3b727 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSetupIntentUsage.html @@ -0,0 +1,517 @@ + + + + SCPSetupIntentUsage Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPSetupIntentUsage Enumeration Reference +

+ +
+ +
+ +
+
+

SCPSetupIntentUsage

+
+
+

Objective-C

+ 
enum SCPSetupIntentUsage : NSUInteger {}
+ +
+
+

Swift

+ 
enum SetupIntentUsage : UInt, @unchecked Sendable
+ +
+
+

The SetupIntent usage options tell Stripe how the payment method is intended to be used in the future. +Stripe will use the chosen option to pick the most frictionless flow for the customer.

+
+

See

+ https://stripe.com/docs/payments/setup-intents#increasing-success-rate-by-specifying-usage + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    An off-session usage indicates to Stripe that future payments will take place +without the direct involvement of the customer. Creating an off-session SetupIntent +might incur some initial friction from additional authentication steps, +but can reduce customer intervention in later off-session payments.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSetupIntentUsageOffSession
    + +
    +
    +

    Swift

    + 
    case offSession = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    An on-session usage indicates to Stripe that future payments will take place +while the customer is actively in your checkout flow and able to authenticate +the payment method. With the on-session option, you can postpone authenticating +the card details until a future checkout to avoid upfront friction.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSetupIntentUsageOnSession
    + +
    +
    +

    Swift

    + 
    case onSession = 1
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSimulateReaderUpdate.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSimulateReaderUpdate.html new file mode 100644 index 00000000..91360cb3 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSimulateReaderUpdate.html @@ -0,0 +1,630 @@ + + + + SCPSimulateReaderUpdate Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPSimulateReaderUpdate Enumeration Reference +

+ +
+ +
+ +
+
+

SCPSimulateReaderUpdate

+
+
+

Objective-C

+ 
enum SCPSimulateReaderUpdate : NSUInteger {}
+ +
+
+

Swift

+ 
enum SimulateReaderUpdate : UInt, @unchecked Sendable
+ +
+
+

Enum used to simulate various types of reader updates being available for +a simulated bluetooth or local mobile reader.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Default value.

    + +
      +
    • When connecting to a Bluetooth reader, an update is available that is marked +as needing to be installed within 7 days.
      • +
    • When connecting to a Local Mobile reader, a mandatory update will complete +during the connection flow.
      • +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulateReaderUpdateAvailable = 0
    + +
    +
    +

    Swift

    + 
    case available = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    No updates are available

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulateReaderUpdateNone
    + +
    +
    +

    Swift

    + 
    case none = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A required full reader software update exists. Use this to simulate the +auto-install of a required update that will be applied during connect. +This simulated update will take 1 minute and progress will be provided +to the delegate provided to connectBluetoothReader or +connectLocalMobileReader as appropriate.

    +
    +

    See

    + SCPBluetoothReaderReaderDelegate + +
    +

    See

    + SCPLocalMobileReaderDelegate + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulateReaderUpdateRequired
    + +
    +
    +

    Swift

    + 
    case required = 2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A required update exists.

    + +
      +
    • When connecting to a Bluetooth reader, the connection will fail because +the reader’s battery is too low for an update to begin.
      • +
    • When connecting to a Local Mobile reader, a mandatory update will +complete during the connection flow.
      • +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulateReaderUpdateLowBattery
    + +
    +
    +

    Swift

    + 
    case lowBattery = 3
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Randomly picks a type of update for the reader to help exercise the +various states.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulateReaderUpdateRandom
    + +
    +
    +

    Swift

    + 
    case random = 4
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSimulatedCardType.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSimulatedCardType.html new file mode 100644 index 00000000..092d3a17 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSimulatedCardType.html @@ -0,0 +1,1359 @@ + + + + SCPSimulatedCardType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPSimulatedCardType Enumeration Reference +

+ +
+ +
+ +
+
+

SCPSimulatedCardType

+
+
+

Objective-C

+ 
enum SCPSimulatedCardType : NSUInteger {}
+ +
+
+

Swift

+ 
enum SimulatedCardType : UInt, @unchecked Sendable
+ +
+
+

Enum used to simulate various types of cards and error cases.

+
+

See

+ https://stripe.com/docs/terminal/testing#simulated-test-cards + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Visa

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeVisa = 0
    + +
    +
    +

    Swift

    + 
    case visa = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Visa (debit)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeVisaDebit
    + +
    +
    +

    Swift

    + 
    case visaDebit = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Mastercard

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeMastercard
    + +
    +
    +

    Swift

    + 
    case mastercard = 2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Mastercard (debit)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeMasterDebit
    + +
    +
    +

    Swift

    + 
    case masterDebit = 3
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Mastercard (prepaid)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeMastercardPrepaid
    + +
    +
    +

    Swift

    + 
    case mastercardPrepaid = 4
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    American Express

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeAmex
    + +
    +
    +

    Swift

    + 
    case amex = 5
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    American Express

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeAmex2
    + +
    +
    +

    Swift

    + 
    case amex2 = 6
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Discover

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeDiscover
    + +
    +
    +

    Swift

    + 
    case discover = 7
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Discover

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeDiscover2
    + +
    +
    +

    Swift

    + 
    case discover2 = 8
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Diners Club

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeDiners
    + +
    +
    +

    Swift

    + 
    case diners = 9
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Diners Club (14 digit card)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeDiners14Digit
    + +
    +
    +

    Swift

    + 
    case diners14Digit = 10
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    JCB

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeJcb
    + +
    +
    +

    Swift

    + 
    case jcb = 11
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    UnionPay

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeUnionPay
    + +
    +
    +

    Swift

    + 
    case unionPay = 12
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Interac

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeInterac
    + +
    +
    +

    Swift

    + 
    case interac = 13
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Eftpos Australia

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeEftposAuDebit
    + +
    +
    +

    Swift

    + 
    case eftposAuDebit = 14
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Eftpos Australia/Visa

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeEftposAuVisaDebit
    + +
    +
    +

    Swift

    + 
    case eftposAuVisaDebit = 15
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Eftpos Australia/Mastercard

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeEftposAuDebitMastercard
    + +
    +
    +

    Swift

    + 
    case eftposAuDebitMastercard = 16
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Charge is declined with a card_declined code.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeChargeDeclined
    + +
    +
    +

    Swift

    + 
    case chargeDeclined = 17
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Charge is declined with a card_declined code. The decline_code + attribute is insufficient_funds.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeChargeDeclinedInsufficientFunds
    + +
    +
    +

    Swift

    + 
    case chargeDeclinedInsufficientFunds = 18
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Charge is declined with a card_declined code. The decline_code + attribute is lost_card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeChargeDeclinedLostCard
    + +
    +
    +

    Swift

    + 
    case chargeDeclinedLostCard = 19
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Charge is declined with a card_declined code. The decline_code + attribute is stolen_card.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeChargeDeclinedStolenCard
    + +
    +
    +

    Swift

    + 
    case chargeDeclinedStolenCard = 20
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Charge is declined with an expired_card code.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeChargeDeclinedExpiredCard
    + +
    +
    +

    Swift

    + 
    case chargeDeclinedExpiredCard = 21
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Charge is declined with a processing_error code.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeChargeDeclinedProcessingError
    + +
    +
    +

    Swift

    + 
    case chargeDeclinedProcessingError = 22
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Refund is declined with a refund_fail error.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeRefundFailed
    + +
    +
    +

    Swift

    + 
    case refundFailed = 23
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Payment attaches Online Pin to the transaction. + cardholder_verification_method will be set to online_pin in the resulting paymentIntent + WisePad3 only

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeOnlinePinCvm
    + +
    +
    +

    Swift

    + 
    case onlinePinCvm = 24
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This flow simulates an Online Pin scenario with SCA compliance. + Payment is retried and user is prompted to input their pin. + Next an online pin being entered is simulated.

    +
    cardholder_verification_method will be set to online_pin in the resulting paymentIntent.
+WisePad3 only
+
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeOnlinePinScaRetry
    + +
    +
    +

    Swift

    + 
    case onlinePinScaRetry = 25
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Payment attaches Offline Pin to the transaction. + cardholder_verification_method will be set to offline_pin in the resulting paymentIntent + WisePad3 only

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeOfflinePinCvm
    + +
    +
    +

    Swift

    + 
    case offlinePinCvm = 26
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This flow simulates an Offline Pin scenario with SCA compliance. + Payment is retried and user is prompted to insert their card. + Next a contact retry and an offline pin being entered are simulated.

    +
    cardholder_verification_method will be set to offline_pin in the resulting paymentIntent.
+WisePad3 only
+
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeOfflinePinScaRetry
    + +
    +
    +

    Swift

    + 
    case offlinePinScaRetry = 27
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPUpdateComponent.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPUpdateComponent.html new file mode 100644 index 00000000..187d0b98 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPUpdateComponent.html @@ -0,0 +1,589 @@ + + + + SCPUpdateComponent Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPUpdateComponent Enumeration Reference +

+ +
+ +
+ +
+
+

SCPUpdateComponent

+
+
+

Objective-C

+ 
enum SCPUpdateComponent : NSUInteger {}
+ +
+
+

Swift

+ 
struct UpdateComponent : OptionSet, @unchecked Sendable
+ +
+
+

A bitmask identifying what exact updates are contained within this update.

+ +

Note that the time estimates documented here are for each individual piece. Updates +will often contain multiple components together. Check the estimatedUpdateTime to +see how long the entire update process is expected to take for all components.

+
+

See

+ https://stripe.com/docs/terminal/readers/bbpos-chipper2xbt#reader-software-releases + +
+

See

+ https://stripe.com/docs/terminal/readers/bbpos-wisepad3#reader-software-releases + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    If set, the update contains incremental changes to the reader. If this is +the only component being updated, the deviceSoftwareVersion will not +differ from the existing installed version. Incremental updates should take +less than 1 minute.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPUpdateComponentIncremental = 1 << 0
    + +
    +
    +

    Swift

    + 
    static var incremental: UpdateComponent { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    If set, this update contains updated firmware for this reader. Firmware updates +can take 5 to 15 minutes.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPUpdateComponentFirmware = 1 << 1
    + +
    +
    +

    Swift

    + 
    static var firmware: UpdateComponent { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    If set, this update contains a new configuration for this reader. These may +contain regional changes or other card network updates. Configuration updates +are expected to take 1 to 2 minutes.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPUpdateComponentConfig = 1 << 2
    + +
    +
    +

    Swift

    + 
    static var config: UpdateComponent { get }
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    If set, this update contains updated encryption keys for the reader. +Updating keys should take less than 1 minute.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPUpdateComponentKeys = 1 << 3
    + +
    +
    +

    Swift

    + 
    static var keys: UpdateComponent { get }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPUpdateTimeEstimate.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPUpdateTimeEstimate.html new file mode 100644 index 00000000..9305f057 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPUpdateTimeEstimate.html @@ -0,0 +1,579 @@ + + + + SCPUpdateTimeEstimate Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPUpdateTimeEstimate Enumeration Reference +

+ +
+ +
+ +
+
+

SCPUpdateTimeEstimate

+
+
+

Objective-C

+ 
enum SCPUpdateTimeEstimate : NSUInteger {}
+ +
+
+

Swift

+ 
enum UpdateTimeEstimate : UInt, @unchecked Sendable
+ +
+
+

The estimated amount of time for an update. Note that these times are estimates; +actual times may vary depending on your network and Bluetooth connection.

+
+

See

+ https://stripe.com/docs/terminal/readers/bbpos-chipper2xbt#reader-software-releases + +
+

See

+ https://stripe.com/docs/terminal/readers/bbpos-wisepad3#reader-software-releases + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The update should take less than 1 minute to complete.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPUpdateTimeEstimateLessThan1Minute
    + +
    +
    +

    Swift

    + 
    case estimateLessThan1Minute = 0
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The update should take 1-2 minutes to complete.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPUpdateTimeEstimate1To2Minutes
    + +
    +
    +

    Swift

    + 
    case estimate1To2Minutes = 1
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The update should take 2-5 minutes to complete.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPUpdateTimeEstimate2To5Minutes
    + +
    +
    +

    Swift

    + 
    case estimate2To5Minutes = 2
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The update should take 5-15 minutes to complete.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPUpdateTimeEstimate5To15Minutes
    + +
    +
    +

    Swift

    + 
    case estimate5To15Minutes = 3
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Errors.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Errors.html new file mode 100644 index 00000000..44e7d31f --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Errors.html @@ -0,0 +1,964 @@ + + + + Errors Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + Errors Reference +

+ +
+ +
+ +
+
+

Errors

+ +
+
+ +
+
+
+
+ + +
+ +

SCPError +

+
+
+
    +
  • +
    + + + + SCPError + +
    +
    +
    +
    +
    +
    +

    Possible error codes for NSError objects under the SCPErrorDomain domain.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPError : NSInteger {}
    + +
    +
    +

    Swift

    + 
    typealias ErrorCode.Code._ErrorType = ErrorCode
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPErrorDomain + +
    +
    +
    +
    +
    +
    +

    The error domain for all errors originating from the Stripe Terminal SDK.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern NSString *const _Nonnull SCPErrorDomain
    + +
    +
    +

    Swift

    + 
    let ErrorDomain: String
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

UserInfo keys +

+
+
+
    +
  • +
    + + + + SCPErrorKey + +
    +
    +
    +
    +
    +
    +

    Use this enum to access userInfo keys for NSError objects under the +SCPErrorDomain domain.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef NSString *const SCPErrorKey
    + +
    +
    +

    Swift

    + 
    struct ErrorKey : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPErrorKeyMessage + +
    +
    +
    +
    +
    +
    +

    An error message explaining what went wrong. You probably shouldn’t show this +to your users, but may want to use it yourself.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern SCPErrorKey _Nonnull SCPErrorKeyMessage
    + +
    +
    +

    Swift

    + 
    static let message: ErrorKey
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The HTTP status code of the response.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern SCPErrorKey _Nonnull SCPErrorKeyHttpStatusCode
    + +
    +
    +

    Swift

    + 
    static let httpStatusCode: ErrorKey
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This error message comes from the reader. You probably shouldn’t show this +to your users, but may want to inspect it yourself.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern SCPErrorKey _Nonnull SCPErrorKeyReaderMessage
    + +
    +
    +

    Swift

    + 
    static let readerMessage: ErrorKey
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    If an Apple Built-In reader fails to connect due to a device ban and the error +has an associated ban expiry date, the NSDate will be returned +under this key.

    +
    +

    See

    + SCPErrorAppleBuiltInReaderDeviceBanned + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern SCPErrorKey _Nonnull SCPErrorKeyDeviceBannedUntilDate
    + +
    +
    +

    Swift

    + 
    static let deviceBannedUntilDate: ErrorKey
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    If a Stripe API request failed, the failed request’s id will be returned in the +error under this key.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern SCPErrorKey _Nonnull SCPErrorKeyStripeAPIRequestId
    + +
    +
    +

    Swift

    + 
    static let stripeAPIRequestId: ErrorKey
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The decline code returned by the Stripe API.

    +
    +

    See

    + https://stripe.com/docs/api#errors-decline_code + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern SCPErrorKey _Nonnull SCPErrorKeyStripeAPIDeclineCode
    + +
    +
    +

    Swift

    + 
    static let stripeAPIDeclineCode: ErrorKey
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The error code returned by the Stripe API.

    +
    +

    See

    + https://stripe.com/docs/api#errors-code + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern SCPErrorKey _Nonnull SCPErrorKeyStripeAPIErrorCode
    + +
    +
    +

    Swift

    + 
    static let stripeAPIErrorCode: ErrorKey
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The parameter the error relates to if the error is parameter-specific.

    +
    +

    See

    + https://stripe.com/docs/api#errors-param + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern SCPErrorKey _Nonnull SCPErrorKeyStripeAPIErrorParameter
    + +
    +
    +

    Swift

    + 
    static let stripeAPIErrorParameter: ErrorKey
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The error type returned by the Stripe API.

    +
    +

    See

    + https://stripe.com/docs/api#errors-type + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern SCPErrorKey _Nonnull SCPErrorKeyStripeAPIErrorType
    + +
    +
    +

    Swift

    + 
    static let stripeAPIErrorType: ErrorKey
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    If a Stripe API request failed and the error has an associated PaymentIntent, +the SCPPaymentIntent will be returned under this key.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern SCPErrorKey _Nonnull SCPErrorKeyStripeAPIPaymentIntent
    + +
    +
    +

    Swift

    + 
    static let stripeAPIPaymentIntent: ErrorKey
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The documentation URL for the error returned by the Stripe API.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern SCPErrorKey _Nonnull SCPErrorKeyStripeAPIDocUrl
    + +
    +
    +

    Swift

    + 
    static let stripeAPIDocUrl: ErrorKey
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    If a refund fails, the reason for refund failure if known. Possible values +are lost_or_stolen_card, expired_or_canceled_card, or unknown.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern SCPErrorKey _Nonnull SCPErrorKeyStripeAPIFailureReason
    + +
    +
    +

    Swift

    + 
    static let stripeAPIFailureReason: ErrorKey
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Payment.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Payment.html new file mode 100644 index 00000000..67ae82e8 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Payment.html @@ -0,0 +1,1404 @@ + + + + Payment Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + Payment Reference +

+ +
+ +
+ +
+
+

Payment

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPBluetoothReaderDelegate.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPBluetoothReaderDelegate.html new file mode 100644 index 00000000..d34121ac --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPBluetoothReaderDelegate.html @@ -0,0 +1,1135 @@ + + + + SCPBluetoothReaderDelegate Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPBluetoothReaderDelegate Protocol Reference +

+ +
+ +
+ +
+
+

SCPBluetoothReaderDelegate

+
+
+

Objective-C

+ 
@protocol SCPBluetoothReaderDelegate <NSObject>
+ +
+
+

Swift

+ 
protocol BluetoothReaderDelegate : NSObjectProtocol
+ +
+
+

Implement this protocol to handle a connected Bluetooth reader’s events throughout +the lifetime of its connection.

+ +

Implementing this delegate is required when connecting to any Bluetooth connected +reader, such as the Chipper 2X BT and the WisePad 3.

+ +

The provided delegate must be retained by your application until the reader disconnects.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The SDK is reporting that an update is available for the reader. +This update should be installed at the earliest convenience via +-[SCPTerminal installUpdate:]

    + +

    Check the SCPReaderSoftwareUpdate.requiredAt field to see when this update +will be a required update. Required updates are installed immediately upon connection.

    + +

    This delegate method is most likely to be called right after connectReader: but +applications that stay connected to the reader for long periods of time should expect +this method to be called any time the reader is not busy performing a transaction.

    +
    +

    See

    +

    https://stripe.com/docs/terminal/readers/bbpos-chipper2xbt#updating-reader-software

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)reader:(nonnull SCPReader *)reader
+    didReportAvailableUpdate:(nonnull SCPReaderSoftwareUpdate *)update;
    + +
    +
    +

    Swift

    + 
    func reader(_ reader: SCPReader, didReportAvailableUpdate update: SCPReaderSoftwareUpdate)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + update + + +
    +

    An SCPReaderSoftwareUpdate object representing the update to be installed.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SDK is reporting that the reader has started installing a software update.

    + +

    There are two scenarios when a reader’s software update can be installed. Some +updates must be installed immediately, and may be being installed automatically +during connectReader:. Other updates can be delayed, and will be installed +when your integration calls installAvailableUpdate.

    + +

    Required updates will only start installing during connectReader:. Once your app’s +connectReader: completion is called, didStartInstallingUpdate: will only fire +from requests to install via installUpdate:.

    + +

    Note that required updates are critical for the reader to have the +correct configuration and prevent receiving SCPErrorUnsupportedReaderVersion. +Updates that aren’t yet required are reported by reader:didReportUpdateAvailable:.

    +
    +

    See

    +

    https://stripe.com/docs/terminal/readers/bbpos-chipper2xbt#updating-reader-software

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)reader:(nonnull SCPReader *)reader
+    didStartInstallingUpdate:(nonnull SCPReaderSoftwareUpdate *)update
+                  cancelable:(nullable SCPCancelable *)cancelable;
    + +
    +
    +

    Swift

    + 
    func reader(_ reader: SCPReader, didStartInstallingUpdate update: SCPReaderSoftwareUpdate, cancelable: SCPCancelable?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + update + + +
    +

    The SCPReaderSoftwareUpdate with an estimatedUpdateTime that +can be used to communicate how long the update is expected to take.

    +
    +
    + + cancelable + + +
    +

    This cancelable is provided to cancel the +installation if needed. Canceling a required update will result in a failed +connect with error SCPErrorUnsupportedReaderVersion. Incremental only updates will +have a nil cancelable because these updates can not be canceled.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The reader reported progress on a software update.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)reader:(nonnull SCPReader *)reader
+    didReportReaderSoftwareUpdateProgress:(float)progress;
    + +
    +
    +

    Swift

    + 
    func reader(_ reader: SCPReader, didReportReaderSoftwareUpdateProgress progress: Float)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + progress + + +
    +

    An estimate of the progress of the software update +(in the range [0, 1]).

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The reader is reporting that an installation has finished. If the install was +successful, error will be nil.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)reader:(nonnull SCPReader *)reader
+    didFinishInstallingUpdate:(nullable SCPReaderSoftwareUpdate *)update
+                        error:(nullable NSError *)error;
    + +
    +
    +

    Swift

    + 
    func reader(_ reader: SCPReader, didFinishInstallingUpdate update: SCPReaderSoftwareUpdate?, error: Error?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + update + + +
    +

    The update that was being installed, if any. Calls to installAvailableUpdate + when no update is available will still report didFinishInstallingUpdate, but with + a nil update.

    +
    +
    + + error + + +
    +

    If the installed failed, this will describe the error preventing install.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method is called when the reader begins waiting for input. Your app +should prompt the customer to present a payment method using one of the given input +options. If the reader emits a prompt, the didRequestReaderDisplayMessage method +will be called.

    + +

    Use - [SCPTerminal stringFromReaderInputOptions] to get a user facing string for the input +options.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)reader:(nonnull SCPReader *)reader
+    didRequestReaderInput:(SCPReaderInputOptions)inputOptions;
    + +
    +
    +

    Swift

    + 
    func reader(_ reader: SCPReader, didRequestReaderInput inputOptions: ReaderInputOptions = [])
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + inputOptions + + +
    +

    The armed input options on the reader.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method is called to request that a prompt be displayed in your app. +For example, if the prompt is SwipeCard, your app should instruct the +user to present the card again by swiping it.

    + +

    Use - [SCPTerminal stringFromReaderDisplayMessage] to get a user facing string for the prompt.

    +
    +

    See

    +

    SCPReaderDisplayMessage

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)reader:(nonnull SCPReader *)reader
+    didRequestReaderDisplayMessage:(SCPReaderDisplayMessage)displayMessage;
    + +
    +
    +

    Swift

    + 
    func reader(_ reader: SCPReader, didRequestReaderDisplayMessage displayMessage: ReaderDisplayMessage)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + displayMessage + + +
    +

    The message to display to the user.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SDK reported an event from the reader (e.g. a card was inserted).

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)reader:(nonnull SCPReader *)reader
+    didReportReaderEvent:(SCPReaderEvent)event
+                    info:(nullable NSDictionary *)info;
    + +
    +
    +

    Swift

    + 
    optional func reader(_ reader: SCPReader, didReportReaderEvent event: ReaderEvent, info: [AnyHashable : Any]?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + event + + +
    +

    The reader event.

    +
    +
    + + info + + +
    +

    Additional info associated with the event, or nil.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SDK reported the reader’s battery level or charging state has changed.

    +
    +

    See

    +

    SCPBatteryStatus

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)reader:(nonnull SCPReader *)reader
+    didReportBatteryLevel:(float)batteryLevel
+                   status:(SCPBatteryStatus)status
+               isCharging:(BOOL)isCharging;
    + +
    +
    +

    Swift

    + 
    optional func reader(_ reader: SCPReader, didReportBatteryLevel batteryLevel: Float, status: BatteryStatus, isCharging: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + batteryLevel + + +
    +

    The new battery level of the reader, a float from 0.0 to 1.0

    +
    +
    + + status + + +
    +

    The classification of the battery level. - see: SCPBatteryStatus

    +
    +
    + + isCharging + + +
    +

    YES if the reader is plugged in and charging.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method is called when the SDK’s currently connected reader has a low battery.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)readerDidReportLowBatteryWarning:(nonnull SCPReader *)reader;
    + +
    +
    +

    Swift

    + 
    optional func readerDidReportLowBatteryWarning(_ reader: SCPReader)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPConnectionTokenProvider.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPConnectionTokenProvider.html new file mode 100644 index 00000000..4572eccc --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPConnectionTokenProvider.html @@ -0,0 +1,524 @@ + + + + SCPConnectionTokenProvider Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPConnectionTokenProvider Protocol Reference +

+ +
+ +
+ +
+
+

SCPConnectionTokenProvider

+
+
+

Objective-C

+ 
@protocol SCPConnectionTokenProvider
+ +
+
+

Swift

+ 
protocol ConnectionTokenProvider
+ +
+
+

Before integrating the SDK, you should create an endpoint on your backend +server that creates a new connection token via the Stripe Terminal API. The +connection token is used by the SDK to connect to a reader.

+ +

An overview of the lifecycle of a connection token:

+ +
    +
  • When Stripe Terminal is initialized, the SDK attempts to proactively request +an connection token from your backend server.
    • +
  • The SDK uses the connection to connect to a reader.
    • +
  • Subsequent calls to connect require a new connection token. If you disconnect +from a reader, and then call connect again, the SDK will need a new connection +token from your backend server.
    • +
+ +

We suggest making your application’s API client conform to this protocol.

+
+

See

+ https://stripe.com/docs/terminal/sdk/ios#connection-token + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Fetches a connection token from your backend server.

    + +

    On your backend server, use Stripe’s /v1/terminal/connection_tokens endpoint to +create a connection token, and return the connection_token string from the response +to your app. In your app, call the completion block with the connection token, +or an error if fetching the token failed.

    +
    +

    See

    +

    https://stripe.com/docs/api/terminal/connection_tokens/create

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)fetchConnectionToken:
+    (nonnull SCPConnectionTokenCompletionBlock)completion;
    + +
    +
    +

    Swift

    + 
    func fetchConnectionToken() async throws -> String
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    Call this with a connection token, or an error if +creating the connection token failed.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPDiscoveryDelegate.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPDiscoveryDelegate.html new file mode 100644 index 00000000..5858a273 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPDiscoveryDelegate.html @@ -0,0 +1,552 @@ + + + + SCPDiscoveryDelegate Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPDiscoveryDelegate Protocol Reference +

+ +
+ +
+ +
+
+

SCPDiscoveryDelegate

+
+
+

Objective-C

+ 
@protocol SCPDiscoveryDelegate <NSObject>
+ +
+
+

Swift

+ 
protocol DiscoveryDelegate : NSObjectProtocol
+ +
+
+

Implement this protocol to handle a continually updating list +of discovered readers. You must pass an SCPDiscoveryDelegate +when calling -[SCPTerminal discoverReaders:delegate:completion:].

+
+

See

+ https://stripe.com/docs/terminal/readers/connecting + +
+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    This method will be called repeatedly until:

    + + + +

    You should not cache the SCPReader objects in the readers array. In other +words, after calling connectReader: with a discovered reader, you should not +attempt to cache and re-use the Reader object. The connectivity information +associated with the discovered Reader object will become stale. If no readers +have been found didUpdateDiscoveredReaders will be called with an empty +array.

    +

    Bluetooth Scan

    + +

    When discovering a reader using this method, this didUpdateDiscoveredReaders +delegate method will be called multiple times as the Bluetooth scan +proceeds.

    + +

    Your app should display an updating list of discovered readers if +your user is connecting to a reader for the first time.

    + +

    Otherwise, you may automatically select a previously saved reader. +Once a selection has been made, call the connectReader method to begin +connecting to the reader.

    +

    Bluetooth Proximity

    + +

    When discovering a reader using this method, this didUpdateDiscoveredReaders +delegate method will be called once. The reader’s LEDs will begin +flashing.

    +

    Internet

    + +

    When discovering a reader using this method, the didUpdateDiscoveredReaders +delegate method will only be called once. Both readers online and offline will +be sent to didUpdateDiscoveredReaders. Only an online reader can be connected +to, so it will be up to you to check its network status. If you have not +registered any readers to your account didUpdateDiscoveredReaders will be +called with an empty array. Note that this discovery method is currently only +compatable with VerifoneP400.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)terminal:(nonnull SCPTerminal *)terminal
+    didUpdateDiscoveredReaders:(nonnull NSArray<SCPReader *> *)readers;
    + +
    +
    +

    Swift

    + 
    func terminal(_ terminal: Terminal, didUpdateDiscoveredReaders readers: [SCPReader])
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + terminal + + +
    +

    The originating SCPTerminal.

    +
    +
    + + readers + + +
    +

    The discovered readers.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPJSONDecodable.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPJSONDecodable.html new file mode 100644 index 00000000..5a5c39cc --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPJSONDecodable.html @@ -0,0 +1,508 @@ + + + + SCPJSONDecodable Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPJSONDecodable Protocol Reference +

+ +
+ +
+ +
+
+

SCPJSONDecodable

+
+
+

Objective-C

+ 
@protocol SCPJSONDecodable <NSObject>
+ +
+
+

Swift

+ 
protocol JSONDecodable : NSObjectProtocol
+ +
+
+

Objects conforming to this protocol can be instantiated by decoding a JSON +dictionary.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Parses a JSON dictionary into an instance of the class. Returns nil if the +object could not be decoded.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nullable instancetype)decodedObjectFromJSON:(nullable NSDictionary *)json;
    + +
    +
    +

    Swift

    + 
    static func decodedObject(fromJSON json: [AnyHashable : Any]?) -> Self?
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + originalJSON + +
    +
    +
    +
    +
    +
    +

    The raw JSON used to create the object. This may be useful for accessing +fields that haven’t yet been made into properties in the SDK.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) NSDictionary *_Nonnull originalJSON;
    + +
    +
    +

    Swift

    + 
    var originalJSON: [AnyHashable : Any] { get }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPLocalMobileReaderDelegate.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPLocalMobileReaderDelegate.html new file mode 100644 index 00000000..021f453e --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPLocalMobileReaderDelegate.html @@ -0,0 +1,859 @@ + + + + SCPLocalMobileReaderDelegate Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPLocalMobileReaderDelegate Protocol Reference +

+ +
+ +
+ +
+
+

SCPLocalMobileReaderDelegate

+
+
+

Objective-C

+ 
@protocol SCPLocalMobileReaderDelegate <NSObject>
+ +
+
+

Swift

+ 
protocol LocalMobileReaderDelegate : NSObjectProtocol
+ +
+
+

Implement this protocol to handle a connected local mobile reader’s events throughout +the lifetime of its connection.

+ +

Implementing this delegate is required when connecting to any Local Mobile reader.

+ +

The provided delegate must be retained by your application until the reader disconnects.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The reader has started installing a software update.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)localMobileReader:(nonnull SCPReader *)reader
+    didStartInstallingUpdate:(nonnull SCPReaderSoftwareUpdate *)update
+                  cancelable:(nullable SCPCancelable *)cancelable;
    + +
    +
    +

    Swift

    + 
    func localMobileReader(_ reader: SCPReader, didStartInstallingUpdate update: SCPReaderSoftwareUpdate, cancelable: SCPCancelable?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + update + + +
    +

    The SCPReaderSoftwareUpdate with an estimatedUpdateTime that +can be used to communicate how long the update is expected to take.

    +
    +
    + + cancelable + + +
    +

    This cancelable is provided to cancel the +installation if needed. Canceling a required update will result in a failed +connect with error SCPErrorUnsupportedReaderVersion. Some updates will +have a nil cancelable because these updates can not be canceled.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The reader reported progress on a software update.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)localMobileReader:(nonnull SCPReader *)reader
+    didReportReaderSoftwareUpdateProgress:(float)progress;
    + +
    +
    +

    Swift

    + 
    func localMobileReader(_ reader: SCPReader, didReportReaderSoftwareUpdateProgress progress: Float)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + progress + + +
    +

    An estimate of the progress of the software update +(in the range [0.0, 1.0]).

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The reader has finished installing an update.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)localMobileReader:(nonnull SCPReader *)reader
+    didFinishInstallingUpdate:(nullable SCPReaderSoftwareUpdate *)update
+                        error:(nullable NSError *)error;
    + +
    +
    +

    Swift

    + 
    func localMobileReader(_ reader: SCPReader, didFinishInstallingUpdate update: SCPReaderSoftwareUpdate?, error: Error?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + update + + +
    +

    The update that was being installed, if any.

    +
    +
    + + error + + +
    +

    If the installed failed, this will describe the error +preventing install. If it succeeded, the error will be nil.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method is called when the reader begins waiting for input. +Use - [SCPTerminal stringFromReaderInputOptions:] to get a user facing string +for the input options.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)localMobileReader:(nonnull SCPReader *)reader
+    didRequestReaderInput:(SCPReaderInputOptions)inputOptions;
    + +
    +
    +

    Swift

    + 
    func localMobileReader(_ reader: SCPReader, didRequestReaderInput inputOptions: ReaderInputOptions = [])
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + inputOptions + + +
    +

    The armed input options on the reader.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This method is called to request that a prompt be displayed in your app. +Use - [SCPTerminal stringFromReaderDisplayMessage:] to get a user +facing string for the prompt.

    +
    +

    See

    + SCPReaderDisplayMessage + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)localMobileReader:(nonnull SCPReader *)reader
+    didRequestReaderDisplayMessage:(SCPReaderDisplayMessage)displayMessage;
    + +
    +
    +

    Swift

    + 
    func localMobileReader(_ reader: SCPReader, didRequestReaderDisplayMessage displayMessage: ReaderDisplayMessage)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    + + displayMessage + + +
    +

    The message to display to the user.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The reader is reporting that, as part of preparing to accept payments, +the terms of service has been accepted.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)localMobileReaderDidAcceptTermsOfService:(nonnull SCPReader *)reader;
    + +
    +
    +

    Swift

    + 
    optional func localMobileReaderDidAcceptTermsOfService(_ reader: SCPReader)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + reader + + +
    +

    The originating reader.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPReconnectionDelegate.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPReconnectionDelegate.html new file mode 100644 index 00000000..5c6cc982 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPReconnectionDelegate.html @@ -0,0 +1,622 @@ + + + + SCPReconnectionDelegate Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPReconnectionDelegate Protocol Reference +

+ +
+ +
+ +
+
+

SCPReconnectionDelegate

+
+
+

Objective-C

+ 
@protocol SCPReconnectionDelegate <NSObject>
+ +
+
+

Swift

+ 
protocol ReconnectionDelegate : NSObjectProtocol
+ +
+
+

Implement this protocol to handle bluetooth auto-reconnection.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The reader has lost Bluetooth connection to the SDK and reconnection attempts have been started.

    + +

    In your implementation of this method, you should notify your user that +the reader disconnected and that reconnection attempts are being made.

    + +

    Requires autoReconnectOnUnexpectedDisconnect is set to true in the SCPBluetoothConnectionConfig

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)terminal:(nonnull SCPTerminal *)terminal
+    didStartReaderReconnect:(nonnull SCPCancelable *)cancelable;
    + +
    +
    +

    Swift

    + 
    func terminal(_ terminal: Terminal, didStartReaderReconnect cancelable: SCPCancelable)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + terminal + + +
    +

    The originating terminal.

    +
    +
    + + cancelable + + +
    +

    A cancelable that can be used to stop reconnection

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SDK was able to reconnect to the previously connected Bluetooth reader.

    + +

    In your implementation of this method, you should notify your user that +reader connection has been re-established.

    + +

    Requires autoReconnectOnUnexpectedDisconnect is set to true in the SCPBluetoothConnectionConfig

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)terminalDidSucceedReaderReconnect:(nonnull SCPTerminal *)terminal;
    + +
    +
    +

    Swift

    + 
    func terminalDidSucceedReaderReconnect(_ terminal: Terminal)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + terminal + + +
    +

    The originating terminal.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The SDK was not able to reconnect to the previously connected bluetooth reader. The SDK is now disconnected from any readers.

    + +

    In your implementation of this method, you should notify your user that +the reader has disconnected.

    + +

    Requires autoReconnectOnUnexpectedDisconnect is set to true in the SCPBluetoothConnectionConfig

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)terminalDidFailReaderReconnect:(nonnull SCPTerminal *)terminal;
    + +
    +
    +

    Swift

    + 
    func terminalDidFailReaderReconnect(_ terminal: Terminal)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + terminal + + +
    +

    The originating terminal.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPTerminalDelegate.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPTerminalDelegate.html new file mode 100644 index 00000000..659864e3 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPTerminalDelegate.html @@ -0,0 +1,653 @@ + + + + SCPTerminalDelegate Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + SCPTerminalDelegate Protocol Reference +

+ +
+ +
+ +
+
+

SCPTerminalDelegate

+
+
+

Objective-C

+ 
@protocol SCPTerminalDelegate <NSObject>
+ +
+
+

Swift

+ 
protocol TerminalDelegate : NSObjectProtocol
+ +
+
+

Implement this protocol to handle connection and payment updates from the +Stripe Terminal iOS SDK.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    The reader disconnected unexpectedly (that is, without your app explicitly +calling disconnectReader).

    + +

    In your implementation of this method, you should notify your user that +the reader disconnected. You may also want to call discoverReaders to begin +scanning for readers. Your app can attempt to automatically reconnect to the +disconnected reader, or display UI for your user to re-connect to a reader.

    + +

    You can trigger this call in your app by powering off the connected reader.

    +
    +

    See

    +

    https://stripe.com/docs/terminal/readers/connecting

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)terminal:(nonnull SCPTerminal *)terminal
+    didReportUnexpectedReaderDisconnect:(nonnull SCPReader *)reader;
    + +
    +
    +

    Swift

    + 
    func terminal(_ terminal: Terminal, didReportUnexpectedReaderDisconnect reader: SCPReader)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + terminal + + +
    +

    The originating terminal.

    +
    +
    + + reader + + +
    +

    The previously connected reader.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The currently connected reader’s connectionStatus changed.

    + +

    You should not use this method to detect when a reader unexpectedly +disconnects from your app, as it cannot be used to accurately distinguish +between expected and unexpected disconnect events. To detect unexpect +disconnects (e.g. to automatically notify your user), you should instead use +the -[SCPTerminalDelegate terminal:didReportUnexpectedReaderDisconnect:] method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)terminal:(nonnull SCPTerminal *)terminal
+    didChangeConnectionStatus:(SCPConnectionStatus)status;
    + +
    +
    +

    Swift

    + 
    optional func terminal(_ terminal: Terminal, didChangeConnectionStatus status: ConnectionStatus)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + terminal + + +
    +

    The originating terminal.

    +
    +
    + + status + + +
    +

    The SDK’s new connection status.

    +
    +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The currently connected reader’s paymentStatus changed.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)terminal:(nonnull SCPTerminal *)terminal
+    didChangePaymentStatus:(SCPPaymentStatus)status;
    + +
    +
    +

    Swift

    + 
    optional func terminal(_ terminal: Terminal, didChangePaymentStatus status: PaymentStatus)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + terminal + + +
    +

    The originating terminal.

    +
    +
    + + status + + +
    +

    The SDK’s new payment status.

    +
    +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Reader Discovery & Connection.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Reader Discovery & Connection.html new file mode 100644 index 00000000..5b3f7fd0 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Reader Discovery & Connection.html @@ -0,0 +1,1023 @@ + + + + Reader Discovery & Connection Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + Reader Discovery & Connection Reference +

+ +
+ +
+ +
+
+

Reader Discovery & Connection

+ +
+
+ +
+
+
+
    +
  • +
    + + + + SCPDiscoveryMethod + +
    +
    +
    +
    +
    +
    +

    The possible methods for discovering a reader. Pass a variant of this enum +into your SCPDiscoveryConfiguration.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers/connecting + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPDiscoveryMethod : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum DiscoveryMethod : UInt, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPDiscoveryDelegate + +
    +
    +
    +
    +
    +
    +

    Implement this protocol to handle a continually updating list +of discovered readers. You must pass an SCPDiscoveryDelegate +when calling -[SCPTerminal discoverReaders:delegate:completion:].

    +
    +

    See

    + https://stripe.com/docs/terminal/readers/connecting + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @protocol SCPDiscoveryDelegate <NSObject>
    + +
    +
    +

    Swift

    + 
    protocol DiscoveryDelegate : NSObjectProtocol
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Configuration options for discovering readers.

    + +

    Objects of this type get passed into the Terminal.shared.discoverReaders() +method to control which devices get discovered, and how.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers/connecting + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPDiscoveryConfiguration : NSObject
    + +
    +
    +

    Swift

    + 
    class DiscoveryConfiguration : NSObject
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This class lets you define Bluetooth reader connection options.

    + +

    An object of this class should get passed into Terminal.shared.connectBluetoothReader().

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPBluetoothConnectionConfiguration : SCPConnectionConfiguration
    + +
    +
    +

    Swift

    + 
    class BluetoothConnectionConfiguration : ConnectionConfiguration
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This class lets you set options that define internet reader behavior throughout a given +reader-to-SDK connection session.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPInternetConnectionConfiguration : SCPConnectionConfiguration
    + +
    +
    +

    Swift

    + 
    class InternetConnectionConfiguration : ConnectionConfiguration
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    This class lets you set options that define local mobile reader behavior throughout a given +reader-to-SDK connection session.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPLocalMobileConnectionConfiguration : SCPConnectionConfiguration
    + +
    +
    +

    Swift

    + 
    class LocalMobileConnectionConfiguration : ConnectionConfiguration
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPConnectionStatus + +
    +
    +
    +
    +
    +
    +

    The possible reader connection statuses for the SDK.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers/connecting + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPConnectionStatus : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum ConnectionStatus : UInt, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Parameters to be used when calling Terminal.shared.listLocations() to list +the Location objects associated with an account.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers/connecting + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPListLocationsParameters : NSObject
    + +
    +
    +

    Swift

    + 
    class ListLocationsParameters : NSObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPLocation + +
    +
    +
    +
    +
    +
    +

    A Location is used to group readers in the Stripe Terminal ecosystem. The +Location to which a reader is registered can control regional behavior +for that particular reader.

    + +

    You cannot create locations through the SDK. Instead, use the Stripe API +from your backend to manage your account’s locations.

    + +

    To fetch the Location objects associated with your account, call +Terminal.shared.listLocations().

    +
    +

    See

    + https://stripe.com/docs/api/terminal/locations + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPLocation : NSObject <SCPJSONDecodable>
    + +
    +
    +

    Swift

    + 
    class Location : NSObject, JSONDecodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPLocationStatus + +
    +
    +
    +
    +
    +
    +

    Represents the possible states of the location object for a +discovered reader.

    +
    +

    See

    + SCPReader + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPLocationStatus : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum LocationStatus : UInt, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPAddress + +
    +
    +
    +
    +
    +
    +

    Holds address data associated with a given SCPLocation.

    + +

    You cannot create SCPAddress objects from within the SDK. Instead, they will +be returned as an address property on an SCPLocation object retrieved +by the SDK.

    +
    +

    See

    + https://stripe.com/docs/api/terminal/locations/object#terminal_location_object-address + +
    +

    See

    + SCPLocation + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPAddress : NSObject <SCPJSONDecodable>
    + +
    +
    +

    Swift

    + 
    class Address : NSObject, JSONDecodable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Simulator specific configurations you can set to test your integration’s +behavior in different scenarios. We recommend changing these properties during +testing to ensure your app works as expected for different reader updates +and for different presented cards.

    + +

    Do not create new instances of this class. Instead, set the properties via +SCPTerminal.shared.simulatorConfiguration.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPSimulatorConfiguration : NSObject
    + +
    +
    +

    Swift

    + 
    class SimulatorConfiguration : NSObject
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Enum used to simulate various types of reader updates being available for +a simulated bluetooth or local mobile reader.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPSimulateReaderUpdate : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum SimulateReaderUpdate : UInt, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPSimulatedCard + +
    +
    +
    +
    +
    +
    +

    Simulated Card objects can be used with the shared SCPSimulatorConfiguration +to simulate different card brand and error cases with a simulated Reader.

    + +

    Simulated Card objects are backed by one of Stripe’s test card numbers, which +are hardcoded to provide certain behavior within Stripe’s backend. The +Terminal SDK provides an SCPSimulatedCardType enum that automatically maps +to the card numbers for convenience.

    +
    +

    See

    + https://stripe.com/docs/terminal/testing#simulated-test-cards + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPSimulatedCard : NSObject
    + +
    +
    +

    Swift

    + 
    class SimulatedCard : NSObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPSimulatedCardType + +
    +
    +
    +
    +
    +
    +

    Enum used to simulate various types of cards and error cases.

    +
    +

    See

    + https://stripe.com/docs/terminal/testing#simulated-test-cards + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPSimulatedCardType : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum SimulatedCardType : UInt, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Reader Updates.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Reader Updates.html new file mode 100644 index 00000000..9b5a9e44 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Reader Updates.html @@ -0,0 +1,560 @@ + + + + Reader Updates Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + Reader Updates Reference +

+ +
+ +
+ +
+
+

Reader Updates

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Reader.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Reader.html new file mode 100644 index 00000000..d62be28f --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Reader.html @@ -0,0 +1,842 @@ + + + + Reader Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + Reader Reference +

+ +
+ +
+ +
+
+

Reader

+ +
+
+ +
+
+
+
    +
  • +
    + + + + SCPReader + +
    +
    +
    +
    +
    +
    +

    Information about a card reader that has been discovered by or connected to +the SDK.

    + +

    Some of the properties are only applicable to a certain device type. +These properties are labeled with the reader or reader type to which they apply.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPReader : NSObject <SCPJSONDecodable>
    + +
    +
    +

    Swift

    + 
    class Reader : NSObject, JSONDecodable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPDeviceType + +
    +
    +
    +
    +
    +
    +

    The possible device types for a reader.

    +
    +

    See

    + https://stripe.com/docs/terminal/readers + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPDeviceType : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum DeviceType : UInt, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Implement this protocol to handle a connected Bluetooth reader’s events throughout +the lifetime of its connection.

    + +

    Implementing this delegate is required when connecting to any Bluetooth connected +reader, such as the Chipper 2X BT and the WisePad 3.

    + +

    The provided delegate must be retained by your application until the reader disconnects.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @protocol SCPBluetoothReaderDelegate <NSObject>
    + +
    +
    +

    Swift

    + 
    protocol BluetoothReaderDelegate : NSObjectProtocol
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Implement this protocol to handle a connected local mobile reader’s events throughout +the lifetime of its connection.

    + +

    Implementing this delegate is required when connecting to any Local Mobile reader.

    + +

    The provided delegate must be retained by your application until the reader disconnects.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @protocol SCPLocalMobileReaderDelegate <NSObject>
    + +
    +
    +

    Swift

    + 
    protocol LocalMobileReaderDelegate : NSObjectProtocol
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPReaderEvent + +
    +
    +
    +
    +
    +
    +

    The possible events from a connected reader. Used by [SCPBluetoothReaderDelegate reader:didReportReaderEvent:info:].

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPReaderEvent : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum ReaderEvent : UInt, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPReaderInputOptions + +
    +
    +
    +
    +
    +
    +

    This OptionSet represents all of the input methods available to your user when +the reader begins waiting for input. Used by [SCPBluetoothReaderDelegate reader:didRequestReaderInput:].

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPReaderInputOptions : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    struct ReaderInputOptions : OptionSet, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The display messages that a reader may request be displayed by your app. Used by [SCPBluetoothReaderDelegate reader:didRequestReaderDisplayMessage:].

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPReaderDisplayMessage : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum ReaderDisplayMessage : UInt, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The possible networking statuses for a reader.

    +
    +

    See

    + https://stripe.com/docs/api/terminal/readers/object + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPReaderNetworkStatus : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum ReaderNetworkStatus : UInt, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPBatteryStatus + +
    +
    +
    +
    +
    +
    +

    A categorization of a reader’s battery charge level.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPBatteryStatus : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum BatteryStatus : UInt, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPCart + +
    +
    +
    +
    +
    +
    +

    An SCPCart object contains information about what line items are included in +the current transaction. A cart object should be created and then passed into +Terminal.shared.setReaderDisplay(), which will display the cart’s contents +on the reader’s screen.

    + +

    The SCPCart only represents exactly what will be shown on the screen, and is +not reflective of what the customer is actually charged. You are +responsible for making sure that tax and total reflect what is in the cart.

    +
    +

    Note

    +

    Only Internet readers support setReaderDisplay functionality

    + +
    +

    See

    +

    https://stripe.com/docs/terminal/checkout/cart-display

    + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPCart : NSObject
    + +
    +
    +

    Swift

    + 
    class Cart : NSObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPCartLineItem + +
    +
    +
    +
    +
    +
    +

    Represents a single line item in an SCPCart, displayed on the reader’s screen +during checkout.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPCartLineItem : NSObject
    + +
    +
    +

    Swift

    + 
    class CartLineItem : NSObject
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Saving Cards.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Saving Cards.html new file mode 100644 index 00000000..670b4327 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Saving Cards.html @@ -0,0 +1,798 @@ + + + + Saving Cards Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + Saving Cards Reference +

+ +
+ +
+ +
+
+

Saving Cards

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Terminal.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Terminal.html new file mode 100644 index 00000000..5bc370ad --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/Terminal.html @@ -0,0 +1,734 @@ + + + + Terminal Reference + + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + Terminal Reference +

+ +
+ +
+ +
+
+

Terminal

+ +
+
+ +
+
+
+
    +
  • +
    + + + + SCPTerminal + +
    +
    +
    +
    +
    +
    +

    The SCPTerminal singleton object exposes an interface for discovering readers, +connecting to a reader, creating payments, and saving card information for later +use.

    + +

    Before accessing the singleton object using the shared property, you must set +a ConnectionToken provider: an object that implements the SCPConnectionTokenProvider +protocol. This object should authenticate with your backend, then fetch the secret +from a freshly minted ConnectionToken.

    + +

    The SCPTerminal singleton can only be connected to one reader at a time, and +can only perform one operation at a time. As a general rule, make sure the +completion handler of one operation has been called before calling another +operation from within your app.

    + +

    The Stripe Terminal SDK sends updates to your app by using the delegate pattern. +You may want multiple views in your app to respond to these delegate calls. +We recommend creating a central delegate announcer which broadcasts all delegate +calls to views and ViewControllers that register themselves with that announcer. +We have an example implementation of a TerminalDelegateAnnouncer as part of our +example application.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPTerminal : NSObject
    + +
    +
    +

    Swift

    + 
    class Terminal : NSObject
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Before integrating the SDK, you should create an endpoint on your backend +server that creates a new connection token via the Stripe Terminal API. The +connection token is used by the SDK to connect to a reader.

    + +

    An overview of the lifecycle of a connection token:

    + +
      +
    • When Stripe Terminal is initialized, the SDK attempts to proactively request +an connection token from your backend server.
      • +
    • The SDK uses the connection to connect to a reader.
      • +
    • Subsequent calls to connect require a new connection token. If you disconnect +from a reader, and then call connect again, the SDK will need a new connection +token from your backend server.
      • +
    + +

    We suggest making your application’s API client conform to this protocol.

    +
    +

    See

    + https://stripe.com/docs/terminal/sdk/ios#connection-token + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @protocol SCPConnectionTokenProvider
    + +
    +
    +

    Swift

    + 
    protocol ConnectionTokenProvider
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPTerminalDelegate + +
    +
    +
    +
    +
    +
    +

    Implement this protocol to handle connection and payment updates from the +Stripe Terminal iOS SDK.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @protocol SCPTerminalDelegate <NSObject>
    + +
    +
    +

    Swift

    + 
    protocol TerminalDelegate : NSObjectProtocol
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Implement this protocol to handle bluetooth auto-reconnection.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @protocol SCPReconnectionDelegate <NSObject>
    + +
    +
    +

    Swift

    + 
    protocol ReconnectionDelegate : NSObjectProtocol
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPLogLevel + +
    +
    +
    +
    +
    +
    +

    The various log levels for the SDK.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum SCPLogLevel : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum LogLevel : UInt, @unchecked Sendable
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPCancelable + +
    +
    +
    +
    +
    +
    +

    An object representing an action that can be canceled.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    
+@interface SCPCancelable : NSObject
    + +
    +
    +

    Swift

    + 
    class Cancelable : NSObject
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPJSONDecodable + +
    +
    +
    +
    +
    +
    +

    Objects conforming to this protocol can be instantiated by decoding a JSON +dictionary.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @protocol SCPJSONDecodable <NSObject>
    + +
    +
    +

    Swift

    + 
    protocol JSONDecodable : NSObjectProtocol
    + +
    +
    +
    +
    +
    • +
  • +
    + + + + SCPSDKVersion + +
    +
    +
    +
    +
    +
    +

    The current version of this library.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    static NSString *const _Nonnull SCPSDKVersion = @"2.19.0"
    + +
    +
    +

    Swift

    + 
    let SCPSDKVersion: String
    + +
    +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/css/highlight.css b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/css/highlight.css new file mode 100644 index 00000000..c170357c --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/css/highlight.css @@ -0,0 +1,202 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ +/* Credit to https://gist.github.com/wataru420/2048287 */ +.highlight .c { + color: #999988; + font-style: italic; } + +.highlight .err { + color: #a61717; + background-color: #e3d2d2; } + +.highlight .k { + color: #000000; + font-weight: bold; } + +.highlight .o { + color: #000000; + font-weight: bold; } + +.highlight .cm { + color: #999988; + font-style: italic; } + +.highlight .cp { + color: #999999; + font-weight: bold; } + +.highlight .c1 { + color: #999988; + font-style: italic; } + +.highlight .cs { + color: #999999; + font-weight: bold; + font-style: italic; } + +.highlight .gd { + color: #000000; + background-color: #ffdddd; } + +.highlight .gd .x { + color: #000000; + background-color: #ffaaaa; } + +.highlight .ge { + color: #000000; + font-style: italic; } + +.highlight .gr { + color: #aa0000; } + +.highlight .gh { + color: #999999; } + +.highlight .gi { + color: #000000; + background-color: #ddffdd; } + +.highlight .gi .x { + color: #000000; + background-color: #aaffaa; } + +.highlight .go { + color: #888888; } + +.highlight .gp { + color: #555555; } + +.highlight .gs { + font-weight: bold; } + +.highlight .gu { + color: #aaaaaa; } + +.highlight .gt { + color: #aa0000; } + +.highlight .kc { + color: #000000; + font-weight: bold; } + +.highlight .kd { + color: #000000; + font-weight: bold; } + +.highlight .kp { + color: #000000; + font-weight: bold; } + +.highlight .kr { + color: #000000; + font-weight: bold; } + +.highlight .kt { + color: #445588; } + +.highlight .m { + color: #009999; } + +.highlight .s { + color: #d14; } + +.highlight .na { + color: #008080; } + +.highlight .nb { + color: #0086B3; } + +.highlight .nc { + color: #445588; + font-weight: bold; } + +.highlight .no { + color: #008080; } + +.highlight .ni { + color: #800080; } + +.highlight .ne { + color: #990000; + font-weight: bold; } + +.highlight .nf { + color: #990000; } + +.highlight .nn { + color: #555555; } + +.highlight .nt { + color: #000080; } + +.highlight .nv { + color: #008080; } + +.highlight .ow { + color: #000000; + font-weight: bold; } + +.highlight .w { + color: #bbbbbb; } + +.highlight .mf { + color: #009999; } + +.highlight .mh { + color: #009999; } + +.highlight .mi { + color: #009999; } + +.highlight .mo { + color: #009999; } + +.highlight .sb { + color: #d14; } + +.highlight .sc { + color: #d14; } + +.highlight .sd { + color: #d14; } + +.highlight .s2 { + color: #d14; } + +.highlight .se { + color: #d14; } + +.highlight .sh { + color: #d14; } + +.highlight .si { + color: #d14; } + +.highlight .sx { + color: #d14; } + +.highlight .sr { + color: #009926; } + +.highlight .s1 { + color: #d14; } + +.highlight .ss { + color: #990073; } + +.highlight .bp { + color: #999999; } + +.highlight .vc { + color: #008080; } + +.highlight .vg { + color: #008080; } + +.highlight .vi { + color: #008080; } + +.highlight .il { + color: #009999; } diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/css/jazzy.css b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/css/jazzy.css new file mode 100644 index 00000000..c7bb9fe2 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/css/jazzy.css @@ -0,0 +1,404 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ +*, *:before, *:after { + box-sizing: inherit; } + +body { + margin: 0; + background: #fff; + color: #333; + font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif; + letter-spacing: .2px; + -webkit-font-smoothing: antialiased; + box-sizing: border-box; } + +h1 { + font-size: 2rem; + font-weight: 700; + margin: 1.275em 0 0.6em; } + +h2 { + font-size: 1.75rem; + font-weight: 700; + margin: 1.275em 0 0.3em; } + +h3 { + font-size: 1.5rem; + font-weight: 700; + margin: 1em 0 0.3em; } + +h4 { + font-size: 1.25rem; + font-weight: 700; + margin: 1.275em 0 0.85em; } + +h5 { + font-size: 1rem; + font-weight: 700; + margin: 1.275em 0 0.85em; } + +h6 { + font-size: 1rem; + font-weight: 700; + margin: 1.275em 0 0.85em; + color: #777; } + +p { + margin: 0 0 1em; } + +ul, ol { + padding: 0 0 0 2em; + margin: 0 0 0.85em; } + +blockquote { + margin: 0 0 0.85em; + padding: 0 15px; + color: #858585; + border-left: 4px solid #e5e5e5; } + +img { + max-width: 100%; } + +a { + color: #4183c4; + text-decoration: none; } + a:hover, a:focus { + outline: 0; + text-decoration: underline; } + a.discouraged { + text-decoration: line-through; } + a.discouraged:hover, a.discouraged:focus { + text-decoration: underline line-through; } + +table { + background: #fff; + width: 100%; + border-collapse: collapse; + border-spacing: 0; + overflow: auto; + margin: 0 0 0.85em; } + +tr:nth-child(2n) { + background-color: #fbfbfb; } + +th, td { + padding: 6px 13px; + border: 1px solid #ddd; } + +hr { + height: 1px; + border: none; + background-color: #ddd; } + +pre { + margin: 0 0 1.275em; + padding: .85em 1em; + overflow: auto; + background: #f7f7f7; + font-size: .85em; + font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace; } + +code { + font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace; } + +.item-container p > code, .item-container li > code, .top-matter p > code, .top-matter li > code { + background: #f7f7f7; + padding: .2em; } + .item-container p > code:before, .item-container p > code:after, .item-container li > code:before, .item-container li > code:after, .top-matter p > code:before, .top-matter p > code:after, .top-matter li > code:before, .top-matter li > code:after { + letter-spacing: -.2em; + content: "\00a0"; } + +pre code { + padding: 0; + white-space: pre; } + +.content-wrapper { + display: flex; + flex-direction: column; } + @media (min-width: 768px) { + .content-wrapper { + flex-direction: row; } } +.header { + display: flex; + padding: 8px; + font-size: 0.875em; + background: #444; + color: #999; } + +.header-col { + margin: 0; + padding: 0 8px; } + +.header-col--primary { + flex: 1; } + +.header-link { + color: #fff; } + +.header-icon { + padding-right: 2px; + vertical-align: -3px; + height: 16px; } + +.breadcrumbs { + font-size: 0.875em; + padding: 8px 16px; + margin: 0; + background: #fbfbfb; + border-bottom: 1px solid #ddd; } + +.carat { + height: 10px; + margin: 0 5px; } + +.navigation { + order: 2; } + @media (min-width: 768px) { + .navigation { + order: 1; + width: 25%; + max-width: 300px; + padding-bottom: 64px; + overflow: hidden; + word-wrap: normal; + background: #fbfbfb; + border-right: 1px solid #ddd; } } +.nav-groups { + list-style-type: none; + padding-left: 0; } + +.nav-group-name { + border-bottom: 1px solid #ddd; + padding: 8px 0 8px 16px; } + +.nav-group-name-link { + color: #333; } + +.nav-group-tasks { + margin: 8px 0; + padding: 0 0 0 8px; } + +.nav-group-task { + font-size: 1em; + list-style-type: none; + white-space: nowrap; } + +.nav-group-task-link { + color: #808080; } + +.main-content { + order: 1; } + @media (min-width: 768px) { + .main-content { + order: 2; + flex: 1; + padding-bottom: 60px; } } +.section { + padding: 0 32px; + border-bottom: 1px solid #ddd; } + +.section-content { + max-width: 834px; + margin: 0 auto; + padding: 16px 0; } + +.section-name { + color: #666; + display: block; } + .section-name p { + margin-bottom: inherit; } + +.declaration .highlight { + overflow-x: initial; + padding: 8px 0; + margin: 0; + background-color: transparent; + border: none; } + +.task-group-section { + border-top: 1px solid #ddd; } + +.task-group { + padding-top: 0px; } + +.task-name-container a[name]:before { + content: ""; + display: block; } + +.section-name-container { + position: relative; } + .section-name-container .section-name-link { + position: absolute; + top: 0; + left: 0; + bottom: 0; + right: 0; + margin-bottom: 0; } + .section-name-container .section-name { + position: relative; + pointer-events: none; + z-index: 1; } + .section-name-container .section-name a { + pointer-events: auto; } + +.item-container { + padding: 0; } + +.item { + padding-top: 8px; + width: 100%; + list-style-type: none; } + .item a[name]:before { + content: ""; + display: block; } + .item .token, .item .direct-link { + display: inline-block; + text-indent: -20px; + padding-left: 3px; + margin-left: 20px; + font-size: 1rem; } + .item .declaration-note { + font-size: .85em; + color: #808080; + font-style: italic; } + +.pointer-container { + border-bottom: 1px solid #ddd; + left: -23px; + padding-bottom: 13px; + position: relative; + width: 110%; } + +.pointer { + left: 21px; + top: 7px; + display: block; + position: absolute; + width: 12px; + height: 12px; + border-left: 1px solid #ddd; + border-top: 1px solid #ddd; + background: #fff; + transform: rotate(45deg); } + +.height-container { + display: none; + position: relative; + width: 100%; + overflow: hidden; } + .height-container .section { + background: #fff; + border: 1px solid #ddd; + border-top-width: 0; + padding-top: 10px; + padding-bottom: 5px; + padding: 8px 16px; } + +.aside, .language { + padding: 6px 12px; + margin: 12px 0; + border-left: 5px solid #dddddd; + overflow-y: hidden; } + .aside .aside-title, .language .aside-title { + font-size: 9px; + letter-spacing: 2px; + text-transform: uppercase; + padding-bottom: 0; + margin: 0; + color: #aaa; + -webkit-user-select: none; } + .aside p:last-child, .language p:last-child { + margin-bottom: 0; } + +.language { + border-left: 5px solid #cde9f4; } + .language .aside-title { + color: #4183c4; } + +.aside-warning, .aside-deprecated, .aside-unavailable { + border-left: 5px solid #ff6666; } + .aside-warning .aside-title, .aside-deprecated .aside-title, .aside-unavailable .aside-title { + color: #ff0000; } + +.graybox { + border-collapse: collapse; + width: 100%; } + .graybox p { + margin: 0; + word-break: break-word; + min-width: 50px; } + .graybox td { + border: 1px solid #ddd; + padding: 5px 25px 5px 10px; + vertical-align: middle; } + .graybox tr td:first-of-type { + text-align: right; + padding: 7px; + vertical-align: top; + word-break: normal; + width: 40px; } + +.slightly-smaller { + font-size: 0.9em; } + +.footer { + padding: 8px 16px; + background: #444; + color: #ddd; + font-size: 0.8em; } + .footer p { + margin: 8px 0; } + .footer a { + color: #fff; } + +html.dash .header, html.dash .breadcrumbs, html.dash .navigation { + display: none; } + +html.dash .height-container { + display: block; } + +form[role=search] input { + font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif; + font-size: 14px; + line-height: 24px; + padding: 0 10px; + margin: 0; + border: none; + border-radius: 1em; } + .loading form[role=search] input { + background: white url(../img/spinner.gif) center right 4px no-repeat; } + +form[role=search] .tt-menu { + margin: 0; + min-width: 300px; + background: #fbfbfb; + color: #333; + border: 1px solid #ddd; } + +form[role=search] .tt-highlight { + font-weight: bold; } + +form[role=search] .tt-suggestion { + font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif; + padding: 0 8px; } + form[role=search] .tt-suggestion span { + display: table-cell; + white-space: nowrap; } + form[role=search] .tt-suggestion .doc-parent-name { + width: 100%; + text-align: right; + font-weight: normal; + font-size: 0.9em; + padding-left: 16px; } + +form[role=search] .tt-suggestion:hover, +form[role=search] .tt-suggestion.tt-cursor { + cursor: pointer; + background-color: #4183c4; + color: #fff; } + +form[role=search] .tt-suggestion:hover .doc-parent-name, +form[role=search] .tt-suggestion.tt-cursor .doc-parent-name { + color: #fff; } diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/img/carat.png b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/img/carat.png new file mode 100755 index 00000000..29d2f7fd Binary files /dev/null and b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/img/carat.png differ diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/img/dash.png b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/img/dash.png new file mode 100755 index 00000000..6f694c7a Binary files /dev/null and b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/img/dash.png differ diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/img/spinner.gif b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/img/spinner.gif new file mode 100644 index 00000000..e3038d0a Binary files /dev/null and b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/img/spinner.gif differ diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/index.html b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/index.html new file mode 100644 index 00000000..46c00a9f --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/index.html @@ -0,0 +1,530 @@ + + + + StripeTerminal Reference + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + StripeTerminal Reference +

+ +
+ +
+ +
+
+ +

Stripe Terminal iOS SDK

+ +

Stripe Terminal enables you to build your own in-person checkout to accept payments in the physical world. Built on Stripe’s payments network, Terminal helps you unify your online and offline payment channels. With the Stripe Terminal iOS SDK, you can connect to pre-certified card readers from your iOS app and drive a customized in-store checkout flow.

+ +

Get started with our integration guides and sample integration, or browse the SDK reference documentation.

+ +
+

Upgrading from an older version of the SDK? See our migration guide for guidance.

+
+

Requirements

+ +

The Stripe Terminal iOS SDK is compatible with apps supporting iOS 11 and above.

+

Try the example app

+ +

The iOS SDK includes an open-source example app, which you can use to familiarize yourself with the SDK and reader before starting your own integration.

+ +

To build the example app from source, you’ll need to:

+ +
    +
  1. Navigate to the Example folder, and open Example.xcworkspace (make sure to open the .xcworkspace and not the .xcodeproj).
    2. +
  2. Navigate to our example backend and click the button to deploy it on Heroku.
    3. +
  3. In AppDelegate.swift, set the URL of the Heroku app you just deployed.
    4. +
  4. Build and run the app. The SDK comes with a simple reader simulator, so you can get started without any physical hardware.
    5. +
+

Installation

+ +

We support CocoaPods and Swift Package Manager. If you prefer to install the library manually, please use the latest version from our releases page.

+

Swift Package Manager

+ +

In Xcode, select File > Swift Packages > Add Package Dependency and enter https://github.com/stripe/stripe-terminal-ios

+

CocoaPods

+ +
    +

  1. If you haven’t already, install the latest version of CocoaPods.

    2. +

  2. Add this line to your Podfile:

    +
    pod 'StripeTerminal', '~> 2.0'
+
    3. +

  3. Run the following command:

    +
    pod install
+
    4. +
+ +

From now on, don’t forget to use the *.xcworkspace file to open your project in Xcode, instead of the .xcodeproj file.

+ +

In the future, to update to the latest compatible version of the SDK, just run:

+
pod update StripeTerminal
+
+

Manual

+ +
    +

  1. Navigate to our releases page, download StripeTerminal.xcframework.zip, and unzip it.

    2. +

  2. Drag StripeTerminal.xcframework to the Frameworks, Libraries, and Embedded Content section of your Xcode project’s General settings. Make sure to select “Copy items if needed”.

    3. +
+ +

When new versions of the SDK are released, repeat the above steps to update your installation.

+

Configure your app

+ +

Location services must be enabled in order to use the iOS SDK. Add the following key-value pair to your app’s Info.plist file:

+ +
    +
  • Privacy - Location When In Use Usage Description + +
      +
    • Key: NSLocationWhenInUseUsageDescription
      • +
    • Value: “Location access is required in order to accept payments.”
      • +
    • +
+
+

Note

+

Stripe needs to know where payments occur to reduce risks associated with those charges and to minimize disputes. If the SDK can’t determine the iOS device’s location, payments are disabled until location access is restored.

+ +
+ +

For your app to run in the background and remain connected to the reader, add this key-value pair to your Info.plist file:

+ +
    +
  • Required background modes + +
      +
    • Key: UIBackgroundModes
      • +
    • Value: bluetooth-central (Uses Bluetooth LE accessories)
      • +
    +

    Note

    + Note the value is actually an array that you will need to add bluetooth-central to. + +
    • +
+ +

For your app to pass validation when submitting to the App Store, add the following key-value pairs as well:

+ +
    +
  • Privacy - Bluetooth Peripheral Usage Description + +
      +
    • Key: NSBluetoothPeripheralUsageDescription
      • +
    • Value: “Bluetooth access is required in order to connect to supported bluetooth card readers.”
      • +
    • +
  • Privacy - Bluetooth Always Usage Description + +
      +
    • Key: NSBluetoothAlwaysUsageDescription
      • +
    • Value: “This app uses Bluetooth to connect to supported card readers.”
      • +
    • +
+

Previous API References

+ +

We maintain archives of the SDK’s API reference for older versions of the SDK.

+ + + +
+
+ + +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/js/jazzy.js b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/js/jazzy.js new file mode 100755 index 00000000..19844166 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/js/jazzy.js @@ -0,0 +1,74 @@ +// Jazzy - https://github.com/realm/jazzy +// Copyright Realm Inc. +// SPDX-License-Identifier: MIT + +window.jazzy = {'docset': false} +if (typeof window.dash != 'undefined') { + document.documentElement.className += ' dash' + window.jazzy.docset = true +} +if (navigator.userAgent.match(/xcode/i)) { + document.documentElement.className += ' xcode' + window.jazzy.docset = true +} + +function toggleItem($link, $content) { + var animationDuration = 300; + $link.toggleClass('token-open'); + $content.slideToggle(animationDuration); +} + +function itemLinkToContent($link) { + return $link.parent().parent().next(); +} + +// On doc load + hash-change, open any targetted item +function openCurrentItemIfClosed() { + if (window.jazzy.docset) { + return; + } + var $link = $(`a[name="${location.hash.substring(1)}"]`).nextAll('.token'); + $content = itemLinkToContent($link); + if ($content.is(':hidden')) { + toggleItem($link, $content); + } +} + +$(openCurrentItemIfClosed); +$(window).on('hashchange', openCurrentItemIfClosed); + +// On item link ('token') click, toggle its discussion +$('.token').on('click', function(event) { + if (window.jazzy.docset) { + return; + } + var $link = $(this); + toggleItem($link, itemLinkToContent($link)); + + // Keeps the document from jumping to the hash. + var href = $link.attr('href'); + if (history.pushState) { + history.pushState({}, '', href); + } else { + location.hash = href; + } + event.preventDefault(); +}); + +// Clicks on links to the current, closed, item need to open the item +$("a:not('.token')").on('click', function() { + if (location == this.href) { + openCurrentItemIfClosed(); + } +}); + +// KaTeX rendering +if ("katex" in window) { + $($('.math').each( (_, element) => { + katex.render(element.textContent, element, { + displayMode: $(element).hasClass('m-block'), + throwOnError: false, + trust: true + }); + })) +} diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/js/jazzy.search.js b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/js/jazzy.search.js new file mode 100644 index 00000000..359cdbb8 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/js/jazzy.search.js @@ -0,0 +1,74 @@ +// Jazzy - https://github.com/realm/jazzy +// Copyright Realm Inc. +// SPDX-License-Identifier: MIT + +$(function(){ + var $typeahead = $('[data-typeahead]'); + var $form = $typeahead.parents('form'); + var searchURL = $form.attr('action'); + + function displayTemplate(result) { + return result.name; + } + + function suggestionTemplate(result) { + var t = '
'; + t += '' + result.name + ''; + if (result.parent_name) { + t += '' + result.parent_name + ''; + } + t += '
'; + return t; + } + + $typeahead.one('focus', function() { + $form.addClass('loading'); + + $.getJSON(searchURL).then(function(searchData) { + const searchIndex = lunr(function() { + this.ref('url'); + this.field('name'); + this.field('abstract'); + for (const [url, doc] of Object.entries(searchData)) { + this.add({url: url, name: doc.name, abstract: doc.abstract}); + } + }); + + $typeahead.typeahead( + { + highlight: true, + minLength: 3, + autoselect: true + }, + { + limit: 10, + display: displayTemplate, + templates: { suggestion: suggestionTemplate }, + source: function(query, sync) { + const lcSearch = query.toLowerCase(); + const results = searchIndex.query(function(q) { + q.term(lcSearch, { boost: 100 }); + q.term(lcSearch, { + boost: 10, + wildcard: lunr.Query.wildcard.TRAILING + }); + }).map(function(result) { + var doc = searchData[result.ref]; + doc.url = result.ref; + return doc; + }); + sync(results); + } + } + ); + $form.removeClass('loading'); + $typeahead.trigger('focus'); + }); + }); + + var baseURL = searchURL.slice(0, -"search.json".length); + + $typeahead.on('typeahead:select', function(e, result) { + window.location = baseURL + result.url; + }); +}); diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/js/jquery.min.js b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/js/jquery.min.js new file mode 100644 index 00000000..2c69bc90 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/js/jquery.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.1 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,y=n.hasOwnProperty,a=y.toString,l=a.call(Object),v={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.1",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&v(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!y||!y.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ve(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace(B,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ye(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ve(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],y=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&y.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||y.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||y.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||y.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||y.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||y.push(".#.+[+~]"),e.querySelectorAll("\\\f"),y.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&y.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&y.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&y.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),y.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),y=y.length&&new RegExp(y.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),v=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&v(p,e)?-1:t==C||t.ownerDocument==p&&v(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!y||!y.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),v.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",v.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",v.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ye(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ve(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),v.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="
",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(v.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return B(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=_e(v.pixelPosition,function(e,t){if(t)return t=Be(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return B(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 00){var c=e.utils.clone(r)||{};c.position=[a,l],c.index=s.length,s.push(new e.Token(i.slice(a,o),c))}a=o+1}}return s},e.tokenizer.separator=/[\s\-]+/,e.Pipeline=function(){this._stack=[]},e.Pipeline.registeredFunctions=Object.create(null),e.Pipeline.registerFunction=function(t,r){r in this.registeredFunctions&&e.utils.warn("Overwriting existing registered function: "+r),t.label=r,e.Pipeline.registeredFunctions[t.label]=t},e.Pipeline.warnIfFunctionNotRegistered=function(t){var r=t.label&&t.label in this.registeredFunctions;r||e.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",t)},e.Pipeline.load=function(t){var r=new e.Pipeline;return t.forEach(function(t){var i=e.Pipeline.registeredFunctions[t];if(!i)throw new Error("Cannot load unregistered function: "+t);r.add(i)}),r},e.Pipeline.prototype.add=function(){var t=Array.prototype.slice.call(arguments);t.forEach(function(t){e.Pipeline.warnIfFunctionNotRegistered(t),this._stack.push(t)},this)},e.Pipeline.prototype.after=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");i+=1,this._stack.splice(i,0,r)},e.Pipeline.prototype.before=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");this._stack.splice(i,0,r)},e.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);t!=-1&&this._stack.splice(t,1)},e.Pipeline.prototype.run=function(e){for(var t=this._stack.length,r=0;r1&&(se&&(r=n),s!=e);)i=r-t,n=t+Math.floor(i/2),s=this.elements[2*n];return s==e?2*n:s>e?2*n:sa?l+=2:o==a&&(t+=r[u+1]*i[l+1],u+=2,l+=2);return t},e.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},e.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,r=0;t0){var o,a=s.str.charAt(0);a in s.node.edges?o=s.node.edges[a]:(o=new e.TokenSet,s.node.edges[a]=o),1==s.str.length&&(o["final"]=!0),n.push({node:o,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(0!=s.editsRemaining){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new e.TokenSet;s.node.edges["*"]=u}if(0==s.str.length&&(u["final"]=!0),n.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&n.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),1==s.str.length&&(s.node["final"]=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new e.TokenSet;s.node.edges["*"]=l}1==s.str.length&&(l["final"]=!0),n.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var c,h=s.str.charAt(0),d=s.str.charAt(1);d in s.node.edges?c=s.node.edges[d]:(c=new e.TokenSet,s.node.edges[d]=c),1==s.str.length&&(c["final"]=!0),n.push({node:c,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return i},e.TokenSet.fromString=function(t){for(var r=new e.TokenSet,i=r,n=0,s=t.length;n=e;t--){var r=this.uncheckedNodes[t],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r["char"]]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}},e.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},e.Index.prototype.search=function(t){return this.query(function(r){var i=new e.QueryParser(t,r);i.parse()})},e.Index.prototype.query=function(t){for(var r=new e.Query(this.fields),i=Object.create(null),n=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},e.Builder.prototype.k1=function(e){this._k1=e},e.Builder.prototype.add=function(t,r){var i=t[this._ref],n=Object.keys(this._fields);this._documents[i]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return e.QueryLexer.EOS;var t=this.str.charAt(this.pos);return this.pos+=1,t},e.QueryLexer.prototype.width=function(){return this.pos-this.start},e.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},e.QueryLexer.prototype.backup=function(){this.pos-=1},e.QueryLexer.prototype.acceptDigitRun=function(){var t,r;do t=this.next(),r=t.charCodeAt(0);while(r>47&&r<58);t!=e.QueryLexer.EOS&&this.backup()},e.QueryLexer.prototype.more=function(){return this.pos1&&(t.backup(),t.emit(e.QueryLexer.TERM)),t.ignore(),t.more())return e.QueryLexer.lexText},e.QueryLexer.lexEditDistance=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.EDIT_DISTANCE),e.QueryLexer.lexText},e.QueryLexer.lexBoost=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.BOOST),e.QueryLexer.lexText},e.QueryLexer.lexEOS=function(t){t.width()>0&&t.emit(e.QueryLexer.TERM)},e.QueryLexer.termSeparator=e.tokenizer.separator,e.QueryLexer.lexText=function(t){for(;;){var r=t.next();if(r==e.QueryLexer.EOS)return e.QueryLexer.lexEOS;if(92!=r.charCodeAt(0)){if(":"==r)return e.QueryLexer.lexField;if("~"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexEditDistance;if("^"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexBoost;if("+"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if("-"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if(r.match(e.QueryLexer.termSeparator))return e.QueryLexer.lexTerm}else t.escapeCharacter()}},e.QueryParser=function(t,r){this.lexer=new e.QueryLexer(t),this.query=r,this.currentClause={},this.lexemeIdx=0},e.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var t=e.QueryParser.parseClause;t;)t=t(this);return this.query},e.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},e.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},e.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},e.QueryParser.parseClause=function(t){var r=t.peekLexeme();if(void 0!=r)switch(r.type){case e.QueryLexer.PRESENCE:return e.QueryParser.parsePresence;case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(i+=" with value '"+r.str+"'"),new e.QueryParseError(i,r.start,r.end)}},e.QueryParser.parsePresence=function(t){var r=t.consumeLexeme();if(void 0!=r){switch(r.str){case"-":t.currentClause.presence=e.Query.presence.PROHIBITED;break;case"+":t.currentClause.presence=e.Query.presence.REQUIRED;break;default:var i="unrecognised presence operator'"+r.str+"'";throw new e.QueryParseError(i,r.start,r.end)}var n=t.peekLexeme();if(void 0==n){var i="expecting term or field, found nothing";throw new e.QueryParseError(i,r.start,r.end)}switch(n.type){case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expecting term or field, found '"+n.type+"'";throw new e.QueryParseError(i,n.start,n.end)}}},e.QueryParser.parseField=function(t){var r=t.consumeLexeme();if(void 0!=r){if(t.query.allFields.indexOf(r.str)==-1){var i=t.query.allFields.map(function(e){return"'"+e+"'"}).join(", "),n="unrecognised field '"+r.str+"', possible fields: "+i;throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.fields=[r.str];var s=t.peekLexeme();if(void 0==s){var n="expecting term, found nothing";throw new e.QueryParseError(n,r.start,r.end)}switch(s.type){case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var n="expecting term, found '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseTerm=function(t){var r=t.consumeLexeme();if(void 0!=r){t.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(t.currentClause.usePipeline=!1);var i=t.peekLexeme();if(void 0==i)return void t.nextClause();switch(i.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+i.type+"'";throw new e.QueryParseError(n,i.start,i.end)}}},e.QueryParser.parseEditDistance=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="edit distance must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.editDistance=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseBoost=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="boost must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.boost=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},function(e,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():e.lunr=t()}(this,function(){return e})}(); diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/js/typeahead.jquery.js b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/js/typeahead.jquery.js new file mode 100644 index 00000000..3a2d2ab0 --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/js/typeahead.jquery.js @@ -0,0 +1,1694 @@ +/*! + * typeahead.js 1.3.1 + * https://github.com/corejavascript/typeahead.js + * Copyright 2013-2020 Twitter, Inc. and other contributors; Licensed MIT + */ + + +(function(root, factory) { + if (typeof define === "function" && define.amd) { + define([ "jquery" ], function(a0) { + return factory(a0); + }); + } else if (typeof module === "object" && module.exports) { + module.exports = factory(require("jquery")); + } else { + factory(root["jQuery"]); + } +})(this, function($) { + var _ = function() { + "use strict"; + return { + isMsie: function() { + return /(msie|trident)/i.test(navigator.userAgent) ? navigator.userAgent.match(/(msie |rv:)(\d+(.\d+)?)/i)[2] : false; + }, + isBlankString: function(str) { + return !str || /^\s*$/.test(str); + }, + escapeRegExChars: function(str) { + return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, "\\$&"); + }, + isString: function(obj) { + return typeof obj === "string"; + }, + isNumber: function(obj) { + return typeof obj === "number"; + }, + isArray: $.isArray, + isFunction: $.isFunction, + isObject: $.isPlainObject, + isUndefined: function(obj) { + return typeof obj === "undefined"; + }, + isElement: function(obj) { + return !!(obj && obj.nodeType === 1); + }, + isJQuery: function(obj) { + return obj instanceof $; + }, + toStr: function toStr(s) { + return _.isUndefined(s) || s === null ? "" : s + ""; + }, + bind: $.proxy, + each: function(collection, cb) { + $.each(collection, reverseArgs); + function reverseArgs(index, value) { + return cb(value, index); + } + }, + map: $.map, + filter: $.grep, + every: function(obj, test) { + var result = true; + if (!obj) { + return result; + } + $.each(obj, function(key, val) { + if (!(result = test.call(null, val, key, obj))) { + return false; + } + }); + return !!result; + }, + some: function(obj, test) { + var result = false; + if (!obj) { + return result; + } + $.each(obj, function(key, val) { + if (result = test.call(null, val, key, obj)) { + return false; + } + }); + return !!result; + }, + mixin: $.extend, + identity: function(x) { + return x; + }, + clone: function(obj) { + return $.extend(true, {}, obj); + }, + getIdGenerator: function() { + var counter = 0; + return function() { + return counter++; + }; + }, + templatify: function templatify(obj) { + return $.isFunction(obj) ? obj : template; + function template() { + return String(obj); + } + }, + defer: function(fn) { + setTimeout(fn, 0); + }, + debounce: function(func, wait, immediate) { + var timeout, result; + return function() { + var context = this, args = arguments, later, callNow; + later = function() { + timeout = null; + if (!immediate) { + result = func.apply(context, args); + } + }; + callNow = immediate && !timeout; + clearTimeout(timeout); + timeout = setTimeout(later, wait); + if (callNow) { + result = func.apply(context, args); + } + return result; + }; + }, + throttle: function(func, wait) { + var context, args, timeout, result, previous, later; + previous = 0; + later = function() { + previous = new Date(); + timeout = null; + result = func.apply(context, args); + }; + return function() { + var now = new Date(), remaining = wait - (now - previous); + context = this; + args = arguments; + if (remaining <= 0) { + clearTimeout(timeout); + timeout = null; + previous = now; + result = func.apply(context, args); + } else if (!timeout) { + timeout = setTimeout(later, remaining); + } + return result; + }; + }, + stringify: function(val) { + return _.isString(val) ? val : JSON.stringify(val); + }, + guid: function() { + function _p8(s) { + var p = (Math.random().toString(16) + "000000000").substr(2, 8); + return s ? "-" + p.substr(0, 4) + "-" + p.substr(4, 4) : p; + } + return "tt-" + _p8() + _p8(true) + _p8(true) + _p8(); + }, + noop: function() {} + }; + }(); + var WWW = function() { + "use strict"; + var defaultClassNames = { + wrapper: "twitter-typeahead", + input: "tt-input", + hint: "tt-hint", + menu: "tt-menu", + dataset: "tt-dataset", + suggestion: "tt-suggestion", + selectable: "tt-selectable", + empty: "tt-empty", + open: "tt-open", + cursor: "tt-cursor", + highlight: "tt-highlight" + }; + return build; + function build(o) { + var www, classes; + classes = _.mixin({}, defaultClassNames, o); + www = { + css: buildCss(), + classes: classes, + html: buildHtml(classes), + selectors: buildSelectors(classes) + }; + return { + css: www.css, + html: www.html, + classes: www.classes, + selectors: www.selectors, + mixin: function(o) { + _.mixin(o, www); + } + }; + } + function buildHtml(c) { + return { + wrapper: '', + menu: '
' + }; + } + function buildSelectors(classes) { + var selectors = {}; + _.each(classes, function(v, k) { + selectors[k] = "." + v; + }); + return selectors; + } + function buildCss() { + var css = { + wrapper: { + position: "relative", + display: "inline-block" + }, + hint: { + position: "absolute", + top: "0", + left: "0", + borderColor: "transparent", + boxShadow: "none", + opacity: "1" + }, + input: { + position: "relative", + verticalAlign: "top", + backgroundColor: "transparent" + }, + inputWithNoHint: { + position: "relative", + verticalAlign: "top" + }, + menu: { + position: "absolute", + top: "100%", + left: "0", + zIndex: "100", + display: "none" + }, + ltr: { + left: "0", + right: "auto" + }, + rtl: { + left: "auto", + right: " 0" + } + }; + if (_.isMsie()) { + _.mixin(css.input, { + backgroundImage: "url(data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)" + }); + } + return css; + } + }(); + var EventBus = function() { + "use strict"; + var namespace, deprecationMap; + namespace = "typeahead:"; + deprecationMap = { + render: "rendered", + cursorchange: "cursorchanged", + select: "selected", + autocomplete: "autocompleted" + }; + function EventBus(o) { + if (!o || !o.el) { + $.error("EventBus initialized without el"); + } + this.$el = $(o.el); + } + _.mixin(EventBus.prototype, { + _trigger: function(type, args) { + var $e = $.Event(namespace + type); + this.$el.trigger.call(this.$el, $e, args || []); + return $e; + }, + before: function(type) { + var args, $e; + args = [].slice.call(arguments, 1); + $e = this._trigger("before" + type, args); + return $e.isDefaultPrevented(); + }, + trigger: function(type) { + var deprecatedType; + this._trigger(type, [].slice.call(arguments, 1)); + if (deprecatedType = deprecationMap[type]) { + this._trigger(deprecatedType, [].slice.call(arguments, 1)); + } + } + }); + return EventBus; + }(); + var EventEmitter = function() { + "use strict"; + var splitter = /\s+/, nextTick = getNextTick(); + return { + onSync: onSync, + onAsync: onAsync, + off: off, + trigger: trigger + }; + function on(method, types, cb, context) { + var type; + if (!cb) { + return this; + } + types = types.split(splitter); + cb = context ? bindContext(cb, context) : cb; + this._callbacks = this._callbacks || {}; + while (type = types.shift()) { + this._callbacks[type] = this._callbacks[type] || { + sync: [], + async: [] + }; + this._callbacks[type][method].push(cb); + } + return this; + } + function onAsync(types, cb, context) { + return on.call(this, "async", types, cb, context); + } + function onSync(types, cb, context) { + return on.call(this, "sync", types, cb, context); + } + function off(types) { + var type; + if (!this._callbacks) { + return this; + } + types = types.split(splitter); + while (type = types.shift()) { + delete this._callbacks[type]; + } + return this; + } + function trigger(types) { + var type, callbacks, args, syncFlush, asyncFlush; + if (!this._callbacks) { + return this; + } + types = types.split(splitter); + args = [].slice.call(arguments, 1); + while ((type = types.shift()) && (callbacks = this._callbacks[type])) { + syncFlush = getFlush(callbacks.sync, this, [ type ].concat(args)); + asyncFlush = getFlush(callbacks.async, this, [ type ].concat(args)); + syncFlush() && nextTick(asyncFlush); + } + return this; + } + function getFlush(callbacks, context, args) { + return flush; + function flush() { + var cancelled; + for (var i = 0, len = callbacks.length; !cancelled && i < len; i += 1) { + cancelled = callbacks[i].apply(context, args) === false; + } + return !cancelled; + } + } + function getNextTick() { + var nextTickFn; + if (window.setImmediate) { + nextTickFn = function nextTickSetImmediate(fn) { + setImmediate(function() { + fn(); + }); + }; + } else { + nextTickFn = function nextTickSetTimeout(fn) { + setTimeout(function() { + fn(); + }, 0); + }; + } + return nextTickFn; + } + function bindContext(fn, context) { + return fn.bind ? fn.bind(context) : function() { + fn.apply(context, [].slice.call(arguments, 0)); + }; + } + }(); + var highlight = function(doc) { + "use strict"; + var defaults = { + node: null, + pattern: null, + tagName: "strong", + className: null, + wordsOnly: false, + caseSensitive: false, + diacriticInsensitive: false + }; + var accented = { + A: "[AaªÀ-Åà-åĀ-ąǍǎȀ-ȃȦȧᴬᵃḀḁẚẠ-ảₐ℀℁℻⒜Ⓐⓐ㍱-㍴㎀-㎄㎈㎉㎩-㎯㏂㏊㏟㏿Ａａ]", + B: "[BbᴮᵇḂ-ḇℬ⒝Ⓑⓑ㍴㎅-㎇㏃㏈㏔㏝Ｂｂ]", + C: "[CcÇçĆ-čᶜ℀ℂ℃℅℆ℭⅭⅽ⒞Ⓒⓒ㍶㎈㎉㎝㎠㎤㏄-㏇Ｃｃ]", + D: "[DdĎďDŽ-džDZ-dzᴰᵈḊ-ḓⅅⅆⅮⅾ⒟Ⓓⓓ㋏㍲㍷-㍹㎗㎭-㎯㏅㏈Ｄｄ]", + E: "[EeÈ-Ëè-ëĒ-ěȄ-ȇȨȩᴱᵉḘ-ḛẸ-ẽₑ℡ℯℰⅇ⒠Ⓔⓔ㉐㋍㋎Ｅｅ]", + F: "[FfᶠḞḟ℉ℱ℻⒡Ⓕⓕ㎊-㎌㎙ff-fflＦｆ]", + G: "[GgĜ-ģǦǧǴǵᴳᵍḠḡℊ⒢Ⓖⓖ㋌㋍㎇㎍-㎏㎓㎬㏆㏉㏒㏿Ｇｇ]", + H: "[HhĤĥȞȟʰᴴḢ-ḫẖℋ-ℎ⒣Ⓗⓗ㋌㍱㎐-㎔㏊㏋㏗Ｈｈ]", + I: "[IiÌ-Ïì-ïĨ-İIJijǏǐȈ-ȋᴵᵢḬḭỈ-ịⁱℐℑℹⅈⅠ-ⅣⅥ-ⅨⅪⅫⅰ-ⅳⅵ-ⅸⅺⅻ⒤Ⓘⓘ㍺㏌㏕fiffiＩｉ]", + J: "[JjIJ-ĵLJ-njǰʲᴶⅉ⒥ⒿⓙⱼＪｊ]", + K: "[KkĶķǨǩᴷᵏḰ-ḵK⒦Ⓚⓚ㎄㎅㎉㎏㎑㎘㎞㎢㎦㎪㎸㎾㏀㏆㏍-㏏Ｋｋ]", + L: "[LlĹ-ŀLJ-ljˡᴸḶḷḺ-ḽℒℓ℡Ⅼⅼ⒧Ⓛⓛ㋏㎈㎉㏐-㏓㏕㏖㏿flfflＬｌ]", + M: "[MmᴹᵐḾ-ṃ℠™ℳⅯⅿ⒨Ⓜⓜ㍷-㍹㎃㎆㎎㎒㎖㎙-㎨㎫㎳㎷㎹㎽㎿㏁㏂㏎㏐㏔-㏖㏘㏙㏞㏟Ｍｍ]", + N: "[NnÑñŃ-ʼnNJ-njǸǹᴺṄ-ṋⁿℕ№⒩Ⓝⓝ㎁㎋㎚㎱㎵㎻㏌㏑Ｎｎ]", + O: "[OoºÒ-Öò-öŌ-őƠơǑǒǪǫȌ-ȏȮȯᴼᵒỌ-ỏₒ℅№ℴ⒪Ⓞⓞ㍵㏇㏒㏖Ｏｏ]", + P: "[PpᴾᵖṔ-ṗℙ⒫Ⓟⓟ㉐㍱㍶㎀㎊㎩-㎬㎰㎴㎺㏋㏗-㏚Ｐｐ]", + Q: "[Qqℚ⒬Ⓠⓠ㏃Ｑｑ]", + R: "[RrŔ-řȐ-ȓʳᴿᵣṘ-ṛṞṟ₨ℛ-ℝ⒭Ⓡⓡ㋍㍴㎭-㎯㏚㏛Ｒｒ]", + S: "[SsŚ-šſȘșˢṠ-ṣ₨℁℠⒮Ⓢⓢ㎧㎨㎮-㎳㏛㏜stＳｓ]", + T: "[TtŢ-ťȚțᵀᵗṪ-ṱẗ℡™⒯Ⓣⓣ㉐㋏㎔㏏ſtstＴｔ]", + U: "[UuÙ-Üù-üŨ-ųƯưǓǔȔ-ȗᵁᵘᵤṲ-ṷỤ-ủ℆⒰Ⓤⓤ㍳㍺Ｕｕ]", + V: "[VvᵛᵥṼ-ṿⅣ-Ⅷⅳ-ⅷ⒱Ⓥⓥⱽ㋎㍵㎴-㎹㏜㏞Ｖｖ]", + W: "[WwŴŵʷᵂẀ-ẉẘ⒲Ⓦⓦ㎺-㎿㏝Ｗｗ]", + X: "[XxˣẊ-ẍₓ℻Ⅸ-Ⅻⅸ-ⅻ⒳Ⓧⓧ㏓Ｘｘ]", + Y: "[YyÝýÿŶ-ŸȲȳʸẎẏẙỲ-ỹ⒴Ⓨⓨ㏉Ｙｙ]", + Z: "[ZzŹ-žDZ-dzᶻẐ-ẕℤℨ⒵Ⓩⓩ㎐-㎔Ｚｚ]" + }; + return function hightlight(o) { + var regex; + o = _.mixin({}, defaults, o); + if (!o.node || !o.pattern) { + return; + } + o.pattern = _.isArray(o.pattern) ? o.pattern : [ o.pattern ]; + regex = getRegex(o.pattern, o.caseSensitive, o.wordsOnly, o.diacriticInsensitive); + traverse(o.node, hightlightTextNode); + function hightlightTextNode(textNode) { + var match, patternNode, wrapperNode; + if (match = regex.exec(textNode.data)) { + wrapperNode = doc.createElement(o.tagName); + o.className && (wrapperNode.className = o.className); + patternNode = textNode.splitText(match.index); + patternNode.splitText(match[0].length); + wrapperNode.appendChild(patternNode.cloneNode(true)); + textNode.parentNode.replaceChild(wrapperNode, patternNode); + } + return !!match; + } + function traverse(el, hightlightTextNode) { + var childNode, TEXT_NODE_TYPE = 3; + for (var i = 0; i < el.childNodes.length; i++) { + childNode = el.childNodes[i]; + if (childNode.nodeType === TEXT_NODE_TYPE) { + i += hightlightTextNode(childNode) ? 1 : 0; + } else { + traverse(childNode, hightlightTextNode); + } + } + } + }; + function accent_replacer(chr) { + return accented[chr.toUpperCase()] || chr; + } + function getRegex(patterns, caseSensitive, wordsOnly, diacriticInsensitive) { + var escapedPatterns = [], regexStr; + for (var i = 0, len = patterns.length; i < len; i++) { + var escapedWord = _.escapeRegExChars(patterns[i]); + if (diacriticInsensitive) { + escapedWord = escapedWord.replace(/\S/g, accent_replacer); + } + escapedPatterns.push(escapedWord); + } + regexStr = wordsOnly ? "\\b(" + escapedPatterns.join("|") + ")\\b" : "(" + escapedPatterns.join("|") + ")"; + return caseSensitive ? new RegExp(regexStr) : new RegExp(regexStr, "i"); + } + }(window.document); + var Input = function() { + "use strict"; + var specialKeyCodeMap; + specialKeyCodeMap = { + 9: "tab", + 27: "esc", + 37: "left", + 39: "right", + 13: "enter", + 38: "up", + 40: "down" + }; + function Input(o, www) { + var id; + o = o || {}; + if (!o.input) { + $.error("input is missing"); + } + www.mixin(this); + this.$hint = $(o.hint); + this.$input = $(o.input); + this.$menu = $(o.menu); + id = this.$input.attr("id") || _.guid(); + this.$menu.attr("id", id + "_listbox"); + this.$hint.attr({ + "aria-hidden": true + }); + this.$input.attr({ + "aria-owns": id + "_listbox", + role: "combobox", + "aria-autocomplete": "list", + "aria-expanded": false + }); + this.query = this.$input.val(); + this.queryWhenFocused = this.hasFocus() ? this.query : null; + this.$overflowHelper = buildOverflowHelper(this.$input); + this._checkLanguageDirection(); + if (this.$hint.length === 0) { + this.setHint = this.getHint = this.clearHint = this.clearHintIfInvalid = _.noop; + } + this.onSync("cursorchange", this._updateDescendent); + } + Input.normalizeQuery = function(str) { + return _.toStr(str).replace(/^\s*/g, "").replace(/\s{2,}/g, " "); + }; + _.mixin(Input.prototype, EventEmitter, { + _onBlur: function onBlur() { + this.resetInputValue(); + this.trigger("blurred"); + }, + _onFocus: function onFocus() { + this.queryWhenFocused = this.query; + this.trigger("focused"); + }, + _onKeydown: function onKeydown($e) { + var keyName = specialKeyCodeMap[$e.which || $e.keyCode]; + this._managePreventDefault(keyName, $e); + if (keyName && this._shouldTrigger(keyName, $e)) { + this.trigger(keyName + "Keyed", $e); + } + }, + _onInput: function onInput() { + this._setQuery(this.getInputValue()); + this.clearHintIfInvalid(); + this._checkLanguageDirection(); + }, + _managePreventDefault: function managePreventDefault(keyName, $e) { + var preventDefault; + switch (keyName) { + case "up": + case "down": + preventDefault = !withModifier($e); + break; + + default: + preventDefault = false; + } + preventDefault && $e.preventDefault(); + }, + _shouldTrigger: function shouldTrigger(keyName, $e) { + var trigger; + switch (keyName) { + case "tab": + trigger = !withModifier($e); + break; + + default: + trigger = true; + } + return trigger; + }, + _checkLanguageDirection: function checkLanguageDirection() { + var dir = (this.$input.css("direction") || "ltr").toLowerCase(); + if (this.dir !== dir) { + this.dir = dir; + this.$hint.attr("dir", dir); + this.trigger("langDirChanged", dir); + } + }, + _setQuery: function setQuery(val, silent) { + var areEquivalent, hasDifferentWhitespace; + areEquivalent = areQueriesEquivalent(val, this.query); + hasDifferentWhitespace = areEquivalent ? this.query.length !== val.length : false; + this.query = val; + if (!silent && !areEquivalent) { + this.trigger("queryChanged", this.query); + } else if (!silent && hasDifferentWhitespace) { + this.trigger("whitespaceChanged", this.query); + } + }, + _updateDescendent: function updateDescendent(event, id) { + this.$input.attr("aria-activedescendant", id); + }, + bind: function() { + var that = this, onBlur, onFocus, onKeydown, onInput; + onBlur = _.bind(this._onBlur, this); + onFocus = _.bind(this._onFocus, this); + onKeydown = _.bind(this._onKeydown, this); + onInput = _.bind(this._onInput, this); + this.$input.on("blur.tt", onBlur).on("focus.tt", onFocus).on("keydown.tt", onKeydown); + if (!_.isMsie() || _.isMsie() > 9) { + this.$input.on("input.tt", onInput); + } else { + this.$input.on("keydown.tt keypress.tt cut.tt paste.tt", function($e) { + if (specialKeyCodeMap[$e.which || $e.keyCode]) { + return; + } + _.defer(_.bind(that._onInput, that, $e)); + }); + } + return this; + }, + focus: function focus() { + this.$input.focus(); + }, + blur: function blur() { + this.$input.blur(); + }, + getLangDir: function getLangDir() { + return this.dir; + }, + getQuery: function getQuery() { + return this.query || ""; + }, + setQuery: function setQuery(val, silent) { + this.setInputValue(val); + this._setQuery(val, silent); + }, + hasQueryChangedSinceLastFocus: function hasQueryChangedSinceLastFocus() { + return this.query !== this.queryWhenFocused; + }, + getInputValue: function getInputValue() { + return this.$input.val(); + }, + setInputValue: function setInputValue(value) { + this.$input.val(value); + this.clearHintIfInvalid(); + this._checkLanguageDirection(); + }, + resetInputValue: function resetInputValue() { + this.setInputValue(this.query); + }, + getHint: function getHint() { + return this.$hint.val(); + }, + setHint: function setHint(value) { + this.$hint.val(value); + }, + clearHint: function clearHint() { + this.setHint(""); + }, + clearHintIfInvalid: function clearHintIfInvalid() { + var val, hint, valIsPrefixOfHint, isValid; + val = this.getInputValue(); + hint = this.getHint(); + valIsPrefixOfHint = val !== hint && hint.indexOf(val) === 0; + isValid = val !== "" && valIsPrefixOfHint && !this.hasOverflow(); + !isValid && this.clearHint(); + }, + hasFocus: function hasFocus() { + return this.$input.is(":focus"); + }, + hasOverflow: function hasOverflow() { + var constraint = this.$input.width() - 2; + this.$overflowHelper.text(this.getInputValue()); + return this.$overflowHelper.width() >= constraint; + }, + isCursorAtEnd: function() { + var valueLength, selectionStart, range; + valueLength = this.$input.val().length; + selectionStart = this.$input[0].selectionStart; + if (_.isNumber(selectionStart)) { + return selectionStart === valueLength; + } else if (document.selection) { + range = document.selection.createRange(); + range.moveStart("character", -valueLength); + return valueLength === range.text.length; + } + return true; + }, + destroy: function destroy() { + this.$hint.off(".tt"); + this.$input.off(".tt"); + this.$overflowHelper.remove(); + this.$hint = this.$input = this.$overflowHelper = $("
"); + }, + setAriaExpanded: function setAriaExpanded(value) { + this.$input.attr("aria-expanded", value); + } + }); + return Input; + function buildOverflowHelper($input) { + return $('').css({ + position: "absolute", + visibility: "hidden", + whiteSpace: "pre", + fontFamily: $input.css("font-family"), + fontSize: $input.css("font-size"), + fontStyle: $input.css("font-style"), + fontVariant: $input.css("font-variant"), + fontWeight: $input.css("font-weight"), + wordSpacing: $input.css("word-spacing"), + letterSpacing: $input.css("letter-spacing"), + textIndent: $input.css("text-indent"), + textRendering: $input.css("text-rendering"), + textTransform: $input.css("text-transform") + }).insertAfter($input); + } + function areQueriesEquivalent(a, b) { + return Input.normalizeQuery(a) === Input.normalizeQuery(b); + } + function withModifier($e) { + return $e.altKey || $e.ctrlKey || $e.metaKey || $e.shiftKey; + } + }(); + var Dataset = function() { + "use strict"; + var keys, nameGenerator; + keys = { + dataset: "tt-selectable-dataset", + val: "tt-selectable-display", + obj: "tt-selectable-object" + }; + nameGenerator = _.getIdGenerator(); + function Dataset(o, www) { + o = o || {}; + o.templates = o.templates || {}; + o.templates.notFound = o.templates.notFound || o.templates.empty; + if (!o.source) { + $.error("missing source"); + } + if (!o.node) { + $.error("missing node"); + } + if (o.name && !isValidName(o.name)) { + $.error("invalid dataset name: " + o.name); + } + www.mixin(this); + this.highlight = !!o.highlight; + this.name = _.toStr(o.name || nameGenerator()); + this.limit = o.limit || 5; + this.displayFn = getDisplayFn(o.display || o.displayKey); + this.templates = getTemplates(o.templates, this.displayFn); + this.source = o.source.__ttAdapter ? o.source.__ttAdapter() : o.source; + this.async = _.isUndefined(o.async) ? this.source.length > 2 : !!o.async; + this._resetLastSuggestion(); + this.$el = $(o.node).attr("role", "presentation").addClass(this.classes.dataset).addClass(this.classes.dataset + "-" + this.name); + } + Dataset.extractData = function extractData(el) { + var $el = $(el); + if ($el.data(keys.obj)) { + return { + dataset: $el.data(keys.dataset) || "", + val: $el.data(keys.val) || "", + obj: $el.data(keys.obj) || null + }; + } + return null; + }; + _.mixin(Dataset.prototype, EventEmitter, { + _overwrite: function overwrite(query, suggestions) { + suggestions = suggestions || []; + if (suggestions.length) { + this._renderSuggestions(query, suggestions); + } else if (this.async && this.templates.pending) { + this._renderPending(query); + } else if (!this.async && this.templates.notFound) { + this._renderNotFound(query); + } else { + this._empty(); + } + this.trigger("rendered", suggestions, false, this.name); + }, + _append: function append(query, suggestions) { + suggestions = suggestions || []; + if (suggestions.length && this.$lastSuggestion.length) { + this._appendSuggestions(query, suggestions); + } else if (suggestions.length) { + this._renderSuggestions(query, suggestions); + } else if (!this.$lastSuggestion.length && this.templates.notFound) { + this._renderNotFound(query); + } + this.trigger("rendered", suggestions, true, this.name); + }, + _renderSuggestions: function renderSuggestions(query, suggestions) { + var $fragment; + $fragment = this._getSuggestionsFragment(query, suggestions); + this.$lastSuggestion = $fragment.children().last(); + this.$el.html($fragment).prepend(this._getHeader(query, suggestions)).append(this._getFooter(query, suggestions)); + }, + _appendSuggestions: function appendSuggestions(query, suggestions) { + var $fragment, $lastSuggestion; + $fragment = this._getSuggestionsFragment(query, suggestions); + $lastSuggestion = $fragment.children().last(); + this.$lastSuggestion.after($fragment); + this.$lastSuggestion = $lastSuggestion; + }, + _renderPending: function renderPending(query) { + var template = this.templates.pending; + this._resetLastSuggestion(); + template && this.$el.html(template({ + query: query, + dataset: this.name + })); + }, + _renderNotFound: function renderNotFound(query) { + var template = this.templates.notFound; + this._resetLastSuggestion(); + template && this.$el.html(template({ + query: query, + dataset: this.name + })); + }, + _empty: function empty() { + this.$el.empty(); + this._resetLastSuggestion(); + }, + _getSuggestionsFragment: function getSuggestionsFragment(query, suggestions) { + var that = this, fragment; + fragment = document.createDocumentFragment(); + _.each(suggestions, function getSuggestionNode(suggestion) { + var $el, context; + context = that._injectQuery(query, suggestion); + $el = $(that.templates.suggestion(context)).data(keys.dataset, that.name).data(keys.obj, suggestion).data(keys.val, that.displayFn(suggestion)).addClass(that.classes.suggestion + " " + that.classes.selectable); + fragment.appendChild($el[0]); + }); + this.highlight && highlight({ + className: this.classes.highlight, + node: fragment, + pattern: query + }); + return $(fragment); + }, + _getFooter: function getFooter(query, suggestions) { + return this.templates.footer ? this.templates.footer({ + query: query, + suggestions: suggestions, + dataset: this.name + }) : null; + }, + _getHeader: function getHeader(query, suggestions) { + return this.templates.header ? this.templates.header({ + query: query, + suggestions: suggestions, + dataset: this.name + }) : null; + }, + _resetLastSuggestion: function resetLastSuggestion() { + this.$lastSuggestion = $(); + }, + _injectQuery: function injectQuery(query, obj) { + return _.isObject(obj) ? _.mixin({ + _query: query + }, obj) : obj; + }, + update: function update(query) { + var that = this, canceled = false, syncCalled = false, rendered = 0; + this.cancel(); + this.cancel = function cancel() { + canceled = true; + that.cancel = $.noop; + that.async && that.trigger("asyncCanceled", query, that.name); + }; + this.source(query, sync, async); + !syncCalled && sync([]); + function sync(suggestions) { + if (syncCalled) { + return; + } + syncCalled = true; + suggestions = (suggestions || []).slice(0, that.limit); + rendered = suggestions.length; + that._overwrite(query, suggestions); + if (rendered < that.limit && that.async) { + that.trigger("asyncRequested", query, that.name); + } + } + function async(suggestions) { + suggestions = suggestions || []; + if (!canceled && rendered < that.limit) { + that.cancel = $.noop; + var idx = Math.abs(rendered - that.limit); + rendered += idx; + that._append(query, suggestions.slice(0, idx)); + that.async && that.trigger("asyncReceived", query, that.name); + } + } + }, + cancel: $.noop, + clear: function clear() { + this._empty(); + this.cancel(); + this.trigger("cleared"); + }, + isEmpty: function isEmpty() { + return this.$el.is(":empty"); + }, + destroy: function destroy() { + this.$el = $("
"); + } + }); + return Dataset; + function getDisplayFn(display) { + display = display || _.stringify; + return _.isFunction(display) ? display : displayFn; + function displayFn(obj) { + return obj[display]; + } + } + function getTemplates(templates, displayFn) { + return { + notFound: templates.notFound && _.templatify(templates.notFound), + pending: templates.pending && _.templatify(templates.pending), + header: templates.header && _.templatify(templates.header), + footer: templates.footer && _.templatify(templates.footer), + suggestion: templates.suggestion ? userSuggestionTemplate : suggestionTemplate + }; + function userSuggestionTemplate(context) { + var template = templates.suggestion; + return $(template(context)).attr("id", _.guid()); + } + function suggestionTemplate(context) { + return $('
').attr("id", _.guid()).text(displayFn(context)); + } + } + function isValidName(str) { + return /^[_a-zA-Z0-9-]+$/.test(str); + } + }(); + var Menu = function() { + "use strict"; + function Menu(o, www) { + var that = this; + o = o || {}; + if (!o.node) { + $.error("node is required"); + } + www.mixin(this); + this.$node = $(o.node); + this.query = null; + this.datasets = _.map(o.datasets, initializeDataset); + function initializeDataset(oDataset) { + var node = that.$node.find(oDataset.node).first(); + oDataset.node = node.length ? node : $("
").appendTo(that.$node); + return new Dataset(oDataset, www); + } + } + _.mixin(Menu.prototype, EventEmitter, { + _onSelectableClick: function onSelectableClick($e) { + this.trigger("selectableClicked", $($e.currentTarget)); + }, + _onRendered: function onRendered(type, dataset, suggestions, async) { + this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty()); + this.trigger("datasetRendered", dataset, suggestions, async); + }, + _onCleared: function onCleared() { + this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty()); + this.trigger("datasetCleared"); + }, + _propagate: function propagate() { + this.trigger.apply(this, arguments); + }, + _allDatasetsEmpty: function allDatasetsEmpty() { + return _.every(this.datasets, _.bind(function isDatasetEmpty(dataset) { + var isEmpty = dataset.isEmpty(); + this.$node.attr("aria-expanded", !isEmpty); + return isEmpty; + }, this)); + }, + _getSelectables: function getSelectables() { + return this.$node.find(this.selectors.selectable); + }, + _removeCursor: function _removeCursor() { + var $selectable = this.getActiveSelectable(); + $selectable && $selectable.removeClass(this.classes.cursor); + }, + _ensureVisible: function ensureVisible($el) { + var elTop, elBottom, nodeScrollTop, nodeHeight; + elTop = $el.position().top; + elBottom = elTop + $el.outerHeight(true); + nodeScrollTop = this.$node.scrollTop(); + nodeHeight = this.$node.height() + parseInt(this.$node.css("paddingTop"), 10) + parseInt(this.$node.css("paddingBottom"), 10); + if (elTop < 0) { + this.$node.scrollTop(nodeScrollTop + elTop); + } else if (nodeHeight < elBottom) { + this.$node.scrollTop(nodeScrollTop + (elBottom - nodeHeight)); + } + }, + bind: function() { + var that = this, onSelectableClick; + onSelectableClick = _.bind(this._onSelectableClick, this); + this.$node.on("click.tt", this.selectors.selectable, onSelectableClick); + this.$node.on("mouseover", this.selectors.selectable, function() { + that.setCursor($(this)); + }); + this.$node.on("mouseleave", function() { + that._removeCursor(); + }); + _.each(this.datasets, function(dataset) { + dataset.onSync("asyncRequested", that._propagate, that).onSync("asyncCanceled", that._propagate, that).onSync("asyncReceived", that._propagate, that).onSync("rendered", that._onRendered, that).onSync("cleared", that._onCleared, that); + }); + return this; + }, + isOpen: function isOpen() { + return this.$node.hasClass(this.classes.open); + }, + open: function open() { + this.$node.scrollTop(0); + this.$node.addClass(this.classes.open); + }, + close: function close() { + this.$node.attr("aria-expanded", false); + this.$node.removeClass(this.classes.open); + this._removeCursor(); + }, + setLanguageDirection: function setLanguageDirection(dir) { + this.$node.attr("dir", dir); + }, + selectableRelativeToCursor: function selectableRelativeToCursor(delta) { + var $selectables, $oldCursor, oldIndex, newIndex; + $oldCursor = this.getActiveSelectable(); + $selectables = this._getSelectables(); + oldIndex = $oldCursor ? $selectables.index($oldCursor) : -1; + newIndex = oldIndex + delta; + newIndex = (newIndex + 1) % ($selectables.length + 1) - 1; + newIndex = newIndex < -1 ? $selectables.length - 1 : newIndex; + return newIndex === -1 ? null : $selectables.eq(newIndex); + }, + setCursor: function setCursor($selectable) { + this._removeCursor(); + if ($selectable = $selectable && $selectable.first()) { + $selectable.addClass(this.classes.cursor); + this._ensureVisible($selectable); + } + }, + getSelectableData: function getSelectableData($el) { + return $el && $el.length ? Dataset.extractData($el) : null; + }, + getActiveSelectable: function getActiveSelectable() { + var $selectable = this._getSelectables().filter(this.selectors.cursor).first(); + return $selectable.length ? $selectable : null; + }, + getTopSelectable: function getTopSelectable() { + var $selectable = this._getSelectables().first(); + return $selectable.length ? $selectable : null; + }, + update: function update(query) { + var isValidUpdate = query !== this.query; + if (isValidUpdate) { + this.query = query; + _.each(this.datasets, updateDataset); + } + return isValidUpdate; + function updateDataset(dataset) { + dataset.update(query); + } + }, + empty: function empty() { + _.each(this.datasets, clearDataset); + this.query = null; + this.$node.addClass(this.classes.empty); + function clearDataset(dataset) { + dataset.clear(); + } + }, + destroy: function destroy() { + this.$node.off(".tt"); + this.$node = $("
"); + _.each(this.datasets, destroyDataset); + function destroyDataset(dataset) { + dataset.destroy(); + } + } + }); + return Menu; + }(); + var Status = function() { + "use strict"; + function Status(options) { + this.$el = $("", { + role: "status", + "aria-live": "polite" + }).css({ + position: "absolute", + padding: "0", + border: "0", + height: "1px", + width: "1px", + "margin-bottom": "-1px", + "margin-right": "-1px", + overflow: "hidden", + clip: "rect(0 0 0 0)", + "white-space": "nowrap" + }); + options.$input.after(this.$el); + _.each(options.menu.datasets, _.bind(function(dataset) { + if (dataset.onSync) { + dataset.onSync("rendered", _.bind(this.update, this)); + dataset.onSync("cleared", _.bind(this.cleared, this)); + } + }, this)); + } + _.mixin(Status.prototype, { + update: function update(event, suggestions) { + var length = suggestions.length; + var words; + if (length === 1) { + words = { + result: "result", + is: "is" + }; + } else { + words = { + result: "results", + is: "are" + }; + } + this.$el.text(length + " " + words.result + " " + words.is + " available, use up and down arrow keys to navigate."); + }, + cleared: function() { + this.$el.text(""); + } + }); + return Status; + }(); + var DefaultMenu = function() { + "use strict"; + var s = Menu.prototype; + function DefaultMenu() { + Menu.apply(this, [].slice.call(arguments, 0)); + } + _.mixin(DefaultMenu.prototype, Menu.prototype, { + open: function open() { + !this._allDatasetsEmpty() && this._show(); + return s.open.apply(this, [].slice.call(arguments, 0)); + }, + close: function close() { + this._hide(); + return s.close.apply(this, [].slice.call(arguments, 0)); + }, + _onRendered: function onRendered() { + if (this._allDatasetsEmpty()) { + this._hide(); + } else { + this.isOpen() && this._show(); + } + return s._onRendered.apply(this, [].slice.call(arguments, 0)); + }, + _onCleared: function onCleared() { + if (this._allDatasetsEmpty()) { + this._hide(); + } else { + this.isOpen() && this._show(); + } + return s._onCleared.apply(this, [].slice.call(arguments, 0)); + }, + setLanguageDirection: function setLanguageDirection(dir) { + this.$node.css(dir === "ltr" ? this.css.ltr : this.css.rtl); + return s.setLanguageDirection.apply(this, [].slice.call(arguments, 0)); + }, + _hide: function hide() { + this.$node.hide(); + }, + _show: function show() { + this.$node.css("display", "block"); + } + }); + return DefaultMenu; + }(); + var Typeahead = function() { + "use strict"; + function Typeahead(o, www) { + var onFocused, onBlurred, onEnterKeyed, onTabKeyed, onEscKeyed, onUpKeyed, onDownKeyed, onLeftKeyed, onRightKeyed, onQueryChanged, onWhitespaceChanged; + o = o || {}; + if (!o.input) { + $.error("missing input"); + } + if (!o.menu) { + $.error("missing menu"); + } + if (!o.eventBus) { + $.error("missing event bus"); + } + www.mixin(this); + this.eventBus = o.eventBus; + this.minLength = _.isNumber(o.minLength) ? o.minLength : 1; + this.input = o.input; + this.menu = o.menu; + this.enabled = true; + this.autoselect = !!o.autoselect; + this.active = false; + this.input.hasFocus() && this.activate(); + this.dir = this.input.getLangDir(); + this._hacks(); + this.menu.bind().onSync("selectableClicked", this._onSelectableClicked, this).onSync("asyncRequested", this._onAsyncRequested, this).onSync("asyncCanceled", this._onAsyncCanceled, this).onSync("asyncReceived", this._onAsyncReceived, this).onSync("datasetRendered", this._onDatasetRendered, this).onSync("datasetCleared", this._onDatasetCleared, this); + onFocused = c(this, "activate", "open", "_onFocused"); + onBlurred = c(this, "deactivate", "_onBlurred"); + onEnterKeyed = c(this, "isActive", "isOpen", "_onEnterKeyed"); + onTabKeyed = c(this, "isActive", "isOpen", "_onTabKeyed"); + onEscKeyed = c(this, "isActive", "_onEscKeyed"); + onUpKeyed = c(this, "isActive", "open", "_onUpKeyed"); + onDownKeyed = c(this, "isActive", "open", "_onDownKeyed"); + onLeftKeyed = c(this, "isActive", "isOpen", "_onLeftKeyed"); + onRightKeyed = c(this, "isActive", "isOpen", "_onRightKeyed"); + onQueryChanged = c(this, "_openIfActive", "_onQueryChanged"); + onWhitespaceChanged = c(this, "_openIfActive", "_onWhitespaceChanged"); + this.input.bind().onSync("focused", onFocused, this).onSync("blurred", onBlurred, this).onSync("enterKeyed", onEnterKeyed, this).onSync("tabKeyed", onTabKeyed, this).onSync("escKeyed", onEscKeyed, this).onSync("upKeyed", onUpKeyed, this).onSync("downKeyed", onDownKeyed, this).onSync("leftKeyed", onLeftKeyed, this).onSync("rightKeyed", onRightKeyed, this).onSync("queryChanged", onQueryChanged, this).onSync("whitespaceChanged", onWhitespaceChanged, this).onSync("langDirChanged", this._onLangDirChanged, this); + } + _.mixin(Typeahead.prototype, { + _hacks: function hacks() { + var $input, $menu; + $input = this.input.$input || $("
"); + $menu = this.menu.$node || $("
"); + $input.on("blur.tt", function($e) { + var active, isActive, hasActive; + active = document.activeElement; + isActive = $menu.is(active); + hasActive = $menu.has(active).length > 0; + if (_.isMsie() && (isActive || hasActive)) { + $e.preventDefault(); + $e.stopImmediatePropagation(); + _.defer(function() { + $input.focus(); + }); + } + }); + $menu.on("mousedown.tt", function($e) { + $e.preventDefault(); + }); + }, + _onSelectableClicked: function onSelectableClicked(type, $el) { + this.select($el); + }, + _onDatasetCleared: function onDatasetCleared() { + this._updateHint(); + }, + _onDatasetRendered: function onDatasetRendered(type, suggestions, async, dataset) { + this._updateHint(); + if (this.autoselect) { + var cursorClass = this.selectors.cursor.substr(1); + this.menu.$node.find(this.selectors.suggestion).first().addClass(cursorClass); + } + this.eventBus.trigger("render", suggestions, async, dataset); + }, + _onAsyncRequested: function onAsyncRequested(type, dataset, query) { + this.eventBus.trigger("asyncrequest", query, dataset); + }, + _onAsyncCanceled: function onAsyncCanceled(type, dataset, query) { + this.eventBus.trigger("asynccancel", query, dataset); + }, + _onAsyncReceived: function onAsyncReceived(type, dataset, query) { + this.eventBus.trigger("asyncreceive", query, dataset); + }, + _onFocused: function onFocused() { + this._minLengthMet() && this.menu.update(this.input.getQuery()); + }, + _onBlurred: function onBlurred() { + if (this.input.hasQueryChangedSinceLastFocus()) { + this.eventBus.trigger("change", this.input.getQuery()); + } + }, + _onEnterKeyed: function onEnterKeyed(type, $e) { + var $selectable; + if ($selectable = this.menu.getActiveSelectable()) { + if (this.select($selectable)) { + $e.preventDefault(); + $e.stopPropagation(); + } + } else if (this.autoselect) { + if (this.select(this.menu.getTopSelectable())) { + $e.preventDefault(); + $e.stopPropagation(); + } + } + }, + _onTabKeyed: function onTabKeyed(type, $e) { + var $selectable; + if ($selectable = this.menu.getActiveSelectable()) { + this.select($selectable) && $e.preventDefault(); + } else if (this.autoselect) { + if ($selectable = this.menu.getTopSelectable()) { + this.autocomplete($selectable) && $e.preventDefault(); + } + } + }, + _onEscKeyed: function onEscKeyed() { + this.close(); + }, + _onUpKeyed: function onUpKeyed() { + this.moveCursor(-1); + }, + _onDownKeyed: function onDownKeyed() { + this.moveCursor(+1); + }, + _onLeftKeyed: function onLeftKeyed() { + if (this.dir === "rtl" && this.input.isCursorAtEnd()) { + this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable()); + } + }, + _onRightKeyed: function onRightKeyed() { + if (this.dir === "ltr" && this.input.isCursorAtEnd()) { + this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable()); + } + }, + _onQueryChanged: function onQueryChanged(e, query) { + this._minLengthMet(query) ? this.menu.update(query) : this.menu.empty(); + }, + _onWhitespaceChanged: function onWhitespaceChanged() { + this._updateHint(); + }, + _onLangDirChanged: function onLangDirChanged(e, dir) { + if (this.dir !== dir) { + this.dir = dir; + this.menu.setLanguageDirection(dir); + } + }, + _openIfActive: function openIfActive() { + this.isActive() && this.open(); + }, + _minLengthMet: function minLengthMet(query) { + query = _.isString(query) ? query : this.input.getQuery() || ""; + return query.length >= this.minLength; + }, + _updateHint: function updateHint() { + var $selectable, data, val, query, escapedQuery, frontMatchRegEx, match; + $selectable = this.menu.getTopSelectable(); + data = this.menu.getSelectableData($selectable); + val = this.input.getInputValue(); + if (data && !_.isBlankString(val) && !this.input.hasOverflow()) { + query = Input.normalizeQuery(val); + escapedQuery = _.escapeRegExChars(query); + frontMatchRegEx = new RegExp("^(?:" + escapedQuery + ")(.+$)", "i"); + match = frontMatchRegEx.exec(data.val); + match && this.input.setHint(val + match[1]); + } else { + this.input.clearHint(); + } + }, + isEnabled: function isEnabled() { + return this.enabled; + }, + enable: function enable() { + this.enabled = true; + }, + disable: function disable() { + this.enabled = false; + }, + isActive: function isActive() { + return this.active; + }, + activate: function activate() { + if (this.isActive()) { + return true; + } else if (!this.isEnabled() || this.eventBus.before("active")) { + return false; + } else { + this.active = true; + this.eventBus.trigger("active"); + return true; + } + }, + deactivate: function deactivate() { + if (!this.isActive()) { + return true; + } else if (this.eventBus.before("idle")) { + return false; + } else { + this.active = false; + this.close(); + this.eventBus.trigger("idle"); + return true; + } + }, + isOpen: function isOpen() { + return this.menu.isOpen(); + }, + open: function open() { + if (!this.isOpen() && !this.eventBus.before("open")) { + this.input.setAriaExpanded(true); + this.menu.open(); + this._updateHint(); + this.eventBus.trigger("open"); + } + return this.isOpen(); + }, + close: function close() { + if (this.isOpen() && !this.eventBus.before("close")) { + this.input.setAriaExpanded(false); + this.menu.close(); + this.input.clearHint(); + this.input.resetInputValue(); + this.eventBus.trigger("close"); + } + return !this.isOpen(); + }, + setVal: function setVal(val) { + this.input.setQuery(_.toStr(val)); + }, + getVal: function getVal() { + return this.input.getQuery(); + }, + select: function select($selectable) { + var data = this.menu.getSelectableData($selectable); + if (data && !this.eventBus.before("select", data.obj, data.dataset)) { + this.input.setQuery(data.val, true); + this.eventBus.trigger("select", data.obj, data.dataset); + this.close(); + return true; + } + return false; + }, + autocomplete: function autocomplete($selectable) { + var query, data, isValid; + query = this.input.getQuery(); + data = this.menu.getSelectableData($selectable); + isValid = data && query !== data.val; + if (isValid && !this.eventBus.before("autocomplete", data.obj, data.dataset)) { + this.input.setQuery(data.val); + this.eventBus.trigger("autocomplete", data.obj, data.dataset); + return true; + } + return false; + }, + moveCursor: function moveCursor(delta) { + var query, $candidate, data, suggestion, datasetName, cancelMove, id; + query = this.input.getQuery(); + $candidate = this.menu.selectableRelativeToCursor(delta); + data = this.menu.getSelectableData($candidate); + suggestion = data ? data.obj : null; + datasetName = data ? data.dataset : null; + id = $candidate ? $candidate.attr("id") : null; + this.input.trigger("cursorchange", id); + cancelMove = this._minLengthMet() && this.menu.update(query); + if (!cancelMove && !this.eventBus.before("cursorchange", suggestion, datasetName)) { + this.menu.setCursor($candidate); + if (data) { + if (typeof data.val === "string") { + this.input.setInputValue(data.val); + } + } else { + this.input.resetInputValue(); + this._updateHint(); + } + this.eventBus.trigger("cursorchange", suggestion, datasetName); + return true; + } + return false; + }, + destroy: function destroy() { + this.input.destroy(); + this.menu.destroy(); + } + }); + return Typeahead; + function c(ctx) { + var methods = [].slice.call(arguments, 1); + return function() { + var args = [].slice.call(arguments); + _.each(methods, function(method) { + return ctx[method].apply(ctx, args); + }); + }; + } + }(); + (function() { + "use strict"; + var old, keys, methods; + old = $.fn.typeahead; + keys = { + www: "tt-www", + attrs: "tt-attrs", + typeahead: "tt-typeahead" + }; + methods = { + initialize: function initialize(o, datasets) { + var www; + datasets = _.isArray(datasets) ? datasets : [].slice.call(arguments, 1); + o = o || {}; + www = WWW(o.classNames); + return this.each(attach); + function attach() { + var $input, $wrapper, $hint, $menu, defaultHint, defaultMenu, eventBus, input, menu, status, typeahead, MenuConstructor; + _.each(datasets, function(d) { + d.highlight = !!o.highlight; + }); + $input = $(this); + $wrapper = $(www.html.wrapper); + $hint = $elOrNull(o.hint); + $menu = $elOrNull(o.menu); + defaultHint = o.hint !== false && !$hint; + defaultMenu = o.menu !== false && !$menu; + defaultHint && ($hint = buildHintFromInput($input, www)); + defaultMenu && ($menu = $(www.html.menu).css(www.css.menu)); + $hint && $hint.val(""); + $input = prepInput($input, www); + if (defaultHint || defaultMenu) { + $wrapper.css(www.css.wrapper); + $input.css(defaultHint ? www.css.input : www.css.inputWithNoHint); + $input.wrap($wrapper).parent().prepend(defaultHint ? $hint : null).append(defaultMenu ? $menu : null); + } + MenuConstructor = defaultMenu ? DefaultMenu : Menu; + eventBus = new EventBus({ + el: $input + }); + input = new Input({ + hint: $hint, + input: $input, + menu: $menu + }, www); + menu = new MenuConstructor({ + node: $menu, + datasets: datasets + }, www); + status = new Status({ + $input: $input, + menu: menu + }); + typeahead = new Typeahead({ + input: input, + menu: menu, + eventBus: eventBus, + minLength: o.minLength, + autoselect: o.autoselect + }, www); + $input.data(keys.www, www); + $input.data(keys.typeahead, typeahead); + } + }, + isEnabled: function isEnabled() { + var enabled; + ttEach(this.first(), function(t) { + enabled = t.isEnabled(); + }); + return enabled; + }, + enable: function enable() { + ttEach(this, function(t) { + t.enable(); + }); + return this; + }, + disable: function disable() { + ttEach(this, function(t) { + t.disable(); + }); + return this; + }, + isActive: function isActive() { + var active; + ttEach(this.first(), function(t) { + active = t.isActive(); + }); + return active; + }, + activate: function activate() { + ttEach(this, function(t) { + t.activate(); + }); + return this; + }, + deactivate: function deactivate() { + ttEach(this, function(t) { + t.deactivate(); + }); + return this; + }, + isOpen: function isOpen() { + var open; + ttEach(this.first(), function(t) { + open = t.isOpen(); + }); + return open; + }, + open: function open() { + ttEach(this, function(t) { + t.open(); + }); + return this; + }, + close: function close() { + ttEach(this, function(t) { + t.close(); + }); + return this; + }, + select: function select(el) { + var success = false, $el = $(el); + ttEach(this.first(), function(t) { + success = t.select($el); + }); + return success; + }, + autocomplete: function autocomplete(el) { + var success = false, $el = $(el); + ttEach(this.first(), function(t) { + success = t.autocomplete($el); + }); + return success; + }, + moveCursor: function moveCursoe(delta) { + var success = false; + ttEach(this.first(), function(t) { + success = t.moveCursor(delta); + }); + return success; + }, + val: function val(newVal) { + var query; + if (!arguments.length) { + ttEach(this.first(), function(t) { + query = t.getVal(); + }); + return query; + } else { + ttEach(this, function(t) { + t.setVal(_.toStr(newVal)); + }); + return this; + } + }, + destroy: function destroy() { + ttEach(this, function(typeahead, $input) { + revert($input); + typeahead.destroy(); + }); + return this; + } + }; + $.fn.typeahead = function(method) { + if (methods[method]) { + return methods[method].apply(this, [].slice.call(arguments, 1)); + } else { + return methods.initialize.apply(this, arguments); + } + }; + $.fn.typeahead.noConflict = function noConflict() { + $.fn.typeahead = old; + return this; + }; + function ttEach($els, fn) { + $els.each(function() { + var $input = $(this), typeahead; + (typeahead = $input.data(keys.typeahead)) && fn(typeahead, $input); + }); + } + function buildHintFromInput($input, www) { + return $input.clone().addClass(www.classes.hint).removeData().css(www.css.hint).css(getBackgroundStyles($input)).prop({ + readonly: true, + required: false + }).removeAttr("id name placeholder").removeClass("required").attr({ + spellcheck: "false", + tabindex: -1 + }); + } + function prepInput($input, www) { + $input.data(keys.attrs, { + dir: $input.attr("dir"), + autocomplete: $input.attr("autocomplete"), + spellcheck: $input.attr("spellcheck"), + style: $input.attr("style") + }); + $input.addClass(www.classes.input).attr({ + spellcheck: false + }); + try { + !$input.attr("dir") && $input.attr("dir", "auto"); + } catch (e) {} + return $input; + } + function getBackgroundStyles($el) { + return { + backgroundAttachment: $el.css("background-attachment"), + backgroundClip: $el.css("background-clip"), + backgroundColor: $el.css("background-color"), + backgroundImage: $el.css("background-image"), + backgroundOrigin: $el.css("background-origin"), + backgroundPosition: $el.css("background-position"), + backgroundRepeat: $el.css("background-repeat"), + backgroundSize: $el.css("background-size") + }; + } + function revert($input) { + var www, $wrapper; + www = $input.data(keys.www); + $wrapper = $input.parent().filter(www.selectors.wrapper); + _.each($input.data(keys.attrs), function(val, key) { + _.isUndefined(val) ? $input.removeAttr(key) : $input.attr(key, val); + }); + $input.removeData(keys.typeahead).removeData(keys.www).removeData(keys.attr).removeClass(www.classes.input); + if ($wrapper.length) { + $input.detach().insertAfter($wrapper); + $wrapper.remove(); + } + } + function $elOrNull(obj) { + var isValid, $el; + isValid = _.isJQuery(obj) || _.isElement(obj); + $el = isValid ? $(obj).first() : []; + return $el.length ? $el : null; + } + })(); +}); \ No newline at end of file diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/search.json b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/search.json new file mode 100644 index 00000000..35e53f3c --- /dev/null +++ b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/Documents/search.json @@ -0,0 +1 @@ +{"Blocks.html#/c:SCPBlocks.h@T@SCPConnectionTokenCompletionBlock":{"name":"SCPConnectionTokenCompletionBlock","abstract":"

A block called with a connection token or an error from your backend.

"},"Blocks.html#/c:SCPBlocks.h@T@SCPErrorCompletionBlock":{"name":"SCPErrorCompletionBlock","abstract":"

A block called with an optional error.

"},"Blocks.html#/c:SCPBlocks.h@T@SCPLogListenerBlock":{"name":"SCPLogListenerBlock","abstract":"

A block called with a logline from the SDK.

"},"Blocks.html#/c:SCPBlocks.h@T@SCPPaymentIntentCompletionBlock":{"name":"SCPPaymentIntentCompletionBlock","abstract":"

A block called with a PaymentIntent or an error.

"},"Blocks.html#/c:SCPBlocks.h@T@SCPPaymentMethodCompletionBlock":{"name":"SCPPaymentMethodCompletionBlock","abstract":"

A block called with a PaymentMethod.

"},"Blocks.html#/c:SCPBlocks.h@T@SCPProcessPaymentCompletionBlock":{"name":"SCPProcessPaymentCompletionBlock","abstract":"

A block called with a PaymentIntent or a ProcessPaymentError

"},"Blocks.html#/c:SCPBlocks.h@T@SCPReaderCompletionBlock":{"name":"SCPReaderCompletionBlock","abstract":"

A block called with a reader object or an error.

"},"Blocks.html#/c:SCPBlocks.h@T@SCPProcessRefundCompletionBlock":{"name":"SCPProcessRefundCompletionBlock","abstract":"

A block called with a Refund or a ProcessRefundError.

"},"Blocks.html#/c:SCPBlocks.h@T@SCPConfirmSetupIntentCompletionBlock":{"name":"SCPConfirmSetupIntentCompletionBlock","abstract":"

A block called with a SetupIntent or a ConfirmSetupIntentError.

"},"Blocks.html#/c:SCPBlocks.h@T@SCPLocationsCompletionBlock":{"name":"SCPLocationsCompletionBlock","abstract":"

A block called with a list of Locations or an error.

"},"Blocks.html#/c:SCPBlocks.h@T@SCPRefundCompletionBlock":{"name":"SCPRefundCompletionBlock","abstract":"

A block called with a Refund or an error.

"},"Blocks.html#/c:SCPBlocks.h@T@SCPSetupIntentCompletionBlock":{"name":"SCPSetupIntentCompletionBlock","abstract":"

A block called with a SetupIntent or an error.

"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBusy":{"name":"SCPErrorBusy","abstract":"

The SDK is busy executing another command. The SDK can only execute a","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCancelFailedAlreadyCompleted":{"name":"SCPErrorCancelFailedAlreadyCompleted","abstract":"

Canceling a command failed because the command already completed.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNotConnectedToReader":{"name":"SCPErrorNotConnectedToReader","abstract":"

No reader is connected. Connect to a reader before trying again.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAlreadyConnectedToReader":{"name":"SCPErrorAlreadyConnectedToReader","abstract":"

Already connected to a reader.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorConnectionTokenProviderCompletedWithNothing":{"name":"SCPErrorConnectionTokenProviderCompletedWithNothing","abstract":"

Your implementation of fetchConnectionToken called the completion block","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorProcessInvalidPaymentIntent":{"name":"SCPErrorProcessInvalidPaymentIntent","abstract":"

processPayment was called with an unknown or invalid PaymentIntent.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNilPaymentIntent":{"name":"SCPErrorNilPaymentIntent","abstract":"

collectPaymentMethod or processPayment was called with a nil PaymentIntent.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNilSetupIntent":{"name":"SCPErrorNilSetupIntent","abstract":"

collectSetupIntentPaymentMethod or processSetupIntent was called with","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNilRefundPaymentMethod":{"name":"SCPErrorNilRefundPaymentMethod","abstract":"

processRefund was called without calling collectRefundPaymentMethod","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidRefundParameters":{"name":"SCPErrorInvalidRefundParameters","abstract":"

The RefundParameters object has invalid values. The Charge ID (ch_123abc)","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidClientSecret":{"name":"SCPErrorInvalidClientSecret","abstract":"

A PaymentIntent or SetupIntent was referenced using an invalid client secret.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorMustBeDiscoveringToConnect":{"name":"SCPErrorMustBeDiscoveringToConnect","abstract":"

The SDK must be actively Discovering Readers in order to successfully","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCannotConnectToUndiscoveredReader":{"name":"SCPErrorCannotConnectToUndiscoveredReader","abstract":"

Before connecting to a reader, it must have already been discovered in the","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidDiscoveryConfiguration":{"name":"SCPErrorInvalidDiscoveryConfiguration","abstract":"

discoverReaders was called using an invalid SCPDiscoveryConfiguration.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidReaderForUpdate":{"name":"SCPErrorInvalidReaderForUpdate","abstract":"

installUpdate was passed an update that is for a different reader. Updates can only","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnsupportedSDK":{"name":"SCPErrorUnsupportedSDK","abstract":"

-[SCPTerminal connectReader:completion:] was called from an unsupported version","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorFeatureNotAvailableWithConnectedReader":{"name":"SCPErrorFeatureNotAvailableWithConnectedReader","abstract":"

This feature is currently not available for the selected reader.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorFeatureNotAvailable":{"name":"SCPErrorFeatureNotAvailable","abstract":"

This feature is not currently available.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidListLocationsLimitParameter":{"name":"SCPErrorInvalidListLocationsLimitParameter","abstract":"

The ListLocationsParameters object has invalid values.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothConnectionInvalidLocationIdParameter":{"name":"SCPErrorBluetoothConnectionInvalidLocationIdParameter","abstract":"

The locationId parameter to BluetoothConnectionConfiguration is required but a valid one was not provided.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidRequiredParameter":{"name":"SCPErrorInvalidRequiredParameter","abstract":"

A required parameter was invalid or missing.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderConnectionConfigurationInvalid":{"name":"SCPErrorReaderConnectionConfigurationInvalid","abstract":"

An invalid ConnectionConfiguration was passed through connect.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderTippingParameterInvalid":{"name":"SCPErrorReaderTippingParameterInvalid","abstract":"

An invalid usage of eligibleAmount or skipTipping was passed into collect.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidLocationIdParameter":{"name":"SCPErrorInvalidLocationIdParameter","abstract":"

The provided location ID parameter was invalid.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCanceled":{"name":"SCPErrorCanceled","abstract":"

The command was canceled by your app.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorLocationServicesDisabled":{"name":"SCPErrorLocationServicesDisabled","abstract":"

Access to location services is currently disabled. This may be because:

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothDisabled":{"name":"SCPErrorBluetoothDisabled","abstract":"

This error indicates that Bluetooth is turned off, and the user should use","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothAccessDenied":{"name":"SCPErrorBluetoothAccessDenied","abstract":"

Bluetooth is turned on on the device, but access to Bluetooth has been denied","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothScanTimedOut":{"name":"SCPErrorBluetoothScanTimedOut","abstract":"

Scanning for bluetooth devices timed out.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothLowEnergyUnsupported":{"name":"SCPErrorBluetoothLowEnergyUnsupported","abstract":"

Bluetooth Low Energy is unsupported on this iOS device. Use a different","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedBatteryLow":{"name":"SCPErrorReaderSoftwareUpdateFailedBatteryLow","abstract":"

Updating the reader software failed because the reader’s battery is","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedInterrupted":{"name":"SCPErrorReaderSoftwareUpdateFailedInterrupted","abstract":"

Updating the reader software failed because the update was interrupted.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedExpiredUpdate":{"name":"SCPErrorReaderSoftwareUpdateFailedExpiredUpdate","abstract":"

Updating the reader software failed because the update has expired. Please disconnect and","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothConnectionFailedBatteryCriticallyLow":{"name":"SCPErrorBluetoothConnectionFailedBatteryCriticallyLow","abstract":"

The reader has a critically low battery and cannot connect to the","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardInsertNotRead":{"name":"SCPErrorCardInsertNotRead","abstract":"

The card is not a chip card.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardSwipeNotRead":{"name":"SCPErrorCardSwipeNotRead","abstract":"

The swipe could not be read.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardReadTimedOut":{"name":"SCPErrorCardReadTimedOut","abstract":"

Reading a card timed out.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardRemoved":{"name":"SCPErrorCardRemoved","abstract":"

The card was removed during the transaction.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardLeftInReader":{"name":"SCPErrorCardLeftInReader","abstract":"

A card can only be used for one transaction, and must be removed after","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorMissingEMVData":{"name":"SCPErrorMissingEMVData","abstract":"

The reader failed to read the data from the presented payment method. If you encounter","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCommandNotAllowed":{"name":"SCPErrorCommandNotAllowed","abstract":"

The command was not permitted to execute by the operating system.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnsupportedMobileDeviceConfiguration":{"name":"SCPErrorUnsupportedMobileDeviceConfiguration","abstract":"

The mobile device on which the app is running is in an unsupported","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorPasscodeNotEnabled":{"name":"SCPErrorPasscodeNotEnabled","abstract":"

The mobile device on which the app is running must have a passcode set.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCommandNotAllowedDuringCall":{"name":"SCPErrorCommandNotAllowedDuringCall","abstract":"

The card reader cannot be used while a phone call is active.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidAmount":{"name":"SCPErrorInvalidAmount","abstract":"

An attempt was made to charge an amount not supported by the reader.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidCurrency":{"name":"SCPErrorInvalidCurrency","abstract":"

An attempt was made to charge an amount in a currency not supported by the reader.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderTOSAcceptanceRequiresiCloudSignIn":{"name":"SCPErrorAppleBuiltInReaderTOSAcceptanceRequiresiCloudSignIn","abstract":"

Failed to accept reader-specific terms of service because there is no iCloud","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderTOSAcceptanceCanceled":{"name":"SCPErrorAppleBuiltInReaderTOSAcceptanceCanceled","abstract":"

The user cancelled reader-specific terms of service acceptance.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderBusy":{"name":"SCPErrorReaderBusy","abstract":"

The reader is busy.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorIncompatibleReader":{"name":"SCPErrorIncompatibleReader","abstract":"

An incompatible reader was detected. You can only use the Stripe Terminal","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderCommunicationError":{"name":"SCPErrorReaderCommunicationError","abstract":"

Could not communicate with the reader.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNFCDisabled":{"name":"SCPErrorNFCDisabled","abstract":"

NFC functionality is disabled.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothError":{"name":"SCPErrorBluetoothError","abstract":"

Generic Bluetooth error.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothConnectTimedOut":{"name":"SCPErrorBluetoothConnectTimedOut","abstract":"

Connecting to the bluetooth device timed out. Make sure the device is","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothDisconnected":{"name":"SCPErrorBluetoothDisconnected","abstract":"

The Bluetooth device was disconnected unexpectedly.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothPeerRemovedPairingInformation":{"name":"SCPErrorBluetoothPeerRemovedPairingInformation","abstract":"

Bluetooth pairing error, the reader has removed this device pairing information.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothAlreadyPairedWithAnotherDevice":{"name":"SCPErrorBluetoothAlreadyPairedWithAnotherDevice","abstract":"

The Bluetooth reader is already paired to another device. The Bluetooth reader","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailed":{"name":"SCPErrorReaderSoftwareUpdateFailed","abstract":"

Generic reader software update error.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedReaderError":{"name":"SCPErrorReaderSoftwareUpdateFailedReaderError","abstract":"

Updating the reader software failed because there was an error","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedServerError":{"name":"SCPErrorReaderSoftwareUpdateFailedServerError","abstract":"

Updating the reader software failed because there was an error","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnsupportedReaderVersion":{"name":"SCPErrorUnsupportedReaderVersion","abstract":"

processPayment was called from a reader with an unsupported reader","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnknownReaderIpAddress":{"name":"SCPErrorUnknownReaderIpAddress","abstract":"

The reader returned from discovery does not have an IP address and cannot","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInternetConnectTimeOut":{"name":"SCPErrorInternetConnectTimeOut","abstract":"

Connecting to reader over the internet timed out. Make sure your device and","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorConnectFailedReaderIsInUse":{"name":"SCPErrorConnectFailedReaderIsInUse","abstract":"

Connecting to the reader failed because it is currently in use","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothReconnectStarted":{"name":"SCPErrorBluetoothReconnectStarted","abstract":"

The Bluetooth reader has disconnected and we are attempting to reconnect.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderNotAccessibleInBackground":{"name":"SCPErrorReaderNotAccessibleInBackground","abstract":"

An attempt was made to interact with the reader while the the app is in the background.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderFailedToPrepare":{"name":"SCPErrorAppleBuiltInReaderFailedToPrepare","abstract":"

Preparing the Apple Built-In reader to collect payments failed.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderDeviceBanned":{"name":"SCPErrorAppleBuiltInReaderDeviceBanned","abstract":"

This device cannot be used to process using the Apple Built-In reader as it has been banned.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderTOSNotYetAccepted":{"name":"SCPErrorAppleBuiltInReaderTOSNotYetAccepted","abstract":"

The operation could not be completed because the reader-specific terms of service have","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderTOSAcceptanceFailed":{"name":"SCPErrorAppleBuiltInReaderTOSAcceptanceFailed","abstract":"

Failed to accept reader-specific terms of service using the signed-in Apple ID.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderMerchantBlocked":{"name":"SCPErrorAppleBuiltInReaderMerchantBlocked","abstract":"

This merchant account cannot be used with Apple Built-In reader as it has been blocked.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderInvalidMerchant":{"name":"SCPErrorAppleBuiltInReaderInvalidMerchant","abstract":"

This merchant account cannot be used with the Apple Built-In reader as it is invalid.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnexpectedSdkError":{"name":"SCPErrorUnexpectedSdkError","abstract":"

Unexpected SDK error.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnexpectedReaderError":{"name":"SCPErrorUnexpectedReaderError","abstract":"

Unexpected reader error.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorDeclinedByStripeAPI":{"name":"SCPErrorDeclinedByStripeAPI","abstract":"

The Stripe API declined the transaction.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorDeclinedByReader":{"name":"SCPErrorDeclinedByReader","abstract":"

The reader declined the transaction. Try another card.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCommandRequiresCardholderConsent":{"name":"SCPErrorCommandRequiresCardholderConsent","abstract":"

The cardholder must give consent in order for this operation to succeed.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorRefundFailed":{"name":"SCPErrorRefundFailed","abstract":"

The refund failed. The customer’s bank or card issuer was unable to process","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNotConnectedToInternet":{"name":"SCPErrorNotConnectedToInternet","abstract":"

The SDK is not connected to the internet.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorRequestTimedOut":{"name":"SCPErrorRequestTimedOut","abstract":"

The underlying request timed out.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorStripeAPIError":{"name":"SCPErrorStripeAPIError","abstract":"

The underlying request returned an API error.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorStripeAPIResponseDecodingError":{"name":"SCPErrorStripeAPIResponseDecodingError","abstract":"

The API response from Stripe could not be decoded.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInternalNetworkError":{"name":"SCPErrorInternalNetworkError","abstract":"

Generic network error

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorConnectionTokenProviderCompletedWithError":{"name":"SCPErrorConnectionTokenProviderCompletedWithError","abstract":"

Your implementation of -[SCPConnectionTokenProvider fetchConnectionToken:]","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorSessionExpired":{"name":"SCPErrorSessionExpired","abstract":"

The current session has expired and the reader must be disconnected and","parent_name":"SCPError"},"Enums/SCPError.html":{"name":"SCPError","abstract":"

Possible error codes for NSError objects under the SCPErrorDomain domain.

"},"Errors.html#/c:@SCPErrorDomain":{"name":"SCPErrorDomain","abstract":"

The error domain for all errors originating from the Stripe Terminal SDK.

"},"Errors.html#/c:SCPErrors.h@T@SCPErrorKey":{"name":"SCPErrorKey","abstract":"

Use this enum to access userInfo keys for NSError objects under the"},"Errors.html#/c:@SCPErrorKeyMessage":{"name":"SCPErrorKeyMessage","abstract":"

An error message explaining what went wrong. You probably shouldn’t show this"},"Errors.html#/c:@SCPErrorKeyHttpStatusCode":{"name":"SCPErrorKeyHttpStatusCode","abstract":"

The HTTP status code of the response.

"},"Errors.html#/c:@SCPErrorKeyReaderMessage":{"name":"SCPErrorKeyReaderMessage","abstract":"

This error message comes from the reader. You probably shouldn’t show this"},"Errors.html#/c:@SCPErrorKeyDeviceBannedUntilDate":{"name":"SCPErrorKeyDeviceBannedUntilDate","abstract":"

If an Apple Built-In reader fails to connect due to a device ban and the error"},"Errors.html#/c:@SCPErrorKeyStripeAPIRequestId":{"name":"SCPErrorKeyStripeAPIRequestId","abstract":"

If a Stripe API request failed, the failed request’s id will be returned in the"},"Errors.html#/c:@SCPErrorKeyStripeAPIDeclineCode":{"name":"SCPErrorKeyStripeAPIDeclineCode","abstract":"

The decline code returned by the Stripe API.

"},"Errors.html#/c:@SCPErrorKeyStripeAPIErrorCode":{"name":"SCPErrorKeyStripeAPIErrorCode","abstract":"

The error code returned by the Stripe API.

"},"Errors.html#/c:@SCPErrorKeyStripeAPIErrorParameter":{"name":"SCPErrorKeyStripeAPIErrorParameter","abstract":"

The parameter the error relates to if the error is parameter-specific.

"},"Errors.html#/c:@SCPErrorKeyStripeAPIErrorType":{"name":"SCPErrorKeyStripeAPIErrorType","abstract":"

The error type returned by the Stripe API.

"},"Errors.html#/c:@SCPErrorKeyStripeAPIPaymentIntent":{"name":"SCPErrorKeyStripeAPIPaymentIntent","abstract":"

If a Stripe API request failed and the error has an associated PaymentIntent,"},"Errors.html#/c:@SCPErrorKeyStripeAPIDocUrl":{"name":"SCPErrorKeyStripeAPIDocUrl","abstract":"

The documentation URL for the error returned by the Stripe API.

"},"Errors.html#/c:@SCPErrorKeyStripeAPIFailureReason":{"name":"SCPErrorKeyStripeAPIFailureReason","abstract":"

If a refund fails, the reason for refund failure if known. Possible values"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(py)setupIntent":{"name":"setupIntent","abstract":"

The updated SetupIntent after confirmSetupIntent failed.

","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(py)requestError":{"name":"requestError","abstract":"

If confirmSetupIntent failed because the underlying network request errored,","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(py)declineCode":{"name":"declineCode","abstract":"

If confirmSetupIntent failed because the payment method was declined, this","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPSetupAttemptCardPresentDetails.html#/c:objc(cs)SCPSetupAttemptCardPresentDetails(py)generatedCard":{"name":"generatedCard","abstract":"

The ID of the Card PaymentMethod which was generated by this SetupAttempt.

","parent_name":"SCPSetupAttemptCardPresentDetails"},"Classes/SCPSetupAttemptCardPresentDetails.html#/c:objc(cs)SCPSetupAttemptCardPresentDetails(py)emvAuthData":{"name":"emvAuthData","abstract":"

The Authorization Response Cryptogram (ARPC) from the issuer.

","parent_name":"SCPSetupAttemptCardPresentDetails"},"Classes/SCPSetupAttemptCardPresentDetails.html#/c:objc(cs)SCPSetupAttemptCardPresentDetails(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPSetupAttemptCardPresentDetails"},"Classes/SCPSetupAttemptCardPresentDetails.html#/c:objc(cs)SCPSetupAttemptCardPresentDetails(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPSetupAttemptCardPresentDetails"},"Classes/SCPSetupAttemptPaymentMethodDetails.html#/c:objc(cs)SCPSetupAttemptPaymentMethodDetails(py)type":{"name":"type","abstract":"

The type of the PaymentMethod. The corresponding, similarly named property","parent_name":"SCPSetupAttemptPaymentMethodDetails"},"Classes/SCPSetupAttemptPaymentMethodDetails.html#/c:objc(cs)SCPSetupAttemptPaymentMethodDetails(py)cardPresent":{"name":"cardPresent","abstract":"

If this is a card present payment method (ie self.type == SCPPaymentMethodTypeCardPresent),","parent_name":"SCPSetupAttemptPaymentMethodDetails"},"Classes/SCPSetupAttemptPaymentMethodDetails.html#/c:objc(cs)SCPSetupAttemptPaymentMethodDetails(py)interacPresent":{"name":"interacPresent","abstract":"

If this is a card present payment method (ie self.type == SCPPaymentMethodTypeInteracPresent),","parent_name":"SCPSetupAttemptPaymentMethodDetails"},"Classes/SCPSetupAttemptPaymentMethodDetails.html#/c:objc(cs)SCPSetupAttemptPaymentMethodDetails(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPSetupAttemptPaymentMethodDetails"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)application":{"name":"application","abstract":"

The ID of the Connect application that created the SetupIntent.

","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)created":{"name":"created","abstract":"

Time at which the object was created.

","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)customer":{"name":"customer","abstract":"

ID of the Customer this SetupIntent belongs to, if one exists.

","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)onBehalfOf":{"name":"onBehalfOf","abstract":"

(Connect) The account (if any) for which the setup is intended.

","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)paymentMethod":{"name":"paymentMethod","abstract":"

ID of the payment method used with this SetupAttempt.

","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)paymentMethodDetails":{"name":"paymentMethodDetails","abstract":"

Details about the payment method at the time of SetupIntent confirmation.

","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)setupIntent":{"name":"setupIntent","abstract":"

ID of the SetupIntent that this attempt belongs to.

","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)status":{"name":"status","abstract":"

The status of this SetupAttempt. One of: requires_confirmation,","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)stripeId":{"name":"stripeId","abstract":"

The unique identifier for the SetupAttempt.

","parent_name":"SCPSetupAttempt"},"Enums/SCPSetupIntentUsage.html#/c:@E@SCPSetupIntentUsage@SCPSetupIntentUsageOffSession":{"name":"SCPSetupIntentUsageOffSession","abstract":"

An off-session usage indicates to Stripe that future payments will take place","parent_name":"SCPSetupIntentUsage"},"Enums/SCPSetupIntentUsage.html#/c:@E@SCPSetupIntentUsage@SCPSetupIntentUsageOnSession":{"name":"SCPSetupIntentUsageOnSession","abstract":"

An on-session usage indicates to Stripe that future payments will take place","parent_name":"SCPSetupIntentUsage"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusRequiresPaymentMethod":{"name":"SCPSetupIntentStatusRequiresPaymentMethod","abstract":"

Next step: collect a payment method by calling collectPaymentMethod.

","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusRequiresConfirmation":{"name":"SCPSetupIntentStatusRequiresConfirmation","abstract":"

Next step: confirm the SetupIntent by calling confirmSetupIntent.

","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusRequiresAction":{"name":"SCPSetupIntentStatusRequiresAction","abstract":"

If the setup requires additional actions, such as authenticating with","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusProcessing":{"name":"SCPSetupIntentStatusProcessing","abstract":"

Once required actions are handled, the SetupIntent moves to processing.","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusCanceled":{"name":"SCPSetupIntentStatusCanceled","abstract":"

The SetupIntent was canceled.

","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusSucceeded":{"name":"SCPSetupIntentStatusSucceeded","abstract":"

The SetupIntent succeeded.

","parent_name":"SCPSetupIntentStatus"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)customer":{"name":"customer","abstract":"

ID of the customer this SetupIntent belongs to, if one exists.

","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)stripeDescription":{"name":"stripeDescription","abstract":"

An arbitrary string attached to the object. Often useful for displaying to users.

","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)metadata":{"name":"metadata","abstract":"

Set of key-value pairs that you can attach to an object. This can be useful for","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)usage":{"name":"usage","abstract":"

Indicates how the payment method is intended to be used in the future. If not","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)onBehalfOf":{"name":"onBehalfOf","abstract":"

Connect Only:** The Stripe account ID for which this SetupIntent is created.

","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(im)initWithCustomer:":{"name":"-initWithCustomer:","abstract":"

Initializes SCPSetupIntentParameters with the given customer ID.

","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(im)init":{"name":"-init","abstract":"

Use initWithCustomer:

","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(cm)new":{"name":"+new","abstract":"

Use initWithCustomer:

","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)description":{"name":"description","abstract":"

Use stripeDescription for the string attached to the object.

","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)stripeId":{"name":"stripeId","abstract":"

The unique identifier for the intent.

","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)created":{"name":"created","abstract":"

When the intent was created.

","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)customer":{"name":"customer","abstract":"

The identifier of a customer object to which the SetupIntent is attached, if applicable.

","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)metadata":{"name":"metadata","abstract":"

Set of key-value pairs attached to the object.

","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)usage":{"name":"usage","abstract":"

An SCPSetupIntentUsage value describing how the SetupIntent will be used.","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)status":{"name":"status","abstract":"

The status of the intent.

","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)latestAttempt":{"name":"latestAttempt","abstract":"

The most recent SetupAttempt for this SetupIntent

","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class. You should only use SetupIntents","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class. You should only use SetupIntents","parent_name":"SCPSetupIntent"},"Classes/SCPReadReusableCardParameters.html#/c:objc(cs)SCPReadReusableCardParameters(py)customer":{"name":"customer","abstract":"

Optional parameter: attach the new PaymentMethod to Customer with this id

","parent_name":"SCPReadReusableCardParameters"},"Classes/SCPReadReusableCardParameters.html#/c:objc(cs)SCPReadReusableCardParameters(py)metadata":{"name":"metadata","abstract":"

Optional set of key-value pairs attached to the object. The default is nil.

","parent_name":"SCPReadReusableCardParameters"},"Classes/SCPReadReusableCardParameters.html":{"name":"SCPReadReusableCardParameters","abstract":"

Parameters for reading a reusable card.

"},"Classes/SCPSetupIntent.html":{"name":"SCPSetupIntent","abstract":"

A SetupIntent guides you through the process of setting up and saving a"},"Classes/SCPSetupIntentParameters.html":{"name":"SCPSetupIntentParameters","abstract":"

Parameters for creating an SCPSetupIntent.

"},"Enums/SCPSetupIntentStatus.html":{"name":"SCPSetupIntentStatus","abstract":"

The possible statuses of the SetupIntent.

"},"Enums/SCPSetupIntentUsage.html":{"name":"SCPSetupIntentUsage","abstract":"

The SetupIntent usage options tell Stripe how the payment method is intended to be used in the future."},"Classes/SCPSetupAttempt.html":{"name":"SCPSetupAttempt","abstract":"

A SetupAttempt describes one attempted confirmation of a SetupIntent,"},"Classes/SCPSetupAttemptPaymentMethodDetails.html":{"name":"SCPSetupAttemptPaymentMethodDetails","abstract":"

Details about a PaymentMethod at a specific time. ex: at time of transaction"},"Classes/SCPSetupAttemptCardPresentDetails.html":{"name":"SCPSetupAttemptCardPresentDetails","abstract":"

An object representing details from a transaction using a card_present"},"Classes/SCPConfirmSetupIntentError.html":{"name":"SCPConfirmSetupIntentError","abstract":"

An error from -[SCPTerminal confirmSetupIntent:completion:]

"},"Enums/SCPRefundStatus.html#/c:@E@SCPRefundStatus@SCPRefundStatusSucceeded":{"name":"SCPRefundStatusSucceeded","abstract":"

The refund succeeded.

","parent_name":"SCPRefundStatus"},"Enums/SCPRefundStatus.html#/c:@E@SCPRefundStatus@SCPRefundStatusPending":{"name":"SCPRefundStatusPending","abstract":"

The refund is pending.

","parent_name":"SCPRefundStatus"},"Enums/SCPRefundStatus.html#/c:@E@SCPRefundStatus@SCPRefundStatusFailed":{"name":"SCPRefundStatusFailed","abstract":"

The refund failed.

","parent_name":"SCPRefundStatus"},"Enums/SCPRefundStatus.html#/c:@E@SCPRefundStatus@SCPRefundStatusUnknown":{"name":"SCPRefundStatusUnknown","abstract":"

Unknown refund state.

","parent_name":"SCPRefundStatus"},"Classes/SCPProcessRefundError.html#/c:objc(cs)SCPProcessRefundError(py)refund":{"name":"refund","abstract":"

If processRefund failed after the refund was created, this property contains","parent_name":"SCPProcessRefundError"},"Classes/SCPProcessRefundError.html#/c:objc(cs)SCPProcessRefundError(py)requestError":{"name":"requestError","abstract":"

If processRefund failed because the underlying network request errored,","parent_name":"SCPProcessRefundError"},"Classes/SCPProcessRefundError.html#/c:objc(cs)SCPProcessRefundError(cm)init":{"name":"+init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPProcessRefundError"},"Classes/SCPProcessRefundError.html#/c:objc(cs)SCPProcessRefundError(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPProcessRefundError"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)chargeId":{"name":"chargeId","abstract":"

The ID of the charge to be refunded.

","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)amount":{"name":"amount","abstract":"

The amount of the refund, provided in the currency’s smallest unit.

","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)currency":{"name":"currency","abstract":"

Three-letter ISO currency code. Must be a supported currency.

","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)metadata":{"name":"metadata","abstract":"

Set of key-value pairs that you can attach to an object. This can be useful for","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)reverseTransfer":{"name":"reverseTransfer","abstract":"

Connect only: Nullable boolean indicating whether the transfer should be","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)refundApplicationFee":{"name":"refundApplicationFee","abstract":"

Connect only: Nullable boolean indicating whether the application fee should be","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(im)initWithChargeId:amount:currency:":{"name":"-initWithChargeId:amount:currency:","abstract":"

Initializes SCPRefundParameters with the given charge, amount, and currency.

","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(im)init":{"name":"-init","abstract":"

Use initWithChargeId:amount:currency:

","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(cm)new":{"name":"+new","abstract":"

Use initWithChargeId:amount:currency:

","parent_name":"SCPRefundParameters"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)stripeId":{"name":"stripeId","abstract":"

The unique identifier for the refund.

","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)amount":{"name":"amount","abstract":"

The amount that was refunded.

","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)charge":{"name":"charge","abstract":"

The ID of the charge that was refunded

","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)created":{"name":"created","abstract":"

When the refund object was created.

","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)currency":{"name":"currency","abstract":"

The currency of the amount refunded.

","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)metadata":{"name":"metadata","abstract":"

Metadata associated with the refund.

","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)reason":{"name":"reason","abstract":"

Reason for the refund, either user-provided (duplicate, fraudulent, or","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)status":{"name":"status","abstract":"

The status of the refund.

","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)paymentMethodDetails":{"name":"paymentMethodDetails","abstract":"

The payment method details associated with the refund.

","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)failureReason":{"name":"failureReason","abstract":"

If the refund failed, the reason for refund failure if known.

","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPRefund"},"Classes/SCPRefund.html":{"name":"SCPRefund","abstract":"

An object representing a Stripe refund.

"},"Classes/SCPRefundParameters.html":{"name":"SCPRefundParameters","abstract":"

Parameters for creating an SCPRefund.

"},"Classes/SCPProcessRefundError.html":{"name":"SCPProcessRefundError","abstract":"

An error from -[SCPTerminal processRefund:completion:].

"},"Enums/SCPRefundStatus.html":{"name":"SCPRefundStatus","abstract":"

The possible statuses for a refund.

"},"Enums/SCPIncrementalAuthorizationStatus.html#/c:@E@SCPIncrementalAuthorizationStatus@SCPIncrementalAuthorizationStatusUnknown":{"name":"SCPIncrementalAuthorizationStatusUnknown","abstract":"

It is undetermined whether or not this PaymentIntent will be eligible for incremental authorizations.","parent_name":"SCPIncrementalAuthorizationStatus"},"Enums/SCPIncrementalAuthorizationStatus.html#/c:@E@SCPIncrementalAuthorizationStatus@SCPIncrementalAuthorizationStatusNotSupported":{"name":"SCPIncrementalAuthorizationStatusNotSupported","abstract":"

This PaymentIntent is not eligible for incremental authorizations, or it was not requested.

","parent_name":"SCPIncrementalAuthorizationStatus"},"Enums/SCPIncrementalAuthorizationStatus.html#/c:@E@SCPIncrementalAuthorizationStatus@SCPIncrementalAuthorizationStatusSupported":{"name":"SCPIncrementalAuthorizationStatusSupported","abstract":"

This PaymentIntent is eligible for incremental authorizations.

","parent_name":"SCPIncrementalAuthorizationStatus"},"Classes/SCPNetworks.html#/c:objc(cs)SCPNetworks(py)available":{"name":"available","abstract":"

All available networks for the card.

","parent_name":"SCPNetworks"},"Classes/SCPNetworks.html#/c:objc(cs)SCPNetworks(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPNetworks"},"Classes/SCPNetworks.html#/c:objc(cs)SCPNetworks(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPNetworks"},"Classes/SCPTippingConfiguration.html#/c:objc(cs)SCPTippingConfiguration(py)eligibleAmount":{"name":"eligibleAmount","abstract":"

The amount of the payment total eligible for tips.

","parent_name":"SCPTippingConfiguration"},"Classes/SCPTippingConfiguration.html#/c:objc(cs)SCPTippingConfiguration(im)initWithEligibleAmount:":{"name":"-initWithEligibleAmount:","abstract":"

Initialize a TippingConfiguration instance.

","parent_name":"SCPTippingConfiguration"},"Classes/SCPTippingConfiguration.html#/c:objc(cs)SCPTippingConfiguration(im)init":{"name":"-init","abstract":"

Use initWithEligibleAmount:

","parent_name":"SCPTippingConfiguration"},"Classes/SCPTippingConfiguration.html#/c:objc(cs)SCPTippingConfiguration(cm)new":{"name":"+new","abstract":"

Use initWithEligibleAmount:

","parent_name":"SCPTippingConfiguration"},"Enums/SCPCaptureMethod.html#/c:@E@SCPCaptureMethod@SCPCaptureMethodManual":{"name":"SCPCaptureMethodManual","abstract":"

Place a hold on the funds when the customer authorizes the payment, but don’t","parent_name":"SCPCaptureMethod"},"Enums/SCPCaptureMethod.html#/c:@E@SCPCaptureMethod@SCPCaptureMethodAutomatic":{"name":"SCPCaptureMethodAutomatic","abstract":"

Stripe automatically captures funds when the customer authorizes the payment.

","parent_name":"SCPCaptureMethod"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(py)skipTipping":{"name":"skipTipping","abstract":"

Bypass tipping selection if it would have otherwise been shown.

","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(py)tippingConfiguration":{"name":"tippingConfiguration","abstract":"

The tipping configuration for this payment collection.

","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(py)updatePaymentIntent":{"name":"updatePaymentIntent","abstract":"

Whether or not to update the PaymentIntent server side during collectPaymentMethod.

","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithSkipTipping:":{"name":"-initWithSkipTipping:","abstract":"

Initialize a CollectConfiguration

","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithUpdatePaymentIntent:":{"name":"-initWithUpdatePaymentIntent:","abstract":"

Initialize a CollectConfiguration

","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithTippingConfiguration:":{"name":"-initWithTippingConfiguration:","abstract":"

Initialize a CollectConfiguration.

","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithSkipTipping:updatePaymentIntent:":{"name":"-initWithSkipTipping:updatePaymentIntent:","abstract":"

Initialize a CollectConfiguration

","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithSkipTipping:tippingConfiguration:":{"name":"-initWithSkipTipping:tippingConfiguration:","abstract":"

Initialize a CollectConfiguration.

","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithUpdatePaymentIntent:tippingConfiguration:":{"name":"-initWithUpdatePaymentIntent:tippingConfiguration:","abstract":"

Initialize a CollectConfiguration.

","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithSkipTipping:updatePaymentIntent:tippingConfiguration:":{"name":"-initWithSkipTipping:updatePaymentIntent:tippingConfiguration:","abstract":"

Initialize a CollectConfiguration.

","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)init":{"name":"-init","abstract":"

Use initWithSkipTipping:updatePaymentIntent:tippingConfiguration: or helper initializers.

","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(cm)new":{"name":"+new","abstract":"

Use initWithSkipTipping:updatePaymentIntent:tippingConfiguration: or helper initializers.

","parent_name":"SCPCollectConfiguration"},"Classes/SCPPaymentMethodOptionsParameters.html#/c:objc(cs)SCPPaymentMethodOptionsParameters(py)cardPresentParameters":{"name":"cardPresentParameters","abstract":"

Card-present-specific configuration for this PaymentMethod.

","parent_name":"SCPPaymentMethodOptionsParameters"},"Classes/SCPPaymentMethodOptionsParameters.html#/c:objc(cs)SCPPaymentMethodOptionsParameters(im)initWithCardPresentParameters:":{"name":"-initWithCardPresentParameters:","abstract":"

Initialize a PaymentMethodOptionsParameters

","parent_name":"SCPPaymentMethodOptionsParameters"},"Classes/SCPPaymentMethodOptionsParameters.html#/c:objc(cs)SCPPaymentMethodOptionsParameters(im)init":{"name":"-init","abstract":"

Use initWithCardPresentParameters:(SCPCardPresentParameters)cardPresentParameters

","parent_name":"SCPPaymentMethodOptionsParameters"},"Enums/SCPPaymentMethodType.html#/c:@E@SCPPaymentMethodType@SCPPaymentMethodTypeCard":{"name":"SCPPaymentMethodTypeCard","abstract":"

A card payment method.

","parent_name":"SCPPaymentMethodType"},"Enums/SCPPaymentMethodType.html#/c:@E@SCPPaymentMethodType@SCPPaymentMethodTypeCardPresent":{"name":"SCPPaymentMethodTypeCardPresent","abstract":"

A card present payment method.

","parent_name":"SCPPaymentMethodType"},"Enums/SCPPaymentMethodType.html#/c:@E@SCPPaymentMethodType@SCPPaymentMethodTypeInteracPresent":{"name":"SCPPaymentMethodTypeInteracPresent","abstract":"

An Interac Present payment method.

","parent_name":"SCPPaymentMethodType"},"Enums/SCPPaymentMethodType.html#/c:@E@SCPPaymentMethodType@SCPPaymentMethodTypeUnknown":{"name":"SCPPaymentMethodTypeUnknown","abstract":"

An unknown type.

","parent_name":"SCPPaymentMethodType"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)stripeId":{"name":"stripeId","abstract":"

The unique identifier for the PaymentMethod

","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)created":{"name":"created","abstract":"

Time at which the object was created. Measured in seconds since the Unix epoch.

","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)type":{"name":"type","abstract":"

The type of the PaymentMethod. The corresponding, similarly named property contains additional information specific to the PaymentMethod type.","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)card":{"name":"card","abstract":"

If this is a card PaymentMethod (ie self.type == SCPPaymentMethodTypeCard), this contains additional details.

","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)cardPresent":{"name":"cardPresent","abstract":"

If this is a card_present PaymentMethod (ie self.type == SCPPaymentMethodTypeCardPresent), this contains additional details.

","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)interacPresent":{"name":"interacPresent","abstract":"

If this is an Interac_present PaymentMethod (ie self.type == SCPPaymentMethodTypeInteracPresent), this contains additional details.

","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)customer":{"name":"customer","abstract":"

The Customer that this PaymentMethod is attached to, or nil.

","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)metadata":{"name":"metadata","abstract":"

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPPaymentMethod"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)brand":{"name":"brand","abstract":"

The issuer of the card.

","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)country":{"name":"country","abstract":"

Two-letter ISO code representing the country of the card.

","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)expMonth":{"name":"expMonth","abstract":"

Two-digit number representing the card’s expiration month.","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)expYear":{"name":"expYear","abstract":"

Four-digit number representing the card’s expiration year.","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)funding":{"name":"funding","abstract":"

Card funding type. Ex: credit, debit, etc.

","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)last4":{"name":"last4","abstract":"

The last four digits of the card.

","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)fingerprint":{"name":"fingerprint","abstract":"

Uniquely identifies this particular card number. You can use this attribute","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPCardDetails"},"Classes/SCPPaymentMethodDetails.html#/c:objc(cs)SCPPaymentMethodDetails(py)type":{"name":"type","abstract":"

The type of the PaymentMethod. The corresponding, similarly named property","parent_name":"SCPPaymentMethodDetails"},"Classes/SCPPaymentMethodDetails.html#/c:objc(cs)SCPPaymentMethodDetails(py)cardPresent":{"name":"cardPresent","abstract":"

If this is a card present payment method (ie self.type == SCPPaymentMethodTypeCardPresent),","parent_name":"SCPPaymentMethodDetails"},"Classes/SCPPaymentMethodDetails.html#/c:objc(cs)SCPPaymentMethodDetails(py)interacPresent":{"name":"interacPresent","abstract":"

If this is an Interac present payment method (ie self.type == SCPPaymentMethodTypeInteracPresent),","parent_name":"SCPPaymentMethodDetails"},"Classes/SCPPaymentMethodDetails.html#/c:objc(cs)SCPPaymentMethodDetails(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPPaymentMethodDetails"},"Enums/SCPChargeStatus.html#/c:@E@SCPChargeStatus@SCPChargeStatusSucceeded":{"name":"SCPChargeStatusSucceeded","abstract":"

The charge succeeded.

","parent_name":"SCPChargeStatus"},"Enums/SCPChargeStatus.html#/c:@E@SCPChargeStatus@SCPChargeStatusPending":{"name":"SCPChargeStatusPending","abstract":"

The charge succeeded.

","parent_name":"SCPChargeStatus"},"Enums/SCPChargeStatus.html#/c:@E@SCPChargeStatus@SCPChargeStatusFailed":{"name":"SCPChargeStatusFailed","abstract":"

The charge failed.

","parent_name":"SCPChargeStatus"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)amount":{"name":"amount","abstract":"

The amount of the charge.

","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)currency":{"name":"currency","abstract":"

The currency of the charge.

","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)status":{"name":"status","abstract":"

The status of the charge.

","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)paymentMethodDetails":{"name":"paymentMethodDetails","abstract":"

The payment method details associated with the charge.

","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)stripeDescription":{"name":"stripeDescription","abstract":"

A string describing the charge, displayed in the Stripe dashboard and in","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)metadata":{"name":"metadata","abstract":"

Metadata associated with the charge.

","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)stripeId":{"name":"stripeId","abstract":"

The unique identifier for the charge.

","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)statementDescriptorSuffix":{"name":"statementDescriptorSuffix","abstract":"

Extra dynamic information about a Charge. This will appear concatenated with the statementDescriptor on","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)calculatedStatementDescriptor":{"name":"calculatedStatementDescriptor","abstract":"

The full statement descriptor that is displayed on your customer’s credit card’s statement, after the","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPCharge"},"Enums/SCPCardFundingType.html#/c:@E@SCPCardFundingType@SCPCardFundingTypeDebit":{"name":"SCPCardFundingTypeDebit","abstract":"

Debit

","parent_name":"SCPCardFundingType"},"Enums/SCPCardFundingType.html#/c:@E@SCPCardFundingType@SCPCardFundingTypeCredit":{"name":"SCPCardFundingTypeCredit","abstract":"

Credit

","parent_name":"SCPCardFundingType"},"Enums/SCPCardFundingType.html#/c:@E@SCPCardFundingType@SCPCardFundingTypePrepaid":{"name":"SCPCardFundingTypePrepaid","abstract":"

Prepaid

","parent_name":"SCPCardFundingType"},"Enums/SCPCardFundingType.html#/c:@E@SCPCardFundingType@SCPCardFundingTypeOther":{"name":"SCPCardFundingTypeOther","abstract":"

An other or unknown type of funding source

","parent_name":"SCPCardFundingType"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandVisa":{"name":"SCPCardBrandVisa","abstract":"

Visa card

","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandAmex":{"name":"SCPCardBrandAmex","abstract":"

American Express card

","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandMasterCard":{"name":"SCPCardBrandMasterCard","abstract":"

MasterCard card

","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandDiscover":{"name":"SCPCardBrandDiscover","abstract":"

Discover card

","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandJCB":{"name":"SCPCardBrandJCB","abstract":"

JCB card

","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandDinersClub":{"name":"SCPCardBrandDinersClub","abstract":"

Diners Club card

","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandInterac":{"name":"SCPCardBrandInterac","abstract":"

Interac card

","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandUnionPay":{"name":"SCPCardBrandUnionPay","abstract":"

Union Pay card

","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandEftposAu":{"name":"SCPCardBrandEftposAu","abstract":"

Eftpos Australia card

","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandUnknown":{"name":"SCPCardBrandUnknown","abstract":"

An unknown card brand

","parent_name":"SCPCardBrand"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(py)paymentIntent":{"name":"paymentIntent","abstract":"

The updated PaymentIntent after processPayment failed.

","parent_name":"SCPProcessPaymentError"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(py)requestError":{"name":"requestError","abstract":"

If processPayment failed because the underlying network request errored,","parent_name":"SCPProcessPaymentError"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(py)declineCode":{"name":"declineCode","abstract":"

If processPayment failed because the payment method was declined, this","parent_name":"SCPProcessPaymentError"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPProcessPaymentError"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPProcessPaymentError"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)accountType":{"name":"accountType","abstract":"

The type of account being debited or credited

","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)applicationPreferredName":{"name":"applicationPreferredName","abstract":"

Also known as “Application Name”. Required on EMV receipts.

","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)dedicatedFileName":{"name":"dedicatedFileName","abstract":"

Also known as “AID”. Required on EMV receipts.

","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)authorizationCode":{"name":"authorizationCode","abstract":"

Identifier for this transaction

","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)authorizationResponseCode":{"name":"authorizationResponseCode","abstract":"

Authorization Response Code

","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)applicationCryptogram":{"name":"applicationCryptogram","abstract":"

Application Cryptogram

","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)terminalVerificationResults":{"name":"terminalVerificationResults","abstract":"

TVR

","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)transactionStatusInformation":{"name":"transactionStatusInformation","abstract":"

TSI

","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPReceiptDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)last4":{"name":"last4","abstract":"

The last 4 digits of the card.

","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)expMonth":{"name":"expMonth","abstract":"

The card’s expiration month. 1-indexed (i.e. 1 == January)

","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)expYear":{"name":"expYear","abstract":"

The card’s expiration year.

","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)cardholderName":{"name":"cardholderName","abstract":"

The cardholder name as read from the card, in ISO 7813 format. May include","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)funding":{"name":"funding","abstract":"

The card’s funding type.

","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)brand":{"name":"brand","abstract":"

The issuing brand of the card.

","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)fingerprint":{"name":"fingerprint","abstract":"

A string uniquely identifying this card number.

","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)generatedCard":{"name":"generatedCard","abstract":"

ID of a card PaymentMethod that may be attached to a Customer for future","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)receipt":{"name":"receipt","abstract":"

Receipt information for the card present transaction. Only present for EMV","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)emvAuthData":{"name":"emvAuthData","abstract":"

(Only applicable to EMV payments) The authorization data from the card","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)country":{"name":"country","abstract":"

Two-letter ISO code representing the country of the card. You could use this","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)preferredLocales":{"name":"preferredLocales","abstract":"

EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.

","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)networks":{"name":"networks","abstract":"

Contains information about card networks that can be used to process the payment.

","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)incrementalAuthorizationStatus":{"name":"incrementalAuthorizationStatus","abstract":"

Whether this payment method is eligible for incremental authorizations.

","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPCardPresentDetails"},"Enums/SCPCardPresentRouting.html#/c:@E@SCPCardPresentRouting@SCPCardPresentRoutingDomestic":{"name":"SCPCardPresentRoutingDomestic","abstract":"

Prioritize domestic debit network routing on payment method collection.

","parent_name":"SCPCardPresentRouting"},"Enums/SCPCardPresentRouting.html#/c:@E@SCPCardPresentRouting@SCPCardPresentRoutingInternational":{"name":"SCPCardPresentRoutingInternational","abstract":"

Prioritize international network routing on payment method collection.

","parent_name":"SCPCardPresentRouting"},"Enums/SCPCardPresentCaptureMethod.html#/c:@E@SCPCardPresentCaptureMethod@SCPCardPresentCaptureMethodManualPreferred":{"name":"SCPCardPresentCaptureMethodManualPreferred","abstract":"

Use manual_preferred if you prefer manual capture_method for the SCPPaymentIntent’s capture_method but support","parent_name":"SCPCardPresentCaptureMethod"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(py)requestExtendedAuthorization":{"name":"requestExtendedAuthorization","abstract":"

Using the extended authorizations feature, users in eligible categories can capture up to 31 days later, depending on the card brand.

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(py)requestIncrementalAuthorizationSupport":{"name":"requestIncrementalAuthorizationSupport","abstract":"

Allows you to increase the authorized amount on a confirmed PaymentIntent before you capture it. This means you can update the amount on a payment if the estimated price changes or goods and services are added. Before capture, each incremental authorization appears on your customer’s credit card statement as an additional pending charge.

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(py)captureMethod":{"name":"captureMethod","abstract":"

SCPCardPresentCaptureMethod as a nullable NSNumber.

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(py)requestedPriority":{"name":"requestedPriority","abstract":"

The requested routing priority as a nullable NSNumber.

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:":{"name":"-initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:","abstract":"

Initializes a CardPresentParameters

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:":{"name":"-initWithRequestExtendedAuthorization:","abstract":"

Initializes a CardPresentParameters

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestIncrementalAuthorizationSupport:":{"name":"-initWithRequestIncrementalAuthorizationSupport:","abstract":"

Initializes a CardPresentParameters

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:captureMethod:":{"name":"-initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:captureMethod:","abstract":"

Initializes a CardPresentParameters

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:captureMethod:":{"name":"-initWithRequestExtendedAuthorization:captureMethod:","abstract":"

Initializes a CardPresentParameters

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestIncrementalAuthorizationSupport:captureMethod:":{"name":"-initWithRequestIncrementalAuthorizationSupport:captureMethod:","abstract":"

Initializes a CardPresentParameters

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithCaptureMethod:":{"name":"-initWithCaptureMethod:","abstract":"

Initializes a CardPresentParameters

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:captureMethod:requestedPriority:":{"name":"-initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:captureMethod:requestedPriority:","abstract":"

Initializes a CardPresentParameters

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:requestedPriority:":{"name":"-initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:requestedPriority:","abstract":"

Initializes a CardPresentParameters

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithCaptureMethod:requestedPriority:":{"name":"-initWithCaptureMethod:requestedPriority:","abstract":"

Initializes a CardPresentParameters

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestedPriority:":{"name":"-initWithRequestedPriority:","abstract":"

Initializes a CardPresentParameters

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)init":{"name":"-init","abstract":"

Use alternative initializer.

","parent_name":"SCPCardPresentParameters"},"Classes/SCPTip.html#/c:objc(cs)SCPTip(py)amount":{"name":"amount","abstract":"

Portion of the amount that corresponds to a tip

","parent_name":"SCPTip"},"Classes/SCPTip.html#/c:objc(cs)SCPTip(im)init":{"name":"-init","abstract":"

You cannot directly instantiate SCPTip.

","parent_name":"SCPTip"},"Classes/SCPTip.html#/c:objc(cs)SCPTip(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate SCPTip.

","parent_name":"SCPTip"},"Classes/SCPAmountDetails.html#/c:objc(cs)SCPAmountDetails(py)tip":{"name":"tip","abstract":"

Details about the tip

","parent_name":"SCPAmountDetails"},"Classes/SCPAmountDetails.html#/c:objc(cs)SCPAmountDetails(im)init":{"name":"-init","abstract":"

You cannot directly instantiate SCPAmountDetails.

","parent_name":"SCPAmountDetails"},"Classes/SCPAmountDetails.html#/c:objc(cs)SCPAmountDetails(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate SCPAmountDetails.

","parent_name":"SCPAmountDetails"},"Enums/SCPPaymentStatus.html#/c:@E@SCPPaymentStatus@SCPPaymentStatusNotReady":{"name":"SCPPaymentStatusNotReady","abstract":"

The SDK is not ready to start a payment. It may be busy with another","parent_name":"SCPPaymentStatus"},"Enums/SCPPaymentStatus.html#/c:@E@SCPPaymentStatus@SCPPaymentStatusReady":{"name":"SCPPaymentStatusReady","abstract":"

The SDK is ready to start a payment.

","parent_name":"SCPPaymentStatus"},"Enums/SCPPaymentStatus.html#/c:@E@SCPPaymentStatus@SCPPaymentStatusWaitingForInput":{"name":"SCPPaymentStatusWaitingForInput","abstract":"

The SDK is waiting for input from the customer (e.g., for a card to","parent_name":"SCPPaymentStatus"},"Enums/SCPPaymentStatus.html#/c:@E@SCPPaymentStatus@SCPPaymentStatusProcessing":{"name":"SCPPaymentStatusProcessing","abstract":"

The SDK is processing a payment.

","parent_name":"SCPPaymentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusRequiresPaymentMethod":{"name":"SCPPaymentIntentStatusRequiresPaymentMethod","abstract":"

Next step: collect a payment method by calling collectPaymentMethod.

","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusRequiresConfirmation":{"name":"SCPPaymentIntentStatusRequiresConfirmation","abstract":"

Next step: process the payment by calling processPayment.

","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusRequiresCapture":{"name":"SCPPaymentIntentStatusRequiresCapture","abstract":"

Next step: capture the PaymentIntent on your backend via the Stripe API.

","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusProcessing":{"name":"SCPPaymentIntentStatusProcessing","abstract":"

The PaymentIntent is in the middle of full EMV processing.

","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusCanceled":{"name":"SCPPaymentIntentStatusCanceled","abstract":"

The PaymentIntent was canceled.

","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusSucceeded":{"name":"SCPPaymentIntentStatusSucceeded","abstract":"

The PaymentIntent succeeded.

","parent_name":"SCPPaymentIntentStatus"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)amount":{"name":"amount","abstract":"

The amount of the payment, provided in the currency’s smallest unit.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)currency":{"name":"currency","abstract":"

Three-letter ISO currency code, in lowercase. Must be a supported currency.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)paymentMethodTypes":{"name":"paymentMethodTypes","abstract":"

The list of payment method types that this PaymentIntent is allowed to use.","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)captureMethod":{"name":"captureMethod","abstract":"

The capture method that this PaymentIntent should use. Defaults to SCPCaptureMethodManual.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)metadata":{"name":"metadata","abstract":"

Set of key-value pairs that you can attach to an object. This can be useful for","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)stripeDescription":{"name":"stripeDescription","abstract":"

An arbitrary string attached to the object. If you send a receipt email for","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)statementDescriptor":{"name":"statementDescriptor","abstract":"

A string to be displayed on your customer’s credit card statement. This may be","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)statementDescriptorSuffix":{"name":"statementDescriptorSuffix","abstract":"

A string to specify details about the transaction so your customer can understand it clearly on their statement.","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)receiptEmail":{"name":"receiptEmail","abstract":"

Email address that the receipt for the resulting payment will be sent to.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)customer":{"name":"customer","abstract":"

The ID of the Customer this PaymentIntent is for, if one exists.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)applicationFeeAmount":{"name":"applicationFeeAmount","abstract":"

The amount of the application fee (if any) that will be applied to the","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)transferGroup":{"name":"transferGroup","abstract":"

A string that identifies the resulting payment as part of a group.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)transferDataDestination":{"name":"transferDataDestination","abstract":"

The account (if any) the payment will be attributed to for tax reporting, and","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)onBehalfOf":{"name":"onBehalfOf","abstract":"

The Stripe account ID for which these funds are intended.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)setupFutureUsage":{"name":"setupFutureUsage","abstract":"

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)paymentMethodOptionsParameters":{"name":"paymentMethodOptionsParameters","abstract":"

Specific options used during the creation of the PaymentMethod.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)initWithAmount:currency:":{"name":"-initWithAmount:currency:","abstract":"

Initializes SCPPaymentIntentParameters with the given parameters.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)initWithAmount:currency:paymentMethodTypes:":{"name":"-initWithAmount:currency:paymentMethodTypes:","abstract":"

Initializes SCPPaymentIntentParameters with the given parameters.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)initWithAmount:currency:captureMethod:":{"name":"-initWithAmount:currency:captureMethod:","abstract":"

Initializes SCPPaymentIntentParameters with the given parameters.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)initWithAmount:currency:paymentMethodTypes:captureMethod:":{"name":"-initWithAmount:currency:paymentMethodTypes:captureMethod:","abstract":"

Initializes SCPPaymentIntentParameters with the given parameters.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)init":{"name":"-init","abstract":"

Use initWithAmount:currency:

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(cm)new":{"name":"+new","abstract":"

Use initWithAmount:currency:

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)description":{"name":"description","abstract":"

Use stripeDescription for the string attached to the object.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)stripeId":{"name":"stripeId","abstract":"

The unique identifier for the intent.

","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)created":{"name":"created","abstract":"

When the intent was created.

","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)status":{"name":"status","abstract":"

The status of the PaymentIntent.

","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)amount":{"name":"amount","abstract":"

The amount to be collected by this PaymentIntent, provided in the currency’s","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)captureMethod":{"name":"captureMethod","abstract":"

Controls when the funds will be captured from the customer’s account.

","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)currency":{"name":"currency","abstract":"

The currency of the payment.

","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)metadata":{"name":"metadata","abstract":"

Set of key-value pairs attached to the object.

","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)charges":{"name":"charges","abstract":"

Charges that were created by this PaymentIntent, if any.

","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)paymentMethod":{"name":"paymentMethod","abstract":"

The payment method to be used in this PaymentIntent. Only valid in the","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)amountDetails":{"name":"amountDetails","abstract":"

Details about items included in the amount after confirmation.

","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)amountTip":{"name":"amountTip","abstract":"

Indicates how much the user intends to tip in addition to the amount by at confirmation time.","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)statementDescriptor":{"name":"statementDescriptor","abstract":"

Extra information about a PaymentIntent. This will appear on your customer’s statement when","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)statementDescriptorSuffix":{"name":"statementDescriptorSuffix","abstract":"

Extra dynamic information about a PaymentIntent. This will appear concatenated with the statementDescriptor on","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(im)init":{"name":"-init","abstract":"

You cannot directly instantiate SCPPaymentIntent. You should only use","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate SCPPaymentIntent. You should only use","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html":{"name":"SCPPaymentIntent","abstract":"

A PaymentIntent tracks the process of collecting a payment from your customer."},"Classes/SCPPaymentIntentParameters.html":{"name":"SCPPaymentIntentParameters","abstract":"

Parameters for creating an SCPPaymentIntent. Pass an object of this type"},"Enums/SCPPaymentIntentStatus.html":{"name":"SCPPaymentIntentStatus","abstract":"

The possible statuses for a PaymentIntent.

"},"Enums/SCPPaymentStatus.html":{"name":"SCPPaymentStatus","abstract":"

The possible payment statuses for the SDK.

"},"Classes/SCPAmountDetails.html":{"name":"SCPAmountDetails","abstract":"

Contains details about items included in the [PaymentIntent] amount

"},"Classes/SCPTip.html":{"name":"SCPTip","abstract":"

Contains details about tips

"},"Classes/SCPCardPresentParameters.html":{"name":"SCPCardPresentParameters","abstract":"

Parameters that will be applied to the card present PaymentIntent.

"},"Enums/SCPCardPresentCaptureMethod.html":{"name":"SCPCardPresentCaptureMethod","abstract":"

Capture Method values that can be used as card-present payment method options.

"},"Enums/SCPCardPresentRouting.html":{"name":"SCPCardPresentRouting","abstract":"

Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.

"},"Classes/SCPCardPresentDetails.html":{"name":"SCPCardPresentDetails","abstract":"

An object representing details from a transaction using a card_present"},"Classes/SCPReceiptDetails.html":{"name":"SCPReceiptDetails","abstract":"

Receipt details associated with a card present transaction.

"},"Classes/SCPProcessPaymentError.html":{"name":"SCPProcessPaymentError","abstract":"

An error from -[SCPTerminal processPayment:completion:].

"},"Enums/SCPCardBrand.html":{"name":"SCPCardBrand","abstract":"

The various card brands for a card.

"},"Enums/SCPCardFundingType.html":{"name":"SCPCardFundingType","abstract":"

The various funding sources for a card.

"},"Classes/SCPCharge.html":{"name":"SCPCharge","abstract":"

An object representing a Stripe charge.

"},"Enums/SCPChargeStatus.html":{"name":"SCPChargeStatus","abstract":"

The possible statuses for a charge

"},"Classes/SCPPaymentMethodDetails.html":{"name":"SCPPaymentMethodDetails","abstract":"

Details about a PaymentMethod at a specific time. ex: at time of transaction"},"Classes/SCPCardDetails.html":{"name":"SCPCardDetails","abstract":"

Contains details about a user’s credit card.

"},"Classes/SCPPaymentMethod.html":{"name":"SCPPaymentMethod","abstract":"

PaymentMethod objects represent your customer’s payment instruments."},"Enums/SCPPaymentMethodType.html":{"name":"SCPPaymentMethodType","abstract":"

The type of the PaymentMethod.

"},"Classes/SCPPaymentMethodOptionsParameters.html":{"name":"SCPPaymentMethodOptionsParameters","abstract":"

The PaymentMethodOptionsParameters contains options for PaymentMethod creation.

"},"Classes/SCPCollectConfiguration.html":{"name":"SCPCollectConfiguration","abstract":"

The CollectConfiguration contains configuration information relevant to collecting a payment"},"Enums/SCPCaptureMethod.html":{"name":"SCPCaptureMethod","abstract":"

@abstract Controls when the funds will be captured from the customer’s account.

"},"Classes/SCPTippingConfiguration.html":{"name":"SCPTippingConfiguration","abstract":"

The TippingConfiguration contains configuration information relevant to collecting tips.

"},"Classes/SCPNetworks.html":{"name":"SCPNetworks","abstract":"

Contains information about card networks that can be used to process the payment.

"},"Enums/SCPIncrementalAuthorizationStatus.html":{"name":"SCPIncrementalAuthorizationStatus","abstract":"

Represents the ability for a PaymentIntent to be incrementally authorized.

"},"Enums/SCPUpdateComponent.html#/c:@E@SCPUpdateComponent@SCPUpdateComponentIncremental":{"name":"SCPUpdateComponentIncremental","abstract":"

If set, the update contains incremental changes to the reader. If this is","parent_name":"SCPUpdateComponent"},"Enums/SCPUpdateComponent.html#/c:@E@SCPUpdateComponent@SCPUpdateComponentFirmware":{"name":"SCPUpdateComponentFirmware","abstract":"

If set, this update contains updated firmware for this reader. Firmware updates","parent_name":"SCPUpdateComponent"},"Enums/SCPUpdateComponent.html#/c:@E@SCPUpdateComponent@SCPUpdateComponentConfig":{"name":"SCPUpdateComponentConfig","abstract":"

If set, this update contains a new configuration for this reader. These may","parent_name":"SCPUpdateComponent"},"Enums/SCPUpdateComponent.html#/c:@E@SCPUpdateComponent@SCPUpdateComponentKeys":{"name":"SCPUpdateComponentKeys","abstract":"

If set, this update contains updated encryption keys for the reader.","parent_name":"SCPUpdateComponent"},"Enums/SCPUpdateTimeEstimate.html#/c:@E@SCPUpdateTimeEstimate@SCPUpdateTimeEstimateLessThan1Minute":{"name":"SCPUpdateTimeEstimateLessThan1Minute","abstract":"

The update should take less than 1 minute to complete.

","parent_name":"SCPUpdateTimeEstimate"},"Enums/SCPUpdateTimeEstimate.html#/c:@E@SCPUpdateTimeEstimate@SCPUpdateTimeEstimate1To2Minutes":{"name":"SCPUpdateTimeEstimate1To2Minutes","abstract":"

The update should take 1-2 minutes to complete.

","parent_name":"SCPUpdateTimeEstimate"},"Enums/SCPUpdateTimeEstimate.html#/c:@E@SCPUpdateTimeEstimate@SCPUpdateTimeEstimate2To5Minutes":{"name":"SCPUpdateTimeEstimate2To5Minutes","abstract":"

The update should take 2-5 minutes to complete.

","parent_name":"SCPUpdateTimeEstimate"},"Enums/SCPUpdateTimeEstimate.html#/c:@E@SCPUpdateTimeEstimate@SCPUpdateTimeEstimate5To15Minutes":{"name":"SCPUpdateTimeEstimate5To15Minutes","abstract":"

The update should take 5-15 minutes to complete.

","parent_name":"SCPUpdateTimeEstimate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(py)estimatedUpdateTime":{"name":"estimatedUpdateTime","abstract":"

The estimated amount of time for the update.

","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(py)deviceSoftwareVersion":{"name":"deviceSoftwareVersion","abstract":"

The target version for the update.

","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(py)components":{"name":"components","abstract":"

The components that will be installed in this update.

","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(py)requiredAt":{"name":"requiredAt","abstract":"

The date at which this update will be required to be installed. If this date","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(cm)stringFromUpdateTimeEstimate:":{"name":"+stringFromUpdateTimeEstimate:","abstract":"

Returns an unlocalized string for the given update time estimate.

","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html":{"name":"SCPReaderSoftwareUpdate","abstract":"

An object representing a reader update.

"},"Enums/SCPUpdateTimeEstimate.html":{"name":"SCPUpdateTimeEstimate","abstract":"

The estimated amount of time for an update. Note that these times are estimates;"},"Enums/SCPUpdateComponent.html":{"name":"SCPUpdateComponent","abstract":"

A bitmask identifying what exact updates are contained within this update.

"},"Classes/SCPCartLineItem.html#/c:objc(cs)SCPCartLineItem(py)quantity":{"name":"quantity","abstract":"

The quantity of the line item being purchased.

","parent_name":"SCPCartLineItem"},"Classes/SCPCartLineItem.html#/c:objc(cs)SCPCartLineItem(py)displayName":{"name":"displayName","abstract":"

The description or name of the item.

","parent_name":"SCPCartLineItem"},"Classes/SCPCartLineItem.html#/c:objc(cs)SCPCartLineItem(py)amount":{"name":"amount","abstract":"

The price of the item, provided in the cart’s currency’s smallest unit.

","parent_name":"SCPCartLineItem"},"Classes/SCPCartLineItem.html#/c:objc(cs)SCPCartLineItem(im)initWithDisplayName:quantity:amount:":{"name":"-initWithDisplayName:quantity:amount:","abstract":"

The values set here will be shown on the screen as-is. Make sure you’re","parent_name":"SCPCartLineItem"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(py)lineItems":{"name":"lineItems","abstract":"

You can add or remove line items from this array individually or reassign the array entirely.","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(py)tax":{"name":"tax","abstract":"

The displayed tax amount, provided in the currency’s smallest unit.

","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(py)total":{"name":"total","abstract":"

The cart’s total balance, provided in the currency’s smallest unit.

","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(py)currency":{"name":"currency","abstract":"

The currency of the cart.

","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(im)initWithCurrency:tax:total:":{"name":"-initWithCurrency:tax:total:","abstract":"

Initializes an SCPCart with tax and total, in cents, as well as the currency.","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(im)init":{"name":"-init","abstract":"

Use initWithTax:

","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(cm)new":{"name":"+new","abstract":"

Use initWithTax:

","parent_name":"SCPCart"},"Enums/SCPBatteryStatus.html#/c:@E@SCPBatteryStatus@SCPBatteryStatusUnknown":{"name":"SCPBatteryStatusUnknown","abstract":"

Battery state is not yet known or not available for the connected reader.

","parent_name":"SCPBatteryStatus"},"Enums/SCPBatteryStatus.html#/c:@E@SCPBatteryStatus@SCPBatteryStatusCritical":{"name":"SCPBatteryStatusCritical","abstract":"

The device’s battery is less than or equal to 5%.

","parent_name":"SCPBatteryStatus"},"Enums/SCPBatteryStatus.html#/c:@E@SCPBatteryStatus@SCPBatteryStatusLow":{"name":"SCPBatteryStatusLow","abstract":"

The device’s battery is between 5% and 20%.

","parent_name":"SCPBatteryStatus"},"Enums/SCPBatteryStatus.html#/c:@E@SCPBatteryStatus@SCPBatteryStatusNominal":{"name":"SCPBatteryStatusNominal","abstract":"

The device’s battery is greater than 20%.

","parent_name":"SCPBatteryStatus"},"Enums/SCPReaderNetworkStatus.html#/c:@E@SCPReaderNetworkStatus@SCPReaderNetworkStatusOffline":{"name":"SCPReaderNetworkStatusOffline","abstract":"

The reader is offline. Note that Chipper 2x and WisePad 3 will always report","parent_name":"SCPReaderNetworkStatus"},"Enums/SCPReaderNetworkStatus.html#/c:@E@SCPReaderNetworkStatus@SCPReaderNetworkStatusOnline":{"name":"SCPReaderNetworkStatusOnline","abstract":"

The reader is online.

","parent_name":"SCPReaderNetworkStatus"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageRetryCard":{"name":"SCPReaderDisplayMessageRetryCard","abstract":"

Retry the presented card.

","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageInsertCard":{"name":"SCPReaderDisplayMessageInsertCard","abstract":"

Insert the presented card.

","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageInsertOrSwipeCard":{"name":"SCPReaderDisplayMessageInsertOrSwipeCard","abstract":"

Insert or swipe the presented card.

","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageSwipeCard":{"name":"SCPReaderDisplayMessageSwipeCard","abstract":"

Swipe the presented card.

","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageRemoveCard":{"name":"SCPReaderDisplayMessageRemoveCard","abstract":"

Remove the presented card.

","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageMultipleContactlessCardsDetected":{"name":"SCPReaderDisplayMessageMultipleContactlessCardsDetected","abstract":"

The reader detected multiple contactless cards. Make sure only one","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageTryAnotherReadMethod":{"name":"SCPReaderDisplayMessageTryAnotherReadMethod","abstract":"

The card could not be read. Try another read method on the same card, or","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageTryAnotherCard":{"name":"SCPReaderDisplayMessageTryAnotherCard","abstract":"

The card is invalid. Try another card.

","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderInputOptions.html#/c:@E@SCPReaderInputOptions@SCPReaderInputOptionNone":{"name":"SCPReaderInputOptionNone","abstract":"

No input options are available on the reader.

","parent_name":"SCPReaderInputOptions"},"Enums/SCPReaderInputOptions.html#/c:@E@SCPReaderInputOptions@SCPReaderInputOptionSwipeCard":{"name":"SCPReaderInputOptionSwipeCard","abstract":"

Swipe a magstripe card.

","parent_name":"SCPReaderInputOptions"},"Enums/SCPReaderInputOptions.html#/c:@E@SCPReaderInputOptions@SCPReaderInputOptionInsertCard":{"name":"SCPReaderInputOptionInsertCard","abstract":"

Insert a chip card.

","parent_name":"SCPReaderInputOptions"},"Enums/SCPReaderInputOptions.html#/c:@E@SCPReaderInputOptions@SCPReaderInputOptionTapCard":{"name":"SCPReaderInputOptionTapCard","abstract":"

Tap a contactless card.

","parent_name":"SCPReaderInputOptions"},"Enums/SCPReaderEvent.html#/c:@E@SCPReaderEvent@SCPReaderEventCardInserted":{"name":"SCPReaderEventCardInserted","abstract":"

A card was inserted.

","parent_name":"SCPReaderEvent"},"Enums/SCPReaderEvent.html#/c:@E@SCPReaderEvent@SCPReaderEventCardRemoved":{"name":"SCPReaderEventCardRemoved","abstract":"

A card was removed.

","parent_name":"SCPReaderEvent"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didStartInstallingUpdate:cancelable:":{"name":"-localMobileReader:didStartInstallingUpdate:cancelable:","abstract":"

The reader has started installing a software update.

","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didReportReaderSoftwareUpdateProgress:":{"name":"-localMobileReader:didReportReaderSoftwareUpdateProgress:","abstract":"

The reader reported progress on a software update.

","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didFinishInstallingUpdate:error:":{"name":"-localMobileReader:didFinishInstallingUpdate:error:","abstract":"

The reader has finished installing an update.

","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didRequestReaderInput:":{"name":"-localMobileReader:didRequestReaderInput:","abstract":"

This method is called when the reader begins waiting for input.","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didRequestReaderDisplayMessage:":{"name":"-localMobileReader:didRequestReaderDisplayMessage:","abstract":"

This method is called to request that a prompt be displayed in your app.","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReaderDidAcceptTermsOfService:":{"name":"-localMobileReaderDidAcceptTermsOfService:","abstract":"

The reader is reporting that, as part of preparing to accept payments,","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didReportAvailableUpdate:":{"name":"-reader:didReportAvailableUpdate:","abstract":"

The SDK is reporting that an update is available for the reader.","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didStartInstallingUpdate:cancelable:":{"name":"-reader:didStartInstallingUpdate:cancelable:","abstract":"

The SDK is reporting that the reader has started installing a software update.

","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didReportReaderSoftwareUpdateProgress:":{"name":"-reader:didReportReaderSoftwareUpdateProgress:","abstract":"

The reader reported progress on a software update.

","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didFinishInstallingUpdate:error:":{"name":"-reader:didFinishInstallingUpdate:error:","abstract":"

The reader is reporting that an installation has finished. If the install was","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didRequestReaderInput:":{"name":"-reader:didRequestReaderInput:","abstract":"

This method is called when the reader begins waiting for input. Your app","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didRequestReaderDisplayMessage:":{"name":"-reader:didRequestReaderDisplayMessage:","abstract":"

This method is called to request that a prompt be displayed in your app.","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didReportReaderEvent:info:":{"name":"-reader:didReportReaderEvent:info:","abstract":"

The SDK reported an event from the reader (e.g. a card was inserted).

","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didReportBatteryLevel:status:isCharging:":{"name":"-reader:didReportBatteryLevel:status:isCharging:","abstract":"

The SDK reported the reader’s battery level or charging state has changed.

","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)readerDidReportLowBatteryWarning:":{"name":"-readerDidReportLowBatteryWarning:","abstract":"

This method is called when the SDK’s currently connected reader has a low battery.

","parent_name":"SCPBluetoothReaderDelegate"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeChipper2X":{"name":"SCPDeviceTypeChipper2X","abstract":"

The BBPOS Chipper 2X BT mobile reader.

","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeVerifoneP400":{"name":"SCPDeviceTypeVerifoneP400","abstract":"

The Verifone P400 countertop reader.

","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeWisePad3":{"name":"SCPDeviceTypeWisePad3","abstract":"

The BBPOS WisePad 3 mobile reader.

","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeStripeM2":{"name":"SCPDeviceTypeStripeM2","abstract":"

The Stripe Reader M2 mobile reader.

","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeWisePosE":{"name":"SCPDeviceTypeWisePosE","abstract":"

The BBPOS WisePOS E countertop reader.

","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeWisePosEDevKit":{"name":"SCPDeviceTypeWisePosEDevKit","abstract":"

The BBPOS WisePOS E DevKit countertop reader.

","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeStripeS700":{"name":"SCPDeviceTypeStripeS700","abstract":"

Stripe Reader S700.

","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeStripeS700DevKit":{"name":"SCPDeviceTypeStripeS700DevKit","abstract":"

Stripe Reader S700 DevKit.

","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeAppleBuiltIn":{"name":"SCPDeviceTypeAppleBuiltIn","abstract":"

Apple Built-In reader.

","parent_name":"SCPDeviceType"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)deviceType":{"name":"deviceType","abstract":"

The reader’s device type.

","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)simulated":{"name":"simulated","abstract":"

True if this is a simulated reader.

","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)stripeId":{"name":"stripeId","abstract":"

The Stripe unique identifier for the reader.

","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)locationId":{"name":"locationId","abstract":"

The ID of the reader’s Location.

","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)locationStatus":{"name":"locationStatus","abstract":"

Used to tell whether the location field has been set.","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)location":{"name":"location","abstract":"

The details of the location this reader is registered to, if any.

","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)serialNumber":{"name":"serialNumber","abstract":"

The reader’s serial number.

","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)deviceSoftwareVersion":{"name":"deviceSoftwareVersion","abstract":"

The reader’s current device software version, or nil if this information is","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)availableUpdate":{"name":"availableUpdate","abstract":"

The available update for this reader, or nil if no update is available.","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)batteryLevel":{"name":"batteryLevel","abstract":"

The reader’s battery level, represented as a boxed float in the range [0, 1].","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)batteryStatus":{"name":"batteryStatus","abstract":"

The reader’s battery status. Usable as a general classification for the current","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)isCharging":{"name":"isCharging","abstract":"

The reader’s charging state, represented as a BOOL","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)ipAddress":{"name":"ipAddress","abstract":"

The IP address of the reader.

","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)status":{"name":"status","abstract":"

The networking status of the reader: either offline or online. Note that","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)label":{"name":"label","abstract":"

A custom label that may be given to a reader for easier identification.

","parent_name":"SCPReader"},"Classes/SCPReader.html":{"name":"SCPReader","abstract":"

Information about a card reader that has been discovered by or connected to"},"Enums/SCPDeviceType.html":{"name":"SCPDeviceType","abstract":"

The possible device types for a reader.

"},"Protocols/SCPBluetoothReaderDelegate.html":{"name":"SCPBluetoothReaderDelegate","abstract":"

Implement this protocol to handle a connected Bluetooth reader’s events throughout"},"Protocols/SCPLocalMobileReaderDelegate.html":{"name":"SCPLocalMobileReaderDelegate","abstract":"

Implement this protocol to handle a connected local mobile reader’s events throughout"},"Enums/SCPReaderEvent.html":{"name":"SCPReaderEvent","abstract":"

The possible events from a connected reader. Used by [SCPBluetoothReaderDelegate reader:didReportReaderEvent:info:].

"},"Enums/SCPReaderInputOptions.html":{"name":"SCPReaderInputOptions","abstract":"

This OptionSet represents all of the input methods available to your user when"},"Enums/SCPReaderDisplayMessage.html":{"name":"SCPReaderDisplayMessage","abstract":"

The display messages that a reader may request be displayed by your app. Used by [SCPBluetoothReaderDelegate reader:didRequestReaderDisplayMessage:].

"},"Enums/SCPReaderNetworkStatus.html":{"name":"SCPReaderNetworkStatus","abstract":"

The possible networking statuses for a reader.

"},"Enums/SCPBatteryStatus.html":{"name":"SCPBatteryStatus","abstract":"

A categorization of a reader’s battery charge level.

"},"Classes/SCPCart.html":{"name":"SCPCart","abstract":"

An SCPCart object contains information about what line items are included in"},"Classes/SCPCartLineItem.html":{"name":"SCPCartLineItem","abstract":"

Represents a single line item in an SCPCart, displayed on the reader’s screen"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeVisa":{"name":"SCPSimulatedCardTypeVisa","abstract":"

Visa

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeVisaDebit":{"name":"SCPSimulatedCardTypeVisaDebit","abstract":"

Visa (debit)

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeMastercard":{"name":"SCPSimulatedCardTypeMastercard","abstract":"

Mastercard

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeMasterDebit":{"name":"SCPSimulatedCardTypeMasterDebit","abstract":"

Mastercard (debit)

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeMastercardPrepaid":{"name":"SCPSimulatedCardTypeMastercardPrepaid","abstract":"

Mastercard (prepaid)

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeAmex":{"name":"SCPSimulatedCardTypeAmex","abstract":"

American Express

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeAmex2":{"name":"SCPSimulatedCardTypeAmex2","abstract":"

American Express

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeDiscover":{"name":"SCPSimulatedCardTypeDiscover","abstract":"

Discover

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeDiscover2":{"name":"SCPSimulatedCardTypeDiscover2","abstract":"

Discover

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeDiners":{"name":"SCPSimulatedCardTypeDiners","abstract":"

Diners Club

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeDiners14Digit":{"name":"SCPSimulatedCardTypeDiners14Digit","abstract":"

Diners Club (14 digit card)

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeJcb":{"name":"SCPSimulatedCardTypeJcb","abstract":"

JCB

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeUnionPay":{"name":"SCPSimulatedCardTypeUnionPay","abstract":"

UnionPay

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeInterac":{"name":"SCPSimulatedCardTypeInterac","abstract":"

Interac

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeEftposAuDebit":{"name":"SCPSimulatedCardTypeEftposAuDebit","abstract":"

Eftpos Australia

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeEftposAuVisaDebit":{"name":"SCPSimulatedCardTypeEftposAuVisaDebit","abstract":"

Eftpos Australia/Visa

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeEftposAuDebitMastercard":{"name":"SCPSimulatedCardTypeEftposAuDebitMastercard","abstract":"

Eftpos Australia/Mastercard

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclined":{"name":"SCPSimulatedCardTypeChargeDeclined","abstract":"

Charge is declined with a card_declined code.

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedInsufficientFunds":{"name":"SCPSimulatedCardTypeChargeDeclinedInsufficientFunds","abstract":"

Charge is declined with a card_declined code. The decline_code","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedLostCard":{"name":"SCPSimulatedCardTypeChargeDeclinedLostCard","abstract":"

Charge is declined with a card_declined code. The decline_code","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedStolenCard":{"name":"SCPSimulatedCardTypeChargeDeclinedStolenCard","abstract":"

Charge is declined with a card_declined code. The decline_code","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedExpiredCard":{"name":"SCPSimulatedCardTypeChargeDeclinedExpiredCard","abstract":"

Charge is declined with an expired_card code.

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedProcessingError":{"name":"SCPSimulatedCardTypeChargeDeclinedProcessingError","abstract":"

Charge is declined with a processing_error code.

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeRefundFailed":{"name":"SCPSimulatedCardTypeRefundFailed","abstract":"

Refund is declined with a refund_fail error.

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeOnlinePinCvm":{"name":"SCPSimulatedCardTypeOnlinePinCvm","abstract":"

Payment attaches Online Pin to the transaction.","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeOnlinePinScaRetry":{"name":"SCPSimulatedCardTypeOnlinePinScaRetry","abstract":"

This flow simulates an Online Pin scenario with SCA compliance.","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeOfflinePinCvm":{"name":"SCPSimulatedCardTypeOfflinePinCvm","abstract":"

Payment attaches Offline Pin to the transaction.","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeOfflinePinScaRetry":{"name":"SCPSimulatedCardTypeOfflinePinScaRetry","abstract":"

This flow simulates an Offline Pin scenario with SCA compliance.","parent_name":"SCPSimulatedCardType"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)initWithType:":{"name":"-initWithType:","abstract":"

Create a Simulated Card object with a given simulated card type.

","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)initWithTestCardNumber:":{"name":"-initWithTestCardNumber:","abstract":"

Create a Simulated Card object with a raw card number. This initializer is","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)init":{"name":"-init","abstract":"

You cannot instantiate this class without specifying a type or testcard number.

","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)isOnlinePin":{"name":"-isOnlinePin","abstract":"

Returns true if the card is online pin enabled.

","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)isOfflinePin":{"name":"-isOfflinePin","abstract":"

Returns true if the card is offline pin enabled.

","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(cm)new":{"name":"+new","abstract":"

You cannot instantiate this class without specifying a type or testcard number.

","parent_name":"SCPSimulatedCard"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateAvailable":{"name":"SCPSimulateReaderUpdateAvailable","abstract":"

Default value.

","parent_name":"SCPSimulateReaderUpdate"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateNone":{"name":"SCPSimulateReaderUpdateNone","abstract":"

No updates are available

","parent_name":"SCPSimulateReaderUpdate"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateRequired":{"name":"SCPSimulateReaderUpdateRequired","abstract":"

A required full reader software update exists. Use this to simulate the","parent_name":"SCPSimulateReaderUpdate"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateLowBattery":{"name":"SCPSimulateReaderUpdateLowBattery","abstract":"

A required update exists.

","parent_name":"SCPSimulateReaderUpdate"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateRandom":{"name":"SCPSimulateReaderUpdateRandom","abstract":"

Randomly picks a type of update for the reader to help exercise the","parent_name":"SCPSimulateReaderUpdate"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(py)availableReaderUpdate":{"name":"availableReaderUpdate","abstract":"

Set this to different values of the SCPSimulateReaderUpdate enum to","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(py)simulatedCard":{"name":"simulatedCard","abstract":"

Create a SCPSimulatedCard and set it on the shared configuration object to","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(py)simulatedTipAmount":{"name":"simulatedTipAmount","abstract":"

Set this to simulate a Terminal configuration object with this fixed tip","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)city":{"name":"city","abstract":"

The city name

","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)country":{"name":"country","abstract":"

The country code

","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)line1":{"name":"line1","abstract":"

The first line of the address

","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)line2":{"name":"line2","abstract":"

The second line of the address

","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)postalCode":{"name":"postalCode","abstract":"

The postal code of the address

","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)state":{"name":"state","abstract":"

The state of the address

","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPAddress"},"Enums/SCPLocationStatus.html#/c:@E@SCPLocationStatus@SCPLocationStatusUnknown":{"name":"SCPLocationStatusUnknown","abstract":"

The location is not known. location will be nil.

","parent_name":"SCPLocationStatus"},"Enums/SCPLocationStatus.html#/c:@E@SCPLocationStatus@SCPLocationStatusSet":{"name":"SCPLocationStatusSet","abstract":"

The location was successfully set to a known location.","parent_name":"SCPLocationStatus"},"Enums/SCPLocationStatus.html#/c:@E@SCPLocationStatus@SCPLocationStatusNotSet":{"name":"SCPLocationStatusNotSet","abstract":"

This location is known to be not set. location will be nil.

","parent_name":"SCPLocationStatus"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)stripeId":{"name":"stripeId","abstract":"

The ID of the Location

","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)address":{"name":"address","abstract":"

The address of this Location

","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)displayName":{"name":"displayName","abstract":"

The display name of this Location

","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)livemode":{"name":"livemode","abstract":"

Whether this Location was created in livemode

","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)metadata":{"name":"metadata","abstract":"

Any metadata attached to this Location

","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPLocation"},"Classes/SCPListLocationsParameters.html#/c:objc(cs)SCPListLocationsParameters(py)limit":{"name":"limit","abstract":"

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

","parent_name":"SCPListLocationsParameters"},"Classes/SCPListLocationsParameters.html#/c:objc(cs)SCPListLocationsParameters(py)endingBefore":{"name":"endingBefore","abstract":"

A cursor for use in pagination. ending_before is an object ID that defines","parent_name":"SCPListLocationsParameters"},"Classes/SCPListLocationsParameters.html#/c:objc(cs)SCPListLocationsParameters(py)startingAfter":{"name":"startingAfter","abstract":"

A cursor for use in pagination. starting_after is an object ID that defines","parent_name":"SCPListLocationsParameters"},"Classes/SCPListLocationsParameters.html#/c:objc(cs)SCPListLocationsParameters(im)initWithLimit:endingBefore:startingAfter:":{"name":"-initWithLimit:endingBefore:startingAfter:","abstract":"

Initializes SCPListLocationsParameters with the given parameters.

","parent_name":"SCPListLocationsParameters"},"Enums/SCPConnectionStatus.html#/c:@E@SCPConnectionStatus@SCPConnectionStatusNotConnected":{"name":"SCPConnectionStatusNotConnected","abstract":"

The SDK is not connected to a reader.

","parent_name":"SCPConnectionStatus"},"Enums/SCPConnectionStatus.html#/c:@E@SCPConnectionStatus@SCPConnectionStatusConnected":{"name":"SCPConnectionStatusConnected","abstract":"

The SDK is connected to a reader.

","parent_name":"SCPConnectionStatus"},"Enums/SCPConnectionStatus.html#/c:@E@SCPConnectionStatus@SCPConnectionStatusConnecting":{"name":"SCPConnectionStatusConnecting","abstract":"

The SDK is currently connecting to a reader.

","parent_name":"SCPConnectionStatus"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(py)locationId":{"name":"locationId","abstract":"

The ID of the Location which the reader should be","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(py)onBehalfOf":{"name":"onBehalfOf","abstract":"

If your integration is creating destination charges and using on_behalf_of, you must provide the","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(py)merchantDisplayName":{"name":"merchantDisplayName","abstract":"

Optional cardholder facing merchant display name that will be used in the prompt for the cardholder","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(py)tosAcceptancePermitted":{"name":"tosAcceptancePermitted","abstract":"

In order to connect to a reader, merchant-specific terms of service may need to be accepted.","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(im)initWithLocationId:":{"name":"-initWithLocationId:","abstract":"

Initialize ConnectionConfiguration with a location ID.

","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(im)initWithLocationId:merchantDisplayName:onBehalfOf:":{"name":"-initWithLocationId:merchantDisplayName:onBehalfOf:","abstract":"

Initialize ConnectionConfiguration with a location ID, custom merchant display name, and ‘on behalf of’","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(im)initWithLocationId:merchantDisplayName:onBehalfOf:tosAcceptancePermitted:":{"name":"-initWithLocationId:merchantDisplayName:onBehalfOf:tosAcceptancePermitted:","abstract":"

Initialize ConnectionConfiguration with a location ID, custom merchant display name, ‘on behalf of’","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(py)failIfInUse":{"name":"failIfInUse","abstract":"

When set to true, the connection will automatically error if the reader is already","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(py)allowCustomerCancel":{"name":"allowCustomerCancel","abstract":"

If set to true, the customer will be able to press the red X button on the","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(im)initWithFailIfInUse:allowCustomerCancel:":{"name":"-initWithFailIfInUse:allowCustomerCancel:","abstract":"

Initialize an InternetConnectionConfiguration object with all possible properties.

","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(im)initWithFailIfInUse:":{"name":"-initWithFailIfInUse:","abstract":"

Initalize an InternetConnectionConfiguration object and set the failIfInUse","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(im)initWithAllowCustomerCancel:":{"name":"-initWithAllowCustomerCancel:","abstract":"

Initialize an InternetConnectionConfiguration object and set the","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(py)locationId":{"name":"locationId","abstract":"

The ID of the Location which the reader should be registered to during connection.

","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(py)autoReconnectOnUnexpectedDisconnect":{"name":"autoReconnectOnUnexpectedDisconnect","abstract":"

When set to true, the Terminal SDK will attempt a Bluetooth auto-reconnection on any unexpected disconnect.","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(py)autoReconnectionDelegate":{"name":"autoReconnectionDelegate","abstract":"

Contains callback methods for Bluetooth auto-reconnection.

","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(im)initWithLocationId:":{"name":"-initWithLocationId:","abstract":"

Initialize your connect options with a location ID.

","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(im)initWithLocationId:autoReconnectOnUnexpectedDisconnect:autoReconnectionDelegate:":{"name":"-initWithLocationId:autoReconnectOnUnexpectedDisconnect:autoReconnectionDelegate:","abstract":"

Initialize your connect options with a location ID and an expected behavior for unexpected disconnects.

","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(im)initWithDiscoveryMethod:simulated:":{"name":"-initWithDiscoveryMethod:simulated:","abstract":"

Initializes a discovery configuration with the given discovery method. All discoverable readers","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(im)initWithDiscoveryMethod:locationId:simulated:":{"name":"-initWithDiscoveryMethod:locationId:simulated:","abstract":"

This variant of the initializer lets you specify a Location to filter the","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(py)timeout":{"name":"timeout","abstract":"

The timeout (in seconds) after which discoverReaders: should fail. If the","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(py)discoveryMethod":{"name":"discoveryMethod","abstract":"

The method by which to discover readers.

","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(py)simulated":{"name":"simulated","abstract":"

Whether to use simulated discovery to discover a device simulator.

","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(py)locationId":{"name":"locationId","abstract":"

A location ID that can be used to filter discovery result so only readers","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(im)init":{"name":"-init","abstract":"

Use initWithDiscoveryMethod:simulated:

","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(cm)new":{"name":"+new","abstract":"

Use initWithDiscoveryMethod:simulated:

","parent_name":"SCPDiscoveryConfiguration"},"Protocols/SCPDiscoveryDelegate.html#/c:objc(pl)SCPDiscoveryDelegate(im)terminal:didUpdateDiscoveredReaders:":{"name":"-terminal:didUpdateDiscoveredReaders:","abstract":"

This method will be called repeatedly until:

","parent_name":"SCPDiscoveryDelegate"},"Enums/SCPDiscoveryMethod.html#/c:@E@SCPDiscoveryMethod@SCPDiscoveryMethodBluetoothScan":{"name":"SCPDiscoveryMethodBluetoothScan","abstract":"

The Bluetooth Scan discovery method searches for Stripe Terminal’s","parent_name":"SCPDiscoveryMethod"},"Enums/SCPDiscoveryMethod.html#/c:@E@SCPDiscoveryMethod@SCPDiscoveryMethodBluetoothProximity":{"name":"SCPDiscoveryMethodBluetoothProximity","abstract":"

The Bluetooth Proximity discovery method searches for a subset of","parent_name":"SCPDiscoveryMethod"},"Enums/SCPDiscoveryMethod.html#/c:@E@SCPDiscoveryMethod@SCPDiscoveryMethodInternet":{"name":"SCPDiscoveryMethodInternet","abstract":"

The Internet discovery method searches for internet-connected readers,","parent_name":"SCPDiscoveryMethod"},"Enums/SCPDiscoveryMethod.html#/c:@E@SCPDiscoveryMethod@SCPDiscoveryMethodLocalMobile":{"name":"SCPDiscoveryMethodLocalMobile","abstract":"

The Local Mobile discovery method searches for any readers built into the","parent_name":"SCPDiscoveryMethod"},"Enums/SCPDiscoveryMethod.html":{"name":"SCPDiscoveryMethod","abstract":"

The possible methods for discovering a reader. Pass a variant of this enum"},"Protocols/SCPDiscoveryDelegate.html":{"name":"SCPDiscoveryDelegate","abstract":"

Implement this protocol to handle a continually updating list"},"Classes/SCPDiscoveryConfiguration.html":{"name":"SCPDiscoveryConfiguration","abstract":"

Configuration options for discovering readers.

"},"Classes/SCPBluetoothConnectionConfiguration.html":{"name":"SCPBluetoothConnectionConfiguration","abstract":"

This class lets you define Bluetooth reader connection options.

"},"Classes/SCPInternetConnectionConfiguration.html":{"name":"SCPInternetConnectionConfiguration","abstract":"

This class lets you set options that define internet reader behavior throughout a given"},"Classes/SCPLocalMobileConnectionConfiguration.html":{"name":"SCPLocalMobileConnectionConfiguration","abstract":"

This class lets you set options that define local mobile reader behavior throughout a given"},"Enums/SCPConnectionStatus.html":{"name":"SCPConnectionStatus","abstract":"

The possible reader connection statuses for the SDK.

"},"Classes/SCPListLocationsParameters.html":{"name":"SCPListLocationsParameters","abstract":"

Parameters to be used when calling Terminal.shared.listLocations() to list"},"Classes/SCPLocation.html":{"name":"SCPLocation","abstract":"

A Location is used to group readers in the Stripe Terminal ecosystem. The"},"Enums/SCPLocationStatus.html":{"name":"SCPLocationStatus","abstract":"

Represents the possible states of the location object for a"},"Classes/SCPAddress.html":{"name":"SCPAddress","abstract":"

Holds address data associated with a given SCPLocation.

"},"Classes/SCPSimulatorConfiguration.html":{"name":"SCPSimulatorConfiguration","abstract":"

Simulator specific configurations you can set to test your integration’s"},"Enums/SCPSimulateReaderUpdate.html":{"name":"SCPSimulateReaderUpdate","abstract":"

Enum used to simulate various types of reader updates being available for"},"Classes/SCPSimulatedCard.html":{"name":"SCPSimulatedCard","abstract":"

Simulated Card objects can be used with the shared SCPSimulatorConfiguration"},"Enums/SCPSimulatedCardType.html":{"name":"SCPSimulatedCardType","abstract":"

Enum used to simulate various types of cards and error cases.

"},"Protocols/SCPJSONDecodable.html#/c:objc(pl)SCPJSONDecodable(cm)decodedObjectFromJSON:":{"name":"+decodedObjectFromJSON:","abstract":"

Parses a JSON dictionary into an instance of the class. Returns nil if the","parent_name":"SCPJSONDecodable"},"Protocols/SCPJSONDecodable.html#/c:objc(pl)SCPJSONDecodable(py)originalJSON":{"name":"originalJSON","abstract":"

The raw JSON used to create the object. This may be useful for accessing","parent_name":"SCPJSONDecodable"},"Classes/SCPCancelable.html#/c:objc(cs)SCPCancelable(py)completed":{"name":"completed","abstract":"

Indicates whether the command has completed. After the command has completed,","parent_name":"SCPCancelable"},"Classes/SCPCancelable.html#/c:objc(cs)SCPCancelable(im)cancel:":{"name":"-cancel:","abstract":"

Attempts to cancel the action in progress. If the action could not be canceled,","parent_name":"SCPCancelable"},"Enums/SCPLogLevel.html#/c:@E@SCPLogLevel@SCPLogLevelNone":{"name":"SCPLogLevelNone","abstract":"

No logs will printed to the console.

","parent_name":"SCPLogLevel"},"Enums/SCPLogLevel.html#/c:@E@SCPLogLevel@SCPLogLevelVerbose":{"name":"SCPLogLevelVerbose","abstract":"

Verbose logs will be printed to the console.

","parent_name":"SCPLogLevel"},"Protocols/SCPReconnectionDelegate.html#/c:objc(pl)SCPReconnectionDelegate(im)terminal:didStartReaderReconnect:":{"name":"-terminal:didStartReaderReconnect:","abstract":"

The reader has lost Bluetooth connection to the SDK and reconnection attempts have been started.

","parent_name":"SCPReconnectionDelegate"},"Protocols/SCPReconnectionDelegate.html#/c:objc(pl)SCPReconnectionDelegate(im)terminalDidSucceedReaderReconnect:":{"name":"-terminalDidSucceedReaderReconnect:","abstract":"

The SDK was able to reconnect to the previously connected Bluetooth reader.

","parent_name":"SCPReconnectionDelegate"},"Protocols/SCPReconnectionDelegate.html#/c:objc(pl)SCPReconnectionDelegate(im)terminalDidFailReaderReconnect:":{"name":"-terminalDidFailReaderReconnect:","abstract":"

The SDK was not able to reconnect to the previously connected bluetooth reader. The SDK is now disconnected from any readers.

","parent_name":"SCPReconnectionDelegate"},"Protocols/SCPTerminalDelegate.html#/c:objc(pl)SCPTerminalDelegate(im)terminal:didReportUnexpectedReaderDisconnect:":{"name":"-terminal:didReportUnexpectedReaderDisconnect:","abstract":"

The reader disconnected unexpectedly (that is, without your app explicitly","parent_name":"SCPTerminalDelegate"},"Protocols/SCPTerminalDelegate.html#/c:objc(pl)SCPTerminalDelegate(im)terminal:didChangeConnectionStatus:":{"name":"-terminal:didChangeConnectionStatus:","abstract":"

The currently connected reader’s connectionStatus changed.

","parent_name":"SCPTerminalDelegate"},"Protocols/SCPTerminalDelegate.html#/c:objc(pl)SCPTerminalDelegate(im)terminal:didChangePaymentStatus:":{"name":"-terminal:didChangePaymentStatus:","abstract":"

The currently connected reader’s paymentStatus changed.

","parent_name":"SCPTerminalDelegate"},"Protocols/SCPConnectionTokenProvider.html#/c:objc(pl)SCPConnectionTokenProvider(im)fetchConnectionToken:":{"name":"-fetchConnectionToken:","abstract":"

Fetches a connection token from your backend server.

","parent_name":"SCPConnectionTokenProvider"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)setTokenProvider:":{"name":"+setTokenProvider:","abstract":"

Sets the token provider for the shared (singleton) SCPTerminal instance.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)hasTokenProvider":{"name":"+hasTokenProvider","abstract":"

Returns true if a token provider has been set, through setTokenProvider:

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)setLogListener:":{"name":"+setLogListener:","abstract":"

Sets a block to listen for logs from the shared Terminal instance (optional).

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cpy)shared":{"name":"shared","abstract":"

Returns the shared (singleton) Terminal instance.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)delegate":{"name":"delegate","abstract":"

The Terminal singleton object’s primary delegate. This delegate announces","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)connectedReader":{"name":"connectedReader","abstract":"

Information about the connected SCPReader, or nil if no reader is connected.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)connectionStatus":{"name":"connectionStatus","abstract":"

The Terminal instance’s current connection status.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)logLevel":{"name":"logLevel","abstract":"

The log level for the SDK. The default value is .none.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)simulatorConfiguration":{"name":"simulatorConfiguration","abstract":"

The simulator configuration settings that will be used when connecting to","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)paymentStatus":{"name":"paymentStatus","abstract":"

The Terminal instance’s current payment status.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)clearCachedCredentials":{"name":"-clearCachedCredentials","abstract":"

Clears the current connection token, saved reader sessions, and any other","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)supportsReadersOfType:discoveryMethod:simulated:error:":{"name":"-supportsReadersOfType:discoveryMethod:simulated:error:","abstract":"

Use this method to determine whether the mobile device supports a given reader type","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)discoverReaders:delegate:completion:":{"name":"-discoverReaders:delegate:completion:","abstract":"

Begins discovering readers based on the given discovery configuration.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)connectBluetoothReader:delegate:connectionConfig:completion:":{"name":"-connectBluetoothReader:delegate:connectionConfig:completion:","abstract":"

Attempts to connect to the given Bluetooth reader with a given connection","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)connectInternetReader:connectionConfig:completion:":{"name":"-connectInternetReader:connectionConfig:completion:","abstract":"

Attempts to connect to the given Internet reader with a given connection","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)connectLocalMobileReader:delegate:connectionConfig:completion:":{"name":"-connectLocalMobileReader:delegate:connectionConfig:completion:","abstract":"

Attempts to connect to the given Local Mobile reader with a given","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)listLocations:completion:":{"name":"-listLocations:completion:","abstract":"

Retrieves a list of SCPLocation objects belonging to your merchant. You must specify","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)installAvailableUpdate":{"name":"-installAvailableUpdate","abstract":"

Installs the available update for the connected reader.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)disconnectReader:":{"name":"-disconnectReader:","abstract":"

Attempts to disconnect from the currently connected reader.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)createPaymentIntent:completion:":{"name":"-createPaymentIntent:completion:","abstract":"

Creates a new SCPPaymentIntent with the given parameters.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)retrievePaymentIntent:completion:":{"name":"-retrievePaymentIntent:completion:","abstract":"

Retrieves a SCPPaymentIntent with a client secret.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectPaymentMethod:completion:":{"name":"-collectPaymentMethod:completion:","abstract":"

Collects a payment method for the given SCPPaymentIntent.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectPaymentMethod:collectConfig:completion:":{"name":"-collectPaymentMethod:collectConfig:completion:","abstract":"

Collects a payment method for the given PaymentIntent, with the specified configuration.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)processPayment:completion:":{"name":"-processPayment:completion:","abstract":"

Processes a payment after collecting a payment method succeeds.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)cancelPaymentIntent:completion:":{"name":"-cancelPaymentIntent:completion:","abstract":"

Cancels an SCPPaymentIntent.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)readReusableCard:completion:":{"name":"-readReusableCard:completion:","abstract":"

Reads a card with the given parameters and returns a PaymentMethod.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)createSetupIntent:completion:":{"name":"-createSetupIntent:completion:","abstract":"

Creates a new SCPSetupIntent with the given parameters.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)retrieveSetupIntent:completion:":{"name":"-retrieveSetupIntent:completion:","abstract":"

Retrieves an SCPSetupIntent with a client secret.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)cancelSetupIntent:completion:":{"name":"-cancelSetupIntent:completion:","abstract":"

Cancels an SCPPaymentIntent.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectSetupIntentPaymentMethod:customerConsentCollected:completion:":{"name":"-collectSetupIntentPaymentMethod:customerConsentCollected:completion:","abstract":"

Collects a payment method for the given SCPSetupIntent.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)confirmSetupIntent:completion:":{"name":"-confirmSetupIntent:completion:","abstract":"

Confirms a SetupIntent after the payment method has been successfully collected.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectRefundPaymentMethod:completion:":{"name":"-collectRefundPaymentMethod:completion:","abstract":"

Initiates an in-person refund with a given set of SCPRefundParameters by","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)processRefund:":{"name":"-processRefund:","abstract":"

Processes an in-person refund after the refund payment method has been collected.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)clearReaderDisplay:":{"name":"-clearReaderDisplay:","abstract":"

Clears the reader display and resets it to the splash screen.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)setReaderDisplay:completion:":{"name":"-setReaderDisplay:completion:","abstract":"

Updates the reader display with cart information.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromReaderInputOptions:":{"name":"+stringFromReaderInputOptions:","abstract":"

Returns an unlocalized string for the given reader input options, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromReaderDisplayMessage:":{"name":"+stringFromReaderDisplayMessage:","abstract":"

Returns an unlocalized string for the given reader display message, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromReaderEvent:":{"name":"+stringFromReaderEvent:","abstract":"

Returns an unlocalized string for the given reader event, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromConnectionStatus:":{"name":"+stringFromConnectionStatus:","abstract":"

Returns an unlocalized string for the given connection status, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromPaymentStatus:":{"name":"+stringFromPaymentStatus:","abstract":"

Returns an unlocalized string for the given payment status, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromDeviceType:":{"name":"+stringFromDeviceType:","abstract":"

Returns an unlocalized string for the given device type.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromDiscoveryMethod:":{"name":"+stringFromDiscoveryMethod:","abstract":"

Returns an unlocalized string for the given discovery method.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromCardBrand:":{"name":"+stringFromCardBrand:","abstract":"

Returns an unlocalized string for the given card brand.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromPaymentIntentStatus:":{"name":"+stringFromPaymentIntentStatus:","abstract":"

Returns an unlocalized string for the given payment intent status.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromCaptureMethod:":{"name":"+stringFromCaptureMethod:","abstract":"

Returns an unlocalized string for the given capture method.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)init":{"name":"-init","abstract":"

Use initWithConfiguration:tokenProvider:delegate:

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)new":{"name":"+new","abstract":"

Use initWithConfiguration:tokenProvider:delegate:

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html":{"name":"SCPTerminal","abstract":"

The SCPTerminal singleton object exposes an interface for discovering readers,"},"Protocols/SCPConnectionTokenProvider.html":{"name":"SCPConnectionTokenProvider","abstract":"

Before integrating the SDK, you should create an endpoint on your backend"},"Protocols/SCPTerminalDelegate.html":{"name":"SCPTerminalDelegate","abstract":"

Implement this protocol to handle connection and payment updates from the"},"Protocols/SCPReconnectionDelegate.html":{"name":"SCPReconnectionDelegate","abstract":"

Implement this protocol to handle bluetooth auto-reconnection.

"},"Enums/SCPLogLevel.html":{"name":"SCPLogLevel","abstract":"

The various log levels for the SDK.

"},"Classes/SCPCancelable.html":{"name":"SCPCancelable","abstract":"

An object representing an action that can be canceled.

"},"Protocols/SCPJSONDecodable.html":{"name":"SCPJSONDecodable","abstract":"

Objects conforming to this protocol can be instantiated by decoding a JSON"},"Terminal.html#/c:SCPTerminal.h@SCPSDKVersion":{"name":"SCPSDKVersion","abstract":"

The current version of this library.

"},"Terminal.html":{"name":"Terminal"},"Reader%20Discovery%20%26%20Connection.html":{"name":"Reader Discovery & Connection"},"Reader.html":{"name":"Reader"},"Reader%20Updates.html":{"name":"Reader Updates"},"Payment.html":{"name":"Payment"},"Card-Present%20Refunds.html":{"name":"Card-Present Refunds"},"Saving%20Cards.html":{"name":"Saving Cards"},"Errors.html":{"name":"Errors"},"Blocks.html":{"name":"Blocks"}} \ No newline at end of file diff --git a/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/docSet.dsidx b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/docSet.dsidx new file mode 100644 index 00000000..1676015b Binary files /dev/null and b/docs/2.19.0/docsets/StripeTerminal.docset/Contents/Resources/docSet.dsidx differ diff --git a/docs/2.19.0/docsets/StripeTerminal.tgz b/docs/2.19.0/docsets/StripeTerminal.tgz new file mode 100644 index 00000000..4eb67678 Binary files /dev/null and b/docs/2.19.0/docsets/StripeTerminal.tgz differ diff --git a/docs/2.19.0/img/carat.png b/docs/2.19.0/img/carat.png new file mode 100755 index 00000000..29d2f7fd Binary files /dev/null and b/docs/2.19.0/img/carat.png differ diff --git a/docs/2.19.0/img/dash.png b/docs/2.19.0/img/dash.png new file mode 100755 index 00000000..6f694c7a Binary files /dev/null and b/docs/2.19.0/img/dash.png differ diff --git a/docs/2.19.0/img/spinner.gif b/docs/2.19.0/img/spinner.gif new file mode 100644 index 00000000..e3038d0a Binary files /dev/null and b/docs/2.19.0/img/spinner.gif differ diff --git a/docs/2.19.0/index.html b/docs/2.19.0/index.html new file mode 100644 index 00000000..46c00a9f --- /dev/null +++ b/docs/2.19.0/index.html @@ -0,0 +1,530 @@ + + + + StripeTerminal Reference + + + + + + + + + + + + + + + +
+

+ + StripeTerminal 2.19.0 Docs + + +

+ +
+
+ +
+
+ + +
+ +

+ StripeTerminal Reference + + StripeTerminal Reference +

+ +
+ +
+ +
+
+ +

Stripe Terminal iOS SDK

+ +

Stripe Terminal enables you to build your own in-person checkout to accept payments in the physical world. Built on Stripe’s payments network, Terminal helps you unify your online and offline payment channels. With the Stripe Terminal iOS SDK, you can connect to pre-certified card readers from your iOS app and drive a customized in-store checkout flow.

+ +

Get started with our integration guides and sample integration, or browse the SDK reference documentation.

+ +
+

Upgrading from an older version of the SDK? See our migration guide for guidance.

+
+

Requirements

+ +

The Stripe Terminal iOS SDK is compatible with apps supporting iOS 11 and above.

+

Try the example app

+ +

The iOS SDK includes an open-source example app, which you can use to familiarize yourself with the SDK and reader before starting your own integration.

+ +

To build the example app from source, you’ll need to:

+ +
    +
  1. Navigate to the Example folder, and open Example.xcworkspace (make sure to open the .xcworkspace and not the .xcodeproj).
    2. +
  2. Navigate to our example backend and click the button to deploy it on Heroku.
    3. +
  3. In AppDelegate.swift, set the URL of the Heroku app you just deployed.
    4. +
  4. Build and run the app. The SDK comes with a simple reader simulator, so you can get started without any physical hardware.
    5. +
+

Installation

+ +

We support CocoaPods and Swift Package Manager. If you prefer to install the library manually, please use the latest version from our releases page.

+

Swift Package Manager

+ +

In Xcode, select File > Swift Packages > Add Package Dependency and enter https://github.com/stripe/stripe-terminal-ios

+

CocoaPods

+ +
    +

  1. If you haven’t already, install the latest version of CocoaPods.

    2. +

  2. Add this line to your Podfile:

    +
    pod 'StripeTerminal', '~> 2.0'
+
    3. +

  3. Run the following command:

    +
    pod install
+
    4. +
+ +

From now on, don’t forget to use the *.xcworkspace file to open your project in Xcode, instead of the .xcodeproj file.

+ +

In the future, to update to the latest compatible version of the SDK, just run:

+
pod update StripeTerminal
+
+

Manual

+ +
    +

  1. Navigate to our releases page, download StripeTerminal.xcframework.zip, and unzip it.

    2. +

  2. Drag StripeTerminal.xcframework to the Frameworks, Libraries, and Embedded Content section of your Xcode project’s General settings. Make sure to select “Copy items if needed”.

    3. +
+ +

When new versions of the SDK are released, repeat the above steps to update your installation.

+

Configure your app

+ +

Location services must be enabled in order to use the iOS SDK. Add the following key-value pair to your app’s Info.plist file:

+ +
    +
  • Privacy - Location When In Use Usage Description + +
      +
    • Key: NSLocationWhenInUseUsageDescription
      • +
    • Value: “Location access is required in order to accept payments.”
      • +
    • +
+
+

Note

+

Stripe needs to know where payments occur to reduce risks associated with those charges and to minimize disputes. If the SDK can’t determine the iOS device’s location, payments are disabled until location access is restored.

+ +
+ +

For your app to run in the background and remain connected to the reader, add this key-value pair to your Info.plist file:

+ +
    +
  • Required background modes + +
      +
    • Key: UIBackgroundModes
      • +
    • Value: bluetooth-central (Uses Bluetooth LE accessories)
      • +
    +

    Note

    + Note the value is actually an array that you will need to add bluetooth-central to. + +
    • +
+ +

For your app to pass validation when submitting to the App Store, add the following key-value pairs as well:

+ +
    +
  • Privacy - Bluetooth Peripheral Usage Description + +
      +
    • Key: NSBluetoothPeripheralUsageDescription
      • +
    • Value: “Bluetooth access is required in order to connect to supported bluetooth card readers.”
      • +
    • +
  • Privacy - Bluetooth Always Usage Description + +
      +
    • Key: NSBluetoothAlwaysUsageDescription
      • +
    • Value: “This app uses Bluetooth to connect to supported card readers.”
      • +
    • +
+

Previous API References

+ +

We maintain archives of the SDK’s API reference for older versions of the SDK.

+ + + +
+
+ + +
+
+
+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/docs/2.19.0/js/jazzy.js b/docs/2.19.0/js/jazzy.js new file mode 100755 index 00000000..19844166 --- /dev/null +++ b/docs/2.19.0/js/jazzy.js @@ -0,0 +1,74 @@ +// Jazzy - https://github.com/realm/jazzy +// Copyright Realm Inc. +// SPDX-License-Identifier: MIT + +window.jazzy = {'docset': false} +if (typeof window.dash != 'undefined') { + document.documentElement.className += ' dash' + window.jazzy.docset = true +} +if (navigator.userAgent.match(/xcode/i)) { + document.documentElement.className += ' xcode' + window.jazzy.docset = true +} + +function toggleItem($link, $content) { + var animationDuration = 300; + $link.toggleClass('token-open'); + $content.slideToggle(animationDuration); +} + +function itemLinkToContent($link) { + return $link.parent().parent().next(); +} + +// On doc load + hash-change, open any targetted item +function openCurrentItemIfClosed() { + if (window.jazzy.docset) { + return; + } + var $link = $(`a[name="${location.hash.substring(1)}"]`).nextAll('.token'); + $content = itemLinkToContent($link); + if ($content.is(':hidden')) { + toggleItem($link, $content); + } +} + +$(openCurrentItemIfClosed); +$(window).on('hashchange', openCurrentItemIfClosed); + +// On item link ('token') click, toggle its discussion +$('.token').on('click', function(event) { + if (window.jazzy.docset) { + return; + } + var $link = $(this); + toggleItem($link, itemLinkToContent($link)); + + // Keeps the document from jumping to the hash. + var href = $link.attr('href'); + if (history.pushState) { + history.pushState({}, '', href); + } else { + location.hash = href; + } + event.preventDefault(); +}); + +// Clicks on links to the current, closed, item need to open the item +$("a:not('.token')").on('click', function() { + if (location == this.href) { + openCurrentItemIfClosed(); + } +}); + +// KaTeX rendering +if ("katex" in window) { + $($('.math').each( (_, element) => { + katex.render(element.textContent, element, { + displayMode: $(element).hasClass('m-block'), + throwOnError: false, + trust: true + }); + })) +} diff --git a/docs/2.19.0/js/jazzy.search.js b/docs/2.19.0/js/jazzy.search.js new file mode 100644 index 00000000..359cdbb8 --- /dev/null +++ b/docs/2.19.0/js/jazzy.search.js @@ -0,0 +1,74 @@ +// Jazzy - https://github.com/realm/jazzy +// Copyright Realm Inc. +// SPDX-License-Identifier: MIT + +$(function(){ + var $typeahead = $('[data-typeahead]'); + var $form = $typeahead.parents('form'); + var searchURL = $form.attr('action'); + + function displayTemplate(result) { + return result.name; + } + + function suggestionTemplate(result) { + var t = '
'; + t += '' + result.name + ''; + if (result.parent_name) { + t += '' + result.parent_name + ''; + } + t += '
'; + return t; + } + + $typeahead.one('focus', function() { + $form.addClass('loading'); + + $.getJSON(searchURL).then(function(searchData) { + const searchIndex = lunr(function() { + this.ref('url'); + this.field('name'); + this.field('abstract'); + for (const [url, doc] of Object.entries(searchData)) { + this.add({url: url, name: doc.name, abstract: doc.abstract}); + } + }); + + $typeahead.typeahead( + { + highlight: true, + minLength: 3, + autoselect: true + }, + { + limit: 10, + display: displayTemplate, + templates: { suggestion: suggestionTemplate }, + source: function(query, sync) { + const lcSearch = query.toLowerCase(); + const results = searchIndex.query(function(q) { + q.term(lcSearch, { boost: 100 }); + q.term(lcSearch, { + boost: 10, + wildcard: lunr.Query.wildcard.TRAILING + }); + }).map(function(result) { + var doc = searchData[result.ref]; + doc.url = result.ref; + return doc; + }); + sync(results); + } + } + ); + $form.removeClass('loading'); + $typeahead.trigger('focus'); + }); + }); + + var baseURL = searchURL.slice(0, -"search.json".length); + + $typeahead.on('typeahead:select', function(e, result) { + window.location = baseURL + result.url; + }); +}); diff --git a/docs/2.19.0/js/jquery.min.js b/docs/2.19.0/js/jquery.min.js new file mode 100644 index 00000000..2c69bc90 --- /dev/null +++ b/docs/2.19.0/js/jquery.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.1 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,y=n.hasOwnProperty,a=y.toString,l=a.call(Object),v={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.1",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&v(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!y||!y.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ve(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace(B,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ye(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ve(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],y=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&y.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||y.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||y.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||y.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||y.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||y.push(".#.+[+~]"),e.querySelectorAll("\\\f"),y.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&y.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&y.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&y.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),y.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),y=y.length&&new RegExp(y.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),v=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&v(p,e)?-1:t==C||t.ownerDocument==p&&v(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!y||!y.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),v.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",v.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",v.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ye(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ve(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),v.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="
",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(v.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return B(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=_e(v.pixelPosition,function(e,t){if(t)return t=Be(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return B(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 00){var c=e.utils.clone(r)||{};c.position=[a,l],c.index=s.length,s.push(new e.Token(i.slice(a,o),c))}a=o+1}}return s},e.tokenizer.separator=/[\s\-]+/,e.Pipeline=function(){this._stack=[]},e.Pipeline.registeredFunctions=Object.create(null),e.Pipeline.registerFunction=function(t,r){r in this.registeredFunctions&&e.utils.warn("Overwriting existing registered function: "+r),t.label=r,e.Pipeline.registeredFunctions[t.label]=t},e.Pipeline.warnIfFunctionNotRegistered=function(t){var r=t.label&&t.label in this.registeredFunctions;r||e.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",t)},e.Pipeline.load=function(t){var r=new e.Pipeline;return t.forEach(function(t){var i=e.Pipeline.registeredFunctions[t];if(!i)throw new Error("Cannot load unregistered function: "+t);r.add(i)}),r},e.Pipeline.prototype.add=function(){var t=Array.prototype.slice.call(arguments);t.forEach(function(t){e.Pipeline.warnIfFunctionNotRegistered(t),this._stack.push(t)},this)},e.Pipeline.prototype.after=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");i+=1,this._stack.splice(i,0,r)},e.Pipeline.prototype.before=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");this._stack.splice(i,0,r)},e.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);t!=-1&&this._stack.splice(t,1)},e.Pipeline.prototype.run=function(e){for(var t=this._stack.length,r=0;r1&&(se&&(r=n),s!=e);)i=r-t,n=t+Math.floor(i/2),s=this.elements[2*n];return s==e?2*n:s>e?2*n:sa?l+=2:o==a&&(t+=r[u+1]*i[l+1],u+=2,l+=2);return t},e.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},e.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,r=0;t0){var o,a=s.str.charAt(0);a in s.node.edges?o=s.node.edges[a]:(o=new e.TokenSet,s.node.edges[a]=o),1==s.str.length&&(o["final"]=!0),n.push({node:o,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(0!=s.editsRemaining){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new e.TokenSet;s.node.edges["*"]=u}if(0==s.str.length&&(u["final"]=!0),n.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&n.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),1==s.str.length&&(s.node["final"]=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new e.TokenSet;s.node.edges["*"]=l}1==s.str.length&&(l["final"]=!0),n.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var c,h=s.str.charAt(0),d=s.str.charAt(1);d in s.node.edges?c=s.node.edges[d]:(c=new e.TokenSet,s.node.edges[d]=c),1==s.str.length&&(c["final"]=!0),n.push({node:c,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return i},e.TokenSet.fromString=function(t){for(var r=new e.TokenSet,i=r,n=0,s=t.length;n=e;t--){var r=this.uncheckedNodes[t],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r["char"]]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}},e.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},e.Index.prototype.search=function(t){return this.query(function(r){var i=new e.QueryParser(t,r);i.parse()})},e.Index.prototype.query=function(t){for(var r=new e.Query(this.fields),i=Object.create(null),n=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},e.Builder.prototype.k1=function(e){this._k1=e},e.Builder.prototype.add=function(t,r){var i=t[this._ref],n=Object.keys(this._fields);this._documents[i]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return e.QueryLexer.EOS;var t=this.str.charAt(this.pos);return this.pos+=1,t},e.QueryLexer.prototype.width=function(){return this.pos-this.start},e.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},e.QueryLexer.prototype.backup=function(){this.pos-=1},e.QueryLexer.prototype.acceptDigitRun=function(){var t,r;do t=this.next(),r=t.charCodeAt(0);while(r>47&&r<58);t!=e.QueryLexer.EOS&&this.backup()},e.QueryLexer.prototype.more=function(){return this.pos1&&(t.backup(),t.emit(e.QueryLexer.TERM)),t.ignore(),t.more())return e.QueryLexer.lexText},e.QueryLexer.lexEditDistance=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.EDIT_DISTANCE),e.QueryLexer.lexText},e.QueryLexer.lexBoost=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.BOOST),e.QueryLexer.lexText},e.QueryLexer.lexEOS=function(t){t.width()>0&&t.emit(e.QueryLexer.TERM)},e.QueryLexer.termSeparator=e.tokenizer.separator,e.QueryLexer.lexText=function(t){for(;;){var r=t.next();if(r==e.QueryLexer.EOS)return e.QueryLexer.lexEOS;if(92!=r.charCodeAt(0)){if(":"==r)return e.QueryLexer.lexField;if("~"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexEditDistance;if("^"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexBoost;if("+"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if("-"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if(r.match(e.QueryLexer.termSeparator))return e.QueryLexer.lexTerm}else t.escapeCharacter()}},e.QueryParser=function(t,r){this.lexer=new e.QueryLexer(t),this.query=r,this.currentClause={},this.lexemeIdx=0},e.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var t=e.QueryParser.parseClause;t;)t=t(this);return this.query},e.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},e.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},e.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},e.QueryParser.parseClause=function(t){var r=t.peekLexeme();if(void 0!=r)switch(r.type){case e.QueryLexer.PRESENCE:return e.QueryParser.parsePresence;case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(i+=" with value '"+r.str+"'"),new e.QueryParseError(i,r.start,r.end)}},e.QueryParser.parsePresence=function(t){var r=t.consumeLexeme();if(void 0!=r){switch(r.str){case"-":t.currentClause.presence=e.Query.presence.PROHIBITED;break;case"+":t.currentClause.presence=e.Query.presence.REQUIRED;break;default:var i="unrecognised presence operator'"+r.str+"'";throw new e.QueryParseError(i,r.start,r.end)}var n=t.peekLexeme();if(void 0==n){var i="expecting term or field, found nothing";throw new e.QueryParseError(i,r.start,r.end)}switch(n.type){case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expecting term or field, found '"+n.type+"'";throw new e.QueryParseError(i,n.start,n.end)}}},e.QueryParser.parseField=function(t){var r=t.consumeLexeme();if(void 0!=r){if(t.query.allFields.indexOf(r.str)==-1){var i=t.query.allFields.map(function(e){return"'"+e+"'"}).join(", "),n="unrecognised field '"+r.str+"', possible fields: "+i;throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.fields=[r.str];var s=t.peekLexeme();if(void 0==s){var n="expecting term, found nothing";throw new e.QueryParseError(n,r.start,r.end)}switch(s.type){case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var n="expecting term, found '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseTerm=function(t){var r=t.consumeLexeme();if(void 0!=r){t.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(t.currentClause.usePipeline=!1);var i=t.peekLexeme();if(void 0==i)return void t.nextClause();switch(i.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+i.type+"'";throw new e.QueryParseError(n,i.start,i.end)}}},e.QueryParser.parseEditDistance=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="edit distance must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.editDistance=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseBoost=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="boost must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.boost=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},function(e,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():e.lunr=t()}(this,function(){return e})}(); diff --git a/docs/2.19.0/js/typeahead.jquery.js b/docs/2.19.0/js/typeahead.jquery.js new file mode 100644 index 00000000..3a2d2ab0 --- /dev/null +++ b/docs/2.19.0/js/typeahead.jquery.js @@ -0,0 +1,1694 @@ +/*! + * typeahead.js 1.3.1 + * https://github.com/corejavascript/typeahead.js + * Copyright 2013-2020 Twitter, Inc. and other contributors; Licensed MIT + */ + + +(function(root, factory) { + if (typeof define === "function" && define.amd) { + define([ "jquery" ], function(a0) { + return factory(a0); + }); + } else if (typeof module === "object" && module.exports) { + module.exports = factory(require("jquery")); + } else { + factory(root["jQuery"]); + } +})(this, function($) { + var _ = function() { + "use strict"; + return { + isMsie: function() { + return /(msie|trident)/i.test(navigator.userAgent) ? navigator.userAgent.match(/(msie |rv:)(\d+(.\d+)?)/i)[2] : false; + }, + isBlankString: function(str) { + return !str || /^\s*$/.test(str); + }, + escapeRegExChars: function(str) { + return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, "\\$&"); + }, + isString: function(obj) { + return typeof obj === "string"; + }, + isNumber: function(obj) { + return typeof obj === "number"; + }, + isArray: $.isArray, + isFunction: $.isFunction, + isObject: $.isPlainObject, + isUndefined: function(obj) { + return typeof obj === "undefined"; + }, + isElement: function(obj) { + return !!(obj && obj.nodeType === 1); + }, + isJQuery: function(obj) { + return obj instanceof $; + }, + toStr: function toStr(s) { + return _.isUndefined(s) || s === null ? "" : s + ""; + }, + bind: $.proxy, + each: function(collection, cb) { + $.each(collection, reverseArgs); + function reverseArgs(index, value) { + return cb(value, index); + } + }, + map: $.map, + filter: $.grep, + every: function(obj, test) { + var result = true; + if (!obj) { + return result; + } + $.each(obj, function(key, val) { + if (!(result = test.call(null, val, key, obj))) { + return false; + } + }); + return !!result; + }, + some: function(obj, test) { + var result = false; + if (!obj) { + return result; + } + $.each(obj, function(key, val) { + if (result = test.call(null, val, key, obj)) { + return false; + } + }); + return !!result; + }, + mixin: $.extend, + identity: function(x) { + return x; + }, + clone: function(obj) { + return $.extend(true, {}, obj); + }, + getIdGenerator: function() { + var counter = 0; + return function() { + return counter++; + }; + }, + templatify: function templatify(obj) { + return $.isFunction(obj) ? obj : template; + function template() { + return String(obj); + } + }, + defer: function(fn) { + setTimeout(fn, 0); + }, + debounce: function(func, wait, immediate) { + var timeout, result; + return function() { + var context = this, args = arguments, later, callNow; + later = function() { + timeout = null; + if (!immediate) { + result = func.apply(context, args); + } + }; + callNow = immediate && !timeout; + clearTimeout(timeout); + timeout = setTimeout(later, wait); + if (callNow) { + result = func.apply(context, args); + } + return result; + }; + }, + throttle: function(func, wait) { + var context, args, timeout, result, previous, later; + previous = 0; + later = function() { + previous = new Date(); + timeout = null; + result = func.apply(context, args); + }; + return function() { + var now = new Date(), remaining = wait - (now - previous); + context = this; + args = arguments; + if (remaining <= 0) { + clearTimeout(timeout); + timeout = null; + previous = now; + result = func.apply(context, args); + } else if (!timeout) { + timeout = setTimeout(later, remaining); + } + return result; + }; + }, + stringify: function(val) { + return _.isString(val) ? val : JSON.stringify(val); + }, + guid: function() { + function _p8(s) { + var p = (Math.random().toString(16) + "000000000").substr(2, 8); + return s ? "-" + p.substr(0, 4) + "-" + p.substr(4, 4) : p; + } + return "tt-" + _p8() + _p8(true) + _p8(true) + _p8(); + }, + noop: function() {} + }; + }(); + var WWW = function() { + "use strict"; + var defaultClassNames = { + wrapper: "twitter-typeahead", + input: "tt-input", + hint: "tt-hint", + menu: "tt-menu", + dataset: "tt-dataset", + suggestion: "tt-suggestion", + selectable: "tt-selectable", + empty: "tt-empty", + open: "tt-open", + cursor: "tt-cursor", + highlight: "tt-highlight" + }; + return build; + function build(o) { + var www, classes; + classes = _.mixin({}, defaultClassNames, o); + www = { + css: buildCss(), + classes: classes, + html: buildHtml(classes), + selectors: buildSelectors(classes) + }; + return { + css: www.css, + html: www.html, + classes: www.classes, + selectors: www.selectors, + mixin: function(o) { + _.mixin(o, www); + } + }; + } + function buildHtml(c) { + return { + wrapper: '', + menu: '
' + }; + } + function buildSelectors(classes) { + var selectors = {}; + _.each(classes, function(v, k) { + selectors[k] = "." + v; + }); + return selectors; + } + function buildCss() { + var css = { + wrapper: { + position: "relative", + display: "inline-block" + }, + hint: { + position: "absolute", + top: "0", + left: "0", + borderColor: "transparent", + boxShadow: "none", + opacity: "1" + }, + input: { + position: "relative", + verticalAlign: "top", + backgroundColor: "transparent" + }, + inputWithNoHint: { + position: "relative", + verticalAlign: "top" + }, + menu: { + position: "absolute", + top: "100%", + left: "0", + zIndex: "100", + display: "none" + }, + ltr: { + left: "0", + right: "auto" + }, + rtl: { + left: "auto", + right: " 0" + } + }; + if (_.isMsie()) { + _.mixin(css.input, { + backgroundImage: "url(data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)" + }); + } + return css; + } + }(); + var EventBus = function() { + "use strict"; + var namespace, deprecationMap; + namespace = "typeahead:"; + deprecationMap = { + render: "rendered", + cursorchange: "cursorchanged", + select: "selected", + autocomplete: "autocompleted" + }; + function EventBus(o) { + if (!o || !o.el) { + $.error("EventBus initialized without el"); + } + this.$el = $(o.el); + } + _.mixin(EventBus.prototype, { + _trigger: function(type, args) { + var $e = $.Event(namespace + type); + this.$el.trigger.call(this.$el, $e, args || []); + return $e; + }, + before: function(type) { + var args, $e; + args = [].slice.call(arguments, 1); + $e = this._trigger("before" + type, args); + return $e.isDefaultPrevented(); + }, + trigger: function(type) { + var deprecatedType; + this._trigger(type, [].slice.call(arguments, 1)); + if (deprecatedType = deprecationMap[type]) { + this._trigger(deprecatedType, [].slice.call(arguments, 1)); + } + } + }); + return EventBus; + }(); + var EventEmitter = function() { + "use strict"; + var splitter = /\s+/, nextTick = getNextTick(); + return { + onSync: onSync, + onAsync: onAsync, + off: off, + trigger: trigger + }; + function on(method, types, cb, context) { + var type; + if (!cb) { + return this; + } + types = types.split(splitter); + cb = context ? bindContext(cb, context) : cb; + this._callbacks = this._callbacks || {}; + while (type = types.shift()) { + this._callbacks[type] = this._callbacks[type] || { + sync: [], + async: [] + }; + this._callbacks[type][method].push(cb); + } + return this; + } + function onAsync(types, cb, context) { + return on.call(this, "async", types, cb, context); + } + function onSync(types, cb, context) { + return on.call(this, "sync", types, cb, context); + } + function off(types) { + var type; + if (!this._callbacks) { + return this; + } + types = types.split(splitter); + while (type = types.shift()) { + delete this._callbacks[type]; + } + return this; + } + function trigger(types) { + var type, callbacks, args, syncFlush, asyncFlush; + if (!this._callbacks) { + return this; + } + types = types.split(splitter); + args = [].slice.call(arguments, 1); + while ((type = types.shift()) && (callbacks = this._callbacks[type])) { + syncFlush = getFlush(callbacks.sync, this, [ type ].concat(args)); + asyncFlush = getFlush(callbacks.async, this, [ type ].concat(args)); + syncFlush() && nextTick(asyncFlush); + } + return this; + } + function getFlush(callbacks, context, args) { + return flush; + function flush() { + var cancelled; + for (var i = 0, len = callbacks.length; !cancelled && i < len; i += 1) { + cancelled = callbacks[i].apply(context, args) === false; + } + return !cancelled; + } + } + function getNextTick() { + var nextTickFn; + if (window.setImmediate) { + nextTickFn = function nextTickSetImmediate(fn) { + setImmediate(function() { + fn(); + }); + }; + } else { + nextTickFn = function nextTickSetTimeout(fn) { + setTimeout(function() { + fn(); + }, 0); + }; + } + return nextTickFn; + } + function bindContext(fn, context) { + return fn.bind ? fn.bind(context) : function() { + fn.apply(context, [].slice.call(arguments, 0)); + }; + } + }(); + var highlight = function(doc) { + "use strict"; + var defaults = { + node: null, + pattern: null, + tagName: "strong", + className: null, + wordsOnly: false, + caseSensitive: false, + diacriticInsensitive: false + }; + var accented = { + A: "[AaªÀ-Åà-åĀ-ąǍǎȀ-ȃȦȧᴬᵃḀḁẚẠ-ảₐ℀℁℻⒜Ⓐⓐ㍱-㍴㎀-㎄㎈㎉㎩-㎯㏂㏊㏟㏿Ａａ]", + B: "[BbᴮᵇḂ-ḇℬ⒝Ⓑⓑ㍴㎅-㎇㏃㏈㏔㏝Ｂｂ]", + C: "[CcÇçĆ-čᶜ℀ℂ℃℅℆ℭⅭⅽ⒞Ⓒⓒ㍶㎈㎉㎝㎠㎤㏄-㏇Ｃｃ]", + D: "[DdĎďDŽ-džDZ-dzᴰᵈḊ-ḓⅅⅆⅮⅾ⒟Ⓓⓓ㋏㍲㍷-㍹㎗㎭-㎯㏅㏈Ｄｄ]", + E: "[EeÈ-Ëè-ëĒ-ěȄ-ȇȨȩᴱᵉḘ-ḛẸ-ẽₑ℡ℯℰⅇ⒠Ⓔⓔ㉐㋍㋎Ｅｅ]", + F: "[FfᶠḞḟ℉ℱ℻⒡Ⓕⓕ㎊-㎌㎙ff-fflＦｆ]", + G: "[GgĜ-ģǦǧǴǵᴳᵍḠḡℊ⒢Ⓖⓖ㋌㋍㎇㎍-㎏㎓㎬㏆㏉㏒㏿Ｇｇ]", + H: "[HhĤĥȞȟʰᴴḢ-ḫẖℋ-ℎ⒣Ⓗⓗ㋌㍱㎐-㎔㏊㏋㏗Ｈｈ]", + I: "[IiÌ-Ïì-ïĨ-İIJijǏǐȈ-ȋᴵᵢḬḭỈ-ịⁱℐℑℹⅈⅠ-ⅣⅥ-ⅨⅪⅫⅰ-ⅳⅵ-ⅸⅺⅻ⒤Ⓘⓘ㍺㏌㏕fiffiＩｉ]", + J: "[JjIJ-ĵLJ-njǰʲᴶⅉ⒥ⒿⓙⱼＪｊ]", + K: "[KkĶķǨǩᴷᵏḰ-ḵK⒦Ⓚⓚ㎄㎅㎉㎏㎑㎘㎞㎢㎦㎪㎸㎾㏀㏆㏍-㏏Ｋｋ]", + L: "[LlĹ-ŀLJ-ljˡᴸḶḷḺ-ḽℒℓ℡Ⅼⅼ⒧Ⓛⓛ㋏㎈㎉㏐-㏓㏕㏖㏿flfflＬｌ]", + M: "[MmᴹᵐḾ-ṃ℠™ℳⅯⅿ⒨Ⓜⓜ㍷-㍹㎃㎆㎎㎒㎖㎙-㎨㎫㎳㎷㎹㎽㎿㏁㏂㏎㏐㏔-㏖㏘㏙㏞㏟Ｍｍ]", + N: "[NnÑñŃ-ʼnNJ-njǸǹᴺṄ-ṋⁿℕ№⒩Ⓝⓝ㎁㎋㎚㎱㎵㎻㏌㏑Ｎｎ]", + O: "[OoºÒ-Öò-öŌ-őƠơǑǒǪǫȌ-ȏȮȯᴼᵒỌ-ỏₒ℅№ℴ⒪Ⓞⓞ㍵㏇㏒㏖Ｏｏ]", + P: "[PpᴾᵖṔ-ṗℙ⒫Ⓟⓟ㉐㍱㍶㎀㎊㎩-㎬㎰㎴㎺㏋㏗-㏚Ｐｐ]", + Q: "[Qqℚ⒬Ⓠⓠ㏃Ｑｑ]", + R: "[RrŔ-řȐ-ȓʳᴿᵣṘ-ṛṞṟ₨ℛ-ℝ⒭Ⓡⓡ㋍㍴㎭-㎯㏚㏛Ｒｒ]", + S: "[SsŚ-šſȘșˢṠ-ṣ₨℁℠⒮Ⓢⓢ㎧㎨㎮-㎳㏛㏜stＳｓ]", + T: "[TtŢ-ťȚțᵀᵗṪ-ṱẗ℡™⒯Ⓣⓣ㉐㋏㎔㏏ſtstＴｔ]", + U: "[UuÙ-Üù-üŨ-ųƯưǓǔȔ-ȗᵁᵘᵤṲ-ṷỤ-ủ℆⒰Ⓤⓤ㍳㍺Ｕｕ]", + V: "[VvᵛᵥṼ-ṿⅣ-Ⅷⅳ-ⅷ⒱Ⓥⓥⱽ㋎㍵㎴-㎹㏜㏞Ｖｖ]", + W: "[WwŴŵʷᵂẀ-ẉẘ⒲Ⓦⓦ㎺-㎿㏝Ｗｗ]", + X: "[XxˣẊ-ẍₓ℻Ⅸ-Ⅻⅸ-ⅻ⒳Ⓧⓧ㏓Ｘｘ]", + Y: "[YyÝýÿŶ-ŸȲȳʸẎẏẙỲ-ỹ⒴Ⓨⓨ㏉Ｙｙ]", + Z: "[ZzŹ-žDZ-dzᶻẐ-ẕℤℨ⒵Ⓩⓩ㎐-㎔Ｚｚ]" + }; + return function hightlight(o) { + var regex; + o = _.mixin({}, defaults, o); + if (!o.node || !o.pattern) { + return; + } + o.pattern = _.isArray(o.pattern) ? o.pattern : [ o.pattern ]; + regex = getRegex(o.pattern, o.caseSensitive, o.wordsOnly, o.diacriticInsensitive); + traverse(o.node, hightlightTextNode); + function hightlightTextNode(textNode) { + var match, patternNode, wrapperNode; + if (match = regex.exec(textNode.data)) { + wrapperNode = doc.createElement(o.tagName); + o.className && (wrapperNode.className = o.className); + patternNode = textNode.splitText(match.index); + patternNode.splitText(match[0].length); + wrapperNode.appendChild(patternNode.cloneNode(true)); + textNode.parentNode.replaceChild(wrapperNode, patternNode); + } + return !!match; + } + function traverse(el, hightlightTextNode) { + var childNode, TEXT_NODE_TYPE = 3; + for (var i = 0; i < el.childNodes.length; i++) { + childNode = el.childNodes[i]; + if (childNode.nodeType === TEXT_NODE_TYPE) { + i += hightlightTextNode(childNode) ? 1 : 0; + } else { + traverse(childNode, hightlightTextNode); + } + } + } + }; + function accent_replacer(chr) { + return accented[chr.toUpperCase()] || chr; + } + function getRegex(patterns, caseSensitive, wordsOnly, diacriticInsensitive) { + var escapedPatterns = [], regexStr; + for (var i = 0, len = patterns.length; i < len; i++) { + var escapedWord = _.escapeRegExChars(patterns[i]); + if (diacriticInsensitive) { + escapedWord = escapedWord.replace(/\S/g, accent_replacer); + } + escapedPatterns.push(escapedWord); + } + regexStr = wordsOnly ? "\\b(" + escapedPatterns.join("|") + ")\\b" : "(" + escapedPatterns.join("|") + ")"; + return caseSensitive ? new RegExp(regexStr) : new RegExp(regexStr, "i"); + } + }(window.document); + var Input = function() { + "use strict"; + var specialKeyCodeMap; + specialKeyCodeMap = { + 9: "tab", + 27: "esc", + 37: "left", + 39: "right", + 13: "enter", + 38: "up", + 40: "down" + }; + function Input(o, www) { + var id; + o = o || {}; + if (!o.input) { + $.error("input is missing"); + } + www.mixin(this); + this.$hint = $(o.hint); + this.$input = $(o.input); + this.$menu = $(o.menu); + id = this.$input.attr("id") || _.guid(); + this.$menu.attr("id", id + "_listbox"); + this.$hint.attr({ + "aria-hidden": true + }); + this.$input.attr({ + "aria-owns": id + "_listbox", + role: "combobox", + "aria-autocomplete": "list", + "aria-expanded": false + }); + this.query = this.$input.val(); + this.queryWhenFocused = this.hasFocus() ? this.query : null; + this.$overflowHelper = buildOverflowHelper(this.$input); + this._checkLanguageDirection(); + if (this.$hint.length === 0) { + this.setHint = this.getHint = this.clearHint = this.clearHintIfInvalid = _.noop; + } + this.onSync("cursorchange", this._updateDescendent); + } + Input.normalizeQuery = function(str) { + return _.toStr(str).replace(/^\s*/g, "").replace(/\s{2,}/g, " "); + }; + _.mixin(Input.prototype, EventEmitter, { + _onBlur: function onBlur() { + this.resetInputValue(); + this.trigger("blurred"); + }, + _onFocus: function onFocus() { + this.queryWhenFocused = this.query; + this.trigger("focused"); + }, + _onKeydown: function onKeydown($e) { + var keyName = specialKeyCodeMap[$e.which || $e.keyCode]; + this._managePreventDefault(keyName, $e); + if (keyName && this._shouldTrigger(keyName, $e)) { + this.trigger(keyName + "Keyed", $e); + } + }, + _onInput: function onInput() { + this._setQuery(this.getInputValue()); + this.clearHintIfInvalid(); + this._checkLanguageDirection(); + }, + _managePreventDefault: function managePreventDefault(keyName, $e) { + var preventDefault; + switch (keyName) { + case "up": + case "down": + preventDefault = !withModifier($e); + break; + + default: + preventDefault = false; + } + preventDefault && $e.preventDefault(); + }, + _shouldTrigger: function shouldTrigger(keyName, $e) { + var trigger; + switch (keyName) { + case "tab": + trigger = !withModifier($e); + break; + + default: + trigger = true; + } + return trigger; + }, + _checkLanguageDirection: function checkLanguageDirection() { + var dir = (this.$input.css("direction") || "ltr").toLowerCase(); + if (this.dir !== dir) { + this.dir = dir; + this.$hint.attr("dir", dir); + this.trigger("langDirChanged", dir); + } + }, + _setQuery: function setQuery(val, silent) { + var areEquivalent, hasDifferentWhitespace; + areEquivalent = areQueriesEquivalent(val, this.query); + hasDifferentWhitespace = areEquivalent ? this.query.length !== val.length : false; + this.query = val; + if (!silent && !areEquivalent) { + this.trigger("queryChanged", this.query); + } else if (!silent && hasDifferentWhitespace) { + this.trigger("whitespaceChanged", this.query); + } + }, + _updateDescendent: function updateDescendent(event, id) { + this.$input.attr("aria-activedescendant", id); + }, + bind: function() { + var that = this, onBlur, onFocus, onKeydown, onInput; + onBlur = _.bind(this._onBlur, this); + onFocus = _.bind(this._onFocus, this); + onKeydown = _.bind(this._onKeydown, this); + onInput = _.bind(this._onInput, this); + this.$input.on("blur.tt", onBlur).on("focus.tt", onFocus).on("keydown.tt", onKeydown); + if (!_.isMsie() || _.isMsie() > 9) { + this.$input.on("input.tt", onInput); + } else { + this.$input.on("keydown.tt keypress.tt cut.tt paste.tt", function($e) { + if (specialKeyCodeMap[$e.which || $e.keyCode]) { + return; + } + _.defer(_.bind(that._onInput, that, $e)); + }); + } + return this; + }, + focus: function focus() { + this.$input.focus(); + }, + blur: function blur() { + this.$input.blur(); + }, + getLangDir: function getLangDir() { + return this.dir; + }, + getQuery: function getQuery() { + return this.query || ""; + }, + setQuery: function setQuery(val, silent) { + this.setInputValue(val); + this._setQuery(val, silent); + }, + hasQueryChangedSinceLastFocus: function hasQueryChangedSinceLastFocus() { + return this.query !== this.queryWhenFocused; + }, + getInputValue: function getInputValue() { + return this.$input.val(); + }, + setInputValue: function setInputValue(value) { + this.$input.val(value); + this.clearHintIfInvalid(); + this._checkLanguageDirection(); + }, + resetInputValue: function resetInputValue() { + this.setInputValue(this.query); + }, + getHint: function getHint() { + return this.$hint.val(); + }, + setHint: function setHint(value) { + this.$hint.val(value); + }, + clearHint: function clearHint() { + this.setHint(""); + }, + clearHintIfInvalid: function clearHintIfInvalid() { + var val, hint, valIsPrefixOfHint, isValid; + val = this.getInputValue(); + hint = this.getHint(); + valIsPrefixOfHint = val !== hint && hint.indexOf(val) === 0; + isValid = val !== "" && valIsPrefixOfHint && !this.hasOverflow(); + !isValid && this.clearHint(); + }, + hasFocus: function hasFocus() { + return this.$input.is(":focus"); + }, + hasOverflow: function hasOverflow() { + var constraint = this.$input.width() - 2; + this.$overflowHelper.text(this.getInputValue()); + return this.$overflowHelper.width() >= constraint; + }, + isCursorAtEnd: function() { + var valueLength, selectionStart, range; + valueLength = this.$input.val().length; + selectionStart = this.$input[0].selectionStart; + if (_.isNumber(selectionStart)) { + return selectionStart === valueLength; + } else if (document.selection) { + range = document.selection.createRange(); + range.moveStart("character", -valueLength); + return valueLength === range.text.length; + } + return true; + }, + destroy: function destroy() { + this.$hint.off(".tt"); + this.$input.off(".tt"); + this.$overflowHelper.remove(); + this.$hint = this.$input = this.$overflowHelper = $("
"); + }, + setAriaExpanded: function setAriaExpanded(value) { + this.$input.attr("aria-expanded", value); + } + }); + return Input; + function buildOverflowHelper($input) { + return $('').css({ + position: "absolute", + visibility: "hidden", + whiteSpace: "pre", + fontFamily: $input.css("font-family"), + fontSize: $input.css("font-size"), + fontStyle: $input.css("font-style"), + fontVariant: $input.css("font-variant"), + fontWeight: $input.css("font-weight"), + wordSpacing: $input.css("word-spacing"), + letterSpacing: $input.css("letter-spacing"), + textIndent: $input.css("text-indent"), + textRendering: $input.css("text-rendering"), + textTransform: $input.css("text-transform") + }).insertAfter($input); + } + function areQueriesEquivalent(a, b) { + return Input.normalizeQuery(a) === Input.normalizeQuery(b); + } + function withModifier($e) { + return $e.altKey || $e.ctrlKey || $e.metaKey || $e.shiftKey; + } + }(); + var Dataset = function() { + "use strict"; + var keys, nameGenerator; + keys = { + dataset: "tt-selectable-dataset", + val: "tt-selectable-display", + obj: "tt-selectable-object" + }; + nameGenerator = _.getIdGenerator(); + function Dataset(o, www) { + o = o || {}; + o.templates = o.templates || {}; + o.templates.notFound = o.templates.notFound || o.templates.empty; + if (!o.source) { + $.error("missing source"); + } + if (!o.node) { + $.error("missing node"); + } + if (o.name && !isValidName(o.name)) { + $.error("invalid dataset name: " + o.name); + } + www.mixin(this); + this.highlight = !!o.highlight; + this.name = _.toStr(o.name || nameGenerator()); + this.limit = o.limit || 5; + this.displayFn = getDisplayFn(o.display || o.displayKey); + this.templates = getTemplates(o.templates, this.displayFn); + this.source = o.source.__ttAdapter ? o.source.__ttAdapter() : o.source; + this.async = _.isUndefined(o.async) ? this.source.length > 2 : !!o.async; + this._resetLastSuggestion(); + this.$el = $(o.node).attr("role", "presentation").addClass(this.classes.dataset).addClass(this.classes.dataset + "-" + this.name); + } + Dataset.extractData = function extractData(el) { + var $el = $(el); + if ($el.data(keys.obj)) { + return { + dataset: $el.data(keys.dataset) || "", + val: $el.data(keys.val) || "", + obj: $el.data(keys.obj) || null + }; + } + return null; + }; + _.mixin(Dataset.prototype, EventEmitter, { + _overwrite: function overwrite(query, suggestions) { + suggestions = suggestions || []; + if (suggestions.length) { + this._renderSuggestions(query, suggestions); + } else if (this.async && this.templates.pending) { + this._renderPending(query); + } else if (!this.async && this.templates.notFound) { + this._renderNotFound(query); + } else { + this._empty(); + } + this.trigger("rendered", suggestions, false, this.name); + }, + _append: function append(query, suggestions) { + suggestions = suggestions || []; + if (suggestions.length && this.$lastSuggestion.length) { + this._appendSuggestions(query, suggestions); + } else if (suggestions.length) { + this._renderSuggestions(query, suggestions); + } else if (!this.$lastSuggestion.length && this.templates.notFound) { + this._renderNotFound(query); + } + this.trigger("rendered", suggestions, true, this.name); + }, + _renderSuggestions: function renderSuggestions(query, suggestions) { + var $fragment; + $fragment = this._getSuggestionsFragment(query, suggestions); + this.$lastSuggestion = $fragment.children().last(); + this.$el.html($fragment).prepend(this._getHeader(query, suggestions)).append(this._getFooter(query, suggestions)); + }, + _appendSuggestions: function appendSuggestions(query, suggestions) { + var $fragment, $lastSuggestion; + $fragment = this._getSuggestionsFragment(query, suggestions); + $lastSuggestion = $fragment.children().last(); + this.$lastSuggestion.after($fragment); + this.$lastSuggestion = $lastSuggestion; + }, + _renderPending: function renderPending(query) { + var template = this.templates.pending; + this._resetLastSuggestion(); + template && this.$el.html(template({ + query: query, + dataset: this.name + })); + }, + _renderNotFound: function renderNotFound(query) { + var template = this.templates.notFound; + this._resetLastSuggestion(); + template && this.$el.html(template({ + query: query, + dataset: this.name + })); + }, + _empty: function empty() { + this.$el.empty(); + this._resetLastSuggestion(); + }, + _getSuggestionsFragment: function getSuggestionsFragment(query, suggestions) { + var that = this, fragment; + fragment = document.createDocumentFragment(); + _.each(suggestions, function getSuggestionNode(suggestion) { + var $el, context; + context = that._injectQuery(query, suggestion); + $el = $(that.templates.suggestion(context)).data(keys.dataset, that.name).data(keys.obj, suggestion).data(keys.val, that.displayFn(suggestion)).addClass(that.classes.suggestion + " " + that.classes.selectable); + fragment.appendChild($el[0]); + }); + this.highlight && highlight({ + className: this.classes.highlight, + node: fragment, + pattern: query + }); + return $(fragment); + }, + _getFooter: function getFooter(query, suggestions) { + return this.templates.footer ? this.templates.footer({ + query: query, + suggestions: suggestions, + dataset: this.name + }) : null; + }, + _getHeader: function getHeader(query, suggestions) { + return this.templates.header ? this.templates.header({ + query: query, + suggestions: suggestions, + dataset: this.name + }) : null; + }, + _resetLastSuggestion: function resetLastSuggestion() { + this.$lastSuggestion = $(); + }, + _injectQuery: function injectQuery(query, obj) { + return _.isObject(obj) ? _.mixin({ + _query: query + }, obj) : obj; + }, + update: function update(query) { + var that = this, canceled = false, syncCalled = false, rendered = 0; + this.cancel(); + this.cancel = function cancel() { + canceled = true; + that.cancel = $.noop; + that.async && that.trigger("asyncCanceled", query, that.name); + }; + this.source(query, sync, async); + !syncCalled && sync([]); + function sync(suggestions) { + if (syncCalled) { + return; + } + syncCalled = true; + suggestions = (suggestions || []).slice(0, that.limit); + rendered = suggestions.length; + that._overwrite(query, suggestions); + if (rendered < that.limit && that.async) { + that.trigger("asyncRequested", query, that.name); + } + } + function async(suggestions) { + suggestions = suggestions || []; + if (!canceled && rendered < that.limit) { + that.cancel = $.noop; + var idx = Math.abs(rendered - that.limit); + rendered += idx; + that._append(query, suggestions.slice(0, idx)); + that.async && that.trigger("asyncReceived", query, that.name); + } + } + }, + cancel: $.noop, + clear: function clear() { + this._empty(); + this.cancel(); + this.trigger("cleared"); + }, + isEmpty: function isEmpty() { + return this.$el.is(":empty"); + }, + destroy: function destroy() { + this.$el = $("
"); + } + }); + return Dataset; + function getDisplayFn(display) { + display = display || _.stringify; + return _.isFunction(display) ? display : displayFn; + function displayFn(obj) { + return obj[display]; + } + } + function getTemplates(templates, displayFn) { + return { + notFound: templates.notFound && _.templatify(templates.notFound), + pending: templates.pending && _.templatify(templates.pending), + header: templates.header && _.templatify(templates.header), + footer: templates.footer && _.templatify(templates.footer), + suggestion: templates.suggestion ? userSuggestionTemplate : suggestionTemplate + }; + function userSuggestionTemplate(context) { + var template = templates.suggestion; + return $(template(context)).attr("id", _.guid()); + } + function suggestionTemplate(context) { + return $('
').attr("id", _.guid()).text(displayFn(context)); + } + } + function isValidName(str) { + return /^[_a-zA-Z0-9-]+$/.test(str); + } + }(); + var Menu = function() { + "use strict"; + function Menu(o, www) { + var that = this; + o = o || {}; + if (!o.node) { + $.error("node is required"); + } + www.mixin(this); + this.$node = $(o.node); + this.query = null; + this.datasets = _.map(o.datasets, initializeDataset); + function initializeDataset(oDataset) { + var node = that.$node.find(oDataset.node).first(); + oDataset.node = node.length ? node : $("
").appendTo(that.$node); + return new Dataset(oDataset, www); + } + } + _.mixin(Menu.prototype, EventEmitter, { + _onSelectableClick: function onSelectableClick($e) { + this.trigger("selectableClicked", $($e.currentTarget)); + }, + _onRendered: function onRendered(type, dataset, suggestions, async) { + this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty()); + this.trigger("datasetRendered", dataset, suggestions, async); + }, + _onCleared: function onCleared() { + this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty()); + this.trigger("datasetCleared"); + }, + _propagate: function propagate() { + this.trigger.apply(this, arguments); + }, + _allDatasetsEmpty: function allDatasetsEmpty() { + return _.every(this.datasets, _.bind(function isDatasetEmpty(dataset) { + var isEmpty = dataset.isEmpty(); + this.$node.attr("aria-expanded", !isEmpty); + return isEmpty; + }, this)); + }, + _getSelectables: function getSelectables() { + return this.$node.find(this.selectors.selectable); + }, + _removeCursor: function _removeCursor() { + var $selectable = this.getActiveSelectable(); + $selectable && $selectable.removeClass(this.classes.cursor); + }, + _ensureVisible: function ensureVisible($el) { + var elTop, elBottom, nodeScrollTop, nodeHeight; + elTop = $el.position().top; + elBottom = elTop + $el.outerHeight(true); + nodeScrollTop = this.$node.scrollTop(); + nodeHeight = this.$node.height() + parseInt(this.$node.css("paddingTop"), 10) + parseInt(this.$node.css("paddingBottom"), 10); + if (elTop < 0) { + this.$node.scrollTop(nodeScrollTop + elTop); + } else if (nodeHeight < elBottom) { + this.$node.scrollTop(nodeScrollTop + (elBottom - nodeHeight)); + } + }, + bind: function() { + var that = this, onSelectableClick; + onSelectableClick = _.bind(this._onSelectableClick, this); + this.$node.on("click.tt", this.selectors.selectable, onSelectableClick); + this.$node.on("mouseover", this.selectors.selectable, function() { + that.setCursor($(this)); + }); + this.$node.on("mouseleave", function() { + that._removeCursor(); + }); + _.each(this.datasets, function(dataset) { + dataset.onSync("asyncRequested", that._propagate, that).onSync("asyncCanceled", that._propagate, that).onSync("asyncReceived", that._propagate, that).onSync("rendered", that._onRendered, that).onSync("cleared", that._onCleared, that); + }); + return this; + }, + isOpen: function isOpen() { + return this.$node.hasClass(this.classes.open); + }, + open: function open() { + this.$node.scrollTop(0); + this.$node.addClass(this.classes.open); + }, + close: function close() { + this.$node.attr("aria-expanded", false); + this.$node.removeClass(this.classes.open); + this._removeCursor(); + }, + setLanguageDirection: function setLanguageDirection(dir) { + this.$node.attr("dir", dir); + }, + selectableRelativeToCursor: function selectableRelativeToCursor(delta) { + var $selectables, $oldCursor, oldIndex, newIndex; + $oldCursor = this.getActiveSelectable(); + $selectables = this._getSelectables(); + oldIndex = $oldCursor ? $selectables.index($oldCursor) : -1; + newIndex = oldIndex + delta; + newIndex = (newIndex + 1) % ($selectables.length + 1) - 1; + newIndex = newIndex < -1 ? $selectables.length - 1 : newIndex; + return newIndex === -1 ? null : $selectables.eq(newIndex); + }, + setCursor: function setCursor($selectable) { + this._removeCursor(); + if ($selectable = $selectable && $selectable.first()) { + $selectable.addClass(this.classes.cursor); + this._ensureVisible($selectable); + } + }, + getSelectableData: function getSelectableData($el) { + return $el && $el.length ? Dataset.extractData($el) : null; + }, + getActiveSelectable: function getActiveSelectable() { + var $selectable = this._getSelectables().filter(this.selectors.cursor).first(); + return $selectable.length ? $selectable : null; + }, + getTopSelectable: function getTopSelectable() { + var $selectable = this._getSelectables().first(); + return $selectable.length ? $selectable : null; + }, + update: function update(query) { + var isValidUpdate = query !== this.query; + if (isValidUpdate) { + this.query = query; + _.each(this.datasets, updateDataset); + } + return isValidUpdate; + function updateDataset(dataset) { + dataset.update(query); + } + }, + empty: function empty() { + _.each(this.datasets, clearDataset); + this.query = null; + this.$node.addClass(this.classes.empty); + function clearDataset(dataset) { + dataset.clear(); + } + }, + destroy: function destroy() { + this.$node.off(".tt"); + this.$node = $("
"); + _.each(this.datasets, destroyDataset); + function destroyDataset(dataset) { + dataset.destroy(); + } + } + }); + return Menu; + }(); + var Status = function() { + "use strict"; + function Status(options) { + this.$el = $("", { + role: "status", + "aria-live": "polite" + }).css({ + position: "absolute", + padding: "0", + border: "0", + height: "1px", + width: "1px", + "margin-bottom": "-1px", + "margin-right": "-1px", + overflow: "hidden", + clip: "rect(0 0 0 0)", + "white-space": "nowrap" + }); + options.$input.after(this.$el); + _.each(options.menu.datasets, _.bind(function(dataset) { + if (dataset.onSync) { + dataset.onSync("rendered", _.bind(this.update, this)); + dataset.onSync("cleared", _.bind(this.cleared, this)); + } + }, this)); + } + _.mixin(Status.prototype, { + update: function update(event, suggestions) { + var length = suggestions.length; + var words; + if (length === 1) { + words = { + result: "result", + is: "is" + }; + } else { + words = { + result: "results", + is: "are" + }; + } + this.$el.text(length + " " + words.result + " " + words.is + " available, use up and down arrow keys to navigate."); + }, + cleared: function() { + this.$el.text(""); + } + }); + return Status; + }(); + var DefaultMenu = function() { + "use strict"; + var s = Menu.prototype; + function DefaultMenu() { + Menu.apply(this, [].slice.call(arguments, 0)); + } + _.mixin(DefaultMenu.prototype, Menu.prototype, { + open: function open() { + !this._allDatasetsEmpty() && this._show(); + return s.open.apply(this, [].slice.call(arguments, 0)); + }, + close: function close() { + this._hide(); + return s.close.apply(this, [].slice.call(arguments, 0)); + }, + _onRendered: function onRendered() { + if (this._allDatasetsEmpty()) { + this._hide(); + } else { + this.isOpen() && this._show(); + } + return s._onRendered.apply(this, [].slice.call(arguments, 0)); + }, + _onCleared: function onCleared() { + if (this._allDatasetsEmpty()) { + this._hide(); + } else { + this.isOpen() && this._show(); + } + return s._onCleared.apply(this, [].slice.call(arguments, 0)); + }, + setLanguageDirection: function setLanguageDirection(dir) { + this.$node.css(dir === "ltr" ? this.css.ltr : this.css.rtl); + return s.setLanguageDirection.apply(this, [].slice.call(arguments, 0)); + }, + _hide: function hide() { + this.$node.hide(); + }, + _show: function show() { + this.$node.css("display", "block"); + } + }); + return DefaultMenu; + }(); + var Typeahead = function() { + "use strict"; + function Typeahead(o, www) { + var onFocused, onBlurred, onEnterKeyed, onTabKeyed, onEscKeyed, onUpKeyed, onDownKeyed, onLeftKeyed, onRightKeyed, onQueryChanged, onWhitespaceChanged; + o = o || {}; + if (!o.input) { + $.error("missing input"); + } + if (!o.menu) { + $.error("missing menu"); + } + if (!o.eventBus) { + $.error("missing event bus"); + } + www.mixin(this); + this.eventBus = o.eventBus; + this.minLength = _.isNumber(o.minLength) ? o.minLength : 1; + this.input = o.input; + this.menu = o.menu; + this.enabled = true; + this.autoselect = !!o.autoselect; + this.active = false; + this.input.hasFocus() && this.activate(); + this.dir = this.input.getLangDir(); + this._hacks(); + this.menu.bind().onSync("selectableClicked", this._onSelectableClicked, this).onSync("asyncRequested", this._onAsyncRequested, this).onSync("asyncCanceled", this._onAsyncCanceled, this).onSync("asyncReceived", this._onAsyncReceived, this).onSync("datasetRendered", this._onDatasetRendered, this).onSync("datasetCleared", this._onDatasetCleared, this); + onFocused = c(this, "activate", "open", "_onFocused"); + onBlurred = c(this, "deactivate", "_onBlurred"); + onEnterKeyed = c(this, "isActive", "isOpen", "_onEnterKeyed"); + onTabKeyed = c(this, "isActive", "isOpen", "_onTabKeyed"); + onEscKeyed = c(this, "isActive", "_onEscKeyed"); + onUpKeyed = c(this, "isActive", "open", "_onUpKeyed"); + onDownKeyed = c(this, "isActive", "open", "_onDownKeyed"); + onLeftKeyed = c(this, "isActive", "isOpen", "_onLeftKeyed"); + onRightKeyed = c(this, "isActive", "isOpen", "_onRightKeyed"); + onQueryChanged = c(this, "_openIfActive", "_onQueryChanged"); + onWhitespaceChanged = c(this, "_openIfActive", "_onWhitespaceChanged"); + this.input.bind().onSync("focused", onFocused, this).onSync("blurred", onBlurred, this).onSync("enterKeyed", onEnterKeyed, this).onSync("tabKeyed", onTabKeyed, this).onSync("escKeyed", onEscKeyed, this).onSync("upKeyed", onUpKeyed, this).onSync("downKeyed", onDownKeyed, this).onSync("leftKeyed", onLeftKeyed, this).onSync("rightKeyed", onRightKeyed, this).onSync("queryChanged", onQueryChanged, this).onSync("whitespaceChanged", onWhitespaceChanged, this).onSync("langDirChanged", this._onLangDirChanged, this); + } + _.mixin(Typeahead.prototype, { + _hacks: function hacks() { + var $input, $menu; + $input = this.input.$input || $("
"); + $menu = this.menu.$node || $("
"); + $input.on("blur.tt", function($e) { + var active, isActive, hasActive; + active = document.activeElement; + isActive = $menu.is(active); + hasActive = $menu.has(active).length > 0; + if (_.isMsie() && (isActive || hasActive)) { + $e.preventDefault(); + $e.stopImmediatePropagation(); + _.defer(function() { + $input.focus(); + }); + } + }); + $menu.on("mousedown.tt", function($e) { + $e.preventDefault(); + }); + }, + _onSelectableClicked: function onSelectableClicked(type, $el) { + this.select($el); + }, + _onDatasetCleared: function onDatasetCleared() { + this._updateHint(); + }, + _onDatasetRendered: function onDatasetRendered(type, suggestions, async, dataset) { + this._updateHint(); + if (this.autoselect) { + var cursorClass = this.selectors.cursor.substr(1); + this.menu.$node.find(this.selectors.suggestion).first().addClass(cursorClass); + } + this.eventBus.trigger("render", suggestions, async, dataset); + }, + _onAsyncRequested: function onAsyncRequested(type, dataset, query) { + this.eventBus.trigger("asyncrequest", query, dataset); + }, + _onAsyncCanceled: function onAsyncCanceled(type, dataset, query) { + this.eventBus.trigger("asynccancel", query, dataset); + }, + _onAsyncReceived: function onAsyncReceived(type, dataset, query) { + this.eventBus.trigger("asyncreceive", query, dataset); + }, + _onFocused: function onFocused() { + this._minLengthMet() && this.menu.update(this.input.getQuery()); + }, + _onBlurred: function onBlurred() { + if (this.input.hasQueryChangedSinceLastFocus()) { + this.eventBus.trigger("change", this.input.getQuery()); + } + }, + _onEnterKeyed: function onEnterKeyed(type, $e) { + var $selectable; + if ($selectable = this.menu.getActiveSelectable()) { + if (this.select($selectable)) { + $e.preventDefault(); + $e.stopPropagation(); + } + } else if (this.autoselect) { + if (this.select(this.menu.getTopSelectable())) { + $e.preventDefault(); + $e.stopPropagation(); + } + } + }, + _onTabKeyed: function onTabKeyed(type, $e) { + var $selectable; + if ($selectable = this.menu.getActiveSelectable()) { + this.select($selectable) && $e.preventDefault(); + } else if (this.autoselect) { + if ($selectable = this.menu.getTopSelectable()) { + this.autocomplete($selectable) && $e.preventDefault(); + } + } + }, + _onEscKeyed: function onEscKeyed() { + this.close(); + }, + _onUpKeyed: function onUpKeyed() { + this.moveCursor(-1); + }, + _onDownKeyed: function onDownKeyed() { + this.moveCursor(+1); + }, + _onLeftKeyed: function onLeftKeyed() { + if (this.dir === "rtl" && this.input.isCursorAtEnd()) { + this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable()); + } + }, + _onRightKeyed: function onRightKeyed() { + if (this.dir === "ltr" && this.input.isCursorAtEnd()) { + this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable()); + } + }, + _onQueryChanged: function onQueryChanged(e, query) { + this._minLengthMet(query) ? this.menu.update(query) : this.menu.empty(); + }, + _onWhitespaceChanged: function onWhitespaceChanged() { + this._updateHint(); + }, + _onLangDirChanged: function onLangDirChanged(e, dir) { + if (this.dir !== dir) { + this.dir = dir; + this.menu.setLanguageDirection(dir); + } + }, + _openIfActive: function openIfActive() { + this.isActive() && this.open(); + }, + _minLengthMet: function minLengthMet(query) { + query = _.isString(query) ? query : this.input.getQuery() || ""; + return query.length >= this.minLength; + }, + _updateHint: function updateHint() { + var $selectable, data, val, query, escapedQuery, frontMatchRegEx, match; + $selectable = this.menu.getTopSelectable(); + data = this.menu.getSelectableData($selectable); + val = this.input.getInputValue(); + if (data && !_.isBlankString(val) && !this.input.hasOverflow()) { + query = Input.normalizeQuery(val); + escapedQuery = _.escapeRegExChars(query); + frontMatchRegEx = new RegExp("^(?:" + escapedQuery + ")(.+$)", "i"); + match = frontMatchRegEx.exec(data.val); + match && this.input.setHint(val + match[1]); + } else { + this.input.clearHint(); + } + }, + isEnabled: function isEnabled() { + return this.enabled; + }, + enable: function enable() { + this.enabled = true; + }, + disable: function disable() { + this.enabled = false; + }, + isActive: function isActive() { + return this.active; + }, + activate: function activate() { + if (this.isActive()) { + return true; + } else if (!this.isEnabled() || this.eventBus.before("active")) { + return false; + } else { + this.active = true; + this.eventBus.trigger("active"); + return true; + } + }, + deactivate: function deactivate() { + if (!this.isActive()) { + return true; + } else if (this.eventBus.before("idle")) { + return false; + } else { + this.active = false; + this.close(); + this.eventBus.trigger("idle"); + return true; + } + }, + isOpen: function isOpen() { + return this.menu.isOpen(); + }, + open: function open() { + if (!this.isOpen() && !this.eventBus.before("open")) { + this.input.setAriaExpanded(true); + this.menu.open(); + this._updateHint(); + this.eventBus.trigger("open"); + } + return this.isOpen(); + }, + close: function close() { + if (this.isOpen() && !this.eventBus.before("close")) { + this.input.setAriaExpanded(false); + this.menu.close(); + this.input.clearHint(); + this.input.resetInputValue(); + this.eventBus.trigger("close"); + } + return !this.isOpen(); + }, + setVal: function setVal(val) { + this.input.setQuery(_.toStr(val)); + }, + getVal: function getVal() { + return this.input.getQuery(); + }, + select: function select($selectable) { + var data = this.menu.getSelectableData($selectable); + if (data && !this.eventBus.before("select", data.obj, data.dataset)) { + this.input.setQuery(data.val, true); + this.eventBus.trigger("select", data.obj, data.dataset); + this.close(); + return true; + } + return false; + }, + autocomplete: function autocomplete($selectable) { + var query, data, isValid; + query = this.input.getQuery(); + data = this.menu.getSelectableData($selectable); + isValid = data && query !== data.val; + if (isValid && !this.eventBus.before("autocomplete", data.obj, data.dataset)) { + this.input.setQuery(data.val); + this.eventBus.trigger("autocomplete", data.obj, data.dataset); + return true; + } + return false; + }, + moveCursor: function moveCursor(delta) { + var query, $candidate, data, suggestion, datasetName, cancelMove, id; + query = this.input.getQuery(); + $candidate = this.menu.selectableRelativeToCursor(delta); + data = this.menu.getSelectableData($candidate); + suggestion = data ? data.obj : null; + datasetName = data ? data.dataset : null; + id = $candidate ? $candidate.attr("id") : null; + this.input.trigger("cursorchange", id); + cancelMove = this._minLengthMet() && this.menu.update(query); + if (!cancelMove && !this.eventBus.before("cursorchange", suggestion, datasetName)) { + this.menu.setCursor($candidate); + if (data) { + if (typeof data.val === "string") { + this.input.setInputValue(data.val); + } + } else { + this.input.resetInputValue(); + this._updateHint(); + } + this.eventBus.trigger("cursorchange", suggestion, datasetName); + return true; + } + return false; + }, + destroy: function destroy() { + this.input.destroy(); + this.menu.destroy(); + } + }); + return Typeahead; + function c(ctx) { + var methods = [].slice.call(arguments, 1); + return function() { + var args = [].slice.call(arguments); + _.each(methods, function(method) { + return ctx[method].apply(ctx, args); + }); + }; + } + }(); + (function() { + "use strict"; + var old, keys, methods; + old = $.fn.typeahead; + keys = { + www: "tt-www", + attrs: "tt-attrs", + typeahead: "tt-typeahead" + }; + methods = { + initialize: function initialize(o, datasets) { + var www; + datasets = _.isArray(datasets) ? datasets : [].slice.call(arguments, 1); + o = o || {}; + www = WWW(o.classNames); + return this.each(attach); + function attach() { + var $input, $wrapper, $hint, $menu, defaultHint, defaultMenu, eventBus, input, menu, status, typeahead, MenuConstructor; + _.each(datasets, function(d) { + d.highlight = !!o.highlight; + }); + $input = $(this); + $wrapper = $(www.html.wrapper); + $hint = $elOrNull(o.hint); + $menu = $elOrNull(o.menu); + defaultHint = o.hint !== false && !$hint; + defaultMenu = o.menu !== false && !$menu; + defaultHint && ($hint = buildHintFromInput($input, www)); + defaultMenu && ($menu = $(www.html.menu).css(www.css.menu)); + $hint && $hint.val(""); + $input = prepInput($input, www); + if (defaultHint || defaultMenu) { + $wrapper.css(www.css.wrapper); + $input.css(defaultHint ? www.css.input : www.css.inputWithNoHint); + $input.wrap($wrapper).parent().prepend(defaultHint ? $hint : null).append(defaultMenu ? $menu : null); + } + MenuConstructor = defaultMenu ? DefaultMenu : Menu; + eventBus = new EventBus({ + el: $input + }); + input = new Input({ + hint: $hint, + input: $input, + menu: $menu + }, www); + menu = new MenuConstructor({ + node: $menu, + datasets: datasets + }, www); + status = new Status({ + $input: $input, + menu: menu + }); + typeahead = new Typeahead({ + input: input, + menu: menu, + eventBus: eventBus, + minLength: o.minLength, + autoselect: o.autoselect + }, www); + $input.data(keys.www, www); + $input.data(keys.typeahead, typeahead); + } + }, + isEnabled: function isEnabled() { + var enabled; + ttEach(this.first(), function(t) { + enabled = t.isEnabled(); + }); + return enabled; + }, + enable: function enable() { + ttEach(this, function(t) { + t.enable(); + }); + return this; + }, + disable: function disable() { + ttEach(this, function(t) { + t.disable(); + }); + return this; + }, + isActive: function isActive() { + var active; + ttEach(this.first(), function(t) { + active = t.isActive(); + }); + return active; + }, + activate: function activate() { + ttEach(this, function(t) { + t.activate(); + }); + return this; + }, + deactivate: function deactivate() { + ttEach(this, function(t) { + t.deactivate(); + }); + return this; + }, + isOpen: function isOpen() { + var open; + ttEach(this.first(), function(t) { + open = t.isOpen(); + }); + return open; + }, + open: function open() { + ttEach(this, function(t) { + t.open(); + }); + return this; + }, + close: function close() { + ttEach(this, function(t) { + t.close(); + }); + return this; + }, + select: function select(el) { + var success = false, $el = $(el); + ttEach(this.first(), function(t) { + success = t.select($el); + }); + return success; + }, + autocomplete: function autocomplete(el) { + var success = false, $el = $(el); + ttEach(this.first(), function(t) { + success = t.autocomplete($el); + }); + return success; + }, + moveCursor: function moveCursoe(delta) { + var success = false; + ttEach(this.first(), function(t) { + success = t.moveCursor(delta); + }); + return success; + }, + val: function val(newVal) { + var query; + if (!arguments.length) { + ttEach(this.first(), function(t) { + query = t.getVal(); + }); + return query; + } else { + ttEach(this, function(t) { + t.setVal(_.toStr(newVal)); + }); + return this; + } + }, + destroy: function destroy() { + ttEach(this, function(typeahead, $input) { + revert($input); + typeahead.destroy(); + }); + return this; + } + }; + $.fn.typeahead = function(method) { + if (methods[method]) { + return methods[method].apply(this, [].slice.call(arguments, 1)); + } else { + return methods.initialize.apply(this, arguments); + } + }; + $.fn.typeahead.noConflict = function noConflict() { + $.fn.typeahead = old; + return this; + }; + function ttEach($els, fn) { + $els.each(function() { + var $input = $(this), typeahead; + (typeahead = $input.data(keys.typeahead)) && fn(typeahead, $input); + }); + } + function buildHintFromInput($input, www) { + return $input.clone().addClass(www.classes.hint).removeData().css(www.css.hint).css(getBackgroundStyles($input)).prop({ + readonly: true, + required: false + }).removeAttr("id name placeholder").removeClass("required").attr({ + spellcheck: "false", + tabindex: -1 + }); + } + function prepInput($input, www) { + $input.data(keys.attrs, { + dir: $input.attr("dir"), + autocomplete: $input.attr("autocomplete"), + spellcheck: $input.attr("spellcheck"), + style: $input.attr("style") + }); + $input.addClass(www.classes.input).attr({ + spellcheck: false + }); + try { + !$input.attr("dir") && $input.attr("dir", "auto"); + } catch (e) {} + return $input; + } + function getBackgroundStyles($el) { + return { + backgroundAttachment: $el.css("background-attachment"), + backgroundClip: $el.css("background-clip"), + backgroundColor: $el.css("background-color"), + backgroundImage: $el.css("background-image"), + backgroundOrigin: $el.css("background-origin"), + backgroundPosition: $el.css("background-position"), + backgroundRepeat: $el.css("background-repeat"), + backgroundSize: $el.css("background-size") + }; + } + function revert($input) { + var www, $wrapper; + www = $input.data(keys.www); + $wrapper = $input.parent().filter(www.selectors.wrapper); + _.each($input.data(keys.attrs), function(val, key) { + _.isUndefined(val) ? $input.removeAttr(key) : $input.attr(key, val); + }); + $input.removeData(keys.typeahead).removeData(keys.www).removeData(keys.attr).removeClass(www.classes.input); + if ($wrapper.length) { + $input.detach().insertAfter($wrapper); + $wrapper.remove(); + } + } + function $elOrNull(obj) { + var isValid, $el; + isValid = _.isJQuery(obj) || _.isElement(obj); + $el = isValid ? $(obj).first() : []; + return $el.length ? $el : null; + } + })(); +}); \ No newline at end of file diff --git a/docs/2.19.0/search.json b/docs/2.19.0/search.json new file mode 100644 index 00000000..35e53f3c --- /dev/null +++ b/docs/2.19.0/search.json @@ -0,0 +1 @@ +{"Blocks.html#/c:SCPBlocks.h@T@SCPConnectionTokenCompletionBlock":{"name":"SCPConnectionTokenCompletionBlock","abstract":"

A block called with a connection token or an error from your backend.

"},"Blocks.html#/c:SCPBlocks.h@T@SCPErrorCompletionBlock":{"name":"SCPErrorCompletionBlock","abstract":"

A block called with an optional error.

"},"Blocks.html#/c:SCPBlocks.h@T@SCPLogListenerBlock":{"name":"SCPLogListenerBlock","abstract":"

A block called with a logline from the SDK.

"},"Blocks.html#/c:SCPBlocks.h@T@SCPPaymentIntentCompletionBlock":{"name":"SCPPaymentIntentCompletionBlock","abstract":"

A block called with a PaymentIntent or an error.

"},"Blocks.html#/c:SCPBlocks.h@T@SCPPaymentMethodCompletionBlock":{"name":"SCPPaymentMethodCompletionBlock","abstract":"

A block called with a PaymentMethod.

"},"Blocks.html#/c:SCPBlocks.h@T@SCPProcessPaymentCompletionBlock":{"name":"SCPProcessPaymentCompletionBlock","abstract":"

A block called with a PaymentIntent or a ProcessPaymentError

"},"Blocks.html#/c:SCPBlocks.h@T@SCPReaderCompletionBlock":{"name":"SCPReaderCompletionBlock","abstract":"

A block called with a reader object or an error.

"},"Blocks.html#/c:SCPBlocks.h@T@SCPProcessRefundCompletionBlock":{"name":"SCPProcessRefundCompletionBlock","abstract":"

A block called with a Refund or a ProcessRefundError.

"},"Blocks.html#/c:SCPBlocks.h@T@SCPConfirmSetupIntentCompletionBlock":{"name":"SCPConfirmSetupIntentCompletionBlock","abstract":"

A block called with a SetupIntent or a ConfirmSetupIntentError.

"},"Blocks.html#/c:SCPBlocks.h@T@SCPLocationsCompletionBlock":{"name":"SCPLocationsCompletionBlock","abstract":"

A block called with a list of Locations or an error.

"},"Blocks.html#/c:SCPBlocks.h@T@SCPRefundCompletionBlock":{"name":"SCPRefundCompletionBlock","abstract":"

A block called with a Refund or an error.

"},"Blocks.html#/c:SCPBlocks.h@T@SCPSetupIntentCompletionBlock":{"name":"SCPSetupIntentCompletionBlock","abstract":"

A block called with a SetupIntent or an error.

"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBusy":{"name":"SCPErrorBusy","abstract":"

The SDK is busy executing another command. The SDK can only execute a","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCancelFailedAlreadyCompleted":{"name":"SCPErrorCancelFailedAlreadyCompleted","abstract":"

Canceling a command failed because the command already completed.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNotConnectedToReader":{"name":"SCPErrorNotConnectedToReader","abstract":"

No reader is connected. Connect to a reader before trying again.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAlreadyConnectedToReader":{"name":"SCPErrorAlreadyConnectedToReader","abstract":"

Already connected to a reader.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorConnectionTokenProviderCompletedWithNothing":{"name":"SCPErrorConnectionTokenProviderCompletedWithNothing","abstract":"

Your implementation of fetchConnectionToken called the completion block","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorProcessInvalidPaymentIntent":{"name":"SCPErrorProcessInvalidPaymentIntent","abstract":"

processPayment was called with an unknown or invalid PaymentIntent.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNilPaymentIntent":{"name":"SCPErrorNilPaymentIntent","abstract":"

collectPaymentMethod or processPayment was called with a nil PaymentIntent.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNilSetupIntent":{"name":"SCPErrorNilSetupIntent","abstract":"

collectSetupIntentPaymentMethod or processSetupIntent was called with","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNilRefundPaymentMethod":{"name":"SCPErrorNilRefundPaymentMethod","abstract":"

processRefund was called without calling collectRefundPaymentMethod","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidRefundParameters":{"name":"SCPErrorInvalidRefundParameters","abstract":"

The RefundParameters object has invalid values. The Charge ID (ch_123abc)","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidClientSecret":{"name":"SCPErrorInvalidClientSecret","abstract":"

A PaymentIntent or SetupIntent was referenced using an invalid client secret.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorMustBeDiscoveringToConnect":{"name":"SCPErrorMustBeDiscoveringToConnect","abstract":"

The SDK must be actively Discovering Readers in order to successfully","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCannotConnectToUndiscoveredReader":{"name":"SCPErrorCannotConnectToUndiscoveredReader","abstract":"

Before connecting to a reader, it must have already been discovered in the","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidDiscoveryConfiguration":{"name":"SCPErrorInvalidDiscoveryConfiguration","abstract":"

discoverReaders was called using an invalid SCPDiscoveryConfiguration.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidReaderForUpdate":{"name":"SCPErrorInvalidReaderForUpdate","abstract":"

installUpdate was passed an update that is for a different reader. Updates can only","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnsupportedSDK":{"name":"SCPErrorUnsupportedSDK","abstract":"

-[SCPTerminal connectReader:completion:] was called from an unsupported version","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorFeatureNotAvailableWithConnectedReader":{"name":"SCPErrorFeatureNotAvailableWithConnectedReader","abstract":"

This feature is currently not available for the selected reader.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorFeatureNotAvailable":{"name":"SCPErrorFeatureNotAvailable","abstract":"

This feature is not currently available.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidListLocationsLimitParameter":{"name":"SCPErrorInvalidListLocationsLimitParameter","abstract":"

The ListLocationsParameters object has invalid values.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothConnectionInvalidLocationIdParameter":{"name":"SCPErrorBluetoothConnectionInvalidLocationIdParameter","abstract":"

The locationId parameter to BluetoothConnectionConfiguration is required but a valid one was not provided.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidRequiredParameter":{"name":"SCPErrorInvalidRequiredParameter","abstract":"

A required parameter was invalid or missing.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderConnectionConfigurationInvalid":{"name":"SCPErrorReaderConnectionConfigurationInvalid","abstract":"

An invalid ConnectionConfiguration was passed through connect.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderTippingParameterInvalid":{"name":"SCPErrorReaderTippingParameterInvalid","abstract":"

An invalid usage of eligibleAmount or skipTipping was passed into collect.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidLocationIdParameter":{"name":"SCPErrorInvalidLocationIdParameter","abstract":"

The provided location ID parameter was invalid.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCanceled":{"name":"SCPErrorCanceled","abstract":"

The command was canceled by your app.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorLocationServicesDisabled":{"name":"SCPErrorLocationServicesDisabled","abstract":"

Access to location services is currently disabled. This may be because:

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothDisabled":{"name":"SCPErrorBluetoothDisabled","abstract":"

This error indicates that Bluetooth is turned off, and the user should use","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothAccessDenied":{"name":"SCPErrorBluetoothAccessDenied","abstract":"

Bluetooth is turned on on the device, but access to Bluetooth has been denied","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothScanTimedOut":{"name":"SCPErrorBluetoothScanTimedOut","abstract":"

Scanning for bluetooth devices timed out.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothLowEnergyUnsupported":{"name":"SCPErrorBluetoothLowEnergyUnsupported","abstract":"

Bluetooth Low Energy is unsupported on this iOS device. Use a different","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedBatteryLow":{"name":"SCPErrorReaderSoftwareUpdateFailedBatteryLow","abstract":"

Updating the reader software failed because the reader’s battery is","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedInterrupted":{"name":"SCPErrorReaderSoftwareUpdateFailedInterrupted","abstract":"

Updating the reader software failed because the update was interrupted.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedExpiredUpdate":{"name":"SCPErrorReaderSoftwareUpdateFailedExpiredUpdate","abstract":"

Updating the reader software failed because the update has expired. Please disconnect and","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothConnectionFailedBatteryCriticallyLow":{"name":"SCPErrorBluetoothConnectionFailedBatteryCriticallyLow","abstract":"

The reader has a critically low battery and cannot connect to the","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardInsertNotRead":{"name":"SCPErrorCardInsertNotRead","abstract":"

The card is not a chip card.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardSwipeNotRead":{"name":"SCPErrorCardSwipeNotRead","abstract":"

The swipe could not be read.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardReadTimedOut":{"name":"SCPErrorCardReadTimedOut","abstract":"

Reading a card timed out.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardRemoved":{"name":"SCPErrorCardRemoved","abstract":"

The card was removed during the transaction.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardLeftInReader":{"name":"SCPErrorCardLeftInReader","abstract":"

A card can only be used for one transaction, and must be removed after","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorMissingEMVData":{"name":"SCPErrorMissingEMVData","abstract":"

The reader failed to read the data from the presented payment method. If you encounter","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCommandNotAllowed":{"name":"SCPErrorCommandNotAllowed","abstract":"

The command was not permitted to execute by the operating system.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnsupportedMobileDeviceConfiguration":{"name":"SCPErrorUnsupportedMobileDeviceConfiguration","abstract":"

The mobile device on which the app is running is in an unsupported","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorPasscodeNotEnabled":{"name":"SCPErrorPasscodeNotEnabled","abstract":"

The mobile device on which the app is running must have a passcode set.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCommandNotAllowedDuringCall":{"name":"SCPErrorCommandNotAllowedDuringCall","abstract":"

The card reader cannot be used while a phone call is active.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidAmount":{"name":"SCPErrorInvalidAmount","abstract":"

An attempt was made to charge an amount not supported by the reader.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidCurrency":{"name":"SCPErrorInvalidCurrency","abstract":"

An attempt was made to charge an amount in a currency not supported by the reader.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderTOSAcceptanceRequiresiCloudSignIn":{"name":"SCPErrorAppleBuiltInReaderTOSAcceptanceRequiresiCloudSignIn","abstract":"

Failed to accept reader-specific terms of service because there is no iCloud","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderTOSAcceptanceCanceled":{"name":"SCPErrorAppleBuiltInReaderTOSAcceptanceCanceled","abstract":"

The user cancelled reader-specific terms of service acceptance.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderBusy":{"name":"SCPErrorReaderBusy","abstract":"

The reader is busy.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorIncompatibleReader":{"name":"SCPErrorIncompatibleReader","abstract":"

An incompatible reader was detected. You can only use the Stripe Terminal","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderCommunicationError":{"name":"SCPErrorReaderCommunicationError","abstract":"

Could not communicate with the reader.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNFCDisabled":{"name":"SCPErrorNFCDisabled","abstract":"

NFC functionality is disabled.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothError":{"name":"SCPErrorBluetoothError","abstract":"

Generic Bluetooth error.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothConnectTimedOut":{"name":"SCPErrorBluetoothConnectTimedOut","abstract":"

Connecting to the bluetooth device timed out. Make sure the device is","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothDisconnected":{"name":"SCPErrorBluetoothDisconnected","abstract":"

The Bluetooth device was disconnected unexpectedly.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothPeerRemovedPairingInformation":{"name":"SCPErrorBluetoothPeerRemovedPairingInformation","abstract":"

Bluetooth pairing error, the reader has removed this device pairing information.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothAlreadyPairedWithAnotherDevice":{"name":"SCPErrorBluetoothAlreadyPairedWithAnotherDevice","abstract":"

The Bluetooth reader is already paired to another device. The Bluetooth reader","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailed":{"name":"SCPErrorReaderSoftwareUpdateFailed","abstract":"

Generic reader software update error.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedReaderError":{"name":"SCPErrorReaderSoftwareUpdateFailedReaderError","abstract":"

Updating the reader software failed because there was an error","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedServerError":{"name":"SCPErrorReaderSoftwareUpdateFailedServerError","abstract":"

Updating the reader software failed because there was an error","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnsupportedReaderVersion":{"name":"SCPErrorUnsupportedReaderVersion","abstract":"

processPayment was called from a reader with an unsupported reader","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnknownReaderIpAddress":{"name":"SCPErrorUnknownReaderIpAddress","abstract":"

The reader returned from discovery does not have an IP address and cannot","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInternetConnectTimeOut":{"name":"SCPErrorInternetConnectTimeOut","abstract":"

Connecting to reader over the internet timed out. Make sure your device and","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorConnectFailedReaderIsInUse":{"name":"SCPErrorConnectFailedReaderIsInUse","abstract":"

Connecting to the reader failed because it is currently in use","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothReconnectStarted":{"name":"SCPErrorBluetoothReconnectStarted","abstract":"

The Bluetooth reader has disconnected and we are attempting to reconnect.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderNotAccessibleInBackground":{"name":"SCPErrorReaderNotAccessibleInBackground","abstract":"

An attempt was made to interact with the reader while the the app is in the background.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderFailedToPrepare":{"name":"SCPErrorAppleBuiltInReaderFailedToPrepare","abstract":"

Preparing the Apple Built-In reader to collect payments failed.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderDeviceBanned":{"name":"SCPErrorAppleBuiltInReaderDeviceBanned","abstract":"

This device cannot be used to process using the Apple Built-In reader as it has been banned.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderTOSNotYetAccepted":{"name":"SCPErrorAppleBuiltInReaderTOSNotYetAccepted","abstract":"

The operation could not be completed because the reader-specific terms of service have","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderTOSAcceptanceFailed":{"name":"SCPErrorAppleBuiltInReaderTOSAcceptanceFailed","abstract":"

Failed to accept reader-specific terms of service using the signed-in Apple ID.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderMerchantBlocked":{"name":"SCPErrorAppleBuiltInReaderMerchantBlocked","abstract":"

This merchant account cannot be used with Apple Built-In reader as it has been blocked.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderInvalidMerchant":{"name":"SCPErrorAppleBuiltInReaderInvalidMerchant","abstract":"

This merchant account cannot be used with the Apple Built-In reader as it is invalid.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnexpectedSdkError":{"name":"SCPErrorUnexpectedSdkError","abstract":"

Unexpected SDK error.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnexpectedReaderError":{"name":"SCPErrorUnexpectedReaderError","abstract":"

Unexpected reader error.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorDeclinedByStripeAPI":{"name":"SCPErrorDeclinedByStripeAPI","abstract":"

The Stripe API declined the transaction.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorDeclinedByReader":{"name":"SCPErrorDeclinedByReader","abstract":"

The reader declined the transaction. Try another card.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCommandRequiresCardholderConsent":{"name":"SCPErrorCommandRequiresCardholderConsent","abstract":"

The cardholder must give consent in order for this operation to succeed.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorRefundFailed":{"name":"SCPErrorRefundFailed","abstract":"

The refund failed. The customer’s bank or card issuer was unable to process","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNotConnectedToInternet":{"name":"SCPErrorNotConnectedToInternet","abstract":"

The SDK is not connected to the internet.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorRequestTimedOut":{"name":"SCPErrorRequestTimedOut","abstract":"

The underlying request timed out.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorStripeAPIError":{"name":"SCPErrorStripeAPIError","abstract":"

The underlying request returned an API error.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorStripeAPIResponseDecodingError":{"name":"SCPErrorStripeAPIResponseDecodingError","abstract":"

The API response from Stripe could not be decoded.

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInternalNetworkError":{"name":"SCPErrorInternalNetworkError","abstract":"

Generic network error

","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorConnectionTokenProviderCompletedWithError":{"name":"SCPErrorConnectionTokenProviderCompletedWithError","abstract":"

Your implementation of -[SCPConnectionTokenProvider fetchConnectionToken:]","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorSessionExpired":{"name":"SCPErrorSessionExpired","abstract":"

The current session has expired and the reader must be disconnected and","parent_name":"SCPError"},"Enums/SCPError.html":{"name":"SCPError","abstract":"

Possible error codes for NSError objects under the SCPErrorDomain domain.

"},"Errors.html#/c:@SCPErrorDomain":{"name":"SCPErrorDomain","abstract":"

The error domain for all errors originating from the Stripe Terminal SDK.

"},"Errors.html#/c:SCPErrors.h@T@SCPErrorKey":{"name":"SCPErrorKey","abstract":"

Use this enum to access userInfo keys for NSError objects under the"},"Errors.html#/c:@SCPErrorKeyMessage":{"name":"SCPErrorKeyMessage","abstract":"

An error message explaining what went wrong. You probably shouldn’t show this"},"Errors.html#/c:@SCPErrorKeyHttpStatusCode":{"name":"SCPErrorKeyHttpStatusCode","abstract":"

The HTTP status code of the response.

"},"Errors.html#/c:@SCPErrorKeyReaderMessage":{"name":"SCPErrorKeyReaderMessage","abstract":"

This error message comes from the reader. You probably shouldn’t show this"},"Errors.html#/c:@SCPErrorKeyDeviceBannedUntilDate":{"name":"SCPErrorKeyDeviceBannedUntilDate","abstract":"

If an Apple Built-In reader fails to connect due to a device ban and the error"},"Errors.html#/c:@SCPErrorKeyStripeAPIRequestId":{"name":"SCPErrorKeyStripeAPIRequestId","abstract":"

If a Stripe API request failed, the failed request’s id will be returned in the"},"Errors.html#/c:@SCPErrorKeyStripeAPIDeclineCode":{"name":"SCPErrorKeyStripeAPIDeclineCode","abstract":"

The decline code returned by the Stripe API.

"},"Errors.html#/c:@SCPErrorKeyStripeAPIErrorCode":{"name":"SCPErrorKeyStripeAPIErrorCode","abstract":"

The error code returned by the Stripe API.

"},"Errors.html#/c:@SCPErrorKeyStripeAPIErrorParameter":{"name":"SCPErrorKeyStripeAPIErrorParameter","abstract":"

The parameter the error relates to if the error is parameter-specific.

"},"Errors.html#/c:@SCPErrorKeyStripeAPIErrorType":{"name":"SCPErrorKeyStripeAPIErrorType","abstract":"

The error type returned by the Stripe API.

"},"Errors.html#/c:@SCPErrorKeyStripeAPIPaymentIntent":{"name":"SCPErrorKeyStripeAPIPaymentIntent","abstract":"

If a Stripe API request failed and the error has an associated PaymentIntent,"},"Errors.html#/c:@SCPErrorKeyStripeAPIDocUrl":{"name":"SCPErrorKeyStripeAPIDocUrl","abstract":"

The documentation URL for the error returned by the Stripe API.

"},"Errors.html#/c:@SCPErrorKeyStripeAPIFailureReason":{"name":"SCPErrorKeyStripeAPIFailureReason","abstract":"

If a refund fails, the reason for refund failure if known. Possible values"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(py)setupIntent":{"name":"setupIntent","abstract":"

The updated SetupIntent after confirmSetupIntent failed.

","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(py)requestError":{"name":"requestError","abstract":"

If confirmSetupIntent failed because the underlying network request errored,","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(py)declineCode":{"name":"declineCode","abstract":"

If confirmSetupIntent failed because the payment method was declined, this","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPSetupAttemptCardPresentDetails.html#/c:objc(cs)SCPSetupAttemptCardPresentDetails(py)generatedCard":{"name":"generatedCard","abstract":"

The ID of the Card PaymentMethod which was generated by this SetupAttempt.

","parent_name":"SCPSetupAttemptCardPresentDetails"},"Classes/SCPSetupAttemptCardPresentDetails.html#/c:objc(cs)SCPSetupAttemptCardPresentDetails(py)emvAuthData":{"name":"emvAuthData","abstract":"

The Authorization Response Cryptogram (ARPC) from the issuer.

","parent_name":"SCPSetupAttemptCardPresentDetails"},"Classes/SCPSetupAttemptCardPresentDetails.html#/c:objc(cs)SCPSetupAttemptCardPresentDetails(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPSetupAttemptCardPresentDetails"},"Classes/SCPSetupAttemptCardPresentDetails.html#/c:objc(cs)SCPSetupAttemptCardPresentDetails(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPSetupAttemptCardPresentDetails"},"Classes/SCPSetupAttemptPaymentMethodDetails.html#/c:objc(cs)SCPSetupAttemptPaymentMethodDetails(py)type":{"name":"type","abstract":"

The type of the PaymentMethod. The corresponding, similarly named property","parent_name":"SCPSetupAttemptPaymentMethodDetails"},"Classes/SCPSetupAttemptPaymentMethodDetails.html#/c:objc(cs)SCPSetupAttemptPaymentMethodDetails(py)cardPresent":{"name":"cardPresent","abstract":"

If this is a card present payment method (ie self.type == SCPPaymentMethodTypeCardPresent),","parent_name":"SCPSetupAttemptPaymentMethodDetails"},"Classes/SCPSetupAttemptPaymentMethodDetails.html#/c:objc(cs)SCPSetupAttemptPaymentMethodDetails(py)interacPresent":{"name":"interacPresent","abstract":"

If this is a card present payment method (ie self.type == SCPPaymentMethodTypeInteracPresent),","parent_name":"SCPSetupAttemptPaymentMethodDetails"},"Classes/SCPSetupAttemptPaymentMethodDetails.html#/c:objc(cs)SCPSetupAttemptPaymentMethodDetails(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPSetupAttemptPaymentMethodDetails"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)application":{"name":"application","abstract":"

The ID of the Connect application that created the SetupIntent.

","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)created":{"name":"created","abstract":"

Time at which the object was created.

","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)customer":{"name":"customer","abstract":"

ID of the Customer this SetupIntent belongs to, if one exists.

","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)onBehalfOf":{"name":"onBehalfOf","abstract":"

(Connect) The account (if any) for which the setup is intended.

","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)paymentMethod":{"name":"paymentMethod","abstract":"

ID of the payment method used with this SetupAttempt.

","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)paymentMethodDetails":{"name":"paymentMethodDetails","abstract":"

Details about the payment method at the time of SetupIntent confirmation.

","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)setupIntent":{"name":"setupIntent","abstract":"

ID of the SetupIntent that this attempt belongs to.

","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)status":{"name":"status","abstract":"

The status of this SetupAttempt. One of: requires_confirmation,","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)stripeId":{"name":"stripeId","abstract":"

The unique identifier for the SetupAttempt.

","parent_name":"SCPSetupAttempt"},"Enums/SCPSetupIntentUsage.html#/c:@E@SCPSetupIntentUsage@SCPSetupIntentUsageOffSession":{"name":"SCPSetupIntentUsageOffSession","abstract":"

An off-session usage indicates to Stripe that future payments will take place","parent_name":"SCPSetupIntentUsage"},"Enums/SCPSetupIntentUsage.html#/c:@E@SCPSetupIntentUsage@SCPSetupIntentUsageOnSession":{"name":"SCPSetupIntentUsageOnSession","abstract":"

An on-session usage indicates to Stripe that future payments will take place","parent_name":"SCPSetupIntentUsage"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusRequiresPaymentMethod":{"name":"SCPSetupIntentStatusRequiresPaymentMethod","abstract":"

Next step: collect a payment method by calling collectPaymentMethod.

","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusRequiresConfirmation":{"name":"SCPSetupIntentStatusRequiresConfirmation","abstract":"

Next step: confirm the SetupIntent by calling confirmSetupIntent.

","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusRequiresAction":{"name":"SCPSetupIntentStatusRequiresAction","abstract":"

If the setup requires additional actions, such as authenticating with","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusProcessing":{"name":"SCPSetupIntentStatusProcessing","abstract":"

Once required actions are handled, the SetupIntent moves to processing.","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusCanceled":{"name":"SCPSetupIntentStatusCanceled","abstract":"

The SetupIntent was canceled.

","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusSucceeded":{"name":"SCPSetupIntentStatusSucceeded","abstract":"

The SetupIntent succeeded.

","parent_name":"SCPSetupIntentStatus"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)customer":{"name":"customer","abstract":"

ID of the customer this SetupIntent belongs to, if one exists.

","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)stripeDescription":{"name":"stripeDescription","abstract":"

An arbitrary string attached to the object. Often useful for displaying to users.

","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)metadata":{"name":"metadata","abstract":"

Set of key-value pairs that you can attach to an object. This can be useful for","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)usage":{"name":"usage","abstract":"

Indicates how the payment method is intended to be used in the future. If not","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)onBehalfOf":{"name":"onBehalfOf","abstract":"

Connect Only:** The Stripe account ID for which this SetupIntent is created.

","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(im)initWithCustomer:":{"name":"-initWithCustomer:","abstract":"

Initializes SCPSetupIntentParameters with the given customer ID.

","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(im)init":{"name":"-init","abstract":"

Use initWithCustomer:

","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(cm)new":{"name":"+new","abstract":"

Use initWithCustomer:

","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)description":{"name":"description","abstract":"

Use stripeDescription for the string attached to the object.

","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)stripeId":{"name":"stripeId","abstract":"

The unique identifier for the intent.

","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)created":{"name":"created","abstract":"

When the intent was created.

","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)customer":{"name":"customer","abstract":"

The identifier of a customer object to which the SetupIntent is attached, if applicable.

","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)metadata":{"name":"metadata","abstract":"

Set of key-value pairs attached to the object.

","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)usage":{"name":"usage","abstract":"

An SCPSetupIntentUsage value describing how the SetupIntent will be used.","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)status":{"name":"status","abstract":"

The status of the intent.

","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)latestAttempt":{"name":"latestAttempt","abstract":"

The most recent SetupAttempt for this SetupIntent

","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class. You should only use SetupIntents","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class. You should only use SetupIntents","parent_name":"SCPSetupIntent"},"Classes/SCPReadReusableCardParameters.html#/c:objc(cs)SCPReadReusableCardParameters(py)customer":{"name":"customer","abstract":"

Optional parameter: attach the new PaymentMethod to Customer with this id

","parent_name":"SCPReadReusableCardParameters"},"Classes/SCPReadReusableCardParameters.html#/c:objc(cs)SCPReadReusableCardParameters(py)metadata":{"name":"metadata","abstract":"

Optional set of key-value pairs attached to the object. The default is nil.

","parent_name":"SCPReadReusableCardParameters"},"Classes/SCPReadReusableCardParameters.html":{"name":"SCPReadReusableCardParameters","abstract":"

Parameters for reading a reusable card.

"},"Classes/SCPSetupIntent.html":{"name":"SCPSetupIntent","abstract":"

A SetupIntent guides you through the process of setting up and saving a"},"Classes/SCPSetupIntentParameters.html":{"name":"SCPSetupIntentParameters","abstract":"

Parameters for creating an SCPSetupIntent.

"},"Enums/SCPSetupIntentStatus.html":{"name":"SCPSetupIntentStatus","abstract":"

The possible statuses of the SetupIntent.

"},"Enums/SCPSetupIntentUsage.html":{"name":"SCPSetupIntentUsage","abstract":"

The SetupIntent usage options tell Stripe how the payment method is intended to be used in the future."},"Classes/SCPSetupAttempt.html":{"name":"SCPSetupAttempt","abstract":"

A SetupAttempt describes one attempted confirmation of a SetupIntent,"},"Classes/SCPSetupAttemptPaymentMethodDetails.html":{"name":"SCPSetupAttemptPaymentMethodDetails","abstract":"

Details about a PaymentMethod at a specific time. ex: at time of transaction"},"Classes/SCPSetupAttemptCardPresentDetails.html":{"name":"SCPSetupAttemptCardPresentDetails","abstract":"

An object representing details from a transaction using a card_present"},"Classes/SCPConfirmSetupIntentError.html":{"name":"SCPConfirmSetupIntentError","abstract":"

An error from -[SCPTerminal confirmSetupIntent:completion:]

"},"Enums/SCPRefundStatus.html#/c:@E@SCPRefundStatus@SCPRefundStatusSucceeded":{"name":"SCPRefundStatusSucceeded","abstract":"

The refund succeeded.

","parent_name":"SCPRefundStatus"},"Enums/SCPRefundStatus.html#/c:@E@SCPRefundStatus@SCPRefundStatusPending":{"name":"SCPRefundStatusPending","abstract":"

The refund is pending.

","parent_name":"SCPRefundStatus"},"Enums/SCPRefundStatus.html#/c:@E@SCPRefundStatus@SCPRefundStatusFailed":{"name":"SCPRefundStatusFailed","abstract":"

The refund failed.

","parent_name":"SCPRefundStatus"},"Enums/SCPRefundStatus.html#/c:@E@SCPRefundStatus@SCPRefundStatusUnknown":{"name":"SCPRefundStatusUnknown","abstract":"

Unknown refund state.

","parent_name":"SCPRefundStatus"},"Classes/SCPProcessRefundError.html#/c:objc(cs)SCPProcessRefundError(py)refund":{"name":"refund","abstract":"

If processRefund failed after the refund was created, this property contains","parent_name":"SCPProcessRefundError"},"Classes/SCPProcessRefundError.html#/c:objc(cs)SCPProcessRefundError(py)requestError":{"name":"requestError","abstract":"

If processRefund failed because the underlying network request errored,","parent_name":"SCPProcessRefundError"},"Classes/SCPProcessRefundError.html#/c:objc(cs)SCPProcessRefundError(cm)init":{"name":"+init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPProcessRefundError"},"Classes/SCPProcessRefundError.html#/c:objc(cs)SCPProcessRefundError(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPProcessRefundError"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)chargeId":{"name":"chargeId","abstract":"

The ID of the charge to be refunded.

","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)amount":{"name":"amount","abstract":"

The amount of the refund, provided in the currency’s smallest unit.

","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)currency":{"name":"currency","abstract":"

Three-letter ISO currency code. Must be a supported currency.

","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)metadata":{"name":"metadata","abstract":"

Set of key-value pairs that you can attach to an object. This can be useful for","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)reverseTransfer":{"name":"reverseTransfer","abstract":"

Connect only: Nullable boolean indicating whether the transfer should be","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)refundApplicationFee":{"name":"refundApplicationFee","abstract":"

Connect only: Nullable boolean indicating whether the application fee should be","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(im)initWithChargeId:amount:currency:":{"name":"-initWithChargeId:amount:currency:","abstract":"

Initializes SCPRefundParameters with the given charge, amount, and currency.

","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(im)init":{"name":"-init","abstract":"

Use initWithChargeId:amount:currency:

","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(cm)new":{"name":"+new","abstract":"

Use initWithChargeId:amount:currency:

","parent_name":"SCPRefundParameters"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)stripeId":{"name":"stripeId","abstract":"

The unique identifier for the refund.

","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)amount":{"name":"amount","abstract":"

The amount that was refunded.

","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)charge":{"name":"charge","abstract":"

The ID of the charge that was refunded

","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)created":{"name":"created","abstract":"

When the refund object was created.

","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)currency":{"name":"currency","abstract":"

The currency of the amount refunded.

","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)metadata":{"name":"metadata","abstract":"

Metadata associated with the refund.

","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)reason":{"name":"reason","abstract":"

Reason for the refund, either user-provided (duplicate, fraudulent, or","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)status":{"name":"status","abstract":"

The status of the refund.

","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)paymentMethodDetails":{"name":"paymentMethodDetails","abstract":"

The payment method details associated with the refund.

","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)failureReason":{"name":"failureReason","abstract":"

If the refund failed, the reason for refund failure if known.

","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPRefund"},"Classes/SCPRefund.html":{"name":"SCPRefund","abstract":"

An object representing a Stripe refund.

"},"Classes/SCPRefundParameters.html":{"name":"SCPRefundParameters","abstract":"

Parameters for creating an SCPRefund.

"},"Classes/SCPProcessRefundError.html":{"name":"SCPProcessRefundError","abstract":"

An error from -[SCPTerminal processRefund:completion:].

"},"Enums/SCPRefundStatus.html":{"name":"SCPRefundStatus","abstract":"

The possible statuses for a refund.

"},"Enums/SCPIncrementalAuthorizationStatus.html#/c:@E@SCPIncrementalAuthorizationStatus@SCPIncrementalAuthorizationStatusUnknown":{"name":"SCPIncrementalAuthorizationStatusUnknown","abstract":"

It is undetermined whether or not this PaymentIntent will be eligible for incremental authorizations.","parent_name":"SCPIncrementalAuthorizationStatus"},"Enums/SCPIncrementalAuthorizationStatus.html#/c:@E@SCPIncrementalAuthorizationStatus@SCPIncrementalAuthorizationStatusNotSupported":{"name":"SCPIncrementalAuthorizationStatusNotSupported","abstract":"

This PaymentIntent is not eligible for incremental authorizations, or it was not requested.

","parent_name":"SCPIncrementalAuthorizationStatus"},"Enums/SCPIncrementalAuthorizationStatus.html#/c:@E@SCPIncrementalAuthorizationStatus@SCPIncrementalAuthorizationStatusSupported":{"name":"SCPIncrementalAuthorizationStatusSupported","abstract":"

This PaymentIntent is eligible for incremental authorizations.

","parent_name":"SCPIncrementalAuthorizationStatus"},"Classes/SCPNetworks.html#/c:objc(cs)SCPNetworks(py)available":{"name":"available","abstract":"

All available networks for the card.

","parent_name":"SCPNetworks"},"Classes/SCPNetworks.html#/c:objc(cs)SCPNetworks(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPNetworks"},"Classes/SCPNetworks.html#/c:objc(cs)SCPNetworks(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPNetworks"},"Classes/SCPTippingConfiguration.html#/c:objc(cs)SCPTippingConfiguration(py)eligibleAmount":{"name":"eligibleAmount","abstract":"

The amount of the payment total eligible for tips.

","parent_name":"SCPTippingConfiguration"},"Classes/SCPTippingConfiguration.html#/c:objc(cs)SCPTippingConfiguration(im)initWithEligibleAmount:":{"name":"-initWithEligibleAmount:","abstract":"

Initialize a TippingConfiguration instance.

","parent_name":"SCPTippingConfiguration"},"Classes/SCPTippingConfiguration.html#/c:objc(cs)SCPTippingConfiguration(im)init":{"name":"-init","abstract":"

Use initWithEligibleAmount:

","parent_name":"SCPTippingConfiguration"},"Classes/SCPTippingConfiguration.html#/c:objc(cs)SCPTippingConfiguration(cm)new":{"name":"+new","abstract":"

Use initWithEligibleAmount:

","parent_name":"SCPTippingConfiguration"},"Enums/SCPCaptureMethod.html#/c:@E@SCPCaptureMethod@SCPCaptureMethodManual":{"name":"SCPCaptureMethodManual","abstract":"

Place a hold on the funds when the customer authorizes the payment, but don’t","parent_name":"SCPCaptureMethod"},"Enums/SCPCaptureMethod.html#/c:@E@SCPCaptureMethod@SCPCaptureMethodAutomatic":{"name":"SCPCaptureMethodAutomatic","abstract":"

Stripe automatically captures funds when the customer authorizes the payment.

","parent_name":"SCPCaptureMethod"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(py)skipTipping":{"name":"skipTipping","abstract":"

Bypass tipping selection if it would have otherwise been shown.

","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(py)tippingConfiguration":{"name":"tippingConfiguration","abstract":"

The tipping configuration for this payment collection.

","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(py)updatePaymentIntent":{"name":"updatePaymentIntent","abstract":"

Whether or not to update the PaymentIntent server side during collectPaymentMethod.

","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithSkipTipping:":{"name":"-initWithSkipTipping:","abstract":"

Initialize a CollectConfiguration

","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithUpdatePaymentIntent:":{"name":"-initWithUpdatePaymentIntent:","abstract":"

Initialize a CollectConfiguration

","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithTippingConfiguration:":{"name":"-initWithTippingConfiguration:","abstract":"

Initialize a CollectConfiguration.

","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithSkipTipping:updatePaymentIntent:":{"name":"-initWithSkipTipping:updatePaymentIntent:","abstract":"

Initialize a CollectConfiguration

","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithSkipTipping:tippingConfiguration:":{"name":"-initWithSkipTipping:tippingConfiguration:","abstract":"

Initialize a CollectConfiguration.

","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithUpdatePaymentIntent:tippingConfiguration:":{"name":"-initWithUpdatePaymentIntent:tippingConfiguration:","abstract":"

Initialize a CollectConfiguration.

","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithSkipTipping:updatePaymentIntent:tippingConfiguration:":{"name":"-initWithSkipTipping:updatePaymentIntent:tippingConfiguration:","abstract":"

Initialize a CollectConfiguration.

","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)init":{"name":"-init","abstract":"

Use initWithSkipTipping:updatePaymentIntent:tippingConfiguration: or helper initializers.

","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(cm)new":{"name":"+new","abstract":"

Use initWithSkipTipping:updatePaymentIntent:tippingConfiguration: or helper initializers.

","parent_name":"SCPCollectConfiguration"},"Classes/SCPPaymentMethodOptionsParameters.html#/c:objc(cs)SCPPaymentMethodOptionsParameters(py)cardPresentParameters":{"name":"cardPresentParameters","abstract":"

Card-present-specific configuration for this PaymentMethod.

","parent_name":"SCPPaymentMethodOptionsParameters"},"Classes/SCPPaymentMethodOptionsParameters.html#/c:objc(cs)SCPPaymentMethodOptionsParameters(im)initWithCardPresentParameters:":{"name":"-initWithCardPresentParameters:","abstract":"

Initialize a PaymentMethodOptionsParameters

","parent_name":"SCPPaymentMethodOptionsParameters"},"Classes/SCPPaymentMethodOptionsParameters.html#/c:objc(cs)SCPPaymentMethodOptionsParameters(im)init":{"name":"-init","abstract":"

Use initWithCardPresentParameters:(SCPCardPresentParameters)cardPresentParameters

","parent_name":"SCPPaymentMethodOptionsParameters"},"Enums/SCPPaymentMethodType.html#/c:@E@SCPPaymentMethodType@SCPPaymentMethodTypeCard":{"name":"SCPPaymentMethodTypeCard","abstract":"

A card payment method.

","parent_name":"SCPPaymentMethodType"},"Enums/SCPPaymentMethodType.html#/c:@E@SCPPaymentMethodType@SCPPaymentMethodTypeCardPresent":{"name":"SCPPaymentMethodTypeCardPresent","abstract":"

A card present payment method.

","parent_name":"SCPPaymentMethodType"},"Enums/SCPPaymentMethodType.html#/c:@E@SCPPaymentMethodType@SCPPaymentMethodTypeInteracPresent":{"name":"SCPPaymentMethodTypeInteracPresent","abstract":"

An Interac Present payment method.

","parent_name":"SCPPaymentMethodType"},"Enums/SCPPaymentMethodType.html#/c:@E@SCPPaymentMethodType@SCPPaymentMethodTypeUnknown":{"name":"SCPPaymentMethodTypeUnknown","abstract":"

An unknown type.

","parent_name":"SCPPaymentMethodType"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)stripeId":{"name":"stripeId","abstract":"

The unique identifier for the PaymentMethod

","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)created":{"name":"created","abstract":"

Time at which the object was created. Measured in seconds since the Unix epoch.

","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)type":{"name":"type","abstract":"

The type of the PaymentMethod. The corresponding, similarly named property contains additional information specific to the PaymentMethod type.","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)card":{"name":"card","abstract":"

If this is a card PaymentMethod (ie self.type == SCPPaymentMethodTypeCard), this contains additional details.

","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)cardPresent":{"name":"cardPresent","abstract":"

If this is a card_present PaymentMethod (ie self.type == SCPPaymentMethodTypeCardPresent), this contains additional details.

","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)interacPresent":{"name":"interacPresent","abstract":"

If this is an Interac_present PaymentMethod (ie self.type == SCPPaymentMethodTypeInteracPresent), this contains additional details.

","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)customer":{"name":"customer","abstract":"

The Customer that this PaymentMethod is attached to, or nil.

","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)metadata":{"name":"metadata","abstract":"

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPPaymentMethod"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)brand":{"name":"brand","abstract":"

The issuer of the card.

","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)country":{"name":"country","abstract":"

Two-letter ISO code representing the country of the card.

","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)expMonth":{"name":"expMonth","abstract":"

Two-digit number representing the card’s expiration month.","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)expYear":{"name":"expYear","abstract":"

Four-digit number representing the card’s expiration year.","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)funding":{"name":"funding","abstract":"

Card funding type. Ex: credit, debit, etc.

","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)last4":{"name":"last4","abstract":"

The last four digits of the card.

","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)fingerprint":{"name":"fingerprint","abstract":"

Uniquely identifies this particular card number. You can use this attribute","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPCardDetails"},"Classes/SCPPaymentMethodDetails.html#/c:objc(cs)SCPPaymentMethodDetails(py)type":{"name":"type","abstract":"

The type of the PaymentMethod. The corresponding, similarly named property","parent_name":"SCPPaymentMethodDetails"},"Classes/SCPPaymentMethodDetails.html#/c:objc(cs)SCPPaymentMethodDetails(py)cardPresent":{"name":"cardPresent","abstract":"

If this is a card present payment method (ie self.type == SCPPaymentMethodTypeCardPresent),","parent_name":"SCPPaymentMethodDetails"},"Classes/SCPPaymentMethodDetails.html#/c:objc(cs)SCPPaymentMethodDetails(py)interacPresent":{"name":"interacPresent","abstract":"

If this is an Interac present payment method (ie self.type == SCPPaymentMethodTypeInteracPresent),","parent_name":"SCPPaymentMethodDetails"},"Classes/SCPPaymentMethodDetails.html#/c:objc(cs)SCPPaymentMethodDetails(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPPaymentMethodDetails"},"Enums/SCPChargeStatus.html#/c:@E@SCPChargeStatus@SCPChargeStatusSucceeded":{"name":"SCPChargeStatusSucceeded","abstract":"

The charge succeeded.

","parent_name":"SCPChargeStatus"},"Enums/SCPChargeStatus.html#/c:@E@SCPChargeStatus@SCPChargeStatusPending":{"name":"SCPChargeStatusPending","abstract":"

The charge succeeded.

","parent_name":"SCPChargeStatus"},"Enums/SCPChargeStatus.html#/c:@E@SCPChargeStatus@SCPChargeStatusFailed":{"name":"SCPChargeStatusFailed","abstract":"

The charge failed.

","parent_name":"SCPChargeStatus"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)amount":{"name":"amount","abstract":"

The amount of the charge.

","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)currency":{"name":"currency","abstract":"

The currency of the charge.

","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)status":{"name":"status","abstract":"

The status of the charge.

","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)paymentMethodDetails":{"name":"paymentMethodDetails","abstract":"

The payment method details associated with the charge.

","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)stripeDescription":{"name":"stripeDescription","abstract":"

A string describing the charge, displayed in the Stripe dashboard and in","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)metadata":{"name":"metadata","abstract":"

Metadata associated with the charge.

","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)stripeId":{"name":"stripeId","abstract":"

The unique identifier for the charge.

","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)statementDescriptorSuffix":{"name":"statementDescriptorSuffix","abstract":"

Extra dynamic information about a Charge. This will appear concatenated with the statementDescriptor on","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)calculatedStatementDescriptor":{"name":"calculatedStatementDescriptor","abstract":"

The full statement descriptor that is displayed on your customer’s credit card’s statement, after the","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPCharge"},"Enums/SCPCardFundingType.html#/c:@E@SCPCardFundingType@SCPCardFundingTypeDebit":{"name":"SCPCardFundingTypeDebit","abstract":"

Debit

","parent_name":"SCPCardFundingType"},"Enums/SCPCardFundingType.html#/c:@E@SCPCardFundingType@SCPCardFundingTypeCredit":{"name":"SCPCardFundingTypeCredit","abstract":"

Credit

","parent_name":"SCPCardFundingType"},"Enums/SCPCardFundingType.html#/c:@E@SCPCardFundingType@SCPCardFundingTypePrepaid":{"name":"SCPCardFundingTypePrepaid","abstract":"

Prepaid

","parent_name":"SCPCardFundingType"},"Enums/SCPCardFundingType.html#/c:@E@SCPCardFundingType@SCPCardFundingTypeOther":{"name":"SCPCardFundingTypeOther","abstract":"

An other or unknown type of funding source

","parent_name":"SCPCardFundingType"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandVisa":{"name":"SCPCardBrandVisa","abstract":"

Visa card

","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandAmex":{"name":"SCPCardBrandAmex","abstract":"

American Express card

","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandMasterCard":{"name":"SCPCardBrandMasterCard","abstract":"

MasterCard card

","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandDiscover":{"name":"SCPCardBrandDiscover","abstract":"

Discover card

","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandJCB":{"name":"SCPCardBrandJCB","abstract":"

JCB card

","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandDinersClub":{"name":"SCPCardBrandDinersClub","abstract":"

Diners Club card

","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandInterac":{"name":"SCPCardBrandInterac","abstract":"

Interac card

","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandUnionPay":{"name":"SCPCardBrandUnionPay","abstract":"

Union Pay card

","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandEftposAu":{"name":"SCPCardBrandEftposAu","abstract":"

Eftpos Australia card

","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandUnknown":{"name":"SCPCardBrandUnknown","abstract":"

An unknown card brand

","parent_name":"SCPCardBrand"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(py)paymentIntent":{"name":"paymentIntent","abstract":"

The updated PaymentIntent after processPayment failed.

","parent_name":"SCPProcessPaymentError"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(py)requestError":{"name":"requestError","abstract":"

If processPayment failed because the underlying network request errored,","parent_name":"SCPProcessPaymentError"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(py)declineCode":{"name":"declineCode","abstract":"

If processPayment failed because the payment method was declined, this","parent_name":"SCPProcessPaymentError"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPProcessPaymentError"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPProcessPaymentError"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)accountType":{"name":"accountType","abstract":"

The type of account being debited or credited

","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)applicationPreferredName":{"name":"applicationPreferredName","abstract":"

Also known as “Application Name”. Required on EMV receipts.

","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)dedicatedFileName":{"name":"dedicatedFileName","abstract":"

Also known as “AID”. Required on EMV receipts.

","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)authorizationCode":{"name":"authorizationCode","abstract":"

Identifier for this transaction

","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)authorizationResponseCode":{"name":"authorizationResponseCode","abstract":"

Authorization Response Code

","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)applicationCryptogram":{"name":"applicationCryptogram","abstract":"

Application Cryptogram

","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)terminalVerificationResults":{"name":"terminalVerificationResults","abstract":"

TVR

","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)transactionStatusInformation":{"name":"transactionStatusInformation","abstract":"

TSI

","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPReceiptDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)last4":{"name":"last4","abstract":"

The last 4 digits of the card.

","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)expMonth":{"name":"expMonth","abstract":"

The card’s expiration month. 1-indexed (i.e. 1 == January)

","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)expYear":{"name":"expYear","abstract":"

The card’s expiration year.

","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)cardholderName":{"name":"cardholderName","abstract":"

The cardholder name as read from the card, in ISO 7813 format. May include","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)funding":{"name":"funding","abstract":"

The card’s funding type.

","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)brand":{"name":"brand","abstract":"

The issuing brand of the card.

","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)fingerprint":{"name":"fingerprint","abstract":"

A string uniquely identifying this card number.

","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)generatedCard":{"name":"generatedCard","abstract":"

ID of a card PaymentMethod that may be attached to a Customer for future","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)receipt":{"name":"receipt","abstract":"

Receipt information for the card present transaction. Only present for EMV","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)emvAuthData":{"name":"emvAuthData","abstract":"

(Only applicable to EMV payments) The authorization data from the card","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)country":{"name":"country","abstract":"

Two-letter ISO code representing the country of the card. You could use this","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)preferredLocales":{"name":"preferredLocales","abstract":"

EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.

","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)networks":{"name":"networks","abstract":"

Contains information about card networks that can be used to process the payment.

","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)incrementalAuthorizationStatus":{"name":"incrementalAuthorizationStatus","abstract":"

Whether this payment method is eligible for incremental authorizations.

","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPCardPresentDetails"},"Enums/SCPCardPresentRouting.html#/c:@E@SCPCardPresentRouting@SCPCardPresentRoutingDomestic":{"name":"SCPCardPresentRoutingDomestic","abstract":"

Prioritize domestic debit network routing on payment method collection.

","parent_name":"SCPCardPresentRouting"},"Enums/SCPCardPresentRouting.html#/c:@E@SCPCardPresentRouting@SCPCardPresentRoutingInternational":{"name":"SCPCardPresentRoutingInternational","abstract":"

Prioritize international network routing on payment method collection.

","parent_name":"SCPCardPresentRouting"},"Enums/SCPCardPresentCaptureMethod.html#/c:@E@SCPCardPresentCaptureMethod@SCPCardPresentCaptureMethodManualPreferred":{"name":"SCPCardPresentCaptureMethodManualPreferred","abstract":"

Use manual_preferred if you prefer manual capture_method for the SCPPaymentIntent’s capture_method but support","parent_name":"SCPCardPresentCaptureMethod"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(py)requestExtendedAuthorization":{"name":"requestExtendedAuthorization","abstract":"

Using the extended authorizations feature, users in eligible categories can capture up to 31 days later, depending on the card brand.

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(py)requestIncrementalAuthorizationSupport":{"name":"requestIncrementalAuthorizationSupport","abstract":"

Allows you to increase the authorized amount on a confirmed PaymentIntent before you capture it. This means you can update the amount on a payment if the estimated price changes or goods and services are added. Before capture, each incremental authorization appears on your customer’s credit card statement as an additional pending charge.

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(py)captureMethod":{"name":"captureMethod","abstract":"

SCPCardPresentCaptureMethod as a nullable NSNumber.

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(py)requestedPriority":{"name":"requestedPriority","abstract":"

The requested routing priority as a nullable NSNumber.

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:":{"name":"-initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:","abstract":"

Initializes a CardPresentParameters

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:":{"name":"-initWithRequestExtendedAuthorization:","abstract":"

Initializes a CardPresentParameters

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestIncrementalAuthorizationSupport:":{"name":"-initWithRequestIncrementalAuthorizationSupport:","abstract":"

Initializes a CardPresentParameters

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:captureMethod:":{"name":"-initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:captureMethod:","abstract":"

Initializes a CardPresentParameters

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:captureMethod:":{"name":"-initWithRequestExtendedAuthorization:captureMethod:","abstract":"

Initializes a CardPresentParameters

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestIncrementalAuthorizationSupport:captureMethod:":{"name":"-initWithRequestIncrementalAuthorizationSupport:captureMethod:","abstract":"

Initializes a CardPresentParameters

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithCaptureMethod:":{"name":"-initWithCaptureMethod:","abstract":"

Initializes a CardPresentParameters

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:captureMethod:requestedPriority:":{"name":"-initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:captureMethod:requestedPriority:","abstract":"

Initializes a CardPresentParameters

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:requestedPriority:":{"name":"-initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:requestedPriority:","abstract":"

Initializes a CardPresentParameters

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithCaptureMethod:requestedPriority:":{"name":"-initWithCaptureMethod:requestedPriority:","abstract":"

Initializes a CardPresentParameters

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestedPriority:":{"name":"-initWithRequestedPriority:","abstract":"

Initializes a CardPresentParameters

","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)init":{"name":"-init","abstract":"

Use alternative initializer.

","parent_name":"SCPCardPresentParameters"},"Classes/SCPTip.html#/c:objc(cs)SCPTip(py)amount":{"name":"amount","abstract":"

Portion of the amount that corresponds to a tip

","parent_name":"SCPTip"},"Classes/SCPTip.html#/c:objc(cs)SCPTip(im)init":{"name":"-init","abstract":"

You cannot directly instantiate SCPTip.

","parent_name":"SCPTip"},"Classes/SCPTip.html#/c:objc(cs)SCPTip(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate SCPTip.

","parent_name":"SCPTip"},"Classes/SCPAmountDetails.html#/c:objc(cs)SCPAmountDetails(py)tip":{"name":"tip","abstract":"

Details about the tip

","parent_name":"SCPAmountDetails"},"Classes/SCPAmountDetails.html#/c:objc(cs)SCPAmountDetails(im)init":{"name":"-init","abstract":"

You cannot directly instantiate SCPAmountDetails.

","parent_name":"SCPAmountDetails"},"Classes/SCPAmountDetails.html#/c:objc(cs)SCPAmountDetails(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate SCPAmountDetails.

","parent_name":"SCPAmountDetails"},"Enums/SCPPaymentStatus.html#/c:@E@SCPPaymentStatus@SCPPaymentStatusNotReady":{"name":"SCPPaymentStatusNotReady","abstract":"

The SDK is not ready to start a payment. It may be busy with another","parent_name":"SCPPaymentStatus"},"Enums/SCPPaymentStatus.html#/c:@E@SCPPaymentStatus@SCPPaymentStatusReady":{"name":"SCPPaymentStatusReady","abstract":"

The SDK is ready to start a payment.

","parent_name":"SCPPaymentStatus"},"Enums/SCPPaymentStatus.html#/c:@E@SCPPaymentStatus@SCPPaymentStatusWaitingForInput":{"name":"SCPPaymentStatusWaitingForInput","abstract":"

The SDK is waiting for input from the customer (e.g., for a card to","parent_name":"SCPPaymentStatus"},"Enums/SCPPaymentStatus.html#/c:@E@SCPPaymentStatus@SCPPaymentStatusProcessing":{"name":"SCPPaymentStatusProcessing","abstract":"

The SDK is processing a payment.

","parent_name":"SCPPaymentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusRequiresPaymentMethod":{"name":"SCPPaymentIntentStatusRequiresPaymentMethod","abstract":"

Next step: collect a payment method by calling collectPaymentMethod.

","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusRequiresConfirmation":{"name":"SCPPaymentIntentStatusRequiresConfirmation","abstract":"

Next step: process the payment by calling processPayment.

","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusRequiresCapture":{"name":"SCPPaymentIntentStatusRequiresCapture","abstract":"

Next step: capture the PaymentIntent on your backend via the Stripe API.

","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusProcessing":{"name":"SCPPaymentIntentStatusProcessing","abstract":"

The PaymentIntent is in the middle of full EMV processing.

","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusCanceled":{"name":"SCPPaymentIntentStatusCanceled","abstract":"

The PaymentIntent was canceled.

","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusSucceeded":{"name":"SCPPaymentIntentStatusSucceeded","abstract":"

The PaymentIntent succeeded.

","parent_name":"SCPPaymentIntentStatus"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)amount":{"name":"amount","abstract":"

The amount of the payment, provided in the currency’s smallest unit.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)currency":{"name":"currency","abstract":"

Three-letter ISO currency code, in lowercase. Must be a supported currency.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)paymentMethodTypes":{"name":"paymentMethodTypes","abstract":"

The list of payment method types that this PaymentIntent is allowed to use.","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)captureMethod":{"name":"captureMethod","abstract":"

The capture method that this PaymentIntent should use. Defaults to SCPCaptureMethodManual.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)metadata":{"name":"metadata","abstract":"

Set of key-value pairs that you can attach to an object. This can be useful for","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)stripeDescription":{"name":"stripeDescription","abstract":"

An arbitrary string attached to the object. If you send a receipt email for","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)statementDescriptor":{"name":"statementDescriptor","abstract":"

A string to be displayed on your customer’s credit card statement. This may be","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)statementDescriptorSuffix":{"name":"statementDescriptorSuffix","abstract":"

A string to specify details about the transaction so your customer can understand it clearly on their statement.","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)receiptEmail":{"name":"receiptEmail","abstract":"

Email address that the receipt for the resulting payment will be sent to.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)customer":{"name":"customer","abstract":"

The ID of the Customer this PaymentIntent is for, if one exists.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)applicationFeeAmount":{"name":"applicationFeeAmount","abstract":"

The amount of the application fee (if any) that will be applied to the","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)transferGroup":{"name":"transferGroup","abstract":"

A string that identifies the resulting payment as part of a group.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)transferDataDestination":{"name":"transferDataDestination","abstract":"

The account (if any) the payment will be attributed to for tax reporting, and","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)onBehalfOf":{"name":"onBehalfOf","abstract":"

The Stripe account ID for which these funds are intended.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)setupFutureUsage":{"name":"setupFutureUsage","abstract":"

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)paymentMethodOptionsParameters":{"name":"paymentMethodOptionsParameters","abstract":"

Specific options used during the creation of the PaymentMethod.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)initWithAmount:currency:":{"name":"-initWithAmount:currency:","abstract":"

Initializes SCPPaymentIntentParameters with the given parameters.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)initWithAmount:currency:paymentMethodTypes:":{"name":"-initWithAmount:currency:paymentMethodTypes:","abstract":"

Initializes SCPPaymentIntentParameters with the given parameters.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)initWithAmount:currency:captureMethod:":{"name":"-initWithAmount:currency:captureMethod:","abstract":"

Initializes SCPPaymentIntentParameters with the given parameters.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)initWithAmount:currency:paymentMethodTypes:captureMethod:":{"name":"-initWithAmount:currency:paymentMethodTypes:captureMethod:","abstract":"

Initializes SCPPaymentIntentParameters with the given parameters.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)init":{"name":"-init","abstract":"

Use initWithAmount:currency:

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(cm)new":{"name":"+new","abstract":"

Use initWithAmount:currency:

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)description":{"name":"description","abstract":"

Use stripeDescription for the string attached to the object.

","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)stripeId":{"name":"stripeId","abstract":"

The unique identifier for the intent.

","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)created":{"name":"created","abstract":"

When the intent was created.

","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)status":{"name":"status","abstract":"

The status of the PaymentIntent.

","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)amount":{"name":"amount","abstract":"

The amount to be collected by this PaymentIntent, provided in the currency’s","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)captureMethod":{"name":"captureMethod","abstract":"

Controls when the funds will be captured from the customer’s account.

","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)currency":{"name":"currency","abstract":"

The currency of the payment.

","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)metadata":{"name":"metadata","abstract":"

Set of key-value pairs attached to the object.

","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)charges":{"name":"charges","abstract":"

Charges that were created by this PaymentIntent, if any.

","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)paymentMethod":{"name":"paymentMethod","abstract":"

The payment method to be used in this PaymentIntent. Only valid in the","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)amountDetails":{"name":"amountDetails","abstract":"

Details about items included in the amount after confirmation.

","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)amountTip":{"name":"amountTip","abstract":"

Indicates how much the user intends to tip in addition to the amount by at confirmation time.","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)statementDescriptor":{"name":"statementDescriptor","abstract":"

Extra information about a PaymentIntent. This will appear on your customer’s statement when","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)statementDescriptorSuffix":{"name":"statementDescriptorSuffix","abstract":"

Extra dynamic information about a PaymentIntent. This will appear concatenated with the statementDescriptor on","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(im)init":{"name":"-init","abstract":"

You cannot directly instantiate SCPPaymentIntent. You should only use","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate SCPPaymentIntent. You should only use","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html":{"name":"SCPPaymentIntent","abstract":"

A PaymentIntent tracks the process of collecting a payment from your customer."},"Classes/SCPPaymentIntentParameters.html":{"name":"SCPPaymentIntentParameters","abstract":"

Parameters for creating an SCPPaymentIntent. Pass an object of this type"},"Enums/SCPPaymentIntentStatus.html":{"name":"SCPPaymentIntentStatus","abstract":"

The possible statuses for a PaymentIntent.

"},"Enums/SCPPaymentStatus.html":{"name":"SCPPaymentStatus","abstract":"

The possible payment statuses for the SDK.

"},"Classes/SCPAmountDetails.html":{"name":"SCPAmountDetails","abstract":"

Contains details about items included in the [PaymentIntent] amount

"},"Classes/SCPTip.html":{"name":"SCPTip","abstract":"

Contains details about tips

"},"Classes/SCPCardPresentParameters.html":{"name":"SCPCardPresentParameters","abstract":"

Parameters that will be applied to the card present PaymentIntent.

"},"Enums/SCPCardPresentCaptureMethod.html":{"name":"SCPCardPresentCaptureMethod","abstract":"

Capture Method values that can be used as card-present payment method options.

"},"Enums/SCPCardPresentRouting.html":{"name":"SCPCardPresentRouting","abstract":"

Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.

"},"Classes/SCPCardPresentDetails.html":{"name":"SCPCardPresentDetails","abstract":"

An object representing details from a transaction using a card_present"},"Classes/SCPReceiptDetails.html":{"name":"SCPReceiptDetails","abstract":"

Receipt details associated with a card present transaction.

"},"Classes/SCPProcessPaymentError.html":{"name":"SCPProcessPaymentError","abstract":"

An error from -[SCPTerminal processPayment:completion:].

"},"Enums/SCPCardBrand.html":{"name":"SCPCardBrand","abstract":"

The various card brands for a card.

"},"Enums/SCPCardFundingType.html":{"name":"SCPCardFundingType","abstract":"

The various funding sources for a card.

"},"Classes/SCPCharge.html":{"name":"SCPCharge","abstract":"

An object representing a Stripe charge.

"},"Enums/SCPChargeStatus.html":{"name":"SCPChargeStatus","abstract":"

The possible statuses for a charge

"},"Classes/SCPPaymentMethodDetails.html":{"name":"SCPPaymentMethodDetails","abstract":"

Details about a PaymentMethod at a specific time. ex: at time of transaction"},"Classes/SCPCardDetails.html":{"name":"SCPCardDetails","abstract":"

Contains details about a user’s credit card.

"},"Classes/SCPPaymentMethod.html":{"name":"SCPPaymentMethod","abstract":"

PaymentMethod objects represent your customer’s payment instruments."},"Enums/SCPPaymentMethodType.html":{"name":"SCPPaymentMethodType","abstract":"

The type of the PaymentMethod.

"},"Classes/SCPPaymentMethodOptionsParameters.html":{"name":"SCPPaymentMethodOptionsParameters","abstract":"

The PaymentMethodOptionsParameters contains options for PaymentMethod creation.

"},"Classes/SCPCollectConfiguration.html":{"name":"SCPCollectConfiguration","abstract":"

The CollectConfiguration contains configuration information relevant to collecting a payment"},"Enums/SCPCaptureMethod.html":{"name":"SCPCaptureMethod","abstract":"

@abstract Controls when the funds will be captured from the customer’s account.

"},"Classes/SCPTippingConfiguration.html":{"name":"SCPTippingConfiguration","abstract":"

The TippingConfiguration contains configuration information relevant to collecting tips.

"},"Classes/SCPNetworks.html":{"name":"SCPNetworks","abstract":"

Contains information about card networks that can be used to process the payment.

"},"Enums/SCPIncrementalAuthorizationStatus.html":{"name":"SCPIncrementalAuthorizationStatus","abstract":"

Represents the ability for a PaymentIntent to be incrementally authorized.

"},"Enums/SCPUpdateComponent.html#/c:@E@SCPUpdateComponent@SCPUpdateComponentIncremental":{"name":"SCPUpdateComponentIncremental","abstract":"

If set, the update contains incremental changes to the reader. If this is","parent_name":"SCPUpdateComponent"},"Enums/SCPUpdateComponent.html#/c:@E@SCPUpdateComponent@SCPUpdateComponentFirmware":{"name":"SCPUpdateComponentFirmware","abstract":"

If set, this update contains updated firmware for this reader. Firmware updates","parent_name":"SCPUpdateComponent"},"Enums/SCPUpdateComponent.html#/c:@E@SCPUpdateComponent@SCPUpdateComponentConfig":{"name":"SCPUpdateComponentConfig","abstract":"

If set, this update contains a new configuration for this reader. These may","parent_name":"SCPUpdateComponent"},"Enums/SCPUpdateComponent.html#/c:@E@SCPUpdateComponent@SCPUpdateComponentKeys":{"name":"SCPUpdateComponentKeys","abstract":"

If set, this update contains updated encryption keys for the reader.","parent_name":"SCPUpdateComponent"},"Enums/SCPUpdateTimeEstimate.html#/c:@E@SCPUpdateTimeEstimate@SCPUpdateTimeEstimateLessThan1Minute":{"name":"SCPUpdateTimeEstimateLessThan1Minute","abstract":"

The update should take less than 1 minute to complete.

","parent_name":"SCPUpdateTimeEstimate"},"Enums/SCPUpdateTimeEstimate.html#/c:@E@SCPUpdateTimeEstimate@SCPUpdateTimeEstimate1To2Minutes":{"name":"SCPUpdateTimeEstimate1To2Minutes","abstract":"

The update should take 1-2 minutes to complete.

","parent_name":"SCPUpdateTimeEstimate"},"Enums/SCPUpdateTimeEstimate.html#/c:@E@SCPUpdateTimeEstimate@SCPUpdateTimeEstimate2To5Minutes":{"name":"SCPUpdateTimeEstimate2To5Minutes","abstract":"

The update should take 2-5 minutes to complete.

","parent_name":"SCPUpdateTimeEstimate"},"Enums/SCPUpdateTimeEstimate.html#/c:@E@SCPUpdateTimeEstimate@SCPUpdateTimeEstimate5To15Minutes":{"name":"SCPUpdateTimeEstimate5To15Minutes","abstract":"

The update should take 5-15 minutes to complete.

","parent_name":"SCPUpdateTimeEstimate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(py)estimatedUpdateTime":{"name":"estimatedUpdateTime","abstract":"

The estimated amount of time for the update.

","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(py)deviceSoftwareVersion":{"name":"deviceSoftwareVersion","abstract":"

The target version for the update.

","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(py)components":{"name":"components","abstract":"

The components that will be installed in this update.

","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(py)requiredAt":{"name":"requiredAt","abstract":"

The date at which this update will be required to be installed. If this date","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(cm)stringFromUpdateTimeEstimate:":{"name":"+stringFromUpdateTimeEstimate:","abstract":"

Returns an unlocalized string for the given update time estimate.

","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html":{"name":"SCPReaderSoftwareUpdate","abstract":"

An object representing a reader update.

"},"Enums/SCPUpdateTimeEstimate.html":{"name":"SCPUpdateTimeEstimate","abstract":"

The estimated amount of time for an update. Note that these times are estimates;"},"Enums/SCPUpdateComponent.html":{"name":"SCPUpdateComponent","abstract":"

A bitmask identifying what exact updates are contained within this update.

"},"Classes/SCPCartLineItem.html#/c:objc(cs)SCPCartLineItem(py)quantity":{"name":"quantity","abstract":"

The quantity of the line item being purchased.

","parent_name":"SCPCartLineItem"},"Classes/SCPCartLineItem.html#/c:objc(cs)SCPCartLineItem(py)displayName":{"name":"displayName","abstract":"

The description or name of the item.

","parent_name":"SCPCartLineItem"},"Classes/SCPCartLineItem.html#/c:objc(cs)SCPCartLineItem(py)amount":{"name":"amount","abstract":"

The price of the item, provided in the cart’s currency’s smallest unit.

","parent_name":"SCPCartLineItem"},"Classes/SCPCartLineItem.html#/c:objc(cs)SCPCartLineItem(im)initWithDisplayName:quantity:amount:":{"name":"-initWithDisplayName:quantity:amount:","abstract":"

The values set here will be shown on the screen as-is. Make sure you’re","parent_name":"SCPCartLineItem"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(py)lineItems":{"name":"lineItems","abstract":"

You can add or remove line items from this array individually or reassign the array entirely.","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(py)tax":{"name":"tax","abstract":"

The displayed tax amount, provided in the currency’s smallest unit.

","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(py)total":{"name":"total","abstract":"

The cart’s total balance, provided in the currency’s smallest unit.

","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(py)currency":{"name":"currency","abstract":"

The currency of the cart.

","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(im)initWithCurrency:tax:total:":{"name":"-initWithCurrency:tax:total:","abstract":"

Initializes an SCPCart with tax and total, in cents, as well as the currency.","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(im)init":{"name":"-init","abstract":"

Use initWithTax:

","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(cm)new":{"name":"+new","abstract":"

Use initWithTax:

","parent_name":"SCPCart"},"Enums/SCPBatteryStatus.html#/c:@E@SCPBatteryStatus@SCPBatteryStatusUnknown":{"name":"SCPBatteryStatusUnknown","abstract":"

Battery state is not yet known or not available for the connected reader.

","parent_name":"SCPBatteryStatus"},"Enums/SCPBatteryStatus.html#/c:@E@SCPBatteryStatus@SCPBatteryStatusCritical":{"name":"SCPBatteryStatusCritical","abstract":"

The device’s battery is less than or equal to 5%.

","parent_name":"SCPBatteryStatus"},"Enums/SCPBatteryStatus.html#/c:@E@SCPBatteryStatus@SCPBatteryStatusLow":{"name":"SCPBatteryStatusLow","abstract":"

The device’s battery is between 5% and 20%.

","parent_name":"SCPBatteryStatus"},"Enums/SCPBatteryStatus.html#/c:@E@SCPBatteryStatus@SCPBatteryStatusNominal":{"name":"SCPBatteryStatusNominal","abstract":"

The device’s battery is greater than 20%.

","parent_name":"SCPBatteryStatus"},"Enums/SCPReaderNetworkStatus.html#/c:@E@SCPReaderNetworkStatus@SCPReaderNetworkStatusOffline":{"name":"SCPReaderNetworkStatusOffline","abstract":"

The reader is offline. Note that Chipper 2x and WisePad 3 will always report","parent_name":"SCPReaderNetworkStatus"},"Enums/SCPReaderNetworkStatus.html#/c:@E@SCPReaderNetworkStatus@SCPReaderNetworkStatusOnline":{"name":"SCPReaderNetworkStatusOnline","abstract":"

The reader is online.

","parent_name":"SCPReaderNetworkStatus"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageRetryCard":{"name":"SCPReaderDisplayMessageRetryCard","abstract":"

Retry the presented card.

","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageInsertCard":{"name":"SCPReaderDisplayMessageInsertCard","abstract":"

Insert the presented card.

","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageInsertOrSwipeCard":{"name":"SCPReaderDisplayMessageInsertOrSwipeCard","abstract":"

Insert or swipe the presented card.

","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageSwipeCard":{"name":"SCPReaderDisplayMessageSwipeCard","abstract":"

Swipe the presented card.

","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageRemoveCard":{"name":"SCPReaderDisplayMessageRemoveCard","abstract":"

Remove the presented card.

","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageMultipleContactlessCardsDetected":{"name":"SCPReaderDisplayMessageMultipleContactlessCardsDetected","abstract":"

The reader detected multiple contactless cards. Make sure only one","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageTryAnotherReadMethod":{"name":"SCPReaderDisplayMessageTryAnotherReadMethod","abstract":"

The card could not be read. Try another read method on the same card, or","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageTryAnotherCard":{"name":"SCPReaderDisplayMessageTryAnotherCard","abstract":"

The card is invalid. Try another card.

","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderInputOptions.html#/c:@E@SCPReaderInputOptions@SCPReaderInputOptionNone":{"name":"SCPReaderInputOptionNone","abstract":"

No input options are available on the reader.

","parent_name":"SCPReaderInputOptions"},"Enums/SCPReaderInputOptions.html#/c:@E@SCPReaderInputOptions@SCPReaderInputOptionSwipeCard":{"name":"SCPReaderInputOptionSwipeCard","abstract":"

Swipe a magstripe card.

","parent_name":"SCPReaderInputOptions"},"Enums/SCPReaderInputOptions.html#/c:@E@SCPReaderInputOptions@SCPReaderInputOptionInsertCard":{"name":"SCPReaderInputOptionInsertCard","abstract":"

Insert a chip card.

","parent_name":"SCPReaderInputOptions"},"Enums/SCPReaderInputOptions.html#/c:@E@SCPReaderInputOptions@SCPReaderInputOptionTapCard":{"name":"SCPReaderInputOptionTapCard","abstract":"

Tap a contactless card.

","parent_name":"SCPReaderInputOptions"},"Enums/SCPReaderEvent.html#/c:@E@SCPReaderEvent@SCPReaderEventCardInserted":{"name":"SCPReaderEventCardInserted","abstract":"

A card was inserted.

","parent_name":"SCPReaderEvent"},"Enums/SCPReaderEvent.html#/c:@E@SCPReaderEvent@SCPReaderEventCardRemoved":{"name":"SCPReaderEventCardRemoved","abstract":"

A card was removed.

","parent_name":"SCPReaderEvent"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didStartInstallingUpdate:cancelable:":{"name":"-localMobileReader:didStartInstallingUpdate:cancelable:","abstract":"

The reader has started installing a software update.

","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didReportReaderSoftwareUpdateProgress:":{"name":"-localMobileReader:didReportReaderSoftwareUpdateProgress:","abstract":"

The reader reported progress on a software update.

","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didFinishInstallingUpdate:error:":{"name":"-localMobileReader:didFinishInstallingUpdate:error:","abstract":"

The reader has finished installing an update.

","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didRequestReaderInput:":{"name":"-localMobileReader:didRequestReaderInput:","abstract":"

This method is called when the reader begins waiting for input.","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didRequestReaderDisplayMessage:":{"name":"-localMobileReader:didRequestReaderDisplayMessage:","abstract":"

This method is called to request that a prompt be displayed in your app.","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReaderDidAcceptTermsOfService:":{"name":"-localMobileReaderDidAcceptTermsOfService:","abstract":"

The reader is reporting that, as part of preparing to accept payments,","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didReportAvailableUpdate:":{"name":"-reader:didReportAvailableUpdate:","abstract":"

The SDK is reporting that an update is available for the reader.","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didStartInstallingUpdate:cancelable:":{"name":"-reader:didStartInstallingUpdate:cancelable:","abstract":"

The SDK is reporting that the reader has started installing a software update.

","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didReportReaderSoftwareUpdateProgress:":{"name":"-reader:didReportReaderSoftwareUpdateProgress:","abstract":"

The reader reported progress on a software update.

","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didFinishInstallingUpdate:error:":{"name":"-reader:didFinishInstallingUpdate:error:","abstract":"

The reader is reporting that an installation has finished. If the install was","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didRequestReaderInput:":{"name":"-reader:didRequestReaderInput:","abstract":"

This method is called when the reader begins waiting for input. Your app","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didRequestReaderDisplayMessage:":{"name":"-reader:didRequestReaderDisplayMessage:","abstract":"

This method is called to request that a prompt be displayed in your app.","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didReportReaderEvent:info:":{"name":"-reader:didReportReaderEvent:info:","abstract":"

The SDK reported an event from the reader (e.g. a card was inserted).

","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didReportBatteryLevel:status:isCharging:":{"name":"-reader:didReportBatteryLevel:status:isCharging:","abstract":"

The SDK reported the reader’s battery level or charging state has changed.

","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)readerDidReportLowBatteryWarning:":{"name":"-readerDidReportLowBatteryWarning:","abstract":"

This method is called when the SDK’s currently connected reader has a low battery.

","parent_name":"SCPBluetoothReaderDelegate"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeChipper2X":{"name":"SCPDeviceTypeChipper2X","abstract":"

The BBPOS Chipper 2X BT mobile reader.

","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeVerifoneP400":{"name":"SCPDeviceTypeVerifoneP400","abstract":"

The Verifone P400 countertop reader.

","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeWisePad3":{"name":"SCPDeviceTypeWisePad3","abstract":"

The BBPOS WisePad 3 mobile reader.

","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeStripeM2":{"name":"SCPDeviceTypeStripeM2","abstract":"

The Stripe Reader M2 mobile reader.

","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeWisePosE":{"name":"SCPDeviceTypeWisePosE","abstract":"

The BBPOS WisePOS E countertop reader.

","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeWisePosEDevKit":{"name":"SCPDeviceTypeWisePosEDevKit","abstract":"

The BBPOS WisePOS E DevKit countertop reader.

","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeStripeS700":{"name":"SCPDeviceTypeStripeS700","abstract":"

Stripe Reader S700.

","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeStripeS700DevKit":{"name":"SCPDeviceTypeStripeS700DevKit","abstract":"

Stripe Reader S700 DevKit.

","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeAppleBuiltIn":{"name":"SCPDeviceTypeAppleBuiltIn","abstract":"

Apple Built-In reader.

","parent_name":"SCPDeviceType"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)deviceType":{"name":"deviceType","abstract":"

The reader’s device type.

","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)simulated":{"name":"simulated","abstract":"

True if this is a simulated reader.

","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)stripeId":{"name":"stripeId","abstract":"

The Stripe unique identifier for the reader.

","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)locationId":{"name":"locationId","abstract":"

The ID of the reader’s Location.

","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)locationStatus":{"name":"locationStatus","abstract":"

Used to tell whether the location field has been set.","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)location":{"name":"location","abstract":"

The details of the location this reader is registered to, if any.

","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)serialNumber":{"name":"serialNumber","abstract":"

The reader’s serial number.

","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)deviceSoftwareVersion":{"name":"deviceSoftwareVersion","abstract":"

The reader’s current device software version, or nil if this information is","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)availableUpdate":{"name":"availableUpdate","abstract":"

The available update for this reader, or nil if no update is available.","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)batteryLevel":{"name":"batteryLevel","abstract":"

The reader’s battery level, represented as a boxed float in the range [0, 1].","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)batteryStatus":{"name":"batteryStatus","abstract":"

The reader’s battery status. Usable as a general classification for the current","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)isCharging":{"name":"isCharging","abstract":"

The reader’s charging state, represented as a BOOL","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)ipAddress":{"name":"ipAddress","abstract":"

The IP address of the reader.

","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)status":{"name":"status","abstract":"

The networking status of the reader: either offline or online. Note that","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)label":{"name":"label","abstract":"

A custom label that may be given to a reader for easier identification.

","parent_name":"SCPReader"},"Classes/SCPReader.html":{"name":"SCPReader","abstract":"

Information about a card reader that has been discovered by or connected to"},"Enums/SCPDeviceType.html":{"name":"SCPDeviceType","abstract":"

The possible device types for a reader.

"},"Protocols/SCPBluetoothReaderDelegate.html":{"name":"SCPBluetoothReaderDelegate","abstract":"

Implement this protocol to handle a connected Bluetooth reader’s events throughout"},"Protocols/SCPLocalMobileReaderDelegate.html":{"name":"SCPLocalMobileReaderDelegate","abstract":"

Implement this protocol to handle a connected local mobile reader’s events throughout"},"Enums/SCPReaderEvent.html":{"name":"SCPReaderEvent","abstract":"

The possible events from a connected reader. Used by [SCPBluetoothReaderDelegate reader:didReportReaderEvent:info:].

"},"Enums/SCPReaderInputOptions.html":{"name":"SCPReaderInputOptions","abstract":"

This OptionSet represents all of the input methods available to your user when"},"Enums/SCPReaderDisplayMessage.html":{"name":"SCPReaderDisplayMessage","abstract":"

The display messages that a reader may request be displayed by your app. Used by [SCPBluetoothReaderDelegate reader:didRequestReaderDisplayMessage:].

"},"Enums/SCPReaderNetworkStatus.html":{"name":"SCPReaderNetworkStatus","abstract":"

The possible networking statuses for a reader.

"},"Enums/SCPBatteryStatus.html":{"name":"SCPBatteryStatus","abstract":"

A categorization of a reader’s battery charge level.

"},"Classes/SCPCart.html":{"name":"SCPCart","abstract":"

An SCPCart object contains information about what line items are included in"},"Classes/SCPCartLineItem.html":{"name":"SCPCartLineItem","abstract":"

Represents a single line item in an SCPCart, displayed on the reader’s screen"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeVisa":{"name":"SCPSimulatedCardTypeVisa","abstract":"

Visa

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeVisaDebit":{"name":"SCPSimulatedCardTypeVisaDebit","abstract":"

Visa (debit)

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeMastercard":{"name":"SCPSimulatedCardTypeMastercard","abstract":"

Mastercard

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeMasterDebit":{"name":"SCPSimulatedCardTypeMasterDebit","abstract":"

Mastercard (debit)

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeMastercardPrepaid":{"name":"SCPSimulatedCardTypeMastercardPrepaid","abstract":"

Mastercard (prepaid)

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeAmex":{"name":"SCPSimulatedCardTypeAmex","abstract":"

American Express

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeAmex2":{"name":"SCPSimulatedCardTypeAmex2","abstract":"

American Express

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeDiscover":{"name":"SCPSimulatedCardTypeDiscover","abstract":"

Discover

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeDiscover2":{"name":"SCPSimulatedCardTypeDiscover2","abstract":"

Discover

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeDiners":{"name":"SCPSimulatedCardTypeDiners","abstract":"

Diners Club

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeDiners14Digit":{"name":"SCPSimulatedCardTypeDiners14Digit","abstract":"

Diners Club (14 digit card)

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeJcb":{"name":"SCPSimulatedCardTypeJcb","abstract":"

JCB

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeUnionPay":{"name":"SCPSimulatedCardTypeUnionPay","abstract":"

UnionPay

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeInterac":{"name":"SCPSimulatedCardTypeInterac","abstract":"

Interac

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeEftposAuDebit":{"name":"SCPSimulatedCardTypeEftposAuDebit","abstract":"

Eftpos Australia

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeEftposAuVisaDebit":{"name":"SCPSimulatedCardTypeEftposAuVisaDebit","abstract":"

Eftpos Australia/Visa

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeEftposAuDebitMastercard":{"name":"SCPSimulatedCardTypeEftposAuDebitMastercard","abstract":"

Eftpos Australia/Mastercard

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclined":{"name":"SCPSimulatedCardTypeChargeDeclined","abstract":"

Charge is declined with a card_declined code.

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedInsufficientFunds":{"name":"SCPSimulatedCardTypeChargeDeclinedInsufficientFunds","abstract":"

Charge is declined with a card_declined code. The decline_code","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedLostCard":{"name":"SCPSimulatedCardTypeChargeDeclinedLostCard","abstract":"

Charge is declined with a card_declined code. The decline_code","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedStolenCard":{"name":"SCPSimulatedCardTypeChargeDeclinedStolenCard","abstract":"

Charge is declined with a card_declined code. The decline_code","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedExpiredCard":{"name":"SCPSimulatedCardTypeChargeDeclinedExpiredCard","abstract":"

Charge is declined with an expired_card code.

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedProcessingError":{"name":"SCPSimulatedCardTypeChargeDeclinedProcessingError","abstract":"

Charge is declined with a processing_error code.

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeRefundFailed":{"name":"SCPSimulatedCardTypeRefundFailed","abstract":"

Refund is declined with a refund_fail error.

","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeOnlinePinCvm":{"name":"SCPSimulatedCardTypeOnlinePinCvm","abstract":"

Payment attaches Online Pin to the transaction.","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeOnlinePinScaRetry":{"name":"SCPSimulatedCardTypeOnlinePinScaRetry","abstract":"

This flow simulates an Online Pin scenario with SCA compliance.","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeOfflinePinCvm":{"name":"SCPSimulatedCardTypeOfflinePinCvm","abstract":"

Payment attaches Offline Pin to the transaction.","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeOfflinePinScaRetry":{"name":"SCPSimulatedCardTypeOfflinePinScaRetry","abstract":"

This flow simulates an Offline Pin scenario with SCA compliance.","parent_name":"SCPSimulatedCardType"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)initWithType:":{"name":"-initWithType:","abstract":"

Create a Simulated Card object with a given simulated card type.

","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)initWithTestCardNumber:":{"name":"-initWithTestCardNumber:","abstract":"

Create a Simulated Card object with a raw card number. This initializer is","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)init":{"name":"-init","abstract":"

You cannot instantiate this class without specifying a type or testcard number.

","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)isOnlinePin":{"name":"-isOnlinePin","abstract":"

Returns true if the card is online pin enabled.

","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)isOfflinePin":{"name":"-isOfflinePin","abstract":"

Returns true if the card is offline pin enabled.

","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(cm)new":{"name":"+new","abstract":"

You cannot instantiate this class without specifying a type or testcard number.

","parent_name":"SCPSimulatedCard"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateAvailable":{"name":"SCPSimulateReaderUpdateAvailable","abstract":"

Default value.

","parent_name":"SCPSimulateReaderUpdate"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateNone":{"name":"SCPSimulateReaderUpdateNone","abstract":"

No updates are available

","parent_name":"SCPSimulateReaderUpdate"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateRequired":{"name":"SCPSimulateReaderUpdateRequired","abstract":"

A required full reader software update exists. Use this to simulate the","parent_name":"SCPSimulateReaderUpdate"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateLowBattery":{"name":"SCPSimulateReaderUpdateLowBattery","abstract":"

A required update exists.

","parent_name":"SCPSimulateReaderUpdate"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateRandom":{"name":"SCPSimulateReaderUpdateRandom","abstract":"

Randomly picks a type of update for the reader to help exercise the","parent_name":"SCPSimulateReaderUpdate"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(py)availableReaderUpdate":{"name":"availableReaderUpdate","abstract":"

Set this to different values of the SCPSimulateReaderUpdate enum to","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(py)simulatedCard":{"name":"simulatedCard","abstract":"

Create a SCPSimulatedCard and set it on the shared configuration object to","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(py)simulatedTipAmount":{"name":"simulatedTipAmount","abstract":"

Set this to simulate a Terminal configuration object with this fixed tip","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)city":{"name":"city","abstract":"

The city name

","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)country":{"name":"country","abstract":"

The country code

","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)line1":{"name":"line1","abstract":"

The first line of the address

","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)line2":{"name":"line2","abstract":"

The second line of the address

","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)postalCode":{"name":"postalCode","abstract":"

The postal code of the address

","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)state":{"name":"state","abstract":"

The state of the address

","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPAddress"},"Enums/SCPLocationStatus.html#/c:@E@SCPLocationStatus@SCPLocationStatusUnknown":{"name":"SCPLocationStatusUnknown","abstract":"

The location is not known. location will be nil.

","parent_name":"SCPLocationStatus"},"Enums/SCPLocationStatus.html#/c:@E@SCPLocationStatus@SCPLocationStatusSet":{"name":"SCPLocationStatusSet","abstract":"

The location was successfully set to a known location.","parent_name":"SCPLocationStatus"},"Enums/SCPLocationStatus.html#/c:@E@SCPLocationStatus@SCPLocationStatusNotSet":{"name":"SCPLocationStatusNotSet","abstract":"

This location is known to be not set. location will be nil.

","parent_name":"SCPLocationStatus"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)stripeId":{"name":"stripeId","abstract":"

The ID of the Location

","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)address":{"name":"address","abstract":"

The address of this Location

","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)displayName":{"name":"displayName","abstract":"

The display name of this Location

","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)livemode":{"name":"livemode","abstract":"

Whether this Location was created in livemode

","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)metadata":{"name":"metadata","abstract":"

Any metadata attached to this Location

","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(im)init":{"name":"-init","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(cm)new":{"name":"+new","abstract":"

You cannot directly instantiate this class.

","parent_name":"SCPLocation"},"Classes/SCPListLocationsParameters.html#/c:objc(cs)SCPListLocationsParameters(py)limit":{"name":"limit","abstract":"

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

","parent_name":"SCPListLocationsParameters"},"Classes/SCPListLocationsParameters.html#/c:objc(cs)SCPListLocationsParameters(py)endingBefore":{"name":"endingBefore","abstract":"

A cursor for use in pagination. ending_before is an object ID that defines","parent_name":"SCPListLocationsParameters"},"Classes/SCPListLocationsParameters.html#/c:objc(cs)SCPListLocationsParameters(py)startingAfter":{"name":"startingAfter","abstract":"

A cursor for use in pagination. starting_after is an object ID that defines","parent_name":"SCPListLocationsParameters"},"Classes/SCPListLocationsParameters.html#/c:objc(cs)SCPListLocationsParameters(im)initWithLimit:endingBefore:startingAfter:":{"name":"-initWithLimit:endingBefore:startingAfter:","abstract":"

Initializes SCPListLocationsParameters with the given parameters.

","parent_name":"SCPListLocationsParameters"},"Enums/SCPConnectionStatus.html#/c:@E@SCPConnectionStatus@SCPConnectionStatusNotConnected":{"name":"SCPConnectionStatusNotConnected","abstract":"

The SDK is not connected to a reader.

","parent_name":"SCPConnectionStatus"},"Enums/SCPConnectionStatus.html#/c:@E@SCPConnectionStatus@SCPConnectionStatusConnected":{"name":"SCPConnectionStatusConnected","abstract":"

The SDK is connected to a reader.

","parent_name":"SCPConnectionStatus"},"Enums/SCPConnectionStatus.html#/c:@E@SCPConnectionStatus@SCPConnectionStatusConnecting":{"name":"SCPConnectionStatusConnecting","abstract":"

The SDK is currently connecting to a reader.

","parent_name":"SCPConnectionStatus"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(py)locationId":{"name":"locationId","abstract":"

The ID of the Location which the reader should be","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(py)onBehalfOf":{"name":"onBehalfOf","abstract":"

If your integration is creating destination charges and using on_behalf_of, you must provide the","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(py)merchantDisplayName":{"name":"merchantDisplayName","abstract":"

Optional cardholder facing merchant display name that will be used in the prompt for the cardholder","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(py)tosAcceptancePermitted":{"name":"tosAcceptancePermitted","abstract":"

In order to connect to a reader, merchant-specific terms of service may need to be accepted.","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(im)initWithLocationId:":{"name":"-initWithLocationId:","abstract":"

Initialize ConnectionConfiguration with a location ID.

","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(im)initWithLocationId:merchantDisplayName:onBehalfOf:":{"name":"-initWithLocationId:merchantDisplayName:onBehalfOf:","abstract":"

Initialize ConnectionConfiguration with a location ID, custom merchant display name, and ‘on behalf of’","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(im)initWithLocationId:merchantDisplayName:onBehalfOf:tosAcceptancePermitted:":{"name":"-initWithLocationId:merchantDisplayName:onBehalfOf:tosAcceptancePermitted:","abstract":"

Initialize ConnectionConfiguration with a location ID, custom merchant display name, ‘on behalf of’","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(py)failIfInUse":{"name":"failIfInUse","abstract":"

When set to true, the connection will automatically error if the reader is already","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(py)allowCustomerCancel":{"name":"allowCustomerCancel","abstract":"

If set to true, the customer will be able to press the red X button on the","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(im)initWithFailIfInUse:allowCustomerCancel:":{"name":"-initWithFailIfInUse:allowCustomerCancel:","abstract":"

Initialize an InternetConnectionConfiguration object with all possible properties.

","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(im)initWithFailIfInUse:":{"name":"-initWithFailIfInUse:","abstract":"

Initalize an InternetConnectionConfiguration object and set the failIfInUse","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(im)initWithAllowCustomerCancel:":{"name":"-initWithAllowCustomerCancel:","abstract":"

Initialize an InternetConnectionConfiguration object and set the","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(py)locationId":{"name":"locationId","abstract":"

The ID of the Location which the reader should be registered to during connection.

","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(py)autoReconnectOnUnexpectedDisconnect":{"name":"autoReconnectOnUnexpectedDisconnect","abstract":"

When set to true, the Terminal SDK will attempt a Bluetooth auto-reconnection on any unexpected disconnect.","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(py)autoReconnectionDelegate":{"name":"autoReconnectionDelegate","abstract":"

Contains callback methods for Bluetooth auto-reconnection.

","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(im)initWithLocationId:":{"name":"-initWithLocationId:","abstract":"

Initialize your connect options with a location ID.

","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(im)initWithLocationId:autoReconnectOnUnexpectedDisconnect:autoReconnectionDelegate:":{"name":"-initWithLocationId:autoReconnectOnUnexpectedDisconnect:autoReconnectionDelegate:","abstract":"

Initialize your connect options with a location ID and an expected behavior for unexpected disconnects.

","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(im)initWithDiscoveryMethod:simulated:":{"name":"-initWithDiscoveryMethod:simulated:","abstract":"

Initializes a discovery configuration with the given discovery method. All discoverable readers","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(im)initWithDiscoveryMethod:locationId:simulated:":{"name":"-initWithDiscoveryMethod:locationId:simulated:","abstract":"

This variant of the initializer lets you specify a Location to filter the","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(py)timeout":{"name":"timeout","abstract":"

The timeout (in seconds) after which discoverReaders: should fail. If the","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(py)discoveryMethod":{"name":"discoveryMethod","abstract":"

The method by which to discover readers.

","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(py)simulated":{"name":"simulated","abstract":"

Whether to use simulated discovery to discover a device simulator.

","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(py)locationId":{"name":"locationId","abstract":"

A location ID that can be used to filter discovery result so only readers","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(im)init":{"name":"-init","abstract":"

Use initWithDiscoveryMethod:simulated:

","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(cm)new":{"name":"+new","abstract":"

Use initWithDiscoveryMethod:simulated:

","parent_name":"SCPDiscoveryConfiguration"},"Protocols/SCPDiscoveryDelegate.html#/c:objc(pl)SCPDiscoveryDelegate(im)terminal:didUpdateDiscoveredReaders:":{"name":"-terminal:didUpdateDiscoveredReaders:","abstract":"

This method will be called repeatedly until:

","parent_name":"SCPDiscoveryDelegate"},"Enums/SCPDiscoveryMethod.html#/c:@E@SCPDiscoveryMethod@SCPDiscoveryMethodBluetoothScan":{"name":"SCPDiscoveryMethodBluetoothScan","abstract":"

The Bluetooth Scan discovery method searches for Stripe Terminal’s","parent_name":"SCPDiscoveryMethod"},"Enums/SCPDiscoveryMethod.html#/c:@E@SCPDiscoveryMethod@SCPDiscoveryMethodBluetoothProximity":{"name":"SCPDiscoveryMethodBluetoothProximity","abstract":"

The Bluetooth Proximity discovery method searches for a subset of","parent_name":"SCPDiscoveryMethod"},"Enums/SCPDiscoveryMethod.html#/c:@E@SCPDiscoveryMethod@SCPDiscoveryMethodInternet":{"name":"SCPDiscoveryMethodInternet","abstract":"

The Internet discovery method searches for internet-connected readers,","parent_name":"SCPDiscoveryMethod"},"Enums/SCPDiscoveryMethod.html#/c:@E@SCPDiscoveryMethod@SCPDiscoveryMethodLocalMobile":{"name":"SCPDiscoveryMethodLocalMobile","abstract":"

The Local Mobile discovery method searches for any readers built into the","parent_name":"SCPDiscoveryMethod"},"Enums/SCPDiscoveryMethod.html":{"name":"SCPDiscoveryMethod","abstract":"

The possible methods for discovering a reader. Pass a variant of this enum"},"Protocols/SCPDiscoveryDelegate.html":{"name":"SCPDiscoveryDelegate","abstract":"

Implement this protocol to handle a continually updating list"},"Classes/SCPDiscoveryConfiguration.html":{"name":"SCPDiscoveryConfiguration","abstract":"

Configuration options for discovering readers.

"},"Classes/SCPBluetoothConnectionConfiguration.html":{"name":"SCPBluetoothConnectionConfiguration","abstract":"

This class lets you define Bluetooth reader connection options.

"},"Classes/SCPInternetConnectionConfiguration.html":{"name":"SCPInternetConnectionConfiguration","abstract":"

This class lets you set options that define internet reader behavior throughout a given"},"Classes/SCPLocalMobileConnectionConfiguration.html":{"name":"SCPLocalMobileConnectionConfiguration","abstract":"

This class lets you set options that define local mobile reader behavior throughout a given"},"Enums/SCPConnectionStatus.html":{"name":"SCPConnectionStatus","abstract":"

The possible reader connection statuses for the SDK.

"},"Classes/SCPListLocationsParameters.html":{"name":"SCPListLocationsParameters","abstract":"

Parameters to be used when calling Terminal.shared.listLocations() to list"},"Classes/SCPLocation.html":{"name":"SCPLocation","abstract":"

A Location is used to group readers in the Stripe Terminal ecosystem. The"},"Enums/SCPLocationStatus.html":{"name":"SCPLocationStatus","abstract":"

Represents the possible states of the location object for a"},"Classes/SCPAddress.html":{"name":"SCPAddress","abstract":"

Holds address data associated with a given SCPLocation.

"},"Classes/SCPSimulatorConfiguration.html":{"name":"SCPSimulatorConfiguration","abstract":"

Simulator specific configurations you can set to test your integration’s"},"Enums/SCPSimulateReaderUpdate.html":{"name":"SCPSimulateReaderUpdate","abstract":"

Enum used to simulate various types of reader updates being available for"},"Classes/SCPSimulatedCard.html":{"name":"SCPSimulatedCard","abstract":"

Simulated Card objects can be used with the shared SCPSimulatorConfiguration"},"Enums/SCPSimulatedCardType.html":{"name":"SCPSimulatedCardType","abstract":"

Enum used to simulate various types of cards and error cases.

"},"Protocols/SCPJSONDecodable.html#/c:objc(pl)SCPJSONDecodable(cm)decodedObjectFromJSON:":{"name":"+decodedObjectFromJSON:","abstract":"

Parses a JSON dictionary into an instance of the class. Returns nil if the","parent_name":"SCPJSONDecodable"},"Protocols/SCPJSONDecodable.html#/c:objc(pl)SCPJSONDecodable(py)originalJSON":{"name":"originalJSON","abstract":"

The raw JSON used to create the object. This may be useful for accessing","parent_name":"SCPJSONDecodable"},"Classes/SCPCancelable.html#/c:objc(cs)SCPCancelable(py)completed":{"name":"completed","abstract":"

Indicates whether the command has completed. After the command has completed,","parent_name":"SCPCancelable"},"Classes/SCPCancelable.html#/c:objc(cs)SCPCancelable(im)cancel:":{"name":"-cancel:","abstract":"

Attempts to cancel the action in progress. If the action could not be canceled,","parent_name":"SCPCancelable"},"Enums/SCPLogLevel.html#/c:@E@SCPLogLevel@SCPLogLevelNone":{"name":"SCPLogLevelNone","abstract":"

No logs will printed to the console.

","parent_name":"SCPLogLevel"},"Enums/SCPLogLevel.html#/c:@E@SCPLogLevel@SCPLogLevelVerbose":{"name":"SCPLogLevelVerbose","abstract":"

Verbose logs will be printed to the console.

","parent_name":"SCPLogLevel"},"Protocols/SCPReconnectionDelegate.html#/c:objc(pl)SCPReconnectionDelegate(im)terminal:didStartReaderReconnect:":{"name":"-terminal:didStartReaderReconnect:","abstract":"

The reader has lost Bluetooth connection to the SDK and reconnection attempts have been started.

","parent_name":"SCPReconnectionDelegate"},"Protocols/SCPReconnectionDelegate.html#/c:objc(pl)SCPReconnectionDelegate(im)terminalDidSucceedReaderReconnect:":{"name":"-terminalDidSucceedReaderReconnect:","abstract":"

The SDK was able to reconnect to the previously connected Bluetooth reader.

","parent_name":"SCPReconnectionDelegate"},"Protocols/SCPReconnectionDelegate.html#/c:objc(pl)SCPReconnectionDelegate(im)terminalDidFailReaderReconnect:":{"name":"-terminalDidFailReaderReconnect:","abstract":"

The SDK was not able to reconnect to the previously connected bluetooth reader. The SDK is now disconnected from any readers.

","parent_name":"SCPReconnectionDelegate"},"Protocols/SCPTerminalDelegate.html#/c:objc(pl)SCPTerminalDelegate(im)terminal:didReportUnexpectedReaderDisconnect:":{"name":"-terminal:didReportUnexpectedReaderDisconnect:","abstract":"

The reader disconnected unexpectedly (that is, without your app explicitly","parent_name":"SCPTerminalDelegate"},"Protocols/SCPTerminalDelegate.html#/c:objc(pl)SCPTerminalDelegate(im)terminal:didChangeConnectionStatus:":{"name":"-terminal:didChangeConnectionStatus:","abstract":"

The currently connected reader’s connectionStatus changed.

","parent_name":"SCPTerminalDelegate"},"Protocols/SCPTerminalDelegate.html#/c:objc(pl)SCPTerminalDelegate(im)terminal:didChangePaymentStatus:":{"name":"-terminal:didChangePaymentStatus:","abstract":"

The currently connected reader’s paymentStatus changed.

","parent_name":"SCPTerminalDelegate"},"Protocols/SCPConnectionTokenProvider.html#/c:objc(pl)SCPConnectionTokenProvider(im)fetchConnectionToken:":{"name":"-fetchConnectionToken:","abstract":"

Fetches a connection token from your backend server.

","parent_name":"SCPConnectionTokenProvider"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)setTokenProvider:":{"name":"+setTokenProvider:","abstract":"

Sets the token provider for the shared (singleton) SCPTerminal instance.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)hasTokenProvider":{"name":"+hasTokenProvider","abstract":"

Returns true if a token provider has been set, through setTokenProvider:

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)setLogListener:":{"name":"+setLogListener:","abstract":"

Sets a block to listen for logs from the shared Terminal instance (optional).

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cpy)shared":{"name":"shared","abstract":"

Returns the shared (singleton) Terminal instance.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)delegate":{"name":"delegate","abstract":"

The Terminal singleton object’s primary delegate. This delegate announces","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)connectedReader":{"name":"connectedReader","abstract":"

Information about the connected SCPReader, or nil if no reader is connected.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)connectionStatus":{"name":"connectionStatus","abstract":"

The Terminal instance’s current connection status.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)logLevel":{"name":"logLevel","abstract":"

The log level for the SDK. The default value is .none.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)simulatorConfiguration":{"name":"simulatorConfiguration","abstract":"

The simulator configuration settings that will be used when connecting to","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)paymentStatus":{"name":"paymentStatus","abstract":"

The Terminal instance’s current payment status.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)clearCachedCredentials":{"name":"-clearCachedCredentials","abstract":"

Clears the current connection token, saved reader sessions, and any other","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)supportsReadersOfType:discoveryMethod:simulated:error:":{"name":"-supportsReadersOfType:discoveryMethod:simulated:error:","abstract":"

Use this method to determine whether the mobile device supports a given reader type","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)discoverReaders:delegate:completion:":{"name":"-discoverReaders:delegate:completion:","abstract":"

Begins discovering readers based on the given discovery configuration.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)connectBluetoothReader:delegate:connectionConfig:completion:":{"name":"-connectBluetoothReader:delegate:connectionConfig:completion:","abstract":"

Attempts to connect to the given Bluetooth reader with a given connection","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)connectInternetReader:connectionConfig:completion:":{"name":"-connectInternetReader:connectionConfig:completion:","abstract":"

Attempts to connect to the given Internet reader with a given connection","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)connectLocalMobileReader:delegate:connectionConfig:completion:":{"name":"-connectLocalMobileReader:delegate:connectionConfig:completion:","abstract":"

Attempts to connect to the given Local Mobile reader with a given","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)listLocations:completion:":{"name":"-listLocations:completion:","abstract":"

Retrieves a list of SCPLocation objects belonging to your merchant. You must specify","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)installAvailableUpdate":{"name":"-installAvailableUpdate","abstract":"

Installs the available update for the connected reader.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)disconnectReader:":{"name":"-disconnectReader:","abstract":"

Attempts to disconnect from the currently connected reader.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)createPaymentIntent:completion:":{"name":"-createPaymentIntent:completion:","abstract":"

Creates a new SCPPaymentIntent with the given parameters.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)retrievePaymentIntent:completion:":{"name":"-retrievePaymentIntent:completion:","abstract":"

Retrieves a SCPPaymentIntent with a client secret.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectPaymentMethod:completion:":{"name":"-collectPaymentMethod:completion:","abstract":"

Collects a payment method for the given SCPPaymentIntent.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectPaymentMethod:collectConfig:completion:":{"name":"-collectPaymentMethod:collectConfig:completion:","abstract":"

Collects a payment method for the given PaymentIntent, with the specified configuration.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)processPayment:completion:":{"name":"-processPayment:completion:","abstract":"

Processes a payment after collecting a payment method succeeds.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)cancelPaymentIntent:completion:":{"name":"-cancelPaymentIntent:completion:","abstract":"

Cancels an SCPPaymentIntent.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)readReusableCard:completion:":{"name":"-readReusableCard:completion:","abstract":"

Reads a card with the given parameters and returns a PaymentMethod.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)createSetupIntent:completion:":{"name":"-createSetupIntent:completion:","abstract":"

Creates a new SCPSetupIntent with the given parameters.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)retrieveSetupIntent:completion:":{"name":"-retrieveSetupIntent:completion:","abstract":"

Retrieves an SCPSetupIntent with a client secret.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)cancelSetupIntent:completion:":{"name":"-cancelSetupIntent:completion:","abstract":"

Cancels an SCPPaymentIntent.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectSetupIntentPaymentMethod:customerConsentCollected:completion:":{"name":"-collectSetupIntentPaymentMethod:customerConsentCollected:completion:","abstract":"

Collects a payment method for the given SCPSetupIntent.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)confirmSetupIntent:completion:":{"name":"-confirmSetupIntent:completion:","abstract":"

Confirms a SetupIntent after the payment method has been successfully collected.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectRefundPaymentMethod:completion:":{"name":"-collectRefundPaymentMethod:completion:","abstract":"

Initiates an in-person refund with a given set of SCPRefundParameters by","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)processRefund:":{"name":"-processRefund:","abstract":"

Processes an in-person refund after the refund payment method has been collected.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)clearReaderDisplay:":{"name":"-clearReaderDisplay:","abstract":"

Clears the reader display and resets it to the splash screen.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)setReaderDisplay:completion:":{"name":"-setReaderDisplay:completion:","abstract":"

Updates the reader display with cart information.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromReaderInputOptions:":{"name":"+stringFromReaderInputOptions:","abstract":"

Returns an unlocalized string for the given reader input options, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromReaderDisplayMessage:":{"name":"+stringFromReaderDisplayMessage:","abstract":"

Returns an unlocalized string for the given reader display message, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromReaderEvent:":{"name":"+stringFromReaderEvent:","abstract":"

Returns an unlocalized string for the given reader event, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromConnectionStatus:":{"name":"+stringFromConnectionStatus:","abstract":"

Returns an unlocalized string for the given connection status, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromPaymentStatus:":{"name":"+stringFromPaymentStatus:","abstract":"

Returns an unlocalized string for the given payment status, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromDeviceType:":{"name":"+stringFromDeviceType:","abstract":"

Returns an unlocalized string for the given device type.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromDiscoveryMethod:":{"name":"+stringFromDiscoveryMethod:","abstract":"

Returns an unlocalized string for the given discovery method.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromCardBrand:":{"name":"+stringFromCardBrand:","abstract":"

Returns an unlocalized string for the given card brand.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromPaymentIntentStatus:":{"name":"+stringFromPaymentIntentStatus:","abstract":"

Returns an unlocalized string for the given payment intent status.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromCaptureMethod:":{"name":"+stringFromCaptureMethod:","abstract":"

Returns an unlocalized string for the given capture method.

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)init":{"name":"-init","abstract":"

Use initWithConfiguration:tokenProvider:delegate:

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)new":{"name":"+new","abstract":"

Use initWithConfiguration:tokenProvider:delegate:

","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html":{"name":"SCPTerminal","abstract":"

The SCPTerminal singleton object exposes an interface for discovering readers,"},"Protocols/SCPConnectionTokenProvider.html":{"name":"SCPConnectionTokenProvider","abstract":"

Before integrating the SDK, you should create an endpoint on your backend"},"Protocols/SCPTerminalDelegate.html":{"name":"SCPTerminalDelegate","abstract":"

Implement this protocol to handle connection and payment updates from the"},"Protocols/SCPReconnectionDelegate.html":{"name":"SCPReconnectionDelegate","abstract":"

Implement this protocol to handle bluetooth auto-reconnection.

"},"Enums/SCPLogLevel.html":{"name":"SCPLogLevel","abstract":"

The various log levels for the SDK.

"},"Classes/SCPCancelable.html":{"name":"SCPCancelable","abstract":"

An object representing an action that can be canceled.

"},"Protocols/SCPJSONDecodable.html":{"name":"SCPJSONDecodable","abstract":"

Objects conforming to this protocol can be instantiated by decoding a JSON"},"Terminal.html#/c:SCPTerminal.h@SCPSDKVersion":{"name":"SCPSDKVersion","abstract":"

The current version of this library.

"},"Terminal.html":{"name":"Terminal"},"Reader%20Discovery%20%26%20Connection.html":{"name":"Reader Discovery & Connection"},"Reader.html":{"name":"Reader"},"Reader%20Updates.html":{"name":"Reader Updates"},"Payment.html":{"name":"Payment"},"Card-Present%20Refunds.html":{"name":"Card-Present Refunds"},"Saving%20Cards.html":{"name":"Saving Cards"},"Errors.html":{"name":"Errors"},"Blocks.html":{"name":"Blocks"}} \ No newline at end of file diff --git a/docs/2.19.0/undocumented.json b/docs/2.19.0/undocumented.json new file mode 100644 index 00000000..fea92eee --- /dev/null +++ b/docs/2.19.0/undocumented.json @@ -0,0 +1,6 @@ +{ + "warnings": [ + + ], + "source_directory": "/Users/mindy/stripe/stripe-terminal-ios" +} \ No newline at end of file diff --git a/docs/docs/Blocks.html b/docs/docs/Blocks.html index 3456f97f..1ae50c86 100644 --- a/docs/docs/Blocks.html +++ b/docs/docs/Blocks.html @@ -21,7 +21,7 @@

- StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

@@ -1180,7 +1180,7 @@

Parameters

-

© 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

Generated by jazzy ♪♫ v0.14.3, a Realm project.

diff --git a/docs/docs/Card-Present Refunds.html b/docs/docs/Card-Present Refunds.html index 0e60fa59..8dfab0e8 100644 --- a/docs/docs/Card-Present Refunds.html +++ b/docs/docs/Card-Present Refunds.html @@ -21,7 +21,7 @@

- StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

@@ -593,7 +593,7 @@

Declaration

-

© 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

Generated by jazzy ♪♫ v0.14.3, a Realm project.

diff --git a/docs/docs/Classes/SCPAddress.html b/docs/docs/Classes/SCPAddress.html index 48259030..1cc43df7 100644 --- a/docs/docs/Classes/SCPAddress.html +++ b/docs/docs/Classes/SCPAddress.html @@ -21,7 +21,7 @@

- StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

@@ -702,7 +702,7 @@

Declaration

-

© 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

Generated by jazzy ♪♫ v0.14.3, a Realm project.

diff --git a/docs/docs/Classes/SCPAmountDetails.html b/docs/docs/Classes/SCPAmountDetails.html index 0429a39a..01e45108 100644 --- a/docs/docs/Classes/SCPAmountDetails.html +++ b/docs/docs/Classes/SCPAmountDetails.html @@ -21,7 +21,7 @@

- StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

@@ -528,7 +528,7 @@

Declaration

-

© 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

Generated by jazzy ♪♫ v0.14.3, a Realm project.

diff --git a/docs/docs/Classes/SCPBluetoothConnectionConfiguration.html b/docs/docs/Classes/SCPBluetoothConnectionConfiguration.html index 59dd9cfd..8b1d745d 100644 --- a/docs/docs/Classes/SCPBluetoothConnectionConfiguration.html +++ b/docs/docs/Classes/SCPBluetoothConnectionConfiguration.html @@ -21,7 +21,7 @@

- StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

@@ -620,7 +620,7 @@

Declaration

-

© 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

Generated by jazzy ♪♫ v0.14.3, a Realm project.

diff --git a/docs/docs/Classes/SCPCancelable.html b/docs/docs/Classes/SCPCancelable.html index d62824e0..12f88a0f 100644 --- a/docs/docs/Classes/SCPCancelable.html +++ b/docs/docs/Classes/SCPCancelable.html @@ -21,7 +21,7 @@

- StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

@@ -487,7 +487,7 @@

Declaration

Swift

- 
func cancel() async throws
+ 
func cancel() async throws
@@ -502,7 +502,7 @@

Declaration

-

© 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

Generated by jazzy ♪♫ v0.14.3, a Realm project.

diff --git a/docs/docs/Classes/SCPCardDetails.html b/docs/docs/Classes/SCPCardDetails.html index 5f649dae..03455eea 100644 --- a/docs/docs/Classes/SCPCardDetails.html +++ b/docs/docs/Classes/SCPCardDetails.html @@ -21,7 +21,7 @@

- StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

@@ -699,7 +699,7 @@

Declaration

-

© 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

Generated by jazzy ♪♫ v0.14.3, a Realm project.

diff --git a/docs/docs/Classes/SCPCardPresentDetails.html b/docs/docs/Classes/SCPCardPresentDetails.html index 683df915..1c726500 100644 --- a/docs/docs/Classes/SCPCardPresentDetails.html +++ b/docs/docs/Classes/SCPCardPresentDetails.html @@ -21,7 +21,7 @@

- StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

@@ -970,7 +970,7 @@

Declaration

-

© 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

Generated by jazzy ♪♫ v0.14.3, a Realm project.

diff --git a/docs/docs/Classes/SCPCardPresentParameters.html b/docs/docs/Classes/SCPCardPresentParameters.html index b09a8665..9dead429 100644 --- a/docs/docs/Classes/SCPCardPresentParameters.html +++ b/docs/docs/Classes/SCPCardPresentParameters.html @@ -21,7 +21,7 @@

- StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

@@ -1335,7 +1335,7 @@

Declaration

-

© 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

Generated by jazzy ♪♫ v0.14.3, a Realm project.

diff --git a/docs/docs/Classes/SCPCart.html b/docs/docs/Classes/SCPCart.html index cc570238..d75a2035 100644 --- a/docs/docs/Classes/SCPCart.html +++ b/docs/docs/Classes/SCPCart.html @@ -21,7 +21,7 @@

- StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

@@ -723,7 +723,7 @@

Declaration

-

© 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

Generated by jazzy ♪♫ v0.14.3, a Realm project.

diff --git a/docs/docs/Classes/SCPCartLineItem.html b/docs/docs/Classes/SCPCartLineItem.html index b9416748..0e13cb38 100644 --- a/docs/docs/Classes/SCPCartLineItem.html +++ b/docs/docs/Classes/SCPCartLineItem.html @@ -21,7 +21,7 @@

- StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

@@ -618,7 +618,7 @@

Parameters

-

© 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

Generated by jazzy ♪♫ v0.14.3, a Realm project.

diff --git a/docs/docs/Classes/SCPCharge.html b/docs/docs/Classes/SCPCharge.html index 0ec9ace4..97b56c17 100644 --- a/docs/docs/Classes/SCPCharge.html +++ b/docs/docs/Classes/SCPCharge.html @@ -21,7 +21,7 @@

- StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

@@ -798,7 +798,7 @@

Declaration

-

© 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

Generated by jazzy ♪♫ v0.14.3, a Realm project.

diff --git a/docs/docs/Classes/SCPCollectConfiguration.html b/docs/docs/Classes/SCPCollectConfiguration.html index 3a31050d..273cb8f0 100644 --- a/docs/docs/Classes/SCPCollectConfiguration.html +++ b/docs/docs/Classes/SCPCollectConfiguration.html @@ -21,7 +21,7 @@

- StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

@@ -563,7 +563,7 @@

Declaration

Swift

- 
convenience init(skipTipping: Bool)
+ 
convenience init(skipTipping: Bool)
@@ -614,7 +614,7 @@

Declaration

Swift

- 
convenience init(updatePaymentIntent: Bool)
+ 
convenience init(updatePaymentIntent: Bool)
@@ -666,7 +666,7 @@

Declaration

Swift

- 
convenience init(tippingConfiguration: SCPTippingConfiguration)
+ 
convenience init(tippingConfiguration: SCPTippingConfiguration)
@@ -718,7 +718,7 @@

Declaration

Swift

- 
convenience init(skipTipping: Bool, updatePaymentIntent: Bool)
+ 
convenience init(skipTipping: Bool, updatePaymentIntent: Bool)
@@ -783,7 +783,7 @@

Declaration

Swift

- 
convenience init(skipTipping: Bool, tippingConfiguration: SCPTippingConfiguration?)
+ 
convenience init(skipTipping: Bool, tippingConfiguration: SCPTippingConfiguration?)
@@ -849,7 +849,7 @@

Declaration

Swift

- 
convenience init(updatePaymentIntent: Bool, tippingConfiguration: SCPTippingConfiguration?)
+ 
convenience init(updatePaymentIntent: Bool, tippingConfiguration: SCPTippingConfiguration?)
@@ -1035,7 +1035,7 @@

Declaration

-

© 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

Generated by jazzy ♪♫ v0.14.3, a Realm project.

diff --git a/docs/docs/Classes/SCPConfirmSetupIntentError.html b/docs/docs/Classes/SCPConfirmSetupIntentError.html index 234661d3..41bf695c 100644 --- a/docs/docs/Classes/SCPConfirmSetupIntentError.html +++ b/docs/docs/Classes/SCPConfirmSetupIntentError.html @@ -21,7 +21,7 @@

- StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

@@ -595,7 +595,7 @@

Declaration

-

© 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

Generated by jazzy ♪♫ v0.14.3, a Realm project.

diff --git a/docs/docs/Classes/SCPDiscoveryConfiguration.html b/docs/docs/Classes/SCPDiscoveryConfiguration.html index 1608a2a2..854a42e2 100644 --- a/docs/docs/Classes/SCPDiscoveryConfiguration.html +++ b/docs/docs/Classes/SCPDiscoveryConfiguration.html @@ -21,7 +21,7 @@

- StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

@@ -804,7 +804,7 @@

Declaration

-

© 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

Generated by jazzy ♪♫ v0.14.3, a Realm project.

diff --git a/docs/docs/Classes/SCPInternetConnectionConfiguration.html b/docs/docs/Classes/SCPInternetConnectionConfiguration.html index 73eea45a..7f83eca2 100644 --- a/docs/docs/Classes/SCPInternetConnectionConfiguration.html +++ b/docs/docs/Classes/SCPInternetConnectionConfiguration.html @@ -21,7 +21,7 @@

- StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

@@ -624,7 +624,7 @@

Declaration

-

© 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

Generated by jazzy ♪♫ v0.14.3, a Realm project.

diff --git a/docs/docs/Classes/SCPListLocationsParameters.html b/docs/docs/Classes/SCPListLocationsParameters.html index 5026aa28..334e6957 100644 --- a/docs/docs/Classes/SCPListLocationsParameters.html +++ b/docs/docs/Classes/SCPListLocationsParameters.html @@ -21,7 +21,7 @@

- StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

@@ -641,7 +641,7 @@

Parameters

-

© 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

Generated by jazzy ♪♫ v0.14.3, a Realm project.

diff --git a/docs/docs/Classes/SCPLocalMobileConnectionConfiguration.html b/docs/docs/Classes/SCPLocalMobileConnectionConfiguration.html index adc818a0..04b672f2 100644 --- a/docs/docs/Classes/SCPLocalMobileConnectionConfiguration.html +++ b/docs/docs/Classes/SCPLocalMobileConnectionConfiguration.html @@ -21,7 +21,7 @@

- StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

@@ -610,7 +610,7 @@

Declaration

Swift

- 
convenience init(locationId: String)
+ 
convenience init(locationId: String)
@@ -669,7 +669,7 @@

Declaration

Swift

- 
convenience init(locationId: String, merchantDisplayName: String?, onBehalfOf: String?)
+ 
convenience init(locationId: String, merchantDisplayName: String?, onBehalfOf: String?)
@@ -829,7 +829,7 @@

Parameters

-

© 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

Generated by jazzy ♪♫ v0.14.3, a Realm project.

diff --git a/docs/docs/Classes/SCPLocation.html b/docs/docs/Classes/SCPLocation.html index 95ed9221..08d41ac9 100644 --- a/docs/docs/Classes/SCPLocation.html +++ b/docs/docs/Classes/SCPLocation.html @@ -21,7 +21,7 @@

- StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

@@ -680,7 +680,7 @@

Declaration

-

© 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

Generated by jazzy ♪♫ v0.14.3, a Realm project.

diff --git a/docs/docs/Classes/SCPNetworks.html b/docs/docs/Classes/SCPNetworks.html index 8ee05d0b..930d0cb4 100644 --- a/docs/docs/Classes/SCPNetworks.html +++ b/docs/docs/Classes/SCPNetworks.html @@ -21,7 +21,7 @@

- StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

@@ -535,7 +535,7 @@

Declaration

-

© 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

+

© 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

Generated by jazzy ♪♫ v0.14.3, a Realm project.

diff --git a/docs/docs/Classes/SCPPaymentIntent.html b/docs/docs/Classes/SCPPaymentIntent.html index 921dcf86..a05eba8c 100644 --- a/docs/docs/Classes/SCPPaymentIntent.html +++ b/docs/docs/Classes/SCPPaymentIntent.html @@ -21,7 +21,7 @@

- StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

@@ -569,6 +569,38 @@

Declaration

+
  • +
    + + + + captureMethod + +
    +
    +
    +
    +
    +
    +

    Controls when the funds will be captured from the customer’s account.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPCaptureMethod captureMethod;
    + +
    +
    +

    Swift

    + 
    var captureMethod: CaptureMethod { get }
    + +
    +
    +
    +
    +
  • @@ -921,7 +953,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Classes/SCPPaymentIntentParameters.html b/docs/docs/Classes/SCPPaymentIntentParameters.html index 72eb9c88..85be4f22 100644 --- a/docs/docs/Classes/SCPPaymentIntentParameters.html +++ b/docs/docs/Classes/SCPPaymentIntentParameters.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -1478,7 +1478,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Classes/SCPPaymentMethod.html b/docs/docs/Classes/SCPPaymentMethod.html index 35a94012..0cc3a9cd 100644 --- a/docs/docs/Classes/SCPPaymentMethod.html +++ b/docs/docs/Classes/SCPPaymentMethod.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -770,7 +770,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Classes/SCPPaymentMethodDetails.html b/docs/docs/Classes/SCPPaymentMethodDetails.html index c404b2d1..47f84137 100644 --- a/docs/docs/Classes/SCPPaymentMethodDetails.html +++ b/docs/docs/Classes/SCPPaymentMethodDetails.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -576,7 +576,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Classes/SCPPaymentMethodOptionsParameters.html b/docs/docs/Classes/SCPPaymentMethodOptionsParameters.html index 8e41abc1..f4b01067 100644 --- a/docs/docs/Classes/SCPPaymentMethodOptionsParameters.html +++ b/docs/docs/Classes/SCPPaymentMethodOptionsParameters.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -555,7 +555,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Classes/SCPProcessPaymentError.html b/docs/docs/Classes/SCPProcessPaymentError.html index dc2c11ee..dbe0e5b2 100644 --- a/docs/docs/Classes/SCPProcessPaymentError.html +++ b/docs/docs/Classes/SCPProcessPaymentError.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -616,7 +616,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Classes/SCPProcessRefundError.html b/docs/docs/Classes/SCPProcessRefundError.html index 5e8eaf8e..fbdca4ef 100644 --- a/docs/docs/Classes/SCPProcessRefundError.html +++ b/docs/docs/Classes/SCPProcessRefundError.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -573,7 +573,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Classes/SCPReadReusableCardParameters.html b/docs/docs/Classes/SCPReadReusableCardParameters.html index dc92efab..ee8243fb 100644 --- a/docs/docs/Classes/SCPReadReusableCardParameters.html +++ b/docs/docs/Classes/SCPReadReusableCardParameters.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -523,7 +523,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Classes/SCPReader.html b/docs/docs/Classes/SCPReader.html index 0cf718ce..32b7bf17 100644 --- a/docs/docs/Classes/SCPReader.html +++ b/docs/docs/Classes/SCPReader.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -1095,7 +1095,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Classes/SCPReaderSoftwareUpdate.html b/docs/docs/Classes/SCPReaderSoftwareUpdate.html index 48b9a690..c77821cb 100644 --- a/docs/docs/Classes/SCPReaderSoftwareUpdate.html +++ b/docs/docs/Classes/SCPReaderSoftwareUpdate.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -674,7 +674,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Classes/SCPReceiptDetails.html b/docs/docs/Classes/SCPReceiptDetails.html index fb1fb0f2..ecc9a2d0 100644 --- a/docs/docs/Classes/SCPReceiptDetails.html +++ b/docs/docs/Classes/SCPReceiptDetails.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -528,6 +528,38 @@

    Declaration

    • +
  • +
    + + + + authorizationCode + +
    +
    +
    +
    +
    +
    +

    Identifier for this transaction

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *authorizationCode;
    + +
    +
    +

    Swift

    + 
    var authorizationCode: String? { get }
    + +
    +
    +
    +
    +
  • @@ -726,7 +758,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Classes/SCPRefund.html b/docs/docs/Classes/SCPRefund.html index c0ba6e9d..9ac10c01 100644 --- a/docs/docs/Classes/SCPRefund.html +++ b/docs/docs/Classes/SCPRefund.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -846,7 +846,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Classes/SCPRefundParameters.html b/docs/docs/Classes/SCPRefundParameters.html index 7b6b86d0..3336fc40 100644 --- a/docs/docs/Classes/SCPRefundParameters.html +++ b/docs/docs/Classes/SCPRefundParameters.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -810,7 +810,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Classes/SCPSetupAttempt.html b/docs/docs/Classes/SCPSetupAttempt.html index 5decd2e1..5d2a7650 100644 --- a/docs/docs/Classes/SCPSetupAttempt.html +++ b/docs/docs/Classes/SCPSetupAttempt.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -732,7 +732,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Classes/SCPSetupAttemptCardPresentDetails.html b/docs/docs/Classes/SCPSetupAttemptCardPresentDetails.html index 23c811b9..3ed97167 100644 --- a/docs/docs/Classes/SCPSetupAttemptCardPresentDetails.html +++ b/docs/docs/Classes/SCPSetupAttemptCardPresentDetails.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -567,7 +567,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Classes/SCPSetupAttemptPaymentMethodDetails.html b/docs/docs/Classes/SCPSetupAttemptPaymentMethodDetails.html index 7090350d..2c61e973 100644 --- a/docs/docs/Classes/SCPSetupAttemptPaymentMethodDetails.html +++ b/docs/docs/Classes/SCPSetupAttemptPaymentMethodDetails.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -576,7 +576,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Classes/SCPSetupIntent.html b/docs/docs/Classes/SCPSetupIntent.html index 1ee67bd8..f265e94b 100644 --- a/docs/docs/Classes/SCPSetupIntent.html +++ b/docs/docs/Classes/SCPSetupIntent.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -737,7 +737,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Classes/SCPSetupIntentParameters.html b/docs/docs/Classes/SCPSetupIntentParameters.html index eaf4d573..9b5e65b8 100644 --- a/docs/docs/Classes/SCPSetupIntentParameters.html +++ b/docs/docs/Classes/SCPSetupIntentParameters.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -762,7 +762,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Classes/SCPSimulatedCard.html b/docs/docs/Classes/SCPSimulatedCard.html index 832d3ad4..c048b926 100644 --- a/docs/docs/Classes/SCPSimulatedCard.html +++ b/docs/docs/Classes/SCPSimulatedCard.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -650,7 +650,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Classes/SCPSimulatorConfiguration.html b/docs/docs/Classes/SCPSimulatorConfiguration.html index bb6fac2c..5de8a38b 100644 --- a/docs/docs/Classes/SCPSimulatorConfiguration.html +++ b/docs/docs/Classes/SCPSimulatorConfiguration.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -513,6 +513,39 @@

    Declaration

    • +
  • +
    + + + + simulatedTipAmount + +
    +
    +
    +
    +
    +
    +

    Set this to simulate a Terminal configuration object with this fixed tip +amount for all currencies.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, nullable) NSNumber *simulatedTipAmount;
    + +
    +
    +

    Swift

    + 
    var simulatedTipAmount: NSNumber? { get set }
    + +
    +
    +
    +
    +
  • @@ -585,7 +618,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Classes/SCPTerminal.html b/docs/docs/Classes/SCPTerminal.html index 8683a818..2774e155 100644 --- a/docs/docs/Classes/SCPTerminal.html +++ b/docs/docs/Classes/SCPTerminal.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -1140,7 +1140,7 @@

    Declaration

    Swift

    - 
    func connectBluetoothReader(_ reader: SCPReader, delegate: BluetoothReaderDelegate, connectionConfig: SCPBluetoothConnectionConfiguration) async throws -> SCPReader
    + 
    func connectBluetoothReader(_ reader: SCPReader, delegate: BluetoothReaderDelegate, connectionConfig: SCPBluetoothConnectionConfiguration) async throws -> SCPReader
    @@ -1257,7 +1257,7 @@

    Declaration

    Swift

    - 
    func connectInternetReader(_ reader: SCPReader, connectionConfig: SCPInternetConnectionConfiguration?) async throws -> SCPReader
    + 
    func connectInternetReader(_ reader: SCPReader, connectionConfig: SCPInternetConnectionConfiguration?) async throws -> SCPReader
    @@ -1371,7 +1371,7 @@

    Declaration

    Swift

    - 
    func connectLocalMobileReader(_ reader: SCPReader, delegate: LocalMobileReaderDelegate, connectionConfig: SCPLocalMobileConnectionConfiguration) async throws -> SCPReader
    + 
    func connectLocalMobileReader(_ reader: SCPReader, delegate: LocalMobileReaderDelegate, connectionConfig: SCPLocalMobileConnectionConfiguration) async throws -> SCPReader
    @@ -1470,7 +1470,7 @@

    Declaration

    Swift

    - 
    func listLocations(parameters: SCPListLocationsParameters?) async throws -> ([SCPLocation], Bool)
    + 
    func listLocations(parameters: SCPListLocationsParameters?) async throws -> ([SCPLocation], Bool)
    @@ -1609,7 +1609,7 @@

    Declaration

    Swift

    - 
    func disconnectReader() async throws
    + 
    func disconnectReader() async throws
    @@ -1666,7 +1666,7 @@

    Taking payments

    Note: If the information required to create a PaymentIntent isn’t readily available in your app, you can create the PaymentIntent on your server and use the retrievePaymentIntent method to retrieve the PaymentIntent in your app.

    -
    - note: This cannot be used with the Verifone P400. If used with the
+
    - - note: This cannot be used with the Verifone P400. If used with the
 Verifone P400, the completion handler will be called with
 an SCPErrorFeatureNotAvailableWithConnectedReader error.
 
    
@@ -1687,7 +1687,7 @@ 
    Declaration
    
                         
                         
    
                           
    Swift
    
-                          
    func createPaymentIntent(_ parameters: SCPPaymentIntentParameters) async throws -> PaymentIntent
    
+                          
    func createPaymentIntent(_ parameters: PaymentIntentParameters) async throws -> PaymentIntent
    
 
                         
    
                       
@@ -1761,7 +1761,7 @@ 
    Declaration
    
                         
                         
    
                           
    Swift
    
-                          
    func retrievePaymentIntent(clientSecret: String) async throws -> PaymentIntent
    
+                          
    func retrievePaymentIntent(clientSecret: String) async throws -> PaymentIntent
    
 
                         
    
                       
@@ -2024,7 +2024,7 @@ 
    Declaration
    
                         
                         
    
                           
    Swift
    
-                          
    func processPayment(_ paymentIntent: PaymentIntent) async -> (PaymentIntent?, SCPProcessPaymentError?)
    
+                          
    func processPayment(_ paymentIntent: PaymentIntent) async -> (PaymentIntent?, SCPProcessPaymentError?)
    
 
                         
    
                       
@@ -2103,7 +2103,7 @@ 
    Declaration
    
                         
                         
    
                           
    Swift
    
-                          
    func cancelPaymentIntent(_ paymentIntent: PaymentIntent) async throws -> PaymentIntent
    
+                          
    func cancelPaymentIntent(_ paymentIntent: PaymentIntent) async throws -> PaymentIntent
    
 
                         
    
                       
@@ -2281,7 +2281,7 @@ 
    Declaration
    
                         
                         
    
                           
    Swift
    
-                          
    func createSetupIntent(_ setupIntentParams: SCPSetupIntentParameters) async throws -> SCPSetupIntent
    
+                          
    func createSetupIntent(_ setupIntentParams: SCPSetupIntentParameters) async throws -> SCPSetupIntent
    
 
                         
    
                       
@@ -2297,7 +2297,7 @@ 
    Parameters
    
                               
                               
                                 
    
-                                  
    The parameters that control the creation of the SetupIntent
    
+                                  
    The parameters that control the creation of the SetupIntent.
    
                                 
    
                               
                             
@@ -2309,7 +2309,7 @@ 
    Parameters
    
                               
                               
                                 
    
-                                  
    The compltion block called when the command completes
    
+                                  
    The completion block called when the command completes.
    
                                 
    
                               
                             
@@ -2348,7 +2348,7 @@ 
    Declaration
    
                         
                         
    
                           
    Swift
    
-                          
    func retrieveSetupIntent(clientSecret: String) async throws -> SCPSetupIntent
    
+                          
    func retrieveSetupIntent(clientSecret: String) async throws -> SCPSetupIntent
    
 
                         
    
                       
@@ -2364,7 +2364,7 @@ 
    Parameters
    
                               
                               
                                 
    
-                                  
    The client secret of the SetupIntent to be retrieved
    
+                                  
    The client secret of the SetupIntent to be retrieved.
    
                                 
    
                               
                             
@@ -2421,7 +2421,7 @@ 
    Declaration
    
                         
                         
    
                           
    Swift
    
-                          
    func cancelSetupIntent(_ intent: SCPSetupIntent) async throws -> SCPSetupIntent
    
+                          
    func cancelSetupIntent(_ intent: SCPSetupIntent) async throws -> SCPSetupIntent
    
 
                         
    
                       
@@ -2617,7 +2617,7 @@ 
    Declaration
    
                         
                         
    
                           
    Swift
    
-                          
    func confirmSetupIntent(_ setupIntent: SCPSetupIntent) async -> (SCPSetupIntent?, SCPConfirmSetupIntentError?)
    
+                          
    func confirmSetupIntent(_ setupIntent: SCPSetupIntent) async -> (SCPSetupIntent?, SCPConfirmSetupIntentError?)
    
 
                         
    
                       
@@ -2816,7 +2816,7 @@ 
    Declaration
    
                         
                         
    
                           
    Swift
    
-                          
    func processRefund() async -> (SCPRefund?, SCPProcessRefundError?)
    
+                          
    func processRefund() async -> (SCPRefund?, SCPProcessRefundError?)
    
 
                         
    
                       
@@ -2885,7 +2885,7 @@ 
    Declaration
    
                         
                         
    
                           
    Swift
    
-                          
    func clearReaderDisplay() async throws
    
+                          
    func clearReaderDisplay() async throws
    
 
                         
    
                       
@@ -2944,7 +2944,7 @@ 
    Declaration
    
                         
                         
    
                           
    Swift
    
-                          
    func setReaderDisplay(_ cart: Cart) async throws
    
+                          
    func setReaderDisplay(_ cart: Cart) async throws
    
 
                         
    
                       
@@ -3278,6 +3278,38 @@ 
    Declaration

    • +
  • + +
    +
    +
    +
    +
    +

    Returns an unlocalized string for the given capture method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSString *)stringFromCaptureMethod:(SCPCaptureMethod)captureMethod;
    + +
    +
    +

    Swift

    + 
    class func stringFromCaptureMethod(_ captureMethod: CaptureMethod) -> String
    + +
    +
    +
    +
    +
  • @@ -3348,7 +3380,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Classes/SCPTip.html b/docs/docs/Classes/SCPTip.html index d87c7b93..ffc2ce76 100644 --- a/docs/docs/Classes/SCPTip.html +++ b/docs/docs/Classes/SCPTip.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -540,7 +540,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Classes/SCPTippingConfiguration.html b/docs/docs/Classes/SCPTippingConfiguration.html index 01f92707..09b1b1ac 100644 --- a/docs/docs/Classes/SCPTippingConfiguration.html +++ b/docs/docs/Classes/SCPTippingConfiguration.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -580,7 +580,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPBatteryStatus.html b/docs/docs/Enums/SCPBatteryStatus.html index 7a2fa6fe..ebcce066 100644 --- a/docs/docs/Enums/SCPBatteryStatus.html +++ b/docs/docs/Enums/SCPBatteryStatus.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -562,7 +562,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPCaptureMethod.html b/docs/docs/Enums/SCPCaptureMethod.html index 4a438045..8ac8c405 100644 --- a/docs/docs/Enums/SCPCaptureMethod.html +++ b/docs/docs/Enums/SCPCaptureMethod.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -505,7 +505,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPCardBrand.html b/docs/docs/Enums/SCPCardBrand.html index c2099743..d408676b 100644 --- a/docs/docs/Enums/SCPCardBrand.html +++ b/docs/docs/Enums/SCPCardBrand.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -759,7 +759,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPCardFundingType.html b/docs/docs/Enums/SCPCardFundingType.html index f079f84d..694be8cc 100644 --- a/docs/docs/Enums/SCPCardFundingType.html +++ b/docs/docs/Enums/SCPCardFundingType.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -567,7 +567,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPCardPresentCaptureMethod.html b/docs/docs/Enums/SCPCardPresentCaptureMethod.html index ec744f3c..a62f6068 100644 --- a/docs/docs/Enums/SCPCardPresentCaptureMethod.html +++ b/docs/docs/Enums/SCPCardPresentCaptureMethod.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -467,7 +467,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPCardPresentRouting.html b/docs/docs/Enums/SCPCardPresentRouting.html index 9076b4fd..0b7e2508 100644 --- a/docs/docs/Enums/SCPCardPresentRouting.html +++ b/docs/docs/Enums/SCPCardPresentRouting.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -498,7 +498,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPChargeStatus.html b/docs/docs/Enums/SCPChargeStatus.html index e2ae167f..5143797b 100644 --- a/docs/docs/Enums/SCPChargeStatus.html +++ b/docs/docs/Enums/SCPChargeStatus.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -530,7 +530,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPConnectionStatus.html b/docs/docs/Enums/SCPConnectionStatus.html index 3c70a410..f23fe5d3 100644 --- a/docs/docs/Enums/SCPConnectionStatus.html +++ b/docs/docs/Enums/SCPConnectionStatus.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -535,7 +535,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPDeviceType.html b/docs/docs/Enums/SCPDeviceType.html index 495d6e14..4471c9e1 100644 --- a/docs/docs/Enums/SCPDeviceType.html +++ b/docs/docs/Enums/SCPDeviceType.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -757,7 +757,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPDiscoveryMethod.html b/docs/docs/Enums/SCPDiscoveryMethod.html index ae015fe8..087b7f7e 100644 --- a/docs/docs/Enums/SCPDiscoveryMethod.html +++ b/docs/docs/Enums/SCPDiscoveryMethod.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -628,7 +628,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPError.html b/docs/docs/Enums/SCPError.html index 79958271..d578f6cb 100644 --- a/docs/docs/Enums/SCPError.html +++ b/docs/docs/Enums/SCPError.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -3310,7 +3310,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPIncrementalAuthorizationStatus.html b/docs/docs/Enums/SCPIncrementalAuthorizationStatus.html index a1d20e81..d757f280 100644 --- a/docs/docs/Enums/SCPIncrementalAuthorizationStatus.html +++ b/docs/docs/Enums/SCPIncrementalAuthorizationStatus.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -536,7 +536,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPLocationStatus.html b/docs/docs/Enums/SCPLocationStatus.html index fd5ca1f3..682ae40d 100644 --- a/docs/docs/Enums/SCPLocationStatus.html +++ b/docs/docs/Enums/SCPLocationStatus.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -540,7 +540,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPLogLevel.html b/docs/docs/Enums/SCPLogLevel.html index a77cf154..e65b3157 100644 --- a/docs/docs/Enums/SCPLogLevel.html +++ b/docs/docs/Enums/SCPLogLevel.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -498,7 +498,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPPaymentIntentStatus.html b/docs/docs/Enums/SCPPaymentIntentStatus.html index 3f5367a6..5d0481ca 100644 --- a/docs/docs/Enums/SCPPaymentIntentStatus.html +++ b/docs/docs/Enums/SCPPaymentIntentStatus.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -628,7 +628,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPPaymentMethodType.html b/docs/docs/Enums/SCPPaymentMethodType.html index 022c9b11..66b1ed0a 100644 --- a/docs/docs/Enums/SCPPaymentMethodType.html +++ b/docs/docs/Enums/SCPPaymentMethodType.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -567,7 +567,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPPaymentStatus.html b/docs/docs/Enums/SCPPaymentStatus.html index 174d66a2..5b5fcd7b 100644 --- a/docs/docs/Enums/SCPPaymentStatus.html +++ b/docs/docs/Enums/SCPPaymentStatus.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -569,7 +569,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPReaderDisplayMessage.html b/docs/docs/Enums/SCPReaderDisplayMessage.html index 623c23e6..0933ea7a 100644 --- a/docs/docs/Enums/SCPReaderDisplayMessage.html +++ b/docs/docs/Enums/SCPReaderDisplayMessage.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -692,7 +692,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPReaderEvent.html b/docs/docs/Enums/SCPReaderEvent.html index 68ddfd60..35708369 100644 --- a/docs/docs/Enums/SCPReaderEvent.html +++ b/docs/docs/Enums/SCPReaderEvent.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -498,7 +498,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPReaderInputOptions.html b/docs/docs/Enums/SCPReaderInputOptions.html index e61d25d0..80a96d0d 100644 --- a/docs/docs/Enums/SCPReaderInputOptions.html +++ b/docs/docs/Enums/SCPReaderInputOptions.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -558,7 +558,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPReaderNetworkStatus.html b/docs/docs/Enums/SCPReaderNetworkStatus.html index 596969ef..d9700139 100644 --- a/docs/docs/Enums/SCPReaderNetworkStatus.html +++ b/docs/docs/Enums/SCPReaderNetworkStatus.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -504,7 +504,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPRefundStatus.html b/docs/docs/Enums/SCPRefundStatus.html index 69330ecb..3a66c318 100644 --- a/docs/docs/Enums/SCPRefundStatus.html +++ b/docs/docs/Enums/SCPRefundStatus.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -567,7 +567,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPSetupIntentStatus.html b/docs/docs/Enums/SCPSetupIntentStatus.html index dd777bbd..e31fef63 100644 --- a/docs/docs/Enums/SCPSetupIntentStatus.html +++ b/docs/docs/Enums/SCPSetupIntentStatus.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -634,7 +634,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPSetupIntentUsage.html b/docs/docs/Enums/SCPSetupIntentUsage.html index 4722c1d6..46f3b727 100644 --- a/docs/docs/Enums/SCPSetupIntentUsage.html +++ b/docs/docs/Enums/SCPSetupIntentUsage.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -510,7 +510,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPSimulateReaderUpdate.html b/docs/docs/Enums/SCPSimulateReaderUpdate.html index 43603e5f..91360cb3 100644 --- a/docs/docs/Enums/SCPSimulateReaderUpdate.html +++ b/docs/docs/Enums/SCPSimulateReaderUpdate.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -623,7 +623,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPSimulatedCardType.html b/docs/docs/Enums/SCPSimulatedCardType.html index 37fd200d..092d3a17 100644 --- a/docs/docs/Enums/SCPSimulatedCardType.html +++ b/docs/docs/Enums/SCPSimulatedCardType.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -911,6 +911,70 @@

    Declaration

    • +
  • + +
    +
    +
    +
    +
    +

    Eftpos Australia/Visa

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeEftposAuVisaDebit
    + +
    +
    +

    Swift

    + 
    case eftposAuVisaDebit = 15
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Eftpos Australia/Mastercard

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeEftposAuDebitMastercard
    + +
    +
    +

    Swift

    + 
    case eftposAuDebitMastercard = 16
    + +
    +
    +
    +
    +
  • @@ -936,7 +1000,7 @@

    Declaration

    Swift

    - 
    case chargeDeclined = 15
    + 
    case chargeDeclined = 17
    @@ -969,7 +1033,7 @@

    Declaration

    Swift

    - 
    case chargeDeclinedInsufficientFunds = 16
    + 
    case chargeDeclinedInsufficientFunds = 18
    @@ -1002,7 +1066,7 @@

    Declaration

    Swift

    - 
    case chargeDeclinedLostCard = 17
    + 
    case chargeDeclinedLostCard = 19
    @@ -1035,7 +1099,7 @@

    Declaration

    Swift

    - 
    case chargeDeclinedStolenCard = 18
    + 
    case chargeDeclinedStolenCard = 20
    @@ -1067,7 +1131,7 @@

    Declaration

    Swift

    - 
    case chargeDeclinedExpiredCard = 19
    + 
    case chargeDeclinedExpiredCard = 21
    @@ -1099,7 +1163,7 @@

    Declaration

    Swift

    - 
    case chargeDeclinedProcessingError = 20
    + 
    case chargeDeclinedProcessingError = 22
    @@ -1131,7 +1195,7 @@

    Declaration

    Swift

    - 
    case refundFailed = 21
    + 
    case refundFailed = 23
    @@ -1165,7 +1229,7 @@

    Declaration

    Swift

    - 
    case onlinePinCvm = 22
    + 
    case onlinePinCvm = 24
    @@ -1202,7 +1266,7 @@

    Declaration

    Swift

    - 
    case onlinePinScaRetry = 23
    + 
    case onlinePinScaRetry = 25
    @@ -1236,7 +1300,7 @@

    Declaration

    Swift

    - 
    case offlinePinCvm = 24
    + 
    case offlinePinCvm = 26
    @@ -1273,7 +1337,7 @@

    Declaration

    Swift

    - 
    case offlinePinScaRetry = 25
    + 
    case offlinePinScaRetry = 27
    @@ -1288,7 +1352,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPUpdateComponent.html b/docs/docs/Enums/SCPUpdateComponent.html index bfe1f1d6..187d0b98 100644 --- a/docs/docs/Enums/SCPUpdateComponent.html +++ b/docs/docs/Enums/SCPUpdateComponent.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -582,7 +582,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Enums/SCPUpdateTimeEstimate.html b/docs/docs/Enums/SCPUpdateTimeEstimate.html index cfb14431..9305f057 100644 --- a/docs/docs/Enums/SCPUpdateTimeEstimate.html +++ b/docs/docs/Enums/SCPUpdateTimeEstimate.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -572,7 +572,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Errors.html b/docs/docs/Errors.html index d7b357f8..44e7d31f 100644 --- a/docs/docs/Errors.html +++ b/docs/docs/Errors.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -957,7 +957,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Payment.html b/docs/docs/Payment.html index 54dedd32..67ae82e8 100644 --- a/docs/docs/Payment.html +++ b/docs/docs/Payment.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -1397,7 +1397,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Protocols/SCPBluetoothReaderDelegate.html b/docs/docs/Protocols/SCPBluetoothReaderDelegate.html index 95aa3375..d34121ac 100644 --- a/docs/docs/Protocols/SCPBluetoothReaderDelegate.html +++ b/docs/docs/Protocols/SCPBluetoothReaderDelegate.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -1128,7 +1128,7 @@

    Parameters

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Protocols/SCPConnectionTokenProvider.html b/docs/docs/Protocols/SCPConnectionTokenProvider.html index 82b24ece..4572eccc 100644 --- a/docs/docs/Protocols/SCPConnectionTokenProvider.html +++ b/docs/docs/Protocols/SCPConnectionTokenProvider.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -482,7 +482,7 @@

    Declaration

    Swift

    - 
    func fetchConnectionToken() async throws -> String
    + 
    func fetchConnectionToken() async throws -> String
    @@ -517,7 +517,7 @@

    Parameters

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Protocols/SCPDiscoveryDelegate.html b/docs/docs/Protocols/SCPDiscoveryDelegate.html index dcfbc7a8..5858a273 100644 --- a/docs/docs/Protocols/SCPDiscoveryDelegate.html +++ b/docs/docs/Protocols/SCPDiscoveryDelegate.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -545,7 +545,7 @@

    Parameters

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Protocols/SCPJSONDecodable.html b/docs/docs/Protocols/SCPJSONDecodable.html index d4b43c6f..5a5c39cc 100644 --- a/docs/docs/Protocols/SCPJSONDecodable.html +++ b/docs/docs/Protocols/SCPJSONDecodable.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -501,7 +501,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Protocols/SCPLocalMobileReaderDelegate.html b/docs/docs/Protocols/SCPLocalMobileReaderDelegate.html index f59a60ab..021f453e 100644 --- a/docs/docs/Protocols/SCPLocalMobileReaderDelegate.html +++ b/docs/docs/Protocols/SCPLocalMobileReaderDelegate.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -852,7 +852,7 @@

    Parameters

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Protocols/SCPReconnectionDelegate.html b/docs/docs/Protocols/SCPReconnectionDelegate.html index 88ad7e26..5c6cc982 100644 --- a/docs/docs/Protocols/SCPReconnectionDelegate.html +++ b/docs/docs/Protocols/SCPReconnectionDelegate.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -615,7 +615,7 @@

    Parameters

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Protocols/SCPTerminalDelegate.html b/docs/docs/Protocols/SCPTerminalDelegate.html index 123cffd8..659864e3 100644 --- a/docs/docs/Protocols/SCPTerminalDelegate.html +++ b/docs/docs/Protocols/SCPTerminalDelegate.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -646,7 +646,7 @@

    Parameters

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Reader Discovery & Connection.html b/docs/docs/Reader Discovery & Connection.html index 3bb475ba..5b3f7fd0 100644 --- a/docs/docs/Reader Discovery & Connection.html +++ b/docs/docs/Reader Discovery & Connection.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -1016,7 +1016,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Reader Updates.html b/docs/docs/Reader Updates.html index faf86075..9b5a9e44 100644 --- a/docs/docs/Reader Updates.html +++ b/docs/docs/Reader Updates.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -553,7 +553,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Reader.html b/docs/docs/Reader.html index 62f12083..d62be28f 100644 --- a/docs/docs/Reader.html +++ b/docs/docs/Reader.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -835,7 +835,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Saving Cards.html b/docs/docs/Saving Cards.html index 9f9b98d0..670b4327 100644 --- a/docs/docs/Saving Cards.html +++ b/docs/docs/Saving Cards.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -791,7 +791,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/Terminal.html b/docs/docs/Terminal.html index cb93a3a8..5bc370ad 100644 --- a/docs/docs/Terminal.html +++ b/docs/docs/Terminal.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -707,7 +707,7 @@

    Declaration

    Declaration

    Objective-C

    - 
    static NSString *const _Nonnull SCPSDKVersion = @"2.18.1"
    + 
    static NSString *const _Nonnull SCPSDKVersion = @"2.19.0"
    @@ -727,7 +727,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Blocks.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Blocks.html index 3456f97f..1ae50c86 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Blocks.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Blocks.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -1180,7 +1180,7 @@

    Parameters

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Card-Present Refunds.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Card-Present Refunds.html index 0e60fa59..8dfab0e8 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Card-Present Refunds.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Card-Present Refunds.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -593,7 +593,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPAddress.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPAddress.html index 48259030..1cc43df7 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPAddress.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPAddress.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -702,7 +702,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPAmountDetails.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPAmountDetails.html index 0429a39a..01e45108 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPAmountDetails.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPAmountDetails.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -528,7 +528,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPBluetoothConnectionConfiguration.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPBluetoothConnectionConfiguration.html index 59dd9cfd..8b1d745d 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPBluetoothConnectionConfiguration.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPBluetoothConnectionConfiguration.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -620,7 +620,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCancelable.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCancelable.html index d62824e0..12f88a0f 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCancelable.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCancelable.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -487,7 +487,7 @@

    Declaration

    Swift

    - 
    func cancel() async throws
    + 
    func cancel() async throws
    @@ -502,7 +502,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCardDetails.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCardDetails.html index 5f649dae..03455eea 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCardDetails.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCardDetails.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -699,7 +699,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCardPresentDetails.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCardPresentDetails.html index 683df915..1c726500 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCardPresentDetails.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCardPresentDetails.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -970,7 +970,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCardPresentParameters.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCardPresentParameters.html index b09a8665..9dead429 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCardPresentParameters.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCardPresentParameters.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -1335,7 +1335,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCart.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCart.html index cc570238..d75a2035 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCart.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCart.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -723,7 +723,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCartLineItem.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCartLineItem.html index b9416748..0e13cb38 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCartLineItem.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCartLineItem.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -618,7 +618,7 @@

    Parameters

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCharge.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCharge.html index 0ec9ace4..97b56c17 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCharge.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCharge.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -798,7 +798,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCollectConfiguration.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCollectConfiguration.html index 3a31050d..273cb8f0 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCollectConfiguration.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCollectConfiguration.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -563,7 +563,7 @@

    Declaration

    Swift

    - 
    convenience init(skipTipping: Bool)
    + 
    convenience init(skipTipping: Bool)
    @@ -614,7 +614,7 @@

    Declaration

    Swift

    - 
    convenience init(updatePaymentIntent: Bool)
    + 
    convenience init(updatePaymentIntent: Bool)
    @@ -666,7 +666,7 @@

    Declaration

    Swift

    - 
    convenience init(tippingConfiguration: SCPTippingConfiguration)
    + 
    convenience init(tippingConfiguration: SCPTippingConfiguration)
    @@ -718,7 +718,7 @@

    Declaration

    Swift

    - 
    convenience init(skipTipping: Bool, updatePaymentIntent: Bool)
    + 
    convenience init(skipTipping: Bool, updatePaymentIntent: Bool)
    @@ -783,7 +783,7 @@

    Declaration

    Swift

    - 
    convenience init(skipTipping: Bool, tippingConfiguration: SCPTippingConfiguration?)
    + 
    convenience init(skipTipping: Bool, tippingConfiguration: SCPTippingConfiguration?)
    @@ -849,7 +849,7 @@

    Declaration

    Swift

    - 
    convenience init(updatePaymentIntent: Bool, tippingConfiguration: SCPTippingConfiguration?)
    + 
    convenience init(updatePaymentIntent: Bool, tippingConfiguration: SCPTippingConfiguration?)
    @@ -1035,7 +1035,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPConfirmSetupIntentError.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPConfirmSetupIntentError.html index 234661d3..41bf695c 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPConfirmSetupIntentError.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPConfirmSetupIntentError.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -595,7 +595,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPDiscoveryConfiguration.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPDiscoveryConfiguration.html index 1608a2a2..854a42e2 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPDiscoveryConfiguration.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPDiscoveryConfiguration.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -804,7 +804,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPInternetConnectionConfiguration.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPInternetConnectionConfiguration.html index 73eea45a..7f83eca2 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPInternetConnectionConfiguration.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPInternetConnectionConfiguration.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -624,7 +624,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPListLocationsParameters.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPListLocationsParameters.html index 5026aa28..334e6957 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPListLocationsParameters.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPListLocationsParameters.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -641,7 +641,7 @@

    Parameters

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPLocalMobileConnectionConfiguration.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPLocalMobileConnectionConfiguration.html index adc818a0..04b672f2 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPLocalMobileConnectionConfiguration.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPLocalMobileConnectionConfiguration.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -610,7 +610,7 @@

    Declaration

    Swift

    - 
    convenience init(locationId: String)
    + 
    convenience init(locationId: String)
    @@ -669,7 +669,7 @@

    Declaration

    Swift

    - 
    convenience init(locationId: String, merchantDisplayName: String?, onBehalfOf: String?)
    + 
    convenience init(locationId: String, merchantDisplayName: String?, onBehalfOf: String?)
    @@ -829,7 +829,7 @@

    Parameters

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPLocation.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPLocation.html index 95ed9221..08d41ac9 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPLocation.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPLocation.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -680,7 +680,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPNetworks.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPNetworks.html index 8ee05d0b..930d0cb4 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPNetworks.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPNetworks.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -535,7 +535,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentIntent.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentIntent.html index 921dcf86..a05eba8c 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentIntent.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentIntent.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -569,6 +569,38 @@

    Declaration

    • +
  • +
    + + + + captureMethod + +
    +
    +
    +
    +
    +
    +

    Controls when the funds will be captured from the customer’s account.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly) SCPCaptureMethod captureMethod;
    + +
    +
    +

    Swift

    + 
    var captureMethod: CaptureMethod { get }
    + +
    +
    +
    +
    +
  • @@ -921,7 +953,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentIntentParameters.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentIntentParameters.html index 72eb9c88..85be4f22 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentIntentParameters.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentIntentParameters.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -1478,7 +1478,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentMethod.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentMethod.html index 35a94012..0cc3a9cd 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentMethod.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentMethod.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -770,7 +770,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentMethodDetails.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentMethodDetails.html index c404b2d1..47f84137 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentMethodDetails.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentMethodDetails.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -576,7 +576,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentMethodOptionsParameters.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentMethodOptionsParameters.html index 8e41abc1..f4b01067 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentMethodOptionsParameters.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentMethodOptionsParameters.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -555,7 +555,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPProcessPaymentError.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPProcessPaymentError.html index dc2c11ee..dbe0e5b2 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPProcessPaymentError.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPProcessPaymentError.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -616,7 +616,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPProcessRefundError.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPProcessRefundError.html index 5e8eaf8e..fbdca4ef 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPProcessRefundError.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPProcessRefundError.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -573,7 +573,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReadReusableCardParameters.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReadReusableCardParameters.html index dc92efab..ee8243fb 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReadReusableCardParameters.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReadReusableCardParameters.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -523,7 +523,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReader.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReader.html index 0cf718ce..32b7bf17 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReader.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReader.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -1095,7 +1095,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReaderSoftwareUpdate.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReaderSoftwareUpdate.html index 48b9a690..c77821cb 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReaderSoftwareUpdate.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReaderSoftwareUpdate.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -674,7 +674,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReceiptDetails.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReceiptDetails.html index fb1fb0f2..ecc9a2d0 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReceiptDetails.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPReceiptDetails.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -528,6 +528,38 @@

    Declaration

    • +
  • +
    + + + + authorizationCode + +
    +
    +
    +
    +
    +
    +

    Identifier for this transaction

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, readonly, nullable) NSString *authorizationCode;
    + +
    +
    +

    Swift

    + 
    var authorizationCode: String? { get }
    + +
    +
    +
    +
    +
  • @@ -726,7 +758,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPRefund.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPRefund.html index c0ba6e9d..9ac10c01 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPRefund.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPRefund.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -846,7 +846,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPRefundParameters.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPRefundParameters.html index 7b6b86d0..3336fc40 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPRefundParameters.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPRefundParameters.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -810,7 +810,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupAttempt.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupAttempt.html index 5decd2e1..5d2a7650 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupAttempt.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupAttempt.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -732,7 +732,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupAttemptCardPresentDetails.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupAttemptCardPresentDetails.html index 23c811b9..3ed97167 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupAttemptCardPresentDetails.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupAttemptCardPresentDetails.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -567,7 +567,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupAttemptPaymentMethodDetails.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupAttemptPaymentMethodDetails.html index 7090350d..2c61e973 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupAttemptPaymentMethodDetails.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupAttemptPaymentMethodDetails.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -576,7 +576,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupIntent.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupIntent.html index 1ee67bd8..f265e94b 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupIntent.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupIntent.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -737,7 +737,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupIntentParameters.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupIntentParameters.html index eaf4d573..9b5e65b8 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupIntentParameters.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSetupIntentParameters.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -762,7 +762,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSimulatedCard.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSimulatedCard.html index 832d3ad4..c048b926 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSimulatedCard.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSimulatedCard.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -650,7 +650,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSimulatorConfiguration.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSimulatorConfiguration.html index bb6fac2c..5de8a38b 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSimulatorConfiguration.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSimulatorConfiguration.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -513,6 +513,39 @@

    Declaration

    • +
  • +
    + + + + simulatedTipAmount + +
    +
    +
    +
    +
    +
    +

    Set this to simulate a Terminal configuration object with this fixed tip +amount for all currencies.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (nonatomic, nullable) NSNumber *simulatedTipAmount;
    + +
    +
    +

    Swift

    + 
    var simulatedTipAmount: NSNumber? { get set }
    + +
    +
    +
    +
    +
  • @@ -585,7 +618,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTerminal.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTerminal.html index 8683a818..2774e155 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTerminal.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTerminal.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -1140,7 +1140,7 @@

    Declaration

    Swift

    - 
    func connectBluetoothReader(_ reader: SCPReader, delegate: BluetoothReaderDelegate, connectionConfig: SCPBluetoothConnectionConfiguration) async throws -> SCPReader
    + 
    func connectBluetoothReader(_ reader: SCPReader, delegate: BluetoothReaderDelegate, connectionConfig: SCPBluetoothConnectionConfiguration) async throws -> SCPReader
    @@ -1257,7 +1257,7 @@

    Declaration

    Swift

    - 
    func connectInternetReader(_ reader: SCPReader, connectionConfig: SCPInternetConnectionConfiguration?) async throws -> SCPReader
    + 
    func connectInternetReader(_ reader: SCPReader, connectionConfig: SCPInternetConnectionConfiguration?) async throws -> SCPReader
    @@ -1371,7 +1371,7 @@

    Declaration

    Swift

    - 
    func connectLocalMobileReader(_ reader: SCPReader, delegate: LocalMobileReaderDelegate, connectionConfig: SCPLocalMobileConnectionConfiguration) async throws -> SCPReader
    + 
    func connectLocalMobileReader(_ reader: SCPReader, delegate: LocalMobileReaderDelegate, connectionConfig: SCPLocalMobileConnectionConfiguration) async throws -> SCPReader
    @@ -1470,7 +1470,7 @@

    Declaration

    Swift

    - 
    func listLocations(parameters: SCPListLocationsParameters?) async throws -> ([SCPLocation], Bool)
    + 
    func listLocations(parameters: SCPListLocationsParameters?) async throws -> ([SCPLocation], Bool)
    @@ -1609,7 +1609,7 @@

    Declaration

    Swift

    - 
    func disconnectReader() async throws
    + 
    func disconnectReader() async throws
    @@ -1666,7 +1666,7 @@

    Taking payments

    Note: If the information required to create a PaymentIntent isn’t readily available in your app, you can create the PaymentIntent on your server and use the retrievePaymentIntent method to retrieve the PaymentIntent in your app.

    -
    - note: This cannot be used with the Verifone P400. If used with the
+
    - - note: This cannot be used with the Verifone P400. If used with the
 Verifone P400, the completion handler will be called with
 an SCPErrorFeatureNotAvailableWithConnectedReader error.
 
    
@@ -1687,7 +1687,7 @@ 
    Declaration
    
                         
                         
    
                           
    Swift
    
-                          
    func createPaymentIntent(_ parameters: SCPPaymentIntentParameters) async throws -> PaymentIntent
    
+                          
    func createPaymentIntent(_ parameters: PaymentIntentParameters) async throws -> PaymentIntent
    
 
                         
    
                       
@@ -1761,7 +1761,7 @@ 
    Declaration
    
                         
                         
    
                           
    Swift
    
-                          
    func retrievePaymentIntent(clientSecret: String) async throws -> PaymentIntent
    
+                          
    func retrievePaymentIntent(clientSecret: String) async throws -> PaymentIntent
    
 
                         
    
                       
@@ -2024,7 +2024,7 @@ 
    Declaration
    
                         
                         
    
                           
    Swift
    
-                          
    func processPayment(_ paymentIntent: PaymentIntent) async -> (PaymentIntent?, SCPProcessPaymentError?)
    
+                          
    func processPayment(_ paymentIntent: PaymentIntent) async -> (PaymentIntent?, SCPProcessPaymentError?)
    
 
                         
    
                       
@@ -2103,7 +2103,7 @@ 
    Declaration
    
                         
                         
    
                           
    Swift
    
-                          
    func cancelPaymentIntent(_ paymentIntent: PaymentIntent) async throws -> PaymentIntent
    
+                          
    func cancelPaymentIntent(_ paymentIntent: PaymentIntent) async throws -> PaymentIntent
    
 
                         
    
                       
@@ -2281,7 +2281,7 @@ 
    Declaration
    
                         
                         
    
                           
    Swift
    
-                          
    func createSetupIntent(_ setupIntentParams: SCPSetupIntentParameters) async throws -> SCPSetupIntent
    
+                          
    func createSetupIntent(_ setupIntentParams: SCPSetupIntentParameters) async throws -> SCPSetupIntent
    
 
                         
    
                       
@@ -2297,7 +2297,7 @@ 
    Parameters
    
                               
                               
                                 
    
-                                  
    The parameters that control the creation of the SetupIntent
    
+                                  
    The parameters that control the creation of the SetupIntent.
    
                                 
    
                               
                             
@@ -2309,7 +2309,7 @@ 
    Parameters
    
                               
                               
                                 
    
-                                  
    The compltion block called when the command completes
    
+                                  
    The completion block called when the command completes.
    
                                 
    
                               
                             
@@ -2348,7 +2348,7 @@ 
    Declaration
    
                         
                         
    
                           
    Swift
    
-                          
    func retrieveSetupIntent(clientSecret: String) async throws -> SCPSetupIntent
    
+                          
    func retrieveSetupIntent(clientSecret: String) async throws -> SCPSetupIntent
    
 
                         
    
                       
@@ -2364,7 +2364,7 @@ 
    Parameters
    
                               
                               
                                 
    
-                                  
    The client secret of the SetupIntent to be retrieved
    
+                                  
    The client secret of the SetupIntent to be retrieved.
    
                                 
    
                               
                             
@@ -2421,7 +2421,7 @@ 
    Declaration
    
                         
                         
    
                           
    Swift
    
-                          
    func cancelSetupIntent(_ intent: SCPSetupIntent) async throws -> SCPSetupIntent
    
+                          
    func cancelSetupIntent(_ intent: SCPSetupIntent) async throws -> SCPSetupIntent
    
 
                         
    
                       
@@ -2617,7 +2617,7 @@ 
    Declaration
    
                         
                         
    
                           
    Swift
    
-                          
    func confirmSetupIntent(_ setupIntent: SCPSetupIntent) async -> (SCPSetupIntent?, SCPConfirmSetupIntentError?)
    
+                          
    func confirmSetupIntent(_ setupIntent: SCPSetupIntent) async -> (SCPSetupIntent?, SCPConfirmSetupIntentError?)
    
 
                         
    
                       
@@ -2816,7 +2816,7 @@ 
    Declaration
    
                         
                         
    
                           
    Swift
    
-                          
    func processRefund() async -> (SCPRefund?, SCPProcessRefundError?)
    
+                          
    func processRefund() async -> (SCPRefund?, SCPProcessRefundError?)
    
 
                         
    
                       
@@ -2885,7 +2885,7 @@ 
    Declaration
    
                         
                         
    
                           
    Swift
    
-                          
    func clearReaderDisplay() async throws
    
+                          
    func clearReaderDisplay() async throws
    
 
                         
    
                       
@@ -2944,7 +2944,7 @@ 
    Declaration
    
                         
                         
    
                           
    Swift
    
-                          
    func setReaderDisplay(_ cart: Cart) async throws
    
+                          
    func setReaderDisplay(_ cart: Cart) async throws
    
 
                         
    
                       
@@ -3278,6 +3278,38 @@ 
    Declaration

    • +
  • + +
    +
    +
    +
    +
    +

    Returns an unlocalized string for the given capture method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSString *)stringFromCaptureMethod:(SCPCaptureMethod)captureMethod;
    + +
    +
    +

    Swift

    + 
    class func stringFromCaptureMethod(_ captureMethod: CaptureMethod) -> String
    + +
    +
    +
    +
    +
  • @@ -3348,7 +3380,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTip.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTip.html index d87c7b93..ffc2ce76 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTip.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTip.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -540,7 +540,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTippingConfiguration.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTippingConfiguration.html index 01f92707..09b1b1ac 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTippingConfiguration.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTippingConfiguration.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -580,7 +580,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPBatteryStatus.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPBatteryStatus.html index 7a2fa6fe..ebcce066 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPBatteryStatus.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPBatteryStatus.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -562,7 +562,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCaptureMethod.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCaptureMethod.html index 4a438045..8ac8c405 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCaptureMethod.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCaptureMethod.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -505,7 +505,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardBrand.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardBrand.html index c2099743..d408676b 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardBrand.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardBrand.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -759,7 +759,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardFundingType.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardFundingType.html index f079f84d..694be8cc 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardFundingType.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardFundingType.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -567,7 +567,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardPresentCaptureMethod.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardPresentCaptureMethod.html index ec744f3c..a62f6068 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardPresentCaptureMethod.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardPresentCaptureMethod.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -467,7 +467,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardPresentRouting.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardPresentRouting.html index 9076b4fd..0b7e2508 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardPresentRouting.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPCardPresentRouting.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -498,7 +498,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPChargeStatus.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPChargeStatus.html index e2ae167f..5143797b 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPChargeStatus.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPChargeStatus.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -530,7 +530,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPConnectionStatus.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPConnectionStatus.html index 3c70a410..f23fe5d3 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPConnectionStatus.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPConnectionStatus.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -535,7 +535,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPDeviceType.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPDeviceType.html index 495d6e14..4471c9e1 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPDeviceType.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPDeviceType.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -757,7 +757,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPDiscoveryMethod.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPDiscoveryMethod.html index ae015fe8..087b7f7e 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPDiscoveryMethod.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPDiscoveryMethod.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -628,7 +628,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPError.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPError.html index 79958271..d578f6cb 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPError.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPError.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -3310,7 +3310,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPIncrementalAuthorizationStatus.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPIncrementalAuthorizationStatus.html index a1d20e81..d757f280 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPIncrementalAuthorizationStatus.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPIncrementalAuthorizationStatus.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -536,7 +536,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPLocationStatus.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPLocationStatus.html index fd5ca1f3..682ae40d 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPLocationStatus.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPLocationStatus.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -540,7 +540,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPLogLevel.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPLogLevel.html index a77cf154..e65b3157 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPLogLevel.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPLogLevel.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -498,7 +498,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPPaymentIntentStatus.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPPaymentIntentStatus.html index 3f5367a6..5d0481ca 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPPaymentIntentStatus.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPPaymentIntentStatus.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -628,7 +628,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPPaymentMethodType.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPPaymentMethodType.html index 022c9b11..66b1ed0a 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPPaymentMethodType.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPPaymentMethodType.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -567,7 +567,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPPaymentStatus.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPPaymentStatus.html index 174d66a2..5b5fcd7b 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPPaymentStatus.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPPaymentStatus.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -569,7 +569,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderDisplayMessage.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderDisplayMessage.html index 623c23e6..0933ea7a 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderDisplayMessage.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderDisplayMessage.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -692,7 +692,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderEvent.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderEvent.html index 68ddfd60..35708369 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderEvent.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderEvent.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -498,7 +498,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderInputOptions.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderInputOptions.html index e61d25d0..80a96d0d 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderInputOptions.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderInputOptions.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -558,7 +558,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderNetworkStatus.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderNetworkStatus.html index 596969ef..d9700139 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderNetworkStatus.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPReaderNetworkStatus.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -504,7 +504,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPRefundStatus.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPRefundStatus.html index 69330ecb..3a66c318 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPRefundStatus.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPRefundStatus.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -567,7 +567,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSetupIntentStatus.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSetupIntentStatus.html index dd777bbd..e31fef63 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSetupIntentStatus.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSetupIntentStatus.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -634,7 +634,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSetupIntentUsage.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSetupIntentUsage.html index 4722c1d6..46f3b727 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSetupIntentUsage.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSetupIntentUsage.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -510,7 +510,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSimulateReaderUpdate.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSimulateReaderUpdate.html index 43603e5f..91360cb3 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSimulateReaderUpdate.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSimulateReaderUpdate.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -623,7 +623,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSimulatedCardType.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSimulatedCardType.html index 37fd200d..092d3a17 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSimulatedCardType.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPSimulatedCardType.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -911,6 +911,70 @@

    Declaration

    • +
  • + +
    +
    +
    +
    +
    +

    Eftpos Australia/Visa

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeEftposAuVisaDebit
    + +
    +
    +

    Swift

    + 
    case eftposAuVisaDebit = 15
    + +
    +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Eftpos Australia/Mastercard

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    SCPSimulatedCardTypeEftposAuDebitMastercard
    + +
    +
    +

    Swift

    + 
    case eftposAuDebitMastercard = 16
    + +
    +
    +
    +
    +
  • @@ -936,7 +1000,7 @@

    Declaration

    Swift

    - 
    case chargeDeclined = 15
    + 
    case chargeDeclined = 17
    @@ -969,7 +1033,7 @@

    Declaration

    Swift

    - 
    case chargeDeclinedInsufficientFunds = 16
    + 
    case chargeDeclinedInsufficientFunds = 18
    @@ -1002,7 +1066,7 @@

    Declaration

    Swift

    - 
    case chargeDeclinedLostCard = 17
    + 
    case chargeDeclinedLostCard = 19
    @@ -1035,7 +1099,7 @@

    Declaration

    Swift

    - 
    case chargeDeclinedStolenCard = 18
    + 
    case chargeDeclinedStolenCard = 20
    @@ -1067,7 +1131,7 @@

    Declaration

    Swift

    - 
    case chargeDeclinedExpiredCard = 19
    + 
    case chargeDeclinedExpiredCard = 21
    @@ -1099,7 +1163,7 @@

    Declaration

    Swift

    - 
    case chargeDeclinedProcessingError = 20
    + 
    case chargeDeclinedProcessingError = 22
    @@ -1131,7 +1195,7 @@

    Declaration

    Swift

    - 
    case refundFailed = 21
    + 
    case refundFailed = 23
    @@ -1165,7 +1229,7 @@

    Declaration

    Swift

    - 
    case onlinePinCvm = 22
    + 
    case onlinePinCvm = 24
    @@ -1202,7 +1266,7 @@

    Declaration

    Swift

    - 
    case onlinePinScaRetry = 23
    + 
    case onlinePinScaRetry = 25
    @@ -1236,7 +1300,7 @@

    Declaration

    Swift

    - 
    case offlinePinCvm = 24
    + 
    case offlinePinCvm = 26
    @@ -1273,7 +1337,7 @@

    Declaration

    Swift

    - 
    case offlinePinScaRetry = 25
    + 
    case offlinePinScaRetry = 27
    @@ -1288,7 +1352,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPUpdateComponent.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPUpdateComponent.html index bfe1f1d6..187d0b98 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPUpdateComponent.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPUpdateComponent.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -582,7 +582,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPUpdateTimeEstimate.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPUpdateTimeEstimate.html index cfb14431..9305f057 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPUpdateTimeEstimate.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPUpdateTimeEstimate.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -572,7 +572,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Errors.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Errors.html index d7b357f8..44e7d31f 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Errors.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Errors.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -957,7 +957,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Payment.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Payment.html index 54dedd32..67ae82e8 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Payment.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Payment.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -1397,7 +1397,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPBluetoothReaderDelegate.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPBluetoothReaderDelegate.html index 95aa3375..d34121ac 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPBluetoothReaderDelegate.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPBluetoothReaderDelegate.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -1128,7 +1128,7 @@

    Parameters

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPConnectionTokenProvider.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPConnectionTokenProvider.html index 82b24ece..4572eccc 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPConnectionTokenProvider.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPConnectionTokenProvider.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -482,7 +482,7 @@

    Declaration

    Swift

    - 
    func fetchConnectionToken() async throws -> String
    + 
    func fetchConnectionToken() async throws -> String
    @@ -517,7 +517,7 @@

    Parameters

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPDiscoveryDelegate.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPDiscoveryDelegate.html index dcfbc7a8..5858a273 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPDiscoveryDelegate.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPDiscoveryDelegate.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -545,7 +545,7 @@

    Parameters

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPJSONDecodable.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPJSONDecodable.html index d4b43c6f..5a5c39cc 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPJSONDecodable.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPJSONDecodable.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -501,7 +501,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPLocalMobileReaderDelegate.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPLocalMobileReaderDelegate.html index f59a60ab..021f453e 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPLocalMobileReaderDelegate.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPLocalMobileReaderDelegate.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -852,7 +852,7 @@

    Parameters

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPReconnectionDelegate.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPReconnectionDelegate.html index 88ad7e26..5c6cc982 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPReconnectionDelegate.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPReconnectionDelegate.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -615,7 +615,7 @@

    Parameters

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPTerminalDelegate.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPTerminalDelegate.html index 123cffd8..659864e3 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPTerminalDelegate.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPTerminalDelegate.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -646,7 +646,7 @@

    Parameters

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Reader Discovery & Connection.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Reader Discovery & Connection.html index 3bb475ba..5b3f7fd0 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Reader Discovery & Connection.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Reader Discovery & Connection.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -1016,7 +1016,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Reader Updates.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Reader Updates.html index faf86075..9b5a9e44 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Reader Updates.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Reader Updates.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -553,7 +553,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Reader.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Reader.html index 62f12083..d62be28f 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Reader.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Reader.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -835,7 +835,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Saving Cards.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Saving Cards.html index 9f9b98d0..670b4327 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Saving Cards.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Saving Cards.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -791,7 +791,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Terminal.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Terminal.html index cb93a3a8..5bc370ad 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Terminal.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Terminal.html @@ -21,7 +21,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -707,7 +707,7 @@

    Declaration

    Declaration

    Objective-C

    - 
    static NSString *const _Nonnull SCPSDKVersion = @"2.18.1"
    + 
    static NSString *const _Nonnull SCPSDKVersion = @"2.19.0"
    @@ -727,7 +727,7 @@

    Declaration

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/index.html b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/index.html index 5505a897..46c00a9f 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/index.html +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/index.html @@ -20,7 +20,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -523,7 +523,7 @@

    Previous API References

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/search.json b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/search.json index 323a4709..35e53f3c 100644 --- a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/search.json +++ b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/search.json @@ -1 +1 @@ -{"Blocks.html#/c:SCPBlocks.h@T@SCPConnectionTokenCompletionBlock":{"name":"SCPConnectionTokenCompletionBlock","abstract":"

    A block called with a connection token or an error from your backend.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPErrorCompletionBlock":{"name":"SCPErrorCompletionBlock","abstract":"

    A block called with an optional error.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPLogListenerBlock":{"name":"SCPLogListenerBlock","abstract":"

    A block called with a logline from the SDK.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPPaymentIntentCompletionBlock":{"name":"SCPPaymentIntentCompletionBlock","abstract":"

    A block called with a PaymentIntent or an error.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPPaymentMethodCompletionBlock":{"name":"SCPPaymentMethodCompletionBlock","abstract":"

    A block called with a PaymentMethod.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPProcessPaymentCompletionBlock":{"name":"SCPProcessPaymentCompletionBlock","abstract":"

    A block called with a PaymentIntent or a ProcessPaymentError

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPReaderCompletionBlock":{"name":"SCPReaderCompletionBlock","abstract":"

    A block called with a reader object or an error.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPProcessRefundCompletionBlock":{"name":"SCPProcessRefundCompletionBlock","abstract":"

    A block called with a Refund or a ProcessRefundError.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPConfirmSetupIntentCompletionBlock":{"name":"SCPConfirmSetupIntentCompletionBlock","abstract":"

    A block called with a SetupIntent or a ConfirmSetupIntentError.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPLocationsCompletionBlock":{"name":"SCPLocationsCompletionBlock","abstract":"

    A block called with a list of Locations or an error.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPRefundCompletionBlock":{"name":"SCPRefundCompletionBlock","abstract":"

    A block called with a Refund or an error.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPSetupIntentCompletionBlock":{"name":"SCPSetupIntentCompletionBlock","abstract":"

    A block called with a SetupIntent or an error.

    "},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBusy":{"name":"SCPErrorBusy","abstract":"

    The SDK is busy executing another command. The SDK can only execute a","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCancelFailedAlreadyCompleted":{"name":"SCPErrorCancelFailedAlreadyCompleted","abstract":"

    Canceling a command failed because the command already completed.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNotConnectedToReader":{"name":"SCPErrorNotConnectedToReader","abstract":"

    No reader is connected. Connect to a reader before trying again.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAlreadyConnectedToReader":{"name":"SCPErrorAlreadyConnectedToReader","abstract":"

    Already connected to a reader.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorConnectionTokenProviderCompletedWithNothing":{"name":"SCPErrorConnectionTokenProviderCompletedWithNothing","abstract":"

    Your implementation of fetchConnectionToken called the completion block","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorProcessInvalidPaymentIntent":{"name":"SCPErrorProcessInvalidPaymentIntent","abstract":"

    processPayment was called with an unknown or invalid PaymentIntent.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNilPaymentIntent":{"name":"SCPErrorNilPaymentIntent","abstract":"

    collectPaymentMethod or processPayment was called with a nil PaymentIntent.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNilSetupIntent":{"name":"SCPErrorNilSetupIntent","abstract":"

    collectSetupIntentPaymentMethod or processSetupIntent was called with","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNilRefundPaymentMethod":{"name":"SCPErrorNilRefundPaymentMethod","abstract":"

    processRefund was called without calling collectRefundPaymentMethod","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidRefundParameters":{"name":"SCPErrorInvalidRefundParameters","abstract":"

    The RefundParameters object has invalid values. The Charge ID (ch_123abc)","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidClientSecret":{"name":"SCPErrorInvalidClientSecret","abstract":"

    A PaymentIntent or SetupIntent was referenced using an invalid client secret.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorMustBeDiscoveringToConnect":{"name":"SCPErrorMustBeDiscoveringToConnect","abstract":"

    The SDK must be actively Discovering Readers in order to successfully","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCannotConnectToUndiscoveredReader":{"name":"SCPErrorCannotConnectToUndiscoveredReader","abstract":"

    Before connecting to a reader, it must have already been discovered in the","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidDiscoveryConfiguration":{"name":"SCPErrorInvalidDiscoveryConfiguration","abstract":"

    discoverReaders was called using an invalid SCPDiscoveryConfiguration.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidReaderForUpdate":{"name":"SCPErrorInvalidReaderForUpdate","abstract":"

    installUpdate was passed an update that is for a different reader. Updates can only","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnsupportedSDK":{"name":"SCPErrorUnsupportedSDK","abstract":"

    -[SCPTerminal connectReader:completion:] was called from an unsupported version","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorFeatureNotAvailableWithConnectedReader":{"name":"SCPErrorFeatureNotAvailableWithConnectedReader","abstract":"

    This feature is currently not available for the selected reader.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorFeatureNotAvailable":{"name":"SCPErrorFeatureNotAvailable","abstract":"

    This feature is not currently available.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidListLocationsLimitParameter":{"name":"SCPErrorInvalidListLocationsLimitParameter","abstract":"

    The ListLocationsParameters object has invalid values.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothConnectionInvalidLocationIdParameter":{"name":"SCPErrorBluetoothConnectionInvalidLocationIdParameter","abstract":"

    The locationId parameter to BluetoothConnectionConfiguration is required but a valid one was not provided.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidRequiredParameter":{"name":"SCPErrorInvalidRequiredParameter","abstract":"

    A required parameter was invalid or missing.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderConnectionConfigurationInvalid":{"name":"SCPErrorReaderConnectionConfigurationInvalid","abstract":"

    An invalid ConnectionConfiguration was passed through connect.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderTippingParameterInvalid":{"name":"SCPErrorReaderTippingParameterInvalid","abstract":"

    An invalid usage of eligibleAmount or skipTipping was passed into collect.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidLocationIdParameter":{"name":"SCPErrorInvalidLocationIdParameter","abstract":"

    The provided location ID parameter was invalid.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCanceled":{"name":"SCPErrorCanceled","abstract":"

    The command was canceled by your app.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorLocationServicesDisabled":{"name":"SCPErrorLocationServicesDisabled","abstract":"

    Access to location services is currently disabled. This may be because:

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothDisabled":{"name":"SCPErrorBluetoothDisabled","abstract":"

    This error indicates that Bluetooth is turned off, and the user should use","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothAccessDenied":{"name":"SCPErrorBluetoothAccessDenied","abstract":"

    Bluetooth is turned on on the device, but access to Bluetooth has been denied","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothScanTimedOut":{"name":"SCPErrorBluetoothScanTimedOut","abstract":"

    Scanning for bluetooth devices timed out.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothLowEnergyUnsupported":{"name":"SCPErrorBluetoothLowEnergyUnsupported","abstract":"

    Bluetooth Low Energy is unsupported on this iOS device. Use a different","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedBatteryLow":{"name":"SCPErrorReaderSoftwareUpdateFailedBatteryLow","abstract":"

    Updating the reader software failed because the reader’s battery is","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedInterrupted":{"name":"SCPErrorReaderSoftwareUpdateFailedInterrupted","abstract":"

    Updating the reader software failed because the update was interrupted.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedExpiredUpdate":{"name":"SCPErrorReaderSoftwareUpdateFailedExpiredUpdate","abstract":"

    Updating the reader software failed because the update has expired. Please disconnect and","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothConnectionFailedBatteryCriticallyLow":{"name":"SCPErrorBluetoothConnectionFailedBatteryCriticallyLow","abstract":"

    The reader has a critically low battery and cannot connect to the","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardInsertNotRead":{"name":"SCPErrorCardInsertNotRead","abstract":"

    The card is not a chip card.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardSwipeNotRead":{"name":"SCPErrorCardSwipeNotRead","abstract":"

    The swipe could not be read.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardReadTimedOut":{"name":"SCPErrorCardReadTimedOut","abstract":"

    Reading a card timed out.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardRemoved":{"name":"SCPErrorCardRemoved","abstract":"

    The card was removed during the transaction.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardLeftInReader":{"name":"SCPErrorCardLeftInReader","abstract":"

    A card can only be used for one transaction, and must be removed after","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorMissingEMVData":{"name":"SCPErrorMissingEMVData","abstract":"

    The reader failed to read the data from the presented payment method. If you encounter","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCommandNotAllowed":{"name":"SCPErrorCommandNotAllowed","abstract":"

    The command was not permitted to execute by the operating system.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnsupportedMobileDeviceConfiguration":{"name":"SCPErrorUnsupportedMobileDeviceConfiguration","abstract":"

    The mobile device on which the app is running is in an unsupported","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorPasscodeNotEnabled":{"name":"SCPErrorPasscodeNotEnabled","abstract":"

    The mobile device on which the app is running must have a passcode set.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCommandNotAllowedDuringCall":{"name":"SCPErrorCommandNotAllowedDuringCall","abstract":"

    The card reader cannot be used while a phone call is active.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidAmount":{"name":"SCPErrorInvalidAmount","abstract":"

    An attempt was made to charge an amount not supported by the reader.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidCurrency":{"name":"SCPErrorInvalidCurrency","abstract":"

    An attempt was made to charge an amount in a currency not supported by the reader.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderTOSAcceptanceRequiresiCloudSignIn":{"name":"SCPErrorAppleBuiltInReaderTOSAcceptanceRequiresiCloudSignIn","abstract":"

    Failed to accept reader-specific terms of service because there is no iCloud","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderTOSAcceptanceCanceled":{"name":"SCPErrorAppleBuiltInReaderTOSAcceptanceCanceled","abstract":"

    The user cancelled reader-specific terms of service acceptance.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderBusy":{"name":"SCPErrorReaderBusy","abstract":"

    The reader is busy.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorIncompatibleReader":{"name":"SCPErrorIncompatibleReader","abstract":"

    An incompatible reader was detected. You can only use the Stripe Terminal","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderCommunicationError":{"name":"SCPErrorReaderCommunicationError","abstract":"

    Could not communicate with the reader.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNFCDisabled":{"name":"SCPErrorNFCDisabled","abstract":"

    NFC functionality is disabled.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothError":{"name":"SCPErrorBluetoothError","abstract":"

    Generic Bluetooth error.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothConnectTimedOut":{"name":"SCPErrorBluetoothConnectTimedOut","abstract":"

    Connecting to the bluetooth device timed out. Make sure the device is","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothDisconnected":{"name":"SCPErrorBluetoothDisconnected","abstract":"

    The Bluetooth device was disconnected unexpectedly.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothPeerRemovedPairingInformation":{"name":"SCPErrorBluetoothPeerRemovedPairingInformation","abstract":"

    Bluetooth pairing error, the reader has removed this device pairing information.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothAlreadyPairedWithAnotherDevice":{"name":"SCPErrorBluetoothAlreadyPairedWithAnotherDevice","abstract":"

    The Bluetooth reader is already paired to another device. The Bluetooth reader","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailed":{"name":"SCPErrorReaderSoftwareUpdateFailed","abstract":"

    Generic reader software update error.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedReaderError":{"name":"SCPErrorReaderSoftwareUpdateFailedReaderError","abstract":"

    Updating the reader software failed because there was an error","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedServerError":{"name":"SCPErrorReaderSoftwareUpdateFailedServerError","abstract":"

    Updating the reader software failed because there was an error","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnsupportedReaderVersion":{"name":"SCPErrorUnsupportedReaderVersion","abstract":"

    processPayment was called from a reader with an unsupported reader","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnknownReaderIpAddress":{"name":"SCPErrorUnknownReaderIpAddress","abstract":"

    The reader returned from discovery does not have an IP address and cannot","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInternetConnectTimeOut":{"name":"SCPErrorInternetConnectTimeOut","abstract":"

    Connecting to reader over the internet timed out. Make sure your device and","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorConnectFailedReaderIsInUse":{"name":"SCPErrorConnectFailedReaderIsInUse","abstract":"

    Connecting to the reader failed because it is currently in use","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothReconnectStarted":{"name":"SCPErrorBluetoothReconnectStarted","abstract":"

    The Bluetooth reader has disconnected and we are attempting to reconnect.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderNotAccessibleInBackground":{"name":"SCPErrorReaderNotAccessibleInBackground","abstract":"

    An attempt was made to interact with the reader while the the app is in the background.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderFailedToPrepare":{"name":"SCPErrorAppleBuiltInReaderFailedToPrepare","abstract":"

    Preparing the Apple Built-In reader to collect payments failed.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderDeviceBanned":{"name":"SCPErrorAppleBuiltInReaderDeviceBanned","abstract":"

    This device cannot be used to process using the Apple Built-In reader as it has been banned.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderTOSNotYetAccepted":{"name":"SCPErrorAppleBuiltInReaderTOSNotYetAccepted","abstract":"

    The operation could not be completed because the reader-specific terms of service have","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderTOSAcceptanceFailed":{"name":"SCPErrorAppleBuiltInReaderTOSAcceptanceFailed","abstract":"

    Failed to accept reader-specific terms of service using the signed-in Apple ID.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderMerchantBlocked":{"name":"SCPErrorAppleBuiltInReaderMerchantBlocked","abstract":"

    This merchant account cannot be used with Apple Built-In reader as it has been blocked.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderInvalidMerchant":{"name":"SCPErrorAppleBuiltInReaderInvalidMerchant","abstract":"

    This merchant account cannot be used with the Apple Built-In reader as it is invalid.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnexpectedSdkError":{"name":"SCPErrorUnexpectedSdkError","abstract":"

    Unexpected SDK error.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnexpectedReaderError":{"name":"SCPErrorUnexpectedReaderError","abstract":"

    Unexpected reader error.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorDeclinedByStripeAPI":{"name":"SCPErrorDeclinedByStripeAPI","abstract":"

    The Stripe API declined the transaction.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorDeclinedByReader":{"name":"SCPErrorDeclinedByReader","abstract":"

    The reader declined the transaction. Try another card.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCommandRequiresCardholderConsent":{"name":"SCPErrorCommandRequiresCardholderConsent","abstract":"

    The cardholder must give consent in order for this operation to succeed.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorRefundFailed":{"name":"SCPErrorRefundFailed","abstract":"

    The refund failed. The customer’s bank or card issuer was unable to process","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNotConnectedToInternet":{"name":"SCPErrorNotConnectedToInternet","abstract":"

    The SDK is not connected to the internet.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorRequestTimedOut":{"name":"SCPErrorRequestTimedOut","abstract":"

    The underlying request timed out.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorStripeAPIError":{"name":"SCPErrorStripeAPIError","abstract":"

    The underlying request returned an API error.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorStripeAPIResponseDecodingError":{"name":"SCPErrorStripeAPIResponseDecodingError","abstract":"

    The API response from Stripe could not be decoded.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInternalNetworkError":{"name":"SCPErrorInternalNetworkError","abstract":"

    Generic network error

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorConnectionTokenProviderCompletedWithError":{"name":"SCPErrorConnectionTokenProviderCompletedWithError","abstract":"

    Your implementation of -[SCPConnectionTokenProvider fetchConnectionToken:]","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorSessionExpired":{"name":"SCPErrorSessionExpired","abstract":"

    The current session has expired and the reader must be disconnected and","parent_name":"SCPError"},"Enums/SCPError.html":{"name":"SCPError","abstract":"

    Possible error codes for NSError objects under the SCPErrorDomain domain.

    "},"Errors.html#/c:@SCPErrorDomain":{"name":"SCPErrorDomain","abstract":"

    The error domain for all errors originating from the Stripe Terminal SDK.

    "},"Errors.html#/c:SCPErrors.h@T@SCPErrorKey":{"name":"SCPErrorKey","abstract":"

    Use this enum to access userInfo keys for NSError objects under the"},"Errors.html#/c:@SCPErrorKeyMessage":{"name":"SCPErrorKeyMessage","abstract":"

    An error message explaining what went wrong. You probably shouldn’t show this"},"Errors.html#/c:@SCPErrorKeyHttpStatusCode":{"name":"SCPErrorKeyHttpStatusCode","abstract":"

    The HTTP status code of the response.

    "},"Errors.html#/c:@SCPErrorKeyReaderMessage":{"name":"SCPErrorKeyReaderMessage","abstract":"

    This error message comes from the reader. You probably shouldn’t show this"},"Errors.html#/c:@SCPErrorKeyDeviceBannedUntilDate":{"name":"SCPErrorKeyDeviceBannedUntilDate","abstract":"

    If an Apple Built-In reader fails to connect due to a device ban and the error"},"Errors.html#/c:@SCPErrorKeyStripeAPIRequestId":{"name":"SCPErrorKeyStripeAPIRequestId","abstract":"

    If a Stripe API request failed, the failed request’s id will be returned in the"},"Errors.html#/c:@SCPErrorKeyStripeAPIDeclineCode":{"name":"SCPErrorKeyStripeAPIDeclineCode","abstract":"

    The decline code returned by the Stripe API.

    "},"Errors.html#/c:@SCPErrorKeyStripeAPIErrorCode":{"name":"SCPErrorKeyStripeAPIErrorCode","abstract":"

    The error code returned by the Stripe API.

    "},"Errors.html#/c:@SCPErrorKeyStripeAPIErrorParameter":{"name":"SCPErrorKeyStripeAPIErrorParameter","abstract":"

    The parameter the error relates to if the error is parameter-specific.

    "},"Errors.html#/c:@SCPErrorKeyStripeAPIErrorType":{"name":"SCPErrorKeyStripeAPIErrorType","abstract":"

    The error type returned by the Stripe API.

    "},"Errors.html#/c:@SCPErrorKeyStripeAPIPaymentIntent":{"name":"SCPErrorKeyStripeAPIPaymentIntent","abstract":"

    If a Stripe API request failed and the error has an associated PaymentIntent,"},"Errors.html#/c:@SCPErrorKeyStripeAPIDocUrl":{"name":"SCPErrorKeyStripeAPIDocUrl","abstract":"

    The documentation URL for the error returned by the Stripe API.

    "},"Errors.html#/c:@SCPErrorKeyStripeAPIFailureReason":{"name":"SCPErrorKeyStripeAPIFailureReason","abstract":"

    If a refund fails, the reason for refund failure if known. Possible values"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(py)setupIntent":{"name":"setupIntent","abstract":"

    The updated SetupIntent after confirmSetupIntent failed.

    ","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(py)requestError":{"name":"requestError","abstract":"

    If confirmSetupIntent failed because the underlying network request errored,","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(py)declineCode":{"name":"declineCode","abstract":"

    If confirmSetupIntent failed because the payment method was declined, this","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPSetupAttemptCardPresentDetails.html#/c:objc(cs)SCPSetupAttemptCardPresentDetails(py)generatedCard":{"name":"generatedCard","abstract":"

    The ID of the Card PaymentMethod which was generated by this SetupAttempt.

    ","parent_name":"SCPSetupAttemptCardPresentDetails"},"Classes/SCPSetupAttemptCardPresentDetails.html#/c:objc(cs)SCPSetupAttemptCardPresentDetails(py)emvAuthData":{"name":"emvAuthData","abstract":"

    The Authorization Response Cryptogram (ARPC) from the issuer.

    ","parent_name":"SCPSetupAttemptCardPresentDetails"},"Classes/SCPSetupAttemptCardPresentDetails.html#/c:objc(cs)SCPSetupAttemptCardPresentDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPSetupAttemptCardPresentDetails"},"Classes/SCPSetupAttemptCardPresentDetails.html#/c:objc(cs)SCPSetupAttemptCardPresentDetails(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPSetupAttemptCardPresentDetails"},"Classes/SCPSetupAttemptPaymentMethodDetails.html#/c:objc(cs)SCPSetupAttemptPaymentMethodDetails(py)type":{"name":"type","abstract":"

    The type of the PaymentMethod. The corresponding, similarly named property","parent_name":"SCPSetupAttemptPaymentMethodDetails"},"Classes/SCPSetupAttemptPaymentMethodDetails.html#/c:objc(cs)SCPSetupAttemptPaymentMethodDetails(py)cardPresent":{"name":"cardPresent","abstract":"

    If this is a card present payment method (ie self.type == SCPPaymentMethodTypeCardPresent),","parent_name":"SCPSetupAttemptPaymentMethodDetails"},"Classes/SCPSetupAttemptPaymentMethodDetails.html#/c:objc(cs)SCPSetupAttemptPaymentMethodDetails(py)interacPresent":{"name":"interacPresent","abstract":"

    If this is a card present payment method (ie self.type == SCPPaymentMethodTypeInteracPresent),","parent_name":"SCPSetupAttemptPaymentMethodDetails"},"Classes/SCPSetupAttemptPaymentMethodDetails.html#/c:objc(cs)SCPSetupAttemptPaymentMethodDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPSetupAttemptPaymentMethodDetails"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)application":{"name":"application","abstract":"

    The ID of the Connect application that created the SetupIntent.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)created":{"name":"created","abstract":"

    Time at which the object was created.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)customer":{"name":"customer","abstract":"

    ID of the Customer this SetupIntent belongs to, if one exists.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)onBehalfOf":{"name":"onBehalfOf","abstract":"

    (Connect) The account (if any) for which the setup is intended.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)paymentMethod":{"name":"paymentMethod","abstract":"

    ID of the payment method used with this SetupAttempt.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)paymentMethodDetails":{"name":"paymentMethodDetails","abstract":"

    Details about the payment method at the time of SetupIntent confirmation.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)setupIntent":{"name":"setupIntent","abstract":"

    ID of the SetupIntent that this attempt belongs to.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)status":{"name":"status","abstract":"

    The status of this SetupAttempt. One of: requires_confirmation,","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)stripeId":{"name":"stripeId","abstract":"

    The unique identifier for the SetupAttempt.

    ","parent_name":"SCPSetupAttempt"},"Enums/SCPSetupIntentUsage.html#/c:@E@SCPSetupIntentUsage@SCPSetupIntentUsageOffSession":{"name":"SCPSetupIntentUsageOffSession","abstract":"

    An off-session usage indicates to Stripe that future payments will take place","parent_name":"SCPSetupIntentUsage"},"Enums/SCPSetupIntentUsage.html#/c:@E@SCPSetupIntentUsage@SCPSetupIntentUsageOnSession":{"name":"SCPSetupIntentUsageOnSession","abstract":"

    An on-session usage indicates to Stripe that future payments will take place","parent_name":"SCPSetupIntentUsage"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusRequiresPaymentMethod":{"name":"SCPSetupIntentStatusRequiresPaymentMethod","abstract":"

    Next step: collect a payment method by calling collectPaymentMethod.

    ","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusRequiresConfirmation":{"name":"SCPSetupIntentStatusRequiresConfirmation","abstract":"

    Next step: confirm the SetupIntent by calling confirmSetupIntent.

    ","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusRequiresAction":{"name":"SCPSetupIntentStatusRequiresAction","abstract":"

    If the setup requires additional actions, such as authenticating with","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusProcessing":{"name":"SCPSetupIntentStatusProcessing","abstract":"

    Once required actions are handled, the SetupIntent moves to processing.","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusCanceled":{"name":"SCPSetupIntentStatusCanceled","abstract":"

    The SetupIntent was canceled.

    ","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusSucceeded":{"name":"SCPSetupIntentStatusSucceeded","abstract":"

    The SetupIntent succeeded.

    ","parent_name":"SCPSetupIntentStatus"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)customer":{"name":"customer","abstract":"

    ID of the customer this SetupIntent belongs to, if one exists.

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)stripeDescription":{"name":"stripeDescription","abstract":"

    An arbitrary string attached to the object. Often useful for displaying to users.

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)metadata":{"name":"metadata","abstract":"

    Set of key-value pairs that you can attach to an object. This can be useful for","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)usage":{"name":"usage","abstract":"

    Indicates how the payment method is intended to be used in the future. If not","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)onBehalfOf":{"name":"onBehalfOf","abstract":"

    Connect Only:** The Stripe account ID for which this SetupIntent is created.

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(im)initWithCustomer:":{"name":"-initWithCustomer:","abstract":"

    Initializes SCPSetupIntentParameters with the given customer ID.

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(im)init":{"name":"-init","abstract":"

    Use initWithCustomer:

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(cm)new":{"name":"+new","abstract":"

    Use initWithCustomer:

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)description":{"name":"description","abstract":"

    Use stripeDescription for the string attached to the object.

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)stripeId":{"name":"stripeId","abstract":"

    The unique identifier for the intent.

    ","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)created":{"name":"created","abstract":"

    When the intent was created.

    ","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)customer":{"name":"customer","abstract":"

    The identifier of a customer object to which the SetupIntent is attached, if applicable.

    ","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)metadata":{"name":"metadata","abstract":"

    Set of key-value pairs attached to the object.

    ","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)usage":{"name":"usage","abstract":"

    An SCPSetupIntentUsage value describing how the SetupIntent will be used.","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)status":{"name":"status","abstract":"

    The status of the intent.

    ","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)latestAttempt":{"name":"latestAttempt","abstract":"

    The most recent SetupAttempt for this SetupIntent

    ","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class. You should only use SetupIntents","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class. You should only use SetupIntents","parent_name":"SCPSetupIntent"},"Classes/SCPReadReusableCardParameters.html#/c:objc(cs)SCPReadReusableCardParameters(py)customer":{"name":"customer","abstract":"

    Optional parameter: attach the new PaymentMethod to Customer with this id

    ","parent_name":"SCPReadReusableCardParameters"},"Classes/SCPReadReusableCardParameters.html#/c:objc(cs)SCPReadReusableCardParameters(py)metadata":{"name":"metadata","abstract":"

    Optional set of key-value pairs attached to the object. The default is nil.

    ","parent_name":"SCPReadReusableCardParameters"},"Classes/SCPReadReusableCardParameters.html":{"name":"SCPReadReusableCardParameters","abstract":"

    Parameters for reading a reusable card.

    "},"Classes/SCPSetupIntent.html":{"name":"SCPSetupIntent","abstract":"

    A SetupIntent guides you through the process of setting up and saving a"},"Classes/SCPSetupIntentParameters.html":{"name":"SCPSetupIntentParameters","abstract":"

    Parameters for creating an SCPSetupIntent.

    "},"Enums/SCPSetupIntentStatus.html":{"name":"SCPSetupIntentStatus","abstract":"

    The possible statuses of the SetupIntent.

    "},"Enums/SCPSetupIntentUsage.html":{"name":"SCPSetupIntentUsage","abstract":"

    The SetupIntent usage options tell Stripe how the payment method is intended to be used in the future."},"Classes/SCPSetupAttempt.html":{"name":"SCPSetupAttempt","abstract":"

    A SetupAttempt describes one attempted confirmation of a SetupIntent,"},"Classes/SCPSetupAttemptPaymentMethodDetails.html":{"name":"SCPSetupAttemptPaymentMethodDetails","abstract":"

    Details about a PaymentMethod at a specific time. ex: at time of transaction"},"Classes/SCPSetupAttemptCardPresentDetails.html":{"name":"SCPSetupAttemptCardPresentDetails","abstract":"

    An object representing details from a transaction using a card_present"},"Classes/SCPConfirmSetupIntentError.html":{"name":"SCPConfirmSetupIntentError","abstract":"

    An error from -[SCPTerminal confirmSetupIntent:completion:]

    "},"Enums/SCPRefundStatus.html#/c:@E@SCPRefundStatus@SCPRefundStatusSucceeded":{"name":"SCPRefundStatusSucceeded","abstract":"

    The refund succeeded.

    ","parent_name":"SCPRefundStatus"},"Enums/SCPRefundStatus.html#/c:@E@SCPRefundStatus@SCPRefundStatusPending":{"name":"SCPRefundStatusPending","abstract":"

    The refund is pending.

    ","parent_name":"SCPRefundStatus"},"Enums/SCPRefundStatus.html#/c:@E@SCPRefundStatus@SCPRefundStatusFailed":{"name":"SCPRefundStatusFailed","abstract":"

    The refund failed.

    ","parent_name":"SCPRefundStatus"},"Enums/SCPRefundStatus.html#/c:@E@SCPRefundStatus@SCPRefundStatusUnknown":{"name":"SCPRefundStatusUnknown","abstract":"

    Unknown refund state.

    ","parent_name":"SCPRefundStatus"},"Classes/SCPProcessRefundError.html#/c:objc(cs)SCPProcessRefundError(py)refund":{"name":"refund","abstract":"

    If processRefund failed after the refund was created, this property contains","parent_name":"SCPProcessRefundError"},"Classes/SCPProcessRefundError.html#/c:objc(cs)SCPProcessRefundError(py)requestError":{"name":"requestError","abstract":"

    If processRefund failed because the underlying network request errored,","parent_name":"SCPProcessRefundError"},"Classes/SCPProcessRefundError.html#/c:objc(cs)SCPProcessRefundError(cm)init":{"name":"+init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPProcessRefundError"},"Classes/SCPProcessRefundError.html#/c:objc(cs)SCPProcessRefundError(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPProcessRefundError"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)chargeId":{"name":"chargeId","abstract":"

    The ID of the charge to be refunded.

    ","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)amount":{"name":"amount","abstract":"

    The amount of the refund, provided in the currency’s smallest unit.

    ","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)currency":{"name":"currency","abstract":"

    Three-letter ISO currency code. Must be a supported currency.

    ","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)metadata":{"name":"metadata","abstract":"

    Set of key-value pairs that you can attach to an object. This can be useful for","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)reverseTransfer":{"name":"reverseTransfer","abstract":"

    Connect only: Nullable boolean indicating whether the transfer should be","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)refundApplicationFee":{"name":"refundApplicationFee","abstract":"

    Connect only: Nullable boolean indicating whether the application fee should be","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(im)initWithChargeId:amount:currency:":{"name":"-initWithChargeId:amount:currency:","abstract":"

    Initializes SCPRefundParameters with the given charge, amount, and currency.

    ","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(im)init":{"name":"-init","abstract":"

    Use initWithChargeId:amount:currency:

    ","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(cm)new":{"name":"+new","abstract":"

    Use initWithChargeId:amount:currency:

    ","parent_name":"SCPRefundParameters"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)stripeId":{"name":"stripeId","abstract":"

    The unique identifier for the refund.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)amount":{"name":"amount","abstract":"

    The amount that was refunded.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)charge":{"name":"charge","abstract":"

    The ID of the charge that was refunded

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)created":{"name":"created","abstract":"

    When the refund object was created.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)currency":{"name":"currency","abstract":"

    The currency of the amount refunded.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)metadata":{"name":"metadata","abstract":"

    Metadata associated with the refund.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)reason":{"name":"reason","abstract":"

    Reason for the refund, either user-provided (duplicate, fraudulent, or","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)status":{"name":"status","abstract":"

    The status of the refund.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)paymentMethodDetails":{"name":"paymentMethodDetails","abstract":"

    The payment method details associated with the refund.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)failureReason":{"name":"failureReason","abstract":"

    If the refund failed, the reason for refund failure if known.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html":{"name":"SCPRefund","abstract":"

    An object representing a Stripe refund.

    "},"Classes/SCPRefundParameters.html":{"name":"SCPRefundParameters","abstract":"

    Parameters for creating an SCPRefund.

    "},"Classes/SCPProcessRefundError.html":{"name":"SCPProcessRefundError","abstract":"

    An error from -[SCPTerminal processRefund:completion:].

    "},"Enums/SCPRefundStatus.html":{"name":"SCPRefundStatus","abstract":"

    The possible statuses for a refund.

    "},"Enums/SCPIncrementalAuthorizationStatus.html#/c:@E@SCPIncrementalAuthorizationStatus@SCPIncrementalAuthorizationStatusUnknown":{"name":"SCPIncrementalAuthorizationStatusUnknown","abstract":"

    It is undetermined whether or not this PaymentIntent will be eligible for incremental authorizations.","parent_name":"SCPIncrementalAuthorizationStatus"},"Enums/SCPIncrementalAuthorizationStatus.html#/c:@E@SCPIncrementalAuthorizationStatus@SCPIncrementalAuthorizationStatusNotSupported":{"name":"SCPIncrementalAuthorizationStatusNotSupported","abstract":"

    This PaymentIntent is not eligible for incremental authorizations, or it was not requested.

    ","parent_name":"SCPIncrementalAuthorizationStatus"},"Enums/SCPIncrementalAuthorizationStatus.html#/c:@E@SCPIncrementalAuthorizationStatus@SCPIncrementalAuthorizationStatusSupported":{"name":"SCPIncrementalAuthorizationStatusSupported","abstract":"

    This PaymentIntent is eligible for incremental authorizations.

    ","parent_name":"SCPIncrementalAuthorizationStatus"},"Classes/SCPNetworks.html#/c:objc(cs)SCPNetworks(py)available":{"name":"available","abstract":"

    All available networks for the card.

    ","parent_name":"SCPNetworks"},"Classes/SCPNetworks.html#/c:objc(cs)SCPNetworks(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPNetworks"},"Classes/SCPNetworks.html#/c:objc(cs)SCPNetworks(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPNetworks"},"Classes/SCPTippingConfiguration.html#/c:objc(cs)SCPTippingConfiguration(py)eligibleAmount":{"name":"eligibleAmount","abstract":"

    The amount of the payment total eligible for tips.

    ","parent_name":"SCPTippingConfiguration"},"Classes/SCPTippingConfiguration.html#/c:objc(cs)SCPTippingConfiguration(im)initWithEligibleAmount:":{"name":"-initWithEligibleAmount:","abstract":"

    Initialize a TippingConfiguration instance.

    ","parent_name":"SCPTippingConfiguration"},"Classes/SCPTippingConfiguration.html#/c:objc(cs)SCPTippingConfiguration(im)init":{"name":"-init","abstract":"

    Use initWithEligibleAmount:

    ","parent_name":"SCPTippingConfiguration"},"Classes/SCPTippingConfiguration.html#/c:objc(cs)SCPTippingConfiguration(cm)new":{"name":"+new","abstract":"

    Use initWithEligibleAmount:

    ","parent_name":"SCPTippingConfiguration"},"Enums/SCPCaptureMethod.html#/c:@E@SCPCaptureMethod@SCPCaptureMethodManual":{"name":"SCPCaptureMethodManual","abstract":"

    Place a hold on the funds when the customer authorizes the payment, but don’t","parent_name":"SCPCaptureMethod"},"Enums/SCPCaptureMethod.html#/c:@E@SCPCaptureMethod@SCPCaptureMethodAutomatic":{"name":"SCPCaptureMethodAutomatic","abstract":"

    Stripe automatically captures funds when the customer authorizes the payment.

    ","parent_name":"SCPCaptureMethod"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(py)skipTipping":{"name":"skipTipping","abstract":"

    Bypass tipping selection if it would have otherwise been shown.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(py)tippingConfiguration":{"name":"tippingConfiguration","abstract":"

    The tipping configuration for this payment collection.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(py)updatePaymentIntent":{"name":"updatePaymentIntent","abstract":"

    Whether or not to update the PaymentIntent server side during collectPaymentMethod.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithSkipTipping:":{"name":"-initWithSkipTipping:","abstract":"

    Initialize a CollectConfiguration

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithUpdatePaymentIntent:":{"name":"-initWithUpdatePaymentIntent:","abstract":"

    Initialize a CollectConfiguration

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithTippingConfiguration:":{"name":"-initWithTippingConfiguration:","abstract":"

    Initialize a CollectConfiguration.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithSkipTipping:updatePaymentIntent:":{"name":"-initWithSkipTipping:updatePaymentIntent:","abstract":"

    Initialize a CollectConfiguration

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithSkipTipping:tippingConfiguration:":{"name":"-initWithSkipTipping:tippingConfiguration:","abstract":"

    Initialize a CollectConfiguration.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithUpdatePaymentIntent:tippingConfiguration:":{"name":"-initWithUpdatePaymentIntent:tippingConfiguration:","abstract":"

    Initialize a CollectConfiguration.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithSkipTipping:updatePaymentIntent:tippingConfiguration:":{"name":"-initWithSkipTipping:updatePaymentIntent:tippingConfiguration:","abstract":"

    Initialize a CollectConfiguration.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)init":{"name":"-init","abstract":"

    Use initWithSkipTipping:updatePaymentIntent:tippingConfiguration: or helper initializers.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(cm)new":{"name":"+new","abstract":"

    Use initWithSkipTipping:updatePaymentIntent:tippingConfiguration: or helper initializers.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPPaymentMethodOptionsParameters.html#/c:objc(cs)SCPPaymentMethodOptionsParameters(py)cardPresentParameters":{"name":"cardPresentParameters","abstract":"

    Card-present-specific configuration for this PaymentMethod.

    ","parent_name":"SCPPaymentMethodOptionsParameters"},"Classes/SCPPaymentMethodOptionsParameters.html#/c:objc(cs)SCPPaymentMethodOptionsParameters(im)initWithCardPresentParameters:":{"name":"-initWithCardPresentParameters:","abstract":"

    Initialize a PaymentMethodOptionsParameters

    ","parent_name":"SCPPaymentMethodOptionsParameters"},"Classes/SCPPaymentMethodOptionsParameters.html#/c:objc(cs)SCPPaymentMethodOptionsParameters(im)init":{"name":"-init","abstract":"

    Use initWithCardPresentParameters:(SCPCardPresentParameters)cardPresentParameters

    ","parent_name":"SCPPaymentMethodOptionsParameters"},"Enums/SCPPaymentMethodType.html#/c:@E@SCPPaymentMethodType@SCPPaymentMethodTypeCard":{"name":"SCPPaymentMethodTypeCard","abstract":"

    A card payment method.

    ","parent_name":"SCPPaymentMethodType"},"Enums/SCPPaymentMethodType.html#/c:@E@SCPPaymentMethodType@SCPPaymentMethodTypeCardPresent":{"name":"SCPPaymentMethodTypeCardPresent","abstract":"

    A card present payment method.

    ","parent_name":"SCPPaymentMethodType"},"Enums/SCPPaymentMethodType.html#/c:@E@SCPPaymentMethodType@SCPPaymentMethodTypeInteracPresent":{"name":"SCPPaymentMethodTypeInteracPresent","abstract":"

    An Interac Present payment method.

    ","parent_name":"SCPPaymentMethodType"},"Enums/SCPPaymentMethodType.html#/c:@E@SCPPaymentMethodType@SCPPaymentMethodTypeUnknown":{"name":"SCPPaymentMethodTypeUnknown","abstract":"

    An unknown type.

    ","parent_name":"SCPPaymentMethodType"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)stripeId":{"name":"stripeId","abstract":"

    The unique identifier for the PaymentMethod

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)created":{"name":"created","abstract":"

    Time at which the object was created. Measured in seconds since the Unix epoch.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)type":{"name":"type","abstract":"

    The type of the PaymentMethod. The corresponding, similarly named property contains additional information specific to the PaymentMethod type.","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)card":{"name":"card","abstract":"

    If this is a card PaymentMethod (ie self.type == SCPPaymentMethodTypeCard), this contains additional details.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)cardPresent":{"name":"cardPresent","abstract":"

    If this is a card_present PaymentMethod (ie self.type == SCPPaymentMethodTypeCardPresent), this contains additional details.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)interacPresent":{"name":"interacPresent","abstract":"

    If this is an Interac_present PaymentMethod (ie self.type == SCPPaymentMethodTypeInteracPresent), this contains additional details.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)customer":{"name":"customer","abstract":"

    The Customer that this PaymentMethod is attached to, or nil.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)metadata":{"name":"metadata","abstract":"

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)brand":{"name":"brand","abstract":"

    The issuer of the card.

    ","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)country":{"name":"country","abstract":"

    Two-letter ISO code representing the country of the card.

    ","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)expMonth":{"name":"expMonth","abstract":"

    Two-digit number representing the card’s expiration month.","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)expYear":{"name":"expYear","abstract":"

    Four-digit number representing the card’s expiration year.","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)funding":{"name":"funding","abstract":"

    Card funding type. Ex: credit, debit, etc.

    ","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)last4":{"name":"last4","abstract":"

    The last four digits of the card.

    ","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)fingerprint":{"name":"fingerprint","abstract":"

    Uniquely identifies this particular card number. You can use this attribute","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPCardDetails"},"Classes/SCPPaymentMethodDetails.html#/c:objc(cs)SCPPaymentMethodDetails(py)type":{"name":"type","abstract":"

    The type of the PaymentMethod. The corresponding, similarly named property","parent_name":"SCPPaymentMethodDetails"},"Classes/SCPPaymentMethodDetails.html#/c:objc(cs)SCPPaymentMethodDetails(py)cardPresent":{"name":"cardPresent","abstract":"

    If this is a card present payment method (ie self.type == SCPPaymentMethodTypeCardPresent),","parent_name":"SCPPaymentMethodDetails"},"Classes/SCPPaymentMethodDetails.html#/c:objc(cs)SCPPaymentMethodDetails(py)interacPresent":{"name":"interacPresent","abstract":"

    If this is an Interac present payment method (ie self.type == SCPPaymentMethodTypeInteracPresent),","parent_name":"SCPPaymentMethodDetails"},"Classes/SCPPaymentMethodDetails.html#/c:objc(cs)SCPPaymentMethodDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPPaymentMethodDetails"},"Enums/SCPChargeStatus.html#/c:@E@SCPChargeStatus@SCPChargeStatusSucceeded":{"name":"SCPChargeStatusSucceeded","abstract":"

    The charge succeeded.

    ","parent_name":"SCPChargeStatus"},"Enums/SCPChargeStatus.html#/c:@E@SCPChargeStatus@SCPChargeStatusPending":{"name":"SCPChargeStatusPending","abstract":"

    The charge succeeded.

    ","parent_name":"SCPChargeStatus"},"Enums/SCPChargeStatus.html#/c:@E@SCPChargeStatus@SCPChargeStatusFailed":{"name":"SCPChargeStatusFailed","abstract":"

    The charge failed.

    ","parent_name":"SCPChargeStatus"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)amount":{"name":"amount","abstract":"

    The amount of the charge.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)currency":{"name":"currency","abstract":"

    The currency of the charge.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)status":{"name":"status","abstract":"

    The status of the charge.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)paymentMethodDetails":{"name":"paymentMethodDetails","abstract":"

    The payment method details associated with the charge.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)stripeDescription":{"name":"stripeDescription","abstract":"

    A string describing the charge, displayed in the Stripe dashboard and in","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)metadata":{"name":"metadata","abstract":"

    Metadata associated with the charge.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)stripeId":{"name":"stripeId","abstract":"

    The unique identifier for the charge.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)statementDescriptorSuffix":{"name":"statementDescriptorSuffix","abstract":"

    Extra dynamic information about a Charge. This will appear concatenated with the statementDescriptor on","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)calculatedStatementDescriptor":{"name":"calculatedStatementDescriptor","abstract":"

    The full statement descriptor that is displayed on your customer’s credit card’s statement, after the","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPCharge"},"Enums/SCPCardFundingType.html#/c:@E@SCPCardFundingType@SCPCardFundingTypeDebit":{"name":"SCPCardFundingTypeDebit","abstract":"

    Debit

    ","parent_name":"SCPCardFundingType"},"Enums/SCPCardFundingType.html#/c:@E@SCPCardFundingType@SCPCardFundingTypeCredit":{"name":"SCPCardFundingTypeCredit","abstract":"

    Credit

    ","parent_name":"SCPCardFundingType"},"Enums/SCPCardFundingType.html#/c:@E@SCPCardFundingType@SCPCardFundingTypePrepaid":{"name":"SCPCardFundingTypePrepaid","abstract":"

    Prepaid

    ","parent_name":"SCPCardFundingType"},"Enums/SCPCardFundingType.html#/c:@E@SCPCardFundingType@SCPCardFundingTypeOther":{"name":"SCPCardFundingTypeOther","abstract":"

    An other or unknown type of funding source

    ","parent_name":"SCPCardFundingType"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandVisa":{"name":"SCPCardBrandVisa","abstract":"

    Visa card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandAmex":{"name":"SCPCardBrandAmex","abstract":"

    American Express card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandMasterCard":{"name":"SCPCardBrandMasterCard","abstract":"

    MasterCard card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandDiscover":{"name":"SCPCardBrandDiscover","abstract":"

    Discover card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandJCB":{"name":"SCPCardBrandJCB","abstract":"

    JCB card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandDinersClub":{"name":"SCPCardBrandDinersClub","abstract":"

    Diners Club card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandInterac":{"name":"SCPCardBrandInterac","abstract":"

    Interac card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandUnionPay":{"name":"SCPCardBrandUnionPay","abstract":"

    Union Pay card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandEftposAu":{"name":"SCPCardBrandEftposAu","abstract":"

    Eftpos Australia card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandUnknown":{"name":"SCPCardBrandUnknown","abstract":"

    An unknown card brand

    ","parent_name":"SCPCardBrand"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(py)paymentIntent":{"name":"paymentIntent","abstract":"

    The updated PaymentIntent after processPayment failed.

    ","parent_name":"SCPProcessPaymentError"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(py)requestError":{"name":"requestError","abstract":"

    If processPayment failed because the underlying network request errored,","parent_name":"SCPProcessPaymentError"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(py)declineCode":{"name":"declineCode","abstract":"

    If processPayment failed because the payment method was declined, this","parent_name":"SCPProcessPaymentError"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPProcessPaymentError"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPProcessPaymentError"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)accountType":{"name":"accountType","abstract":"

    The type of account being debited or credited

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)applicationPreferredName":{"name":"applicationPreferredName","abstract":"

    Also known as “Application Name”. Required on EMV receipts.

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)dedicatedFileName":{"name":"dedicatedFileName","abstract":"

    Also known as “AID”. Required on EMV receipts.

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)authorizationResponseCode":{"name":"authorizationResponseCode","abstract":"

    Authorization Response Code

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)applicationCryptogram":{"name":"applicationCryptogram","abstract":"

    Application Cryptogram

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)terminalVerificationResults":{"name":"terminalVerificationResults","abstract":"

    TVR

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)transactionStatusInformation":{"name":"transactionStatusInformation","abstract":"

    TSI

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)last4":{"name":"last4","abstract":"

    The last 4 digits of the card.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)expMonth":{"name":"expMonth","abstract":"

    The card’s expiration month. 1-indexed (i.e. 1 == January)

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)expYear":{"name":"expYear","abstract":"

    The card’s expiration year.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)cardholderName":{"name":"cardholderName","abstract":"

    The cardholder name as read from the card, in ISO 7813 format. May include","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)funding":{"name":"funding","abstract":"

    The card’s funding type.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)brand":{"name":"brand","abstract":"

    The issuing brand of the card.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)fingerprint":{"name":"fingerprint","abstract":"

    A string uniquely identifying this card number.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)generatedCard":{"name":"generatedCard","abstract":"

    ID of a card PaymentMethod that may be attached to a Customer for future","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)receipt":{"name":"receipt","abstract":"

    Receipt information for the card present transaction. Only present for EMV","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)emvAuthData":{"name":"emvAuthData","abstract":"

    (Only applicable to EMV payments) The authorization data from the card","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)country":{"name":"country","abstract":"

    Two-letter ISO code representing the country of the card. You could use this","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)preferredLocales":{"name":"preferredLocales","abstract":"

    EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)networks":{"name":"networks","abstract":"

    Contains information about card networks that can be used to process the payment.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)incrementalAuthorizationStatus":{"name":"incrementalAuthorizationStatus","abstract":"

    Whether this payment method is eligible for incremental authorizations.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPCardPresentDetails"},"Enums/SCPCardPresentRouting.html#/c:@E@SCPCardPresentRouting@SCPCardPresentRoutingDomestic":{"name":"SCPCardPresentRoutingDomestic","abstract":"

    Prioritize domestic debit network routing on payment method collection.

    ","parent_name":"SCPCardPresentRouting"},"Enums/SCPCardPresentRouting.html#/c:@E@SCPCardPresentRouting@SCPCardPresentRoutingInternational":{"name":"SCPCardPresentRoutingInternational","abstract":"

    Prioritize international network routing on payment method collection.

    ","parent_name":"SCPCardPresentRouting"},"Enums/SCPCardPresentCaptureMethod.html#/c:@E@SCPCardPresentCaptureMethod@SCPCardPresentCaptureMethodManualPreferred":{"name":"SCPCardPresentCaptureMethodManualPreferred","abstract":"

    Use manual_preferred if you prefer manual capture_method for the SCPPaymentIntent’s capture_method but support","parent_name":"SCPCardPresentCaptureMethod"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(py)requestExtendedAuthorization":{"name":"requestExtendedAuthorization","abstract":"

    Using the extended authorizations feature, users in eligible categories can capture up to 31 days later, depending on the card brand.

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(py)requestIncrementalAuthorizationSupport":{"name":"requestIncrementalAuthorizationSupport","abstract":"

    Allows you to increase the authorized amount on a confirmed PaymentIntent before you capture it. This means you can update the amount on a payment if the estimated price changes or goods and services are added. Before capture, each incremental authorization appears on your customer’s credit card statement as an additional pending charge.

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(py)captureMethod":{"name":"captureMethod","abstract":"

    SCPCardPresentCaptureMethod as a nullable NSNumber.

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(py)requestedPriority":{"name":"requestedPriority","abstract":"

    The requested routing priority as a nullable NSNumber.

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:":{"name":"-initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:":{"name":"-initWithRequestExtendedAuthorization:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestIncrementalAuthorizationSupport:":{"name":"-initWithRequestIncrementalAuthorizationSupport:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:captureMethod:":{"name":"-initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:captureMethod:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:captureMethod:":{"name":"-initWithRequestExtendedAuthorization:captureMethod:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestIncrementalAuthorizationSupport:captureMethod:":{"name":"-initWithRequestIncrementalAuthorizationSupport:captureMethod:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithCaptureMethod:":{"name":"-initWithCaptureMethod:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:captureMethod:requestedPriority:":{"name":"-initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:captureMethod:requestedPriority:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:requestedPriority:":{"name":"-initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:requestedPriority:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithCaptureMethod:requestedPriority:":{"name":"-initWithCaptureMethod:requestedPriority:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestedPriority:":{"name":"-initWithRequestedPriority:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)init":{"name":"-init","abstract":"

    Use alternative initializer.

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPTip.html#/c:objc(cs)SCPTip(py)amount":{"name":"amount","abstract":"

    Portion of the amount that corresponds to a tip

    ","parent_name":"SCPTip"},"Classes/SCPTip.html#/c:objc(cs)SCPTip(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate SCPTip.

    ","parent_name":"SCPTip"},"Classes/SCPTip.html#/c:objc(cs)SCPTip(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate SCPTip.

    ","parent_name":"SCPTip"},"Classes/SCPAmountDetails.html#/c:objc(cs)SCPAmountDetails(py)tip":{"name":"tip","abstract":"

    Details about the tip

    ","parent_name":"SCPAmountDetails"},"Classes/SCPAmountDetails.html#/c:objc(cs)SCPAmountDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate SCPAmountDetails.

    ","parent_name":"SCPAmountDetails"},"Classes/SCPAmountDetails.html#/c:objc(cs)SCPAmountDetails(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate SCPAmountDetails.

    ","parent_name":"SCPAmountDetails"},"Enums/SCPPaymentStatus.html#/c:@E@SCPPaymentStatus@SCPPaymentStatusNotReady":{"name":"SCPPaymentStatusNotReady","abstract":"

    The SDK is not ready to start a payment. It may be busy with another","parent_name":"SCPPaymentStatus"},"Enums/SCPPaymentStatus.html#/c:@E@SCPPaymentStatus@SCPPaymentStatusReady":{"name":"SCPPaymentStatusReady","abstract":"

    The SDK is ready to start a payment.

    ","parent_name":"SCPPaymentStatus"},"Enums/SCPPaymentStatus.html#/c:@E@SCPPaymentStatus@SCPPaymentStatusWaitingForInput":{"name":"SCPPaymentStatusWaitingForInput","abstract":"

    The SDK is waiting for input from the customer (e.g., for a card to","parent_name":"SCPPaymentStatus"},"Enums/SCPPaymentStatus.html#/c:@E@SCPPaymentStatus@SCPPaymentStatusProcessing":{"name":"SCPPaymentStatusProcessing","abstract":"

    The SDK is processing a payment.

    ","parent_name":"SCPPaymentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusRequiresPaymentMethod":{"name":"SCPPaymentIntentStatusRequiresPaymentMethod","abstract":"

    Next step: collect a payment method by calling collectPaymentMethod.

    ","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusRequiresConfirmation":{"name":"SCPPaymentIntentStatusRequiresConfirmation","abstract":"

    Next step: process the payment by calling processPayment.

    ","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusRequiresCapture":{"name":"SCPPaymentIntentStatusRequiresCapture","abstract":"

    Next step: capture the PaymentIntent on your backend via the Stripe API.

    ","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusProcessing":{"name":"SCPPaymentIntentStatusProcessing","abstract":"

    The PaymentIntent is in the middle of full EMV processing.

    ","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusCanceled":{"name":"SCPPaymentIntentStatusCanceled","abstract":"

    The PaymentIntent was canceled.

    ","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusSucceeded":{"name":"SCPPaymentIntentStatusSucceeded","abstract":"

    The PaymentIntent succeeded.

    ","parent_name":"SCPPaymentIntentStatus"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)amount":{"name":"amount","abstract":"

    The amount of the payment, provided in the currency’s smallest unit.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)currency":{"name":"currency","abstract":"

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)paymentMethodTypes":{"name":"paymentMethodTypes","abstract":"

    The list of payment method types that this PaymentIntent is allowed to use.","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)captureMethod":{"name":"captureMethod","abstract":"

    The capture method that this PaymentIntent should use. Defaults to SCPCaptureMethodManual.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)metadata":{"name":"metadata","abstract":"

    Set of key-value pairs that you can attach to an object. This can be useful for","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)stripeDescription":{"name":"stripeDescription","abstract":"

    An arbitrary string attached to the object. If you send a receipt email for","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)statementDescriptor":{"name":"statementDescriptor","abstract":"

    A string to be displayed on your customer’s credit card statement. This may be","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)statementDescriptorSuffix":{"name":"statementDescriptorSuffix","abstract":"

    A string to specify details about the transaction so your customer can understand it clearly on their statement.","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)receiptEmail":{"name":"receiptEmail","abstract":"

    Email address that the receipt for the resulting payment will be sent to.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)customer":{"name":"customer","abstract":"

    The ID of the Customer this PaymentIntent is for, if one exists.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)applicationFeeAmount":{"name":"applicationFeeAmount","abstract":"

    The amount of the application fee (if any) that will be applied to the","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)transferGroup":{"name":"transferGroup","abstract":"

    A string that identifies the resulting payment as part of a group.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)transferDataDestination":{"name":"transferDataDestination","abstract":"

    The account (if any) the payment will be attributed to for tax reporting, and","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)onBehalfOf":{"name":"onBehalfOf","abstract":"

    The Stripe account ID for which these funds are intended.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)setupFutureUsage":{"name":"setupFutureUsage","abstract":"

    Indicates that you intend to make future payments with this PaymentIntent’s payment method.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)paymentMethodOptionsParameters":{"name":"paymentMethodOptionsParameters","abstract":"

    Specific options used during the creation of the PaymentMethod.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)initWithAmount:currency:":{"name":"-initWithAmount:currency:","abstract":"

    Initializes SCPPaymentIntentParameters with the given parameters.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)initWithAmount:currency:paymentMethodTypes:":{"name":"-initWithAmount:currency:paymentMethodTypes:","abstract":"

    Initializes SCPPaymentIntentParameters with the given parameters.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)initWithAmount:currency:captureMethod:":{"name":"-initWithAmount:currency:captureMethod:","abstract":"

    Initializes SCPPaymentIntentParameters with the given parameters.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)initWithAmount:currency:paymentMethodTypes:captureMethod:":{"name":"-initWithAmount:currency:paymentMethodTypes:captureMethod:","abstract":"

    Initializes SCPPaymentIntentParameters with the given parameters.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)init":{"name":"-init","abstract":"

    Use initWithAmount:currency:

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(cm)new":{"name":"+new","abstract":"

    Use initWithAmount:currency:

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)description":{"name":"description","abstract":"

    Use stripeDescription for the string attached to the object.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)stripeId":{"name":"stripeId","abstract":"

    The unique identifier for the intent.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)created":{"name":"created","abstract":"

    When the intent was created.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)status":{"name":"status","abstract":"

    The status of the PaymentIntent.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)amount":{"name":"amount","abstract":"

    The amount to be collected by this PaymentIntent, provided in the currency’s","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)currency":{"name":"currency","abstract":"

    The currency of the payment.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)metadata":{"name":"metadata","abstract":"

    Set of key-value pairs attached to the object.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)charges":{"name":"charges","abstract":"

    Charges that were created by this PaymentIntent, if any.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)paymentMethod":{"name":"paymentMethod","abstract":"

    The payment method to be used in this PaymentIntent. Only valid in the","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)amountDetails":{"name":"amountDetails","abstract":"

    Details about items included in the amount after confirmation.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)amountTip":{"name":"amountTip","abstract":"

    Indicates how much the user intends to tip in addition to the amount by at confirmation time.","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)statementDescriptor":{"name":"statementDescriptor","abstract":"

    Extra information about a PaymentIntent. This will appear on your customer’s statement when","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)statementDescriptorSuffix":{"name":"statementDescriptorSuffix","abstract":"

    Extra dynamic information about a PaymentIntent. This will appear concatenated with the statementDescriptor on","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate SCPPaymentIntent. You should only use","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate SCPPaymentIntent. You should only use","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html":{"name":"SCPPaymentIntent","abstract":"

    A PaymentIntent tracks the process of collecting a payment from your customer."},"Classes/SCPPaymentIntentParameters.html":{"name":"SCPPaymentIntentParameters","abstract":"

    Parameters for creating an SCPPaymentIntent. Pass an object of this type"},"Enums/SCPPaymentIntentStatus.html":{"name":"SCPPaymentIntentStatus","abstract":"

    The possible statuses for a PaymentIntent.

    "},"Enums/SCPPaymentStatus.html":{"name":"SCPPaymentStatus","abstract":"

    The possible payment statuses for the SDK.

    "},"Classes/SCPAmountDetails.html":{"name":"SCPAmountDetails","abstract":"

    Contains details about items included in the [PaymentIntent] amount

    "},"Classes/SCPTip.html":{"name":"SCPTip","abstract":"

    Contains details about tips

    "},"Classes/SCPCardPresentParameters.html":{"name":"SCPCardPresentParameters","abstract":"

    Parameters that will be applied to the card present PaymentIntent.

    "},"Enums/SCPCardPresentCaptureMethod.html":{"name":"SCPCardPresentCaptureMethod","abstract":"

    Capture Method values that can be used as card-present payment method options.

    "},"Enums/SCPCardPresentRouting.html":{"name":"SCPCardPresentRouting","abstract":"

    Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.

    "},"Classes/SCPCardPresentDetails.html":{"name":"SCPCardPresentDetails","abstract":"

    An object representing details from a transaction using a card_present"},"Classes/SCPReceiptDetails.html":{"name":"SCPReceiptDetails","abstract":"

    Receipt details associated with a card present transaction.

    "},"Classes/SCPProcessPaymentError.html":{"name":"SCPProcessPaymentError","abstract":"

    An error from -[SCPTerminal processPayment:completion:].

    "},"Enums/SCPCardBrand.html":{"name":"SCPCardBrand","abstract":"

    The various card brands for a card.

    "},"Enums/SCPCardFundingType.html":{"name":"SCPCardFundingType","abstract":"

    The various funding sources for a card.

    "},"Classes/SCPCharge.html":{"name":"SCPCharge","abstract":"

    An object representing a Stripe charge.

    "},"Enums/SCPChargeStatus.html":{"name":"SCPChargeStatus","abstract":"

    The possible statuses for a charge

    "},"Classes/SCPPaymentMethodDetails.html":{"name":"SCPPaymentMethodDetails","abstract":"

    Details about a PaymentMethod at a specific time. ex: at time of transaction"},"Classes/SCPCardDetails.html":{"name":"SCPCardDetails","abstract":"

    Contains details about a user’s credit card.

    "},"Classes/SCPPaymentMethod.html":{"name":"SCPPaymentMethod","abstract":"

    PaymentMethod objects represent your customer’s payment instruments."},"Enums/SCPPaymentMethodType.html":{"name":"SCPPaymentMethodType","abstract":"

    The type of the PaymentMethod.

    "},"Classes/SCPPaymentMethodOptionsParameters.html":{"name":"SCPPaymentMethodOptionsParameters","abstract":"

    The PaymentMethodOptionsParameters contains options for PaymentMethod creation.

    "},"Classes/SCPCollectConfiguration.html":{"name":"SCPCollectConfiguration","abstract":"

    The CollectConfiguration contains configuration information relevant to collecting a payment"},"Enums/SCPCaptureMethod.html":{"name":"SCPCaptureMethod","abstract":"

    @abstract Controls when the funds will be captured from the customer’s account.

    "},"Classes/SCPTippingConfiguration.html":{"name":"SCPTippingConfiguration","abstract":"

    The TippingConfiguration contains configuration information relevant to collecting tips.

    "},"Classes/SCPNetworks.html":{"name":"SCPNetworks","abstract":"

    Contains information about card networks that can be used to process the payment.

    "},"Enums/SCPIncrementalAuthorizationStatus.html":{"name":"SCPIncrementalAuthorizationStatus","abstract":"

    Represents the ability for a PaymentIntent to be incrementally authorized.

    "},"Enums/SCPUpdateComponent.html#/c:@E@SCPUpdateComponent@SCPUpdateComponentIncremental":{"name":"SCPUpdateComponentIncremental","abstract":"

    If set, the update contains incremental changes to the reader. If this is","parent_name":"SCPUpdateComponent"},"Enums/SCPUpdateComponent.html#/c:@E@SCPUpdateComponent@SCPUpdateComponentFirmware":{"name":"SCPUpdateComponentFirmware","abstract":"

    If set, this update contains updated firmware for this reader. Firmware updates","parent_name":"SCPUpdateComponent"},"Enums/SCPUpdateComponent.html#/c:@E@SCPUpdateComponent@SCPUpdateComponentConfig":{"name":"SCPUpdateComponentConfig","abstract":"

    If set, this update contains a new configuration for this reader. These may","parent_name":"SCPUpdateComponent"},"Enums/SCPUpdateComponent.html#/c:@E@SCPUpdateComponent@SCPUpdateComponentKeys":{"name":"SCPUpdateComponentKeys","abstract":"

    If set, this update contains updated encryption keys for the reader.","parent_name":"SCPUpdateComponent"},"Enums/SCPUpdateTimeEstimate.html#/c:@E@SCPUpdateTimeEstimate@SCPUpdateTimeEstimateLessThan1Minute":{"name":"SCPUpdateTimeEstimateLessThan1Minute","abstract":"

    The update should take less than 1 minute to complete.

    ","parent_name":"SCPUpdateTimeEstimate"},"Enums/SCPUpdateTimeEstimate.html#/c:@E@SCPUpdateTimeEstimate@SCPUpdateTimeEstimate1To2Minutes":{"name":"SCPUpdateTimeEstimate1To2Minutes","abstract":"

    The update should take 1-2 minutes to complete.

    ","parent_name":"SCPUpdateTimeEstimate"},"Enums/SCPUpdateTimeEstimate.html#/c:@E@SCPUpdateTimeEstimate@SCPUpdateTimeEstimate2To5Minutes":{"name":"SCPUpdateTimeEstimate2To5Minutes","abstract":"

    The update should take 2-5 minutes to complete.

    ","parent_name":"SCPUpdateTimeEstimate"},"Enums/SCPUpdateTimeEstimate.html#/c:@E@SCPUpdateTimeEstimate@SCPUpdateTimeEstimate5To15Minutes":{"name":"SCPUpdateTimeEstimate5To15Minutes","abstract":"

    The update should take 5-15 minutes to complete.

    ","parent_name":"SCPUpdateTimeEstimate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(py)estimatedUpdateTime":{"name":"estimatedUpdateTime","abstract":"

    The estimated amount of time for the update.

    ","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(py)deviceSoftwareVersion":{"name":"deviceSoftwareVersion","abstract":"

    The target version for the update.

    ","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(py)components":{"name":"components","abstract":"

    The components that will be installed in this update.

    ","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(py)requiredAt":{"name":"requiredAt","abstract":"

    The date at which this update will be required to be installed. If this date","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(cm)stringFromUpdateTimeEstimate:":{"name":"+stringFromUpdateTimeEstimate:","abstract":"

    Returns an unlocalized string for the given update time estimate.

    ","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html":{"name":"SCPReaderSoftwareUpdate","abstract":"

    An object representing a reader update.

    "},"Enums/SCPUpdateTimeEstimate.html":{"name":"SCPUpdateTimeEstimate","abstract":"

    The estimated amount of time for an update. Note that these times are estimates;"},"Enums/SCPUpdateComponent.html":{"name":"SCPUpdateComponent","abstract":"

    A bitmask identifying what exact updates are contained within this update.

    "},"Classes/SCPCartLineItem.html#/c:objc(cs)SCPCartLineItem(py)quantity":{"name":"quantity","abstract":"

    The quantity of the line item being purchased.

    ","parent_name":"SCPCartLineItem"},"Classes/SCPCartLineItem.html#/c:objc(cs)SCPCartLineItem(py)displayName":{"name":"displayName","abstract":"

    The description or name of the item.

    ","parent_name":"SCPCartLineItem"},"Classes/SCPCartLineItem.html#/c:objc(cs)SCPCartLineItem(py)amount":{"name":"amount","abstract":"

    The price of the item, provided in the cart’s currency’s smallest unit.

    ","parent_name":"SCPCartLineItem"},"Classes/SCPCartLineItem.html#/c:objc(cs)SCPCartLineItem(im)initWithDisplayName:quantity:amount:":{"name":"-initWithDisplayName:quantity:amount:","abstract":"

    The values set here will be shown on the screen as-is. Make sure you’re","parent_name":"SCPCartLineItem"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(py)lineItems":{"name":"lineItems","abstract":"

    You can add or remove line items from this array individually or reassign the array entirely.","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(py)tax":{"name":"tax","abstract":"

    The displayed tax amount, provided in the currency’s smallest unit.

    ","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(py)total":{"name":"total","abstract":"

    The cart’s total balance, provided in the currency’s smallest unit.

    ","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(py)currency":{"name":"currency","abstract":"

    The currency of the cart.

    ","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(im)initWithCurrency:tax:total:":{"name":"-initWithCurrency:tax:total:","abstract":"

    Initializes an SCPCart with tax and total, in cents, as well as the currency.","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(im)init":{"name":"-init","abstract":"

    Use initWithTax:

    ","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(cm)new":{"name":"+new","abstract":"

    Use initWithTax:

    ","parent_name":"SCPCart"},"Enums/SCPBatteryStatus.html#/c:@E@SCPBatteryStatus@SCPBatteryStatusUnknown":{"name":"SCPBatteryStatusUnknown","abstract":"

    Battery state is not yet known or not available for the connected reader.

    ","parent_name":"SCPBatteryStatus"},"Enums/SCPBatteryStatus.html#/c:@E@SCPBatteryStatus@SCPBatteryStatusCritical":{"name":"SCPBatteryStatusCritical","abstract":"

    The device’s battery is less than or equal to 5%.

    ","parent_name":"SCPBatteryStatus"},"Enums/SCPBatteryStatus.html#/c:@E@SCPBatteryStatus@SCPBatteryStatusLow":{"name":"SCPBatteryStatusLow","abstract":"

    The device’s battery is between 5% and 20%.

    ","parent_name":"SCPBatteryStatus"},"Enums/SCPBatteryStatus.html#/c:@E@SCPBatteryStatus@SCPBatteryStatusNominal":{"name":"SCPBatteryStatusNominal","abstract":"

    The device’s battery is greater than 20%.

    ","parent_name":"SCPBatteryStatus"},"Enums/SCPReaderNetworkStatus.html#/c:@E@SCPReaderNetworkStatus@SCPReaderNetworkStatusOffline":{"name":"SCPReaderNetworkStatusOffline","abstract":"

    The reader is offline. Note that Chipper 2x and WisePad 3 will always report","parent_name":"SCPReaderNetworkStatus"},"Enums/SCPReaderNetworkStatus.html#/c:@E@SCPReaderNetworkStatus@SCPReaderNetworkStatusOnline":{"name":"SCPReaderNetworkStatusOnline","abstract":"

    The reader is online.

    ","parent_name":"SCPReaderNetworkStatus"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageRetryCard":{"name":"SCPReaderDisplayMessageRetryCard","abstract":"

    Retry the presented card.

    ","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageInsertCard":{"name":"SCPReaderDisplayMessageInsertCard","abstract":"

    Insert the presented card.

    ","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageInsertOrSwipeCard":{"name":"SCPReaderDisplayMessageInsertOrSwipeCard","abstract":"

    Insert or swipe the presented card.

    ","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageSwipeCard":{"name":"SCPReaderDisplayMessageSwipeCard","abstract":"

    Swipe the presented card.

    ","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageRemoveCard":{"name":"SCPReaderDisplayMessageRemoveCard","abstract":"

    Remove the presented card.

    ","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageMultipleContactlessCardsDetected":{"name":"SCPReaderDisplayMessageMultipleContactlessCardsDetected","abstract":"

    The reader detected multiple contactless cards. Make sure only one","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageTryAnotherReadMethod":{"name":"SCPReaderDisplayMessageTryAnotherReadMethod","abstract":"

    The card could not be read. Try another read method on the same card, or","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageTryAnotherCard":{"name":"SCPReaderDisplayMessageTryAnotherCard","abstract":"

    The card is invalid. Try another card.

    ","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderInputOptions.html#/c:@E@SCPReaderInputOptions@SCPReaderInputOptionNone":{"name":"SCPReaderInputOptionNone","abstract":"

    No input options are available on the reader.

    ","parent_name":"SCPReaderInputOptions"},"Enums/SCPReaderInputOptions.html#/c:@E@SCPReaderInputOptions@SCPReaderInputOptionSwipeCard":{"name":"SCPReaderInputOptionSwipeCard","abstract":"

    Swipe a magstripe card.

    ","parent_name":"SCPReaderInputOptions"},"Enums/SCPReaderInputOptions.html#/c:@E@SCPReaderInputOptions@SCPReaderInputOptionInsertCard":{"name":"SCPReaderInputOptionInsertCard","abstract":"

    Insert a chip card.

    ","parent_name":"SCPReaderInputOptions"},"Enums/SCPReaderInputOptions.html#/c:@E@SCPReaderInputOptions@SCPReaderInputOptionTapCard":{"name":"SCPReaderInputOptionTapCard","abstract":"

    Tap a contactless card.

    ","parent_name":"SCPReaderInputOptions"},"Enums/SCPReaderEvent.html#/c:@E@SCPReaderEvent@SCPReaderEventCardInserted":{"name":"SCPReaderEventCardInserted","abstract":"

    A card was inserted.

    ","parent_name":"SCPReaderEvent"},"Enums/SCPReaderEvent.html#/c:@E@SCPReaderEvent@SCPReaderEventCardRemoved":{"name":"SCPReaderEventCardRemoved","abstract":"

    A card was removed.

    ","parent_name":"SCPReaderEvent"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didStartInstallingUpdate:cancelable:":{"name":"-localMobileReader:didStartInstallingUpdate:cancelable:","abstract":"

    The reader has started installing a software update.

    ","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didReportReaderSoftwareUpdateProgress:":{"name":"-localMobileReader:didReportReaderSoftwareUpdateProgress:","abstract":"

    The reader reported progress on a software update.

    ","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didFinishInstallingUpdate:error:":{"name":"-localMobileReader:didFinishInstallingUpdate:error:","abstract":"

    The reader has finished installing an update.

    ","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didRequestReaderInput:":{"name":"-localMobileReader:didRequestReaderInput:","abstract":"

    This method is called when the reader begins waiting for input.","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didRequestReaderDisplayMessage:":{"name":"-localMobileReader:didRequestReaderDisplayMessage:","abstract":"

    This method is called to request that a prompt be displayed in your app.","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReaderDidAcceptTermsOfService:":{"name":"-localMobileReaderDidAcceptTermsOfService:","abstract":"

    The reader is reporting that, as part of preparing to accept payments,","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didReportAvailableUpdate:":{"name":"-reader:didReportAvailableUpdate:","abstract":"

    The SDK is reporting that an update is available for the reader.","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didStartInstallingUpdate:cancelable:":{"name":"-reader:didStartInstallingUpdate:cancelable:","abstract":"

    The SDK is reporting that the reader has started installing a software update.

    ","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didReportReaderSoftwareUpdateProgress:":{"name":"-reader:didReportReaderSoftwareUpdateProgress:","abstract":"

    The reader reported progress on a software update.

    ","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didFinishInstallingUpdate:error:":{"name":"-reader:didFinishInstallingUpdate:error:","abstract":"

    The reader is reporting that an installation has finished. If the install was","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didRequestReaderInput:":{"name":"-reader:didRequestReaderInput:","abstract":"

    This method is called when the reader begins waiting for input. Your app","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didRequestReaderDisplayMessage:":{"name":"-reader:didRequestReaderDisplayMessage:","abstract":"

    This method is called to request that a prompt be displayed in your app.","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didReportReaderEvent:info:":{"name":"-reader:didReportReaderEvent:info:","abstract":"

    The SDK reported an event from the reader (e.g. a card was inserted).

    ","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didReportBatteryLevel:status:isCharging:":{"name":"-reader:didReportBatteryLevel:status:isCharging:","abstract":"

    The SDK reported the reader’s battery level or charging state has changed.

    ","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)readerDidReportLowBatteryWarning:":{"name":"-readerDidReportLowBatteryWarning:","abstract":"

    This method is called when the SDK’s currently connected reader has a low battery.

    ","parent_name":"SCPBluetoothReaderDelegate"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeChipper2X":{"name":"SCPDeviceTypeChipper2X","abstract":"

    The BBPOS Chipper 2X BT mobile reader.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeVerifoneP400":{"name":"SCPDeviceTypeVerifoneP400","abstract":"

    The Verifone P400 countertop reader.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeWisePad3":{"name":"SCPDeviceTypeWisePad3","abstract":"

    The BBPOS WisePad 3 mobile reader.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeStripeM2":{"name":"SCPDeviceTypeStripeM2","abstract":"

    The Stripe Reader M2 mobile reader.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeWisePosE":{"name":"SCPDeviceTypeWisePosE","abstract":"

    The BBPOS WisePOS E countertop reader.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeWisePosEDevKit":{"name":"SCPDeviceTypeWisePosEDevKit","abstract":"

    The BBPOS WisePOS E DevKit countertop reader.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeStripeS700":{"name":"SCPDeviceTypeStripeS700","abstract":"

    Stripe Reader S700.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeStripeS700DevKit":{"name":"SCPDeviceTypeStripeS700DevKit","abstract":"

    Stripe Reader S700 DevKit.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeAppleBuiltIn":{"name":"SCPDeviceTypeAppleBuiltIn","abstract":"

    Apple Built-In reader.

    ","parent_name":"SCPDeviceType"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)deviceType":{"name":"deviceType","abstract":"

    The reader’s device type.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)simulated":{"name":"simulated","abstract":"

    True if this is a simulated reader.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)stripeId":{"name":"stripeId","abstract":"

    The Stripe unique identifier for the reader.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)locationId":{"name":"locationId","abstract":"

    The ID of the reader’s Location.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)locationStatus":{"name":"locationStatus","abstract":"

    Used to tell whether the location field has been set.","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)location":{"name":"location","abstract":"

    The details of the location this reader is registered to, if any.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)serialNumber":{"name":"serialNumber","abstract":"

    The reader’s serial number.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)deviceSoftwareVersion":{"name":"deviceSoftwareVersion","abstract":"

    The reader’s current device software version, or nil if this information is","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)availableUpdate":{"name":"availableUpdate","abstract":"

    The available update for this reader, or nil if no update is available.","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)batteryLevel":{"name":"batteryLevel","abstract":"

    The reader’s battery level, represented as a boxed float in the range [0, 1].","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)batteryStatus":{"name":"batteryStatus","abstract":"

    The reader’s battery status. Usable as a general classification for the current","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)isCharging":{"name":"isCharging","abstract":"

    The reader’s charging state, represented as a BOOL","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)ipAddress":{"name":"ipAddress","abstract":"

    The IP address of the reader.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)status":{"name":"status","abstract":"

    The networking status of the reader: either offline or online. Note that","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)label":{"name":"label","abstract":"

    A custom label that may be given to a reader for easier identification.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html":{"name":"SCPReader","abstract":"

    Information about a card reader that has been discovered by or connected to"},"Enums/SCPDeviceType.html":{"name":"SCPDeviceType","abstract":"

    The possible device types for a reader.

    "},"Protocols/SCPBluetoothReaderDelegate.html":{"name":"SCPBluetoothReaderDelegate","abstract":"

    Implement this protocol to handle a connected Bluetooth reader’s events throughout"},"Protocols/SCPLocalMobileReaderDelegate.html":{"name":"SCPLocalMobileReaderDelegate","abstract":"

    Implement this protocol to handle a connected local mobile reader’s events throughout"},"Enums/SCPReaderEvent.html":{"name":"SCPReaderEvent","abstract":"

    The possible events from a connected reader. Used by [SCPBluetoothReaderDelegate reader:didReportReaderEvent:info:].

    "},"Enums/SCPReaderInputOptions.html":{"name":"SCPReaderInputOptions","abstract":"

    This OptionSet represents all of the input methods available to your user when"},"Enums/SCPReaderDisplayMessage.html":{"name":"SCPReaderDisplayMessage","abstract":"

    The display messages that a reader may request be displayed by your app. Used by [SCPBluetoothReaderDelegate reader:didRequestReaderDisplayMessage:].

    "},"Enums/SCPReaderNetworkStatus.html":{"name":"SCPReaderNetworkStatus","abstract":"

    The possible networking statuses for a reader.

    "},"Enums/SCPBatteryStatus.html":{"name":"SCPBatteryStatus","abstract":"

    A categorization of a reader’s battery charge level.

    "},"Classes/SCPCart.html":{"name":"SCPCart","abstract":"

    An SCPCart object contains information about what line items are included in"},"Classes/SCPCartLineItem.html":{"name":"SCPCartLineItem","abstract":"

    Represents a single line item in an SCPCart, displayed on the reader’s screen"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeVisa":{"name":"SCPSimulatedCardTypeVisa","abstract":"

    Visa

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeVisaDebit":{"name":"SCPSimulatedCardTypeVisaDebit","abstract":"

    Visa (debit)

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeMastercard":{"name":"SCPSimulatedCardTypeMastercard","abstract":"

    Mastercard

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeMasterDebit":{"name":"SCPSimulatedCardTypeMasterDebit","abstract":"

    Mastercard (debit)

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeMastercardPrepaid":{"name":"SCPSimulatedCardTypeMastercardPrepaid","abstract":"

    Mastercard (prepaid)

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeAmex":{"name":"SCPSimulatedCardTypeAmex","abstract":"

    American Express

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeAmex2":{"name":"SCPSimulatedCardTypeAmex2","abstract":"

    American Express

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeDiscover":{"name":"SCPSimulatedCardTypeDiscover","abstract":"

    Discover

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeDiscover2":{"name":"SCPSimulatedCardTypeDiscover2","abstract":"

    Discover

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeDiners":{"name":"SCPSimulatedCardTypeDiners","abstract":"

    Diners Club

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeDiners14Digit":{"name":"SCPSimulatedCardTypeDiners14Digit","abstract":"

    Diners Club (14 digit card)

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeJcb":{"name":"SCPSimulatedCardTypeJcb","abstract":"

    JCB

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeUnionPay":{"name":"SCPSimulatedCardTypeUnionPay","abstract":"

    UnionPay

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeInterac":{"name":"SCPSimulatedCardTypeInterac","abstract":"

    Interac

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeEftposAuDebit":{"name":"SCPSimulatedCardTypeEftposAuDebit","abstract":"

    Eftpos Australia

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclined":{"name":"SCPSimulatedCardTypeChargeDeclined","abstract":"

    Charge is declined with a card_declined code.

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedInsufficientFunds":{"name":"SCPSimulatedCardTypeChargeDeclinedInsufficientFunds","abstract":"

    Charge is declined with a card_declined code. The decline_code","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedLostCard":{"name":"SCPSimulatedCardTypeChargeDeclinedLostCard","abstract":"

    Charge is declined with a card_declined code. The decline_code","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedStolenCard":{"name":"SCPSimulatedCardTypeChargeDeclinedStolenCard","abstract":"

    Charge is declined with a card_declined code. The decline_code","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedExpiredCard":{"name":"SCPSimulatedCardTypeChargeDeclinedExpiredCard","abstract":"

    Charge is declined with an expired_card code.

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedProcessingError":{"name":"SCPSimulatedCardTypeChargeDeclinedProcessingError","abstract":"

    Charge is declined with a processing_error code.

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeRefundFailed":{"name":"SCPSimulatedCardTypeRefundFailed","abstract":"

    Refund is declined with a refund_fail error.

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeOnlinePinCvm":{"name":"SCPSimulatedCardTypeOnlinePinCvm","abstract":"

    Payment attaches Online Pin to the transaction.","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeOnlinePinScaRetry":{"name":"SCPSimulatedCardTypeOnlinePinScaRetry","abstract":"

    This flow simulates an Online Pin scenario with SCA compliance.","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeOfflinePinCvm":{"name":"SCPSimulatedCardTypeOfflinePinCvm","abstract":"

    Payment attaches Offline Pin to the transaction.","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeOfflinePinScaRetry":{"name":"SCPSimulatedCardTypeOfflinePinScaRetry","abstract":"

    This flow simulates an Offline Pin scenario with SCA compliance.","parent_name":"SCPSimulatedCardType"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)initWithType:":{"name":"-initWithType:","abstract":"

    Create a Simulated Card object with a given simulated card type.

    ","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)initWithTestCardNumber:":{"name":"-initWithTestCardNumber:","abstract":"

    Create a Simulated Card object with a raw card number. This initializer is","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)init":{"name":"-init","abstract":"

    You cannot instantiate this class without specifying a type or testcard number.

    ","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)isOnlinePin":{"name":"-isOnlinePin","abstract":"

    Returns true if the card is online pin enabled.

    ","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)isOfflinePin":{"name":"-isOfflinePin","abstract":"

    Returns true if the card is offline pin enabled.

    ","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(cm)new":{"name":"+new","abstract":"

    You cannot instantiate this class without specifying a type or testcard number.

    ","parent_name":"SCPSimulatedCard"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateAvailable":{"name":"SCPSimulateReaderUpdateAvailable","abstract":"

    Default value.

    ","parent_name":"SCPSimulateReaderUpdate"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateNone":{"name":"SCPSimulateReaderUpdateNone","abstract":"

    No updates are available

    ","parent_name":"SCPSimulateReaderUpdate"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateRequired":{"name":"SCPSimulateReaderUpdateRequired","abstract":"

    A required full reader software update exists. Use this to simulate the","parent_name":"SCPSimulateReaderUpdate"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateLowBattery":{"name":"SCPSimulateReaderUpdateLowBattery","abstract":"

    A required update exists.

    ","parent_name":"SCPSimulateReaderUpdate"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateRandom":{"name":"SCPSimulateReaderUpdateRandom","abstract":"

    Randomly picks a type of update for the reader to help exercise the","parent_name":"SCPSimulateReaderUpdate"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(py)availableReaderUpdate":{"name":"availableReaderUpdate","abstract":"

    Set this to different values of the SCPSimulateReaderUpdate enum to","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(py)simulatedCard":{"name":"simulatedCard","abstract":"

    Create a SCPSimulatedCard and set it on the shared configuration object to","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)city":{"name":"city","abstract":"

    The city name

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)country":{"name":"country","abstract":"

    The country code

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)line1":{"name":"line1","abstract":"

    The first line of the address

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)line2":{"name":"line2","abstract":"

    The second line of the address

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)postalCode":{"name":"postalCode","abstract":"

    The postal code of the address

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)state":{"name":"state","abstract":"

    The state of the address

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPAddress"},"Enums/SCPLocationStatus.html#/c:@E@SCPLocationStatus@SCPLocationStatusUnknown":{"name":"SCPLocationStatusUnknown","abstract":"

    The location is not known. location will be nil.

    ","parent_name":"SCPLocationStatus"},"Enums/SCPLocationStatus.html#/c:@E@SCPLocationStatus@SCPLocationStatusSet":{"name":"SCPLocationStatusSet","abstract":"

    The location was successfully set to a known location.","parent_name":"SCPLocationStatus"},"Enums/SCPLocationStatus.html#/c:@E@SCPLocationStatus@SCPLocationStatusNotSet":{"name":"SCPLocationStatusNotSet","abstract":"

    This location is known to be not set. location will be nil.

    ","parent_name":"SCPLocationStatus"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)stripeId":{"name":"stripeId","abstract":"

    The ID of the Location

    ","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)address":{"name":"address","abstract":"

    The address of this Location

    ","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)displayName":{"name":"displayName","abstract":"

    The display name of this Location

    ","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)livemode":{"name":"livemode","abstract":"

    Whether this Location was created in livemode

    ","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)metadata":{"name":"metadata","abstract":"

    Any metadata attached to this Location

    ","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPLocation"},"Classes/SCPListLocationsParameters.html#/c:objc(cs)SCPListLocationsParameters(py)limit":{"name":"limit","abstract":"

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    ","parent_name":"SCPListLocationsParameters"},"Classes/SCPListLocationsParameters.html#/c:objc(cs)SCPListLocationsParameters(py)endingBefore":{"name":"endingBefore","abstract":"

    A cursor for use in pagination. ending_before is an object ID that defines","parent_name":"SCPListLocationsParameters"},"Classes/SCPListLocationsParameters.html#/c:objc(cs)SCPListLocationsParameters(py)startingAfter":{"name":"startingAfter","abstract":"

    A cursor for use in pagination. starting_after is an object ID that defines","parent_name":"SCPListLocationsParameters"},"Classes/SCPListLocationsParameters.html#/c:objc(cs)SCPListLocationsParameters(im)initWithLimit:endingBefore:startingAfter:":{"name":"-initWithLimit:endingBefore:startingAfter:","abstract":"

    Initializes SCPListLocationsParameters with the given parameters.

    ","parent_name":"SCPListLocationsParameters"},"Enums/SCPConnectionStatus.html#/c:@E@SCPConnectionStatus@SCPConnectionStatusNotConnected":{"name":"SCPConnectionStatusNotConnected","abstract":"

    The SDK is not connected to a reader.

    ","parent_name":"SCPConnectionStatus"},"Enums/SCPConnectionStatus.html#/c:@E@SCPConnectionStatus@SCPConnectionStatusConnected":{"name":"SCPConnectionStatusConnected","abstract":"

    The SDK is connected to a reader.

    ","parent_name":"SCPConnectionStatus"},"Enums/SCPConnectionStatus.html#/c:@E@SCPConnectionStatus@SCPConnectionStatusConnecting":{"name":"SCPConnectionStatusConnecting","abstract":"

    The SDK is currently connecting to a reader.

    ","parent_name":"SCPConnectionStatus"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(py)locationId":{"name":"locationId","abstract":"

    The ID of the Location which the reader should be","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(py)onBehalfOf":{"name":"onBehalfOf","abstract":"

    If your integration is creating destination charges and using on_behalf_of, you must provide the","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(py)merchantDisplayName":{"name":"merchantDisplayName","abstract":"

    Optional cardholder facing merchant display name that will be used in the prompt for the cardholder","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(py)tosAcceptancePermitted":{"name":"tosAcceptancePermitted","abstract":"

    In order to connect to a reader, merchant-specific terms of service may need to be accepted.","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(im)initWithLocationId:":{"name":"-initWithLocationId:","abstract":"

    Initialize ConnectionConfiguration with a location ID.

    ","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(im)initWithLocationId:merchantDisplayName:onBehalfOf:":{"name":"-initWithLocationId:merchantDisplayName:onBehalfOf:","abstract":"

    Initialize ConnectionConfiguration with a location ID, custom merchant display name, and ‘on behalf of’","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(im)initWithLocationId:merchantDisplayName:onBehalfOf:tosAcceptancePermitted:":{"name":"-initWithLocationId:merchantDisplayName:onBehalfOf:tosAcceptancePermitted:","abstract":"

    Initialize ConnectionConfiguration with a location ID, custom merchant display name, ‘on behalf of’","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(py)failIfInUse":{"name":"failIfInUse","abstract":"

    When set to true, the connection will automatically error if the reader is already","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(py)allowCustomerCancel":{"name":"allowCustomerCancel","abstract":"

    If set to true, the customer will be able to press the red X button on the","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(im)initWithFailIfInUse:allowCustomerCancel:":{"name":"-initWithFailIfInUse:allowCustomerCancel:","abstract":"

    Initialize an InternetConnectionConfiguration object with all possible properties.

    ","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(im)initWithFailIfInUse:":{"name":"-initWithFailIfInUse:","abstract":"

    Initalize an InternetConnectionConfiguration object and set the failIfInUse","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(im)initWithAllowCustomerCancel:":{"name":"-initWithAllowCustomerCancel:","abstract":"

    Initialize an InternetConnectionConfiguration object and set the","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(py)locationId":{"name":"locationId","abstract":"

    The ID of the Location which the reader should be registered to during connection.

    ","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(py)autoReconnectOnUnexpectedDisconnect":{"name":"autoReconnectOnUnexpectedDisconnect","abstract":"

    When set to true, the Terminal SDK will attempt a Bluetooth auto-reconnection on any unexpected disconnect.","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(py)autoReconnectionDelegate":{"name":"autoReconnectionDelegate","abstract":"

    Contains callback methods for Bluetooth auto-reconnection.

    ","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(im)initWithLocationId:":{"name":"-initWithLocationId:","abstract":"

    Initialize your connect options with a location ID.

    ","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(im)initWithLocationId:autoReconnectOnUnexpectedDisconnect:autoReconnectionDelegate:":{"name":"-initWithLocationId:autoReconnectOnUnexpectedDisconnect:autoReconnectionDelegate:","abstract":"

    Initialize your connect options with a location ID and an expected behavior for unexpected disconnects.

    ","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(im)initWithDiscoveryMethod:simulated:":{"name":"-initWithDiscoveryMethod:simulated:","abstract":"

    Initializes a discovery configuration with the given discovery method. All discoverable readers","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(im)initWithDiscoveryMethod:locationId:simulated:":{"name":"-initWithDiscoveryMethod:locationId:simulated:","abstract":"

    This variant of the initializer lets you specify a Location to filter the","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(py)timeout":{"name":"timeout","abstract":"

    The timeout (in seconds) after which discoverReaders: should fail. If the","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(py)discoveryMethod":{"name":"discoveryMethod","abstract":"

    The method by which to discover readers.

    ","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(py)simulated":{"name":"simulated","abstract":"

    Whether to use simulated discovery to discover a device simulator.

    ","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(py)locationId":{"name":"locationId","abstract":"

    A location ID that can be used to filter discovery result so only readers","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(im)init":{"name":"-init","abstract":"

    Use initWithDiscoveryMethod:simulated:

    ","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(cm)new":{"name":"+new","abstract":"

    Use initWithDiscoveryMethod:simulated:

    ","parent_name":"SCPDiscoveryConfiguration"},"Protocols/SCPDiscoveryDelegate.html#/c:objc(pl)SCPDiscoveryDelegate(im)terminal:didUpdateDiscoveredReaders:":{"name":"-terminal:didUpdateDiscoveredReaders:","abstract":"

    This method will be called repeatedly until:

    ","parent_name":"SCPDiscoveryDelegate"},"Enums/SCPDiscoveryMethod.html#/c:@E@SCPDiscoveryMethod@SCPDiscoveryMethodBluetoothScan":{"name":"SCPDiscoveryMethodBluetoothScan","abstract":"

    The Bluetooth Scan discovery method searches for Stripe Terminal’s","parent_name":"SCPDiscoveryMethod"},"Enums/SCPDiscoveryMethod.html#/c:@E@SCPDiscoveryMethod@SCPDiscoveryMethodBluetoothProximity":{"name":"SCPDiscoveryMethodBluetoothProximity","abstract":"

    The Bluetooth Proximity discovery method searches for a subset of","parent_name":"SCPDiscoveryMethod"},"Enums/SCPDiscoveryMethod.html#/c:@E@SCPDiscoveryMethod@SCPDiscoveryMethodInternet":{"name":"SCPDiscoveryMethodInternet","abstract":"

    The Internet discovery method searches for internet-connected readers,","parent_name":"SCPDiscoveryMethod"},"Enums/SCPDiscoveryMethod.html#/c:@E@SCPDiscoveryMethod@SCPDiscoveryMethodLocalMobile":{"name":"SCPDiscoveryMethodLocalMobile","abstract":"

    The Local Mobile discovery method searches for any readers built into the","parent_name":"SCPDiscoveryMethod"},"Enums/SCPDiscoveryMethod.html":{"name":"SCPDiscoveryMethod","abstract":"

    The possible methods for discovering a reader. Pass a variant of this enum"},"Protocols/SCPDiscoveryDelegate.html":{"name":"SCPDiscoveryDelegate","abstract":"

    Implement this protocol to handle a continually updating list"},"Classes/SCPDiscoveryConfiguration.html":{"name":"SCPDiscoveryConfiguration","abstract":"

    Configuration options for discovering readers.

    "},"Classes/SCPBluetoothConnectionConfiguration.html":{"name":"SCPBluetoothConnectionConfiguration","abstract":"

    This class lets you define Bluetooth reader connection options.

    "},"Classes/SCPInternetConnectionConfiguration.html":{"name":"SCPInternetConnectionConfiguration","abstract":"

    This class lets you set options that define internet reader behavior throughout a given"},"Classes/SCPLocalMobileConnectionConfiguration.html":{"name":"SCPLocalMobileConnectionConfiguration","abstract":"

    This class lets you set options that define local mobile reader behavior throughout a given"},"Enums/SCPConnectionStatus.html":{"name":"SCPConnectionStatus","abstract":"

    The possible reader connection statuses for the SDK.

    "},"Classes/SCPListLocationsParameters.html":{"name":"SCPListLocationsParameters","abstract":"

    Parameters to be used when calling Terminal.shared.listLocations() to list"},"Classes/SCPLocation.html":{"name":"SCPLocation","abstract":"

    A Location is used to group readers in the Stripe Terminal ecosystem. The"},"Enums/SCPLocationStatus.html":{"name":"SCPLocationStatus","abstract":"

    Represents the possible states of the location object for a"},"Classes/SCPAddress.html":{"name":"SCPAddress","abstract":"

    Holds address data associated with a given SCPLocation.

    "},"Classes/SCPSimulatorConfiguration.html":{"name":"SCPSimulatorConfiguration","abstract":"

    Simulator specific configurations you can set to test your integration’s"},"Enums/SCPSimulateReaderUpdate.html":{"name":"SCPSimulateReaderUpdate","abstract":"

    Enum used to simulate various types of reader updates being available for"},"Classes/SCPSimulatedCard.html":{"name":"SCPSimulatedCard","abstract":"

    Simulated Card objects can be used with the shared SCPSimulatorConfiguration"},"Enums/SCPSimulatedCardType.html":{"name":"SCPSimulatedCardType","abstract":"

    Enum used to simulate various types of cards and error cases.

    "},"Protocols/SCPJSONDecodable.html#/c:objc(pl)SCPJSONDecodable(cm)decodedObjectFromJSON:":{"name":"+decodedObjectFromJSON:","abstract":"

    Parses a JSON dictionary into an instance of the class. Returns nil if the","parent_name":"SCPJSONDecodable"},"Protocols/SCPJSONDecodable.html#/c:objc(pl)SCPJSONDecodable(py)originalJSON":{"name":"originalJSON","abstract":"

    The raw JSON used to create the object. This may be useful for accessing","parent_name":"SCPJSONDecodable"},"Classes/SCPCancelable.html#/c:objc(cs)SCPCancelable(py)completed":{"name":"completed","abstract":"

    Indicates whether the command has completed. After the command has completed,","parent_name":"SCPCancelable"},"Classes/SCPCancelable.html#/c:objc(cs)SCPCancelable(im)cancel:":{"name":"-cancel:","abstract":"

    Attempts to cancel the action in progress. If the action could not be canceled,","parent_name":"SCPCancelable"},"Enums/SCPLogLevel.html#/c:@E@SCPLogLevel@SCPLogLevelNone":{"name":"SCPLogLevelNone","abstract":"

    No logs will printed to the console.

    ","parent_name":"SCPLogLevel"},"Enums/SCPLogLevel.html#/c:@E@SCPLogLevel@SCPLogLevelVerbose":{"name":"SCPLogLevelVerbose","abstract":"

    Verbose logs will be printed to the console.

    ","parent_name":"SCPLogLevel"},"Protocols/SCPReconnectionDelegate.html#/c:objc(pl)SCPReconnectionDelegate(im)terminal:didStartReaderReconnect:":{"name":"-terminal:didStartReaderReconnect:","abstract":"

    The reader has lost Bluetooth connection to the SDK and reconnection attempts have been started.

    ","parent_name":"SCPReconnectionDelegate"},"Protocols/SCPReconnectionDelegate.html#/c:objc(pl)SCPReconnectionDelegate(im)terminalDidSucceedReaderReconnect:":{"name":"-terminalDidSucceedReaderReconnect:","abstract":"

    The SDK was able to reconnect to the previously connected Bluetooth reader.

    ","parent_name":"SCPReconnectionDelegate"},"Protocols/SCPReconnectionDelegate.html#/c:objc(pl)SCPReconnectionDelegate(im)terminalDidFailReaderReconnect:":{"name":"-terminalDidFailReaderReconnect:","abstract":"

    The SDK was not able to reconnect to the previously connected bluetooth reader. The SDK is now disconnected from any readers.

    ","parent_name":"SCPReconnectionDelegate"},"Protocols/SCPTerminalDelegate.html#/c:objc(pl)SCPTerminalDelegate(im)terminal:didReportUnexpectedReaderDisconnect:":{"name":"-terminal:didReportUnexpectedReaderDisconnect:","abstract":"

    The reader disconnected unexpectedly (that is, without your app explicitly","parent_name":"SCPTerminalDelegate"},"Protocols/SCPTerminalDelegate.html#/c:objc(pl)SCPTerminalDelegate(im)terminal:didChangeConnectionStatus:":{"name":"-terminal:didChangeConnectionStatus:","abstract":"

    The currently connected reader’s connectionStatus changed.

    ","parent_name":"SCPTerminalDelegate"},"Protocols/SCPTerminalDelegate.html#/c:objc(pl)SCPTerminalDelegate(im)terminal:didChangePaymentStatus:":{"name":"-terminal:didChangePaymentStatus:","abstract":"

    The currently connected reader’s paymentStatus changed.

    ","parent_name":"SCPTerminalDelegate"},"Protocols/SCPConnectionTokenProvider.html#/c:objc(pl)SCPConnectionTokenProvider(im)fetchConnectionToken:":{"name":"-fetchConnectionToken:","abstract":"

    Fetches a connection token from your backend server.

    ","parent_name":"SCPConnectionTokenProvider"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)setTokenProvider:":{"name":"+setTokenProvider:","abstract":"

    Sets the token provider for the shared (singleton) SCPTerminal instance.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)hasTokenProvider":{"name":"+hasTokenProvider","abstract":"

    Returns true if a token provider has been set, through setTokenProvider:

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)setLogListener:":{"name":"+setLogListener:","abstract":"

    Sets a block to listen for logs from the shared Terminal instance (optional).

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cpy)shared":{"name":"shared","abstract":"

    Returns the shared (singleton) Terminal instance.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)delegate":{"name":"delegate","abstract":"

    The Terminal singleton object’s primary delegate. This delegate announces","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)connectedReader":{"name":"connectedReader","abstract":"

    Information about the connected SCPReader, or nil if no reader is connected.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)connectionStatus":{"name":"connectionStatus","abstract":"

    The Terminal instance’s current connection status.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)logLevel":{"name":"logLevel","abstract":"

    The log level for the SDK. The default value is .none.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)simulatorConfiguration":{"name":"simulatorConfiguration","abstract":"

    The simulator configuration settings that will be used when connecting to","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)paymentStatus":{"name":"paymentStatus","abstract":"

    The Terminal instance’s current payment status.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)clearCachedCredentials":{"name":"-clearCachedCredentials","abstract":"

    Clears the current connection token, saved reader sessions, and any other","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)supportsReadersOfType:discoveryMethod:simulated:error:":{"name":"-supportsReadersOfType:discoveryMethod:simulated:error:","abstract":"

    Use this method to determine whether the mobile device supports a given reader type","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)discoverReaders:delegate:completion:":{"name":"-discoverReaders:delegate:completion:","abstract":"

    Begins discovering readers based on the given discovery configuration.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)connectBluetoothReader:delegate:connectionConfig:completion:":{"name":"-connectBluetoothReader:delegate:connectionConfig:completion:","abstract":"

    Attempts to connect to the given Bluetooth reader with a given connection","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)connectInternetReader:connectionConfig:completion:":{"name":"-connectInternetReader:connectionConfig:completion:","abstract":"

    Attempts to connect to the given Internet reader with a given connection","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)connectLocalMobileReader:delegate:connectionConfig:completion:":{"name":"-connectLocalMobileReader:delegate:connectionConfig:completion:","abstract":"

    Attempts to connect to the given Local Mobile reader with a given","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)listLocations:completion:":{"name":"-listLocations:completion:","abstract":"

    Retrieves a list of SCPLocation objects belonging to your merchant. You must specify","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)installAvailableUpdate":{"name":"-installAvailableUpdate","abstract":"

    Installs the available update for the connected reader.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)disconnectReader:":{"name":"-disconnectReader:","abstract":"

    Attempts to disconnect from the currently connected reader.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)createPaymentIntent:completion:":{"name":"-createPaymentIntent:completion:","abstract":"

    Creates a new SCPPaymentIntent with the given parameters.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)retrievePaymentIntent:completion:":{"name":"-retrievePaymentIntent:completion:","abstract":"

    Retrieves a SCPPaymentIntent with a client secret.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectPaymentMethod:completion:":{"name":"-collectPaymentMethod:completion:","abstract":"

    Collects a payment method for the given SCPPaymentIntent.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectPaymentMethod:collectConfig:completion:":{"name":"-collectPaymentMethod:collectConfig:completion:","abstract":"

    Collects a payment method for the given PaymentIntent, with the specified configuration.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)processPayment:completion:":{"name":"-processPayment:completion:","abstract":"

    Processes a payment after collecting a payment method succeeds.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)cancelPaymentIntent:completion:":{"name":"-cancelPaymentIntent:completion:","abstract":"

    Cancels an SCPPaymentIntent.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)readReusableCard:completion:":{"name":"-readReusableCard:completion:","abstract":"

    Reads a card with the given parameters and returns a PaymentMethod.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)createSetupIntent:completion:":{"name":"-createSetupIntent:completion:","abstract":"

    Creates a new SCPSetupIntent with the given parameters.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)retrieveSetupIntent:completion:":{"name":"-retrieveSetupIntent:completion:","abstract":"

    Retrieves an SCPSetupIntent with a client secret.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)cancelSetupIntent:completion:":{"name":"-cancelSetupIntent:completion:","abstract":"

    Cancels an SCPPaymentIntent.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectSetupIntentPaymentMethod:customerConsentCollected:completion:":{"name":"-collectSetupIntentPaymentMethod:customerConsentCollected:completion:","abstract":"

    Collects a payment method for the given SCPSetupIntent.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)confirmSetupIntent:completion:":{"name":"-confirmSetupIntent:completion:","abstract":"

    Confirms a SetupIntent after the payment method has been successfully collected.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectRefundPaymentMethod:completion:":{"name":"-collectRefundPaymentMethod:completion:","abstract":"

    Initiates an in-person refund with a given set of SCPRefundParameters by","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)processRefund:":{"name":"-processRefund:","abstract":"

    Processes an in-person refund after the refund payment method has been collected.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)clearReaderDisplay:":{"name":"-clearReaderDisplay:","abstract":"

    Clears the reader display and resets it to the splash screen.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)setReaderDisplay:completion:":{"name":"-setReaderDisplay:completion:","abstract":"

    Updates the reader display with cart information.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromReaderInputOptions:":{"name":"+stringFromReaderInputOptions:","abstract":"

    Returns an unlocalized string for the given reader input options, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromReaderDisplayMessage:":{"name":"+stringFromReaderDisplayMessage:","abstract":"

    Returns an unlocalized string for the given reader display message, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromReaderEvent:":{"name":"+stringFromReaderEvent:","abstract":"

    Returns an unlocalized string for the given reader event, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromConnectionStatus:":{"name":"+stringFromConnectionStatus:","abstract":"

    Returns an unlocalized string for the given connection status, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromPaymentStatus:":{"name":"+stringFromPaymentStatus:","abstract":"

    Returns an unlocalized string for the given payment status, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromDeviceType:":{"name":"+stringFromDeviceType:","abstract":"

    Returns an unlocalized string for the given device type.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromDiscoveryMethod:":{"name":"+stringFromDiscoveryMethod:","abstract":"

    Returns an unlocalized string for the given discovery method.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromCardBrand:":{"name":"+stringFromCardBrand:","abstract":"

    Returns an unlocalized string for the given card brand.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromPaymentIntentStatus:":{"name":"+stringFromPaymentIntentStatus:","abstract":"

    Returns an unlocalized string for the given payment intent status.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)init":{"name":"-init","abstract":"

    Use initWithConfiguration:tokenProvider:delegate:

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)new":{"name":"+new","abstract":"

    Use initWithConfiguration:tokenProvider:delegate:

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html":{"name":"SCPTerminal","abstract":"

    The SCPTerminal singleton object exposes an interface for discovering readers,"},"Protocols/SCPConnectionTokenProvider.html":{"name":"SCPConnectionTokenProvider","abstract":"

    Before integrating the SDK, you should create an endpoint on your backend"},"Protocols/SCPTerminalDelegate.html":{"name":"SCPTerminalDelegate","abstract":"

    Implement this protocol to handle connection and payment updates from the"},"Protocols/SCPReconnectionDelegate.html":{"name":"SCPReconnectionDelegate","abstract":"

    Implement this protocol to handle bluetooth auto-reconnection.

    "},"Enums/SCPLogLevel.html":{"name":"SCPLogLevel","abstract":"

    The various log levels for the SDK.

    "},"Classes/SCPCancelable.html":{"name":"SCPCancelable","abstract":"

    An object representing an action that can be canceled.

    "},"Protocols/SCPJSONDecodable.html":{"name":"SCPJSONDecodable","abstract":"

    Objects conforming to this protocol can be instantiated by decoding a JSON"},"Terminal.html#/c:SCPTerminal.h@SCPSDKVersion":{"name":"SCPSDKVersion","abstract":"

    The current version of this library.

    "},"Terminal.html":{"name":"Terminal"},"Reader%20Discovery%20%26%20Connection.html":{"name":"Reader Discovery & Connection"},"Reader.html":{"name":"Reader"},"Reader%20Updates.html":{"name":"Reader Updates"},"Payment.html":{"name":"Payment"},"Card-Present%20Refunds.html":{"name":"Card-Present Refunds"},"Saving%20Cards.html":{"name":"Saving Cards"},"Errors.html":{"name":"Errors"},"Blocks.html":{"name":"Blocks"}} \ No newline at end of file +{"Blocks.html#/c:SCPBlocks.h@T@SCPConnectionTokenCompletionBlock":{"name":"SCPConnectionTokenCompletionBlock","abstract":"

    A block called with a connection token or an error from your backend.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPErrorCompletionBlock":{"name":"SCPErrorCompletionBlock","abstract":"

    A block called with an optional error.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPLogListenerBlock":{"name":"SCPLogListenerBlock","abstract":"

    A block called with a logline from the SDK.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPPaymentIntentCompletionBlock":{"name":"SCPPaymentIntentCompletionBlock","abstract":"

    A block called with a PaymentIntent or an error.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPPaymentMethodCompletionBlock":{"name":"SCPPaymentMethodCompletionBlock","abstract":"

    A block called with a PaymentMethod.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPProcessPaymentCompletionBlock":{"name":"SCPProcessPaymentCompletionBlock","abstract":"

    A block called with a PaymentIntent or a ProcessPaymentError

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPReaderCompletionBlock":{"name":"SCPReaderCompletionBlock","abstract":"

    A block called with a reader object or an error.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPProcessRefundCompletionBlock":{"name":"SCPProcessRefundCompletionBlock","abstract":"

    A block called with a Refund or a ProcessRefundError.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPConfirmSetupIntentCompletionBlock":{"name":"SCPConfirmSetupIntentCompletionBlock","abstract":"

    A block called with a SetupIntent or a ConfirmSetupIntentError.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPLocationsCompletionBlock":{"name":"SCPLocationsCompletionBlock","abstract":"

    A block called with a list of Locations or an error.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPRefundCompletionBlock":{"name":"SCPRefundCompletionBlock","abstract":"

    A block called with a Refund or an error.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPSetupIntentCompletionBlock":{"name":"SCPSetupIntentCompletionBlock","abstract":"

    A block called with a SetupIntent or an error.

    "},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBusy":{"name":"SCPErrorBusy","abstract":"

    The SDK is busy executing another command. The SDK can only execute a","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCancelFailedAlreadyCompleted":{"name":"SCPErrorCancelFailedAlreadyCompleted","abstract":"

    Canceling a command failed because the command already completed.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNotConnectedToReader":{"name":"SCPErrorNotConnectedToReader","abstract":"

    No reader is connected. Connect to a reader before trying again.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAlreadyConnectedToReader":{"name":"SCPErrorAlreadyConnectedToReader","abstract":"

    Already connected to a reader.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorConnectionTokenProviderCompletedWithNothing":{"name":"SCPErrorConnectionTokenProviderCompletedWithNothing","abstract":"

    Your implementation of fetchConnectionToken called the completion block","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorProcessInvalidPaymentIntent":{"name":"SCPErrorProcessInvalidPaymentIntent","abstract":"

    processPayment was called with an unknown or invalid PaymentIntent.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNilPaymentIntent":{"name":"SCPErrorNilPaymentIntent","abstract":"

    collectPaymentMethod or processPayment was called with a nil PaymentIntent.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNilSetupIntent":{"name":"SCPErrorNilSetupIntent","abstract":"

    collectSetupIntentPaymentMethod or processSetupIntent was called with","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNilRefundPaymentMethod":{"name":"SCPErrorNilRefundPaymentMethod","abstract":"

    processRefund was called without calling collectRefundPaymentMethod","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidRefundParameters":{"name":"SCPErrorInvalidRefundParameters","abstract":"

    The RefundParameters object has invalid values. The Charge ID (ch_123abc)","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidClientSecret":{"name":"SCPErrorInvalidClientSecret","abstract":"

    A PaymentIntent or SetupIntent was referenced using an invalid client secret.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorMustBeDiscoveringToConnect":{"name":"SCPErrorMustBeDiscoveringToConnect","abstract":"

    The SDK must be actively Discovering Readers in order to successfully","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCannotConnectToUndiscoveredReader":{"name":"SCPErrorCannotConnectToUndiscoveredReader","abstract":"

    Before connecting to a reader, it must have already been discovered in the","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidDiscoveryConfiguration":{"name":"SCPErrorInvalidDiscoveryConfiguration","abstract":"

    discoverReaders was called using an invalid SCPDiscoveryConfiguration.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidReaderForUpdate":{"name":"SCPErrorInvalidReaderForUpdate","abstract":"

    installUpdate was passed an update that is for a different reader. Updates can only","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnsupportedSDK":{"name":"SCPErrorUnsupportedSDK","abstract":"

    -[SCPTerminal connectReader:completion:] was called from an unsupported version","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorFeatureNotAvailableWithConnectedReader":{"name":"SCPErrorFeatureNotAvailableWithConnectedReader","abstract":"

    This feature is currently not available for the selected reader.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorFeatureNotAvailable":{"name":"SCPErrorFeatureNotAvailable","abstract":"

    This feature is not currently available.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidListLocationsLimitParameter":{"name":"SCPErrorInvalidListLocationsLimitParameter","abstract":"

    The ListLocationsParameters object has invalid values.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothConnectionInvalidLocationIdParameter":{"name":"SCPErrorBluetoothConnectionInvalidLocationIdParameter","abstract":"

    The locationId parameter to BluetoothConnectionConfiguration is required but a valid one was not provided.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidRequiredParameter":{"name":"SCPErrorInvalidRequiredParameter","abstract":"

    A required parameter was invalid or missing.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderConnectionConfigurationInvalid":{"name":"SCPErrorReaderConnectionConfigurationInvalid","abstract":"

    An invalid ConnectionConfiguration was passed through connect.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderTippingParameterInvalid":{"name":"SCPErrorReaderTippingParameterInvalid","abstract":"

    An invalid usage of eligibleAmount or skipTipping was passed into collect.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidLocationIdParameter":{"name":"SCPErrorInvalidLocationIdParameter","abstract":"

    The provided location ID parameter was invalid.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCanceled":{"name":"SCPErrorCanceled","abstract":"

    The command was canceled by your app.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorLocationServicesDisabled":{"name":"SCPErrorLocationServicesDisabled","abstract":"

    Access to location services is currently disabled. This may be because:

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothDisabled":{"name":"SCPErrorBluetoothDisabled","abstract":"

    This error indicates that Bluetooth is turned off, and the user should use","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothAccessDenied":{"name":"SCPErrorBluetoothAccessDenied","abstract":"

    Bluetooth is turned on on the device, but access to Bluetooth has been denied","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothScanTimedOut":{"name":"SCPErrorBluetoothScanTimedOut","abstract":"

    Scanning for bluetooth devices timed out.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothLowEnergyUnsupported":{"name":"SCPErrorBluetoothLowEnergyUnsupported","abstract":"

    Bluetooth Low Energy is unsupported on this iOS device. Use a different","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedBatteryLow":{"name":"SCPErrorReaderSoftwareUpdateFailedBatteryLow","abstract":"

    Updating the reader software failed because the reader’s battery is","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedInterrupted":{"name":"SCPErrorReaderSoftwareUpdateFailedInterrupted","abstract":"

    Updating the reader software failed because the update was interrupted.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedExpiredUpdate":{"name":"SCPErrorReaderSoftwareUpdateFailedExpiredUpdate","abstract":"

    Updating the reader software failed because the update has expired. Please disconnect and","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothConnectionFailedBatteryCriticallyLow":{"name":"SCPErrorBluetoothConnectionFailedBatteryCriticallyLow","abstract":"

    The reader has a critically low battery and cannot connect to the","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardInsertNotRead":{"name":"SCPErrorCardInsertNotRead","abstract":"

    The card is not a chip card.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardSwipeNotRead":{"name":"SCPErrorCardSwipeNotRead","abstract":"

    The swipe could not be read.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardReadTimedOut":{"name":"SCPErrorCardReadTimedOut","abstract":"

    Reading a card timed out.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardRemoved":{"name":"SCPErrorCardRemoved","abstract":"

    The card was removed during the transaction.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardLeftInReader":{"name":"SCPErrorCardLeftInReader","abstract":"

    A card can only be used for one transaction, and must be removed after","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorMissingEMVData":{"name":"SCPErrorMissingEMVData","abstract":"

    The reader failed to read the data from the presented payment method. If you encounter","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCommandNotAllowed":{"name":"SCPErrorCommandNotAllowed","abstract":"

    The command was not permitted to execute by the operating system.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnsupportedMobileDeviceConfiguration":{"name":"SCPErrorUnsupportedMobileDeviceConfiguration","abstract":"

    The mobile device on which the app is running is in an unsupported","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorPasscodeNotEnabled":{"name":"SCPErrorPasscodeNotEnabled","abstract":"

    The mobile device on which the app is running must have a passcode set.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCommandNotAllowedDuringCall":{"name":"SCPErrorCommandNotAllowedDuringCall","abstract":"

    The card reader cannot be used while a phone call is active.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidAmount":{"name":"SCPErrorInvalidAmount","abstract":"

    An attempt was made to charge an amount not supported by the reader.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidCurrency":{"name":"SCPErrorInvalidCurrency","abstract":"

    An attempt was made to charge an amount in a currency not supported by the reader.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderTOSAcceptanceRequiresiCloudSignIn":{"name":"SCPErrorAppleBuiltInReaderTOSAcceptanceRequiresiCloudSignIn","abstract":"

    Failed to accept reader-specific terms of service because there is no iCloud","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderTOSAcceptanceCanceled":{"name":"SCPErrorAppleBuiltInReaderTOSAcceptanceCanceled","abstract":"

    The user cancelled reader-specific terms of service acceptance.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderBusy":{"name":"SCPErrorReaderBusy","abstract":"

    The reader is busy.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorIncompatibleReader":{"name":"SCPErrorIncompatibleReader","abstract":"

    An incompatible reader was detected. You can only use the Stripe Terminal","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderCommunicationError":{"name":"SCPErrorReaderCommunicationError","abstract":"

    Could not communicate with the reader.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNFCDisabled":{"name":"SCPErrorNFCDisabled","abstract":"

    NFC functionality is disabled.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothError":{"name":"SCPErrorBluetoothError","abstract":"

    Generic Bluetooth error.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothConnectTimedOut":{"name":"SCPErrorBluetoothConnectTimedOut","abstract":"

    Connecting to the bluetooth device timed out. Make sure the device is","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothDisconnected":{"name":"SCPErrorBluetoothDisconnected","abstract":"

    The Bluetooth device was disconnected unexpectedly.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothPeerRemovedPairingInformation":{"name":"SCPErrorBluetoothPeerRemovedPairingInformation","abstract":"

    Bluetooth pairing error, the reader has removed this device pairing information.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothAlreadyPairedWithAnotherDevice":{"name":"SCPErrorBluetoothAlreadyPairedWithAnotherDevice","abstract":"

    The Bluetooth reader is already paired to another device. The Bluetooth reader","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailed":{"name":"SCPErrorReaderSoftwareUpdateFailed","abstract":"

    Generic reader software update error.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedReaderError":{"name":"SCPErrorReaderSoftwareUpdateFailedReaderError","abstract":"

    Updating the reader software failed because there was an error","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedServerError":{"name":"SCPErrorReaderSoftwareUpdateFailedServerError","abstract":"

    Updating the reader software failed because there was an error","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnsupportedReaderVersion":{"name":"SCPErrorUnsupportedReaderVersion","abstract":"

    processPayment was called from a reader with an unsupported reader","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnknownReaderIpAddress":{"name":"SCPErrorUnknownReaderIpAddress","abstract":"

    The reader returned from discovery does not have an IP address and cannot","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInternetConnectTimeOut":{"name":"SCPErrorInternetConnectTimeOut","abstract":"

    Connecting to reader over the internet timed out. Make sure your device and","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorConnectFailedReaderIsInUse":{"name":"SCPErrorConnectFailedReaderIsInUse","abstract":"

    Connecting to the reader failed because it is currently in use","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothReconnectStarted":{"name":"SCPErrorBluetoothReconnectStarted","abstract":"

    The Bluetooth reader has disconnected and we are attempting to reconnect.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderNotAccessibleInBackground":{"name":"SCPErrorReaderNotAccessibleInBackground","abstract":"

    An attempt was made to interact with the reader while the the app is in the background.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderFailedToPrepare":{"name":"SCPErrorAppleBuiltInReaderFailedToPrepare","abstract":"

    Preparing the Apple Built-In reader to collect payments failed.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderDeviceBanned":{"name":"SCPErrorAppleBuiltInReaderDeviceBanned","abstract":"

    This device cannot be used to process using the Apple Built-In reader as it has been banned.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderTOSNotYetAccepted":{"name":"SCPErrorAppleBuiltInReaderTOSNotYetAccepted","abstract":"

    The operation could not be completed because the reader-specific terms of service have","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderTOSAcceptanceFailed":{"name":"SCPErrorAppleBuiltInReaderTOSAcceptanceFailed","abstract":"

    Failed to accept reader-specific terms of service using the signed-in Apple ID.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderMerchantBlocked":{"name":"SCPErrorAppleBuiltInReaderMerchantBlocked","abstract":"

    This merchant account cannot be used with Apple Built-In reader as it has been blocked.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderInvalidMerchant":{"name":"SCPErrorAppleBuiltInReaderInvalidMerchant","abstract":"

    This merchant account cannot be used with the Apple Built-In reader as it is invalid.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnexpectedSdkError":{"name":"SCPErrorUnexpectedSdkError","abstract":"

    Unexpected SDK error.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnexpectedReaderError":{"name":"SCPErrorUnexpectedReaderError","abstract":"

    Unexpected reader error.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorDeclinedByStripeAPI":{"name":"SCPErrorDeclinedByStripeAPI","abstract":"

    The Stripe API declined the transaction.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorDeclinedByReader":{"name":"SCPErrorDeclinedByReader","abstract":"

    The reader declined the transaction. Try another card.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCommandRequiresCardholderConsent":{"name":"SCPErrorCommandRequiresCardholderConsent","abstract":"

    The cardholder must give consent in order for this operation to succeed.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorRefundFailed":{"name":"SCPErrorRefundFailed","abstract":"

    The refund failed. The customer’s bank or card issuer was unable to process","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNotConnectedToInternet":{"name":"SCPErrorNotConnectedToInternet","abstract":"

    The SDK is not connected to the internet.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorRequestTimedOut":{"name":"SCPErrorRequestTimedOut","abstract":"

    The underlying request timed out.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorStripeAPIError":{"name":"SCPErrorStripeAPIError","abstract":"

    The underlying request returned an API error.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorStripeAPIResponseDecodingError":{"name":"SCPErrorStripeAPIResponseDecodingError","abstract":"

    The API response from Stripe could not be decoded.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInternalNetworkError":{"name":"SCPErrorInternalNetworkError","abstract":"

    Generic network error

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorConnectionTokenProviderCompletedWithError":{"name":"SCPErrorConnectionTokenProviderCompletedWithError","abstract":"

    Your implementation of -[SCPConnectionTokenProvider fetchConnectionToken:]","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorSessionExpired":{"name":"SCPErrorSessionExpired","abstract":"

    The current session has expired and the reader must be disconnected and","parent_name":"SCPError"},"Enums/SCPError.html":{"name":"SCPError","abstract":"

    Possible error codes for NSError objects under the SCPErrorDomain domain.

    "},"Errors.html#/c:@SCPErrorDomain":{"name":"SCPErrorDomain","abstract":"

    The error domain for all errors originating from the Stripe Terminal SDK.

    "},"Errors.html#/c:SCPErrors.h@T@SCPErrorKey":{"name":"SCPErrorKey","abstract":"

    Use this enum to access userInfo keys for NSError objects under the"},"Errors.html#/c:@SCPErrorKeyMessage":{"name":"SCPErrorKeyMessage","abstract":"

    An error message explaining what went wrong. You probably shouldn’t show this"},"Errors.html#/c:@SCPErrorKeyHttpStatusCode":{"name":"SCPErrorKeyHttpStatusCode","abstract":"

    The HTTP status code of the response.

    "},"Errors.html#/c:@SCPErrorKeyReaderMessage":{"name":"SCPErrorKeyReaderMessage","abstract":"

    This error message comes from the reader. You probably shouldn’t show this"},"Errors.html#/c:@SCPErrorKeyDeviceBannedUntilDate":{"name":"SCPErrorKeyDeviceBannedUntilDate","abstract":"

    If an Apple Built-In reader fails to connect due to a device ban and the error"},"Errors.html#/c:@SCPErrorKeyStripeAPIRequestId":{"name":"SCPErrorKeyStripeAPIRequestId","abstract":"

    If a Stripe API request failed, the failed request’s id will be returned in the"},"Errors.html#/c:@SCPErrorKeyStripeAPIDeclineCode":{"name":"SCPErrorKeyStripeAPIDeclineCode","abstract":"

    The decline code returned by the Stripe API.

    "},"Errors.html#/c:@SCPErrorKeyStripeAPIErrorCode":{"name":"SCPErrorKeyStripeAPIErrorCode","abstract":"

    The error code returned by the Stripe API.

    "},"Errors.html#/c:@SCPErrorKeyStripeAPIErrorParameter":{"name":"SCPErrorKeyStripeAPIErrorParameter","abstract":"

    The parameter the error relates to if the error is parameter-specific.

    "},"Errors.html#/c:@SCPErrorKeyStripeAPIErrorType":{"name":"SCPErrorKeyStripeAPIErrorType","abstract":"

    The error type returned by the Stripe API.

    "},"Errors.html#/c:@SCPErrorKeyStripeAPIPaymentIntent":{"name":"SCPErrorKeyStripeAPIPaymentIntent","abstract":"

    If a Stripe API request failed and the error has an associated PaymentIntent,"},"Errors.html#/c:@SCPErrorKeyStripeAPIDocUrl":{"name":"SCPErrorKeyStripeAPIDocUrl","abstract":"

    The documentation URL for the error returned by the Stripe API.

    "},"Errors.html#/c:@SCPErrorKeyStripeAPIFailureReason":{"name":"SCPErrorKeyStripeAPIFailureReason","abstract":"

    If a refund fails, the reason for refund failure if known. Possible values"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(py)setupIntent":{"name":"setupIntent","abstract":"

    The updated SetupIntent after confirmSetupIntent failed.

    ","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(py)requestError":{"name":"requestError","abstract":"

    If confirmSetupIntent failed because the underlying network request errored,","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(py)declineCode":{"name":"declineCode","abstract":"

    If confirmSetupIntent failed because the payment method was declined, this","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPSetupAttemptCardPresentDetails.html#/c:objc(cs)SCPSetupAttemptCardPresentDetails(py)generatedCard":{"name":"generatedCard","abstract":"

    The ID of the Card PaymentMethod which was generated by this SetupAttempt.

    ","parent_name":"SCPSetupAttemptCardPresentDetails"},"Classes/SCPSetupAttemptCardPresentDetails.html#/c:objc(cs)SCPSetupAttemptCardPresentDetails(py)emvAuthData":{"name":"emvAuthData","abstract":"

    The Authorization Response Cryptogram (ARPC) from the issuer.

    ","parent_name":"SCPSetupAttemptCardPresentDetails"},"Classes/SCPSetupAttemptCardPresentDetails.html#/c:objc(cs)SCPSetupAttemptCardPresentDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPSetupAttemptCardPresentDetails"},"Classes/SCPSetupAttemptCardPresentDetails.html#/c:objc(cs)SCPSetupAttemptCardPresentDetails(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPSetupAttemptCardPresentDetails"},"Classes/SCPSetupAttemptPaymentMethodDetails.html#/c:objc(cs)SCPSetupAttemptPaymentMethodDetails(py)type":{"name":"type","abstract":"

    The type of the PaymentMethod. The corresponding, similarly named property","parent_name":"SCPSetupAttemptPaymentMethodDetails"},"Classes/SCPSetupAttemptPaymentMethodDetails.html#/c:objc(cs)SCPSetupAttemptPaymentMethodDetails(py)cardPresent":{"name":"cardPresent","abstract":"

    If this is a card present payment method (ie self.type == SCPPaymentMethodTypeCardPresent),","parent_name":"SCPSetupAttemptPaymentMethodDetails"},"Classes/SCPSetupAttemptPaymentMethodDetails.html#/c:objc(cs)SCPSetupAttemptPaymentMethodDetails(py)interacPresent":{"name":"interacPresent","abstract":"

    If this is a card present payment method (ie self.type == SCPPaymentMethodTypeInteracPresent),","parent_name":"SCPSetupAttemptPaymentMethodDetails"},"Classes/SCPSetupAttemptPaymentMethodDetails.html#/c:objc(cs)SCPSetupAttemptPaymentMethodDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPSetupAttemptPaymentMethodDetails"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)application":{"name":"application","abstract":"

    The ID of the Connect application that created the SetupIntent.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)created":{"name":"created","abstract":"

    Time at which the object was created.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)customer":{"name":"customer","abstract":"

    ID of the Customer this SetupIntent belongs to, if one exists.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)onBehalfOf":{"name":"onBehalfOf","abstract":"

    (Connect) The account (if any) for which the setup is intended.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)paymentMethod":{"name":"paymentMethod","abstract":"

    ID of the payment method used with this SetupAttempt.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)paymentMethodDetails":{"name":"paymentMethodDetails","abstract":"

    Details about the payment method at the time of SetupIntent confirmation.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)setupIntent":{"name":"setupIntent","abstract":"

    ID of the SetupIntent that this attempt belongs to.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)status":{"name":"status","abstract":"

    The status of this SetupAttempt. One of: requires_confirmation,","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)stripeId":{"name":"stripeId","abstract":"

    The unique identifier for the SetupAttempt.

    ","parent_name":"SCPSetupAttempt"},"Enums/SCPSetupIntentUsage.html#/c:@E@SCPSetupIntentUsage@SCPSetupIntentUsageOffSession":{"name":"SCPSetupIntentUsageOffSession","abstract":"

    An off-session usage indicates to Stripe that future payments will take place","parent_name":"SCPSetupIntentUsage"},"Enums/SCPSetupIntentUsage.html#/c:@E@SCPSetupIntentUsage@SCPSetupIntentUsageOnSession":{"name":"SCPSetupIntentUsageOnSession","abstract":"

    An on-session usage indicates to Stripe that future payments will take place","parent_name":"SCPSetupIntentUsage"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusRequiresPaymentMethod":{"name":"SCPSetupIntentStatusRequiresPaymentMethod","abstract":"

    Next step: collect a payment method by calling collectPaymentMethod.

    ","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusRequiresConfirmation":{"name":"SCPSetupIntentStatusRequiresConfirmation","abstract":"

    Next step: confirm the SetupIntent by calling confirmSetupIntent.

    ","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusRequiresAction":{"name":"SCPSetupIntentStatusRequiresAction","abstract":"

    If the setup requires additional actions, such as authenticating with","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusProcessing":{"name":"SCPSetupIntentStatusProcessing","abstract":"

    Once required actions are handled, the SetupIntent moves to processing.","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusCanceled":{"name":"SCPSetupIntentStatusCanceled","abstract":"

    The SetupIntent was canceled.

    ","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusSucceeded":{"name":"SCPSetupIntentStatusSucceeded","abstract":"

    The SetupIntent succeeded.

    ","parent_name":"SCPSetupIntentStatus"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)customer":{"name":"customer","abstract":"

    ID of the customer this SetupIntent belongs to, if one exists.

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)stripeDescription":{"name":"stripeDescription","abstract":"

    An arbitrary string attached to the object. Often useful for displaying to users.

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)metadata":{"name":"metadata","abstract":"

    Set of key-value pairs that you can attach to an object. This can be useful for","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)usage":{"name":"usage","abstract":"

    Indicates how the payment method is intended to be used in the future. If not","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)onBehalfOf":{"name":"onBehalfOf","abstract":"

    Connect Only:** The Stripe account ID for which this SetupIntent is created.

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(im)initWithCustomer:":{"name":"-initWithCustomer:","abstract":"

    Initializes SCPSetupIntentParameters with the given customer ID.

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(im)init":{"name":"-init","abstract":"

    Use initWithCustomer:

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(cm)new":{"name":"+new","abstract":"

    Use initWithCustomer:

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)description":{"name":"description","abstract":"

    Use stripeDescription for the string attached to the object.

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)stripeId":{"name":"stripeId","abstract":"

    The unique identifier for the intent.

    ","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)created":{"name":"created","abstract":"

    When the intent was created.

    ","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)customer":{"name":"customer","abstract":"

    The identifier of a customer object to which the SetupIntent is attached, if applicable.

    ","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)metadata":{"name":"metadata","abstract":"

    Set of key-value pairs attached to the object.

    ","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)usage":{"name":"usage","abstract":"

    An SCPSetupIntentUsage value describing how the SetupIntent will be used.","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)status":{"name":"status","abstract":"

    The status of the intent.

    ","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)latestAttempt":{"name":"latestAttempt","abstract":"

    The most recent SetupAttempt for this SetupIntent

    ","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class. You should only use SetupIntents","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class. You should only use SetupIntents","parent_name":"SCPSetupIntent"},"Classes/SCPReadReusableCardParameters.html#/c:objc(cs)SCPReadReusableCardParameters(py)customer":{"name":"customer","abstract":"

    Optional parameter: attach the new PaymentMethod to Customer with this id

    ","parent_name":"SCPReadReusableCardParameters"},"Classes/SCPReadReusableCardParameters.html#/c:objc(cs)SCPReadReusableCardParameters(py)metadata":{"name":"metadata","abstract":"

    Optional set of key-value pairs attached to the object. The default is nil.

    ","parent_name":"SCPReadReusableCardParameters"},"Classes/SCPReadReusableCardParameters.html":{"name":"SCPReadReusableCardParameters","abstract":"

    Parameters for reading a reusable card.

    "},"Classes/SCPSetupIntent.html":{"name":"SCPSetupIntent","abstract":"

    A SetupIntent guides you through the process of setting up and saving a"},"Classes/SCPSetupIntentParameters.html":{"name":"SCPSetupIntentParameters","abstract":"

    Parameters for creating an SCPSetupIntent.

    "},"Enums/SCPSetupIntentStatus.html":{"name":"SCPSetupIntentStatus","abstract":"

    The possible statuses of the SetupIntent.

    "},"Enums/SCPSetupIntentUsage.html":{"name":"SCPSetupIntentUsage","abstract":"

    The SetupIntent usage options tell Stripe how the payment method is intended to be used in the future."},"Classes/SCPSetupAttempt.html":{"name":"SCPSetupAttempt","abstract":"

    A SetupAttempt describes one attempted confirmation of a SetupIntent,"},"Classes/SCPSetupAttemptPaymentMethodDetails.html":{"name":"SCPSetupAttemptPaymentMethodDetails","abstract":"

    Details about a PaymentMethod at a specific time. ex: at time of transaction"},"Classes/SCPSetupAttemptCardPresentDetails.html":{"name":"SCPSetupAttemptCardPresentDetails","abstract":"

    An object representing details from a transaction using a card_present"},"Classes/SCPConfirmSetupIntentError.html":{"name":"SCPConfirmSetupIntentError","abstract":"

    An error from -[SCPTerminal confirmSetupIntent:completion:]

    "},"Enums/SCPRefundStatus.html#/c:@E@SCPRefundStatus@SCPRefundStatusSucceeded":{"name":"SCPRefundStatusSucceeded","abstract":"

    The refund succeeded.

    ","parent_name":"SCPRefundStatus"},"Enums/SCPRefundStatus.html#/c:@E@SCPRefundStatus@SCPRefundStatusPending":{"name":"SCPRefundStatusPending","abstract":"

    The refund is pending.

    ","parent_name":"SCPRefundStatus"},"Enums/SCPRefundStatus.html#/c:@E@SCPRefundStatus@SCPRefundStatusFailed":{"name":"SCPRefundStatusFailed","abstract":"

    The refund failed.

    ","parent_name":"SCPRefundStatus"},"Enums/SCPRefundStatus.html#/c:@E@SCPRefundStatus@SCPRefundStatusUnknown":{"name":"SCPRefundStatusUnknown","abstract":"

    Unknown refund state.

    ","parent_name":"SCPRefundStatus"},"Classes/SCPProcessRefundError.html#/c:objc(cs)SCPProcessRefundError(py)refund":{"name":"refund","abstract":"

    If processRefund failed after the refund was created, this property contains","parent_name":"SCPProcessRefundError"},"Classes/SCPProcessRefundError.html#/c:objc(cs)SCPProcessRefundError(py)requestError":{"name":"requestError","abstract":"

    If processRefund failed because the underlying network request errored,","parent_name":"SCPProcessRefundError"},"Classes/SCPProcessRefundError.html#/c:objc(cs)SCPProcessRefundError(cm)init":{"name":"+init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPProcessRefundError"},"Classes/SCPProcessRefundError.html#/c:objc(cs)SCPProcessRefundError(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPProcessRefundError"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)chargeId":{"name":"chargeId","abstract":"

    The ID of the charge to be refunded.

    ","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)amount":{"name":"amount","abstract":"

    The amount of the refund, provided in the currency’s smallest unit.

    ","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)currency":{"name":"currency","abstract":"

    Three-letter ISO currency code. Must be a supported currency.

    ","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)metadata":{"name":"metadata","abstract":"

    Set of key-value pairs that you can attach to an object. This can be useful for","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)reverseTransfer":{"name":"reverseTransfer","abstract":"

    Connect only: Nullable boolean indicating whether the transfer should be","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)refundApplicationFee":{"name":"refundApplicationFee","abstract":"

    Connect only: Nullable boolean indicating whether the application fee should be","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(im)initWithChargeId:amount:currency:":{"name":"-initWithChargeId:amount:currency:","abstract":"

    Initializes SCPRefundParameters with the given charge, amount, and currency.

    ","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(im)init":{"name":"-init","abstract":"

    Use initWithChargeId:amount:currency:

    ","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(cm)new":{"name":"+new","abstract":"

    Use initWithChargeId:amount:currency:

    ","parent_name":"SCPRefundParameters"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)stripeId":{"name":"stripeId","abstract":"

    The unique identifier for the refund.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)amount":{"name":"amount","abstract":"

    The amount that was refunded.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)charge":{"name":"charge","abstract":"

    The ID of the charge that was refunded

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)created":{"name":"created","abstract":"

    When the refund object was created.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)currency":{"name":"currency","abstract":"

    The currency of the amount refunded.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)metadata":{"name":"metadata","abstract":"

    Metadata associated with the refund.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)reason":{"name":"reason","abstract":"

    Reason for the refund, either user-provided (duplicate, fraudulent, or","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)status":{"name":"status","abstract":"

    The status of the refund.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)paymentMethodDetails":{"name":"paymentMethodDetails","abstract":"

    The payment method details associated with the refund.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)failureReason":{"name":"failureReason","abstract":"

    If the refund failed, the reason for refund failure if known.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html":{"name":"SCPRefund","abstract":"

    An object representing a Stripe refund.

    "},"Classes/SCPRefundParameters.html":{"name":"SCPRefundParameters","abstract":"

    Parameters for creating an SCPRefund.

    "},"Classes/SCPProcessRefundError.html":{"name":"SCPProcessRefundError","abstract":"

    An error from -[SCPTerminal processRefund:completion:].

    "},"Enums/SCPRefundStatus.html":{"name":"SCPRefundStatus","abstract":"

    The possible statuses for a refund.

    "},"Enums/SCPIncrementalAuthorizationStatus.html#/c:@E@SCPIncrementalAuthorizationStatus@SCPIncrementalAuthorizationStatusUnknown":{"name":"SCPIncrementalAuthorizationStatusUnknown","abstract":"

    It is undetermined whether or not this PaymentIntent will be eligible for incremental authorizations.","parent_name":"SCPIncrementalAuthorizationStatus"},"Enums/SCPIncrementalAuthorizationStatus.html#/c:@E@SCPIncrementalAuthorizationStatus@SCPIncrementalAuthorizationStatusNotSupported":{"name":"SCPIncrementalAuthorizationStatusNotSupported","abstract":"

    This PaymentIntent is not eligible for incremental authorizations, or it was not requested.

    ","parent_name":"SCPIncrementalAuthorizationStatus"},"Enums/SCPIncrementalAuthorizationStatus.html#/c:@E@SCPIncrementalAuthorizationStatus@SCPIncrementalAuthorizationStatusSupported":{"name":"SCPIncrementalAuthorizationStatusSupported","abstract":"

    This PaymentIntent is eligible for incremental authorizations.

    ","parent_name":"SCPIncrementalAuthorizationStatus"},"Classes/SCPNetworks.html#/c:objc(cs)SCPNetworks(py)available":{"name":"available","abstract":"

    All available networks for the card.

    ","parent_name":"SCPNetworks"},"Classes/SCPNetworks.html#/c:objc(cs)SCPNetworks(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPNetworks"},"Classes/SCPNetworks.html#/c:objc(cs)SCPNetworks(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPNetworks"},"Classes/SCPTippingConfiguration.html#/c:objc(cs)SCPTippingConfiguration(py)eligibleAmount":{"name":"eligibleAmount","abstract":"

    The amount of the payment total eligible for tips.

    ","parent_name":"SCPTippingConfiguration"},"Classes/SCPTippingConfiguration.html#/c:objc(cs)SCPTippingConfiguration(im)initWithEligibleAmount:":{"name":"-initWithEligibleAmount:","abstract":"

    Initialize a TippingConfiguration instance.

    ","parent_name":"SCPTippingConfiguration"},"Classes/SCPTippingConfiguration.html#/c:objc(cs)SCPTippingConfiguration(im)init":{"name":"-init","abstract":"

    Use initWithEligibleAmount:

    ","parent_name":"SCPTippingConfiguration"},"Classes/SCPTippingConfiguration.html#/c:objc(cs)SCPTippingConfiguration(cm)new":{"name":"+new","abstract":"

    Use initWithEligibleAmount:

    ","parent_name":"SCPTippingConfiguration"},"Enums/SCPCaptureMethod.html#/c:@E@SCPCaptureMethod@SCPCaptureMethodManual":{"name":"SCPCaptureMethodManual","abstract":"

    Place a hold on the funds when the customer authorizes the payment, but don’t","parent_name":"SCPCaptureMethod"},"Enums/SCPCaptureMethod.html#/c:@E@SCPCaptureMethod@SCPCaptureMethodAutomatic":{"name":"SCPCaptureMethodAutomatic","abstract":"

    Stripe automatically captures funds when the customer authorizes the payment.

    ","parent_name":"SCPCaptureMethod"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(py)skipTipping":{"name":"skipTipping","abstract":"

    Bypass tipping selection if it would have otherwise been shown.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(py)tippingConfiguration":{"name":"tippingConfiguration","abstract":"

    The tipping configuration for this payment collection.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(py)updatePaymentIntent":{"name":"updatePaymentIntent","abstract":"

    Whether or not to update the PaymentIntent server side during collectPaymentMethod.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithSkipTipping:":{"name":"-initWithSkipTipping:","abstract":"

    Initialize a CollectConfiguration

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithUpdatePaymentIntent:":{"name":"-initWithUpdatePaymentIntent:","abstract":"

    Initialize a CollectConfiguration

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithTippingConfiguration:":{"name":"-initWithTippingConfiguration:","abstract":"

    Initialize a CollectConfiguration.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithSkipTipping:updatePaymentIntent:":{"name":"-initWithSkipTipping:updatePaymentIntent:","abstract":"

    Initialize a CollectConfiguration

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithSkipTipping:tippingConfiguration:":{"name":"-initWithSkipTipping:tippingConfiguration:","abstract":"

    Initialize a CollectConfiguration.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithUpdatePaymentIntent:tippingConfiguration:":{"name":"-initWithUpdatePaymentIntent:tippingConfiguration:","abstract":"

    Initialize a CollectConfiguration.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithSkipTipping:updatePaymentIntent:tippingConfiguration:":{"name":"-initWithSkipTipping:updatePaymentIntent:tippingConfiguration:","abstract":"

    Initialize a CollectConfiguration.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)init":{"name":"-init","abstract":"

    Use initWithSkipTipping:updatePaymentIntent:tippingConfiguration: or helper initializers.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(cm)new":{"name":"+new","abstract":"

    Use initWithSkipTipping:updatePaymentIntent:tippingConfiguration: or helper initializers.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPPaymentMethodOptionsParameters.html#/c:objc(cs)SCPPaymentMethodOptionsParameters(py)cardPresentParameters":{"name":"cardPresentParameters","abstract":"

    Card-present-specific configuration for this PaymentMethod.

    ","parent_name":"SCPPaymentMethodOptionsParameters"},"Classes/SCPPaymentMethodOptionsParameters.html#/c:objc(cs)SCPPaymentMethodOptionsParameters(im)initWithCardPresentParameters:":{"name":"-initWithCardPresentParameters:","abstract":"

    Initialize a PaymentMethodOptionsParameters

    ","parent_name":"SCPPaymentMethodOptionsParameters"},"Classes/SCPPaymentMethodOptionsParameters.html#/c:objc(cs)SCPPaymentMethodOptionsParameters(im)init":{"name":"-init","abstract":"

    Use initWithCardPresentParameters:(SCPCardPresentParameters)cardPresentParameters

    ","parent_name":"SCPPaymentMethodOptionsParameters"},"Enums/SCPPaymentMethodType.html#/c:@E@SCPPaymentMethodType@SCPPaymentMethodTypeCard":{"name":"SCPPaymentMethodTypeCard","abstract":"

    A card payment method.

    ","parent_name":"SCPPaymentMethodType"},"Enums/SCPPaymentMethodType.html#/c:@E@SCPPaymentMethodType@SCPPaymentMethodTypeCardPresent":{"name":"SCPPaymentMethodTypeCardPresent","abstract":"

    A card present payment method.

    ","parent_name":"SCPPaymentMethodType"},"Enums/SCPPaymentMethodType.html#/c:@E@SCPPaymentMethodType@SCPPaymentMethodTypeInteracPresent":{"name":"SCPPaymentMethodTypeInteracPresent","abstract":"

    An Interac Present payment method.

    ","parent_name":"SCPPaymentMethodType"},"Enums/SCPPaymentMethodType.html#/c:@E@SCPPaymentMethodType@SCPPaymentMethodTypeUnknown":{"name":"SCPPaymentMethodTypeUnknown","abstract":"

    An unknown type.

    ","parent_name":"SCPPaymentMethodType"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)stripeId":{"name":"stripeId","abstract":"

    The unique identifier for the PaymentMethod

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)created":{"name":"created","abstract":"

    Time at which the object was created. Measured in seconds since the Unix epoch.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)type":{"name":"type","abstract":"

    The type of the PaymentMethod. The corresponding, similarly named property contains additional information specific to the PaymentMethod type.","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)card":{"name":"card","abstract":"

    If this is a card PaymentMethod (ie self.type == SCPPaymentMethodTypeCard), this contains additional details.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)cardPresent":{"name":"cardPresent","abstract":"

    If this is a card_present PaymentMethod (ie self.type == SCPPaymentMethodTypeCardPresent), this contains additional details.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)interacPresent":{"name":"interacPresent","abstract":"

    If this is an Interac_present PaymentMethod (ie self.type == SCPPaymentMethodTypeInteracPresent), this contains additional details.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)customer":{"name":"customer","abstract":"

    The Customer that this PaymentMethod is attached to, or nil.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)metadata":{"name":"metadata","abstract":"

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)brand":{"name":"brand","abstract":"

    The issuer of the card.

    ","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)country":{"name":"country","abstract":"

    Two-letter ISO code representing the country of the card.

    ","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)expMonth":{"name":"expMonth","abstract":"

    Two-digit number representing the card’s expiration month.","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)expYear":{"name":"expYear","abstract":"

    Four-digit number representing the card’s expiration year.","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)funding":{"name":"funding","abstract":"

    Card funding type. Ex: credit, debit, etc.

    ","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)last4":{"name":"last4","abstract":"

    The last four digits of the card.

    ","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)fingerprint":{"name":"fingerprint","abstract":"

    Uniquely identifies this particular card number. You can use this attribute","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPCardDetails"},"Classes/SCPPaymentMethodDetails.html#/c:objc(cs)SCPPaymentMethodDetails(py)type":{"name":"type","abstract":"

    The type of the PaymentMethod. The corresponding, similarly named property","parent_name":"SCPPaymentMethodDetails"},"Classes/SCPPaymentMethodDetails.html#/c:objc(cs)SCPPaymentMethodDetails(py)cardPresent":{"name":"cardPresent","abstract":"

    If this is a card present payment method (ie self.type == SCPPaymentMethodTypeCardPresent),","parent_name":"SCPPaymentMethodDetails"},"Classes/SCPPaymentMethodDetails.html#/c:objc(cs)SCPPaymentMethodDetails(py)interacPresent":{"name":"interacPresent","abstract":"

    If this is an Interac present payment method (ie self.type == SCPPaymentMethodTypeInteracPresent),","parent_name":"SCPPaymentMethodDetails"},"Classes/SCPPaymentMethodDetails.html#/c:objc(cs)SCPPaymentMethodDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPPaymentMethodDetails"},"Enums/SCPChargeStatus.html#/c:@E@SCPChargeStatus@SCPChargeStatusSucceeded":{"name":"SCPChargeStatusSucceeded","abstract":"

    The charge succeeded.

    ","parent_name":"SCPChargeStatus"},"Enums/SCPChargeStatus.html#/c:@E@SCPChargeStatus@SCPChargeStatusPending":{"name":"SCPChargeStatusPending","abstract":"

    The charge succeeded.

    ","parent_name":"SCPChargeStatus"},"Enums/SCPChargeStatus.html#/c:@E@SCPChargeStatus@SCPChargeStatusFailed":{"name":"SCPChargeStatusFailed","abstract":"

    The charge failed.

    ","parent_name":"SCPChargeStatus"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)amount":{"name":"amount","abstract":"

    The amount of the charge.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)currency":{"name":"currency","abstract":"

    The currency of the charge.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)status":{"name":"status","abstract":"

    The status of the charge.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)paymentMethodDetails":{"name":"paymentMethodDetails","abstract":"

    The payment method details associated with the charge.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)stripeDescription":{"name":"stripeDescription","abstract":"

    A string describing the charge, displayed in the Stripe dashboard and in","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)metadata":{"name":"metadata","abstract":"

    Metadata associated with the charge.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)stripeId":{"name":"stripeId","abstract":"

    The unique identifier for the charge.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)statementDescriptorSuffix":{"name":"statementDescriptorSuffix","abstract":"

    Extra dynamic information about a Charge. This will appear concatenated with the statementDescriptor on","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)calculatedStatementDescriptor":{"name":"calculatedStatementDescriptor","abstract":"

    The full statement descriptor that is displayed on your customer’s credit card’s statement, after the","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPCharge"},"Enums/SCPCardFundingType.html#/c:@E@SCPCardFundingType@SCPCardFundingTypeDebit":{"name":"SCPCardFundingTypeDebit","abstract":"

    Debit

    ","parent_name":"SCPCardFundingType"},"Enums/SCPCardFundingType.html#/c:@E@SCPCardFundingType@SCPCardFundingTypeCredit":{"name":"SCPCardFundingTypeCredit","abstract":"

    Credit

    ","parent_name":"SCPCardFundingType"},"Enums/SCPCardFundingType.html#/c:@E@SCPCardFundingType@SCPCardFundingTypePrepaid":{"name":"SCPCardFundingTypePrepaid","abstract":"

    Prepaid

    ","parent_name":"SCPCardFundingType"},"Enums/SCPCardFundingType.html#/c:@E@SCPCardFundingType@SCPCardFundingTypeOther":{"name":"SCPCardFundingTypeOther","abstract":"

    An other or unknown type of funding source

    ","parent_name":"SCPCardFundingType"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandVisa":{"name":"SCPCardBrandVisa","abstract":"

    Visa card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandAmex":{"name":"SCPCardBrandAmex","abstract":"

    American Express card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandMasterCard":{"name":"SCPCardBrandMasterCard","abstract":"

    MasterCard card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandDiscover":{"name":"SCPCardBrandDiscover","abstract":"

    Discover card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandJCB":{"name":"SCPCardBrandJCB","abstract":"

    JCB card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandDinersClub":{"name":"SCPCardBrandDinersClub","abstract":"

    Diners Club card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandInterac":{"name":"SCPCardBrandInterac","abstract":"

    Interac card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandUnionPay":{"name":"SCPCardBrandUnionPay","abstract":"

    Union Pay card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandEftposAu":{"name":"SCPCardBrandEftposAu","abstract":"

    Eftpos Australia card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandUnknown":{"name":"SCPCardBrandUnknown","abstract":"

    An unknown card brand

    ","parent_name":"SCPCardBrand"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(py)paymentIntent":{"name":"paymentIntent","abstract":"

    The updated PaymentIntent after processPayment failed.

    ","parent_name":"SCPProcessPaymentError"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(py)requestError":{"name":"requestError","abstract":"

    If processPayment failed because the underlying network request errored,","parent_name":"SCPProcessPaymentError"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(py)declineCode":{"name":"declineCode","abstract":"

    If processPayment failed because the payment method was declined, this","parent_name":"SCPProcessPaymentError"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPProcessPaymentError"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPProcessPaymentError"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)accountType":{"name":"accountType","abstract":"

    The type of account being debited or credited

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)applicationPreferredName":{"name":"applicationPreferredName","abstract":"

    Also known as “Application Name”. Required on EMV receipts.

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)dedicatedFileName":{"name":"dedicatedFileName","abstract":"

    Also known as “AID”. Required on EMV receipts.

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)authorizationCode":{"name":"authorizationCode","abstract":"

    Identifier for this transaction

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)authorizationResponseCode":{"name":"authorizationResponseCode","abstract":"

    Authorization Response Code

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)applicationCryptogram":{"name":"applicationCryptogram","abstract":"

    Application Cryptogram

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)terminalVerificationResults":{"name":"terminalVerificationResults","abstract":"

    TVR

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)transactionStatusInformation":{"name":"transactionStatusInformation","abstract":"

    TSI

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)last4":{"name":"last4","abstract":"

    The last 4 digits of the card.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)expMonth":{"name":"expMonth","abstract":"

    The card’s expiration month. 1-indexed (i.e. 1 == January)

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)expYear":{"name":"expYear","abstract":"

    The card’s expiration year.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)cardholderName":{"name":"cardholderName","abstract":"

    The cardholder name as read from the card, in ISO 7813 format. May include","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)funding":{"name":"funding","abstract":"

    The card’s funding type.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)brand":{"name":"brand","abstract":"

    The issuing brand of the card.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)fingerprint":{"name":"fingerprint","abstract":"

    A string uniquely identifying this card number.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)generatedCard":{"name":"generatedCard","abstract":"

    ID of a card PaymentMethod that may be attached to a Customer for future","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)receipt":{"name":"receipt","abstract":"

    Receipt information for the card present transaction. Only present for EMV","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)emvAuthData":{"name":"emvAuthData","abstract":"

    (Only applicable to EMV payments) The authorization data from the card","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)country":{"name":"country","abstract":"

    Two-letter ISO code representing the country of the card. You could use this","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)preferredLocales":{"name":"preferredLocales","abstract":"

    EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)networks":{"name":"networks","abstract":"

    Contains information about card networks that can be used to process the payment.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)incrementalAuthorizationStatus":{"name":"incrementalAuthorizationStatus","abstract":"

    Whether this payment method is eligible for incremental authorizations.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPCardPresentDetails"},"Enums/SCPCardPresentRouting.html#/c:@E@SCPCardPresentRouting@SCPCardPresentRoutingDomestic":{"name":"SCPCardPresentRoutingDomestic","abstract":"

    Prioritize domestic debit network routing on payment method collection.

    ","parent_name":"SCPCardPresentRouting"},"Enums/SCPCardPresentRouting.html#/c:@E@SCPCardPresentRouting@SCPCardPresentRoutingInternational":{"name":"SCPCardPresentRoutingInternational","abstract":"

    Prioritize international network routing on payment method collection.

    ","parent_name":"SCPCardPresentRouting"},"Enums/SCPCardPresentCaptureMethod.html#/c:@E@SCPCardPresentCaptureMethod@SCPCardPresentCaptureMethodManualPreferred":{"name":"SCPCardPresentCaptureMethodManualPreferred","abstract":"

    Use manual_preferred if you prefer manual capture_method for the SCPPaymentIntent’s capture_method but support","parent_name":"SCPCardPresentCaptureMethod"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(py)requestExtendedAuthorization":{"name":"requestExtendedAuthorization","abstract":"

    Using the extended authorizations feature, users in eligible categories can capture up to 31 days later, depending on the card brand.

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(py)requestIncrementalAuthorizationSupport":{"name":"requestIncrementalAuthorizationSupport","abstract":"

    Allows you to increase the authorized amount on a confirmed PaymentIntent before you capture it. This means you can update the amount on a payment if the estimated price changes or goods and services are added. Before capture, each incremental authorization appears on your customer’s credit card statement as an additional pending charge.

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(py)captureMethod":{"name":"captureMethod","abstract":"

    SCPCardPresentCaptureMethod as a nullable NSNumber.

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(py)requestedPriority":{"name":"requestedPriority","abstract":"

    The requested routing priority as a nullable NSNumber.

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:":{"name":"-initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:":{"name":"-initWithRequestExtendedAuthorization:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestIncrementalAuthorizationSupport:":{"name":"-initWithRequestIncrementalAuthorizationSupport:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:captureMethod:":{"name":"-initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:captureMethod:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:captureMethod:":{"name":"-initWithRequestExtendedAuthorization:captureMethod:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestIncrementalAuthorizationSupport:captureMethod:":{"name":"-initWithRequestIncrementalAuthorizationSupport:captureMethod:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithCaptureMethod:":{"name":"-initWithCaptureMethod:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:captureMethod:requestedPriority:":{"name":"-initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:captureMethod:requestedPriority:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:requestedPriority:":{"name":"-initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:requestedPriority:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithCaptureMethod:requestedPriority:":{"name":"-initWithCaptureMethod:requestedPriority:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestedPriority:":{"name":"-initWithRequestedPriority:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)init":{"name":"-init","abstract":"

    Use alternative initializer.

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPTip.html#/c:objc(cs)SCPTip(py)amount":{"name":"amount","abstract":"

    Portion of the amount that corresponds to a tip

    ","parent_name":"SCPTip"},"Classes/SCPTip.html#/c:objc(cs)SCPTip(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate SCPTip.

    ","parent_name":"SCPTip"},"Classes/SCPTip.html#/c:objc(cs)SCPTip(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate SCPTip.

    ","parent_name":"SCPTip"},"Classes/SCPAmountDetails.html#/c:objc(cs)SCPAmountDetails(py)tip":{"name":"tip","abstract":"

    Details about the tip

    ","parent_name":"SCPAmountDetails"},"Classes/SCPAmountDetails.html#/c:objc(cs)SCPAmountDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate SCPAmountDetails.

    ","parent_name":"SCPAmountDetails"},"Classes/SCPAmountDetails.html#/c:objc(cs)SCPAmountDetails(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate SCPAmountDetails.

    ","parent_name":"SCPAmountDetails"},"Enums/SCPPaymentStatus.html#/c:@E@SCPPaymentStatus@SCPPaymentStatusNotReady":{"name":"SCPPaymentStatusNotReady","abstract":"

    The SDK is not ready to start a payment. It may be busy with another","parent_name":"SCPPaymentStatus"},"Enums/SCPPaymentStatus.html#/c:@E@SCPPaymentStatus@SCPPaymentStatusReady":{"name":"SCPPaymentStatusReady","abstract":"

    The SDK is ready to start a payment.

    ","parent_name":"SCPPaymentStatus"},"Enums/SCPPaymentStatus.html#/c:@E@SCPPaymentStatus@SCPPaymentStatusWaitingForInput":{"name":"SCPPaymentStatusWaitingForInput","abstract":"

    The SDK is waiting for input from the customer (e.g., for a card to","parent_name":"SCPPaymentStatus"},"Enums/SCPPaymentStatus.html#/c:@E@SCPPaymentStatus@SCPPaymentStatusProcessing":{"name":"SCPPaymentStatusProcessing","abstract":"

    The SDK is processing a payment.

    ","parent_name":"SCPPaymentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusRequiresPaymentMethod":{"name":"SCPPaymentIntentStatusRequiresPaymentMethod","abstract":"

    Next step: collect a payment method by calling collectPaymentMethod.

    ","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusRequiresConfirmation":{"name":"SCPPaymentIntentStatusRequiresConfirmation","abstract":"

    Next step: process the payment by calling processPayment.

    ","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusRequiresCapture":{"name":"SCPPaymentIntentStatusRequiresCapture","abstract":"

    Next step: capture the PaymentIntent on your backend via the Stripe API.

    ","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusProcessing":{"name":"SCPPaymentIntentStatusProcessing","abstract":"

    The PaymentIntent is in the middle of full EMV processing.

    ","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusCanceled":{"name":"SCPPaymentIntentStatusCanceled","abstract":"

    The PaymentIntent was canceled.

    ","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusSucceeded":{"name":"SCPPaymentIntentStatusSucceeded","abstract":"

    The PaymentIntent succeeded.

    ","parent_name":"SCPPaymentIntentStatus"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)amount":{"name":"amount","abstract":"

    The amount of the payment, provided in the currency’s smallest unit.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)currency":{"name":"currency","abstract":"

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)paymentMethodTypes":{"name":"paymentMethodTypes","abstract":"

    The list of payment method types that this PaymentIntent is allowed to use.","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)captureMethod":{"name":"captureMethod","abstract":"

    The capture method that this PaymentIntent should use. Defaults to SCPCaptureMethodManual.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)metadata":{"name":"metadata","abstract":"

    Set of key-value pairs that you can attach to an object. This can be useful for","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)stripeDescription":{"name":"stripeDescription","abstract":"

    An arbitrary string attached to the object. If you send a receipt email for","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)statementDescriptor":{"name":"statementDescriptor","abstract":"

    A string to be displayed on your customer’s credit card statement. This may be","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)statementDescriptorSuffix":{"name":"statementDescriptorSuffix","abstract":"

    A string to specify details about the transaction so your customer can understand it clearly on their statement.","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)receiptEmail":{"name":"receiptEmail","abstract":"

    Email address that the receipt for the resulting payment will be sent to.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)customer":{"name":"customer","abstract":"

    The ID of the Customer this PaymentIntent is for, if one exists.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)applicationFeeAmount":{"name":"applicationFeeAmount","abstract":"

    The amount of the application fee (if any) that will be applied to the","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)transferGroup":{"name":"transferGroup","abstract":"

    A string that identifies the resulting payment as part of a group.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)transferDataDestination":{"name":"transferDataDestination","abstract":"

    The account (if any) the payment will be attributed to for tax reporting, and","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)onBehalfOf":{"name":"onBehalfOf","abstract":"

    The Stripe account ID for which these funds are intended.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)setupFutureUsage":{"name":"setupFutureUsage","abstract":"

    Indicates that you intend to make future payments with this PaymentIntent’s payment method.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)paymentMethodOptionsParameters":{"name":"paymentMethodOptionsParameters","abstract":"

    Specific options used during the creation of the PaymentMethod.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)initWithAmount:currency:":{"name":"-initWithAmount:currency:","abstract":"

    Initializes SCPPaymentIntentParameters with the given parameters.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)initWithAmount:currency:paymentMethodTypes:":{"name":"-initWithAmount:currency:paymentMethodTypes:","abstract":"

    Initializes SCPPaymentIntentParameters with the given parameters.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)initWithAmount:currency:captureMethod:":{"name":"-initWithAmount:currency:captureMethod:","abstract":"

    Initializes SCPPaymentIntentParameters with the given parameters.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)initWithAmount:currency:paymentMethodTypes:captureMethod:":{"name":"-initWithAmount:currency:paymentMethodTypes:captureMethod:","abstract":"

    Initializes SCPPaymentIntentParameters with the given parameters.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)init":{"name":"-init","abstract":"

    Use initWithAmount:currency:

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(cm)new":{"name":"+new","abstract":"

    Use initWithAmount:currency:

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)description":{"name":"description","abstract":"

    Use stripeDescription for the string attached to the object.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)stripeId":{"name":"stripeId","abstract":"

    The unique identifier for the intent.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)created":{"name":"created","abstract":"

    When the intent was created.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)status":{"name":"status","abstract":"

    The status of the PaymentIntent.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)amount":{"name":"amount","abstract":"

    The amount to be collected by this PaymentIntent, provided in the currency’s","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)captureMethod":{"name":"captureMethod","abstract":"

    Controls when the funds will be captured from the customer’s account.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)currency":{"name":"currency","abstract":"

    The currency of the payment.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)metadata":{"name":"metadata","abstract":"

    Set of key-value pairs attached to the object.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)charges":{"name":"charges","abstract":"

    Charges that were created by this PaymentIntent, if any.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)paymentMethod":{"name":"paymentMethod","abstract":"

    The payment method to be used in this PaymentIntent. Only valid in the","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)amountDetails":{"name":"amountDetails","abstract":"

    Details about items included in the amount after confirmation.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)amountTip":{"name":"amountTip","abstract":"

    Indicates how much the user intends to tip in addition to the amount by at confirmation time.","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)statementDescriptor":{"name":"statementDescriptor","abstract":"

    Extra information about a PaymentIntent. This will appear on your customer’s statement when","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)statementDescriptorSuffix":{"name":"statementDescriptorSuffix","abstract":"

    Extra dynamic information about a PaymentIntent. This will appear concatenated with the statementDescriptor on","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate SCPPaymentIntent. You should only use","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate SCPPaymentIntent. You should only use","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html":{"name":"SCPPaymentIntent","abstract":"

    A PaymentIntent tracks the process of collecting a payment from your customer."},"Classes/SCPPaymentIntentParameters.html":{"name":"SCPPaymentIntentParameters","abstract":"

    Parameters for creating an SCPPaymentIntent. Pass an object of this type"},"Enums/SCPPaymentIntentStatus.html":{"name":"SCPPaymentIntentStatus","abstract":"

    The possible statuses for a PaymentIntent.

    "},"Enums/SCPPaymentStatus.html":{"name":"SCPPaymentStatus","abstract":"

    The possible payment statuses for the SDK.

    "},"Classes/SCPAmountDetails.html":{"name":"SCPAmountDetails","abstract":"

    Contains details about items included in the [PaymentIntent] amount

    "},"Classes/SCPTip.html":{"name":"SCPTip","abstract":"

    Contains details about tips

    "},"Classes/SCPCardPresentParameters.html":{"name":"SCPCardPresentParameters","abstract":"

    Parameters that will be applied to the card present PaymentIntent.

    "},"Enums/SCPCardPresentCaptureMethod.html":{"name":"SCPCardPresentCaptureMethod","abstract":"

    Capture Method values that can be used as card-present payment method options.

    "},"Enums/SCPCardPresentRouting.html":{"name":"SCPCardPresentRouting","abstract":"

    Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.

    "},"Classes/SCPCardPresentDetails.html":{"name":"SCPCardPresentDetails","abstract":"

    An object representing details from a transaction using a card_present"},"Classes/SCPReceiptDetails.html":{"name":"SCPReceiptDetails","abstract":"

    Receipt details associated with a card present transaction.

    "},"Classes/SCPProcessPaymentError.html":{"name":"SCPProcessPaymentError","abstract":"

    An error from -[SCPTerminal processPayment:completion:].

    "},"Enums/SCPCardBrand.html":{"name":"SCPCardBrand","abstract":"

    The various card brands for a card.

    "},"Enums/SCPCardFundingType.html":{"name":"SCPCardFundingType","abstract":"

    The various funding sources for a card.

    "},"Classes/SCPCharge.html":{"name":"SCPCharge","abstract":"

    An object representing a Stripe charge.

    "},"Enums/SCPChargeStatus.html":{"name":"SCPChargeStatus","abstract":"

    The possible statuses for a charge

    "},"Classes/SCPPaymentMethodDetails.html":{"name":"SCPPaymentMethodDetails","abstract":"

    Details about a PaymentMethod at a specific time. ex: at time of transaction"},"Classes/SCPCardDetails.html":{"name":"SCPCardDetails","abstract":"

    Contains details about a user’s credit card.

    "},"Classes/SCPPaymentMethod.html":{"name":"SCPPaymentMethod","abstract":"

    PaymentMethod objects represent your customer’s payment instruments."},"Enums/SCPPaymentMethodType.html":{"name":"SCPPaymentMethodType","abstract":"

    The type of the PaymentMethod.

    "},"Classes/SCPPaymentMethodOptionsParameters.html":{"name":"SCPPaymentMethodOptionsParameters","abstract":"

    The PaymentMethodOptionsParameters contains options for PaymentMethod creation.

    "},"Classes/SCPCollectConfiguration.html":{"name":"SCPCollectConfiguration","abstract":"

    The CollectConfiguration contains configuration information relevant to collecting a payment"},"Enums/SCPCaptureMethod.html":{"name":"SCPCaptureMethod","abstract":"

    @abstract Controls when the funds will be captured from the customer’s account.

    "},"Classes/SCPTippingConfiguration.html":{"name":"SCPTippingConfiguration","abstract":"

    The TippingConfiguration contains configuration information relevant to collecting tips.

    "},"Classes/SCPNetworks.html":{"name":"SCPNetworks","abstract":"

    Contains information about card networks that can be used to process the payment.

    "},"Enums/SCPIncrementalAuthorizationStatus.html":{"name":"SCPIncrementalAuthorizationStatus","abstract":"

    Represents the ability for a PaymentIntent to be incrementally authorized.

    "},"Enums/SCPUpdateComponent.html#/c:@E@SCPUpdateComponent@SCPUpdateComponentIncremental":{"name":"SCPUpdateComponentIncremental","abstract":"

    If set, the update contains incremental changes to the reader. If this is","parent_name":"SCPUpdateComponent"},"Enums/SCPUpdateComponent.html#/c:@E@SCPUpdateComponent@SCPUpdateComponentFirmware":{"name":"SCPUpdateComponentFirmware","abstract":"

    If set, this update contains updated firmware for this reader. Firmware updates","parent_name":"SCPUpdateComponent"},"Enums/SCPUpdateComponent.html#/c:@E@SCPUpdateComponent@SCPUpdateComponentConfig":{"name":"SCPUpdateComponentConfig","abstract":"

    If set, this update contains a new configuration for this reader. These may","parent_name":"SCPUpdateComponent"},"Enums/SCPUpdateComponent.html#/c:@E@SCPUpdateComponent@SCPUpdateComponentKeys":{"name":"SCPUpdateComponentKeys","abstract":"

    If set, this update contains updated encryption keys for the reader.","parent_name":"SCPUpdateComponent"},"Enums/SCPUpdateTimeEstimate.html#/c:@E@SCPUpdateTimeEstimate@SCPUpdateTimeEstimateLessThan1Minute":{"name":"SCPUpdateTimeEstimateLessThan1Minute","abstract":"

    The update should take less than 1 minute to complete.

    ","parent_name":"SCPUpdateTimeEstimate"},"Enums/SCPUpdateTimeEstimate.html#/c:@E@SCPUpdateTimeEstimate@SCPUpdateTimeEstimate1To2Minutes":{"name":"SCPUpdateTimeEstimate1To2Minutes","abstract":"

    The update should take 1-2 minutes to complete.

    ","parent_name":"SCPUpdateTimeEstimate"},"Enums/SCPUpdateTimeEstimate.html#/c:@E@SCPUpdateTimeEstimate@SCPUpdateTimeEstimate2To5Minutes":{"name":"SCPUpdateTimeEstimate2To5Minutes","abstract":"

    The update should take 2-5 minutes to complete.

    ","parent_name":"SCPUpdateTimeEstimate"},"Enums/SCPUpdateTimeEstimate.html#/c:@E@SCPUpdateTimeEstimate@SCPUpdateTimeEstimate5To15Minutes":{"name":"SCPUpdateTimeEstimate5To15Minutes","abstract":"

    The update should take 5-15 minutes to complete.

    ","parent_name":"SCPUpdateTimeEstimate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(py)estimatedUpdateTime":{"name":"estimatedUpdateTime","abstract":"

    The estimated amount of time for the update.

    ","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(py)deviceSoftwareVersion":{"name":"deviceSoftwareVersion","abstract":"

    The target version for the update.

    ","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(py)components":{"name":"components","abstract":"

    The components that will be installed in this update.

    ","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(py)requiredAt":{"name":"requiredAt","abstract":"

    The date at which this update will be required to be installed. If this date","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(cm)stringFromUpdateTimeEstimate:":{"name":"+stringFromUpdateTimeEstimate:","abstract":"

    Returns an unlocalized string for the given update time estimate.

    ","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html":{"name":"SCPReaderSoftwareUpdate","abstract":"

    An object representing a reader update.

    "},"Enums/SCPUpdateTimeEstimate.html":{"name":"SCPUpdateTimeEstimate","abstract":"

    The estimated amount of time for an update. Note that these times are estimates;"},"Enums/SCPUpdateComponent.html":{"name":"SCPUpdateComponent","abstract":"

    A bitmask identifying what exact updates are contained within this update.

    "},"Classes/SCPCartLineItem.html#/c:objc(cs)SCPCartLineItem(py)quantity":{"name":"quantity","abstract":"

    The quantity of the line item being purchased.

    ","parent_name":"SCPCartLineItem"},"Classes/SCPCartLineItem.html#/c:objc(cs)SCPCartLineItem(py)displayName":{"name":"displayName","abstract":"

    The description or name of the item.

    ","parent_name":"SCPCartLineItem"},"Classes/SCPCartLineItem.html#/c:objc(cs)SCPCartLineItem(py)amount":{"name":"amount","abstract":"

    The price of the item, provided in the cart’s currency’s smallest unit.

    ","parent_name":"SCPCartLineItem"},"Classes/SCPCartLineItem.html#/c:objc(cs)SCPCartLineItem(im)initWithDisplayName:quantity:amount:":{"name":"-initWithDisplayName:quantity:amount:","abstract":"

    The values set here will be shown on the screen as-is. Make sure you’re","parent_name":"SCPCartLineItem"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(py)lineItems":{"name":"lineItems","abstract":"

    You can add or remove line items from this array individually or reassign the array entirely.","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(py)tax":{"name":"tax","abstract":"

    The displayed tax amount, provided in the currency’s smallest unit.

    ","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(py)total":{"name":"total","abstract":"

    The cart’s total balance, provided in the currency’s smallest unit.

    ","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(py)currency":{"name":"currency","abstract":"

    The currency of the cart.

    ","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(im)initWithCurrency:tax:total:":{"name":"-initWithCurrency:tax:total:","abstract":"

    Initializes an SCPCart with tax and total, in cents, as well as the currency.","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(im)init":{"name":"-init","abstract":"

    Use initWithTax:

    ","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(cm)new":{"name":"+new","abstract":"

    Use initWithTax:

    ","parent_name":"SCPCart"},"Enums/SCPBatteryStatus.html#/c:@E@SCPBatteryStatus@SCPBatteryStatusUnknown":{"name":"SCPBatteryStatusUnknown","abstract":"

    Battery state is not yet known or not available for the connected reader.

    ","parent_name":"SCPBatteryStatus"},"Enums/SCPBatteryStatus.html#/c:@E@SCPBatteryStatus@SCPBatteryStatusCritical":{"name":"SCPBatteryStatusCritical","abstract":"

    The device’s battery is less than or equal to 5%.

    ","parent_name":"SCPBatteryStatus"},"Enums/SCPBatteryStatus.html#/c:@E@SCPBatteryStatus@SCPBatteryStatusLow":{"name":"SCPBatteryStatusLow","abstract":"

    The device’s battery is between 5% and 20%.

    ","parent_name":"SCPBatteryStatus"},"Enums/SCPBatteryStatus.html#/c:@E@SCPBatteryStatus@SCPBatteryStatusNominal":{"name":"SCPBatteryStatusNominal","abstract":"

    The device’s battery is greater than 20%.

    ","parent_name":"SCPBatteryStatus"},"Enums/SCPReaderNetworkStatus.html#/c:@E@SCPReaderNetworkStatus@SCPReaderNetworkStatusOffline":{"name":"SCPReaderNetworkStatusOffline","abstract":"

    The reader is offline. Note that Chipper 2x and WisePad 3 will always report","parent_name":"SCPReaderNetworkStatus"},"Enums/SCPReaderNetworkStatus.html#/c:@E@SCPReaderNetworkStatus@SCPReaderNetworkStatusOnline":{"name":"SCPReaderNetworkStatusOnline","abstract":"

    The reader is online.

    ","parent_name":"SCPReaderNetworkStatus"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageRetryCard":{"name":"SCPReaderDisplayMessageRetryCard","abstract":"

    Retry the presented card.

    ","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageInsertCard":{"name":"SCPReaderDisplayMessageInsertCard","abstract":"

    Insert the presented card.

    ","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageInsertOrSwipeCard":{"name":"SCPReaderDisplayMessageInsertOrSwipeCard","abstract":"

    Insert or swipe the presented card.

    ","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageSwipeCard":{"name":"SCPReaderDisplayMessageSwipeCard","abstract":"

    Swipe the presented card.

    ","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageRemoveCard":{"name":"SCPReaderDisplayMessageRemoveCard","abstract":"

    Remove the presented card.

    ","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageMultipleContactlessCardsDetected":{"name":"SCPReaderDisplayMessageMultipleContactlessCardsDetected","abstract":"

    The reader detected multiple contactless cards. Make sure only one","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageTryAnotherReadMethod":{"name":"SCPReaderDisplayMessageTryAnotherReadMethod","abstract":"

    The card could not be read. Try another read method on the same card, or","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageTryAnotherCard":{"name":"SCPReaderDisplayMessageTryAnotherCard","abstract":"

    The card is invalid. Try another card.

    ","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderInputOptions.html#/c:@E@SCPReaderInputOptions@SCPReaderInputOptionNone":{"name":"SCPReaderInputOptionNone","abstract":"

    No input options are available on the reader.

    ","parent_name":"SCPReaderInputOptions"},"Enums/SCPReaderInputOptions.html#/c:@E@SCPReaderInputOptions@SCPReaderInputOptionSwipeCard":{"name":"SCPReaderInputOptionSwipeCard","abstract":"

    Swipe a magstripe card.

    ","parent_name":"SCPReaderInputOptions"},"Enums/SCPReaderInputOptions.html#/c:@E@SCPReaderInputOptions@SCPReaderInputOptionInsertCard":{"name":"SCPReaderInputOptionInsertCard","abstract":"

    Insert a chip card.

    ","parent_name":"SCPReaderInputOptions"},"Enums/SCPReaderInputOptions.html#/c:@E@SCPReaderInputOptions@SCPReaderInputOptionTapCard":{"name":"SCPReaderInputOptionTapCard","abstract":"

    Tap a contactless card.

    ","parent_name":"SCPReaderInputOptions"},"Enums/SCPReaderEvent.html#/c:@E@SCPReaderEvent@SCPReaderEventCardInserted":{"name":"SCPReaderEventCardInserted","abstract":"

    A card was inserted.

    ","parent_name":"SCPReaderEvent"},"Enums/SCPReaderEvent.html#/c:@E@SCPReaderEvent@SCPReaderEventCardRemoved":{"name":"SCPReaderEventCardRemoved","abstract":"

    A card was removed.

    ","parent_name":"SCPReaderEvent"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didStartInstallingUpdate:cancelable:":{"name":"-localMobileReader:didStartInstallingUpdate:cancelable:","abstract":"

    The reader has started installing a software update.

    ","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didReportReaderSoftwareUpdateProgress:":{"name":"-localMobileReader:didReportReaderSoftwareUpdateProgress:","abstract":"

    The reader reported progress on a software update.

    ","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didFinishInstallingUpdate:error:":{"name":"-localMobileReader:didFinishInstallingUpdate:error:","abstract":"

    The reader has finished installing an update.

    ","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didRequestReaderInput:":{"name":"-localMobileReader:didRequestReaderInput:","abstract":"

    This method is called when the reader begins waiting for input.","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didRequestReaderDisplayMessage:":{"name":"-localMobileReader:didRequestReaderDisplayMessage:","abstract":"

    This method is called to request that a prompt be displayed in your app.","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReaderDidAcceptTermsOfService:":{"name":"-localMobileReaderDidAcceptTermsOfService:","abstract":"

    The reader is reporting that, as part of preparing to accept payments,","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didReportAvailableUpdate:":{"name":"-reader:didReportAvailableUpdate:","abstract":"

    The SDK is reporting that an update is available for the reader.","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didStartInstallingUpdate:cancelable:":{"name":"-reader:didStartInstallingUpdate:cancelable:","abstract":"

    The SDK is reporting that the reader has started installing a software update.

    ","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didReportReaderSoftwareUpdateProgress:":{"name":"-reader:didReportReaderSoftwareUpdateProgress:","abstract":"

    The reader reported progress on a software update.

    ","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didFinishInstallingUpdate:error:":{"name":"-reader:didFinishInstallingUpdate:error:","abstract":"

    The reader is reporting that an installation has finished. If the install was","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didRequestReaderInput:":{"name":"-reader:didRequestReaderInput:","abstract":"

    This method is called when the reader begins waiting for input. Your app","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didRequestReaderDisplayMessage:":{"name":"-reader:didRequestReaderDisplayMessage:","abstract":"

    This method is called to request that a prompt be displayed in your app.","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didReportReaderEvent:info:":{"name":"-reader:didReportReaderEvent:info:","abstract":"

    The SDK reported an event from the reader (e.g. a card was inserted).

    ","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didReportBatteryLevel:status:isCharging:":{"name":"-reader:didReportBatteryLevel:status:isCharging:","abstract":"

    The SDK reported the reader’s battery level or charging state has changed.

    ","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)readerDidReportLowBatteryWarning:":{"name":"-readerDidReportLowBatteryWarning:","abstract":"

    This method is called when the SDK’s currently connected reader has a low battery.

    ","parent_name":"SCPBluetoothReaderDelegate"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeChipper2X":{"name":"SCPDeviceTypeChipper2X","abstract":"

    The BBPOS Chipper 2X BT mobile reader.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeVerifoneP400":{"name":"SCPDeviceTypeVerifoneP400","abstract":"

    The Verifone P400 countertop reader.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeWisePad3":{"name":"SCPDeviceTypeWisePad3","abstract":"

    The BBPOS WisePad 3 mobile reader.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeStripeM2":{"name":"SCPDeviceTypeStripeM2","abstract":"

    The Stripe Reader M2 mobile reader.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeWisePosE":{"name":"SCPDeviceTypeWisePosE","abstract":"

    The BBPOS WisePOS E countertop reader.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeWisePosEDevKit":{"name":"SCPDeviceTypeWisePosEDevKit","abstract":"

    The BBPOS WisePOS E DevKit countertop reader.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeStripeS700":{"name":"SCPDeviceTypeStripeS700","abstract":"

    Stripe Reader S700.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeStripeS700DevKit":{"name":"SCPDeviceTypeStripeS700DevKit","abstract":"

    Stripe Reader S700 DevKit.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeAppleBuiltIn":{"name":"SCPDeviceTypeAppleBuiltIn","abstract":"

    Apple Built-In reader.

    ","parent_name":"SCPDeviceType"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)deviceType":{"name":"deviceType","abstract":"

    The reader’s device type.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)simulated":{"name":"simulated","abstract":"

    True if this is a simulated reader.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)stripeId":{"name":"stripeId","abstract":"

    The Stripe unique identifier for the reader.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)locationId":{"name":"locationId","abstract":"

    The ID of the reader’s Location.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)locationStatus":{"name":"locationStatus","abstract":"

    Used to tell whether the location field has been set.","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)location":{"name":"location","abstract":"

    The details of the location this reader is registered to, if any.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)serialNumber":{"name":"serialNumber","abstract":"

    The reader’s serial number.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)deviceSoftwareVersion":{"name":"deviceSoftwareVersion","abstract":"

    The reader’s current device software version, or nil if this information is","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)availableUpdate":{"name":"availableUpdate","abstract":"

    The available update for this reader, or nil if no update is available.","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)batteryLevel":{"name":"batteryLevel","abstract":"

    The reader’s battery level, represented as a boxed float in the range [0, 1].","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)batteryStatus":{"name":"batteryStatus","abstract":"

    The reader’s battery status. Usable as a general classification for the current","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)isCharging":{"name":"isCharging","abstract":"

    The reader’s charging state, represented as a BOOL","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)ipAddress":{"name":"ipAddress","abstract":"

    The IP address of the reader.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)status":{"name":"status","abstract":"

    The networking status of the reader: either offline or online. Note that","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)label":{"name":"label","abstract":"

    A custom label that may be given to a reader for easier identification.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html":{"name":"SCPReader","abstract":"

    Information about a card reader that has been discovered by or connected to"},"Enums/SCPDeviceType.html":{"name":"SCPDeviceType","abstract":"

    The possible device types for a reader.

    "},"Protocols/SCPBluetoothReaderDelegate.html":{"name":"SCPBluetoothReaderDelegate","abstract":"

    Implement this protocol to handle a connected Bluetooth reader’s events throughout"},"Protocols/SCPLocalMobileReaderDelegate.html":{"name":"SCPLocalMobileReaderDelegate","abstract":"

    Implement this protocol to handle a connected local mobile reader’s events throughout"},"Enums/SCPReaderEvent.html":{"name":"SCPReaderEvent","abstract":"

    The possible events from a connected reader. Used by [SCPBluetoothReaderDelegate reader:didReportReaderEvent:info:].

    "},"Enums/SCPReaderInputOptions.html":{"name":"SCPReaderInputOptions","abstract":"

    This OptionSet represents all of the input methods available to your user when"},"Enums/SCPReaderDisplayMessage.html":{"name":"SCPReaderDisplayMessage","abstract":"

    The display messages that a reader may request be displayed by your app. Used by [SCPBluetoothReaderDelegate reader:didRequestReaderDisplayMessage:].

    "},"Enums/SCPReaderNetworkStatus.html":{"name":"SCPReaderNetworkStatus","abstract":"

    The possible networking statuses for a reader.

    "},"Enums/SCPBatteryStatus.html":{"name":"SCPBatteryStatus","abstract":"

    A categorization of a reader’s battery charge level.

    "},"Classes/SCPCart.html":{"name":"SCPCart","abstract":"

    An SCPCart object contains information about what line items are included in"},"Classes/SCPCartLineItem.html":{"name":"SCPCartLineItem","abstract":"

    Represents a single line item in an SCPCart, displayed on the reader’s screen"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeVisa":{"name":"SCPSimulatedCardTypeVisa","abstract":"

    Visa

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeVisaDebit":{"name":"SCPSimulatedCardTypeVisaDebit","abstract":"

    Visa (debit)

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeMastercard":{"name":"SCPSimulatedCardTypeMastercard","abstract":"

    Mastercard

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeMasterDebit":{"name":"SCPSimulatedCardTypeMasterDebit","abstract":"

    Mastercard (debit)

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeMastercardPrepaid":{"name":"SCPSimulatedCardTypeMastercardPrepaid","abstract":"

    Mastercard (prepaid)

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeAmex":{"name":"SCPSimulatedCardTypeAmex","abstract":"

    American Express

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeAmex2":{"name":"SCPSimulatedCardTypeAmex2","abstract":"

    American Express

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeDiscover":{"name":"SCPSimulatedCardTypeDiscover","abstract":"

    Discover

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeDiscover2":{"name":"SCPSimulatedCardTypeDiscover2","abstract":"

    Discover

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeDiners":{"name":"SCPSimulatedCardTypeDiners","abstract":"

    Diners Club

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeDiners14Digit":{"name":"SCPSimulatedCardTypeDiners14Digit","abstract":"

    Diners Club (14 digit card)

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeJcb":{"name":"SCPSimulatedCardTypeJcb","abstract":"

    JCB

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeUnionPay":{"name":"SCPSimulatedCardTypeUnionPay","abstract":"

    UnionPay

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeInterac":{"name":"SCPSimulatedCardTypeInterac","abstract":"

    Interac

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeEftposAuDebit":{"name":"SCPSimulatedCardTypeEftposAuDebit","abstract":"

    Eftpos Australia

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeEftposAuVisaDebit":{"name":"SCPSimulatedCardTypeEftposAuVisaDebit","abstract":"

    Eftpos Australia/Visa

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeEftposAuDebitMastercard":{"name":"SCPSimulatedCardTypeEftposAuDebitMastercard","abstract":"

    Eftpos Australia/Mastercard

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclined":{"name":"SCPSimulatedCardTypeChargeDeclined","abstract":"

    Charge is declined with a card_declined code.

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedInsufficientFunds":{"name":"SCPSimulatedCardTypeChargeDeclinedInsufficientFunds","abstract":"

    Charge is declined with a card_declined code. The decline_code","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedLostCard":{"name":"SCPSimulatedCardTypeChargeDeclinedLostCard","abstract":"

    Charge is declined with a card_declined code. The decline_code","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedStolenCard":{"name":"SCPSimulatedCardTypeChargeDeclinedStolenCard","abstract":"

    Charge is declined with a card_declined code. The decline_code","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedExpiredCard":{"name":"SCPSimulatedCardTypeChargeDeclinedExpiredCard","abstract":"

    Charge is declined with an expired_card code.

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedProcessingError":{"name":"SCPSimulatedCardTypeChargeDeclinedProcessingError","abstract":"

    Charge is declined with a processing_error code.

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeRefundFailed":{"name":"SCPSimulatedCardTypeRefundFailed","abstract":"

    Refund is declined with a refund_fail error.

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeOnlinePinCvm":{"name":"SCPSimulatedCardTypeOnlinePinCvm","abstract":"

    Payment attaches Online Pin to the transaction.","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeOnlinePinScaRetry":{"name":"SCPSimulatedCardTypeOnlinePinScaRetry","abstract":"

    This flow simulates an Online Pin scenario with SCA compliance.","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeOfflinePinCvm":{"name":"SCPSimulatedCardTypeOfflinePinCvm","abstract":"

    Payment attaches Offline Pin to the transaction.","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeOfflinePinScaRetry":{"name":"SCPSimulatedCardTypeOfflinePinScaRetry","abstract":"

    This flow simulates an Offline Pin scenario with SCA compliance.","parent_name":"SCPSimulatedCardType"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)initWithType:":{"name":"-initWithType:","abstract":"

    Create a Simulated Card object with a given simulated card type.

    ","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)initWithTestCardNumber:":{"name":"-initWithTestCardNumber:","abstract":"

    Create a Simulated Card object with a raw card number. This initializer is","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)init":{"name":"-init","abstract":"

    You cannot instantiate this class without specifying a type or testcard number.

    ","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)isOnlinePin":{"name":"-isOnlinePin","abstract":"

    Returns true if the card is online pin enabled.

    ","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)isOfflinePin":{"name":"-isOfflinePin","abstract":"

    Returns true if the card is offline pin enabled.

    ","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(cm)new":{"name":"+new","abstract":"

    You cannot instantiate this class without specifying a type or testcard number.

    ","parent_name":"SCPSimulatedCard"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateAvailable":{"name":"SCPSimulateReaderUpdateAvailable","abstract":"

    Default value.

    ","parent_name":"SCPSimulateReaderUpdate"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateNone":{"name":"SCPSimulateReaderUpdateNone","abstract":"

    No updates are available

    ","parent_name":"SCPSimulateReaderUpdate"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateRequired":{"name":"SCPSimulateReaderUpdateRequired","abstract":"

    A required full reader software update exists. Use this to simulate the","parent_name":"SCPSimulateReaderUpdate"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateLowBattery":{"name":"SCPSimulateReaderUpdateLowBattery","abstract":"

    A required update exists.

    ","parent_name":"SCPSimulateReaderUpdate"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateRandom":{"name":"SCPSimulateReaderUpdateRandom","abstract":"

    Randomly picks a type of update for the reader to help exercise the","parent_name":"SCPSimulateReaderUpdate"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(py)availableReaderUpdate":{"name":"availableReaderUpdate","abstract":"

    Set this to different values of the SCPSimulateReaderUpdate enum to","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(py)simulatedCard":{"name":"simulatedCard","abstract":"

    Create a SCPSimulatedCard and set it on the shared configuration object to","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(py)simulatedTipAmount":{"name":"simulatedTipAmount","abstract":"

    Set this to simulate a Terminal configuration object with this fixed tip","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)city":{"name":"city","abstract":"

    The city name

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)country":{"name":"country","abstract":"

    The country code

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)line1":{"name":"line1","abstract":"

    The first line of the address

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)line2":{"name":"line2","abstract":"

    The second line of the address

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)postalCode":{"name":"postalCode","abstract":"

    The postal code of the address

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)state":{"name":"state","abstract":"

    The state of the address

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPAddress"},"Enums/SCPLocationStatus.html#/c:@E@SCPLocationStatus@SCPLocationStatusUnknown":{"name":"SCPLocationStatusUnknown","abstract":"

    The location is not known. location will be nil.

    ","parent_name":"SCPLocationStatus"},"Enums/SCPLocationStatus.html#/c:@E@SCPLocationStatus@SCPLocationStatusSet":{"name":"SCPLocationStatusSet","abstract":"

    The location was successfully set to a known location.","parent_name":"SCPLocationStatus"},"Enums/SCPLocationStatus.html#/c:@E@SCPLocationStatus@SCPLocationStatusNotSet":{"name":"SCPLocationStatusNotSet","abstract":"

    This location is known to be not set. location will be nil.

    ","parent_name":"SCPLocationStatus"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)stripeId":{"name":"stripeId","abstract":"

    The ID of the Location

    ","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)address":{"name":"address","abstract":"

    The address of this Location

    ","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)displayName":{"name":"displayName","abstract":"

    The display name of this Location

    ","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)livemode":{"name":"livemode","abstract":"

    Whether this Location was created in livemode

    ","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)metadata":{"name":"metadata","abstract":"

    Any metadata attached to this Location

    ","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPLocation"},"Classes/SCPListLocationsParameters.html#/c:objc(cs)SCPListLocationsParameters(py)limit":{"name":"limit","abstract":"

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    ","parent_name":"SCPListLocationsParameters"},"Classes/SCPListLocationsParameters.html#/c:objc(cs)SCPListLocationsParameters(py)endingBefore":{"name":"endingBefore","abstract":"

    A cursor for use in pagination. ending_before is an object ID that defines","parent_name":"SCPListLocationsParameters"},"Classes/SCPListLocationsParameters.html#/c:objc(cs)SCPListLocationsParameters(py)startingAfter":{"name":"startingAfter","abstract":"

    A cursor for use in pagination. starting_after is an object ID that defines","parent_name":"SCPListLocationsParameters"},"Classes/SCPListLocationsParameters.html#/c:objc(cs)SCPListLocationsParameters(im)initWithLimit:endingBefore:startingAfter:":{"name":"-initWithLimit:endingBefore:startingAfter:","abstract":"

    Initializes SCPListLocationsParameters with the given parameters.

    ","parent_name":"SCPListLocationsParameters"},"Enums/SCPConnectionStatus.html#/c:@E@SCPConnectionStatus@SCPConnectionStatusNotConnected":{"name":"SCPConnectionStatusNotConnected","abstract":"

    The SDK is not connected to a reader.

    ","parent_name":"SCPConnectionStatus"},"Enums/SCPConnectionStatus.html#/c:@E@SCPConnectionStatus@SCPConnectionStatusConnected":{"name":"SCPConnectionStatusConnected","abstract":"

    The SDK is connected to a reader.

    ","parent_name":"SCPConnectionStatus"},"Enums/SCPConnectionStatus.html#/c:@E@SCPConnectionStatus@SCPConnectionStatusConnecting":{"name":"SCPConnectionStatusConnecting","abstract":"

    The SDK is currently connecting to a reader.

    ","parent_name":"SCPConnectionStatus"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(py)locationId":{"name":"locationId","abstract":"

    The ID of the Location which the reader should be","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(py)onBehalfOf":{"name":"onBehalfOf","abstract":"

    If your integration is creating destination charges and using on_behalf_of, you must provide the","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(py)merchantDisplayName":{"name":"merchantDisplayName","abstract":"

    Optional cardholder facing merchant display name that will be used in the prompt for the cardholder","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(py)tosAcceptancePermitted":{"name":"tosAcceptancePermitted","abstract":"

    In order to connect to a reader, merchant-specific terms of service may need to be accepted.","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(im)initWithLocationId:":{"name":"-initWithLocationId:","abstract":"

    Initialize ConnectionConfiguration with a location ID.

    ","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(im)initWithLocationId:merchantDisplayName:onBehalfOf:":{"name":"-initWithLocationId:merchantDisplayName:onBehalfOf:","abstract":"

    Initialize ConnectionConfiguration with a location ID, custom merchant display name, and ‘on behalf of’","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(im)initWithLocationId:merchantDisplayName:onBehalfOf:tosAcceptancePermitted:":{"name":"-initWithLocationId:merchantDisplayName:onBehalfOf:tosAcceptancePermitted:","abstract":"

    Initialize ConnectionConfiguration with a location ID, custom merchant display name, ‘on behalf of’","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(py)failIfInUse":{"name":"failIfInUse","abstract":"

    When set to true, the connection will automatically error if the reader is already","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(py)allowCustomerCancel":{"name":"allowCustomerCancel","abstract":"

    If set to true, the customer will be able to press the red X button on the","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(im)initWithFailIfInUse:allowCustomerCancel:":{"name":"-initWithFailIfInUse:allowCustomerCancel:","abstract":"

    Initialize an InternetConnectionConfiguration object with all possible properties.

    ","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(im)initWithFailIfInUse:":{"name":"-initWithFailIfInUse:","abstract":"

    Initalize an InternetConnectionConfiguration object and set the failIfInUse","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(im)initWithAllowCustomerCancel:":{"name":"-initWithAllowCustomerCancel:","abstract":"

    Initialize an InternetConnectionConfiguration object and set the","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(py)locationId":{"name":"locationId","abstract":"

    The ID of the Location which the reader should be registered to during connection.

    ","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(py)autoReconnectOnUnexpectedDisconnect":{"name":"autoReconnectOnUnexpectedDisconnect","abstract":"

    When set to true, the Terminal SDK will attempt a Bluetooth auto-reconnection on any unexpected disconnect.","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(py)autoReconnectionDelegate":{"name":"autoReconnectionDelegate","abstract":"

    Contains callback methods for Bluetooth auto-reconnection.

    ","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(im)initWithLocationId:":{"name":"-initWithLocationId:","abstract":"

    Initialize your connect options with a location ID.

    ","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(im)initWithLocationId:autoReconnectOnUnexpectedDisconnect:autoReconnectionDelegate:":{"name":"-initWithLocationId:autoReconnectOnUnexpectedDisconnect:autoReconnectionDelegate:","abstract":"

    Initialize your connect options with a location ID and an expected behavior for unexpected disconnects.

    ","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(im)initWithDiscoveryMethod:simulated:":{"name":"-initWithDiscoveryMethod:simulated:","abstract":"

    Initializes a discovery configuration with the given discovery method. All discoverable readers","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(im)initWithDiscoveryMethod:locationId:simulated:":{"name":"-initWithDiscoveryMethod:locationId:simulated:","abstract":"

    This variant of the initializer lets you specify a Location to filter the","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(py)timeout":{"name":"timeout","abstract":"

    The timeout (in seconds) after which discoverReaders: should fail. If the","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(py)discoveryMethod":{"name":"discoveryMethod","abstract":"

    The method by which to discover readers.

    ","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(py)simulated":{"name":"simulated","abstract":"

    Whether to use simulated discovery to discover a device simulator.

    ","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(py)locationId":{"name":"locationId","abstract":"

    A location ID that can be used to filter discovery result so only readers","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(im)init":{"name":"-init","abstract":"

    Use initWithDiscoveryMethod:simulated:

    ","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(cm)new":{"name":"+new","abstract":"

    Use initWithDiscoveryMethod:simulated:

    ","parent_name":"SCPDiscoveryConfiguration"},"Protocols/SCPDiscoveryDelegate.html#/c:objc(pl)SCPDiscoveryDelegate(im)terminal:didUpdateDiscoveredReaders:":{"name":"-terminal:didUpdateDiscoveredReaders:","abstract":"

    This method will be called repeatedly until:

    ","parent_name":"SCPDiscoveryDelegate"},"Enums/SCPDiscoveryMethod.html#/c:@E@SCPDiscoveryMethod@SCPDiscoveryMethodBluetoothScan":{"name":"SCPDiscoveryMethodBluetoothScan","abstract":"

    The Bluetooth Scan discovery method searches for Stripe Terminal’s","parent_name":"SCPDiscoveryMethod"},"Enums/SCPDiscoveryMethod.html#/c:@E@SCPDiscoveryMethod@SCPDiscoveryMethodBluetoothProximity":{"name":"SCPDiscoveryMethodBluetoothProximity","abstract":"

    The Bluetooth Proximity discovery method searches for a subset of","parent_name":"SCPDiscoveryMethod"},"Enums/SCPDiscoveryMethod.html#/c:@E@SCPDiscoveryMethod@SCPDiscoveryMethodInternet":{"name":"SCPDiscoveryMethodInternet","abstract":"

    The Internet discovery method searches for internet-connected readers,","parent_name":"SCPDiscoveryMethod"},"Enums/SCPDiscoveryMethod.html#/c:@E@SCPDiscoveryMethod@SCPDiscoveryMethodLocalMobile":{"name":"SCPDiscoveryMethodLocalMobile","abstract":"

    The Local Mobile discovery method searches for any readers built into the","parent_name":"SCPDiscoveryMethod"},"Enums/SCPDiscoveryMethod.html":{"name":"SCPDiscoveryMethod","abstract":"

    The possible methods for discovering a reader. Pass a variant of this enum"},"Protocols/SCPDiscoveryDelegate.html":{"name":"SCPDiscoveryDelegate","abstract":"

    Implement this protocol to handle a continually updating list"},"Classes/SCPDiscoveryConfiguration.html":{"name":"SCPDiscoveryConfiguration","abstract":"

    Configuration options for discovering readers.

    "},"Classes/SCPBluetoothConnectionConfiguration.html":{"name":"SCPBluetoothConnectionConfiguration","abstract":"

    This class lets you define Bluetooth reader connection options.

    "},"Classes/SCPInternetConnectionConfiguration.html":{"name":"SCPInternetConnectionConfiguration","abstract":"

    This class lets you set options that define internet reader behavior throughout a given"},"Classes/SCPLocalMobileConnectionConfiguration.html":{"name":"SCPLocalMobileConnectionConfiguration","abstract":"

    This class lets you set options that define local mobile reader behavior throughout a given"},"Enums/SCPConnectionStatus.html":{"name":"SCPConnectionStatus","abstract":"

    The possible reader connection statuses for the SDK.

    "},"Classes/SCPListLocationsParameters.html":{"name":"SCPListLocationsParameters","abstract":"

    Parameters to be used when calling Terminal.shared.listLocations() to list"},"Classes/SCPLocation.html":{"name":"SCPLocation","abstract":"

    A Location is used to group readers in the Stripe Terminal ecosystem. The"},"Enums/SCPLocationStatus.html":{"name":"SCPLocationStatus","abstract":"

    Represents the possible states of the location object for a"},"Classes/SCPAddress.html":{"name":"SCPAddress","abstract":"

    Holds address data associated with a given SCPLocation.

    "},"Classes/SCPSimulatorConfiguration.html":{"name":"SCPSimulatorConfiguration","abstract":"

    Simulator specific configurations you can set to test your integration’s"},"Enums/SCPSimulateReaderUpdate.html":{"name":"SCPSimulateReaderUpdate","abstract":"

    Enum used to simulate various types of reader updates being available for"},"Classes/SCPSimulatedCard.html":{"name":"SCPSimulatedCard","abstract":"

    Simulated Card objects can be used with the shared SCPSimulatorConfiguration"},"Enums/SCPSimulatedCardType.html":{"name":"SCPSimulatedCardType","abstract":"

    Enum used to simulate various types of cards and error cases.

    "},"Protocols/SCPJSONDecodable.html#/c:objc(pl)SCPJSONDecodable(cm)decodedObjectFromJSON:":{"name":"+decodedObjectFromJSON:","abstract":"

    Parses a JSON dictionary into an instance of the class. Returns nil if the","parent_name":"SCPJSONDecodable"},"Protocols/SCPJSONDecodable.html#/c:objc(pl)SCPJSONDecodable(py)originalJSON":{"name":"originalJSON","abstract":"

    The raw JSON used to create the object. This may be useful for accessing","parent_name":"SCPJSONDecodable"},"Classes/SCPCancelable.html#/c:objc(cs)SCPCancelable(py)completed":{"name":"completed","abstract":"

    Indicates whether the command has completed. After the command has completed,","parent_name":"SCPCancelable"},"Classes/SCPCancelable.html#/c:objc(cs)SCPCancelable(im)cancel:":{"name":"-cancel:","abstract":"

    Attempts to cancel the action in progress. If the action could not be canceled,","parent_name":"SCPCancelable"},"Enums/SCPLogLevel.html#/c:@E@SCPLogLevel@SCPLogLevelNone":{"name":"SCPLogLevelNone","abstract":"

    No logs will printed to the console.

    ","parent_name":"SCPLogLevel"},"Enums/SCPLogLevel.html#/c:@E@SCPLogLevel@SCPLogLevelVerbose":{"name":"SCPLogLevelVerbose","abstract":"

    Verbose logs will be printed to the console.

    ","parent_name":"SCPLogLevel"},"Protocols/SCPReconnectionDelegate.html#/c:objc(pl)SCPReconnectionDelegate(im)terminal:didStartReaderReconnect:":{"name":"-terminal:didStartReaderReconnect:","abstract":"

    The reader has lost Bluetooth connection to the SDK and reconnection attempts have been started.

    ","parent_name":"SCPReconnectionDelegate"},"Protocols/SCPReconnectionDelegate.html#/c:objc(pl)SCPReconnectionDelegate(im)terminalDidSucceedReaderReconnect:":{"name":"-terminalDidSucceedReaderReconnect:","abstract":"

    The SDK was able to reconnect to the previously connected Bluetooth reader.

    ","parent_name":"SCPReconnectionDelegate"},"Protocols/SCPReconnectionDelegate.html#/c:objc(pl)SCPReconnectionDelegate(im)terminalDidFailReaderReconnect:":{"name":"-terminalDidFailReaderReconnect:","abstract":"

    The SDK was not able to reconnect to the previously connected bluetooth reader. The SDK is now disconnected from any readers.

    ","parent_name":"SCPReconnectionDelegate"},"Protocols/SCPTerminalDelegate.html#/c:objc(pl)SCPTerminalDelegate(im)terminal:didReportUnexpectedReaderDisconnect:":{"name":"-terminal:didReportUnexpectedReaderDisconnect:","abstract":"

    The reader disconnected unexpectedly (that is, without your app explicitly","parent_name":"SCPTerminalDelegate"},"Protocols/SCPTerminalDelegate.html#/c:objc(pl)SCPTerminalDelegate(im)terminal:didChangeConnectionStatus:":{"name":"-terminal:didChangeConnectionStatus:","abstract":"

    The currently connected reader’s connectionStatus changed.

    ","parent_name":"SCPTerminalDelegate"},"Protocols/SCPTerminalDelegate.html#/c:objc(pl)SCPTerminalDelegate(im)terminal:didChangePaymentStatus:":{"name":"-terminal:didChangePaymentStatus:","abstract":"

    The currently connected reader’s paymentStatus changed.

    ","parent_name":"SCPTerminalDelegate"},"Protocols/SCPConnectionTokenProvider.html#/c:objc(pl)SCPConnectionTokenProvider(im)fetchConnectionToken:":{"name":"-fetchConnectionToken:","abstract":"

    Fetches a connection token from your backend server.

    ","parent_name":"SCPConnectionTokenProvider"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)setTokenProvider:":{"name":"+setTokenProvider:","abstract":"

    Sets the token provider for the shared (singleton) SCPTerminal instance.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)hasTokenProvider":{"name":"+hasTokenProvider","abstract":"

    Returns true if a token provider has been set, through setTokenProvider:

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)setLogListener:":{"name":"+setLogListener:","abstract":"

    Sets a block to listen for logs from the shared Terminal instance (optional).

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cpy)shared":{"name":"shared","abstract":"

    Returns the shared (singleton) Terminal instance.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)delegate":{"name":"delegate","abstract":"

    The Terminal singleton object’s primary delegate. This delegate announces","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)connectedReader":{"name":"connectedReader","abstract":"

    Information about the connected SCPReader, or nil if no reader is connected.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)connectionStatus":{"name":"connectionStatus","abstract":"

    The Terminal instance’s current connection status.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)logLevel":{"name":"logLevel","abstract":"

    The log level for the SDK. The default value is .none.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)simulatorConfiguration":{"name":"simulatorConfiguration","abstract":"

    The simulator configuration settings that will be used when connecting to","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)paymentStatus":{"name":"paymentStatus","abstract":"

    The Terminal instance’s current payment status.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)clearCachedCredentials":{"name":"-clearCachedCredentials","abstract":"

    Clears the current connection token, saved reader sessions, and any other","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)supportsReadersOfType:discoveryMethod:simulated:error:":{"name":"-supportsReadersOfType:discoveryMethod:simulated:error:","abstract":"

    Use this method to determine whether the mobile device supports a given reader type","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)discoverReaders:delegate:completion:":{"name":"-discoverReaders:delegate:completion:","abstract":"

    Begins discovering readers based on the given discovery configuration.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)connectBluetoothReader:delegate:connectionConfig:completion:":{"name":"-connectBluetoothReader:delegate:connectionConfig:completion:","abstract":"

    Attempts to connect to the given Bluetooth reader with a given connection","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)connectInternetReader:connectionConfig:completion:":{"name":"-connectInternetReader:connectionConfig:completion:","abstract":"

    Attempts to connect to the given Internet reader with a given connection","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)connectLocalMobileReader:delegate:connectionConfig:completion:":{"name":"-connectLocalMobileReader:delegate:connectionConfig:completion:","abstract":"

    Attempts to connect to the given Local Mobile reader with a given","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)listLocations:completion:":{"name":"-listLocations:completion:","abstract":"

    Retrieves a list of SCPLocation objects belonging to your merchant. You must specify","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)installAvailableUpdate":{"name":"-installAvailableUpdate","abstract":"

    Installs the available update for the connected reader.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)disconnectReader:":{"name":"-disconnectReader:","abstract":"

    Attempts to disconnect from the currently connected reader.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)createPaymentIntent:completion:":{"name":"-createPaymentIntent:completion:","abstract":"

    Creates a new SCPPaymentIntent with the given parameters.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)retrievePaymentIntent:completion:":{"name":"-retrievePaymentIntent:completion:","abstract":"

    Retrieves a SCPPaymentIntent with a client secret.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectPaymentMethod:completion:":{"name":"-collectPaymentMethod:completion:","abstract":"

    Collects a payment method for the given SCPPaymentIntent.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectPaymentMethod:collectConfig:completion:":{"name":"-collectPaymentMethod:collectConfig:completion:","abstract":"

    Collects a payment method for the given PaymentIntent, with the specified configuration.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)processPayment:completion:":{"name":"-processPayment:completion:","abstract":"

    Processes a payment after collecting a payment method succeeds.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)cancelPaymentIntent:completion:":{"name":"-cancelPaymentIntent:completion:","abstract":"

    Cancels an SCPPaymentIntent.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)readReusableCard:completion:":{"name":"-readReusableCard:completion:","abstract":"

    Reads a card with the given parameters and returns a PaymentMethod.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)createSetupIntent:completion:":{"name":"-createSetupIntent:completion:","abstract":"

    Creates a new SCPSetupIntent with the given parameters.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)retrieveSetupIntent:completion:":{"name":"-retrieveSetupIntent:completion:","abstract":"

    Retrieves an SCPSetupIntent with a client secret.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)cancelSetupIntent:completion:":{"name":"-cancelSetupIntent:completion:","abstract":"

    Cancels an SCPPaymentIntent.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectSetupIntentPaymentMethod:customerConsentCollected:completion:":{"name":"-collectSetupIntentPaymentMethod:customerConsentCollected:completion:","abstract":"

    Collects a payment method for the given SCPSetupIntent.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)confirmSetupIntent:completion:":{"name":"-confirmSetupIntent:completion:","abstract":"

    Confirms a SetupIntent after the payment method has been successfully collected.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectRefundPaymentMethod:completion:":{"name":"-collectRefundPaymentMethod:completion:","abstract":"

    Initiates an in-person refund with a given set of SCPRefundParameters by","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)processRefund:":{"name":"-processRefund:","abstract":"

    Processes an in-person refund after the refund payment method has been collected.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)clearReaderDisplay:":{"name":"-clearReaderDisplay:","abstract":"

    Clears the reader display and resets it to the splash screen.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)setReaderDisplay:completion:":{"name":"-setReaderDisplay:completion:","abstract":"

    Updates the reader display with cart information.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromReaderInputOptions:":{"name":"+stringFromReaderInputOptions:","abstract":"

    Returns an unlocalized string for the given reader input options, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromReaderDisplayMessage:":{"name":"+stringFromReaderDisplayMessage:","abstract":"

    Returns an unlocalized string for the given reader display message, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromReaderEvent:":{"name":"+stringFromReaderEvent:","abstract":"

    Returns an unlocalized string for the given reader event, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromConnectionStatus:":{"name":"+stringFromConnectionStatus:","abstract":"

    Returns an unlocalized string for the given connection status, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromPaymentStatus:":{"name":"+stringFromPaymentStatus:","abstract":"

    Returns an unlocalized string for the given payment status, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromDeviceType:":{"name":"+stringFromDeviceType:","abstract":"

    Returns an unlocalized string for the given device type.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromDiscoveryMethod:":{"name":"+stringFromDiscoveryMethod:","abstract":"

    Returns an unlocalized string for the given discovery method.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromCardBrand:":{"name":"+stringFromCardBrand:","abstract":"

    Returns an unlocalized string for the given card brand.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromPaymentIntentStatus:":{"name":"+stringFromPaymentIntentStatus:","abstract":"

    Returns an unlocalized string for the given payment intent status.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromCaptureMethod:":{"name":"+stringFromCaptureMethod:","abstract":"

    Returns an unlocalized string for the given capture method.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)init":{"name":"-init","abstract":"

    Use initWithConfiguration:tokenProvider:delegate:

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)new":{"name":"+new","abstract":"

    Use initWithConfiguration:tokenProvider:delegate:

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html":{"name":"SCPTerminal","abstract":"

    The SCPTerminal singleton object exposes an interface for discovering readers,"},"Protocols/SCPConnectionTokenProvider.html":{"name":"SCPConnectionTokenProvider","abstract":"

    Before integrating the SDK, you should create an endpoint on your backend"},"Protocols/SCPTerminalDelegate.html":{"name":"SCPTerminalDelegate","abstract":"

    Implement this protocol to handle connection and payment updates from the"},"Protocols/SCPReconnectionDelegate.html":{"name":"SCPReconnectionDelegate","abstract":"

    Implement this protocol to handle bluetooth auto-reconnection.

    "},"Enums/SCPLogLevel.html":{"name":"SCPLogLevel","abstract":"

    The various log levels for the SDK.

    "},"Classes/SCPCancelable.html":{"name":"SCPCancelable","abstract":"

    An object representing an action that can be canceled.

    "},"Protocols/SCPJSONDecodable.html":{"name":"SCPJSONDecodable","abstract":"

    Objects conforming to this protocol can be instantiated by decoding a JSON"},"Terminal.html#/c:SCPTerminal.h@SCPSDKVersion":{"name":"SCPSDKVersion","abstract":"

    The current version of this library.

    "},"Terminal.html":{"name":"Terminal"},"Reader%20Discovery%20%26%20Connection.html":{"name":"Reader Discovery & Connection"},"Reader.html":{"name":"Reader"},"Reader%20Updates.html":{"name":"Reader Updates"},"Payment.html":{"name":"Payment"},"Card-Present%20Refunds.html":{"name":"Card-Present Refunds"},"Saving%20Cards.html":{"name":"Saving Cards"},"Errors.html":{"name":"Errors"},"Blocks.html":{"name":"Blocks"}} \ No newline at end of file diff --git a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/docSet.dsidx b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/docSet.dsidx index b9aa2706..1676015b 100644 Binary files a/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/docSet.dsidx and b/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/docSet.dsidx differ diff --git a/docs/docs/docsets/StripeTerminal.tgz b/docs/docs/docsets/StripeTerminal.tgz index 407ee9d9..4eb67678 100644 Binary files a/docs/docs/docsets/StripeTerminal.tgz and b/docs/docs/docsets/StripeTerminal.tgz differ diff --git a/docs/docs/index.html b/docs/docs/index.html index 5505a897..46c00a9f 100644 --- a/docs/docs/index.html +++ b/docs/docs/index.html @@ -20,7 +20,7 @@

    - StripeTerminal 2.18.1 Docs + StripeTerminal 2.19.0 Docs

    @@ -523,7 +523,7 @@

    Previous API References

    -

    © 2023 Stripe. All rights reserved. (Last updated: 2023-03-15)

    +

    © 2023 Stripe. All rights reserved. (Last updated: 2023-04-03)

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    diff --git a/docs/docs/search.json b/docs/docs/search.json index 323a4709..35e53f3c 100644 --- a/docs/docs/search.json +++ b/docs/docs/search.json @@ -1 +1 @@ -{"Blocks.html#/c:SCPBlocks.h@T@SCPConnectionTokenCompletionBlock":{"name":"SCPConnectionTokenCompletionBlock","abstract":"

    A block called with a connection token or an error from your backend.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPErrorCompletionBlock":{"name":"SCPErrorCompletionBlock","abstract":"

    A block called with an optional error.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPLogListenerBlock":{"name":"SCPLogListenerBlock","abstract":"

    A block called with a logline from the SDK.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPPaymentIntentCompletionBlock":{"name":"SCPPaymentIntentCompletionBlock","abstract":"

    A block called with a PaymentIntent or an error.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPPaymentMethodCompletionBlock":{"name":"SCPPaymentMethodCompletionBlock","abstract":"

    A block called with a PaymentMethod.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPProcessPaymentCompletionBlock":{"name":"SCPProcessPaymentCompletionBlock","abstract":"

    A block called with a PaymentIntent or a ProcessPaymentError

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPReaderCompletionBlock":{"name":"SCPReaderCompletionBlock","abstract":"

    A block called with a reader object or an error.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPProcessRefundCompletionBlock":{"name":"SCPProcessRefundCompletionBlock","abstract":"

    A block called with a Refund or a ProcessRefundError.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPConfirmSetupIntentCompletionBlock":{"name":"SCPConfirmSetupIntentCompletionBlock","abstract":"

    A block called with a SetupIntent or a ConfirmSetupIntentError.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPLocationsCompletionBlock":{"name":"SCPLocationsCompletionBlock","abstract":"

    A block called with a list of Locations or an error.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPRefundCompletionBlock":{"name":"SCPRefundCompletionBlock","abstract":"

    A block called with a Refund or an error.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPSetupIntentCompletionBlock":{"name":"SCPSetupIntentCompletionBlock","abstract":"

    A block called with a SetupIntent or an error.

    "},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBusy":{"name":"SCPErrorBusy","abstract":"

    The SDK is busy executing another command. The SDK can only execute a","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCancelFailedAlreadyCompleted":{"name":"SCPErrorCancelFailedAlreadyCompleted","abstract":"

    Canceling a command failed because the command already completed.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNotConnectedToReader":{"name":"SCPErrorNotConnectedToReader","abstract":"

    No reader is connected. Connect to a reader before trying again.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAlreadyConnectedToReader":{"name":"SCPErrorAlreadyConnectedToReader","abstract":"

    Already connected to a reader.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorConnectionTokenProviderCompletedWithNothing":{"name":"SCPErrorConnectionTokenProviderCompletedWithNothing","abstract":"

    Your implementation of fetchConnectionToken called the completion block","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorProcessInvalidPaymentIntent":{"name":"SCPErrorProcessInvalidPaymentIntent","abstract":"

    processPayment was called with an unknown or invalid PaymentIntent.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNilPaymentIntent":{"name":"SCPErrorNilPaymentIntent","abstract":"

    collectPaymentMethod or processPayment was called with a nil PaymentIntent.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNilSetupIntent":{"name":"SCPErrorNilSetupIntent","abstract":"

    collectSetupIntentPaymentMethod or processSetupIntent was called with","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNilRefundPaymentMethod":{"name":"SCPErrorNilRefundPaymentMethod","abstract":"

    processRefund was called without calling collectRefundPaymentMethod","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidRefundParameters":{"name":"SCPErrorInvalidRefundParameters","abstract":"

    The RefundParameters object has invalid values. The Charge ID (ch_123abc)","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidClientSecret":{"name":"SCPErrorInvalidClientSecret","abstract":"

    A PaymentIntent or SetupIntent was referenced using an invalid client secret.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorMustBeDiscoveringToConnect":{"name":"SCPErrorMustBeDiscoveringToConnect","abstract":"

    The SDK must be actively Discovering Readers in order to successfully","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCannotConnectToUndiscoveredReader":{"name":"SCPErrorCannotConnectToUndiscoveredReader","abstract":"

    Before connecting to a reader, it must have already been discovered in the","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidDiscoveryConfiguration":{"name":"SCPErrorInvalidDiscoveryConfiguration","abstract":"

    discoverReaders was called using an invalid SCPDiscoveryConfiguration.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidReaderForUpdate":{"name":"SCPErrorInvalidReaderForUpdate","abstract":"

    installUpdate was passed an update that is for a different reader. Updates can only","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnsupportedSDK":{"name":"SCPErrorUnsupportedSDK","abstract":"

    -[SCPTerminal connectReader:completion:] was called from an unsupported version","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorFeatureNotAvailableWithConnectedReader":{"name":"SCPErrorFeatureNotAvailableWithConnectedReader","abstract":"

    This feature is currently not available for the selected reader.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorFeatureNotAvailable":{"name":"SCPErrorFeatureNotAvailable","abstract":"

    This feature is not currently available.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidListLocationsLimitParameter":{"name":"SCPErrorInvalidListLocationsLimitParameter","abstract":"

    The ListLocationsParameters object has invalid values.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothConnectionInvalidLocationIdParameter":{"name":"SCPErrorBluetoothConnectionInvalidLocationIdParameter","abstract":"

    The locationId parameter to BluetoothConnectionConfiguration is required but a valid one was not provided.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidRequiredParameter":{"name":"SCPErrorInvalidRequiredParameter","abstract":"

    A required parameter was invalid or missing.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderConnectionConfigurationInvalid":{"name":"SCPErrorReaderConnectionConfigurationInvalid","abstract":"

    An invalid ConnectionConfiguration was passed through connect.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderTippingParameterInvalid":{"name":"SCPErrorReaderTippingParameterInvalid","abstract":"

    An invalid usage of eligibleAmount or skipTipping was passed into collect.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidLocationIdParameter":{"name":"SCPErrorInvalidLocationIdParameter","abstract":"

    The provided location ID parameter was invalid.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCanceled":{"name":"SCPErrorCanceled","abstract":"

    The command was canceled by your app.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorLocationServicesDisabled":{"name":"SCPErrorLocationServicesDisabled","abstract":"

    Access to location services is currently disabled. This may be because:

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothDisabled":{"name":"SCPErrorBluetoothDisabled","abstract":"

    This error indicates that Bluetooth is turned off, and the user should use","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothAccessDenied":{"name":"SCPErrorBluetoothAccessDenied","abstract":"

    Bluetooth is turned on on the device, but access to Bluetooth has been denied","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothScanTimedOut":{"name":"SCPErrorBluetoothScanTimedOut","abstract":"

    Scanning for bluetooth devices timed out.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothLowEnergyUnsupported":{"name":"SCPErrorBluetoothLowEnergyUnsupported","abstract":"

    Bluetooth Low Energy is unsupported on this iOS device. Use a different","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedBatteryLow":{"name":"SCPErrorReaderSoftwareUpdateFailedBatteryLow","abstract":"

    Updating the reader software failed because the reader’s battery is","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedInterrupted":{"name":"SCPErrorReaderSoftwareUpdateFailedInterrupted","abstract":"

    Updating the reader software failed because the update was interrupted.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedExpiredUpdate":{"name":"SCPErrorReaderSoftwareUpdateFailedExpiredUpdate","abstract":"

    Updating the reader software failed because the update has expired. Please disconnect and","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothConnectionFailedBatteryCriticallyLow":{"name":"SCPErrorBluetoothConnectionFailedBatteryCriticallyLow","abstract":"

    The reader has a critically low battery and cannot connect to the","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardInsertNotRead":{"name":"SCPErrorCardInsertNotRead","abstract":"

    The card is not a chip card.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardSwipeNotRead":{"name":"SCPErrorCardSwipeNotRead","abstract":"

    The swipe could not be read.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardReadTimedOut":{"name":"SCPErrorCardReadTimedOut","abstract":"

    Reading a card timed out.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardRemoved":{"name":"SCPErrorCardRemoved","abstract":"

    The card was removed during the transaction.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardLeftInReader":{"name":"SCPErrorCardLeftInReader","abstract":"

    A card can only be used for one transaction, and must be removed after","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorMissingEMVData":{"name":"SCPErrorMissingEMVData","abstract":"

    The reader failed to read the data from the presented payment method. If you encounter","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCommandNotAllowed":{"name":"SCPErrorCommandNotAllowed","abstract":"

    The command was not permitted to execute by the operating system.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnsupportedMobileDeviceConfiguration":{"name":"SCPErrorUnsupportedMobileDeviceConfiguration","abstract":"

    The mobile device on which the app is running is in an unsupported","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorPasscodeNotEnabled":{"name":"SCPErrorPasscodeNotEnabled","abstract":"

    The mobile device on which the app is running must have a passcode set.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCommandNotAllowedDuringCall":{"name":"SCPErrorCommandNotAllowedDuringCall","abstract":"

    The card reader cannot be used while a phone call is active.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidAmount":{"name":"SCPErrorInvalidAmount","abstract":"

    An attempt was made to charge an amount not supported by the reader.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidCurrency":{"name":"SCPErrorInvalidCurrency","abstract":"

    An attempt was made to charge an amount in a currency not supported by the reader.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderTOSAcceptanceRequiresiCloudSignIn":{"name":"SCPErrorAppleBuiltInReaderTOSAcceptanceRequiresiCloudSignIn","abstract":"

    Failed to accept reader-specific terms of service because there is no iCloud","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderTOSAcceptanceCanceled":{"name":"SCPErrorAppleBuiltInReaderTOSAcceptanceCanceled","abstract":"

    The user cancelled reader-specific terms of service acceptance.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderBusy":{"name":"SCPErrorReaderBusy","abstract":"

    The reader is busy.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorIncompatibleReader":{"name":"SCPErrorIncompatibleReader","abstract":"

    An incompatible reader was detected. You can only use the Stripe Terminal","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderCommunicationError":{"name":"SCPErrorReaderCommunicationError","abstract":"

    Could not communicate with the reader.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNFCDisabled":{"name":"SCPErrorNFCDisabled","abstract":"

    NFC functionality is disabled.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothError":{"name":"SCPErrorBluetoothError","abstract":"

    Generic Bluetooth error.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothConnectTimedOut":{"name":"SCPErrorBluetoothConnectTimedOut","abstract":"

    Connecting to the bluetooth device timed out. Make sure the device is","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothDisconnected":{"name":"SCPErrorBluetoothDisconnected","abstract":"

    The Bluetooth device was disconnected unexpectedly.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothPeerRemovedPairingInformation":{"name":"SCPErrorBluetoothPeerRemovedPairingInformation","abstract":"

    Bluetooth pairing error, the reader has removed this device pairing information.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothAlreadyPairedWithAnotherDevice":{"name":"SCPErrorBluetoothAlreadyPairedWithAnotherDevice","abstract":"

    The Bluetooth reader is already paired to another device. The Bluetooth reader","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailed":{"name":"SCPErrorReaderSoftwareUpdateFailed","abstract":"

    Generic reader software update error.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedReaderError":{"name":"SCPErrorReaderSoftwareUpdateFailedReaderError","abstract":"

    Updating the reader software failed because there was an error","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedServerError":{"name":"SCPErrorReaderSoftwareUpdateFailedServerError","abstract":"

    Updating the reader software failed because there was an error","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnsupportedReaderVersion":{"name":"SCPErrorUnsupportedReaderVersion","abstract":"

    processPayment was called from a reader with an unsupported reader","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnknownReaderIpAddress":{"name":"SCPErrorUnknownReaderIpAddress","abstract":"

    The reader returned from discovery does not have an IP address and cannot","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInternetConnectTimeOut":{"name":"SCPErrorInternetConnectTimeOut","abstract":"

    Connecting to reader over the internet timed out. Make sure your device and","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorConnectFailedReaderIsInUse":{"name":"SCPErrorConnectFailedReaderIsInUse","abstract":"

    Connecting to the reader failed because it is currently in use","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothReconnectStarted":{"name":"SCPErrorBluetoothReconnectStarted","abstract":"

    The Bluetooth reader has disconnected and we are attempting to reconnect.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderNotAccessibleInBackground":{"name":"SCPErrorReaderNotAccessibleInBackground","abstract":"

    An attempt was made to interact with the reader while the the app is in the background.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderFailedToPrepare":{"name":"SCPErrorAppleBuiltInReaderFailedToPrepare","abstract":"

    Preparing the Apple Built-In reader to collect payments failed.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderDeviceBanned":{"name":"SCPErrorAppleBuiltInReaderDeviceBanned","abstract":"

    This device cannot be used to process using the Apple Built-In reader as it has been banned.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderTOSNotYetAccepted":{"name":"SCPErrorAppleBuiltInReaderTOSNotYetAccepted","abstract":"

    The operation could not be completed because the reader-specific terms of service have","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderTOSAcceptanceFailed":{"name":"SCPErrorAppleBuiltInReaderTOSAcceptanceFailed","abstract":"

    Failed to accept reader-specific terms of service using the signed-in Apple ID.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderMerchantBlocked":{"name":"SCPErrorAppleBuiltInReaderMerchantBlocked","abstract":"

    This merchant account cannot be used with Apple Built-In reader as it has been blocked.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderInvalidMerchant":{"name":"SCPErrorAppleBuiltInReaderInvalidMerchant","abstract":"

    This merchant account cannot be used with the Apple Built-In reader as it is invalid.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnexpectedSdkError":{"name":"SCPErrorUnexpectedSdkError","abstract":"

    Unexpected SDK error.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnexpectedReaderError":{"name":"SCPErrorUnexpectedReaderError","abstract":"

    Unexpected reader error.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorDeclinedByStripeAPI":{"name":"SCPErrorDeclinedByStripeAPI","abstract":"

    The Stripe API declined the transaction.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorDeclinedByReader":{"name":"SCPErrorDeclinedByReader","abstract":"

    The reader declined the transaction. Try another card.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCommandRequiresCardholderConsent":{"name":"SCPErrorCommandRequiresCardholderConsent","abstract":"

    The cardholder must give consent in order for this operation to succeed.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorRefundFailed":{"name":"SCPErrorRefundFailed","abstract":"

    The refund failed. The customer’s bank or card issuer was unable to process","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNotConnectedToInternet":{"name":"SCPErrorNotConnectedToInternet","abstract":"

    The SDK is not connected to the internet.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorRequestTimedOut":{"name":"SCPErrorRequestTimedOut","abstract":"

    The underlying request timed out.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorStripeAPIError":{"name":"SCPErrorStripeAPIError","abstract":"

    The underlying request returned an API error.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorStripeAPIResponseDecodingError":{"name":"SCPErrorStripeAPIResponseDecodingError","abstract":"

    The API response from Stripe could not be decoded.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInternalNetworkError":{"name":"SCPErrorInternalNetworkError","abstract":"

    Generic network error

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorConnectionTokenProviderCompletedWithError":{"name":"SCPErrorConnectionTokenProviderCompletedWithError","abstract":"

    Your implementation of -[SCPConnectionTokenProvider fetchConnectionToken:]","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorSessionExpired":{"name":"SCPErrorSessionExpired","abstract":"

    The current session has expired and the reader must be disconnected and","parent_name":"SCPError"},"Enums/SCPError.html":{"name":"SCPError","abstract":"

    Possible error codes for NSError objects under the SCPErrorDomain domain.

    "},"Errors.html#/c:@SCPErrorDomain":{"name":"SCPErrorDomain","abstract":"

    The error domain for all errors originating from the Stripe Terminal SDK.

    "},"Errors.html#/c:SCPErrors.h@T@SCPErrorKey":{"name":"SCPErrorKey","abstract":"

    Use this enum to access userInfo keys for NSError objects under the"},"Errors.html#/c:@SCPErrorKeyMessage":{"name":"SCPErrorKeyMessage","abstract":"

    An error message explaining what went wrong. You probably shouldn’t show this"},"Errors.html#/c:@SCPErrorKeyHttpStatusCode":{"name":"SCPErrorKeyHttpStatusCode","abstract":"

    The HTTP status code of the response.

    "},"Errors.html#/c:@SCPErrorKeyReaderMessage":{"name":"SCPErrorKeyReaderMessage","abstract":"

    This error message comes from the reader. You probably shouldn’t show this"},"Errors.html#/c:@SCPErrorKeyDeviceBannedUntilDate":{"name":"SCPErrorKeyDeviceBannedUntilDate","abstract":"

    If an Apple Built-In reader fails to connect due to a device ban and the error"},"Errors.html#/c:@SCPErrorKeyStripeAPIRequestId":{"name":"SCPErrorKeyStripeAPIRequestId","abstract":"

    If a Stripe API request failed, the failed request’s id will be returned in the"},"Errors.html#/c:@SCPErrorKeyStripeAPIDeclineCode":{"name":"SCPErrorKeyStripeAPIDeclineCode","abstract":"

    The decline code returned by the Stripe API.

    "},"Errors.html#/c:@SCPErrorKeyStripeAPIErrorCode":{"name":"SCPErrorKeyStripeAPIErrorCode","abstract":"

    The error code returned by the Stripe API.

    "},"Errors.html#/c:@SCPErrorKeyStripeAPIErrorParameter":{"name":"SCPErrorKeyStripeAPIErrorParameter","abstract":"

    The parameter the error relates to if the error is parameter-specific.

    "},"Errors.html#/c:@SCPErrorKeyStripeAPIErrorType":{"name":"SCPErrorKeyStripeAPIErrorType","abstract":"

    The error type returned by the Stripe API.

    "},"Errors.html#/c:@SCPErrorKeyStripeAPIPaymentIntent":{"name":"SCPErrorKeyStripeAPIPaymentIntent","abstract":"

    If a Stripe API request failed and the error has an associated PaymentIntent,"},"Errors.html#/c:@SCPErrorKeyStripeAPIDocUrl":{"name":"SCPErrorKeyStripeAPIDocUrl","abstract":"

    The documentation URL for the error returned by the Stripe API.

    "},"Errors.html#/c:@SCPErrorKeyStripeAPIFailureReason":{"name":"SCPErrorKeyStripeAPIFailureReason","abstract":"

    If a refund fails, the reason for refund failure if known. Possible values"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(py)setupIntent":{"name":"setupIntent","abstract":"

    The updated SetupIntent after confirmSetupIntent failed.

    ","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(py)requestError":{"name":"requestError","abstract":"

    If confirmSetupIntent failed because the underlying network request errored,","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(py)declineCode":{"name":"declineCode","abstract":"

    If confirmSetupIntent failed because the payment method was declined, this","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPSetupAttemptCardPresentDetails.html#/c:objc(cs)SCPSetupAttemptCardPresentDetails(py)generatedCard":{"name":"generatedCard","abstract":"

    The ID of the Card PaymentMethod which was generated by this SetupAttempt.

    ","parent_name":"SCPSetupAttemptCardPresentDetails"},"Classes/SCPSetupAttemptCardPresentDetails.html#/c:objc(cs)SCPSetupAttemptCardPresentDetails(py)emvAuthData":{"name":"emvAuthData","abstract":"

    The Authorization Response Cryptogram (ARPC) from the issuer.

    ","parent_name":"SCPSetupAttemptCardPresentDetails"},"Classes/SCPSetupAttemptCardPresentDetails.html#/c:objc(cs)SCPSetupAttemptCardPresentDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPSetupAttemptCardPresentDetails"},"Classes/SCPSetupAttemptCardPresentDetails.html#/c:objc(cs)SCPSetupAttemptCardPresentDetails(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPSetupAttemptCardPresentDetails"},"Classes/SCPSetupAttemptPaymentMethodDetails.html#/c:objc(cs)SCPSetupAttemptPaymentMethodDetails(py)type":{"name":"type","abstract":"

    The type of the PaymentMethod. The corresponding, similarly named property","parent_name":"SCPSetupAttemptPaymentMethodDetails"},"Classes/SCPSetupAttemptPaymentMethodDetails.html#/c:objc(cs)SCPSetupAttemptPaymentMethodDetails(py)cardPresent":{"name":"cardPresent","abstract":"

    If this is a card present payment method (ie self.type == SCPPaymentMethodTypeCardPresent),","parent_name":"SCPSetupAttemptPaymentMethodDetails"},"Classes/SCPSetupAttemptPaymentMethodDetails.html#/c:objc(cs)SCPSetupAttemptPaymentMethodDetails(py)interacPresent":{"name":"interacPresent","abstract":"

    If this is a card present payment method (ie self.type == SCPPaymentMethodTypeInteracPresent),","parent_name":"SCPSetupAttemptPaymentMethodDetails"},"Classes/SCPSetupAttemptPaymentMethodDetails.html#/c:objc(cs)SCPSetupAttemptPaymentMethodDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPSetupAttemptPaymentMethodDetails"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)application":{"name":"application","abstract":"

    The ID of the Connect application that created the SetupIntent.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)created":{"name":"created","abstract":"

    Time at which the object was created.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)customer":{"name":"customer","abstract":"

    ID of the Customer this SetupIntent belongs to, if one exists.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)onBehalfOf":{"name":"onBehalfOf","abstract":"

    (Connect) The account (if any) for which the setup is intended.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)paymentMethod":{"name":"paymentMethod","abstract":"

    ID of the payment method used with this SetupAttempt.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)paymentMethodDetails":{"name":"paymentMethodDetails","abstract":"

    Details about the payment method at the time of SetupIntent confirmation.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)setupIntent":{"name":"setupIntent","abstract":"

    ID of the SetupIntent that this attempt belongs to.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)status":{"name":"status","abstract":"

    The status of this SetupAttempt. One of: requires_confirmation,","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)stripeId":{"name":"stripeId","abstract":"

    The unique identifier for the SetupAttempt.

    ","parent_name":"SCPSetupAttempt"},"Enums/SCPSetupIntentUsage.html#/c:@E@SCPSetupIntentUsage@SCPSetupIntentUsageOffSession":{"name":"SCPSetupIntentUsageOffSession","abstract":"

    An off-session usage indicates to Stripe that future payments will take place","parent_name":"SCPSetupIntentUsage"},"Enums/SCPSetupIntentUsage.html#/c:@E@SCPSetupIntentUsage@SCPSetupIntentUsageOnSession":{"name":"SCPSetupIntentUsageOnSession","abstract":"

    An on-session usage indicates to Stripe that future payments will take place","parent_name":"SCPSetupIntentUsage"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusRequiresPaymentMethod":{"name":"SCPSetupIntentStatusRequiresPaymentMethod","abstract":"

    Next step: collect a payment method by calling collectPaymentMethod.

    ","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusRequiresConfirmation":{"name":"SCPSetupIntentStatusRequiresConfirmation","abstract":"

    Next step: confirm the SetupIntent by calling confirmSetupIntent.

    ","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusRequiresAction":{"name":"SCPSetupIntentStatusRequiresAction","abstract":"

    If the setup requires additional actions, such as authenticating with","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusProcessing":{"name":"SCPSetupIntentStatusProcessing","abstract":"

    Once required actions are handled, the SetupIntent moves to processing.","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusCanceled":{"name":"SCPSetupIntentStatusCanceled","abstract":"

    The SetupIntent was canceled.

    ","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusSucceeded":{"name":"SCPSetupIntentStatusSucceeded","abstract":"

    The SetupIntent succeeded.

    ","parent_name":"SCPSetupIntentStatus"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)customer":{"name":"customer","abstract":"

    ID of the customer this SetupIntent belongs to, if one exists.

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)stripeDescription":{"name":"stripeDescription","abstract":"

    An arbitrary string attached to the object. Often useful for displaying to users.

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)metadata":{"name":"metadata","abstract":"

    Set of key-value pairs that you can attach to an object. This can be useful for","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)usage":{"name":"usage","abstract":"

    Indicates how the payment method is intended to be used in the future. If not","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)onBehalfOf":{"name":"onBehalfOf","abstract":"

    Connect Only:** The Stripe account ID for which this SetupIntent is created.

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(im)initWithCustomer:":{"name":"-initWithCustomer:","abstract":"

    Initializes SCPSetupIntentParameters with the given customer ID.

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(im)init":{"name":"-init","abstract":"

    Use initWithCustomer:

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(cm)new":{"name":"+new","abstract":"

    Use initWithCustomer:

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)description":{"name":"description","abstract":"

    Use stripeDescription for the string attached to the object.

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)stripeId":{"name":"stripeId","abstract":"

    The unique identifier for the intent.

    ","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)created":{"name":"created","abstract":"

    When the intent was created.

    ","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)customer":{"name":"customer","abstract":"

    The identifier of a customer object to which the SetupIntent is attached, if applicable.

    ","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)metadata":{"name":"metadata","abstract":"

    Set of key-value pairs attached to the object.

    ","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)usage":{"name":"usage","abstract":"

    An SCPSetupIntentUsage value describing how the SetupIntent will be used.","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)status":{"name":"status","abstract":"

    The status of the intent.

    ","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)latestAttempt":{"name":"latestAttempt","abstract":"

    The most recent SetupAttempt for this SetupIntent

    ","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class. You should only use SetupIntents","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class. You should only use SetupIntents","parent_name":"SCPSetupIntent"},"Classes/SCPReadReusableCardParameters.html#/c:objc(cs)SCPReadReusableCardParameters(py)customer":{"name":"customer","abstract":"

    Optional parameter: attach the new PaymentMethod to Customer with this id

    ","parent_name":"SCPReadReusableCardParameters"},"Classes/SCPReadReusableCardParameters.html#/c:objc(cs)SCPReadReusableCardParameters(py)metadata":{"name":"metadata","abstract":"

    Optional set of key-value pairs attached to the object. The default is nil.

    ","parent_name":"SCPReadReusableCardParameters"},"Classes/SCPReadReusableCardParameters.html":{"name":"SCPReadReusableCardParameters","abstract":"

    Parameters for reading a reusable card.

    "},"Classes/SCPSetupIntent.html":{"name":"SCPSetupIntent","abstract":"

    A SetupIntent guides you through the process of setting up and saving a"},"Classes/SCPSetupIntentParameters.html":{"name":"SCPSetupIntentParameters","abstract":"

    Parameters for creating an SCPSetupIntent.

    "},"Enums/SCPSetupIntentStatus.html":{"name":"SCPSetupIntentStatus","abstract":"

    The possible statuses of the SetupIntent.

    "},"Enums/SCPSetupIntentUsage.html":{"name":"SCPSetupIntentUsage","abstract":"

    The SetupIntent usage options tell Stripe how the payment method is intended to be used in the future."},"Classes/SCPSetupAttempt.html":{"name":"SCPSetupAttempt","abstract":"

    A SetupAttempt describes one attempted confirmation of a SetupIntent,"},"Classes/SCPSetupAttemptPaymentMethodDetails.html":{"name":"SCPSetupAttemptPaymentMethodDetails","abstract":"

    Details about a PaymentMethod at a specific time. ex: at time of transaction"},"Classes/SCPSetupAttemptCardPresentDetails.html":{"name":"SCPSetupAttemptCardPresentDetails","abstract":"

    An object representing details from a transaction using a card_present"},"Classes/SCPConfirmSetupIntentError.html":{"name":"SCPConfirmSetupIntentError","abstract":"

    An error from -[SCPTerminal confirmSetupIntent:completion:]

    "},"Enums/SCPRefundStatus.html#/c:@E@SCPRefundStatus@SCPRefundStatusSucceeded":{"name":"SCPRefundStatusSucceeded","abstract":"

    The refund succeeded.

    ","parent_name":"SCPRefundStatus"},"Enums/SCPRefundStatus.html#/c:@E@SCPRefundStatus@SCPRefundStatusPending":{"name":"SCPRefundStatusPending","abstract":"

    The refund is pending.

    ","parent_name":"SCPRefundStatus"},"Enums/SCPRefundStatus.html#/c:@E@SCPRefundStatus@SCPRefundStatusFailed":{"name":"SCPRefundStatusFailed","abstract":"

    The refund failed.

    ","parent_name":"SCPRefundStatus"},"Enums/SCPRefundStatus.html#/c:@E@SCPRefundStatus@SCPRefundStatusUnknown":{"name":"SCPRefundStatusUnknown","abstract":"

    Unknown refund state.

    ","parent_name":"SCPRefundStatus"},"Classes/SCPProcessRefundError.html#/c:objc(cs)SCPProcessRefundError(py)refund":{"name":"refund","abstract":"

    If processRefund failed after the refund was created, this property contains","parent_name":"SCPProcessRefundError"},"Classes/SCPProcessRefundError.html#/c:objc(cs)SCPProcessRefundError(py)requestError":{"name":"requestError","abstract":"

    If processRefund failed because the underlying network request errored,","parent_name":"SCPProcessRefundError"},"Classes/SCPProcessRefundError.html#/c:objc(cs)SCPProcessRefundError(cm)init":{"name":"+init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPProcessRefundError"},"Classes/SCPProcessRefundError.html#/c:objc(cs)SCPProcessRefundError(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPProcessRefundError"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)chargeId":{"name":"chargeId","abstract":"

    The ID of the charge to be refunded.

    ","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)amount":{"name":"amount","abstract":"

    The amount of the refund, provided in the currency’s smallest unit.

    ","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)currency":{"name":"currency","abstract":"

    Three-letter ISO currency code. Must be a supported currency.

    ","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)metadata":{"name":"metadata","abstract":"

    Set of key-value pairs that you can attach to an object. This can be useful for","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)reverseTransfer":{"name":"reverseTransfer","abstract":"

    Connect only: Nullable boolean indicating whether the transfer should be","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)refundApplicationFee":{"name":"refundApplicationFee","abstract":"

    Connect only: Nullable boolean indicating whether the application fee should be","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(im)initWithChargeId:amount:currency:":{"name":"-initWithChargeId:amount:currency:","abstract":"

    Initializes SCPRefundParameters with the given charge, amount, and currency.

    ","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(im)init":{"name":"-init","abstract":"

    Use initWithChargeId:amount:currency:

    ","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(cm)new":{"name":"+new","abstract":"

    Use initWithChargeId:amount:currency:

    ","parent_name":"SCPRefundParameters"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)stripeId":{"name":"stripeId","abstract":"

    The unique identifier for the refund.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)amount":{"name":"amount","abstract":"

    The amount that was refunded.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)charge":{"name":"charge","abstract":"

    The ID of the charge that was refunded

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)created":{"name":"created","abstract":"

    When the refund object was created.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)currency":{"name":"currency","abstract":"

    The currency of the amount refunded.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)metadata":{"name":"metadata","abstract":"

    Metadata associated with the refund.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)reason":{"name":"reason","abstract":"

    Reason for the refund, either user-provided (duplicate, fraudulent, or","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)status":{"name":"status","abstract":"

    The status of the refund.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)paymentMethodDetails":{"name":"paymentMethodDetails","abstract":"

    The payment method details associated with the refund.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)failureReason":{"name":"failureReason","abstract":"

    If the refund failed, the reason for refund failure if known.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html":{"name":"SCPRefund","abstract":"

    An object representing a Stripe refund.

    "},"Classes/SCPRefundParameters.html":{"name":"SCPRefundParameters","abstract":"

    Parameters for creating an SCPRefund.

    "},"Classes/SCPProcessRefundError.html":{"name":"SCPProcessRefundError","abstract":"

    An error from -[SCPTerminal processRefund:completion:].

    "},"Enums/SCPRefundStatus.html":{"name":"SCPRefundStatus","abstract":"

    The possible statuses for a refund.

    "},"Enums/SCPIncrementalAuthorizationStatus.html#/c:@E@SCPIncrementalAuthorizationStatus@SCPIncrementalAuthorizationStatusUnknown":{"name":"SCPIncrementalAuthorizationStatusUnknown","abstract":"

    It is undetermined whether or not this PaymentIntent will be eligible for incremental authorizations.","parent_name":"SCPIncrementalAuthorizationStatus"},"Enums/SCPIncrementalAuthorizationStatus.html#/c:@E@SCPIncrementalAuthorizationStatus@SCPIncrementalAuthorizationStatusNotSupported":{"name":"SCPIncrementalAuthorizationStatusNotSupported","abstract":"

    This PaymentIntent is not eligible for incremental authorizations, or it was not requested.

    ","parent_name":"SCPIncrementalAuthorizationStatus"},"Enums/SCPIncrementalAuthorizationStatus.html#/c:@E@SCPIncrementalAuthorizationStatus@SCPIncrementalAuthorizationStatusSupported":{"name":"SCPIncrementalAuthorizationStatusSupported","abstract":"

    This PaymentIntent is eligible for incremental authorizations.

    ","parent_name":"SCPIncrementalAuthorizationStatus"},"Classes/SCPNetworks.html#/c:objc(cs)SCPNetworks(py)available":{"name":"available","abstract":"

    All available networks for the card.

    ","parent_name":"SCPNetworks"},"Classes/SCPNetworks.html#/c:objc(cs)SCPNetworks(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPNetworks"},"Classes/SCPNetworks.html#/c:objc(cs)SCPNetworks(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPNetworks"},"Classes/SCPTippingConfiguration.html#/c:objc(cs)SCPTippingConfiguration(py)eligibleAmount":{"name":"eligibleAmount","abstract":"

    The amount of the payment total eligible for tips.

    ","parent_name":"SCPTippingConfiguration"},"Classes/SCPTippingConfiguration.html#/c:objc(cs)SCPTippingConfiguration(im)initWithEligibleAmount:":{"name":"-initWithEligibleAmount:","abstract":"

    Initialize a TippingConfiguration instance.

    ","parent_name":"SCPTippingConfiguration"},"Classes/SCPTippingConfiguration.html#/c:objc(cs)SCPTippingConfiguration(im)init":{"name":"-init","abstract":"

    Use initWithEligibleAmount:

    ","parent_name":"SCPTippingConfiguration"},"Classes/SCPTippingConfiguration.html#/c:objc(cs)SCPTippingConfiguration(cm)new":{"name":"+new","abstract":"

    Use initWithEligibleAmount:

    ","parent_name":"SCPTippingConfiguration"},"Enums/SCPCaptureMethod.html#/c:@E@SCPCaptureMethod@SCPCaptureMethodManual":{"name":"SCPCaptureMethodManual","abstract":"

    Place a hold on the funds when the customer authorizes the payment, but don’t","parent_name":"SCPCaptureMethod"},"Enums/SCPCaptureMethod.html#/c:@E@SCPCaptureMethod@SCPCaptureMethodAutomatic":{"name":"SCPCaptureMethodAutomatic","abstract":"

    Stripe automatically captures funds when the customer authorizes the payment.

    ","parent_name":"SCPCaptureMethod"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(py)skipTipping":{"name":"skipTipping","abstract":"

    Bypass tipping selection if it would have otherwise been shown.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(py)tippingConfiguration":{"name":"tippingConfiguration","abstract":"

    The tipping configuration for this payment collection.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(py)updatePaymentIntent":{"name":"updatePaymentIntent","abstract":"

    Whether or not to update the PaymentIntent server side during collectPaymentMethod.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithSkipTipping:":{"name":"-initWithSkipTipping:","abstract":"

    Initialize a CollectConfiguration

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithUpdatePaymentIntent:":{"name":"-initWithUpdatePaymentIntent:","abstract":"

    Initialize a CollectConfiguration

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithTippingConfiguration:":{"name":"-initWithTippingConfiguration:","abstract":"

    Initialize a CollectConfiguration.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithSkipTipping:updatePaymentIntent:":{"name":"-initWithSkipTipping:updatePaymentIntent:","abstract":"

    Initialize a CollectConfiguration

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithSkipTipping:tippingConfiguration:":{"name":"-initWithSkipTipping:tippingConfiguration:","abstract":"

    Initialize a CollectConfiguration.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithUpdatePaymentIntent:tippingConfiguration:":{"name":"-initWithUpdatePaymentIntent:tippingConfiguration:","abstract":"

    Initialize a CollectConfiguration.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithSkipTipping:updatePaymentIntent:tippingConfiguration:":{"name":"-initWithSkipTipping:updatePaymentIntent:tippingConfiguration:","abstract":"

    Initialize a CollectConfiguration.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)init":{"name":"-init","abstract":"

    Use initWithSkipTipping:updatePaymentIntent:tippingConfiguration: or helper initializers.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(cm)new":{"name":"+new","abstract":"

    Use initWithSkipTipping:updatePaymentIntent:tippingConfiguration: or helper initializers.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPPaymentMethodOptionsParameters.html#/c:objc(cs)SCPPaymentMethodOptionsParameters(py)cardPresentParameters":{"name":"cardPresentParameters","abstract":"

    Card-present-specific configuration for this PaymentMethod.

    ","parent_name":"SCPPaymentMethodOptionsParameters"},"Classes/SCPPaymentMethodOptionsParameters.html#/c:objc(cs)SCPPaymentMethodOptionsParameters(im)initWithCardPresentParameters:":{"name":"-initWithCardPresentParameters:","abstract":"

    Initialize a PaymentMethodOptionsParameters

    ","parent_name":"SCPPaymentMethodOptionsParameters"},"Classes/SCPPaymentMethodOptionsParameters.html#/c:objc(cs)SCPPaymentMethodOptionsParameters(im)init":{"name":"-init","abstract":"

    Use initWithCardPresentParameters:(SCPCardPresentParameters)cardPresentParameters

    ","parent_name":"SCPPaymentMethodOptionsParameters"},"Enums/SCPPaymentMethodType.html#/c:@E@SCPPaymentMethodType@SCPPaymentMethodTypeCard":{"name":"SCPPaymentMethodTypeCard","abstract":"

    A card payment method.

    ","parent_name":"SCPPaymentMethodType"},"Enums/SCPPaymentMethodType.html#/c:@E@SCPPaymentMethodType@SCPPaymentMethodTypeCardPresent":{"name":"SCPPaymentMethodTypeCardPresent","abstract":"

    A card present payment method.

    ","parent_name":"SCPPaymentMethodType"},"Enums/SCPPaymentMethodType.html#/c:@E@SCPPaymentMethodType@SCPPaymentMethodTypeInteracPresent":{"name":"SCPPaymentMethodTypeInteracPresent","abstract":"

    An Interac Present payment method.

    ","parent_name":"SCPPaymentMethodType"},"Enums/SCPPaymentMethodType.html#/c:@E@SCPPaymentMethodType@SCPPaymentMethodTypeUnknown":{"name":"SCPPaymentMethodTypeUnknown","abstract":"

    An unknown type.

    ","parent_name":"SCPPaymentMethodType"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)stripeId":{"name":"stripeId","abstract":"

    The unique identifier for the PaymentMethod

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)created":{"name":"created","abstract":"

    Time at which the object was created. Measured in seconds since the Unix epoch.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)type":{"name":"type","abstract":"

    The type of the PaymentMethod. The corresponding, similarly named property contains additional information specific to the PaymentMethod type.","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)card":{"name":"card","abstract":"

    If this is a card PaymentMethod (ie self.type == SCPPaymentMethodTypeCard), this contains additional details.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)cardPresent":{"name":"cardPresent","abstract":"

    If this is a card_present PaymentMethod (ie self.type == SCPPaymentMethodTypeCardPresent), this contains additional details.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)interacPresent":{"name":"interacPresent","abstract":"

    If this is an Interac_present PaymentMethod (ie self.type == SCPPaymentMethodTypeInteracPresent), this contains additional details.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)customer":{"name":"customer","abstract":"

    The Customer that this PaymentMethod is attached to, or nil.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)metadata":{"name":"metadata","abstract":"

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)brand":{"name":"brand","abstract":"

    The issuer of the card.

    ","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)country":{"name":"country","abstract":"

    Two-letter ISO code representing the country of the card.

    ","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)expMonth":{"name":"expMonth","abstract":"

    Two-digit number representing the card’s expiration month.","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)expYear":{"name":"expYear","abstract":"

    Four-digit number representing the card’s expiration year.","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)funding":{"name":"funding","abstract":"

    Card funding type. Ex: credit, debit, etc.

    ","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)last4":{"name":"last4","abstract":"

    The last four digits of the card.

    ","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)fingerprint":{"name":"fingerprint","abstract":"

    Uniquely identifies this particular card number. You can use this attribute","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPCardDetails"},"Classes/SCPPaymentMethodDetails.html#/c:objc(cs)SCPPaymentMethodDetails(py)type":{"name":"type","abstract":"

    The type of the PaymentMethod. The corresponding, similarly named property","parent_name":"SCPPaymentMethodDetails"},"Classes/SCPPaymentMethodDetails.html#/c:objc(cs)SCPPaymentMethodDetails(py)cardPresent":{"name":"cardPresent","abstract":"

    If this is a card present payment method (ie self.type == SCPPaymentMethodTypeCardPresent),","parent_name":"SCPPaymentMethodDetails"},"Classes/SCPPaymentMethodDetails.html#/c:objc(cs)SCPPaymentMethodDetails(py)interacPresent":{"name":"interacPresent","abstract":"

    If this is an Interac present payment method (ie self.type == SCPPaymentMethodTypeInteracPresent),","parent_name":"SCPPaymentMethodDetails"},"Classes/SCPPaymentMethodDetails.html#/c:objc(cs)SCPPaymentMethodDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPPaymentMethodDetails"},"Enums/SCPChargeStatus.html#/c:@E@SCPChargeStatus@SCPChargeStatusSucceeded":{"name":"SCPChargeStatusSucceeded","abstract":"

    The charge succeeded.

    ","parent_name":"SCPChargeStatus"},"Enums/SCPChargeStatus.html#/c:@E@SCPChargeStatus@SCPChargeStatusPending":{"name":"SCPChargeStatusPending","abstract":"

    The charge succeeded.

    ","parent_name":"SCPChargeStatus"},"Enums/SCPChargeStatus.html#/c:@E@SCPChargeStatus@SCPChargeStatusFailed":{"name":"SCPChargeStatusFailed","abstract":"

    The charge failed.

    ","parent_name":"SCPChargeStatus"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)amount":{"name":"amount","abstract":"

    The amount of the charge.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)currency":{"name":"currency","abstract":"

    The currency of the charge.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)status":{"name":"status","abstract":"

    The status of the charge.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)paymentMethodDetails":{"name":"paymentMethodDetails","abstract":"

    The payment method details associated with the charge.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)stripeDescription":{"name":"stripeDescription","abstract":"

    A string describing the charge, displayed in the Stripe dashboard and in","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)metadata":{"name":"metadata","abstract":"

    Metadata associated with the charge.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)stripeId":{"name":"stripeId","abstract":"

    The unique identifier for the charge.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)statementDescriptorSuffix":{"name":"statementDescriptorSuffix","abstract":"

    Extra dynamic information about a Charge. This will appear concatenated with the statementDescriptor on","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)calculatedStatementDescriptor":{"name":"calculatedStatementDescriptor","abstract":"

    The full statement descriptor that is displayed on your customer’s credit card’s statement, after the","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPCharge"},"Enums/SCPCardFundingType.html#/c:@E@SCPCardFundingType@SCPCardFundingTypeDebit":{"name":"SCPCardFundingTypeDebit","abstract":"

    Debit

    ","parent_name":"SCPCardFundingType"},"Enums/SCPCardFundingType.html#/c:@E@SCPCardFundingType@SCPCardFundingTypeCredit":{"name":"SCPCardFundingTypeCredit","abstract":"

    Credit

    ","parent_name":"SCPCardFundingType"},"Enums/SCPCardFundingType.html#/c:@E@SCPCardFundingType@SCPCardFundingTypePrepaid":{"name":"SCPCardFundingTypePrepaid","abstract":"

    Prepaid

    ","parent_name":"SCPCardFundingType"},"Enums/SCPCardFundingType.html#/c:@E@SCPCardFundingType@SCPCardFundingTypeOther":{"name":"SCPCardFundingTypeOther","abstract":"

    An other or unknown type of funding source

    ","parent_name":"SCPCardFundingType"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandVisa":{"name":"SCPCardBrandVisa","abstract":"

    Visa card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandAmex":{"name":"SCPCardBrandAmex","abstract":"

    American Express card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandMasterCard":{"name":"SCPCardBrandMasterCard","abstract":"

    MasterCard card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandDiscover":{"name":"SCPCardBrandDiscover","abstract":"

    Discover card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandJCB":{"name":"SCPCardBrandJCB","abstract":"

    JCB card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandDinersClub":{"name":"SCPCardBrandDinersClub","abstract":"

    Diners Club card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandInterac":{"name":"SCPCardBrandInterac","abstract":"

    Interac card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandUnionPay":{"name":"SCPCardBrandUnionPay","abstract":"

    Union Pay card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandEftposAu":{"name":"SCPCardBrandEftposAu","abstract":"

    Eftpos Australia card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandUnknown":{"name":"SCPCardBrandUnknown","abstract":"

    An unknown card brand

    ","parent_name":"SCPCardBrand"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(py)paymentIntent":{"name":"paymentIntent","abstract":"

    The updated PaymentIntent after processPayment failed.

    ","parent_name":"SCPProcessPaymentError"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(py)requestError":{"name":"requestError","abstract":"

    If processPayment failed because the underlying network request errored,","parent_name":"SCPProcessPaymentError"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(py)declineCode":{"name":"declineCode","abstract":"

    If processPayment failed because the payment method was declined, this","parent_name":"SCPProcessPaymentError"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPProcessPaymentError"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPProcessPaymentError"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)accountType":{"name":"accountType","abstract":"

    The type of account being debited or credited

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)applicationPreferredName":{"name":"applicationPreferredName","abstract":"

    Also known as “Application Name”. Required on EMV receipts.

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)dedicatedFileName":{"name":"dedicatedFileName","abstract":"

    Also known as “AID”. Required on EMV receipts.

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)authorizationResponseCode":{"name":"authorizationResponseCode","abstract":"

    Authorization Response Code

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)applicationCryptogram":{"name":"applicationCryptogram","abstract":"

    Application Cryptogram

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)terminalVerificationResults":{"name":"terminalVerificationResults","abstract":"

    TVR

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)transactionStatusInformation":{"name":"transactionStatusInformation","abstract":"

    TSI

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)last4":{"name":"last4","abstract":"

    The last 4 digits of the card.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)expMonth":{"name":"expMonth","abstract":"

    The card’s expiration month. 1-indexed (i.e. 1 == January)

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)expYear":{"name":"expYear","abstract":"

    The card’s expiration year.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)cardholderName":{"name":"cardholderName","abstract":"

    The cardholder name as read from the card, in ISO 7813 format. May include","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)funding":{"name":"funding","abstract":"

    The card’s funding type.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)brand":{"name":"brand","abstract":"

    The issuing brand of the card.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)fingerprint":{"name":"fingerprint","abstract":"

    A string uniquely identifying this card number.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)generatedCard":{"name":"generatedCard","abstract":"

    ID of a card PaymentMethod that may be attached to a Customer for future","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)receipt":{"name":"receipt","abstract":"

    Receipt information for the card present transaction. Only present for EMV","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)emvAuthData":{"name":"emvAuthData","abstract":"

    (Only applicable to EMV payments) The authorization data from the card","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)country":{"name":"country","abstract":"

    Two-letter ISO code representing the country of the card. You could use this","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)preferredLocales":{"name":"preferredLocales","abstract":"

    EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)networks":{"name":"networks","abstract":"

    Contains information about card networks that can be used to process the payment.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)incrementalAuthorizationStatus":{"name":"incrementalAuthorizationStatus","abstract":"

    Whether this payment method is eligible for incremental authorizations.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPCardPresentDetails"},"Enums/SCPCardPresentRouting.html#/c:@E@SCPCardPresentRouting@SCPCardPresentRoutingDomestic":{"name":"SCPCardPresentRoutingDomestic","abstract":"

    Prioritize domestic debit network routing on payment method collection.

    ","parent_name":"SCPCardPresentRouting"},"Enums/SCPCardPresentRouting.html#/c:@E@SCPCardPresentRouting@SCPCardPresentRoutingInternational":{"name":"SCPCardPresentRoutingInternational","abstract":"

    Prioritize international network routing on payment method collection.

    ","parent_name":"SCPCardPresentRouting"},"Enums/SCPCardPresentCaptureMethod.html#/c:@E@SCPCardPresentCaptureMethod@SCPCardPresentCaptureMethodManualPreferred":{"name":"SCPCardPresentCaptureMethodManualPreferred","abstract":"

    Use manual_preferred if you prefer manual capture_method for the SCPPaymentIntent’s capture_method but support","parent_name":"SCPCardPresentCaptureMethod"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(py)requestExtendedAuthorization":{"name":"requestExtendedAuthorization","abstract":"

    Using the extended authorizations feature, users in eligible categories can capture up to 31 days later, depending on the card brand.

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(py)requestIncrementalAuthorizationSupport":{"name":"requestIncrementalAuthorizationSupport","abstract":"

    Allows you to increase the authorized amount on a confirmed PaymentIntent before you capture it. This means you can update the amount on a payment if the estimated price changes or goods and services are added. Before capture, each incremental authorization appears on your customer’s credit card statement as an additional pending charge.

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(py)captureMethod":{"name":"captureMethod","abstract":"

    SCPCardPresentCaptureMethod as a nullable NSNumber.

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(py)requestedPriority":{"name":"requestedPriority","abstract":"

    The requested routing priority as a nullable NSNumber.

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:":{"name":"-initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:":{"name":"-initWithRequestExtendedAuthorization:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestIncrementalAuthorizationSupport:":{"name":"-initWithRequestIncrementalAuthorizationSupport:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:captureMethod:":{"name":"-initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:captureMethod:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:captureMethod:":{"name":"-initWithRequestExtendedAuthorization:captureMethod:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestIncrementalAuthorizationSupport:captureMethod:":{"name":"-initWithRequestIncrementalAuthorizationSupport:captureMethod:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithCaptureMethod:":{"name":"-initWithCaptureMethod:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:captureMethod:requestedPriority:":{"name":"-initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:captureMethod:requestedPriority:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:requestedPriority:":{"name":"-initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:requestedPriority:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithCaptureMethod:requestedPriority:":{"name":"-initWithCaptureMethod:requestedPriority:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestedPriority:":{"name":"-initWithRequestedPriority:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)init":{"name":"-init","abstract":"

    Use alternative initializer.

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPTip.html#/c:objc(cs)SCPTip(py)amount":{"name":"amount","abstract":"

    Portion of the amount that corresponds to a tip

    ","parent_name":"SCPTip"},"Classes/SCPTip.html#/c:objc(cs)SCPTip(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate SCPTip.

    ","parent_name":"SCPTip"},"Classes/SCPTip.html#/c:objc(cs)SCPTip(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate SCPTip.

    ","parent_name":"SCPTip"},"Classes/SCPAmountDetails.html#/c:objc(cs)SCPAmountDetails(py)tip":{"name":"tip","abstract":"

    Details about the tip

    ","parent_name":"SCPAmountDetails"},"Classes/SCPAmountDetails.html#/c:objc(cs)SCPAmountDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate SCPAmountDetails.

    ","parent_name":"SCPAmountDetails"},"Classes/SCPAmountDetails.html#/c:objc(cs)SCPAmountDetails(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate SCPAmountDetails.

    ","parent_name":"SCPAmountDetails"},"Enums/SCPPaymentStatus.html#/c:@E@SCPPaymentStatus@SCPPaymentStatusNotReady":{"name":"SCPPaymentStatusNotReady","abstract":"

    The SDK is not ready to start a payment. It may be busy with another","parent_name":"SCPPaymentStatus"},"Enums/SCPPaymentStatus.html#/c:@E@SCPPaymentStatus@SCPPaymentStatusReady":{"name":"SCPPaymentStatusReady","abstract":"

    The SDK is ready to start a payment.

    ","parent_name":"SCPPaymentStatus"},"Enums/SCPPaymentStatus.html#/c:@E@SCPPaymentStatus@SCPPaymentStatusWaitingForInput":{"name":"SCPPaymentStatusWaitingForInput","abstract":"

    The SDK is waiting for input from the customer (e.g., for a card to","parent_name":"SCPPaymentStatus"},"Enums/SCPPaymentStatus.html#/c:@E@SCPPaymentStatus@SCPPaymentStatusProcessing":{"name":"SCPPaymentStatusProcessing","abstract":"

    The SDK is processing a payment.

    ","parent_name":"SCPPaymentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusRequiresPaymentMethod":{"name":"SCPPaymentIntentStatusRequiresPaymentMethod","abstract":"

    Next step: collect a payment method by calling collectPaymentMethod.

    ","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusRequiresConfirmation":{"name":"SCPPaymentIntentStatusRequiresConfirmation","abstract":"

    Next step: process the payment by calling processPayment.

    ","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusRequiresCapture":{"name":"SCPPaymentIntentStatusRequiresCapture","abstract":"

    Next step: capture the PaymentIntent on your backend via the Stripe API.

    ","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusProcessing":{"name":"SCPPaymentIntentStatusProcessing","abstract":"

    The PaymentIntent is in the middle of full EMV processing.

    ","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusCanceled":{"name":"SCPPaymentIntentStatusCanceled","abstract":"

    The PaymentIntent was canceled.

    ","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusSucceeded":{"name":"SCPPaymentIntentStatusSucceeded","abstract":"

    The PaymentIntent succeeded.

    ","parent_name":"SCPPaymentIntentStatus"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)amount":{"name":"amount","abstract":"

    The amount of the payment, provided in the currency’s smallest unit.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)currency":{"name":"currency","abstract":"

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)paymentMethodTypes":{"name":"paymentMethodTypes","abstract":"

    The list of payment method types that this PaymentIntent is allowed to use.","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)captureMethod":{"name":"captureMethod","abstract":"

    The capture method that this PaymentIntent should use. Defaults to SCPCaptureMethodManual.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)metadata":{"name":"metadata","abstract":"

    Set of key-value pairs that you can attach to an object. This can be useful for","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)stripeDescription":{"name":"stripeDescription","abstract":"

    An arbitrary string attached to the object. If you send a receipt email for","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)statementDescriptor":{"name":"statementDescriptor","abstract":"

    A string to be displayed on your customer’s credit card statement. This may be","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)statementDescriptorSuffix":{"name":"statementDescriptorSuffix","abstract":"

    A string to specify details about the transaction so your customer can understand it clearly on their statement.","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)receiptEmail":{"name":"receiptEmail","abstract":"

    Email address that the receipt for the resulting payment will be sent to.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)customer":{"name":"customer","abstract":"

    The ID of the Customer this PaymentIntent is for, if one exists.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)applicationFeeAmount":{"name":"applicationFeeAmount","abstract":"

    The amount of the application fee (if any) that will be applied to the","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)transferGroup":{"name":"transferGroup","abstract":"

    A string that identifies the resulting payment as part of a group.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)transferDataDestination":{"name":"transferDataDestination","abstract":"

    The account (if any) the payment will be attributed to for tax reporting, and","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)onBehalfOf":{"name":"onBehalfOf","abstract":"

    The Stripe account ID for which these funds are intended.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)setupFutureUsage":{"name":"setupFutureUsage","abstract":"

    Indicates that you intend to make future payments with this PaymentIntent’s payment method.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)paymentMethodOptionsParameters":{"name":"paymentMethodOptionsParameters","abstract":"

    Specific options used during the creation of the PaymentMethod.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)initWithAmount:currency:":{"name":"-initWithAmount:currency:","abstract":"

    Initializes SCPPaymentIntentParameters with the given parameters.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)initWithAmount:currency:paymentMethodTypes:":{"name":"-initWithAmount:currency:paymentMethodTypes:","abstract":"

    Initializes SCPPaymentIntentParameters with the given parameters.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)initWithAmount:currency:captureMethod:":{"name":"-initWithAmount:currency:captureMethod:","abstract":"

    Initializes SCPPaymentIntentParameters with the given parameters.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)initWithAmount:currency:paymentMethodTypes:captureMethod:":{"name":"-initWithAmount:currency:paymentMethodTypes:captureMethod:","abstract":"

    Initializes SCPPaymentIntentParameters with the given parameters.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)init":{"name":"-init","abstract":"

    Use initWithAmount:currency:

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(cm)new":{"name":"+new","abstract":"

    Use initWithAmount:currency:

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)description":{"name":"description","abstract":"

    Use stripeDescription for the string attached to the object.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)stripeId":{"name":"stripeId","abstract":"

    The unique identifier for the intent.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)created":{"name":"created","abstract":"

    When the intent was created.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)status":{"name":"status","abstract":"

    The status of the PaymentIntent.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)amount":{"name":"amount","abstract":"

    The amount to be collected by this PaymentIntent, provided in the currency’s","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)currency":{"name":"currency","abstract":"

    The currency of the payment.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)metadata":{"name":"metadata","abstract":"

    Set of key-value pairs attached to the object.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)charges":{"name":"charges","abstract":"

    Charges that were created by this PaymentIntent, if any.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)paymentMethod":{"name":"paymentMethod","abstract":"

    The payment method to be used in this PaymentIntent. Only valid in the","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)amountDetails":{"name":"amountDetails","abstract":"

    Details about items included in the amount after confirmation.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)amountTip":{"name":"amountTip","abstract":"

    Indicates how much the user intends to tip in addition to the amount by at confirmation time.","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)statementDescriptor":{"name":"statementDescriptor","abstract":"

    Extra information about a PaymentIntent. This will appear on your customer’s statement when","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)statementDescriptorSuffix":{"name":"statementDescriptorSuffix","abstract":"

    Extra dynamic information about a PaymentIntent. This will appear concatenated with the statementDescriptor on","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate SCPPaymentIntent. You should only use","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate SCPPaymentIntent. You should only use","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html":{"name":"SCPPaymentIntent","abstract":"

    A PaymentIntent tracks the process of collecting a payment from your customer."},"Classes/SCPPaymentIntentParameters.html":{"name":"SCPPaymentIntentParameters","abstract":"

    Parameters for creating an SCPPaymentIntent. Pass an object of this type"},"Enums/SCPPaymentIntentStatus.html":{"name":"SCPPaymentIntentStatus","abstract":"

    The possible statuses for a PaymentIntent.

    "},"Enums/SCPPaymentStatus.html":{"name":"SCPPaymentStatus","abstract":"

    The possible payment statuses for the SDK.

    "},"Classes/SCPAmountDetails.html":{"name":"SCPAmountDetails","abstract":"

    Contains details about items included in the [PaymentIntent] amount

    "},"Classes/SCPTip.html":{"name":"SCPTip","abstract":"

    Contains details about tips

    "},"Classes/SCPCardPresentParameters.html":{"name":"SCPCardPresentParameters","abstract":"

    Parameters that will be applied to the card present PaymentIntent.

    "},"Enums/SCPCardPresentCaptureMethod.html":{"name":"SCPCardPresentCaptureMethod","abstract":"

    Capture Method values that can be used as card-present payment method options.

    "},"Enums/SCPCardPresentRouting.html":{"name":"SCPCardPresentRouting","abstract":"

    Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.

    "},"Classes/SCPCardPresentDetails.html":{"name":"SCPCardPresentDetails","abstract":"

    An object representing details from a transaction using a card_present"},"Classes/SCPReceiptDetails.html":{"name":"SCPReceiptDetails","abstract":"

    Receipt details associated with a card present transaction.

    "},"Classes/SCPProcessPaymentError.html":{"name":"SCPProcessPaymentError","abstract":"

    An error from -[SCPTerminal processPayment:completion:].

    "},"Enums/SCPCardBrand.html":{"name":"SCPCardBrand","abstract":"

    The various card brands for a card.

    "},"Enums/SCPCardFundingType.html":{"name":"SCPCardFundingType","abstract":"

    The various funding sources for a card.

    "},"Classes/SCPCharge.html":{"name":"SCPCharge","abstract":"

    An object representing a Stripe charge.

    "},"Enums/SCPChargeStatus.html":{"name":"SCPChargeStatus","abstract":"

    The possible statuses for a charge

    "},"Classes/SCPPaymentMethodDetails.html":{"name":"SCPPaymentMethodDetails","abstract":"

    Details about a PaymentMethod at a specific time. ex: at time of transaction"},"Classes/SCPCardDetails.html":{"name":"SCPCardDetails","abstract":"

    Contains details about a user’s credit card.

    "},"Classes/SCPPaymentMethod.html":{"name":"SCPPaymentMethod","abstract":"

    PaymentMethod objects represent your customer’s payment instruments."},"Enums/SCPPaymentMethodType.html":{"name":"SCPPaymentMethodType","abstract":"

    The type of the PaymentMethod.

    "},"Classes/SCPPaymentMethodOptionsParameters.html":{"name":"SCPPaymentMethodOptionsParameters","abstract":"

    The PaymentMethodOptionsParameters contains options for PaymentMethod creation.

    "},"Classes/SCPCollectConfiguration.html":{"name":"SCPCollectConfiguration","abstract":"

    The CollectConfiguration contains configuration information relevant to collecting a payment"},"Enums/SCPCaptureMethod.html":{"name":"SCPCaptureMethod","abstract":"

    @abstract Controls when the funds will be captured from the customer’s account.

    "},"Classes/SCPTippingConfiguration.html":{"name":"SCPTippingConfiguration","abstract":"

    The TippingConfiguration contains configuration information relevant to collecting tips.

    "},"Classes/SCPNetworks.html":{"name":"SCPNetworks","abstract":"

    Contains information about card networks that can be used to process the payment.

    "},"Enums/SCPIncrementalAuthorizationStatus.html":{"name":"SCPIncrementalAuthorizationStatus","abstract":"

    Represents the ability for a PaymentIntent to be incrementally authorized.

    "},"Enums/SCPUpdateComponent.html#/c:@E@SCPUpdateComponent@SCPUpdateComponentIncremental":{"name":"SCPUpdateComponentIncremental","abstract":"

    If set, the update contains incremental changes to the reader. If this is","parent_name":"SCPUpdateComponent"},"Enums/SCPUpdateComponent.html#/c:@E@SCPUpdateComponent@SCPUpdateComponentFirmware":{"name":"SCPUpdateComponentFirmware","abstract":"

    If set, this update contains updated firmware for this reader. Firmware updates","parent_name":"SCPUpdateComponent"},"Enums/SCPUpdateComponent.html#/c:@E@SCPUpdateComponent@SCPUpdateComponentConfig":{"name":"SCPUpdateComponentConfig","abstract":"

    If set, this update contains a new configuration for this reader. These may","parent_name":"SCPUpdateComponent"},"Enums/SCPUpdateComponent.html#/c:@E@SCPUpdateComponent@SCPUpdateComponentKeys":{"name":"SCPUpdateComponentKeys","abstract":"

    If set, this update contains updated encryption keys for the reader.","parent_name":"SCPUpdateComponent"},"Enums/SCPUpdateTimeEstimate.html#/c:@E@SCPUpdateTimeEstimate@SCPUpdateTimeEstimateLessThan1Minute":{"name":"SCPUpdateTimeEstimateLessThan1Minute","abstract":"

    The update should take less than 1 minute to complete.

    ","parent_name":"SCPUpdateTimeEstimate"},"Enums/SCPUpdateTimeEstimate.html#/c:@E@SCPUpdateTimeEstimate@SCPUpdateTimeEstimate1To2Minutes":{"name":"SCPUpdateTimeEstimate1To2Minutes","abstract":"

    The update should take 1-2 minutes to complete.

    ","parent_name":"SCPUpdateTimeEstimate"},"Enums/SCPUpdateTimeEstimate.html#/c:@E@SCPUpdateTimeEstimate@SCPUpdateTimeEstimate2To5Minutes":{"name":"SCPUpdateTimeEstimate2To5Minutes","abstract":"

    The update should take 2-5 minutes to complete.

    ","parent_name":"SCPUpdateTimeEstimate"},"Enums/SCPUpdateTimeEstimate.html#/c:@E@SCPUpdateTimeEstimate@SCPUpdateTimeEstimate5To15Minutes":{"name":"SCPUpdateTimeEstimate5To15Minutes","abstract":"

    The update should take 5-15 minutes to complete.

    ","parent_name":"SCPUpdateTimeEstimate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(py)estimatedUpdateTime":{"name":"estimatedUpdateTime","abstract":"

    The estimated amount of time for the update.

    ","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(py)deviceSoftwareVersion":{"name":"deviceSoftwareVersion","abstract":"

    The target version for the update.

    ","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(py)components":{"name":"components","abstract":"

    The components that will be installed in this update.

    ","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(py)requiredAt":{"name":"requiredAt","abstract":"

    The date at which this update will be required to be installed. If this date","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(cm)stringFromUpdateTimeEstimate:":{"name":"+stringFromUpdateTimeEstimate:","abstract":"

    Returns an unlocalized string for the given update time estimate.

    ","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html":{"name":"SCPReaderSoftwareUpdate","abstract":"

    An object representing a reader update.

    "},"Enums/SCPUpdateTimeEstimate.html":{"name":"SCPUpdateTimeEstimate","abstract":"

    The estimated amount of time for an update. Note that these times are estimates;"},"Enums/SCPUpdateComponent.html":{"name":"SCPUpdateComponent","abstract":"

    A bitmask identifying what exact updates are contained within this update.

    "},"Classes/SCPCartLineItem.html#/c:objc(cs)SCPCartLineItem(py)quantity":{"name":"quantity","abstract":"

    The quantity of the line item being purchased.

    ","parent_name":"SCPCartLineItem"},"Classes/SCPCartLineItem.html#/c:objc(cs)SCPCartLineItem(py)displayName":{"name":"displayName","abstract":"

    The description or name of the item.

    ","parent_name":"SCPCartLineItem"},"Classes/SCPCartLineItem.html#/c:objc(cs)SCPCartLineItem(py)amount":{"name":"amount","abstract":"

    The price of the item, provided in the cart’s currency’s smallest unit.

    ","parent_name":"SCPCartLineItem"},"Classes/SCPCartLineItem.html#/c:objc(cs)SCPCartLineItem(im)initWithDisplayName:quantity:amount:":{"name":"-initWithDisplayName:quantity:amount:","abstract":"

    The values set here will be shown on the screen as-is. Make sure you’re","parent_name":"SCPCartLineItem"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(py)lineItems":{"name":"lineItems","abstract":"

    You can add or remove line items from this array individually or reassign the array entirely.","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(py)tax":{"name":"tax","abstract":"

    The displayed tax amount, provided in the currency’s smallest unit.

    ","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(py)total":{"name":"total","abstract":"

    The cart’s total balance, provided in the currency’s smallest unit.

    ","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(py)currency":{"name":"currency","abstract":"

    The currency of the cart.

    ","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(im)initWithCurrency:tax:total:":{"name":"-initWithCurrency:tax:total:","abstract":"

    Initializes an SCPCart with tax and total, in cents, as well as the currency.","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(im)init":{"name":"-init","abstract":"

    Use initWithTax:

    ","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(cm)new":{"name":"+new","abstract":"

    Use initWithTax:

    ","parent_name":"SCPCart"},"Enums/SCPBatteryStatus.html#/c:@E@SCPBatteryStatus@SCPBatteryStatusUnknown":{"name":"SCPBatteryStatusUnknown","abstract":"

    Battery state is not yet known or not available for the connected reader.

    ","parent_name":"SCPBatteryStatus"},"Enums/SCPBatteryStatus.html#/c:@E@SCPBatteryStatus@SCPBatteryStatusCritical":{"name":"SCPBatteryStatusCritical","abstract":"

    The device’s battery is less than or equal to 5%.

    ","parent_name":"SCPBatteryStatus"},"Enums/SCPBatteryStatus.html#/c:@E@SCPBatteryStatus@SCPBatteryStatusLow":{"name":"SCPBatteryStatusLow","abstract":"

    The device’s battery is between 5% and 20%.

    ","parent_name":"SCPBatteryStatus"},"Enums/SCPBatteryStatus.html#/c:@E@SCPBatteryStatus@SCPBatteryStatusNominal":{"name":"SCPBatteryStatusNominal","abstract":"

    The device’s battery is greater than 20%.

    ","parent_name":"SCPBatteryStatus"},"Enums/SCPReaderNetworkStatus.html#/c:@E@SCPReaderNetworkStatus@SCPReaderNetworkStatusOffline":{"name":"SCPReaderNetworkStatusOffline","abstract":"

    The reader is offline. Note that Chipper 2x and WisePad 3 will always report","parent_name":"SCPReaderNetworkStatus"},"Enums/SCPReaderNetworkStatus.html#/c:@E@SCPReaderNetworkStatus@SCPReaderNetworkStatusOnline":{"name":"SCPReaderNetworkStatusOnline","abstract":"

    The reader is online.

    ","parent_name":"SCPReaderNetworkStatus"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageRetryCard":{"name":"SCPReaderDisplayMessageRetryCard","abstract":"

    Retry the presented card.

    ","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageInsertCard":{"name":"SCPReaderDisplayMessageInsertCard","abstract":"

    Insert the presented card.

    ","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageInsertOrSwipeCard":{"name":"SCPReaderDisplayMessageInsertOrSwipeCard","abstract":"

    Insert or swipe the presented card.

    ","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageSwipeCard":{"name":"SCPReaderDisplayMessageSwipeCard","abstract":"

    Swipe the presented card.

    ","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageRemoveCard":{"name":"SCPReaderDisplayMessageRemoveCard","abstract":"

    Remove the presented card.

    ","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageMultipleContactlessCardsDetected":{"name":"SCPReaderDisplayMessageMultipleContactlessCardsDetected","abstract":"

    The reader detected multiple contactless cards. Make sure only one","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageTryAnotherReadMethod":{"name":"SCPReaderDisplayMessageTryAnotherReadMethod","abstract":"

    The card could not be read. Try another read method on the same card, or","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageTryAnotherCard":{"name":"SCPReaderDisplayMessageTryAnotherCard","abstract":"

    The card is invalid. Try another card.

    ","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderInputOptions.html#/c:@E@SCPReaderInputOptions@SCPReaderInputOptionNone":{"name":"SCPReaderInputOptionNone","abstract":"

    No input options are available on the reader.

    ","parent_name":"SCPReaderInputOptions"},"Enums/SCPReaderInputOptions.html#/c:@E@SCPReaderInputOptions@SCPReaderInputOptionSwipeCard":{"name":"SCPReaderInputOptionSwipeCard","abstract":"

    Swipe a magstripe card.

    ","parent_name":"SCPReaderInputOptions"},"Enums/SCPReaderInputOptions.html#/c:@E@SCPReaderInputOptions@SCPReaderInputOptionInsertCard":{"name":"SCPReaderInputOptionInsertCard","abstract":"

    Insert a chip card.

    ","parent_name":"SCPReaderInputOptions"},"Enums/SCPReaderInputOptions.html#/c:@E@SCPReaderInputOptions@SCPReaderInputOptionTapCard":{"name":"SCPReaderInputOptionTapCard","abstract":"

    Tap a contactless card.

    ","parent_name":"SCPReaderInputOptions"},"Enums/SCPReaderEvent.html#/c:@E@SCPReaderEvent@SCPReaderEventCardInserted":{"name":"SCPReaderEventCardInserted","abstract":"

    A card was inserted.

    ","parent_name":"SCPReaderEvent"},"Enums/SCPReaderEvent.html#/c:@E@SCPReaderEvent@SCPReaderEventCardRemoved":{"name":"SCPReaderEventCardRemoved","abstract":"

    A card was removed.

    ","parent_name":"SCPReaderEvent"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didStartInstallingUpdate:cancelable:":{"name":"-localMobileReader:didStartInstallingUpdate:cancelable:","abstract":"

    The reader has started installing a software update.

    ","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didReportReaderSoftwareUpdateProgress:":{"name":"-localMobileReader:didReportReaderSoftwareUpdateProgress:","abstract":"

    The reader reported progress on a software update.

    ","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didFinishInstallingUpdate:error:":{"name":"-localMobileReader:didFinishInstallingUpdate:error:","abstract":"

    The reader has finished installing an update.

    ","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didRequestReaderInput:":{"name":"-localMobileReader:didRequestReaderInput:","abstract":"

    This method is called when the reader begins waiting for input.","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didRequestReaderDisplayMessage:":{"name":"-localMobileReader:didRequestReaderDisplayMessage:","abstract":"

    This method is called to request that a prompt be displayed in your app.","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReaderDidAcceptTermsOfService:":{"name":"-localMobileReaderDidAcceptTermsOfService:","abstract":"

    The reader is reporting that, as part of preparing to accept payments,","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didReportAvailableUpdate:":{"name":"-reader:didReportAvailableUpdate:","abstract":"

    The SDK is reporting that an update is available for the reader.","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didStartInstallingUpdate:cancelable:":{"name":"-reader:didStartInstallingUpdate:cancelable:","abstract":"

    The SDK is reporting that the reader has started installing a software update.

    ","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didReportReaderSoftwareUpdateProgress:":{"name":"-reader:didReportReaderSoftwareUpdateProgress:","abstract":"

    The reader reported progress on a software update.

    ","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didFinishInstallingUpdate:error:":{"name":"-reader:didFinishInstallingUpdate:error:","abstract":"

    The reader is reporting that an installation has finished. If the install was","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didRequestReaderInput:":{"name":"-reader:didRequestReaderInput:","abstract":"

    This method is called when the reader begins waiting for input. Your app","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didRequestReaderDisplayMessage:":{"name":"-reader:didRequestReaderDisplayMessage:","abstract":"

    This method is called to request that a prompt be displayed in your app.","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didReportReaderEvent:info:":{"name":"-reader:didReportReaderEvent:info:","abstract":"

    The SDK reported an event from the reader (e.g. a card was inserted).

    ","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didReportBatteryLevel:status:isCharging:":{"name":"-reader:didReportBatteryLevel:status:isCharging:","abstract":"

    The SDK reported the reader’s battery level or charging state has changed.

    ","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)readerDidReportLowBatteryWarning:":{"name":"-readerDidReportLowBatteryWarning:","abstract":"

    This method is called when the SDK’s currently connected reader has a low battery.

    ","parent_name":"SCPBluetoothReaderDelegate"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeChipper2X":{"name":"SCPDeviceTypeChipper2X","abstract":"

    The BBPOS Chipper 2X BT mobile reader.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeVerifoneP400":{"name":"SCPDeviceTypeVerifoneP400","abstract":"

    The Verifone P400 countertop reader.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeWisePad3":{"name":"SCPDeviceTypeWisePad3","abstract":"

    The BBPOS WisePad 3 mobile reader.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeStripeM2":{"name":"SCPDeviceTypeStripeM2","abstract":"

    The Stripe Reader M2 mobile reader.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeWisePosE":{"name":"SCPDeviceTypeWisePosE","abstract":"

    The BBPOS WisePOS E countertop reader.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeWisePosEDevKit":{"name":"SCPDeviceTypeWisePosEDevKit","abstract":"

    The BBPOS WisePOS E DevKit countertop reader.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeStripeS700":{"name":"SCPDeviceTypeStripeS700","abstract":"

    Stripe Reader S700.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeStripeS700DevKit":{"name":"SCPDeviceTypeStripeS700DevKit","abstract":"

    Stripe Reader S700 DevKit.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeAppleBuiltIn":{"name":"SCPDeviceTypeAppleBuiltIn","abstract":"

    Apple Built-In reader.

    ","parent_name":"SCPDeviceType"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)deviceType":{"name":"deviceType","abstract":"

    The reader’s device type.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)simulated":{"name":"simulated","abstract":"

    True if this is a simulated reader.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)stripeId":{"name":"stripeId","abstract":"

    The Stripe unique identifier for the reader.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)locationId":{"name":"locationId","abstract":"

    The ID of the reader’s Location.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)locationStatus":{"name":"locationStatus","abstract":"

    Used to tell whether the location field has been set.","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)location":{"name":"location","abstract":"

    The details of the location this reader is registered to, if any.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)serialNumber":{"name":"serialNumber","abstract":"

    The reader’s serial number.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)deviceSoftwareVersion":{"name":"deviceSoftwareVersion","abstract":"

    The reader’s current device software version, or nil if this information is","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)availableUpdate":{"name":"availableUpdate","abstract":"

    The available update for this reader, or nil if no update is available.","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)batteryLevel":{"name":"batteryLevel","abstract":"

    The reader’s battery level, represented as a boxed float in the range [0, 1].","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)batteryStatus":{"name":"batteryStatus","abstract":"

    The reader’s battery status. Usable as a general classification for the current","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)isCharging":{"name":"isCharging","abstract":"

    The reader’s charging state, represented as a BOOL","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)ipAddress":{"name":"ipAddress","abstract":"

    The IP address of the reader.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)status":{"name":"status","abstract":"

    The networking status of the reader: either offline or online. Note that","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)label":{"name":"label","abstract":"

    A custom label that may be given to a reader for easier identification.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html":{"name":"SCPReader","abstract":"

    Information about a card reader that has been discovered by or connected to"},"Enums/SCPDeviceType.html":{"name":"SCPDeviceType","abstract":"

    The possible device types for a reader.

    "},"Protocols/SCPBluetoothReaderDelegate.html":{"name":"SCPBluetoothReaderDelegate","abstract":"

    Implement this protocol to handle a connected Bluetooth reader’s events throughout"},"Protocols/SCPLocalMobileReaderDelegate.html":{"name":"SCPLocalMobileReaderDelegate","abstract":"

    Implement this protocol to handle a connected local mobile reader’s events throughout"},"Enums/SCPReaderEvent.html":{"name":"SCPReaderEvent","abstract":"

    The possible events from a connected reader. Used by [SCPBluetoothReaderDelegate reader:didReportReaderEvent:info:].

    "},"Enums/SCPReaderInputOptions.html":{"name":"SCPReaderInputOptions","abstract":"

    This OptionSet represents all of the input methods available to your user when"},"Enums/SCPReaderDisplayMessage.html":{"name":"SCPReaderDisplayMessage","abstract":"

    The display messages that a reader may request be displayed by your app. Used by [SCPBluetoothReaderDelegate reader:didRequestReaderDisplayMessage:].

    "},"Enums/SCPReaderNetworkStatus.html":{"name":"SCPReaderNetworkStatus","abstract":"

    The possible networking statuses for a reader.

    "},"Enums/SCPBatteryStatus.html":{"name":"SCPBatteryStatus","abstract":"

    A categorization of a reader’s battery charge level.

    "},"Classes/SCPCart.html":{"name":"SCPCart","abstract":"

    An SCPCart object contains information about what line items are included in"},"Classes/SCPCartLineItem.html":{"name":"SCPCartLineItem","abstract":"

    Represents a single line item in an SCPCart, displayed on the reader’s screen"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeVisa":{"name":"SCPSimulatedCardTypeVisa","abstract":"

    Visa

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeVisaDebit":{"name":"SCPSimulatedCardTypeVisaDebit","abstract":"

    Visa (debit)

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeMastercard":{"name":"SCPSimulatedCardTypeMastercard","abstract":"

    Mastercard

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeMasterDebit":{"name":"SCPSimulatedCardTypeMasterDebit","abstract":"

    Mastercard (debit)

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeMastercardPrepaid":{"name":"SCPSimulatedCardTypeMastercardPrepaid","abstract":"

    Mastercard (prepaid)

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeAmex":{"name":"SCPSimulatedCardTypeAmex","abstract":"

    American Express

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeAmex2":{"name":"SCPSimulatedCardTypeAmex2","abstract":"

    American Express

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeDiscover":{"name":"SCPSimulatedCardTypeDiscover","abstract":"

    Discover

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeDiscover2":{"name":"SCPSimulatedCardTypeDiscover2","abstract":"

    Discover

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeDiners":{"name":"SCPSimulatedCardTypeDiners","abstract":"

    Diners Club

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeDiners14Digit":{"name":"SCPSimulatedCardTypeDiners14Digit","abstract":"

    Diners Club (14 digit card)

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeJcb":{"name":"SCPSimulatedCardTypeJcb","abstract":"

    JCB

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeUnionPay":{"name":"SCPSimulatedCardTypeUnionPay","abstract":"

    UnionPay

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeInterac":{"name":"SCPSimulatedCardTypeInterac","abstract":"

    Interac

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeEftposAuDebit":{"name":"SCPSimulatedCardTypeEftposAuDebit","abstract":"

    Eftpos Australia

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclined":{"name":"SCPSimulatedCardTypeChargeDeclined","abstract":"

    Charge is declined with a card_declined code.

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedInsufficientFunds":{"name":"SCPSimulatedCardTypeChargeDeclinedInsufficientFunds","abstract":"

    Charge is declined with a card_declined code. The decline_code","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedLostCard":{"name":"SCPSimulatedCardTypeChargeDeclinedLostCard","abstract":"

    Charge is declined with a card_declined code. The decline_code","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedStolenCard":{"name":"SCPSimulatedCardTypeChargeDeclinedStolenCard","abstract":"

    Charge is declined with a card_declined code. The decline_code","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedExpiredCard":{"name":"SCPSimulatedCardTypeChargeDeclinedExpiredCard","abstract":"

    Charge is declined with an expired_card code.

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedProcessingError":{"name":"SCPSimulatedCardTypeChargeDeclinedProcessingError","abstract":"

    Charge is declined with a processing_error code.

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeRefundFailed":{"name":"SCPSimulatedCardTypeRefundFailed","abstract":"

    Refund is declined with a refund_fail error.

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeOnlinePinCvm":{"name":"SCPSimulatedCardTypeOnlinePinCvm","abstract":"

    Payment attaches Online Pin to the transaction.","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeOnlinePinScaRetry":{"name":"SCPSimulatedCardTypeOnlinePinScaRetry","abstract":"

    This flow simulates an Online Pin scenario with SCA compliance.","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeOfflinePinCvm":{"name":"SCPSimulatedCardTypeOfflinePinCvm","abstract":"

    Payment attaches Offline Pin to the transaction.","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeOfflinePinScaRetry":{"name":"SCPSimulatedCardTypeOfflinePinScaRetry","abstract":"

    This flow simulates an Offline Pin scenario with SCA compliance.","parent_name":"SCPSimulatedCardType"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)initWithType:":{"name":"-initWithType:","abstract":"

    Create a Simulated Card object with a given simulated card type.

    ","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)initWithTestCardNumber:":{"name":"-initWithTestCardNumber:","abstract":"

    Create a Simulated Card object with a raw card number. This initializer is","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)init":{"name":"-init","abstract":"

    You cannot instantiate this class without specifying a type or testcard number.

    ","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)isOnlinePin":{"name":"-isOnlinePin","abstract":"

    Returns true if the card is online pin enabled.

    ","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)isOfflinePin":{"name":"-isOfflinePin","abstract":"

    Returns true if the card is offline pin enabled.

    ","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(cm)new":{"name":"+new","abstract":"

    You cannot instantiate this class without specifying a type or testcard number.

    ","parent_name":"SCPSimulatedCard"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateAvailable":{"name":"SCPSimulateReaderUpdateAvailable","abstract":"

    Default value.

    ","parent_name":"SCPSimulateReaderUpdate"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateNone":{"name":"SCPSimulateReaderUpdateNone","abstract":"

    No updates are available

    ","parent_name":"SCPSimulateReaderUpdate"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateRequired":{"name":"SCPSimulateReaderUpdateRequired","abstract":"

    A required full reader software update exists. Use this to simulate the","parent_name":"SCPSimulateReaderUpdate"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateLowBattery":{"name":"SCPSimulateReaderUpdateLowBattery","abstract":"

    A required update exists.

    ","parent_name":"SCPSimulateReaderUpdate"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateRandom":{"name":"SCPSimulateReaderUpdateRandom","abstract":"

    Randomly picks a type of update for the reader to help exercise the","parent_name":"SCPSimulateReaderUpdate"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(py)availableReaderUpdate":{"name":"availableReaderUpdate","abstract":"

    Set this to different values of the SCPSimulateReaderUpdate enum to","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(py)simulatedCard":{"name":"simulatedCard","abstract":"

    Create a SCPSimulatedCard and set it on the shared configuration object to","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)city":{"name":"city","abstract":"

    The city name

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)country":{"name":"country","abstract":"

    The country code

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)line1":{"name":"line1","abstract":"

    The first line of the address

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)line2":{"name":"line2","abstract":"

    The second line of the address

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)postalCode":{"name":"postalCode","abstract":"

    The postal code of the address

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)state":{"name":"state","abstract":"

    The state of the address

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPAddress"},"Enums/SCPLocationStatus.html#/c:@E@SCPLocationStatus@SCPLocationStatusUnknown":{"name":"SCPLocationStatusUnknown","abstract":"

    The location is not known. location will be nil.

    ","parent_name":"SCPLocationStatus"},"Enums/SCPLocationStatus.html#/c:@E@SCPLocationStatus@SCPLocationStatusSet":{"name":"SCPLocationStatusSet","abstract":"

    The location was successfully set to a known location.","parent_name":"SCPLocationStatus"},"Enums/SCPLocationStatus.html#/c:@E@SCPLocationStatus@SCPLocationStatusNotSet":{"name":"SCPLocationStatusNotSet","abstract":"

    This location is known to be not set. location will be nil.

    ","parent_name":"SCPLocationStatus"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)stripeId":{"name":"stripeId","abstract":"

    The ID of the Location

    ","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)address":{"name":"address","abstract":"

    The address of this Location

    ","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)displayName":{"name":"displayName","abstract":"

    The display name of this Location

    ","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)livemode":{"name":"livemode","abstract":"

    Whether this Location was created in livemode

    ","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)metadata":{"name":"metadata","abstract":"

    Any metadata attached to this Location

    ","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPLocation"},"Classes/SCPListLocationsParameters.html#/c:objc(cs)SCPListLocationsParameters(py)limit":{"name":"limit","abstract":"

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    ","parent_name":"SCPListLocationsParameters"},"Classes/SCPListLocationsParameters.html#/c:objc(cs)SCPListLocationsParameters(py)endingBefore":{"name":"endingBefore","abstract":"

    A cursor for use in pagination. ending_before is an object ID that defines","parent_name":"SCPListLocationsParameters"},"Classes/SCPListLocationsParameters.html#/c:objc(cs)SCPListLocationsParameters(py)startingAfter":{"name":"startingAfter","abstract":"

    A cursor for use in pagination. starting_after is an object ID that defines","parent_name":"SCPListLocationsParameters"},"Classes/SCPListLocationsParameters.html#/c:objc(cs)SCPListLocationsParameters(im)initWithLimit:endingBefore:startingAfter:":{"name":"-initWithLimit:endingBefore:startingAfter:","abstract":"

    Initializes SCPListLocationsParameters with the given parameters.

    ","parent_name":"SCPListLocationsParameters"},"Enums/SCPConnectionStatus.html#/c:@E@SCPConnectionStatus@SCPConnectionStatusNotConnected":{"name":"SCPConnectionStatusNotConnected","abstract":"

    The SDK is not connected to a reader.

    ","parent_name":"SCPConnectionStatus"},"Enums/SCPConnectionStatus.html#/c:@E@SCPConnectionStatus@SCPConnectionStatusConnected":{"name":"SCPConnectionStatusConnected","abstract":"

    The SDK is connected to a reader.

    ","parent_name":"SCPConnectionStatus"},"Enums/SCPConnectionStatus.html#/c:@E@SCPConnectionStatus@SCPConnectionStatusConnecting":{"name":"SCPConnectionStatusConnecting","abstract":"

    The SDK is currently connecting to a reader.

    ","parent_name":"SCPConnectionStatus"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(py)locationId":{"name":"locationId","abstract":"

    The ID of the Location which the reader should be","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(py)onBehalfOf":{"name":"onBehalfOf","abstract":"

    If your integration is creating destination charges and using on_behalf_of, you must provide the","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(py)merchantDisplayName":{"name":"merchantDisplayName","abstract":"

    Optional cardholder facing merchant display name that will be used in the prompt for the cardholder","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(py)tosAcceptancePermitted":{"name":"tosAcceptancePermitted","abstract":"

    In order to connect to a reader, merchant-specific terms of service may need to be accepted.","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(im)initWithLocationId:":{"name":"-initWithLocationId:","abstract":"

    Initialize ConnectionConfiguration with a location ID.

    ","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(im)initWithLocationId:merchantDisplayName:onBehalfOf:":{"name":"-initWithLocationId:merchantDisplayName:onBehalfOf:","abstract":"

    Initialize ConnectionConfiguration with a location ID, custom merchant display name, and ‘on behalf of’","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(im)initWithLocationId:merchantDisplayName:onBehalfOf:tosAcceptancePermitted:":{"name":"-initWithLocationId:merchantDisplayName:onBehalfOf:tosAcceptancePermitted:","abstract":"

    Initialize ConnectionConfiguration with a location ID, custom merchant display name, ‘on behalf of’","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(py)failIfInUse":{"name":"failIfInUse","abstract":"

    When set to true, the connection will automatically error if the reader is already","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(py)allowCustomerCancel":{"name":"allowCustomerCancel","abstract":"

    If set to true, the customer will be able to press the red X button on the","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(im)initWithFailIfInUse:allowCustomerCancel:":{"name":"-initWithFailIfInUse:allowCustomerCancel:","abstract":"

    Initialize an InternetConnectionConfiguration object with all possible properties.

    ","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(im)initWithFailIfInUse:":{"name":"-initWithFailIfInUse:","abstract":"

    Initalize an InternetConnectionConfiguration object and set the failIfInUse","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(im)initWithAllowCustomerCancel:":{"name":"-initWithAllowCustomerCancel:","abstract":"

    Initialize an InternetConnectionConfiguration object and set the","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(py)locationId":{"name":"locationId","abstract":"

    The ID of the Location which the reader should be registered to during connection.

    ","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(py)autoReconnectOnUnexpectedDisconnect":{"name":"autoReconnectOnUnexpectedDisconnect","abstract":"

    When set to true, the Terminal SDK will attempt a Bluetooth auto-reconnection on any unexpected disconnect.","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(py)autoReconnectionDelegate":{"name":"autoReconnectionDelegate","abstract":"

    Contains callback methods for Bluetooth auto-reconnection.

    ","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(im)initWithLocationId:":{"name":"-initWithLocationId:","abstract":"

    Initialize your connect options with a location ID.

    ","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(im)initWithLocationId:autoReconnectOnUnexpectedDisconnect:autoReconnectionDelegate:":{"name":"-initWithLocationId:autoReconnectOnUnexpectedDisconnect:autoReconnectionDelegate:","abstract":"

    Initialize your connect options with a location ID and an expected behavior for unexpected disconnects.

    ","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(im)initWithDiscoveryMethod:simulated:":{"name":"-initWithDiscoveryMethod:simulated:","abstract":"

    Initializes a discovery configuration with the given discovery method. All discoverable readers","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(im)initWithDiscoveryMethod:locationId:simulated:":{"name":"-initWithDiscoveryMethod:locationId:simulated:","abstract":"

    This variant of the initializer lets you specify a Location to filter the","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(py)timeout":{"name":"timeout","abstract":"

    The timeout (in seconds) after which discoverReaders: should fail. If the","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(py)discoveryMethod":{"name":"discoveryMethod","abstract":"

    The method by which to discover readers.

    ","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(py)simulated":{"name":"simulated","abstract":"

    Whether to use simulated discovery to discover a device simulator.

    ","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(py)locationId":{"name":"locationId","abstract":"

    A location ID that can be used to filter discovery result so only readers","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(im)init":{"name":"-init","abstract":"

    Use initWithDiscoveryMethod:simulated:

    ","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(cm)new":{"name":"+new","abstract":"

    Use initWithDiscoveryMethod:simulated:

    ","parent_name":"SCPDiscoveryConfiguration"},"Protocols/SCPDiscoveryDelegate.html#/c:objc(pl)SCPDiscoveryDelegate(im)terminal:didUpdateDiscoveredReaders:":{"name":"-terminal:didUpdateDiscoveredReaders:","abstract":"

    This method will be called repeatedly until:

    ","parent_name":"SCPDiscoveryDelegate"},"Enums/SCPDiscoveryMethod.html#/c:@E@SCPDiscoveryMethod@SCPDiscoveryMethodBluetoothScan":{"name":"SCPDiscoveryMethodBluetoothScan","abstract":"

    The Bluetooth Scan discovery method searches for Stripe Terminal’s","parent_name":"SCPDiscoveryMethod"},"Enums/SCPDiscoveryMethod.html#/c:@E@SCPDiscoveryMethod@SCPDiscoveryMethodBluetoothProximity":{"name":"SCPDiscoveryMethodBluetoothProximity","abstract":"

    The Bluetooth Proximity discovery method searches for a subset of","parent_name":"SCPDiscoveryMethod"},"Enums/SCPDiscoveryMethod.html#/c:@E@SCPDiscoveryMethod@SCPDiscoveryMethodInternet":{"name":"SCPDiscoveryMethodInternet","abstract":"

    The Internet discovery method searches for internet-connected readers,","parent_name":"SCPDiscoveryMethod"},"Enums/SCPDiscoveryMethod.html#/c:@E@SCPDiscoveryMethod@SCPDiscoveryMethodLocalMobile":{"name":"SCPDiscoveryMethodLocalMobile","abstract":"

    The Local Mobile discovery method searches for any readers built into the","parent_name":"SCPDiscoveryMethod"},"Enums/SCPDiscoveryMethod.html":{"name":"SCPDiscoveryMethod","abstract":"

    The possible methods for discovering a reader. Pass a variant of this enum"},"Protocols/SCPDiscoveryDelegate.html":{"name":"SCPDiscoveryDelegate","abstract":"

    Implement this protocol to handle a continually updating list"},"Classes/SCPDiscoveryConfiguration.html":{"name":"SCPDiscoveryConfiguration","abstract":"

    Configuration options for discovering readers.

    "},"Classes/SCPBluetoothConnectionConfiguration.html":{"name":"SCPBluetoothConnectionConfiguration","abstract":"

    This class lets you define Bluetooth reader connection options.

    "},"Classes/SCPInternetConnectionConfiguration.html":{"name":"SCPInternetConnectionConfiguration","abstract":"

    This class lets you set options that define internet reader behavior throughout a given"},"Classes/SCPLocalMobileConnectionConfiguration.html":{"name":"SCPLocalMobileConnectionConfiguration","abstract":"

    This class lets you set options that define local mobile reader behavior throughout a given"},"Enums/SCPConnectionStatus.html":{"name":"SCPConnectionStatus","abstract":"

    The possible reader connection statuses for the SDK.

    "},"Classes/SCPListLocationsParameters.html":{"name":"SCPListLocationsParameters","abstract":"

    Parameters to be used when calling Terminal.shared.listLocations() to list"},"Classes/SCPLocation.html":{"name":"SCPLocation","abstract":"

    A Location is used to group readers in the Stripe Terminal ecosystem. The"},"Enums/SCPLocationStatus.html":{"name":"SCPLocationStatus","abstract":"

    Represents the possible states of the location object for a"},"Classes/SCPAddress.html":{"name":"SCPAddress","abstract":"

    Holds address data associated with a given SCPLocation.

    "},"Classes/SCPSimulatorConfiguration.html":{"name":"SCPSimulatorConfiguration","abstract":"

    Simulator specific configurations you can set to test your integration’s"},"Enums/SCPSimulateReaderUpdate.html":{"name":"SCPSimulateReaderUpdate","abstract":"

    Enum used to simulate various types of reader updates being available for"},"Classes/SCPSimulatedCard.html":{"name":"SCPSimulatedCard","abstract":"

    Simulated Card objects can be used with the shared SCPSimulatorConfiguration"},"Enums/SCPSimulatedCardType.html":{"name":"SCPSimulatedCardType","abstract":"

    Enum used to simulate various types of cards and error cases.

    "},"Protocols/SCPJSONDecodable.html#/c:objc(pl)SCPJSONDecodable(cm)decodedObjectFromJSON:":{"name":"+decodedObjectFromJSON:","abstract":"

    Parses a JSON dictionary into an instance of the class. Returns nil if the","parent_name":"SCPJSONDecodable"},"Protocols/SCPJSONDecodable.html#/c:objc(pl)SCPJSONDecodable(py)originalJSON":{"name":"originalJSON","abstract":"

    The raw JSON used to create the object. This may be useful for accessing","parent_name":"SCPJSONDecodable"},"Classes/SCPCancelable.html#/c:objc(cs)SCPCancelable(py)completed":{"name":"completed","abstract":"

    Indicates whether the command has completed. After the command has completed,","parent_name":"SCPCancelable"},"Classes/SCPCancelable.html#/c:objc(cs)SCPCancelable(im)cancel:":{"name":"-cancel:","abstract":"

    Attempts to cancel the action in progress. If the action could not be canceled,","parent_name":"SCPCancelable"},"Enums/SCPLogLevel.html#/c:@E@SCPLogLevel@SCPLogLevelNone":{"name":"SCPLogLevelNone","abstract":"

    No logs will printed to the console.

    ","parent_name":"SCPLogLevel"},"Enums/SCPLogLevel.html#/c:@E@SCPLogLevel@SCPLogLevelVerbose":{"name":"SCPLogLevelVerbose","abstract":"

    Verbose logs will be printed to the console.

    ","parent_name":"SCPLogLevel"},"Protocols/SCPReconnectionDelegate.html#/c:objc(pl)SCPReconnectionDelegate(im)terminal:didStartReaderReconnect:":{"name":"-terminal:didStartReaderReconnect:","abstract":"

    The reader has lost Bluetooth connection to the SDK and reconnection attempts have been started.

    ","parent_name":"SCPReconnectionDelegate"},"Protocols/SCPReconnectionDelegate.html#/c:objc(pl)SCPReconnectionDelegate(im)terminalDidSucceedReaderReconnect:":{"name":"-terminalDidSucceedReaderReconnect:","abstract":"

    The SDK was able to reconnect to the previously connected Bluetooth reader.

    ","parent_name":"SCPReconnectionDelegate"},"Protocols/SCPReconnectionDelegate.html#/c:objc(pl)SCPReconnectionDelegate(im)terminalDidFailReaderReconnect:":{"name":"-terminalDidFailReaderReconnect:","abstract":"

    The SDK was not able to reconnect to the previously connected bluetooth reader. The SDK is now disconnected from any readers.

    ","parent_name":"SCPReconnectionDelegate"},"Protocols/SCPTerminalDelegate.html#/c:objc(pl)SCPTerminalDelegate(im)terminal:didReportUnexpectedReaderDisconnect:":{"name":"-terminal:didReportUnexpectedReaderDisconnect:","abstract":"

    The reader disconnected unexpectedly (that is, without your app explicitly","parent_name":"SCPTerminalDelegate"},"Protocols/SCPTerminalDelegate.html#/c:objc(pl)SCPTerminalDelegate(im)terminal:didChangeConnectionStatus:":{"name":"-terminal:didChangeConnectionStatus:","abstract":"

    The currently connected reader’s connectionStatus changed.

    ","parent_name":"SCPTerminalDelegate"},"Protocols/SCPTerminalDelegate.html#/c:objc(pl)SCPTerminalDelegate(im)terminal:didChangePaymentStatus:":{"name":"-terminal:didChangePaymentStatus:","abstract":"

    The currently connected reader’s paymentStatus changed.

    ","parent_name":"SCPTerminalDelegate"},"Protocols/SCPConnectionTokenProvider.html#/c:objc(pl)SCPConnectionTokenProvider(im)fetchConnectionToken:":{"name":"-fetchConnectionToken:","abstract":"

    Fetches a connection token from your backend server.

    ","parent_name":"SCPConnectionTokenProvider"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)setTokenProvider:":{"name":"+setTokenProvider:","abstract":"

    Sets the token provider for the shared (singleton) SCPTerminal instance.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)hasTokenProvider":{"name":"+hasTokenProvider","abstract":"

    Returns true if a token provider has been set, through setTokenProvider:

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)setLogListener:":{"name":"+setLogListener:","abstract":"

    Sets a block to listen for logs from the shared Terminal instance (optional).

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cpy)shared":{"name":"shared","abstract":"

    Returns the shared (singleton) Terminal instance.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)delegate":{"name":"delegate","abstract":"

    The Terminal singleton object’s primary delegate. This delegate announces","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)connectedReader":{"name":"connectedReader","abstract":"

    Information about the connected SCPReader, or nil if no reader is connected.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)connectionStatus":{"name":"connectionStatus","abstract":"

    The Terminal instance’s current connection status.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)logLevel":{"name":"logLevel","abstract":"

    The log level for the SDK. The default value is .none.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)simulatorConfiguration":{"name":"simulatorConfiguration","abstract":"

    The simulator configuration settings that will be used when connecting to","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)paymentStatus":{"name":"paymentStatus","abstract":"

    The Terminal instance’s current payment status.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)clearCachedCredentials":{"name":"-clearCachedCredentials","abstract":"

    Clears the current connection token, saved reader sessions, and any other","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)supportsReadersOfType:discoveryMethod:simulated:error:":{"name":"-supportsReadersOfType:discoveryMethod:simulated:error:","abstract":"

    Use this method to determine whether the mobile device supports a given reader type","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)discoverReaders:delegate:completion:":{"name":"-discoverReaders:delegate:completion:","abstract":"

    Begins discovering readers based on the given discovery configuration.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)connectBluetoothReader:delegate:connectionConfig:completion:":{"name":"-connectBluetoothReader:delegate:connectionConfig:completion:","abstract":"

    Attempts to connect to the given Bluetooth reader with a given connection","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)connectInternetReader:connectionConfig:completion:":{"name":"-connectInternetReader:connectionConfig:completion:","abstract":"

    Attempts to connect to the given Internet reader with a given connection","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)connectLocalMobileReader:delegate:connectionConfig:completion:":{"name":"-connectLocalMobileReader:delegate:connectionConfig:completion:","abstract":"

    Attempts to connect to the given Local Mobile reader with a given","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)listLocations:completion:":{"name":"-listLocations:completion:","abstract":"

    Retrieves a list of SCPLocation objects belonging to your merchant. You must specify","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)installAvailableUpdate":{"name":"-installAvailableUpdate","abstract":"

    Installs the available update for the connected reader.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)disconnectReader:":{"name":"-disconnectReader:","abstract":"

    Attempts to disconnect from the currently connected reader.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)createPaymentIntent:completion:":{"name":"-createPaymentIntent:completion:","abstract":"

    Creates a new SCPPaymentIntent with the given parameters.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)retrievePaymentIntent:completion:":{"name":"-retrievePaymentIntent:completion:","abstract":"

    Retrieves a SCPPaymentIntent with a client secret.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectPaymentMethod:completion:":{"name":"-collectPaymentMethod:completion:","abstract":"

    Collects a payment method for the given SCPPaymentIntent.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectPaymentMethod:collectConfig:completion:":{"name":"-collectPaymentMethod:collectConfig:completion:","abstract":"

    Collects a payment method for the given PaymentIntent, with the specified configuration.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)processPayment:completion:":{"name":"-processPayment:completion:","abstract":"

    Processes a payment after collecting a payment method succeeds.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)cancelPaymentIntent:completion:":{"name":"-cancelPaymentIntent:completion:","abstract":"

    Cancels an SCPPaymentIntent.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)readReusableCard:completion:":{"name":"-readReusableCard:completion:","abstract":"

    Reads a card with the given parameters and returns a PaymentMethod.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)createSetupIntent:completion:":{"name":"-createSetupIntent:completion:","abstract":"

    Creates a new SCPSetupIntent with the given parameters.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)retrieveSetupIntent:completion:":{"name":"-retrieveSetupIntent:completion:","abstract":"

    Retrieves an SCPSetupIntent with a client secret.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)cancelSetupIntent:completion:":{"name":"-cancelSetupIntent:completion:","abstract":"

    Cancels an SCPPaymentIntent.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectSetupIntentPaymentMethod:customerConsentCollected:completion:":{"name":"-collectSetupIntentPaymentMethod:customerConsentCollected:completion:","abstract":"

    Collects a payment method for the given SCPSetupIntent.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)confirmSetupIntent:completion:":{"name":"-confirmSetupIntent:completion:","abstract":"

    Confirms a SetupIntent after the payment method has been successfully collected.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectRefundPaymentMethod:completion:":{"name":"-collectRefundPaymentMethod:completion:","abstract":"

    Initiates an in-person refund with a given set of SCPRefundParameters by","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)processRefund:":{"name":"-processRefund:","abstract":"

    Processes an in-person refund after the refund payment method has been collected.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)clearReaderDisplay:":{"name":"-clearReaderDisplay:","abstract":"

    Clears the reader display and resets it to the splash screen.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)setReaderDisplay:completion:":{"name":"-setReaderDisplay:completion:","abstract":"

    Updates the reader display with cart information.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromReaderInputOptions:":{"name":"+stringFromReaderInputOptions:","abstract":"

    Returns an unlocalized string for the given reader input options, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromReaderDisplayMessage:":{"name":"+stringFromReaderDisplayMessage:","abstract":"

    Returns an unlocalized string for the given reader display message, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromReaderEvent:":{"name":"+stringFromReaderEvent:","abstract":"

    Returns an unlocalized string for the given reader event, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromConnectionStatus:":{"name":"+stringFromConnectionStatus:","abstract":"

    Returns an unlocalized string for the given connection status, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromPaymentStatus:":{"name":"+stringFromPaymentStatus:","abstract":"

    Returns an unlocalized string for the given payment status, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromDeviceType:":{"name":"+stringFromDeviceType:","abstract":"

    Returns an unlocalized string for the given device type.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromDiscoveryMethod:":{"name":"+stringFromDiscoveryMethod:","abstract":"

    Returns an unlocalized string for the given discovery method.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromCardBrand:":{"name":"+stringFromCardBrand:","abstract":"

    Returns an unlocalized string for the given card brand.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromPaymentIntentStatus:":{"name":"+stringFromPaymentIntentStatus:","abstract":"

    Returns an unlocalized string for the given payment intent status.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)init":{"name":"-init","abstract":"

    Use initWithConfiguration:tokenProvider:delegate:

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)new":{"name":"+new","abstract":"

    Use initWithConfiguration:tokenProvider:delegate:

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html":{"name":"SCPTerminal","abstract":"

    The SCPTerminal singleton object exposes an interface for discovering readers,"},"Protocols/SCPConnectionTokenProvider.html":{"name":"SCPConnectionTokenProvider","abstract":"

    Before integrating the SDK, you should create an endpoint on your backend"},"Protocols/SCPTerminalDelegate.html":{"name":"SCPTerminalDelegate","abstract":"

    Implement this protocol to handle connection and payment updates from the"},"Protocols/SCPReconnectionDelegate.html":{"name":"SCPReconnectionDelegate","abstract":"

    Implement this protocol to handle bluetooth auto-reconnection.

    "},"Enums/SCPLogLevel.html":{"name":"SCPLogLevel","abstract":"

    The various log levels for the SDK.

    "},"Classes/SCPCancelable.html":{"name":"SCPCancelable","abstract":"

    An object representing an action that can be canceled.

    "},"Protocols/SCPJSONDecodable.html":{"name":"SCPJSONDecodable","abstract":"

    Objects conforming to this protocol can be instantiated by decoding a JSON"},"Terminal.html#/c:SCPTerminal.h@SCPSDKVersion":{"name":"SCPSDKVersion","abstract":"

    The current version of this library.

    "},"Terminal.html":{"name":"Terminal"},"Reader%20Discovery%20%26%20Connection.html":{"name":"Reader Discovery & Connection"},"Reader.html":{"name":"Reader"},"Reader%20Updates.html":{"name":"Reader Updates"},"Payment.html":{"name":"Payment"},"Card-Present%20Refunds.html":{"name":"Card-Present Refunds"},"Saving%20Cards.html":{"name":"Saving Cards"},"Errors.html":{"name":"Errors"},"Blocks.html":{"name":"Blocks"}} \ No newline at end of file +{"Blocks.html#/c:SCPBlocks.h@T@SCPConnectionTokenCompletionBlock":{"name":"SCPConnectionTokenCompletionBlock","abstract":"

    A block called with a connection token or an error from your backend.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPErrorCompletionBlock":{"name":"SCPErrorCompletionBlock","abstract":"

    A block called with an optional error.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPLogListenerBlock":{"name":"SCPLogListenerBlock","abstract":"

    A block called with a logline from the SDK.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPPaymentIntentCompletionBlock":{"name":"SCPPaymentIntentCompletionBlock","abstract":"

    A block called with a PaymentIntent or an error.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPPaymentMethodCompletionBlock":{"name":"SCPPaymentMethodCompletionBlock","abstract":"

    A block called with a PaymentMethod.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPProcessPaymentCompletionBlock":{"name":"SCPProcessPaymentCompletionBlock","abstract":"

    A block called with a PaymentIntent or a ProcessPaymentError

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPReaderCompletionBlock":{"name":"SCPReaderCompletionBlock","abstract":"

    A block called with a reader object or an error.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPProcessRefundCompletionBlock":{"name":"SCPProcessRefundCompletionBlock","abstract":"

    A block called with a Refund or a ProcessRefundError.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPConfirmSetupIntentCompletionBlock":{"name":"SCPConfirmSetupIntentCompletionBlock","abstract":"

    A block called with a SetupIntent or a ConfirmSetupIntentError.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPLocationsCompletionBlock":{"name":"SCPLocationsCompletionBlock","abstract":"

    A block called with a list of Locations or an error.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPRefundCompletionBlock":{"name":"SCPRefundCompletionBlock","abstract":"

    A block called with a Refund or an error.

    "},"Blocks.html#/c:SCPBlocks.h@T@SCPSetupIntentCompletionBlock":{"name":"SCPSetupIntentCompletionBlock","abstract":"

    A block called with a SetupIntent or an error.

    "},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBusy":{"name":"SCPErrorBusy","abstract":"

    The SDK is busy executing another command. The SDK can only execute a","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCancelFailedAlreadyCompleted":{"name":"SCPErrorCancelFailedAlreadyCompleted","abstract":"

    Canceling a command failed because the command already completed.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNotConnectedToReader":{"name":"SCPErrorNotConnectedToReader","abstract":"

    No reader is connected. Connect to a reader before trying again.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAlreadyConnectedToReader":{"name":"SCPErrorAlreadyConnectedToReader","abstract":"

    Already connected to a reader.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorConnectionTokenProviderCompletedWithNothing":{"name":"SCPErrorConnectionTokenProviderCompletedWithNothing","abstract":"

    Your implementation of fetchConnectionToken called the completion block","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorProcessInvalidPaymentIntent":{"name":"SCPErrorProcessInvalidPaymentIntent","abstract":"

    processPayment was called with an unknown or invalid PaymentIntent.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNilPaymentIntent":{"name":"SCPErrorNilPaymentIntent","abstract":"

    collectPaymentMethod or processPayment was called with a nil PaymentIntent.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNilSetupIntent":{"name":"SCPErrorNilSetupIntent","abstract":"

    collectSetupIntentPaymentMethod or processSetupIntent was called with","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNilRefundPaymentMethod":{"name":"SCPErrorNilRefundPaymentMethod","abstract":"

    processRefund was called without calling collectRefundPaymentMethod","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidRefundParameters":{"name":"SCPErrorInvalidRefundParameters","abstract":"

    The RefundParameters object has invalid values. The Charge ID (ch_123abc)","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidClientSecret":{"name":"SCPErrorInvalidClientSecret","abstract":"

    A PaymentIntent or SetupIntent was referenced using an invalid client secret.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorMustBeDiscoveringToConnect":{"name":"SCPErrorMustBeDiscoveringToConnect","abstract":"

    The SDK must be actively Discovering Readers in order to successfully","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCannotConnectToUndiscoveredReader":{"name":"SCPErrorCannotConnectToUndiscoveredReader","abstract":"

    Before connecting to a reader, it must have already been discovered in the","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidDiscoveryConfiguration":{"name":"SCPErrorInvalidDiscoveryConfiguration","abstract":"

    discoverReaders was called using an invalid SCPDiscoveryConfiguration.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidReaderForUpdate":{"name":"SCPErrorInvalidReaderForUpdate","abstract":"

    installUpdate was passed an update that is for a different reader. Updates can only","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnsupportedSDK":{"name":"SCPErrorUnsupportedSDK","abstract":"

    -[SCPTerminal connectReader:completion:] was called from an unsupported version","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorFeatureNotAvailableWithConnectedReader":{"name":"SCPErrorFeatureNotAvailableWithConnectedReader","abstract":"

    This feature is currently not available for the selected reader.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorFeatureNotAvailable":{"name":"SCPErrorFeatureNotAvailable","abstract":"

    This feature is not currently available.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidListLocationsLimitParameter":{"name":"SCPErrorInvalidListLocationsLimitParameter","abstract":"

    The ListLocationsParameters object has invalid values.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothConnectionInvalidLocationIdParameter":{"name":"SCPErrorBluetoothConnectionInvalidLocationIdParameter","abstract":"

    The locationId parameter to BluetoothConnectionConfiguration is required but a valid one was not provided.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidRequiredParameter":{"name":"SCPErrorInvalidRequiredParameter","abstract":"

    A required parameter was invalid or missing.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderConnectionConfigurationInvalid":{"name":"SCPErrorReaderConnectionConfigurationInvalid","abstract":"

    An invalid ConnectionConfiguration was passed through connect.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderTippingParameterInvalid":{"name":"SCPErrorReaderTippingParameterInvalid","abstract":"

    An invalid usage of eligibleAmount or skipTipping was passed into collect.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidLocationIdParameter":{"name":"SCPErrorInvalidLocationIdParameter","abstract":"

    The provided location ID parameter was invalid.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCanceled":{"name":"SCPErrorCanceled","abstract":"

    The command was canceled by your app.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorLocationServicesDisabled":{"name":"SCPErrorLocationServicesDisabled","abstract":"

    Access to location services is currently disabled. This may be because:

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothDisabled":{"name":"SCPErrorBluetoothDisabled","abstract":"

    This error indicates that Bluetooth is turned off, and the user should use","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothAccessDenied":{"name":"SCPErrorBluetoothAccessDenied","abstract":"

    Bluetooth is turned on on the device, but access to Bluetooth has been denied","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothScanTimedOut":{"name":"SCPErrorBluetoothScanTimedOut","abstract":"

    Scanning for bluetooth devices timed out.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothLowEnergyUnsupported":{"name":"SCPErrorBluetoothLowEnergyUnsupported","abstract":"

    Bluetooth Low Energy is unsupported on this iOS device. Use a different","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedBatteryLow":{"name":"SCPErrorReaderSoftwareUpdateFailedBatteryLow","abstract":"

    Updating the reader software failed because the reader’s battery is","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedInterrupted":{"name":"SCPErrorReaderSoftwareUpdateFailedInterrupted","abstract":"

    Updating the reader software failed because the update was interrupted.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedExpiredUpdate":{"name":"SCPErrorReaderSoftwareUpdateFailedExpiredUpdate","abstract":"

    Updating the reader software failed because the update has expired. Please disconnect and","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothConnectionFailedBatteryCriticallyLow":{"name":"SCPErrorBluetoothConnectionFailedBatteryCriticallyLow","abstract":"

    The reader has a critically low battery and cannot connect to the","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardInsertNotRead":{"name":"SCPErrorCardInsertNotRead","abstract":"

    The card is not a chip card.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardSwipeNotRead":{"name":"SCPErrorCardSwipeNotRead","abstract":"

    The swipe could not be read.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardReadTimedOut":{"name":"SCPErrorCardReadTimedOut","abstract":"

    Reading a card timed out.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardRemoved":{"name":"SCPErrorCardRemoved","abstract":"

    The card was removed during the transaction.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCardLeftInReader":{"name":"SCPErrorCardLeftInReader","abstract":"

    A card can only be used for one transaction, and must be removed after","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorMissingEMVData":{"name":"SCPErrorMissingEMVData","abstract":"

    The reader failed to read the data from the presented payment method. If you encounter","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCommandNotAllowed":{"name":"SCPErrorCommandNotAllowed","abstract":"

    The command was not permitted to execute by the operating system.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnsupportedMobileDeviceConfiguration":{"name":"SCPErrorUnsupportedMobileDeviceConfiguration","abstract":"

    The mobile device on which the app is running is in an unsupported","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorPasscodeNotEnabled":{"name":"SCPErrorPasscodeNotEnabled","abstract":"

    The mobile device on which the app is running must have a passcode set.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCommandNotAllowedDuringCall":{"name":"SCPErrorCommandNotAllowedDuringCall","abstract":"

    The card reader cannot be used while a phone call is active.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidAmount":{"name":"SCPErrorInvalidAmount","abstract":"

    An attempt was made to charge an amount not supported by the reader.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInvalidCurrency":{"name":"SCPErrorInvalidCurrency","abstract":"

    An attempt was made to charge an amount in a currency not supported by the reader.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderTOSAcceptanceRequiresiCloudSignIn":{"name":"SCPErrorAppleBuiltInReaderTOSAcceptanceRequiresiCloudSignIn","abstract":"

    Failed to accept reader-specific terms of service because there is no iCloud","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderTOSAcceptanceCanceled":{"name":"SCPErrorAppleBuiltInReaderTOSAcceptanceCanceled","abstract":"

    The user cancelled reader-specific terms of service acceptance.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderBusy":{"name":"SCPErrorReaderBusy","abstract":"

    The reader is busy.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorIncompatibleReader":{"name":"SCPErrorIncompatibleReader","abstract":"

    An incompatible reader was detected. You can only use the Stripe Terminal","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderCommunicationError":{"name":"SCPErrorReaderCommunicationError","abstract":"

    Could not communicate with the reader.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNFCDisabled":{"name":"SCPErrorNFCDisabled","abstract":"

    NFC functionality is disabled.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothError":{"name":"SCPErrorBluetoothError","abstract":"

    Generic Bluetooth error.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothConnectTimedOut":{"name":"SCPErrorBluetoothConnectTimedOut","abstract":"

    Connecting to the bluetooth device timed out. Make sure the device is","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothDisconnected":{"name":"SCPErrorBluetoothDisconnected","abstract":"

    The Bluetooth device was disconnected unexpectedly.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothPeerRemovedPairingInformation":{"name":"SCPErrorBluetoothPeerRemovedPairingInformation","abstract":"

    Bluetooth pairing error, the reader has removed this device pairing information.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothAlreadyPairedWithAnotherDevice":{"name":"SCPErrorBluetoothAlreadyPairedWithAnotherDevice","abstract":"

    The Bluetooth reader is already paired to another device. The Bluetooth reader","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailed":{"name":"SCPErrorReaderSoftwareUpdateFailed","abstract":"

    Generic reader software update error.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedReaderError":{"name":"SCPErrorReaderSoftwareUpdateFailedReaderError","abstract":"

    Updating the reader software failed because there was an error","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderSoftwareUpdateFailedServerError":{"name":"SCPErrorReaderSoftwareUpdateFailedServerError","abstract":"

    Updating the reader software failed because there was an error","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnsupportedReaderVersion":{"name":"SCPErrorUnsupportedReaderVersion","abstract":"

    processPayment was called from a reader with an unsupported reader","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnknownReaderIpAddress":{"name":"SCPErrorUnknownReaderIpAddress","abstract":"

    The reader returned from discovery does not have an IP address and cannot","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInternetConnectTimeOut":{"name":"SCPErrorInternetConnectTimeOut","abstract":"

    Connecting to reader over the internet timed out. Make sure your device and","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorConnectFailedReaderIsInUse":{"name":"SCPErrorConnectFailedReaderIsInUse","abstract":"

    Connecting to the reader failed because it is currently in use","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorBluetoothReconnectStarted":{"name":"SCPErrorBluetoothReconnectStarted","abstract":"

    The Bluetooth reader has disconnected and we are attempting to reconnect.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorReaderNotAccessibleInBackground":{"name":"SCPErrorReaderNotAccessibleInBackground","abstract":"

    An attempt was made to interact with the reader while the the app is in the background.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderFailedToPrepare":{"name":"SCPErrorAppleBuiltInReaderFailedToPrepare","abstract":"

    Preparing the Apple Built-In reader to collect payments failed.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderDeviceBanned":{"name":"SCPErrorAppleBuiltInReaderDeviceBanned","abstract":"

    This device cannot be used to process using the Apple Built-In reader as it has been banned.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderTOSNotYetAccepted":{"name":"SCPErrorAppleBuiltInReaderTOSNotYetAccepted","abstract":"

    The operation could not be completed because the reader-specific terms of service have","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderTOSAcceptanceFailed":{"name":"SCPErrorAppleBuiltInReaderTOSAcceptanceFailed","abstract":"

    Failed to accept reader-specific terms of service using the signed-in Apple ID.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderMerchantBlocked":{"name":"SCPErrorAppleBuiltInReaderMerchantBlocked","abstract":"

    This merchant account cannot be used with Apple Built-In reader as it has been blocked.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorAppleBuiltInReaderInvalidMerchant":{"name":"SCPErrorAppleBuiltInReaderInvalidMerchant","abstract":"

    This merchant account cannot be used with the Apple Built-In reader as it is invalid.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnexpectedSdkError":{"name":"SCPErrorUnexpectedSdkError","abstract":"

    Unexpected SDK error.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorUnexpectedReaderError":{"name":"SCPErrorUnexpectedReaderError","abstract":"

    Unexpected reader error.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorDeclinedByStripeAPI":{"name":"SCPErrorDeclinedByStripeAPI","abstract":"

    The Stripe API declined the transaction.","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorDeclinedByReader":{"name":"SCPErrorDeclinedByReader","abstract":"

    The reader declined the transaction. Try another card.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorCommandRequiresCardholderConsent":{"name":"SCPErrorCommandRequiresCardholderConsent","abstract":"

    The cardholder must give consent in order for this operation to succeed.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorRefundFailed":{"name":"SCPErrorRefundFailed","abstract":"

    The refund failed. The customer’s bank or card issuer was unable to process","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorNotConnectedToInternet":{"name":"SCPErrorNotConnectedToInternet","abstract":"

    The SDK is not connected to the internet.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorRequestTimedOut":{"name":"SCPErrorRequestTimedOut","abstract":"

    The underlying request timed out.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorStripeAPIError":{"name":"SCPErrorStripeAPIError","abstract":"

    The underlying request returned an API error.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorStripeAPIResponseDecodingError":{"name":"SCPErrorStripeAPIResponseDecodingError","abstract":"

    The API response from Stripe could not be decoded.

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorInternalNetworkError":{"name":"SCPErrorInternalNetworkError","abstract":"

    Generic network error

    ","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorConnectionTokenProviderCompletedWithError":{"name":"SCPErrorConnectionTokenProviderCompletedWithError","abstract":"

    Your implementation of -[SCPConnectionTokenProvider fetchConnectionToken:]","parent_name":"SCPError"},"Enums/SCPError.html#/c:@E@SCPError@SCPErrorSessionExpired":{"name":"SCPErrorSessionExpired","abstract":"

    The current session has expired and the reader must be disconnected and","parent_name":"SCPError"},"Enums/SCPError.html":{"name":"SCPError","abstract":"

    Possible error codes for NSError objects under the SCPErrorDomain domain.

    "},"Errors.html#/c:@SCPErrorDomain":{"name":"SCPErrorDomain","abstract":"

    The error domain for all errors originating from the Stripe Terminal SDK.

    "},"Errors.html#/c:SCPErrors.h@T@SCPErrorKey":{"name":"SCPErrorKey","abstract":"

    Use this enum to access userInfo keys for NSError objects under the"},"Errors.html#/c:@SCPErrorKeyMessage":{"name":"SCPErrorKeyMessage","abstract":"

    An error message explaining what went wrong. You probably shouldn’t show this"},"Errors.html#/c:@SCPErrorKeyHttpStatusCode":{"name":"SCPErrorKeyHttpStatusCode","abstract":"

    The HTTP status code of the response.

    "},"Errors.html#/c:@SCPErrorKeyReaderMessage":{"name":"SCPErrorKeyReaderMessage","abstract":"

    This error message comes from the reader. You probably shouldn’t show this"},"Errors.html#/c:@SCPErrorKeyDeviceBannedUntilDate":{"name":"SCPErrorKeyDeviceBannedUntilDate","abstract":"

    If an Apple Built-In reader fails to connect due to a device ban and the error"},"Errors.html#/c:@SCPErrorKeyStripeAPIRequestId":{"name":"SCPErrorKeyStripeAPIRequestId","abstract":"

    If a Stripe API request failed, the failed request’s id will be returned in the"},"Errors.html#/c:@SCPErrorKeyStripeAPIDeclineCode":{"name":"SCPErrorKeyStripeAPIDeclineCode","abstract":"

    The decline code returned by the Stripe API.

    "},"Errors.html#/c:@SCPErrorKeyStripeAPIErrorCode":{"name":"SCPErrorKeyStripeAPIErrorCode","abstract":"

    The error code returned by the Stripe API.

    "},"Errors.html#/c:@SCPErrorKeyStripeAPIErrorParameter":{"name":"SCPErrorKeyStripeAPIErrorParameter","abstract":"

    The parameter the error relates to if the error is parameter-specific.

    "},"Errors.html#/c:@SCPErrorKeyStripeAPIErrorType":{"name":"SCPErrorKeyStripeAPIErrorType","abstract":"

    The error type returned by the Stripe API.

    "},"Errors.html#/c:@SCPErrorKeyStripeAPIPaymentIntent":{"name":"SCPErrorKeyStripeAPIPaymentIntent","abstract":"

    If a Stripe API request failed and the error has an associated PaymentIntent,"},"Errors.html#/c:@SCPErrorKeyStripeAPIDocUrl":{"name":"SCPErrorKeyStripeAPIDocUrl","abstract":"

    The documentation URL for the error returned by the Stripe API.

    "},"Errors.html#/c:@SCPErrorKeyStripeAPIFailureReason":{"name":"SCPErrorKeyStripeAPIFailureReason","abstract":"

    If a refund fails, the reason for refund failure if known. Possible values"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(py)setupIntent":{"name":"setupIntent","abstract":"

    The updated SetupIntent after confirmSetupIntent failed.

    ","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(py)requestError":{"name":"requestError","abstract":"

    If confirmSetupIntent failed because the underlying network request errored,","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(py)declineCode":{"name":"declineCode","abstract":"

    If confirmSetupIntent failed because the payment method was declined, this","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPConfirmSetupIntentError.html#/c:objc(cs)SCPConfirmSetupIntentError(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPConfirmSetupIntentError"},"Classes/SCPSetupAttemptCardPresentDetails.html#/c:objc(cs)SCPSetupAttemptCardPresentDetails(py)generatedCard":{"name":"generatedCard","abstract":"

    The ID of the Card PaymentMethod which was generated by this SetupAttempt.

    ","parent_name":"SCPSetupAttemptCardPresentDetails"},"Classes/SCPSetupAttemptCardPresentDetails.html#/c:objc(cs)SCPSetupAttemptCardPresentDetails(py)emvAuthData":{"name":"emvAuthData","abstract":"

    The Authorization Response Cryptogram (ARPC) from the issuer.

    ","parent_name":"SCPSetupAttemptCardPresentDetails"},"Classes/SCPSetupAttemptCardPresentDetails.html#/c:objc(cs)SCPSetupAttemptCardPresentDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPSetupAttemptCardPresentDetails"},"Classes/SCPSetupAttemptCardPresentDetails.html#/c:objc(cs)SCPSetupAttemptCardPresentDetails(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPSetupAttemptCardPresentDetails"},"Classes/SCPSetupAttemptPaymentMethodDetails.html#/c:objc(cs)SCPSetupAttemptPaymentMethodDetails(py)type":{"name":"type","abstract":"

    The type of the PaymentMethod. The corresponding, similarly named property","parent_name":"SCPSetupAttemptPaymentMethodDetails"},"Classes/SCPSetupAttemptPaymentMethodDetails.html#/c:objc(cs)SCPSetupAttemptPaymentMethodDetails(py)cardPresent":{"name":"cardPresent","abstract":"

    If this is a card present payment method (ie self.type == SCPPaymentMethodTypeCardPresent),","parent_name":"SCPSetupAttemptPaymentMethodDetails"},"Classes/SCPSetupAttemptPaymentMethodDetails.html#/c:objc(cs)SCPSetupAttemptPaymentMethodDetails(py)interacPresent":{"name":"interacPresent","abstract":"

    If this is a card present payment method (ie self.type == SCPPaymentMethodTypeInteracPresent),","parent_name":"SCPSetupAttemptPaymentMethodDetails"},"Classes/SCPSetupAttemptPaymentMethodDetails.html#/c:objc(cs)SCPSetupAttemptPaymentMethodDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPSetupAttemptPaymentMethodDetails"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)application":{"name":"application","abstract":"

    The ID of the Connect application that created the SetupIntent.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)created":{"name":"created","abstract":"

    Time at which the object was created.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)customer":{"name":"customer","abstract":"

    ID of the Customer this SetupIntent belongs to, if one exists.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)onBehalfOf":{"name":"onBehalfOf","abstract":"

    (Connect) The account (if any) for which the setup is intended.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)paymentMethod":{"name":"paymentMethod","abstract":"

    ID of the payment method used with this SetupAttempt.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)paymentMethodDetails":{"name":"paymentMethodDetails","abstract":"

    Details about the payment method at the time of SetupIntent confirmation.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)setupIntent":{"name":"setupIntent","abstract":"

    ID of the SetupIntent that this attempt belongs to.

    ","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)status":{"name":"status","abstract":"

    The status of this SetupAttempt. One of: requires_confirmation,","parent_name":"SCPSetupAttempt"},"Classes/SCPSetupAttempt.html#/c:objc(cs)SCPSetupAttempt(py)stripeId":{"name":"stripeId","abstract":"

    The unique identifier for the SetupAttempt.

    ","parent_name":"SCPSetupAttempt"},"Enums/SCPSetupIntentUsage.html#/c:@E@SCPSetupIntentUsage@SCPSetupIntentUsageOffSession":{"name":"SCPSetupIntentUsageOffSession","abstract":"

    An off-session usage indicates to Stripe that future payments will take place","parent_name":"SCPSetupIntentUsage"},"Enums/SCPSetupIntentUsage.html#/c:@E@SCPSetupIntentUsage@SCPSetupIntentUsageOnSession":{"name":"SCPSetupIntentUsageOnSession","abstract":"

    An on-session usage indicates to Stripe that future payments will take place","parent_name":"SCPSetupIntentUsage"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusRequiresPaymentMethod":{"name":"SCPSetupIntentStatusRequiresPaymentMethod","abstract":"

    Next step: collect a payment method by calling collectPaymentMethod.

    ","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusRequiresConfirmation":{"name":"SCPSetupIntentStatusRequiresConfirmation","abstract":"

    Next step: confirm the SetupIntent by calling confirmSetupIntent.

    ","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusRequiresAction":{"name":"SCPSetupIntentStatusRequiresAction","abstract":"

    If the setup requires additional actions, such as authenticating with","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusProcessing":{"name":"SCPSetupIntentStatusProcessing","abstract":"

    Once required actions are handled, the SetupIntent moves to processing.","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusCanceled":{"name":"SCPSetupIntentStatusCanceled","abstract":"

    The SetupIntent was canceled.

    ","parent_name":"SCPSetupIntentStatus"},"Enums/SCPSetupIntentStatus.html#/c:@E@SCPSetupIntentStatus@SCPSetupIntentStatusSucceeded":{"name":"SCPSetupIntentStatusSucceeded","abstract":"

    The SetupIntent succeeded.

    ","parent_name":"SCPSetupIntentStatus"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)customer":{"name":"customer","abstract":"

    ID of the customer this SetupIntent belongs to, if one exists.

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)stripeDescription":{"name":"stripeDescription","abstract":"

    An arbitrary string attached to the object. Often useful for displaying to users.

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)metadata":{"name":"metadata","abstract":"

    Set of key-value pairs that you can attach to an object. This can be useful for","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)usage":{"name":"usage","abstract":"

    Indicates how the payment method is intended to be used in the future. If not","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)onBehalfOf":{"name":"onBehalfOf","abstract":"

    Connect Only:** The Stripe account ID for which this SetupIntent is created.

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(im)initWithCustomer:":{"name":"-initWithCustomer:","abstract":"

    Initializes SCPSetupIntentParameters with the given customer ID.

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(im)init":{"name":"-init","abstract":"

    Use initWithCustomer:

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(cm)new":{"name":"+new","abstract":"

    Use initWithCustomer:

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntentParameters.html#/c:objc(cs)SCPSetupIntentParameters(py)description":{"name":"description","abstract":"

    Use stripeDescription for the string attached to the object.

    ","parent_name":"SCPSetupIntentParameters"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)stripeId":{"name":"stripeId","abstract":"

    The unique identifier for the intent.

    ","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)created":{"name":"created","abstract":"

    When the intent was created.

    ","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)customer":{"name":"customer","abstract":"

    The identifier of a customer object to which the SetupIntent is attached, if applicable.

    ","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)metadata":{"name":"metadata","abstract":"

    Set of key-value pairs attached to the object.

    ","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)usage":{"name":"usage","abstract":"

    An SCPSetupIntentUsage value describing how the SetupIntent will be used.","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)status":{"name":"status","abstract":"

    The status of the intent.

    ","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(py)latestAttempt":{"name":"latestAttempt","abstract":"

    The most recent SetupAttempt for this SetupIntent

    ","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class. You should only use SetupIntents","parent_name":"SCPSetupIntent"},"Classes/SCPSetupIntent.html#/c:objc(cs)SCPSetupIntent(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class. You should only use SetupIntents","parent_name":"SCPSetupIntent"},"Classes/SCPReadReusableCardParameters.html#/c:objc(cs)SCPReadReusableCardParameters(py)customer":{"name":"customer","abstract":"

    Optional parameter: attach the new PaymentMethod to Customer with this id

    ","parent_name":"SCPReadReusableCardParameters"},"Classes/SCPReadReusableCardParameters.html#/c:objc(cs)SCPReadReusableCardParameters(py)metadata":{"name":"metadata","abstract":"

    Optional set of key-value pairs attached to the object. The default is nil.

    ","parent_name":"SCPReadReusableCardParameters"},"Classes/SCPReadReusableCardParameters.html":{"name":"SCPReadReusableCardParameters","abstract":"

    Parameters for reading a reusable card.

    "},"Classes/SCPSetupIntent.html":{"name":"SCPSetupIntent","abstract":"

    A SetupIntent guides you through the process of setting up and saving a"},"Classes/SCPSetupIntentParameters.html":{"name":"SCPSetupIntentParameters","abstract":"

    Parameters for creating an SCPSetupIntent.

    "},"Enums/SCPSetupIntentStatus.html":{"name":"SCPSetupIntentStatus","abstract":"

    The possible statuses of the SetupIntent.

    "},"Enums/SCPSetupIntentUsage.html":{"name":"SCPSetupIntentUsage","abstract":"

    The SetupIntent usage options tell Stripe how the payment method is intended to be used in the future."},"Classes/SCPSetupAttempt.html":{"name":"SCPSetupAttempt","abstract":"

    A SetupAttempt describes one attempted confirmation of a SetupIntent,"},"Classes/SCPSetupAttemptPaymentMethodDetails.html":{"name":"SCPSetupAttemptPaymentMethodDetails","abstract":"

    Details about a PaymentMethod at a specific time. ex: at time of transaction"},"Classes/SCPSetupAttemptCardPresentDetails.html":{"name":"SCPSetupAttemptCardPresentDetails","abstract":"

    An object representing details from a transaction using a card_present"},"Classes/SCPConfirmSetupIntentError.html":{"name":"SCPConfirmSetupIntentError","abstract":"

    An error from -[SCPTerminal confirmSetupIntent:completion:]

    "},"Enums/SCPRefundStatus.html#/c:@E@SCPRefundStatus@SCPRefundStatusSucceeded":{"name":"SCPRefundStatusSucceeded","abstract":"

    The refund succeeded.

    ","parent_name":"SCPRefundStatus"},"Enums/SCPRefundStatus.html#/c:@E@SCPRefundStatus@SCPRefundStatusPending":{"name":"SCPRefundStatusPending","abstract":"

    The refund is pending.

    ","parent_name":"SCPRefundStatus"},"Enums/SCPRefundStatus.html#/c:@E@SCPRefundStatus@SCPRefundStatusFailed":{"name":"SCPRefundStatusFailed","abstract":"

    The refund failed.

    ","parent_name":"SCPRefundStatus"},"Enums/SCPRefundStatus.html#/c:@E@SCPRefundStatus@SCPRefundStatusUnknown":{"name":"SCPRefundStatusUnknown","abstract":"

    Unknown refund state.

    ","parent_name":"SCPRefundStatus"},"Classes/SCPProcessRefundError.html#/c:objc(cs)SCPProcessRefundError(py)refund":{"name":"refund","abstract":"

    If processRefund failed after the refund was created, this property contains","parent_name":"SCPProcessRefundError"},"Classes/SCPProcessRefundError.html#/c:objc(cs)SCPProcessRefundError(py)requestError":{"name":"requestError","abstract":"

    If processRefund failed because the underlying network request errored,","parent_name":"SCPProcessRefundError"},"Classes/SCPProcessRefundError.html#/c:objc(cs)SCPProcessRefundError(cm)init":{"name":"+init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPProcessRefundError"},"Classes/SCPProcessRefundError.html#/c:objc(cs)SCPProcessRefundError(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPProcessRefundError"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)chargeId":{"name":"chargeId","abstract":"

    The ID of the charge to be refunded.

    ","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)amount":{"name":"amount","abstract":"

    The amount of the refund, provided in the currency’s smallest unit.

    ","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)currency":{"name":"currency","abstract":"

    Three-letter ISO currency code. Must be a supported currency.

    ","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)metadata":{"name":"metadata","abstract":"

    Set of key-value pairs that you can attach to an object. This can be useful for","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)reverseTransfer":{"name":"reverseTransfer","abstract":"

    Connect only: Nullable boolean indicating whether the transfer should be","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(py)refundApplicationFee":{"name":"refundApplicationFee","abstract":"

    Connect only: Nullable boolean indicating whether the application fee should be","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(im)initWithChargeId:amount:currency:":{"name":"-initWithChargeId:amount:currency:","abstract":"

    Initializes SCPRefundParameters with the given charge, amount, and currency.

    ","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(im)init":{"name":"-init","abstract":"

    Use initWithChargeId:amount:currency:

    ","parent_name":"SCPRefundParameters"},"Classes/SCPRefundParameters.html#/c:objc(cs)SCPRefundParameters(cm)new":{"name":"+new","abstract":"

    Use initWithChargeId:amount:currency:

    ","parent_name":"SCPRefundParameters"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)stripeId":{"name":"stripeId","abstract":"

    The unique identifier for the refund.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)amount":{"name":"amount","abstract":"

    The amount that was refunded.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)charge":{"name":"charge","abstract":"

    The ID of the charge that was refunded

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)created":{"name":"created","abstract":"

    When the refund object was created.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)currency":{"name":"currency","abstract":"

    The currency of the amount refunded.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)metadata":{"name":"metadata","abstract":"

    Metadata associated with the refund.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)reason":{"name":"reason","abstract":"

    Reason for the refund, either user-provided (duplicate, fraudulent, or","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)status":{"name":"status","abstract":"

    The status of the refund.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)paymentMethodDetails":{"name":"paymentMethodDetails","abstract":"

    The payment method details associated with the refund.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(py)failureReason":{"name":"failureReason","abstract":"

    If the refund failed, the reason for refund failure if known.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html#/c:objc(cs)SCPRefund(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPRefund"},"Classes/SCPRefund.html":{"name":"SCPRefund","abstract":"

    An object representing a Stripe refund.

    "},"Classes/SCPRefundParameters.html":{"name":"SCPRefundParameters","abstract":"

    Parameters for creating an SCPRefund.

    "},"Classes/SCPProcessRefundError.html":{"name":"SCPProcessRefundError","abstract":"

    An error from -[SCPTerminal processRefund:completion:].

    "},"Enums/SCPRefundStatus.html":{"name":"SCPRefundStatus","abstract":"

    The possible statuses for a refund.

    "},"Enums/SCPIncrementalAuthorizationStatus.html#/c:@E@SCPIncrementalAuthorizationStatus@SCPIncrementalAuthorizationStatusUnknown":{"name":"SCPIncrementalAuthorizationStatusUnknown","abstract":"

    It is undetermined whether or not this PaymentIntent will be eligible for incremental authorizations.","parent_name":"SCPIncrementalAuthorizationStatus"},"Enums/SCPIncrementalAuthorizationStatus.html#/c:@E@SCPIncrementalAuthorizationStatus@SCPIncrementalAuthorizationStatusNotSupported":{"name":"SCPIncrementalAuthorizationStatusNotSupported","abstract":"

    This PaymentIntent is not eligible for incremental authorizations, or it was not requested.

    ","parent_name":"SCPIncrementalAuthorizationStatus"},"Enums/SCPIncrementalAuthorizationStatus.html#/c:@E@SCPIncrementalAuthorizationStatus@SCPIncrementalAuthorizationStatusSupported":{"name":"SCPIncrementalAuthorizationStatusSupported","abstract":"

    This PaymentIntent is eligible for incremental authorizations.

    ","parent_name":"SCPIncrementalAuthorizationStatus"},"Classes/SCPNetworks.html#/c:objc(cs)SCPNetworks(py)available":{"name":"available","abstract":"

    All available networks for the card.

    ","parent_name":"SCPNetworks"},"Classes/SCPNetworks.html#/c:objc(cs)SCPNetworks(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPNetworks"},"Classes/SCPNetworks.html#/c:objc(cs)SCPNetworks(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPNetworks"},"Classes/SCPTippingConfiguration.html#/c:objc(cs)SCPTippingConfiguration(py)eligibleAmount":{"name":"eligibleAmount","abstract":"

    The amount of the payment total eligible for tips.

    ","parent_name":"SCPTippingConfiguration"},"Classes/SCPTippingConfiguration.html#/c:objc(cs)SCPTippingConfiguration(im)initWithEligibleAmount:":{"name":"-initWithEligibleAmount:","abstract":"

    Initialize a TippingConfiguration instance.

    ","parent_name":"SCPTippingConfiguration"},"Classes/SCPTippingConfiguration.html#/c:objc(cs)SCPTippingConfiguration(im)init":{"name":"-init","abstract":"

    Use initWithEligibleAmount:

    ","parent_name":"SCPTippingConfiguration"},"Classes/SCPTippingConfiguration.html#/c:objc(cs)SCPTippingConfiguration(cm)new":{"name":"+new","abstract":"

    Use initWithEligibleAmount:

    ","parent_name":"SCPTippingConfiguration"},"Enums/SCPCaptureMethod.html#/c:@E@SCPCaptureMethod@SCPCaptureMethodManual":{"name":"SCPCaptureMethodManual","abstract":"

    Place a hold on the funds when the customer authorizes the payment, but don’t","parent_name":"SCPCaptureMethod"},"Enums/SCPCaptureMethod.html#/c:@E@SCPCaptureMethod@SCPCaptureMethodAutomatic":{"name":"SCPCaptureMethodAutomatic","abstract":"

    Stripe automatically captures funds when the customer authorizes the payment.

    ","parent_name":"SCPCaptureMethod"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(py)skipTipping":{"name":"skipTipping","abstract":"

    Bypass tipping selection if it would have otherwise been shown.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(py)tippingConfiguration":{"name":"tippingConfiguration","abstract":"

    The tipping configuration for this payment collection.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(py)updatePaymentIntent":{"name":"updatePaymentIntent","abstract":"

    Whether or not to update the PaymentIntent server side during collectPaymentMethod.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithSkipTipping:":{"name":"-initWithSkipTipping:","abstract":"

    Initialize a CollectConfiguration

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithUpdatePaymentIntent:":{"name":"-initWithUpdatePaymentIntent:","abstract":"

    Initialize a CollectConfiguration

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithTippingConfiguration:":{"name":"-initWithTippingConfiguration:","abstract":"

    Initialize a CollectConfiguration.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithSkipTipping:updatePaymentIntent:":{"name":"-initWithSkipTipping:updatePaymentIntent:","abstract":"

    Initialize a CollectConfiguration

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithSkipTipping:tippingConfiguration:":{"name":"-initWithSkipTipping:tippingConfiguration:","abstract":"

    Initialize a CollectConfiguration.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithUpdatePaymentIntent:tippingConfiguration:":{"name":"-initWithUpdatePaymentIntent:tippingConfiguration:","abstract":"

    Initialize a CollectConfiguration.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)initWithSkipTipping:updatePaymentIntent:tippingConfiguration:":{"name":"-initWithSkipTipping:updatePaymentIntent:tippingConfiguration:","abstract":"

    Initialize a CollectConfiguration.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(im)init":{"name":"-init","abstract":"

    Use initWithSkipTipping:updatePaymentIntent:tippingConfiguration: or helper initializers.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPCollectConfiguration.html#/c:objc(cs)SCPCollectConfiguration(cm)new":{"name":"+new","abstract":"

    Use initWithSkipTipping:updatePaymentIntent:tippingConfiguration: or helper initializers.

    ","parent_name":"SCPCollectConfiguration"},"Classes/SCPPaymentMethodOptionsParameters.html#/c:objc(cs)SCPPaymentMethodOptionsParameters(py)cardPresentParameters":{"name":"cardPresentParameters","abstract":"

    Card-present-specific configuration for this PaymentMethod.

    ","parent_name":"SCPPaymentMethodOptionsParameters"},"Classes/SCPPaymentMethodOptionsParameters.html#/c:objc(cs)SCPPaymentMethodOptionsParameters(im)initWithCardPresentParameters:":{"name":"-initWithCardPresentParameters:","abstract":"

    Initialize a PaymentMethodOptionsParameters

    ","parent_name":"SCPPaymentMethodOptionsParameters"},"Classes/SCPPaymentMethodOptionsParameters.html#/c:objc(cs)SCPPaymentMethodOptionsParameters(im)init":{"name":"-init","abstract":"

    Use initWithCardPresentParameters:(SCPCardPresentParameters)cardPresentParameters

    ","parent_name":"SCPPaymentMethodOptionsParameters"},"Enums/SCPPaymentMethodType.html#/c:@E@SCPPaymentMethodType@SCPPaymentMethodTypeCard":{"name":"SCPPaymentMethodTypeCard","abstract":"

    A card payment method.

    ","parent_name":"SCPPaymentMethodType"},"Enums/SCPPaymentMethodType.html#/c:@E@SCPPaymentMethodType@SCPPaymentMethodTypeCardPresent":{"name":"SCPPaymentMethodTypeCardPresent","abstract":"

    A card present payment method.

    ","parent_name":"SCPPaymentMethodType"},"Enums/SCPPaymentMethodType.html#/c:@E@SCPPaymentMethodType@SCPPaymentMethodTypeInteracPresent":{"name":"SCPPaymentMethodTypeInteracPresent","abstract":"

    An Interac Present payment method.

    ","parent_name":"SCPPaymentMethodType"},"Enums/SCPPaymentMethodType.html#/c:@E@SCPPaymentMethodType@SCPPaymentMethodTypeUnknown":{"name":"SCPPaymentMethodTypeUnknown","abstract":"

    An unknown type.

    ","parent_name":"SCPPaymentMethodType"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)stripeId":{"name":"stripeId","abstract":"

    The unique identifier for the PaymentMethod

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)created":{"name":"created","abstract":"

    Time at which the object was created. Measured in seconds since the Unix epoch.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)type":{"name":"type","abstract":"

    The type of the PaymentMethod. The corresponding, similarly named property contains additional information specific to the PaymentMethod type.","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)card":{"name":"card","abstract":"

    If this is a card PaymentMethod (ie self.type == SCPPaymentMethodTypeCard), this contains additional details.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)cardPresent":{"name":"cardPresent","abstract":"

    If this is a card_present PaymentMethod (ie self.type == SCPPaymentMethodTypeCardPresent), this contains additional details.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)interacPresent":{"name":"interacPresent","abstract":"

    If this is an Interac_present PaymentMethod (ie self.type == SCPPaymentMethodTypeInteracPresent), this contains additional details.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)customer":{"name":"customer","abstract":"

    The Customer that this PaymentMethod is attached to, or nil.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(py)metadata":{"name":"metadata","abstract":"

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPPaymentMethod.html#/c:objc(cs)SCPPaymentMethod(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPPaymentMethod"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)brand":{"name":"brand","abstract":"

    The issuer of the card.

    ","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)country":{"name":"country","abstract":"

    Two-letter ISO code representing the country of the card.

    ","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)expMonth":{"name":"expMonth","abstract":"

    Two-digit number representing the card’s expiration month.","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)expYear":{"name":"expYear","abstract":"

    Four-digit number representing the card’s expiration year.","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)funding":{"name":"funding","abstract":"

    Card funding type. Ex: credit, debit, etc.

    ","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)last4":{"name":"last4","abstract":"

    The last four digits of the card.

    ","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(py)fingerprint":{"name":"fingerprint","abstract":"

    Uniquely identifies this particular card number. You can use this attribute","parent_name":"SCPCardDetails"},"Classes/SCPCardDetails.html#/c:objc(cs)SCPCardDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPCardDetails"},"Classes/SCPPaymentMethodDetails.html#/c:objc(cs)SCPPaymentMethodDetails(py)type":{"name":"type","abstract":"

    The type of the PaymentMethod. The corresponding, similarly named property","parent_name":"SCPPaymentMethodDetails"},"Classes/SCPPaymentMethodDetails.html#/c:objc(cs)SCPPaymentMethodDetails(py)cardPresent":{"name":"cardPresent","abstract":"

    If this is a card present payment method (ie self.type == SCPPaymentMethodTypeCardPresent),","parent_name":"SCPPaymentMethodDetails"},"Classes/SCPPaymentMethodDetails.html#/c:objc(cs)SCPPaymentMethodDetails(py)interacPresent":{"name":"interacPresent","abstract":"

    If this is an Interac present payment method (ie self.type == SCPPaymentMethodTypeInteracPresent),","parent_name":"SCPPaymentMethodDetails"},"Classes/SCPPaymentMethodDetails.html#/c:objc(cs)SCPPaymentMethodDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPPaymentMethodDetails"},"Enums/SCPChargeStatus.html#/c:@E@SCPChargeStatus@SCPChargeStatusSucceeded":{"name":"SCPChargeStatusSucceeded","abstract":"

    The charge succeeded.

    ","parent_name":"SCPChargeStatus"},"Enums/SCPChargeStatus.html#/c:@E@SCPChargeStatus@SCPChargeStatusPending":{"name":"SCPChargeStatusPending","abstract":"

    The charge succeeded.

    ","parent_name":"SCPChargeStatus"},"Enums/SCPChargeStatus.html#/c:@E@SCPChargeStatus@SCPChargeStatusFailed":{"name":"SCPChargeStatusFailed","abstract":"

    The charge failed.

    ","parent_name":"SCPChargeStatus"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)amount":{"name":"amount","abstract":"

    The amount of the charge.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)currency":{"name":"currency","abstract":"

    The currency of the charge.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)status":{"name":"status","abstract":"

    The status of the charge.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)paymentMethodDetails":{"name":"paymentMethodDetails","abstract":"

    The payment method details associated with the charge.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)stripeDescription":{"name":"stripeDescription","abstract":"

    A string describing the charge, displayed in the Stripe dashboard and in","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)metadata":{"name":"metadata","abstract":"

    Metadata associated with the charge.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)stripeId":{"name":"stripeId","abstract":"

    The unique identifier for the charge.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)statementDescriptorSuffix":{"name":"statementDescriptorSuffix","abstract":"

    Extra dynamic information about a Charge. This will appear concatenated with the statementDescriptor on","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(py)calculatedStatementDescriptor":{"name":"calculatedStatementDescriptor","abstract":"

    The full statement descriptor that is displayed on your customer’s credit card’s statement, after the","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPCharge"},"Classes/SCPCharge.html#/c:objc(cs)SCPCharge(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPCharge"},"Enums/SCPCardFundingType.html#/c:@E@SCPCardFundingType@SCPCardFundingTypeDebit":{"name":"SCPCardFundingTypeDebit","abstract":"

    Debit

    ","parent_name":"SCPCardFundingType"},"Enums/SCPCardFundingType.html#/c:@E@SCPCardFundingType@SCPCardFundingTypeCredit":{"name":"SCPCardFundingTypeCredit","abstract":"

    Credit

    ","parent_name":"SCPCardFundingType"},"Enums/SCPCardFundingType.html#/c:@E@SCPCardFundingType@SCPCardFundingTypePrepaid":{"name":"SCPCardFundingTypePrepaid","abstract":"

    Prepaid

    ","parent_name":"SCPCardFundingType"},"Enums/SCPCardFundingType.html#/c:@E@SCPCardFundingType@SCPCardFundingTypeOther":{"name":"SCPCardFundingTypeOther","abstract":"

    An other or unknown type of funding source

    ","parent_name":"SCPCardFundingType"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandVisa":{"name":"SCPCardBrandVisa","abstract":"

    Visa card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandAmex":{"name":"SCPCardBrandAmex","abstract":"

    American Express card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandMasterCard":{"name":"SCPCardBrandMasterCard","abstract":"

    MasterCard card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandDiscover":{"name":"SCPCardBrandDiscover","abstract":"

    Discover card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandJCB":{"name":"SCPCardBrandJCB","abstract":"

    JCB card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandDinersClub":{"name":"SCPCardBrandDinersClub","abstract":"

    Diners Club card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandInterac":{"name":"SCPCardBrandInterac","abstract":"

    Interac card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandUnionPay":{"name":"SCPCardBrandUnionPay","abstract":"

    Union Pay card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandEftposAu":{"name":"SCPCardBrandEftposAu","abstract":"

    Eftpos Australia card

    ","parent_name":"SCPCardBrand"},"Enums/SCPCardBrand.html#/c:@E@SCPCardBrand@SCPCardBrandUnknown":{"name":"SCPCardBrandUnknown","abstract":"

    An unknown card brand

    ","parent_name":"SCPCardBrand"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(py)paymentIntent":{"name":"paymentIntent","abstract":"

    The updated PaymentIntent after processPayment failed.

    ","parent_name":"SCPProcessPaymentError"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(py)requestError":{"name":"requestError","abstract":"

    If processPayment failed because the underlying network request errored,","parent_name":"SCPProcessPaymentError"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(py)declineCode":{"name":"declineCode","abstract":"

    If processPayment failed because the payment method was declined, this","parent_name":"SCPProcessPaymentError"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPProcessPaymentError"},"Classes/SCPProcessPaymentError.html#/c:objc(cs)SCPProcessPaymentError(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPProcessPaymentError"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)accountType":{"name":"accountType","abstract":"

    The type of account being debited or credited

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)applicationPreferredName":{"name":"applicationPreferredName","abstract":"

    Also known as “Application Name”. Required on EMV receipts.

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)dedicatedFileName":{"name":"dedicatedFileName","abstract":"

    Also known as “AID”. Required on EMV receipts.

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)authorizationCode":{"name":"authorizationCode","abstract":"

    Identifier for this transaction

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)authorizationResponseCode":{"name":"authorizationResponseCode","abstract":"

    Authorization Response Code

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)applicationCryptogram":{"name":"applicationCryptogram","abstract":"

    Application Cryptogram

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)terminalVerificationResults":{"name":"terminalVerificationResults","abstract":"

    TVR

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(py)transactionStatusInformation":{"name":"transactionStatusInformation","abstract":"

    TSI

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPReceiptDetails.html#/c:objc(cs)SCPReceiptDetails(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPReceiptDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)last4":{"name":"last4","abstract":"

    The last 4 digits of the card.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)expMonth":{"name":"expMonth","abstract":"

    The card’s expiration month. 1-indexed (i.e. 1 == January)

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)expYear":{"name":"expYear","abstract":"

    The card’s expiration year.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)cardholderName":{"name":"cardholderName","abstract":"

    The cardholder name as read from the card, in ISO 7813 format. May include","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)funding":{"name":"funding","abstract":"

    The card’s funding type.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)brand":{"name":"brand","abstract":"

    The issuing brand of the card.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)fingerprint":{"name":"fingerprint","abstract":"

    A string uniquely identifying this card number.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)generatedCard":{"name":"generatedCard","abstract":"

    ID of a card PaymentMethod that may be attached to a Customer for future","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)receipt":{"name":"receipt","abstract":"

    Receipt information for the card present transaction. Only present for EMV","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)emvAuthData":{"name":"emvAuthData","abstract":"

    (Only applicable to EMV payments) The authorization data from the card","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)country":{"name":"country","abstract":"

    Two-letter ISO code representing the country of the card. You could use this","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)preferredLocales":{"name":"preferredLocales","abstract":"

    EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)networks":{"name":"networks","abstract":"

    Contains information about card networks that can be used to process the payment.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(py)incrementalAuthorizationStatus":{"name":"incrementalAuthorizationStatus","abstract":"

    Whether this payment method is eligible for incremental authorizations.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPCardPresentDetails"},"Classes/SCPCardPresentDetails.html#/c:objc(cs)SCPCardPresentDetails(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPCardPresentDetails"},"Enums/SCPCardPresentRouting.html#/c:@E@SCPCardPresentRouting@SCPCardPresentRoutingDomestic":{"name":"SCPCardPresentRoutingDomestic","abstract":"

    Prioritize domestic debit network routing on payment method collection.

    ","parent_name":"SCPCardPresentRouting"},"Enums/SCPCardPresentRouting.html#/c:@E@SCPCardPresentRouting@SCPCardPresentRoutingInternational":{"name":"SCPCardPresentRoutingInternational","abstract":"

    Prioritize international network routing on payment method collection.

    ","parent_name":"SCPCardPresentRouting"},"Enums/SCPCardPresentCaptureMethod.html#/c:@E@SCPCardPresentCaptureMethod@SCPCardPresentCaptureMethodManualPreferred":{"name":"SCPCardPresentCaptureMethodManualPreferred","abstract":"

    Use manual_preferred if you prefer manual capture_method for the SCPPaymentIntent’s capture_method but support","parent_name":"SCPCardPresentCaptureMethod"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(py)requestExtendedAuthorization":{"name":"requestExtendedAuthorization","abstract":"

    Using the extended authorizations feature, users in eligible categories can capture up to 31 days later, depending on the card brand.

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(py)requestIncrementalAuthorizationSupport":{"name":"requestIncrementalAuthorizationSupport","abstract":"

    Allows you to increase the authorized amount on a confirmed PaymentIntent before you capture it. This means you can update the amount on a payment if the estimated price changes or goods and services are added. Before capture, each incremental authorization appears on your customer’s credit card statement as an additional pending charge.

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(py)captureMethod":{"name":"captureMethod","abstract":"

    SCPCardPresentCaptureMethod as a nullable NSNumber.

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(py)requestedPriority":{"name":"requestedPriority","abstract":"

    The requested routing priority as a nullable NSNumber.

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:":{"name":"-initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:":{"name":"-initWithRequestExtendedAuthorization:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestIncrementalAuthorizationSupport:":{"name":"-initWithRequestIncrementalAuthorizationSupport:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:captureMethod:":{"name":"-initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:captureMethod:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:captureMethod:":{"name":"-initWithRequestExtendedAuthorization:captureMethod:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestIncrementalAuthorizationSupport:captureMethod:":{"name":"-initWithRequestIncrementalAuthorizationSupport:captureMethod:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithCaptureMethod:":{"name":"-initWithCaptureMethod:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:captureMethod:requestedPriority:":{"name":"-initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:captureMethod:requestedPriority:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:requestedPriority:":{"name":"-initWithRequestExtendedAuthorization:requestIncrementalAuthorizationSupport:requestedPriority:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithCaptureMethod:requestedPriority:":{"name":"-initWithCaptureMethod:requestedPriority:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)initWithRequestedPriority:":{"name":"-initWithRequestedPriority:","abstract":"

    Initializes a CardPresentParameters

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPCardPresentParameters.html#/c:objc(cs)SCPCardPresentParameters(im)init":{"name":"-init","abstract":"

    Use alternative initializer.

    ","parent_name":"SCPCardPresentParameters"},"Classes/SCPTip.html#/c:objc(cs)SCPTip(py)amount":{"name":"amount","abstract":"

    Portion of the amount that corresponds to a tip

    ","parent_name":"SCPTip"},"Classes/SCPTip.html#/c:objc(cs)SCPTip(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate SCPTip.

    ","parent_name":"SCPTip"},"Classes/SCPTip.html#/c:objc(cs)SCPTip(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate SCPTip.

    ","parent_name":"SCPTip"},"Classes/SCPAmountDetails.html#/c:objc(cs)SCPAmountDetails(py)tip":{"name":"tip","abstract":"

    Details about the tip

    ","parent_name":"SCPAmountDetails"},"Classes/SCPAmountDetails.html#/c:objc(cs)SCPAmountDetails(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate SCPAmountDetails.

    ","parent_name":"SCPAmountDetails"},"Classes/SCPAmountDetails.html#/c:objc(cs)SCPAmountDetails(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate SCPAmountDetails.

    ","parent_name":"SCPAmountDetails"},"Enums/SCPPaymentStatus.html#/c:@E@SCPPaymentStatus@SCPPaymentStatusNotReady":{"name":"SCPPaymentStatusNotReady","abstract":"

    The SDK is not ready to start a payment. It may be busy with another","parent_name":"SCPPaymentStatus"},"Enums/SCPPaymentStatus.html#/c:@E@SCPPaymentStatus@SCPPaymentStatusReady":{"name":"SCPPaymentStatusReady","abstract":"

    The SDK is ready to start a payment.

    ","parent_name":"SCPPaymentStatus"},"Enums/SCPPaymentStatus.html#/c:@E@SCPPaymentStatus@SCPPaymentStatusWaitingForInput":{"name":"SCPPaymentStatusWaitingForInput","abstract":"

    The SDK is waiting for input from the customer (e.g., for a card to","parent_name":"SCPPaymentStatus"},"Enums/SCPPaymentStatus.html#/c:@E@SCPPaymentStatus@SCPPaymentStatusProcessing":{"name":"SCPPaymentStatusProcessing","abstract":"

    The SDK is processing a payment.

    ","parent_name":"SCPPaymentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusRequiresPaymentMethod":{"name":"SCPPaymentIntentStatusRequiresPaymentMethod","abstract":"

    Next step: collect a payment method by calling collectPaymentMethod.

    ","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusRequiresConfirmation":{"name":"SCPPaymentIntentStatusRequiresConfirmation","abstract":"

    Next step: process the payment by calling processPayment.

    ","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusRequiresCapture":{"name":"SCPPaymentIntentStatusRequiresCapture","abstract":"

    Next step: capture the PaymentIntent on your backend via the Stripe API.

    ","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusProcessing":{"name":"SCPPaymentIntentStatusProcessing","abstract":"

    The PaymentIntent is in the middle of full EMV processing.

    ","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusCanceled":{"name":"SCPPaymentIntentStatusCanceled","abstract":"

    The PaymentIntent was canceled.

    ","parent_name":"SCPPaymentIntentStatus"},"Enums/SCPPaymentIntentStatus.html#/c:@E@SCPPaymentIntentStatus@SCPPaymentIntentStatusSucceeded":{"name":"SCPPaymentIntentStatusSucceeded","abstract":"

    The PaymentIntent succeeded.

    ","parent_name":"SCPPaymentIntentStatus"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)amount":{"name":"amount","abstract":"

    The amount of the payment, provided in the currency’s smallest unit.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)currency":{"name":"currency","abstract":"

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)paymentMethodTypes":{"name":"paymentMethodTypes","abstract":"

    The list of payment method types that this PaymentIntent is allowed to use.","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)captureMethod":{"name":"captureMethod","abstract":"

    The capture method that this PaymentIntent should use. Defaults to SCPCaptureMethodManual.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)metadata":{"name":"metadata","abstract":"

    Set of key-value pairs that you can attach to an object. This can be useful for","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)stripeDescription":{"name":"stripeDescription","abstract":"

    An arbitrary string attached to the object. If you send a receipt email for","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)statementDescriptor":{"name":"statementDescriptor","abstract":"

    A string to be displayed on your customer’s credit card statement. This may be","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)statementDescriptorSuffix":{"name":"statementDescriptorSuffix","abstract":"

    A string to specify details about the transaction so your customer can understand it clearly on their statement.","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)receiptEmail":{"name":"receiptEmail","abstract":"

    Email address that the receipt for the resulting payment will be sent to.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)customer":{"name":"customer","abstract":"

    The ID of the Customer this PaymentIntent is for, if one exists.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)applicationFeeAmount":{"name":"applicationFeeAmount","abstract":"

    The amount of the application fee (if any) that will be applied to the","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)transferGroup":{"name":"transferGroup","abstract":"

    A string that identifies the resulting payment as part of a group.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)transferDataDestination":{"name":"transferDataDestination","abstract":"

    The account (if any) the payment will be attributed to for tax reporting, and","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)onBehalfOf":{"name":"onBehalfOf","abstract":"

    The Stripe account ID for which these funds are intended.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)setupFutureUsage":{"name":"setupFutureUsage","abstract":"

    Indicates that you intend to make future payments with this PaymentIntent’s payment method.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)paymentMethodOptionsParameters":{"name":"paymentMethodOptionsParameters","abstract":"

    Specific options used during the creation of the PaymentMethod.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)initWithAmount:currency:":{"name":"-initWithAmount:currency:","abstract":"

    Initializes SCPPaymentIntentParameters with the given parameters.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)initWithAmount:currency:paymentMethodTypes:":{"name":"-initWithAmount:currency:paymentMethodTypes:","abstract":"

    Initializes SCPPaymentIntentParameters with the given parameters.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)initWithAmount:currency:captureMethod:":{"name":"-initWithAmount:currency:captureMethod:","abstract":"

    Initializes SCPPaymentIntentParameters with the given parameters.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)initWithAmount:currency:paymentMethodTypes:captureMethod:":{"name":"-initWithAmount:currency:paymentMethodTypes:captureMethod:","abstract":"

    Initializes SCPPaymentIntentParameters with the given parameters.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(im)init":{"name":"-init","abstract":"

    Use initWithAmount:currency:

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(cm)new":{"name":"+new","abstract":"

    Use initWithAmount:currency:

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntentParameters.html#/c:objc(cs)SCPPaymentIntentParameters(py)description":{"name":"description","abstract":"

    Use stripeDescription for the string attached to the object.

    ","parent_name":"SCPPaymentIntentParameters"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)stripeId":{"name":"stripeId","abstract":"

    The unique identifier for the intent.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)created":{"name":"created","abstract":"

    When the intent was created.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)status":{"name":"status","abstract":"

    The status of the PaymentIntent.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)amount":{"name":"amount","abstract":"

    The amount to be collected by this PaymentIntent, provided in the currency’s","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)captureMethod":{"name":"captureMethod","abstract":"

    Controls when the funds will be captured from the customer’s account.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)currency":{"name":"currency","abstract":"

    The currency of the payment.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)metadata":{"name":"metadata","abstract":"

    Set of key-value pairs attached to the object.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)charges":{"name":"charges","abstract":"

    Charges that were created by this PaymentIntent, if any.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)paymentMethod":{"name":"paymentMethod","abstract":"

    The payment method to be used in this PaymentIntent. Only valid in the","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)amountDetails":{"name":"amountDetails","abstract":"

    Details about items included in the amount after confirmation.

    ","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)amountTip":{"name":"amountTip","abstract":"

    Indicates how much the user intends to tip in addition to the amount by at confirmation time.","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)statementDescriptor":{"name":"statementDescriptor","abstract":"

    Extra information about a PaymentIntent. This will appear on your customer’s statement when","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(py)statementDescriptorSuffix":{"name":"statementDescriptorSuffix","abstract":"

    Extra dynamic information about a PaymentIntent. This will appear concatenated with the statementDescriptor on","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate SCPPaymentIntent. You should only use","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html#/c:objc(cs)SCPPaymentIntent(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate SCPPaymentIntent. You should only use","parent_name":"SCPPaymentIntent"},"Classes/SCPPaymentIntent.html":{"name":"SCPPaymentIntent","abstract":"

    A PaymentIntent tracks the process of collecting a payment from your customer."},"Classes/SCPPaymentIntentParameters.html":{"name":"SCPPaymentIntentParameters","abstract":"

    Parameters for creating an SCPPaymentIntent. Pass an object of this type"},"Enums/SCPPaymentIntentStatus.html":{"name":"SCPPaymentIntentStatus","abstract":"

    The possible statuses for a PaymentIntent.

    "},"Enums/SCPPaymentStatus.html":{"name":"SCPPaymentStatus","abstract":"

    The possible payment statuses for the SDK.

    "},"Classes/SCPAmountDetails.html":{"name":"SCPAmountDetails","abstract":"

    Contains details about items included in the [PaymentIntent] amount

    "},"Classes/SCPTip.html":{"name":"SCPTip","abstract":"

    Contains details about tips

    "},"Classes/SCPCardPresentParameters.html":{"name":"SCPCardPresentParameters","abstract":"

    Parameters that will be applied to the card present PaymentIntent.

    "},"Enums/SCPCardPresentCaptureMethod.html":{"name":"SCPCardPresentCaptureMethod","abstract":"

    Capture Method values that can be used as card-present payment method options.

    "},"Enums/SCPCardPresentRouting.html":{"name":"SCPCardPresentRouting","abstract":"

    Network routing priority on co-branded EMV cards supporting domestic debit and international card schemes.

    "},"Classes/SCPCardPresentDetails.html":{"name":"SCPCardPresentDetails","abstract":"

    An object representing details from a transaction using a card_present"},"Classes/SCPReceiptDetails.html":{"name":"SCPReceiptDetails","abstract":"

    Receipt details associated with a card present transaction.

    "},"Classes/SCPProcessPaymentError.html":{"name":"SCPProcessPaymentError","abstract":"

    An error from -[SCPTerminal processPayment:completion:].

    "},"Enums/SCPCardBrand.html":{"name":"SCPCardBrand","abstract":"

    The various card brands for a card.

    "},"Enums/SCPCardFundingType.html":{"name":"SCPCardFundingType","abstract":"

    The various funding sources for a card.

    "},"Classes/SCPCharge.html":{"name":"SCPCharge","abstract":"

    An object representing a Stripe charge.

    "},"Enums/SCPChargeStatus.html":{"name":"SCPChargeStatus","abstract":"

    The possible statuses for a charge

    "},"Classes/SCPPaymentMethodDetails.html":{"name":"SCPPaymentMethodDetails","abstract":"

    Details about a PaymentMethod at a specific time. ex: at time of transaction"},"Classes/SCPCardDetails.html":{"name":"SCPCardDetails","abstract":"

    Contains details about a user’s credit card.

    "},"Classes/SCPPaymentMethod.html":{"name":"SCPPaymentMethod","abstract":"

    PaymentMethod objects represent your customer’s payment instruments."},"Enums/SCPPaymentMethodType.html":{"name":"SCPPaymentMethodType","abstract":"

    The type of the PaymentMethod.

    "},"Classes/SCPPaymentMethodOptionsParameters.html":{"name":"SCPPaymentMethodOptionsParameters","abstract":"

    The PaymentMethodOptionsParameters contains options for PaymentMethod creation.

    "},"Classes/SCPCollectConfiguration.html":{"name":"SCPCollectConfiguration","abstract":"

    The CollectConfiguration contains configuration information relevant to collecting a payment"},"Enums/SCPCaptureMethod.html":{"name":"SCPCaptureMethod","abstract":"

    @abstract Controls when the funds will be captured from the customer’s account.

    "},"Classes/SCPTippingConfiguration.html":{"name":"SCPTippingConfiguration","abstract":"

    The TippingConfiguration contains configuration information relevant to collecting tips.

    "},"Classes/SCPNetworks.html":{"name":"SCPNetworks","abstract":"

    Contains information about card networks that can be used to process the payment.

    "},"Enums/SCPIncrementalAuthorizationStatus.html":{"name":"SCPIncrementalAuthorizationStatus","abstract":"

    Represents the ability for a PaymentIntent to be incrementally authorized.

    "},"Enums/SCPUpdateComponent.html#/c:@E@SCPUpdateComponent@SCPUpdateComponentIncremental":{"name":"SCPUpdateComponentIncremental","abstract":"

    If set, the update contains incremental changes to the reader. If this is","parent_name":"SCPUpdateComponent"},"Enums/SCPUpdateComponent.html#/c:@E@SCPUpdateComponent@SCPUpdateComponentFirmware":{"name":"SCPUpdateComponentFirmware","abstract":"

    If set, this update contains updated firmware for this reader. Firmware updates","parent_name":"SCPUpdateComponent"},"Enums/SCPUpdateComponent.html#/c:@E@SCPUpdateComponent@SCPUpdateComponentConfig":{"name":"SCPUpdateComponentConfig","abstract":"

    If set, this update contains a new configuration for this reader. These may","parent_name":"SCPUpdateComponent"},"Enums/SCPUpdateComponent.html#/c:@E@SCPUpdateComponent@SCPUpdateComponentKeys":{"name":"SCPUpdateComponentKeys","abstract":"

    If set, this update contains updated encryption keys for the reader.","parent_name":"SCPUpdateComponent"},"Enums/SCPUpdateTimeEstimate.html#/c:@E@SCPUpdateTimeEstimate@SCPUpdateTimeEstimateLessThan1Minute":{"name":"SCPUpdateTimeEstimateLessThan1Minute","abstract":"

    The update should take less than 1 minute to complete.

    ","parent_name":"SCPUpdateTimeEstimate"},"Enums/SCPUpdateTimeEstimate.html#/c:@E@SCPUpdateTimeEstimate@SCPUpdateTimeEstimate1To2Minutes":{"name":"SCPUpdateTimeEstimate1To2Minutes","abstract":"

    The update should take 1-2 minutes to complete.

    ","parent_name":"SCPUpdateTimeEstimate"},"Enums/SCPUpdateTimeEstimate.html#/c:@E@SCPUpdateTimeEstimate@SCPUpdateTimeEstimate2To5Minutes":{"name":"SCPUpdateTimeEstimate2To5Minutes","abstract":"

    The update should take 2-5 minutes to complete.

    ","parent_name":"SCPUpdateTimeEstimate"},"Enums/SCPUpdateTimeEstimate.html#/c:@E@SCPUpdateTimeEstimate@SCPUpdateTimeEstimate5To15Minutes":{"name":"SCPUpdateTimeEstimate5To15Minutes","abstract":"

    The update should take 5-15 minutes to complete.

    ","parent_name":"SCPUpdateTimeEstimate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(py)estimatedUpdateTime":{"name":"estimatedUpdateTime","abstract":"

    The estimated amount of time for the update.

    ","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(py)deviceSoftwareVersion":{"name":"deviceSoftwareVersion","abstract":"

    The target version for the update.

    ","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(py)components":{"name":"components","abstract":"

    The components that will be installed in this update.

    ","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(py)requiredAt":{"name":"requiredAt","abstract":"

    The date at which this update will be required to be installed. If this date","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(cm)stringFromUpdateTimeEstimate:":{"name":"+stringFromUpdateTimeEstimate:","abstract":"

    Returns an unlocalized string for the given update time estimate.

    ","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html#/c:objc(cs)SCPReaderSoftwareUpdate(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPReaderSoftwareUpdate"},"Classes/SCPReaderSoftwareUpdate.html":{"name":"SCPReaderSoftwareUpdate","abstract":"

    An object representing a reader update.

    "},"Enums/SCPUpdateTimeEstimate.html":{"name":"SCPUpdateTimeEstimate","abstract":"

    The estimated amount of time for an update. Note that these times are estimates;"},"Enums/SCPUpdateComponent.html":{"name":"SCPUpdateComponent","abstract":"

    A bitmask identifying what exact updates are contained within this update.

    "},"Classes/SCPCartLineItem.html#/c:objc(cs)SCPCartLineItem(py)quantity":{"name":"quantity","abstract":"

    The quantity of the line item being purchased.

    ","parent_name":"SCPCartLineItem"},"Classes/SCPCartLineItem.html#/c:objc(cs)SCPCartLineItem(py)displayName":{"name":"displayName","abstract":"

    The description or name of the item.

    ","parent_name":"SCPCartLineItem"},"Classes/SCPCartLineItem.html#/c:objc(cs)SCPCartLineItem(py)amount":{"name":"amount","abstract":"

    The price of the item, provided in the cart’s currency’s smallest unit.

    ","parent_name":"SCPCartLineItem"},"Classes/SCPCartLineItem.html#/c:objc(cs)SCPCartLineItem(im)initWithDisplayName:quantity:amount:":{"name":"-initWithDisplayName:quantity:amount:","abstract":"

    The values set here will be shown on the screen as-is. Make sure you’re","parent_name":"SCPCartLineItem"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(py)lineItems":{"name":"lineItems","abstract":"

    You can add or remove line items from this array individually or reassign the array entirely.","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(py)tax":{"name":"tax","abstract":"

    The displayed tax amount, provided in the currency’s smallest unit.

    ","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(py)total":{"name":"total","abstract":"

    The cart’s total balance, provided in the currency’s smallest unit.

    ","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(py)currency":{"name":"currency","abstract":"

    The currency of the cart.

    ","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(im)initWithCurrency:tax:total:":{"name":"-initWithCurrency:tax:total:","abstract":"

    Initializes an SCPCart with tax and total, in cents, as well as the currency.","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(im)init":{"name":"-init","abstract":"

    Use initWithTax:

    ","parent_name":"SCPCart"},"Classes/SCPCart.html#/c:objc(cs)SCPCart(cm)new":{"name":"+new","abstract":"

    Use initWithTax:

    ","parent_name":"SCPCart"},"Enums/SCPBatteryStatus.html#/c:@E@SCPBatteryStatus@SCPBatteryStatusUnknown":{"name":"SCPBatteryStatusUnknown","abstract":"

    Battery state is not yet known or not available for the connected reader.

    ","parent_name":"SCPBatteryStatus"},"Enums/SCPBatteryStatus.html#/c:@E@SCPBatteryStatus@SCPBatteryStatusCritical":{"name":"SCPBatteryStatusCritical","abstract":"

    The device’s battery is less than or equal to 5%.

    ","parent_name":"SCPBatteryStatus"},"Enums/SCPBatteryStatus.html#/c:@E@SCPBatteryStatus@SCPBatteryStatusLow":{"name":"SCPBatteryStatusLow","abstract":"

    The device’s battery is between 5% and 20%.

    ","parent_name":"SCPBatteryStatus"},"Enums/SCPBatteryStatus.html#/c:@E@SCPBatteryStatus@SCPBatteryStatusNominal":{"name":"SCPBatteryStatusNominal","abstract":"

    The device’s battery is greater than 20%.

    ","parent_name":"SCPBatteryStatus"},"Enums/SCPReaderNetworkStatus.html#/c:@E@SCPReaderNetworkStatus@SCPReaderNetworkStatusOffline":{"name":"SCPReaderNetworkStatusOffline","abstract":"

    The reader is offline. Note that Chipper 2x and WisePad 3 will always report","parent_name":"SCPReaderNetworkStatus"},"Enums/SCPReaderNetworkStatus.html#/c:@E@SCPReaderNetworkStatus@SCPReaderNetworkStatusOnline":{"name":"SCPReaderNetworkStatusOnline","abstract":"

    The reader is online.

    ","parent_name":"SCPReaderNetworkStatus"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageRetryCard":{"name":"SCPReaderDisplayMessageRetryCard","abstract":"

    Retry the presented card.

    ","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageInsertCard":{"name":"SCPReaderDisplayMessageInsertCard","abstract":"

    Insert the presented card.

    ","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageInsertOrSwipeCard":{"name":"SCPReaderDisplayMessageInsertOrSwipeCard","abstract":"

    Insert or swipe the presented card.

    ","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageSwipeCard":{"name":"SCPReaderDisplayMessageSwipeCard","abstract":"

    Swipe the presented card.

    ","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageRemoveCard":{"name":"SCPReaderDisplayMessageRemoveCard","abstract":"

    Remove the presented card.

    ","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageMultipleContactlessCardsDetected":{"name":"SCPReaderDisplayMessageMultipleContactlessCardsDetected","abstract":"

    The reader detected multiple contactless cards. Make sure only one","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageTryAnotherReadMethod":{"name":"SCPReaderDisplayMessageTryAnotherReadMethod","abstract":"

    The card could not be read. Try another read method on the same card, or","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderDisplayMessage.html#/c:@E@SCPReaderDisplayMessage@SCPReaderDisplayMessageTryAnotherCard":{"name":"SCPReaderDisplayMessageTryAnotherCard","abstract":"

    The card is invalid. Try another card.

    ","parent_name":"SCPReaderDisplayMessage"},"Enums/SCPReaderInputOptions.html#/c:@E@SCPReaderInputOptions@SCPReaderInputOptionNone":{"name":"SCPReaderInputOptionNone","abstract":"

    No input options are available on the reader.

    ","parent_name":"SCPReaderInputOptions"},"Enums/SCPReaderInputOptions.html#/c:@E@SCPReaderInputOptions@SCPReaderInputOptionSwipeCard":{"name":"SCPReaderInputOptionSwipeCard","abstract":"

    Swipe a magstripe card.

    ","parent_name":"SCPReaderInputOptions"},"Enums/SCPReaderInputOptions.html#/c:@E@SCPReaderInputOptions@SCPReaderInputOptionInsertCard":{"name":"SCPReaderInputOptionInsertCard","abstract":"

    Insert a chip card.

    ","parent_name":"SCPReaderInputOptions"},"Enums/SCPReaderInputOptions.html#/c:@E@SCPReaderInputOptions@SCPReaderInputOptionTapCard":{"name":"SCPReaderInputOptionTapCard","abstract":"

    Tap a contactless card.

    ","parent_name":"SCPReaderInputOptions"},"Enums/SCPReaderEvent.html#/c:@E@SCPReaderEvent@SCPReaderEventCardInserted":{"name":"SCPReaderEventCardInserted","abstract":"

    A card was inserted.

    ","parent_name":"SCPReaderEvent"},"Enums/SCPReaderEvent.html#/c:@E@SCPReaderEvent@SCPReaderEventCardRemoved":{"name":"SCPReaderEventCardRemoved","abstract":"

    A card was removed.

    ","parent_name":"SCPReaderEvent"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didStartInstallingUpdate:cancelable:":{"name":"-localMobileReader:didStartInstallingUpdate:cancelable:","abstract":"

    The reader has started installing a software update.

    ","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didReportReaderSoftwareUpdateProgress:":{"name":"-localMobileReader:didReportReaderSoftwareUpdateProgress:","abstract":"

    The reader reported progress on a software update.

    ","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didFinishInstallingUpdate:error:":{"name":"-localMobileReader:didFinishInstallingUpdate:error:","abstract":"

    The reader has finished installing an update.

    ","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didRequestReaderInput:":{"name":"-localMobileReader:didRequestReaderInput:","abstract":"

    This method is called when the reader begins waiting for input.","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReader:didRequestReaderDisplayMessage:":{"name":"-localMobileReader:didRequestReaderDisplayMessage:","abstract":"

    This method is called to request that a prompt be displayed in your app.","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPLocalMobileReaderDelegate.html#/c:objc(pl)SCPLocalMobileReaderDelegate(im)localMobileReaderDidAcceptTermsOfService:":{"name":"-localMobileReaderDidAcceptTermsOfService:","abstract":"

    The reader is reporting that, as part of preparing to accept payments,","parent_name":"SCPLocalMobileReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didReportAvailableUpdate:":{"name":"-reader:didReportAvailableUpdate:","abstract":"

    The SDK is reporting that an update is available for the reader.","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didStartInstallingUpdate:cancelable:":{"name":"-reader:didStartInstallingUpdate:cancelable:","abstract":"

    The SDK is reporting that the reader has started installing a software update.

    ","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didReportReaderSoftwareUpdateProgress:":{"name":"-reader:didReportReaderSoftwareUpdateProgress:","abstract":"

    The reader reported progress on a software update.

    ","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didFinishInstallingUpdate:error:":{"name":"-reader:didFinishInstallingUpdate:error:","abstract":"

    The reader is reporting that an installation has finished. If the install was","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didRequestReaderInput:":{"name":"-reader:didRequestReaderInput:","abstract":"

    This method is called when the reader begins waiting for input. Your app","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didRequestReaderDisplayMessage:":{"name":"-reader:didRequestReaderDisplayMessage:","abstract":"

    This method is called to request that a prompt be displayed in your app.","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didReportReaderEvent:info:":{"name":"-reader:didReportReaderEvent:info:","abstract":"

    The SDK reported an event from the reader (e.g. a card was inserted).

    ","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)reader:didReportBatteryLevel:status:isCharging:":{"name":"-reader:didReportBatteryLevel:status:isCharging:","abstract":"

    The SDK reported the reader’s battery level or charging state has changed.

    ","parent_name":"SCPBluetoothReaderDelegate"},"Protocols/SCPBluetoothReaderDelegate.html#/c:objc(pl)SCPBluetoothReaderDelegate(im)readerDidReportLowBatteryWarning:":{"name":"-readerDidReportLowBatteryWarning:","abstract":"

    This method is called when the SDK’s currently connected reader has a low battery.

    ","parent_name":"SCPBluetoothReaderDelegate"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeChipper2X":{"name":"SCPDeviceTypeChipper2X","abstract":"

    The BBPOS Chipper 2X BT mobile reader.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeVerifoneP400":{"name":"SCPDeviceTypeVerifoneP400","abstract":"

    The Verifone P400 countertop reader.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeWisePad3":{"name":"SCPDeviceTypeWisePad3","abstract":"

    The BBPOS WisePad 3 mobile reader.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeStripeM2":{"name":"SCPDeviceTypeStripeM2","abstract":"

    The Stripe Reader M2 mobile reader.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeWisePosE":{"name":"SCPDeviceTypeWisePosE","abstract":"

    The BBPOS WisePOS E countertop reader.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeWisePosEDevKit":{"name":"SCPDeviceTypeWisePosEDevKit","abstract":"

    The BBPOS WisePOS E DevKit countertop reader.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeStripeS700":{"name":"SCPDeviceTypeStripeS700","abstract":"

    Stripe Reader S700.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeStripeS700DevKit":{"name":"SCPDeviceTypeStripeS700DevKit","abstract":"

    Stripe Reader S700 DevKit.

    ","parent_name":"SCPDeviceType"},"Enums/SCPDeviceType.html#/c:@E@SCPDeviceType@SCPDeviceTypeAppleBuiltIn":{"name":"SCPDeviceTypeAppleBuiltIn","abstract":"

    Apple Built-In reader.

    ","parent_name":"SCPDeviceType"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)deviceType":{"name":"deviceType","abstract":"

    The reader’s device type.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)simulated":{"name":"simulated","abstract":"

    True if this is a simulated reader.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)stripeId":{"name":"stripeId","abstract":"

    The Stripe unique identifier for the reader.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)locationId":{"name":"locationId","abstract":"

    The ID of the reader’s Location.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)locationStatus":{"name":"locationStatus","abstract":"

    Used to tell whether the location field has been set.","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)location":{"name":"location","abstract":"

    The details of the location this reader is registered to, if any.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)serialNumber":{"name":"serialNumber","abstract":"

    The reader’s serial number.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)deviceSoftwareVersion":{"name":"deviceSoftwareVersion","abstract":"

    The reader’s current device software version, or nil if this information is","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)availableUpdate":{"name":"availableUpdate","abstract":"

    The available update for this reader, or nil if no update is available.","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)batteryLevel":{"name":"batteryLevel","abstract":"

    The reader’s battery level, represented as a boxed float in the range [0, 1].","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)batteryStatus":{"name":"batteryStatus","abstract":"

    The reader’s battery status. Usable as a general classification for the current","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)isCharging":{"name":"isCharging","abstract":"

    The reader’s charging state, represented as a BOOL","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)ipAddress":{"name":"ipAddress","abstract":"

    The IP address of the reader.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)status":{"name":"status","abstract":"

    The networking status of the reader: either offline or online. Note that","parent_name":"SCPReader"},"Classes/SCPReader.html#/c:objc(cs)SCPReader(py)label":{"name":"label","abstract":"

    A custom label that may be given to a reader for easier identification.

    ","parent_name":"SCPReader"},"Classes/SCPReader.html":{"name":"SCPReader","abstract":"

    Information about a card reader that has been discovered by or connected to"},"Enums/SCPDeviceType.html":{"name":"SCPDeviceType","abstract":"

    The possible device types for a reader.

    "},"Protocols/SCPBluetoothReaderDelegate.html":{"name":"SCPBluetoothReaderDelegate","abstract":"

    Implement this protocol to handle a connected Bluetooth reader’s events throughout"},"Protocols/SCPLocalMobileReaderDelegate.html":{"name":"SCPLocalMobileReaderDelegate","abstract":"

    Implement this protocol to handle a connected local mobile reader’s events throughout"},"Enums/SCPReaderEvent.html":{"name":"SCPReaderEvent","abstract":"

    The possible events from a connected reader. Used by [SCPBluetoothReaderDelegate reader:didReportReaderEvent:info:].

    "},"Enums/SCPReaderInputOptions.html":{"name":"SCPReaderInputOptions","abstract":"

    This OptionSet represents all of the input methods available to your user when"},"Enums/SCPReaderDisplayMessage.html":{"name":"SCPReaderDisplayMessage","abstract":"

    The display messages that a reader may request be displayed by your app. Used by [SCPBluetoothReaderDelegate reader:didRequestReaderDisplayMessage:].

    "},"Enums/SCPReaderNetworkStatus.html":{"name":"SCPReaderNetworkStatus","abstract":"

    The possible networking statuses for a reader.

    "},"Enums/SCPBatteryStatus.html":{"name":"SCPBatteryStatus","abstract":"

    A categorization of a reader’s battery charge level.

    "},"Classes/SCPCart.html":{"name":"SCPCart","abstract":"

    An SCPCart object contains information about what line items are included in"},"Classes/SCPCartLineItem.html":{"name":"SCPCartLineItem","abstract":"

    Represents a single line item in an SCPCart, displayed on the reader’s screen"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeVisa":{"name":"SCPSimulatedCardTypeVisa","abstract":"

    Visa

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeVisaDebit":{"name":"SCPSimulatedCardTypeVisaDebit","abstract":"

    Visa (debit)

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeMastercard":{"name":"SCPSimulatedCardTypeMastercard","abstract":"

    Mastercard

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeMasterDebit":{"name":"SCPSimulatedCardTypeMasterDebit","abstract":"

    Mastercard (debit)

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeMastercardPrepaid":{"name":"SCPSimulatedCardTypeMastercardPrepaid","abstract":"

    Mastercard (prepaid)

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeAmex":{"name":"SCPSimulatedCardTypeAmex","abstract":"

    American Express

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeAmex2":{"name":"SCPSimulatedCardTypeAmex2","abstract":"

    American Express

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeDiscover":{"name":"SCPSimulatedCardTypeDiscover","abstract":"

    Discover

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeDiscover2":{"name":"SCPSimulatedCardTypeDiscover2","abstract":"

    Discover

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeDiners":{"name":"SCPSimulatedCardTypeDiners","abstract":"

    Diners Club

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeDiners14Digit":{"name":"SCPSimulatedCardTypeDiners14Digit","abstract":"

    Diners Club (14 digit card)

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeJcb":{"name":"SCPSimulatedCardTypeJcb","abstract":"

    JCB

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeUnionPay":{"name":"SCPSimulatedCardTypeUnionPay","abstract":"

    UnionPay

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeInterac":{"name":"SCPSimulatedCardTypeInterac","abstract":"

    Interac

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeEftposAuDebit":{"name":"SCPSimulatedCardTypeEftposAuDebit","abstract":"

    Eftpos Australia

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeEftposAuVisaDebit":{"name":"SCPSimulatedCardTypeEftposAuVisaDebit","abstract":"

    Eftpos Australia/Visa

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeEftposAuDebitMastercard":{"name":"SCPSimulatedCardTypeEftposAuDebitMastercard","abstract":"

    Eftpos Australia/Mastercard

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclined":{"name":"SCPSimulatedCardTypeChargeDeclined","abstract":"

    Charge is declined with a card_declined code.

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedInsufficientFunds":{"name":"SCPSimulatedCardTypeChargeDeclinedInsufficientFunds","abstract":"

    Charge is declined with a card_declined code. The decline_code","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedLostCard":{"name":"SCPSimulatedCardTypeChargeDeclinedLostCard","abstract":"

    Charge is declined with a card_declined code. The decline_code","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedStolenCard":{"name":"SCPSimulatedCardTypeChargeDeclinedStolenCard","abstract":"

    Charge is declined with a card_declined code. The decline_code","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedExpiredCard":{"name":"SCPSimulatedCardTypeChargeDeclinedExpiredCard","abstract":"

    Charge is declined with an expired_card code.

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeChargeDeclinedProcessingError":{"name":"SCPSimulatedCardTypeChargeDeclinedProcessingError","abstract":"

    Charge is declined with a processing_error code.

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeRefundFailed":{"name":"SCPSimulatedCardTypeRefundFailed","abstract":"

    Refund is declined with a refund_fail error.

    ","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeOnlinePinCvm":{"name":"SCPSimulatedCardTypeOnlinePinCvm","abstract":"

    Payment attaches Online Pin to the transaction.","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeOnlinePinScaRetry":{"name":"SCPSimulatedCardTypeOnlinePinScaRetry","abstract":"

    This flow simulates an Online Pin scenario with SCA compliance.","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeOfflinePinCvm":{"name":"SCPSimulatedCardTypeOfflinePinCvm","abstract":"

    Payment attaches Offline Pin to the transaction.","parent_name":"SCPSimulatedCardType"},"Enums/SCPSimulatedCardType.html#/c:@E@SCPSimulatedCardType@SCPSimulatedCardTypeOfflinePinScaRetry":{"name":"SCPSimulatedCardTypeOfflinePinScaRetry","abstract":"

    This flow simulates an Offline Pin scenario with SCA compliance.","parent_name":"SCPSimulatedCardType"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)initWithType:":{"name":"-initWithType:","abstract":"

    Create a Simulated Card object with a given simulated card type.

    ","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)initWithTestCardNumber:":{"name":"-initWithTestCardNumber:","abstract":"

    Create a Simulated Card object with a raw card number. This initializer is","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)init":{"name":"-init","abstract":"

    You cannot instantiate this class without specifying a type or testcard number.

    ","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)isOnlinePin":{"name":"-isOnlinePin","abstract":"

    Returns true if the card is online pin enabled.

    ","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(im)isOfflinePin":{"name":"-isOfflinePin","abstract":"

    Returns true if the card is offline pin enabled.

    ","parent_name":"SCPSimulatedCard"},"Classes/SCPSimulatedCard.html#/c:objc(cs)SCPSimulatedCard(cm)new":{"name":"+new","abstract":"

    You cannot instantiate this class without specifying a type or testcard number.

    ","parent_name":"SCPSimulatedCard"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateAvailable":{"name":"SCPSimulateReaderUpdateAvailable","abstract":"

    Default value.

    ","parent_name":"SCPSimulateReaderUpdate"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateNone":{"name":"SCPSimulateReaderUpdateNone","abstract":"

    No updates are available

    ","parent_name":"SCPSimulateReaderUpdate"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateRequired":{"name":"SCPSimulateReaderUpdateRequired","abstract":"

    A required full reader software update exists. Use this to simulate the","parent_name":"SCPSimulateReaderUpdate"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateLowBattery":{"name":"SCPSimulateReaderUpdateLowBattery","abstract":"

    A required update exists.

    ","parent_name":"SCPSimulateReaderUpdate"},"Enums/SCPSimulateReaderUpdate.html#/c:@E@SCPSimulateReaderUpdate@SCPSimulateReaderUpdateRandom":{"name":"SCPSimulateReaderUpdateRandom","abstract":"

    Randomly picks a type of update for the reader to help exercise the","parent_name":"SCPSimulateReaderUpdate"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(py)availableReaderUpdate":{"name":"availableReaderUpdate","abstract":"

    Set this to different values of the SCPSimulateReaderUpdate enum to","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(py)simulatedCard":{"name":"simulatedCard","abstract":"

    Create a SCPSimulatedCard and set it on the shared configuration object to","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(py)simulatedTipAmount":{"name":"simulatedTipAmount","abstract":"

    Set this to simulate a Terminal configuration object with this fixed tip","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPSimulatorConfiguration.html#/c:objc(cs)SCPSimulatorConfiguration(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.","parent_name":"SCPSimulatorConfiguration"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)city":{"name":"city","abstract":"

    The city name

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)country":{"name":"country","abstract":"

    The country code

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)line1":{"name":"line1","abstract":"

    The first line of the address

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)line2":{"name":"line2","abstract":"

    The second line of the address

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)postalCode":{"name":"postalCode","abstract":"

    The postal code of the address

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(py)state":{"name":"state","abstract":"

    The state of the address

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPAddress"},"Classes/SCPAddress.html#/c:objc(cs)SCPAddress(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPAddress"},"Enums/SCPLocationStatus.html#/c:@E@SCPLocationStatus@SCPLocationStatusUnknown":{"name":"SCPLocationStatusUnknown","abstract":"

    The location is not known. location will be nil.

    ","parent_name":"SCPLocationStatus"},"Enums/SCPLocationStatus.html#/c:@E@SCPLocationStatus@SCPLocationStatusSet":{"name":"SCPLocationStatusSet","abstract":"

    The location was successfully set to a known location.","parent_name":"SCPLocationStatus"},"Enums/SCPLocationStatus.html#/c:@E@SCPLocationStatus@SCPLocationStatusNotSet":{"name":"SCPLocationStatusNotSet","abstract":"

    This location is known to be not set. location will be nil.

    ","parent_name":"SCPLocationStatus"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)stripeId":{"name":"stripeId","abstract":"

    The ID of the Location

    ","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)address":{"name":"address","abstract":"

    The address of this Location

    ","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)displayName":{"name":"displayName","abstract":"

    The display name of this Location

    ","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)livemode":{"name":"livemode","abstract":"

    Whether this Location was created in livemode

    ","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(py)metadata":{"name":"metadata","abstract":"

    Any metadata attached to this Location

    ","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(im)init":{"name":"-init","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPLocation"},"Classes/SCPLocation.html#/c:objc(cs)SCPLocation(cm)new":{"name":"+new","abstract":"

    You cannot directly instantiate this class.

    ","parent_name":"SCPLocation"},"Classes/SCPListLocationsParameters.html#/c:objc(cs)SCPListLocationsParameters(py)limit":{"name":"limit","abstract":"

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    ","parent_name":"SCPListLocationsParameters"},"Classes/SCPListLocationsParameters.html#/c:objc(cs)SCPListLocationsParameters(py)endingBefore":{"name":"endingBefore","abstract":"

    A cursor for use in pagination. ending_before is an object ID that defines","parent_name":"SCPListLocationsParameters"},"Classes/SCPListLocationsParameters.html#/c:objc(cs)SCPListLocationsParameters(py)startingAfter":{"name":"startingAfter","abstract":"

    A cursor for use in pagination. starting_after is an object ID that defines","parent_name":"SCPListLocationsParameters"},"Classes/SCPListLocationsParameters.html#/c:objc(cs)SCPListLocationsParameters(im)initWithLimit:endingBefore:startingAfter:":{"name":"-initWithLimit:endingBefore:startingAfter:","abstract":"

    Initializes SCPListLocationsParameters with the given parameters.

    ","parent_name":"SCPListLocationsParameters"},"Enums/SCPConnectionStatus.html#/c:@E@SCPConnectionStatus@SCPConnectionStatusNotConnected":{"name":"SCPConnectionStatusNotConnected","abstract":"

    The SDK is not connected to a reader.

    ","parent_name":"SCPConnectionStatus"},"Enums/SCPConnectionStatus.html#/c:@E@SCPConnectionStatus@SCPConnectionStatusConnected":{"name":"SCPConnectionStatusConnected","abstract":"

    The SDK is connected to a reader.

    ","parent_name":"SCPConnectionStatus"},"Enums/SCPConnectionStatus.html#/c:@E@SCPConnectionStatus@SCPConnectionStatusConnecting":{"name":"SCPConnectionStatusConnecting","abstract":"

    The SDK is currently connecting to a reader.

    ","parent_name":"SCPConnectionStatus"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(py)locationId":{"name":"locationId","abstract":"

    The ID of the Location which the reader should be","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(py)onBehalfOf":{"name":"onBehalfOf","abstract":"

    If your integration is creating destination charges and using on_behalf_of, you must provide the","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(py)merchantDisplayName":{"name":"merchantDisplayName","abstract":"

    Optional cardholder facing merchant display name that will be used in the prompt for the cardholder","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(py)tosAcceptancePermitted":{"name":"tosAcceptancePermitted","abstract":"

    In order to connect to a reader, merchant-specific terms of service may need to be accepted.","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(im)initWithLocationId:":{"name":"-initWithLocationId:","abstract":"

    Initialize ConnectionConfiguration with a location ID.

    ","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(im)initWithLocationId:merchantDisplayName:onBehalfOf:":{"name":"-initWithLocationId:merchantDisplayName:onBehalfOf:","abstract":"

    Initialize ConnectionConfiguration with a location ID, custom merchant display name, and ‘on behalf of’","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPLocalMobileConnectionConfiguration.html#/c:objc(cs)SCPLocalMobileConnectionConfiguration(im)initWithLocationId:merchantDisplayName:onBehalfOf:tosAcceptancePermitted:":{"name":"-initWithLocationId:merchantDisplayName:onBehalfOf:tosAcceptancePermitted:","abstract":"

    Initialize ConnectionConfiguration with a location ID, custom merchant display name, ‘on behalf of’","parent_name":"SCPLocalMobileConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(py)failIfInUse":{"name":"failIfInUse","abstract":"

    When set to true, the connection will automatically error if the reader is already","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(py)allowCustomerCancel":{"name":"allowCustomerCancel","abstract":"

    If set to true, the customer will be able to press the red X button on the","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(im)initWithFailIfInUse:allowCustomerCancel:":{"name":"-initWithFailIfInUse:allowCustomerCancel:","abstract":"

    Initialize an InternetConnectionConfiguration object with all possible properties.

    ","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(im)initWithFailIfInUse:":{"name":"-initWithFailIfInUse:","abstract":"

    Initalize an InternetConnectionConfiguration object and set the failIfInUse","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPInternetConnectionConfiguration.html#/c:objc(cs)SCPInternetConnectionConfiguration(im)initWithAllowCustomerCancel:":{"name":"-initWithAllowCustomerCancel:","abstract":"

    Initialize an InternetConnectionConfiguration object and set the","parent_name":"SCPInternetConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(py)locationId":{"name":"locationId","abstract":"

    The ID of the Location which the reader should be registered to during connection.

    ","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(py)autoReconnectOnUnexpectedDisconnect":{"name":"autoReconnectOnUnexpectedDisconnect","abstract":"

    When set to true, the Terminal SDK will attempt a Bluetooth auto-reconnection on any unexpected disconnect.","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(py)autoReconnectionDelegate":{"name":"autoReconnectionDelegate","abstract":"

    Contains callback methods for Bluetooth auto-reconnection.

    ","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(im)initWithLocationId:":{"name":"-initWithLocationId:","abstract":"

    Initialize your connect options with a location ID.

    ","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPBluetoothConnectionConfiguration.html#/c:objc(cs)SCPBluetoothConnectionConfiguration(im)initWithLocationId:autoReconnectOnUnexpectedDisconnect:autoReconnectionDelegate:":{"name":"-initWithLocationId:autoReconnectOnUnexpectedDisconnect:autoReconnectionDelegate:","abstract":"

    Initialize your connect options with a location ID and an expected behavior for unexpected disconnects.

    ","parent_name":"SCPBluetoothConnectionConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(im)initWithDiscoveryMethod:simulated:":{"name":"-initWithDiscoveryMethod:simulated:","abstract":"

    Initializes a discovery configuration with the given discovery method. All discoverable readers","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(im)initWithDiscoveryMethod:locationId:simulated:":{"name":"-initWithDiscoveryMethod:locationId:simulated:","abstract":"

    This variant of the initializer lets you specify a Location to filter the","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(py)timeout":{"name":"timeout","abstract":"

    The timeout (in seconds) after which discoverReaders: should fail. If the","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(py)discoveryMethod":{"name":"discoveryMethod","abstract":"

    The method by which to discover readers.

    ","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(py)simulated":{"name":"simulated","abstract":"

    Whether to use simulated discovery to discover a device simulator.

    ","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(py)locationId":{"name":"locationId","abstract":"

    A location ID that can be used to filter discovery result so only readers","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(im)init":{"name":"-init","abstract":"

    Use initWithDiscoveryMethod:simulated:

    ","parent_name":"SCPDiscoveryConfiguration"},"Classes/SCPDiscoveryConfiguration.html#/c:objc(cs)SCPDiscoveryConfiguration(cm)new":{"name":"+new","abstract":"

    Use initWithDiscoveryMethod:simulated:

    ","parent_name":"SCPDiscoveryConfiguration"},"Protocols/SCPDiscoveryDelegate.html#/c:objc(pl)SCPDiscoveryDelegate(im)terminal:didUpdateDiscoveredReaders:":{"name":"-terminal:didUpdateDiscoveredReaders:","abstract":"

    This method will be called repeatedly until:

    ","parent_name":"SCPDiscoveryDelegate"},"Enums/SCPDiscoveryMethod.html#/c:@E@SCPDiscoveryMethod@SCPDiscoveryMethodBluetoothScan":{"name":"SCPDiscoveryMethodBluetoothScan","abstract":"

    The Bluetooth Scan discovery method searches for Stripe Terminal’s","parent_name":"SCPDiscoveryMethod"},"Enums/SCPDiscoveryMethod.html#/c:@E@SCPDiscoveryMethod@SCPDiscoveryMethodBluetoothProximity":{"name":"SCPDiscoveryMethodBluetoothProximity","abstract":"

    The Bluetooth Proximity discovery method searches for a subset of","parent_name":"SCPDiscoveryMethod"},"Enums/SCPDiscoveryMethod.html#/c:@E@SCPDiscoveryMethod@SCPDiscoveryMethodInternet":{"name":"SCPDiscoveryMethodInternet","abstract":"

    The Internet discovery method searches for internet-connected readers,","parent_name":"SCPDiscoveryMethod"},"Enums/SCPDiscoveryMethod.html#/c:@E@SCPDiscoveryMethod@SCPDiscoveryMethodLocalMobile":{"name":"SCPDiscoveryMethodLocalMobile","abstract":"

    The Local Mobile discovery method searches for any readers built into the","parent_name":"SCPDiscoveryMethod"},"Enums/SCPDiscoveryMethod.html":{"name":"SCPDiscoveryMethod","abstract":"

    The possible methods for discovering a reader. Pass a variant of this enum"},"Protocols/SCPDiscoveryDelegate.html":{"name":"SCPDiscoveryDelegate","abstract":"

    Implement this protocol to handle a continually updating list"},"Classes/SCPDiscoveryConfiguration.html":{"name":"SCPDiscoveryConfiguration","abstract":"

    Configuration options for discovering readers.

    "},"Classes/SCPBluetoothConnectionConfiguration.html":{"name":"SCPBluetoothConnectionConfiguration","abstract":"

    This class lets you define Bluetooth reader connection options.

    "},"Classes/SCPInternetConnectionConfiguration.html":{"name":"SCPInternetConnectionConfiguration","abstract":"

    This class lets you set options that define internet reader behavior throughout a given"},"Classes/SCPLocalMobileConnectionConfiguration.html":{"name":"SCPLocalMobileConnectionConfiguration","abstract":"

    This class lets you set options that define local mobile reader behavior throughout a given"},"Enums/SCPConnectionStatus.html":{"name":"SCPConnectionStatus","abstract":"

    The possible reader connection statuses for the SDK.

    "},"Classes/SCPListLocationsParameters.html":{"name":"SCPListLocationsParameters","abstract":"

    Parameters to be used when calling Terminal.shared.listLocations() to list"},"Classes/SCPLocation.html":{"name":"SCPLocation","abstract":"

    A Location is used to group readers in the Stripe Terminal ecosystem. The"},"Enums/SCPLocationStatus.html":{"name":"SCPLocationStatus","abstract":"

    Represents the possible states of the location object for a"},"Classes/SCPAddress.html":{"name":"SCPAddress","abstract":"

    Holds address data associated with a given SCPLocation.

    "},"Classes/SCPSimulatorConfiguration.html":{"name":"SCPSimulatorConfiguration","abstract":"

    Simulator specific configurations you can set to test your integration’s"},"Enums/SCPSimulateReaderUpdate.html":{"name":"SCPSimulateReaderUpdate","abstract":"

    Enum used to simulate various types of reader updates being available for"},"Classes/SCPSimulatedCard.html":{"name":"SCPSimulatedCard","abstract":"

    Simulated Card objects can be used with the shared SCPSimulatorConfiguration"},"Enums/SCPSimulatedCardType.html":{"name":"SCPSimulatedCardType","abstract":"

    Enum used to simulate various types of cards and error cases.

    "},"Protocols/SCPJSONDecodable.html#/c:objc(pl)SCPJSONDecodable(cm)decodedObjectFromJSON:":{"name":"+decodedObjectFromJSON:","abstract":"

    Parses a JSON dictionary into an instance of the class. Returns nil if the","parent_name":"SCPJSONDecodable"},"Protocols/SCPJSONDecodable.html#/c:objc(pl)SCPJSONDecodable(py)originalJSON":{"name":"originalJSON","abstract":"

    The raw JSON used to create the object. This may be useful for accessing","parent_name":"SCPJSONDecodable"},"Classes/SCPCancelable.html#/c:objc(cs)SCPCancelable(py)completed":{"name":"completed","abstract":"

    Indicates whether the command has completed. After the command has completed,","parent_name":"SCPCancelable"},"Classes/SCPCancelable.html#/c:objc(cs)SCPCancelable(im)cancel:":{"name":"-cancel:","abstract":"

    Attempts to cancel the action in progress. If the action could not be canceled,","parent_name":"SCPCancelable"},"Enums/SCPLogLevel.html#/c:@E@SCPLogLevel@SCPLogLevelNone":{"name":"SCPLogLevelNone","abstract":"

    No logs will printed to the console.

    ","parent_name":"SCPLogLevel"},"Enums/SCPLogLevel.html#/c:@E@SCPLogLevel@SCPLogLevelVerbose":{"name":"SCPLogLevelVerbose","abstract":"

    Verbose logs will be printed to the console.

    ","parent_name":"SCPLogLevel"},"Protocols/SCPReconnectionDelegate.html#/c:objc(pl)SCPReconnectionDelegate(im)terminal:didStartReaderReconnect:":{"name":"-terminal:didStartReaderReconnect:","abstract":"

    The reader has lost Bluetooth connection to the SDK and reconnection attempts have been started.

    ","parent_name":"SCPReconnectionDelegate"},"Protocols/SCPReconnectionDelegate.html#/c:objc(pl)SCPReconnectionDelegate(im)terminalDidSucceedReaderReconnect:":{"name":"-terminalDidSucceedReaderReconnect:","abstract":"

    The SDK was able to reconnect to the previously connected Bluetooth reader.

    ","parent_name":"SCPReconnectionDelegate"},"Protocols/SCPReconnectionDelegate.html#/c:objc(pl)SCPReconnectionDelegate(im)terminalDidFailReaderReconnect:":{"name":"-terminalDidFailReaderReconnect:","abstract":"

    The SDK was not able to reconnect to the previously connected bluetooth reader. The SDK is now disconnected from any readers.

    ","parent_name":"SCPReconnectionDelegate"},"Protocols/SCPTerminalDelegate.html#/c:objc(pl)SCPTerminalDelegate(im)terminal:didReportUnexpectedReaderDisconnect:":{"name":"-terminal:didReportUnexpectedReaderDisconnect:","abstract":"

    The reader disconnected unexpectedly (that is, without your app explicitly","parent_name":"SCPTerminalDelegate"},"Protocols/SCPTerminalDelegate.html#/c:objc(pl)SCPTerminalDelegate(im)terminal:didChangeConnectionStatus:":{"name":"-terminal:didChangeConnectionStatus:","abstract":"

    The currently connected reader’s connectionStatus changed.

    ","parent_name":"SCPTerminalDelegate"},"Protocols/SCPTerminalDelegate.html#/c:objc(pl)SCPTerminalDelegate(im)terminal:didChangePaymentStatus:":{"name":"-terminal:didChangePaymentStatus:","abstract":"

    The currently connected reader’s paymentStatus changed.

    ","parent_name":"SCPTerminalDelegate"},"Protocols/SCPConnectionTokenProvider.html#/c:objc(pl)SCPConnectionTokenProvider(im)fetchConnectionToken:":{"name":"-fetchConnectionToken:","abstract":"

    Fetches a connection token from your backend server.

    ","parent_name":"SCPConnectionTokenProvider"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)setTokenProvider:":{"name":"+setTokenProvider:","abstract":"

    Sets the token provider for the shared (singleton) SCPTerminal instance.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)hasTokenProvider":{"name":"+hasTokenProvider","abstract":"

    Returns true if a token provider has been set, through setTokenProvider:

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)setLogListener:":{"name":"+setLogListener:","abstract":"

    Sets a block to listen for logs from the shared Terminal instance (optional).

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cpy)shared":{"name":"shared","abstract":"

    Returns the shared (singleton) Terminal instance.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)delegate":{"name":"delegate","abstract":"

    The Terminal singleton object’s primary delegate. This delegate announces","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)connectedReader":{"name":"connectedReader","abstract":"

    Information about the connected SCPReader, or nil if no reader is connected.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)connectionStatus":{"name":"connectionStatus","abstract":"

    The Terminal instance’s current connection status.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)logLevel":{"name":"logLevel","abstract":"

    The log level for the SDK. The default value is .none.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)simulatorConfiguration":{"name":"simulatorConfiguration","abstract":"

    The simulator configuration settings that will be used when connecting to","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(py)paymentStatus":{"name":"paymentStatus","abstract":"

    The Terminal instance’s current payment status.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)clearCachedCredentials":{"name":"-clearCachedCredentials","abstract":"

    Clears the current connection token, saved reader sessions, and any other","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)supportsReadersOfType:discoveryMethod:simulated:error:":{"name":"-supportsReadersOfType:discoveryMethod:simulated:error:","abstract":"

    Use this method to determine whether the mobile device supports a given reader type","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)discoverReaders:delegate:completion:":{"name":"-discoverReaders:delegate:completion:","abstract":"

    Begins discovering readers based on the given discovery configuration.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)connectBluetoothReader:delegate:connectionConfig:completion:":{"name":"-connectBluetoothReader:delegate:connectionConfig:completion:","abstract":"

    Attempts to connect to the given Bluetooth reader with a given connection","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)connectInternetReader:connectionConfig:completion:":{"name":"-connectInternetReader:connectionConfig:completion:","abstract":"

    Attempts to connect to the given Internet reader with a given connection","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)connectLocalMobileReader:delegate:connectionConfig:completion:":{"name":"-connectLocalMobileReader:delegate:connectionConfig:completion:","abstract":"

    Attempts to connect to the given Local Mobile reader with a given","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)listLocations:completion:":{"name":"-listLocations:completion:","abstract":"

    Retrieves a list of SCPLocation objects belonging to your merchant. You must specify","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)installAvailableUpdate":{"name":"-installAvailableUpdate","abstract":"

    Installs the available update for the connected reader.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)disconnectReader:":{"name":"-disconnectReader:","abstract":"

    Attempts to disconnect from the currently connected reader.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)createPaymentIntent:completion:":{"name":"-createPaymentIntent:completion:","abstract":"

    Creates a new SCPPaymentIntent with the given parameters.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)retrievePaymentIntent:completion:":{"name":"-retrievePaymentIntent:completion:","abstract":"

    Retrieves a SCPPaymentIntent with a client secret.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectPaymentMethod:completion:":{"name":"-collectPaymentMethod:completion:","abstract":"

    Collects a payment method for the given SCPPaymentIntent.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectPaymentMethod:collectConfig:completion:":{"name":"-collectPaymentMethod:collectConfig:completion:","abstract":"

    Collects a payment method for the given PaymentIntent, with the specified configuration.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)processPayment:completion:":{"name":"-processPayment:completion:","abstract":"

    Processes a payment after collecting a payment method succeeds.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)cancelPaymentIntent:completion:":{"name":"-cancelPaymentIntent:completion:","abstract":"

    Cancels an SCPPaymentIntent.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)readReusableCard:completion:":{"name":"-readReusableCard:completion:","abstract":"

    Reads a card with the given parameters and returns a PaymentMethod.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)createSetupIntent:completion:":{"name":"-createSetupIntent:completion:","abstract":"

    Creates a new SCPSetupIntent with the given parameters.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)retrieveSetupIntent:completion:":{"name":"-retrieveSetupIntent:completion:","abstract":"

    Retrieves an SCPSetupIntent with a client secret.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)cancelSetupIntent:completion:":{"name":"-cancelSetupIntent:completion:","abstract":"

    Cancels an SCPPaymentIntent.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectSetupIntentPaymentMethod:customerConsentCollected:completion:":{"name":"-collectSetupIntentPaymentMethod:customerConsentCollected:completion:","abstract":"

    Collects a payment method for the given SCPSetupIntent.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)confirmSetupIntent:completion:":{"name":"-confirmSetupIntent:completion:","abstract":"

    Confirms a SetupIntent after the payment method has been successfully collected.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)collectRefundPaymentMethod:completion:":{"name":"-collectRefundPaymentMethod:completion:","abstract":"

    Initiates an in-person refund with a given set of SCPRefundParameters by","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)processRefund:":{"name":"-processRefund:","abstract":"

    Processes an in-person refund after the refund payment method has been collected.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)clearReaderDisplay:":{"name":"-clearReaderDisplay:","abstract":"

    Clears the reader display and resets it to the splash screen.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)setReaderDisplay:completion:":{"name":"-setReaderDisplay:completion:","abstract":"

    Updates the reader display with cart information.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromReaderInputOptions:":{"name":"+stringFromReaderInputOptions:","abstract":"

    Returns an unlocalized string for the given reader input options, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromReaderDisplayMessage:":{"name":"+stringFromReaderDisplayMessage:","abstract":"

    Returns an unlocalized string for the given reader display message, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromReaderEvent:":{"name":"+stringFromReaderEvent:","abstract":"

    Returns an unlocalized string for the given reader event, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromConnectionStatus:":{"name":"+stringFromConnectionStatus:","abstract":"

    Returns an unlocalized string for the given connection status, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromPaymentStatus:":{"name":"+stringFromPaymentStatus:","abstract":"

    Returns an unlocalized string for the given payment status, e.g.","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromDeviceType:":{"name":"+stringFromDeviceType:","abstract":"

    Returns an unlocalized string for the given device type.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromDiscoveryMethod:":{"name":"+stringFromDiscoveryMethod:","abstract":"

    Returns an unlocalized string for the given discovery method.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromCardBrand:":{"name":"+stringFromCardBrand:","abstract":"

    Returns an unlocalized string for the given card brand.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromPaymentIntentStatus:":{"name":"+stringFromPaymentIntentStatus:","abstract":"

    Returns an unlocalized string for the given payment intent status.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)stringFromCaptureMethod:":{"name":"+stringFromCaptureMethod:","abstract":"

    Returns an unlocalized string for the given capture method.

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(im)init":{"name":"-init","abstract":"

    Use initWithConfiguration:tokenProvider:delegate:

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html#/c:objc(cs)SCPTerminal(cm)new":{"name":"+new","abstract":"

    Use initWithConfiguration:tokenProvider:delegate:

    ","parent_name":"SCPTerminal"},"Classes/SCPTerminal.html":{"name":"SCPTerminal","abstract":"

    The SCPTerminal singleton object exposes an interface for discovering readers,"},"Protocols/SCPConnectionTokenProvider.html":{"name":"SCPConnectionTokenProvider","abstract":"

    Before integrating the SDK, you should create an endpoint on your backend"},"Protocols/SCPTerminalDelegate.html":{"name":"SCPTerminalDelegate","abstract":"

    Implement this protocol to handle connection and payment updates from the"},"Protocols/SCPReconnectionDelegate.html":{"name":"SCPReconnectionDelegate","abstract":"

    Implement this protocol to handle bluetooth auto-reconnection.

    "},"Enums/SCPLogLevel.html":{"name":"SCPLogLevel","abstract":"

    The various log levels for the SDK.

    "},"Classes/SCPCancelable.html":{"name":"SCPCancelable","abstract":"

    An object representing an action that can be canceled.

    "},"Protocols/SCPJSONDecodable.html":{"name":"SCPJSONDecodable","abstract":"

    Objects conforming to this protocol can be instantiated by decoding a JSON"},"Terminal.html#/c:SCPTerminal.h@SCPSDKVersion":{"name":"SCPSDKVersion","abstract":"

    The current version of this library.

    "},"Terminal.html":{"name":"Terminal"},"Reader%20Discovery%20%26%20Connection.html":{"name":"Reader Discovery & Connection"},"Reader.html":{"name":"Reader"},"Reader%20Updates.html":{"name":"Reader Updates"},"Payment.html":{"name":"Payment"},"Card-Present%20Refunds.html":{"name":"Card-Present Refunds"},"Saving%20Cards.html":{"name":"Saving Cards"},"Errors.html":{"name":"Errors"},"Blocks.html":{"name":"Blocks"}} \ No newline at end of file diff --git a/docs/docs/undocumented.json b/docs/docs/undocumented.json index c82f45f3..fea92eee 100644 --- a/docs/docs/undocumented.json +++ b/docs/docs/undocumented.json @@ -2,5 +2,5 @@ "warnings": [ ], - "source_directory": "/Users/bric/stripe/terminal/historic" + "source_directory": "/Users/mindy/stripe/stripe-terminal-ios" } \ No newline at end of file