Stripe Terminal iOS SDK

https://github.com/stripe/stripe-terminal-ios
Admin
The Stripe Terminal iOS SDK allows developers to build custom in-person checkout experiences within...
Tokens:278,773
Snippets:2,964
Trust Score:9.7
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### SCPSetupIntent

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Saving Cards.html

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.

```APIDOC
## SCPSetupIntent

### Description
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](https://stripe.com/docs/api/setup_intents)

### Declaration

**Objective-C**
```objectivec
@interface SCPSetupIntent : NSObject <NSCopying>
```

**Swift**
```swift
class SetupIntent : NSObject, NSCopying
```
```

--------------------------------

### Swift example usage

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPTapToPayDiscoveryConfigurationBuilder.html

Example of creating a configuration with simulated set to true in Swift.

```swift
try TapToPayDiscoveryConfigurationBuilder().setSimulated(true).build()
```

--------------------------------

### Objective-C example usage

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPTapToPayDiscoveryConfigurationBuilder.html

Example of creating a configuration with simulated set to YES in Objective-C.

```objectivec
[[[SCPTapToPayDiscoveryConfigurationBuilder new] setSimulated:YES] build]
```

--------------------------------

### usage

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPSetupIntentParametersBuilder.html

Sets the usage for the setup intent parameters.

```APIDOC
## usage

### Description
Sets the usage for the setup intent parameters.

### Method
`@property (nonatomic, assign) SCPSetupIntentUsage usage`

### Parameters
- **usage** (SCPSetupIntentUsage) - Required - The intended usage of the setup intent (e.g., on_session or off_session).

```

--------------------------------

### description

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPSetupIntentParametersBuilder.html

Sets the description for the setup intent parameters.

```APIDOC
## description

### Description
Sets the description for the setup intent parameters.

### Method
`@property (nonatomic, copy, nullable) NSString *description`

### Parameters
- **description** (NSString) - Optional - A description of the setup intent.

```

--------------------------------

### metadata

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPSetupIntentParametersBuilder.html

Sets the metadata for the setup intent parameters.

```APIDOC
## metadata

### Description
Sets the metadata for the setup intent parameters.

### Method
`@property (nonatomic, copy, nullable) NSDictionary<NSString *, NSString *> *metadata`

### Parameters
- **metadata** (NSDictionary<NSString *, NSString *>) - Optional - A dictionary of key-value pairs for additional information.

```

--------------------------------

### processSetupIntent

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPTerminal.html

Processes a setup intent by collecting a payment method and confirming the setup intent in a single operation. This method combines the functionality of `collectSetupIntentPaymentMethod` and `confirmSetupIntent` into a single call.

```APIDOC
## processSetupIntent

### Description
Processes a setup intent by collecting a payment method and confirming the setup intent in a single operation. This method combines the functionality of `collectSetupIntentPaymentMethod` and `confirmSetupIntent` into a single call.

### Declaration

**Objective-C**
```objc
- (nullable SCPCancelable *)processSetupIntent:(nonnull SCPSetupIntent *)setupIntent
                                allowRedisplay:(SCPAllowRedisplay)allowRedisplay
                                 collectConfig:(nullable SCPCollectSetupIntentConfiguration *)collectConfig
                                    completion:(nonnull SCPSetupIntentCompletionBlock)completion;
```

**Swift**
```swift
func processSetupIntent(_ setupIntent: SCPSetupIntent, allowRedisplay: AllowRedisplay, collectConfig: CollectSetupIntentConfiguration?, completion: @escaping SetupIntentCompletionBlock) -> SCPCancelable?
```

### Parameters
- **setupIntent** (SCPSetupIntent) - Required - The SetupIntent to process.
- **allowRedisplay** (SCPAllowRedisplay) - Required - Controls how this SetupIntent may be shown to the customer in the Stripe Dashboard.
- **collectConfig** (SCPCollectSetupIntentConfiguration?) - Optional - The configuration for collecting the setup intent payment method.
- **completion** (SCPSetupIntentCompletionBlock) - Required - The completion block called when the setup intent completes.

### Return Value
A cancelable that can be used to cancel the setup intent process.
```

--------------------------------

### setStripeDescription:

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPSetupIntentParametersBuilder.html

Sets the description for the setup intent parameters. See SCPSetupIntentParameters.stripeDescription.

```APIDOC
## setStripeDescription:

### Description
Sets the description for the setup intent parameters.

### Declaration

**Objective-C**
```objectivec
- (nonnull SCPSetupIntentParametersBuilder *)setStripeDescription:(nullable NSString *)stripeDescription;
```

**Swift**
```swift
func setStripeDescription(_ stripeDescription: String?) -> SetupIntentParametersBuilder
```

### Parameters
- **stripeDescription** (NSString * / String?) - Optional - The description of the setup intent.

### Return Value
The builder instance for chaining.
```

--------------------------------

### Swift builder usage example

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPInternetDiscoveryConfigurationBuilder.html

Example usage of the Swift builder to create a configuration with a location ID.

```swift
try InternetDiscoveryConfigurationBuilder().setLocationId("tml_123").build()
```

--------------------------------

### Builder usage example

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPLocalMobileDiscoveryConfigurationBuilder.html

Example usage of the builder to create a local mobile discovery configuration with the simulated property set to YES/true.

```objectivec
[[[SCPLocalMobileDiscoveryConfigurationBuilder new] setSimulated:YES] build]
```

```swift
try LocalMobileDiscoveryConfigurationBuilder().setSimulated(true).build()
```

--------------------------------

### customer

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPSetupIntentParametersBuilder.html

Sets the customer ID for the setup intent parameters.

