Reader

  • Information about a reader that has been discovered or connected to the SDK. Note some of the properties are specific to a certain device type and are labeled as such. If a property does not call out a specific device then it is applicable to all device types.

    See more

    Declaration

    Objective-C

    
    @interface SCPReader : NSObject <SCPJSONDecodable>

    Swift

    class Reader : NSObject, JSONDecodable
  • You must implement this protocol to handle displaying events when connected to a bluetooth reader (e.g., the BBPOS Chipper 2X BT or BBPOS WisePad 3).

    The Verifone P400 has a built-in display, which handles displaying card and payment events to the customer. The Stripe Terminal iOS SDK will not call SCPReaderDisplayDelegate methods while connected to the Verifone P400.

    If you implement this protocol, the object that implements this protocol should get passed into [SCPTerminal collectPaymentMethod:delegate:completion] or [SCPTerminal readReusableCard:delegate:completion].

    See more

    Declaration

    Objective-C

    @protocol SCPReaderDisplayDelegate <NSObject>

    Swift

    protocol ReaderDisplayDelegate : NSObjectProtocol
  • This represents all of the input methods available to your user when the reader begins waiting for input.

    See more

    Declaration

    Objective-C

    enum SCPReaderInputOptions {}

    Swift

    struct ReaderInputOptions : OptionSet
  • The display messages that a reader may request be displayed by your app.

    See more

    Declaration

    Objective-C

    enum SCPReaderDisplayMessage {}

    Swift

    enum ReaderDisplayMessage : UInt
  • The possible events from a connected reader.

    See more

    Declaration

    Objective-C

    enum SCPReaderEvent {}
  • The possible device types for a reader.

    See more

    Declaration

    Objective-C

    enum SCPReaderNetworkStatus {}
  • 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 more

    Declaration

    Objective-C

    
    @interface SCPDiscoveryConfiguration : NSObject

    Swift

    class DiscoveryConfiguration : NSObject
  • The possible device types for a reader.

    See more

    Declaration

    Objective-C

    enum SCPDeviceType {}

    Swift

    enum DeviceType : UInt
  • The possible methods for discovering a reader.

    See more

    Declaration

    Objective-C

    enum SCPDiscoveryMethod {}
  • Implement this protocol to handle a continually updating list of discovered readers. You must pass an SCPDiscoveryDelegate when calling -[SCPTerminal discoverReaders:delegate:completion:].

    See more

    Declaration

    Objective-C

    @protocol SCPDiscoveryDelegate <NSObject>

    Swift

    protocol DiscoveryDelegate : NSObjectProtocol
  • SCPCart contains information about what should display on the reader’s cart. It should be created and then passed into setReaderDisplay, which will place the contents of the cart on the reader’s display.

    You can pass the same SCPCart to multiple calls of setReaderDisplay since the cart is not coupled to any specific call of setReaderDisplay.

    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 the Verifone P400 supports setReaderDisplay functionality

    See more

    Declaration

    Objective-C

    @interface SCPCart : NSObject

    Swift

    class SCPCart : NSObject
  • Dictates what will be shown on the screen through setReaderDisplay. Represents exactly what will be shown on the screen.

    See more

    Declaration

    Objective-C

    @interface SCPCartLineItem : NSObject

    Swift

    class SCPCartLineItem : NSObject