Reader Reference


                    
                    
                    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

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

Declaration

Objective-C

enum SCPDeviceType : NSUInteger {}

Swift

enum DeviceType : UInt, @unchecked Sendable


                    
                    
                    SCPBluetoothReaderDelegate

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 Stripe M2, BBPOS Chipper 2X BT, and the BBPOS WisePad 3.

The provided delegate must be retained by your application until the reader disconnects.

Declaration

Objective-C

@protocol SCPBluetoothReaderDelegate <NSObject>

Swift

protocol BluetoothReaderDelegate : NSObjectProtocol


                    
                    
                    SCPLocalMobileReaderDelegate

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.

Declaration

Objective-C

@protocol SCPLocalMobileReaderDelegate <NSObject>

Swift

protocol LocalMobileReaderDelegate : NSObjectProtocol


                    
                    
                    SCPReaderEvent

The possible events from a connected reader. Used by [SCPBluetoothReaderDelegate reader:didReportReaderEvent:info:].

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:].

Declaration

Objective-C

enum SCPReaderInputOptions : NSUInteger {}

Swift

struct ReaderInputOptions : OptionSet, @unchecked Sendable


                    
                    
                    SCPReaderDisplayMessage

The display messages that a reader may request be displayed by your app. Used by [SCPBluetoothReaderDelegate reader:didRequestReaderDisplayMessage:].

Declaration

Objective-C

enum SCPReaderDisplayMessage : NSUInteger {}

Swift

enum ReaderDisplayMessage : UInt, @unchecked Sendable


                    
                    
                    SCPReaderNetworkStatus

The possible networking statuses for a reader.

See

https://stripe.com/docs/api/terminal/readers/object

Declaration

Objective-C

enum SCPReaderNetworkStatus : NSUInteger {}

Swift

enum ReaderNetworkStatus : UInt, @unchecked Sendable


                    
                    
                    SCPBatteryStatus

A categorization of a reader’s battery charge level.

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.

These values are exactly what will be shown on the screen and do not reflect what the user is actually charged.

Note

Only Internet readers support setReaderDisplay functionality

See

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

Declaration

Objective-C


@interface SCPCart : NSObject

Swift

class Cart : NSObject


                    
                    
                    SCPCartBuilder

A builder class for SCPCart objects.

Declaration

Objective-C


@interface SCPCartBuilder : SCPBuilder <SCPCart *>

Swift

class CartBuilder : SCPBuilder<Cart>


                    
                    
                    SCPCartLineItem

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

The values 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


@interface SCPCartLineItem : NSObject

Swift

class CartLineItem : NSObject


                    
                    
                    SCPCartLineItemBuilder

A builder class for SCPCartLineItem objects.

Declaration

Objective-C


@interface SCPCartLineItemBuilder : SCPBuilder <SCPCartLineItem *>

Swift

class CartLineItemBuilder : SCPBuilder<CartLineItem>


                    
                    
                    SCPCollectInputsParameters

Contains information about the inputs to collect from the reader

Declaration

Objective-C


@interface SCPCollectInputsParameters : NSObject

Swift

class CollectInputsParameters : NSObject


                    
                    
                    SCPCollectInputsParametersBuilder

A builder class for SCPCollectInputsParameters

Declaration

Objective-C


@interface SCPCollectInputsParametersBuilder
    : SCPBuilder <SCPCollectInputsParameters *>

Swift

class CollectInputsParametersBuilder : SCPBuilder<CollectInputsParameters>


                    
                    
                    SCPInput

Represents a single input form

Declaration

Objective-C


@interface SCPInput : NSObject

Swift

class Input : NSObject


                    
                    
                    SCPSignatureInput

Contains information about a signature form to display on the reader

See

https://stripe.com/docs/terminal/features/collect-inputs

Declaration

Objective-C


@interface SCPSignatureInput : SCPInput

Swift

class SignatureInput : Input


                    
                    
                    SCPSignatureInputBuilder

Builder class for SCPSignatureInput.

Declaration

Objective-C


@interface SCPSignatureInputBuilder : SCPBuilder <SCPSignatureInput *>

Swift

class SignatureInputBuilder : SCPBuilder<SignatureInput>


                    
                    
                    SCPSelectionButton

Contains information about a Selection form to display on the reader

See

https://stripe.com/docs/terminal/features/collect-inputs

Declaration

Objective-C


@interface SCPSelectionButton : NSObject

Swift