```APIDOC
## customer

### Description
Sets the customer ID for the setup intent parameters.

### Method
`@property (nonatomic, copy, nullable) NSString *customer`

### Parameters
- **customer** (NSString) - Optional - The ID of the customer associated with the setup intent.

```

--------------------------------

### Swift usage example for BluetoothProximityDiscoveryConfigurationBuilder

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPBluetoothProximityDiscoveryConfigurationBuilder.html

Swift example usage of the builder: creates a builder, sets the simulated property to true, and builds the configuration.

```swift
BluetoothProximityDiscoveryConfigurationBuilder().setSimulated(true).build()
```

--------------------------------

### Build TapToPayDiscoveryConfiguration with simulated mode

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Reader Discovery & Connection.html

Example usage of the TapToPayDiscoveryConfigurationBuilder to create a configuration with simulated mode enabled. The Objective-C and Swift examples are equivalent.

```objectivec
[[[SCPTapToPayDiscoveryConfigurationBuilder new] setSimulated:YES] build]
```

```swift
try TapToPayDiscoveryConfigurationBuilder().setSimulated(true).build()
```

--------------------------------

### Objective-C usage example for SCPBluetoothProximityDiscoveryConfigurationBuilder

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPBluetoothProximityDiscoveryConfigurationBuilder.html

Objective-C example usage of the builder: creates a new builder, sets the simulated property to YES, and builds the configuration.

```objectivec
[[[SCPBluetoothProximityDiscoveryConfigurationBuilder new] setSimulated:YES] build]
```

--------------------------------

### reader(_:didFinishInstallingUpdate:error:)

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Protocols/SCPBluetoothReaderDelegate.html

Delegate method called when the reader finishes installing a software update.

```APIDOC
## reader(_:didFinishInstallingUpdate:error:)

### Description
The reader is reporting that an installation has finished. If the install was successful, error will be nil.

### Declaration
Objective-C:
```objc
- (void)reader:(nonnull SCPReader *)reader didFinishInstallingUpdate:(nullable SCPReaderSoftwareUpdate *)update error:(nullable NSError *)error;
```
Swift:
```swift
func reader(_ reader: SCPReader, didFinishInstallingUpdate update: SCPReaderSoftwareUpdate?, error: Error?)
```

### Parameters
- **reader** (SCPReader) - The originating reader.
- **update** (SCPReaderSoftwareUpdate?) - 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** (Error?) - If the install failed, this will describe the error preventing install.
```

--------------------------------

### tapToPayReader:didFinishInstallingUpdate:error:

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Protocols/SCPTapToPayReaderDelegate.html

Delegate method called when the reader has finished installing an update.

```APIDOC
## tapToPayReader:didFinishInstallingUpdate:error:

### Description
The reader has finished installing an update.

### Declaration

**Objective-C**
```objc
- (void)tapToPayReader:(nonnull SCPReader *)reader
    didFinishInstallingUpdate:(nullable SCPReaderSoftwareUpdate *)update
                        error:(nullable NSError *)error;
```

**Swift**
```swift
func tapToPayReader(_ reader: SCPReader, didFinishInstallingUpdate update: SCPReaderSoftwareUpdate?, error: (any Error)?)
```

### Parameters
- **reader** (SCPReader) - The originating reader.
- **update** (SCPReaderSoftwareUpdate?) - The update that was being installed, if any.
- **error** (NSError?) - If the installed failed, this will describe the error preventing install. If it succeeded, the error will be `nil`.
```

--------------------------------

### reader:didStartInstallingUpdate:cancelable:

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Protocols/SCPBluetoothReaderDelegate.html

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.

```APIDOC
## [DELEGATE] reader:didStartInstallingUpdate:cancelable:

### Description
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.

### Method
- (void)reader:(nonnull SCPReader *)reader didStartInstallingUpdate:(nonnull SCPReaderSoftwareUpdate *)update cancelable:(nullable SCPCancelable *)cancelable;

### Parameters
- **reader** (SCPReader) - The originating reader.
- **update** (SCPReaderSoftwareUpdate) - The SCPReaderSoftwareUpdate with an estimatedUpdateTime that can be used to communicate how long the update is expected to take.
- **cancelable** (SCPCancelable?) - 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.

### Declaration
Objective-C:
```objc
- (void)reader:(nonnull SCPReader *)reader
    didStartInstallingUpdate:(nonnull SCPReaderSoftwareUpdate *)update
                  cancelable:(nullable SCPCancelable *)cancelable;
```

Swift:
```swift
func reader(_ reader: SCPReader, didStartInstallingUpdate update: SCPReaderSoftwareUpdate, cancelable: SCPCancelable?)
```
```

--------------------------------

### reader:didStartInstallingUpdate:cancelable:

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Protocols/SCPBluetoothReaderDelegate.html

Delegate method called when the reader starts installing a software update.

```APIDOC
## reader:didStartInstallingUpdate:cancelable:

### Description
Called when the reader has started installing a software update. This can happen automatically during `connectReader:` for required updates, or when `installAvailableUpdate` is called for optional updates. The `cancelable` parameter can be used to cancel the installation if needed, but canceling a required update will result in a failed connect with error `SCPErrorUnsupportedReaderVersion`.

### Declaration

**Objective-C**
```objc
- (void)reader:(nonnull SCPReader *)reader
    didStartInstallingUpdate:(nonnull SCPReaderSoftwareUpdate *)update
                  cancelable:(nullable SCPCancelable *)cancelable;
```

**Swift**
```swift
func reader(_ reader: SCPReader, didStartInstallingUpdate update: SCPReaderSoftwareUpdate, cancelable: SCPCancelable?)
```

### Parameters
- **reader** (SCPReader) - The originating reader.
- **update** (SCPReaderSoftwareUpdate) - The update with an `estimatedUpdateTime` that can be used to communicate how long the update is expected to take.
- **cancelable** (SCPCancelable?) - A cancelable to cancel the installation if needed. Nil for incremental-only updates that cannot be canceled.
```

