Reader Discovery & Connection
-
The possible methods for discovering a reader. Pass a variant of this enum into your
See moreSCPDiscoveryConfiguration
.Declaration
Objective-C
enum SCPDiscoveryMethod : NSUInteger {}
Swift
enum DiscoveryMethod : UInt, @unchecked Sendable
-
Implement this protocol to handle a continually updating list of discovered readers. You must pass an
See moreSCPDiscoveryDelegate
when calling-[SCPTerminal discoverReaders:delegate:completion:]
.Declaration
Objective-C
@protocol SCPDiscoveryDelegate <NSObject>
Swift
protocol DiscoveryDelegate : NSObjectProtocol
-
Configuration options for discovering readers.
Objects of this type get passed into the
See moreTerminal.shared.discoverReaders()
method to control which devices get discovered, and how.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
See moreTerminal.shared.connectBluetoothReader()
.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 moreDeclaration
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 moreDeclaration
Objective-C
@interface SCPLocalMobileConnectionConfiguration : SCPConnectionConfiguration
Swift
class LocalMobileConnectionConfiguration : ConnectionConfiguration
-
The possible reader connection statuses for the SDK.
See moreDeclaration
Objective-C
enum SCPConnectionStatus : NSUInteger {}
Swift
enum ConnectionStatus : UInt, @unchecked Sendable
-
Parameters to be used when calling
See moreTerminal.shared.listLocations()
to list the Location objects associated with an account.Declaration
Objective-C
@interface SCPListLocationsParameters : NSObject
Swift
class ListLocationsParameters : NSObject
-
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
See moreTerminal.shared.listLocations()
.Declaration
Objective-C
@interface SCPLocation : NSObject <SCPJSONDecodable>
Swift
class Location : 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 anaddress
property on anSCPLocation
object retrieved by the SDK.See
SCPLocation
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
See moreSCPTerminal.shared.simulatorConfiguration
.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 moreDeclaration
Objective-C
enum SCPSimulateReaderUpdate : NSUInteger {}
Swift
enum SimulateReaderUpdate : UInt, @unchecked Sendable
-
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
See moreSCPSimulatedCardType
enum that automatically maps to the card numbers for convenience.Declaration
Objective-C
@interface SCPSimulatedCard : NSObject
Swift
class SimulatedCard : NSObject
-
Enum used to simulate various types of cards and error cases.
See moreDeclaration
Objective-C
enum SCPSimulatedCardType : NSUInteger {}
Swift
enum SimulatedCardType : UInt, @unchecked Sendable