class SelectionButton : NSObject


                    
                    
                    SCPSelectionButtonBuilder

Builder class for SCPSelectionButton.

Declaration

Objective-C


@interface SCPSelectionButtonBuilder : SCPBuilder <SCPSelectionButton *>

Swift

class SelectionButtonBuilder : SCPBuilder<SelectionButton>


                    
                    
                    SCPSelectionButtonStyle

The possible selection button styles

Declaration

Objective-C

enum SCPSelectionButtonStyle : NSUInteger {}

Swift

enum SelectionButtonStyle : UInt, @unchecked Sendable


                    
                    
                    SCPSelectionInput

Contains information about a Selection form to display on the reader

See

https://stripe.com/docs/terminal/features/collect-inputs

Declaration

Objective-C


@interface SCPSelectionInput : SCPInput

Swift

class SelectionInput : Input


                    
                    
                    SCPSelectionInputBuilder

Builder class for SCPSelectionInput.

Declaration

Objective-C


@interface SCPSelectionInputBuilder : SCPBuilder <SCPSelectionInput *>

Swift

class SelectionInputBuilder : SCPBuilder<SelectionInput>


                    
                    
                    SCPPhoneInput

Contains information about a phone form to display on the reader

See

https://stripe.com/docs/terminal/features/collect-inputs

Declaration

Objective-C


@interface SCPPhoneInput : SCPInput

Swift

class PhoneInput : Input


                    
                    
                    SCPPhoneInputBuilder

Builder class for SCPPhoneInput.

Declaration

Objective-C


@interface SCPPhoneInputBuilder : SCPBuilder <SCPPhoneInput *>

Swift

class PhoneInputBuilder : SCPBuilder<PhoneInput>


                    
                    
                    SCPEmailInput

Contains information about an email form to display on the reader

See

https://stripe.com/docs/terminal/features/collect-inputs

Declaration

Objective-C


@interface SCPEmailInput : SCPInput

Swift

class EmailInput : Input


                    
                    
                    SCPEmailInputBuilder

Builder class for SCPEmailInput.

Declaration

Objective-C


@interface SCPEmailInputBuilder : SCPBuilder <SCPEmailInput *>

Swift

class EmailInputBuilder : SCPBuilder<EmailInput>


                    
                    
                    SCPNumericInput

Contains information about a numeric form to display on the reader

See

https://stripe.com/docs/terminal/features/collect-inputs

Declaration

Objective-C


@interface SCPNumericInput : SCPInput

Swift

class NumericInput : Input


                    
                    
                    SCPNumericInputBuilder

Builder class for SCPNumericInput.

Declaration

Objective-C


@interface SCPNumericInputBuilder : SCPBuilder <SCPNumericInput *>

Swift

class NumericInputBuilder : SCPBuilder<NumericInput>


                    
                    
                    SCPTextInput

Contains information about a Text form to display on the reader

See

https://stripe.com/docs/terminal/features/collect-inputs

Declaration

Objective-C


@interface SCPTextInput : SCPInput

Swift

class TextInput : Input


                    
                    
                    SCPTextInputBuilder

Builder class for SCPTextInput.

Declaration

Objective-C


@interface SCPTextInputBuilder : SCPBuilder <SCPTextInput *>

Swift

class TextInputBuilder : SCPBuilder<TextInput>


                    
                    
                    SCPCollectInputsResult

Contains information about the data collected from a given form

Declaration

Objective-C


@interface SCPCollectInputsResult : NSObject

Swift

class CollectInputsResult : NSObject


                    
                    
                    SCPSignatureResult

Contains data collected from a signature form

See

https://stripe.com/docs/terminal/features/collect-inputs

Declaration

Objective-C


@interface SCPSignatureResult : SCPCollectInputsResult

Swift

class SignatureResult : CollectInputsResult


                    
                    
                    SCPSelectionResult

Contains data collected from a Selection form

See

https://stripe.com/docs/terminal/features/collect-inputs

Declaration

Objective-C


@interface SCPSelectionResult : SCPCollectInputsResult

Swift

class SelectionResult : CollectInputsResult


                    
                    
                    SCPPhoneResult

Contains data collected from a Phone form

See

https://stripe.com/docs/terminal/features/collect-inputs

Declaration

Objective-C


@interface SCPPhoneResult : SCPCollectInputsResult

Swift

class PhoneResult : CollectInputsResult


                    
                    
                    SCPEmailResult

Contains data collected from a Email form

See

https://stripe.com/docs/terminal/features/collect-inputs