--------------------------------

### createSetupIntent(_:completion:)

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTerminal.html

Creates a new SCPSetupIntent with the given parameters.

```APIDOC
## createSetupIntent(_:completion:)

### Description
Creates a new SCPSetupIntent with the given parameters.

### Declaration
**Objective-C**
```objc
- (void)createSetupIntent:(nonnull SCPSetupIntentParameters *)setupIntentParams
               completion:(nonnull SCPSetupIntentCompletionBlock)completion;
```

**Swift**
```swift
func createSetupIntent(_ setupIntentParams: SCPSetupIntentParameters) async throws -> SCPSetupIntent
```

### Parameters
- **setupIntentParams** (SCPSetupIntentParameters) - Required - The parameters that control the creation of the SetupIntent.
- **completion** (SCPSetupIntentCompletionBlock) - Required - The completion block called when the command completes.
```

--------------------------------

### tapToPayReader:didStartInstallingUpdate:cancelable:

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Protocols/SCPTapToPayReaderDelegate.html

Delegate method called when the reader has started installing a software update.

```APIDOC
## tapToPayReader:didStartInstallingUpdate:cancelable:

### Description
The reader has started installing a software update.

### Declaration

**Objective-C**
```objc
- (void)tapToPayReader:(nonnull SCPReader *)reader
    didStartInstallingUpdate:(nonnull SCPReaderSoftwareUpdate *)update
                  cancelable:(nullable SCPCancelable *)cancelable;
```

**Swift**
```swift
func tapToPayReader(_ reader: SCPReader, didStartInstallingUpdate update: SCPReaderSoftwareUpdate, cancelable: SCPCancelable?)
```

### Parameters
- **reader** (SCPReader) - The originating reader.
- **update** (SCPReaderSoftwareUpdate) - The `SCPReaderSoftwareUpdate` with an `durationEstimate` that can be used to communicate how long the update is expected to take.
- **cancelable** (SCPCancelable?) - 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.
```

--------------------------------

### localMobileReader:didStartInstallingUpdate:cancelable:

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Protocols/SCPLocalMobileReaderDelegate.html

Delegate method called when the reader starts installing a software update.

```APIDOC
## localMobileReader:didStartInstallingUpdate:cancelable:

### Description
Notifies the delegate that the reader has started installing a software update.

### Declaration
**Objective-C**
```objc
- (void)localMobileReader:(nonnull SCPReader *)reader
    didStartInstallingUpdate:(nonnull SCPReaderSoftwareUpdate *)update
                  cancelable:(nullable SCPCancelable *)cancelable;
```

**Swift**
```swift
func localMobileReader(_ reader: SCPReader, didStartInstallingUpdate update: SCPReaderSoftwareUpdate, cancelable: SCPCancelable?)
```

### Parameters
- **reader** (SCPReader) - The originating reader.
- **update** (SCPReaderSoftwareUpdate) - The update with an `estimatedUpdateTime` that can be used to communicate how long the update is expected to take.
- **cancelable** (SCPCancelable?) - A cancelable 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 cannot be canceled.
```

--------------------------------

### SCPSetupIntentCompletionBlock

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Blocks.html

Completion block for retrieving a SetupIntent.

```APIDOC
## SCPSetupIntentCompletionBlock

### Description
Completion block called when a SetupIntent is retrieved.

### Parameters
- **setupIntent** (SCPSetupIntent?) - The retrieved SetupIntent, or nil if an error occurred.
- **error** (Error?) - The error that occurred, if any.

### Declaration
`typealias SCPSetupIntentCompletionBlock = (SCPSetupIntent?, Error?) -> Void`
```

--------------------------------

### connectReader(_:connectionConfig:completion:)

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTerminal.html

Attempts to connect to the given reader with a given connection configuration. To connect to mobile readers, your app must register that reader to a Location upon connection. The location is specified in the connection configuration for the reader. Throughout the lifetime of the connection, the reader will communicate with your app via the SCPReaderDelegate to announce reader related events. 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. If the SDK is actively discovery when connect is called the SDK will complete the discover command. 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 a mobile reader’s battery is critically low the connect call will fail with SCPErrorBluetoothDisconnected. Plug your reader in to start charging and try again.

```APIDOC
## connectReader(_:connectionConfig:completion:)

### Description
Attempts to connect to the given reader with a given connection configuration. To connect to mobile readers, your app must register that reader to a Location upon connection. The location is specified in the connection configuration for the reader. Throughout the lifetime of the connection, the reader will communicate with your app via the SCPReaderDelegate to announce reader related events. 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. If the SDK is actively discovery when connect is called the SDK will complete the discover command. 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 a mobile reader’s battery is critically low the connect call will fail with SCPErrorBluetoothDisconnected. Plug your reader in to start charging and try again.

### Method
SDK method

### Endpoint
SCPTerminal.connectReader(_:connectionConfig:completion:)

### Parameters
- **reader** (SCPReader) - Required - The reader to connect to. This should be a reader recently returned to the didUpdateDiscoveredReaders: method in the discovery delegate.
- **connectionConfig** (SCPConnectionConfiguration) - Required - The connection configuration for options while connecting to a reader. See SCPConnectionConfiguration and its subclasses for more details.
- **completion** (SCPReaderCompletionBlock) - Required - The completion block called when the command completes.

### Declaration
Objective-C:
```objectivec
- (void)connectReader:(nonnull SCPReader *)reader
     connectionConfig:(nonnull SCPConnectionConfiguration *)connectionConfig
           completion:(nonnull SCPReaderCompletionBlock)completion;
```

Swift:
```swift
func connectReader(_ reader: SCPReader, connectionConfig: ConnectionConfiguration) async throws -> SCPReader
```
```

--------------------------------

### terminal:didRequestReaderDisplayMessage:

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Protocols/SCPReaderDisplayDelegate.html

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 stringFromReaderDisplayMessage to get a user facing string for the prompt.

```APIDOC
## terminal:didRequestReaderDisplayMessage:

### Description
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 stringFromReaderDisplayMessage to get a user facing string for the prompt.

### Declaration
Objective-C:
```objective-c
- (void)terminal:(nonnull SCPTerminal *)terminal
    didRequestReaderDisplayMessage:(SCPReaderDisplayMessage)displayMessage;
```

Swift:
```swift
func terminal(_ terminal: SCPTerminal, didRequestReaderDisplayMessage displayMessage: ReaderDisplayMessage)
```

### Parameters
- **terminal** (SCPTerminal) - The originating terminal.
- **displayMessage** (SCPReaderDisplayMessage) - The message to display to the user.

```

--------------------------------

### Add StripeTerminal pod to Podfile

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/README.md

Add this line to your Podfile to install the Stripe Terminal iOS SDK via CocoaPods. The version specifier '~> 5.0' ensures you get the latest 5.x compatible version.

```ruby
pod 'StripeTerminal', '~> 5.0'
```

--------------------------------

### init

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTerminal.html

Unavailable initializer. Use `initWithConfiguration:tokenProvider:delegate:` instead.

```APIDOC
## [SCPTerminal] init

### Description
Unavailable. Use `initWithConfiguration:tokenProvider:delegate:` instead.

### Declaration

**Objective-C**
```objectivec
- (nonnull instancetype)init;
```
```

--------------------------------

### init

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPInternetEasyConnectConfiguration.html

Unavailable initializer. Use initWithDiscoveryConfiguration:connectionConfiguration: instead.

```APIDOC
## init

### Description
Unavailable. Use initWithDiscoveryConfiguration:connectionConfiguration: instead.

### Method
Initializer

### Declaration
Objective-C:
```objectivec
- (nonnull instancetype)init;
```
```

--------------------------------

### SCPTerminal.init

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPTerminal.html

Unavailable initializer. Use `initWithConfiguration:tokenProvider:delegate:` instead.

```APIDOC
## [SDK] SCPTerminal.init

### Description
Unavailable. Use `initWithConfiguration:tokenProvider:delegate:` instead.

### Declaration

**Objective-C**
```objectivec
- (nonnull instancetype)init;
```

```

--------------------------------

### init(discoveryConfiguration:connectionConfiguration:)

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPTapToPayEasyConnectConfiguration.html

Initializes a TapToPayEasyConnectConfiguration with the provided discovery and connection configurations.

```APIDOC
## init(discoveryConfiguration:connectionConfiguration:)

### Description
Initializes a TapToPayEasyConnectConfiguration with the provided discovery and connection configurations.

### Declaration

**Objective-C**
```objc
- (nonnull instancetype)initWithDiscoveryConfiguration:(nonnull SCPTapToPayDiscoveryConfiguration *)discoveryConfiguration connectionConfiguration:(nonnull SCPTapToPayConnectionConfiguration *)connectionConfiguration;
```

**Swift**
```swift
init(discoveryConfiguration: SCPTapToPayDiscoveryConfiguration, connectionConfiguration: SCPTapToPayConnectionConfiguration)
```

### Parameters
- **discoveryConfiguration** (SCPTapToPayDiscoveryConfiguration) - The Tap to Pay discovery configuration.
- **connectionConfiguration** (SCPTapToPayConnectionConfiguration) - The Tap to Pay connection configuration.

### Return Value
An initialized TapToPayEasyConnectConfiguration.
```

--------------------------------

### init

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPMotoConfiguration.html

The initializer for SCPMotoConfiguration is unavailable. Use SCPMotoConfigurationBuilder instead.

```APIDOC
## Method: init

### Description
Unavailable. Use `SCPMotoConfigurationBuilder` to create instances.

### Declaration

**Objective-C**
```objectivec
- (nonnull instancetype)init;
```

### Parameters
None

### Return Value
An instance of SCPMotoConfiguration.

```

--------------------------------

### Objective-C builder usage example

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPInternetDiscoveryConfigurationBuilder.html

Example usage of the Objective-C builder to create a configuration with a location ID.

```objectivec
[[[SCPInternetDiscoveryConfigurationBuilder new] setLocationId:@"tml_123"] build]
```

--------------------------------

### Initialize git repository

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/Example/Pods/Alamofire/README.md

Initialize your project as a git repository before adding Alamofire as a submodule. Run this in your top-level project directory.

```bash
$ git init
```

--------------------------------

### Carthage Cartfile entry for Static

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/Example/Pods/Static/Readme.markdown

Add this line to your Cartfile to install Static via Carthage, the recommended installation method.

```ruby
github "venmo/Static"
```

--------------------------------

### SCPTerminal.new

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPTerminal.html

Unavailable class method. Use `initWithConfiguration:tokenProvider:delegate:` instead.

```APIDOC
## [SDK] SCPTerminal.new

### Description
Unavailable. Use `initWithConfiguration:tokenProvider:delegate:` instead.

### Declaration

**Objective-C**
```objectivec
+ (nonnull instancetype)new;
```

```

--------------------------------

### initWithTitle:

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPTextInputBuilder.html

Initializes a new instance of the SCPTextInputBuilder class with the provided title.

```APIDOC
## initWithTitle:

### Description
Initializes a new instance of the SCPTextInputBuilder class with the provided title.

### Declaration

**Objective-C**
```objectivec
- (nonnull instancetype)initWithTitle:(nonnull NSString *)title;
```

**Swift**
```swift
init(title: String)
```

### Parameters
- **title** (NSString) - Required - The title for the text input.
```