Declaration

Objective-C


@interface SCPEmailResult : SCPCollectInputsResult

Swift

class EmailResult : CollectInputsResult


                    
                    
                    SCPNumericResult

Contains data collected from a Numeric form

See

https://stripe.com/docs/terminal/features/collect-inputs

Declaration

Objective-C


@interface SCPNumericResult : SCPCollectInputsResult

Swift

class NumericResult : CollectInputsResult


                    
                    
                    SCPTextResult

Contains data collected from a Text form

See

https://stripe.com/docs/terminal/features/collect-inputs

Declaration

Objective-C


@interface SCPTextResult : SCPCollectInputsResult

Swift

class TextResult : CollectInputsResult


                    
                    
                    SCPToggle

Contains information about a Toggle to display as part of a form

See

https://stripe.com/docs/terminal/features/collect-inputs

Declaration

Objective-C


@interface SCPToggle : NSObject

Swift

class Toggle : NSObject


                    
                    
                    SCPToggleValue

The possible toggle default values

Declaration

Objective-C

enum SCPToggleValue : NSUInteger {}

Swift

enum ToggleValue : UInt, @unchecked Sendable


                    
                    
                    SCPToggleResult

The possible toggle result values

Declaration

Objective-C

enum SCPToggleResult : NSUInteger {}

Swift

enum ToggleResult : UInt, @unchecked Sendable


                    
                    
                    SCPToggleBuilder

Builder class for SCPToggle.

Declaration

Objective-C


@interface SCPToggleBuilder : SCPBuilder <SCPToggle *>

Swift

class ToggleBuilder : SCPBuilder<Toggle>


                    
                    
                    SCPReaderSettings

Class representing the current settings of the reader.

Declaration

Objective-C


@interface SCPReaderSettings : NSObject

Swift

class ReaderSettings : NSObject


                    
                    
                    SCPReaderSettingsParameters

The protocol that classes that are able to be passed in to setReaderSettings must implement.

You do not implement this protocol but instead use one of the existing SDK classes that conforms to this protocol:

SCPReaderAccessibilityParameters

Declaration

Objective-C

@protocol SCPReaderSettingsParameters <NSObject>

Swift

protocol ReaderSettingsParameters : NSObjectProtocol


                    
                    
                    SCPReaderAccessibility

Class representing the accessibility state of the reader.

Declaration

Objective-C


@interface SCPReaderAccessibility : NSObject

Swift

class ReaderAccessibility : NSObject


                    
                    
                    SCPReaderTextToSpeechStatus

Represents the current text to speech status of the reader. Note that the actual text to speech value returned here may not match what was last requested since the reader may switch to headphones if the customer plugs in headphones and the state will reset to off after reboots.

See the Reader Settings

Declaration

Objective-C

enum SCPReaderTextToSpeechStatus : NSUInteger {}

Swift

enum ReaderTextToSpeechStatus : UInt, @unchecked Sendable


                    
                    
                    SCPReaderAccessibilityParameters

The SCPReaderAccessibilityParameters class contains information used to update the reader’s accessibility settings. To create a ReaderAccessibilityParameters instance, the SCPReaderAccessibilityParametersBuilder class should be used.

Declaration

Objective-C


@interface SCPReaderAccessibilityParameters
    : NSObject <SCPReaderSettingsParameters>

Swift

class ReaderAccessibilityParameters : NSObject, ReaderSettingsParameters


                    
                    
                    SCPReaderAccessibilityParametersBuilder

A builder class for SCPReaderSettingsParameters.

Declaration

Objective-C


@interface SCPReaderAccessibilityParametersBuilder
    : SCPBuilder <SCPReaderAccessibilityParameters *>

Swift

class ReaderAccessibilityParametersBuilder : SCPBuilder<ReaderAccessibilityParameters>


                    
                    
                    SCPReaderSettingsCompletionBlock

A block called with a SCPReaderSettings.

Success denotes the command was received by the reader and responded to. But the contents of ReaderSettings should be checked for reader errors setting the values.

Declaration

Objective-C

typedef void (^SCPReaderSettingsCompletionBlock)(SCPReaderSettings *_Nullable,
                                                 NSError *_Nullable)

Swift

typealias ReaderSettingsCompletionBlock = (SCPReaderSettings?, Error?) -> Void

Parameters

`readerSettings`	`SCPReaderSettings` object, or nil if an error occurred.
`error`	An error if one occurred, or nil.