--------------------------------

### Install CocoaPods dependencies

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/README.md

Run this command in your project directory to install the dependencies defined in your Podfile. After this, always open the .xcworkspace file instead of the .xcodeproj.

```bash
pod install
```

--------------------------------

### -init

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPCreateConfiguration.html

Unavailable initializer. Use SCPCreateConfigurationBuilder instead.

```APIDOC
## Method: init

### Description
Unavailable. Use `SCPCreateConfigurationBuilder` instead.

### Declaration

**Objective-C**
```objectivec
- (nonnull instancetype)init;
```
```

--------------------------------

### new

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTerminal.html

Unavailable class method. Use `initWithConfiguration:tokenProvider:delegate:` instead.

```APIDOC
## [SCPTerminal] new

### Description
Unavailable. Use `initWithConfiguration:tokenProvider:delegate:` instead.

### Declaration

**Objective-C**
```objectivec
+ (nonnull instancetype)new;
```
```

--------------------------------

### CocoaPods Podfile entry for Static

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/Example/Pods/Static/Readme.markdown

Add these lines to your Podfile to install Static via CocoaPods. Requires CocoaPods version 0.37 or greater. Then run `pod install`.

```ruby
use_frameworks!
pod 'Static', git: 'https://github.com/venmo/Static'
```

--------------------------------

### SCPWechatPayDisplayQrCode Initializers (Unavailable)

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPWechatPayDisplayQrCode.html

The init and new methods are unavailable. You cannot directly instantiate SCPWechatPayDisplayQrCode; you should only use instances returned by the SDK.

```APIDOC
## SCPWechatPayDisplayQrCode Initializers

### Description
These initializers are unavailable. You cannot directly instantiate `SCPWechatPayDisplayQrCode`. You should only use one that has been returned by our SDK.

### Methods

#### init
- **Unavailable**
- **Description**: You cannot directly instantiate `SCPWechatPayDisplayQrCode`. You should only use one that has been returned by our SDK.

Declaration (Objective-C):
```objc
- (nonnull instancetype)init;
```

#### new
- **Unavailable**
- **Description**: You cannot directly instantiate `SCPWechatPayDisplayQrCode`. You should only use one that has been returned by our SDK.

Declaration (Objective-C):
```objc
+ (nonnull instancetype)new;
```
```

--------------------------------

### SCPTerminal initWithTokenProvider:

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPTerminal.html

Initializes the Terminal SDK with the provided token provider.

```APIDOC
## SCPTerminal initWithTokenProvider:

### Description
Initializes the Terminal SDK with the provided token provider.

### Declaration

**Objective-C**
```objc
+ (void)initWithTokenProvider:
    (nonnull id<SCPConnectionTokenProvider>)tokenProvider;
```

**Swift**
```swift
class func initWithTokenProvider(_ tokenProvider: any SCPConnectionTokenProvider)
```

### Parameters
- `_tokenProvider_` (id<SCPConnectionTokenProvider>) - Required - The token provider for authentication with Stripe Terminal.
```

--------------------------------

### retrieveSetupIntent(clientSecret:completion:)

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPTerminal.html

Retrieves an SCPSetupIntent with a client secret.

```APIDOC
## retrieveSetupIntent(clientSecret:completion:)

### Description
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**
```objc
- (void)retrieveSetupIntent:(nonnull NSString *)clientSecret
                 completion:(nonnull SCPSetupIntentCompletionBlock)completion;
```

**Swift**
```swift
func retrieveSetupIntent(clientSecret: String) async throws -> SCPSetupIntent
```

### Parameters
- **clientSecret** (NSString) - Required - The client secret of the SetupIntent to be retrieved.
- **completion** (SCPSetupIntentCompletionBlock) - Required - The completion block called when the command completes.
```

--------------------------------

### SCPConfirmSetupIntentCompletionBlock

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Blocks.html

Completion block for confirming a SetupIntent.

```APIDOC
## SCPConfirmSetupIntentCompletionBlock

### Description
Completion block called when a SetupIntent is confirmed.

### Parameters
- **setupIntent** (SCPSetupIntent?) - The confirmed SetupIntent, or nil if an error occurred.
- **error** (Error?) - The error that occurred, if any.

### Declaration
`typealias SCPConfirmSetupIntentCompletionBlock = (SCPSetupIntent?, Error?) -> Void`
```

--------------------------------

### initWithAmount:currency:

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPPaymentIntentParametersBuilder.html

Initializes the builder with the required amount and currency.

```APIDOC
## SCPPaymentIntentParametersBuilder initWithAmount:currency:

### Description
Initializes SCPPaymentIntentParametersBuilder with the given amount and currency.

### Method
initWithAmount:currency:

### Parameters
- **amount** (NSUInteger) - Required - The amount of the payment, provided in the currency’s smallest unit.
- **currency** (NSString) - Required - The currency of the payment.

### Declaration
Objective-C:
```objc
- (nonnull instancetype)initWithAmount:(NSUInteger)amount
                              currency:(nonnull NSString *)currency;
```

Swift:
```swift
init(amount: UInt, currency: String)
```
```

--------------------------------

### setMetadata:

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPSetupIntentParametersBuilder.html

Sets the metadata for the setup intent parameters. See SCPSetupIntentParameters.metadata.

```APIDOC
## setMetadata:

### Description
Sets the metadata for the setup intent parameters.

### Declaration

**Objective-C**
```objectivec
- (nonnull SCPSetupIntentParametersBuilder *)setMetadata:(nullable NSDictionary<NSString *, NSString *> *)metadata;
```

**Swift**
```swift
func setMetadata(_ metadata: [String : String]?) -> SetupIntentParametersBuilder
```

### Parameters
- **metadata** (NSDictionary<NSString *, NSString *> * / [String : String]?) - Optional - A dictionary of key-value pairs for metadata.

### Return Value
The builder instance for chaining.
```

--------------------------------

### initWithDelegate:

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPInternetConnectionConfigurationBuilder.html

Initializes a new InternetConnectionConfigurationBuilder with the specified delegate.

```APIDOC
## initWithDelegate:

### Description
Creates an `InternetConnectionConfigurationBuilder` with the provided delegate.

### Declaration

**Objective-C**
```objc
- (nonnull instancetype)initWithDelegate:(nonnull id<SCPInternetReaderDelegate>)delegate;
```

**Swift**
```swift
init(delegate: any InternetReaderDelegate)
```

### Parameters
- **delegate** (id<SCPInternetReaderDelegate>) - Required - The delegate to use for the internet reader.

### Return Value
An initialized `InternetConnectionConfigurationBuilder` instance.
```

--------------------------------

### initWithTitle:

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSignatureInputBuilder.html

Initializes a new instance of the SCPSignatureInputBuilder class with the provided title.

```APIDOC
## SCPSignatureInputBuilder initWithTitle

### Description
Initializes a new instance of the `SCPSignatureInputBuilder` class with the provided title.

### Declaration

**Objective-C**
```objectivec
- (nonnull instancetype)initWithTitle:(nonnull NSString *)title;
```

**Swift**
```swift
init(title: String)
```

### Parameters
- **title** (NSString) - Required - The title for the signature input.
```

--------------------------------

### setOnBehalfOf:

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPSetupIntentParametersBuilder.html

Sets the on_behalf_of value for the setup intent parameters. See SCPSetupIntentParameters.onBehalfOf.

```APIDOC
## setOnBehalfOf:

### Description
Sets the on_behalf_of value for the setup intent parameters.

### Declaration

**Objective-C**
```objectivec
- (nonnull SCPSetupIntentParametersBuilder *)setOnBehalfOf:(nullable NSString *)onBehalfOf;
```

**Swift**
```swift
func setOnBehalfOf(_ onBehalfOf: String?) -> SetupIntentParametersBuilder
```

### Parameters
- **onBehalfOf** (NSString * / String?) - Optional - The ID of the Stripe account on whose behalf the setup intent is created.

### Return Value
The builder instance for chaining.
```

--------------------------------

### SCPConfirmSetupIntentError

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPConfirmSetupIntentError.html

Documentation for the SCPConfirmSetupIntentError class, including its properties and initialization restrictions.

```APIDOC
## SCPConfirmSetupIntentError

### Description
An error from `[-[SCPTerminal confirmSetupIntent:completion:]]`. This class provides properties to access the updated SetupIntent, request error, decline code, and API error details when confirming a setup intent fails.

### Properties

#### setupIntent
- **Type**: `SCPSetupIntent?` (nullable)
- **Description**: The updated SetupIntent after `confirmSetupIntent` failed.

#### requestError
- **Type**: `NSError?` (nullable)
- **Description**: If `confirmSetupIntent` failed because the underlying network request errored, this property contains additional details about the error.

#### declineCode
- **Type**: `String?` (nullable)
- **Description**: If `confirmSetupIntent` failed because the payment method was declined, this property contains the decline code.

#### apiError
- **Type**: `SCPApiError?` (nullable)
- **Description**: The API error containing detailed information about the failure.

### Initializers

#### init
- **Availability**: Unavailable
- **Description**: You cannot directly instantiate this class.

#### new
- **Availability**: Unavailable
- **Description**: You cannot directly instantiate this class.

### Declaration

**Objective-C**
```objectivec
@interface SCPConfirmSetupIntentError : NSError
```

**Swift**
```swift
class ConfirmSetupIntentError : NSError
```
```

--------------------------------

### setUsage:

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPSetupIntentParametersBuilder.html

Sets the usage type for the setup intent parameters. See SCPSetupIntentParameters.usage.

```APIDOC
## setUsage:

### Description
Sets the usage type for the setup intent parameters.

### Declaration

**Objective-C**
```objectivec
- (nonnull SCPSetupIntentParametersBuilder *)setUsage:(SCPSetupIntentUsage)usage;
```

**Swift**
```swift
func setUsage(_ usage: SetupIntentUsage) -> SetupIntentParametersBuilder
```

### Parameters
- **usage** (SCPSetupIntentUsage / SetupIntentUsage) - Required - The usage type for the setup intent.

### Return Value
The builder instance for chaining.
```

--------------------------------

### init

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPSetupIntentParametersBuilder.html

Initializes a new SCPSetupIntentParametersBuilder instance.

```APIDOC
## init

### Description
Initializes a new SCPSetupIntentParametersBuilder instance.

### Method
`- (instancetype)init`

### Parameters
None

### Return Value
A new SCPSetupIntentParametersBuilder instance.

```

--------------------------------

### setCustomer:

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPSetupIntentParametersBuilder.html

Sets the customer identifier for the setup intent parameters. See SCPSetupIntentParameters.customer.

```APIDOC
## setCustomer:

### Description
Sets the customer identifier for the setup intent parameters.

### Declaration

**Objective-C**
```objectivec
- (nonnull SCPSetupIntentParametersBuilder *)setCustomer:(nullable NSString *)customer;
```

**Swift**
```swift
func setCustomer(_ customer: String?) -> SetupIntentParametersBuilder
```

### Parameters
- **customer** (NSString * / String?) - Optional - The customer identifier.

### Return Value
The builder instance for chaining.
```

--------------------------------

### init(chargeId:amount:currency:)

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPRefundParametersBuilder.html

Initializes a refund parameters builder with a charge ID, amount, and currency.

```APIDOC
## init(chargeId:amount:currency:)

### Description
Initializes `SCPRefundParametersBuilder` with the given charge, amount, and currency.

### Declaration

**Objective-C**
```objc
- (nonnull instancetype)initWithChargeId:(nonnull NSString *)chargeId
                                  amount:(NSUInteger)amount
                                currency:(nonnull NSString *)currency;
```

**Swift**
```swift
init(chargeId: String, amount: UInt, currency: String)
```

### Parameters
- **chargeId** (NSString) - Required - The ID of the charge to be refunded.
- **amount** (NSUInteger) - Required - The amount to be refunded, provided in the currency’s smallest unit.
- **currency** (NSString) - Required - 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.
```

--------------------------------

### SCPPaymentIntent Initializers (Unavailable)

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPaymentIntent.html

The init and new methods are unavailable. SCPPaymentIntent cannot be instantiated directly; use SCPTerminal.shared.createPaymentIntent() instead.

```APIDOC
## SCPPaymentIntent Initializers (Unavailable)

### Description
You cannot directly instantiate `SCPPaymentIntent`. You should only use one that has been returned by our SDK. See `SCPTerminal.shared.createPaymentIntent()`.

### Methods

#### init
- **Unavailable**
- You cannot directly instantiate `SCPPaymentIntent`.

**Objective-C Declaration:**
```objc
- (nonnull instancetype)init;
```

#### new
- **Unavailable**
- You cannot directly instantiate `SCPPaymentIntent`.

**Objective-C Declaration:**
```objc
+ (nonnull instancetype)new;
```

```

--------------------------------

### localMobileReader:didFinishInstallingUpdate:error:

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Protocols/SCPLocalMobileReaderDelegate.html

Delegate method called when the reader finishes installing an update.

```APIDOC
## localMobileReader:didFinishInstallingUpdate:error:

### Description
Notifies the delegate that the reader has finished installing an update.

### Declaration
**Objective-C**
```objc
- (void)localMobileReader:(nonnull SCPReader *)reader
    didFinishInstallingUpdate:(nullable SCPReaderSoftwareUpdate *)update
                        error:(nullable NSError *)error;
```

**Swift**
```swift
func localMobileReader(_ reader: SCPReader, didFinishInstallingUpdate update: SCPReaderSoftwareUpdate?, error: Error?)
```

### Parameters
- **reader** (SCPReader) - The originating reader.
- **update** (SCPReaderSoftwareUpdate?) - The update that was being installed, if any.
- **error** (Error?) - If the install failed, this will describe the error preventing install. If it succeeded, the error will be `nil`.
```

--------------------------------

### SCPLocalMobileDiscoveryConfigurationBuilder

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPLocalMobileDiscoveryConfigurationBuilder.html

Documentation for the SCPLocalMobileDiscoveryConfigurationBuilder class, including its declaration, example usage, and the setSimulated: method.

```APIDOC
## SCPLocalMobileDiscoveryConfigurationBuilder

### Description
Builder class for SCPLocalMobileDiscoveryConfiguration. Use this builder to construct a discovery configuration for local mobile discovery.

### Declaration

**Objective-C**
```objectivec
@interface SCPLocalMobileDiscoveryConfigurationBuilder
    : SCPBuilder <SCPLocalMobileDiscoveryConfiguration *>
```

**Swift**
```swift
class LocalMobileDiscoveryConfigurationBuilder : SCPBuilder<LocalMobileDiscoveryConfiguration>
```

### Example Usage

**Objective-C**
```objectivec
[[[SCPLocalMobileDiscoveryConfigurationBuilder new] setSimulated:YES] build]
```

**Swift**
```swift
try LocalMobileDiscoveryConfigurationBuilder().setSimulated(true).build()
```

### Methods

#### setSimulated:

Set the simulated property for the discovery configuration that will be built.

**Objective-C**
```objectivec
- (nonnull SCPLocalMobileDiscoveryConfigurationBuilder *)setSimulated:
    (BOOL)simulated;
```

**Swift**
```swift
func setSimulated(_ simulated: Bool) -> LocalMobileDiscoveryConfigurationBuilder
```

**Parameters**
- `simulated` (BOOL/Bool) - Required - The simulated flag to set on the configuration.

**Returns**
- The builder instance, allowing for method chaining.
```

--------------------------------

### new

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPMotoConfiguration.html

The class method 'new' is unavailable. Use SCPMotoConfigurationBuilder instead.

```APIDOC
## Method: new

### Description
Unavailable. Use `SCPMotoConfigurationBuilder` to create instances.

### Declaration

**Objective-C**
```objectivec
+ (nonnull instancetype)new;
```

### Parameters
None

### Return Value
An instance of SCPMotoConfiguration.

```

--------------------------------

### setPaymentMethodTypes:

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPSetupIntentParametersBuilder.html

Sets the payment method types for the setup intent parameters. See SCPSetupIntentParameters.paymentMethodTypes.

```APIDOC
## setPaymentMethodTypes:

### Description
Sets the payment method types for the setup intent parameters.

### Declaration

**Objective-C**
```objectivec
- (nonnull SCPSetupIntentParametersBuilder *)setPaymentMethodTypes:(nonnull NSArray<NSNumber *> *)paymentMethodTypes;
```

**Swift**
```swift
func setPaymentMethodTypes(_ paymentMethodTypes: [NSNumber]) -> SetupIntentParametersBuilder
```

### Parameters
- **paymentMethodTypes** (NSArray<NSNumber *> * / [NSNumber]) - Required - An array of payment method types.

### Return Value
The builder instance for chaining.
```

--------------------------------

### initWithImage:

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPPrintContentBuilder.html

Initializes a new instance of the SCPPrintContentBuilder class with the provided image.

```APIDOC
## initWithImage:

### Description
Initializes a new instance of the SCPPrintContentBuilder class with the provided image.

### Declaration

**Objective-C**
```objectivec
- (nonnull instancetype)initWithImage:(nonnull UIImage *)image;
```

**Swift**
```swift
init(image: UIImage)
```

### Parameters
- **image** (UIImage) - Required - The image to be used for the print content.
```

--------------------------------

### init (Unavailable)

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPPrintContentBuilder.html

The default initializer is unavailable. Use initWithImage: instead.

```APIDOC
## init (Unavailable)

### Description
The default initializer is unavailable. Use initWithImage: instead.

### Declaration

**Objective-C**
```objectivec
- (nonnull instancetype)init;
```

### Availability
Unavailable. Use `initWithImage:`.
```

--------------------------------

### SCPErrorCollectInputsInvalidParameter

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Enums/SCPError.html

Error code indicating that an invalid parameter was used to start a collect inputs operation.

```APIDOC
## SCPErrorCollectInputsInvalidParameter

### Description
An invalid parameter was used to start a collect inputs operation.

### Declaration

**Objective-C**
```objc
SCPErrorCollectInputsInvalidParameter = 1997
```

**Swift**
```swift
static var collectInputsInvalidParameter: ErrorCode.Code { get }
```
```

--------------------------------

### Add Alamofire to Podfile

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/Example/Pods/Alamofire/README.md

Add Alamofire to your Podfile for CocoaPods integration. Run pod install after adding this line.

```ruby
pod 'Alamofire'
```

--------------------------------

### init(title:)

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPSignatureInputBuilder.html

Initializes a new instance of the SCPSignatureInputBuilder class with the provided title.

```APIDOC
## init(title:)

### Description
Initializes a new instance of the `SCPSignatureInputBuilder` class with the provided title.

### Declaration

**Objective-C**
```objc
- (nonnull instancetype)initWithTitle:(nonnull NSString *)title;
```

**Swift**
```swift
init(title: String)
```

### Parameters
- **title** (NSString) - Required - The title for the signature input.

### Return Value
A new `SCPSignatureInputBuilder` instance.
```

--------------------------------

### init (Unavailable)

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Classes/SCPHardcodedLocaleConfigBuilder.html

Unavailable. Use initWithLocale: instead.

```APIDOC
## init (Unavailable)

### Description
Unavailable. Use initWithLocale: instead.

### Declaration

**Objective-C**
```objc
- (nonnull instancetype)init;
```
```

--------------------------------

### reader:didStartReconnect:

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Protocols/SCPReconnectionDelegate.html

Deprecated delegate method called when the reader has lost Bluetooth connection and reconnection attempts have started.

```APIDOC
## reader:didStartReconnect:

### Description
Deprecated. Use `reader:didStartReconnect:disconnectReason:` instead. Called when the reader has lost Bluetooth connection to the SDK and reconnection attempts have been started. Implement this method to notify the user that the reader disconnected and reconnection attempts are being made.

### Declaration

**Objective-C**
```objc
- (void)reader:(nonnull SCPReader *)reader
    didStartReconnect:(nonnull SCPCancelable *)cancelable;
```

**Swift**
```swift
optional func reader(_ reader: SCPReader, didStartReconnect cancelable: SCPCancelable)
```

### Parameters
- **reader** (SCPReader) - The reader that is attempting to be reconnected to.
- **cancelable** (SCPCancelable) - A cancelable that can be used to stop reconnection.

### Requirements
- `autoReconnectOnUnexpectedDisconnect` must be set to `true` in the `SCPBluetoothConnectionConfig`.

### Notes
- This method will be removed in version 4.0. Update to `reader:didStartReconnect:disconnectReason:` to get the reason the reader disconnected. If that method is not implemented, this method will not be called.
```

--------------------------------

### init (Unavailable)

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPSelectionButtonBuilder.html

The default initializer is unavailable. Use initWithStyle:text:id: instead.

```APIDOC
## init (Unavailable)

### Description
The default initializer is unavailable. Use initWithStyle:text:id: instead.

### Declaration

**Objective-C**
```objc
- (nonnull instancetype)init;
```

```

--------------------------------

### SCPPhoneInput Initializers

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/docsets/StripeTerminal.docset/Contents/Resources/Documents/Classes/SCPPhoneInput.html

Unavailable initializers. Use SCPPhoneInputBuilder to create instances.

```APIDOC
## SCPPhoneInput Initializers

### Description
These initializers are unavailable. Use SCPPhoneInputBuilder to create instances.

### Methods

#### init
- **Availability**: Unavailable
- **Description**: Use SCPPhoneInputBuilder.
- **Declaration**: `- (nonnull instancetype)init;`

#### new
- **Availability**: Unavailable
- **Description**: Use SCPPhoneInputBuilder.
- **Declaration**: `+ (nonnull instancetype)new;`
```

--------------------------------

### SCPSetupIntentCollectionReason

Source: https://github.com/stripe/stripe-terminal-ios/blob/master/docs/docs/Saving Cards.html

A field used to indicate the reason for Setup Intent Collection. Changing this value can adjust the presented UI during collection. This value is only to be used with Tap To Pay readers.

```APIDOC
## SCPSetupIntentCollectionReason

### Description
A field used to indicate the reason for Setup Intent Collection. Changing this value can adjust the presented UI during collection. This value is only to be used with Tap To Pay readers.

### Declaration

**Objective-C**
```objectivec
enum SCPSetupIntentCollectionReason : NSUInteger {}
```

**Swift**
```swift
enum SetupIntentCollectionReason : UInt, @unchecked Sendable
```
```
Tokens:
Raw