# Models

## ECPDevice

## ECPPaymentParameters

## ECPSdkEventConstants

Constants to be used to help consumers specify which events they would like to listen to when calling **Initalize Sdk**.

These string values will be accessible through the ECPSdkEventsConstants class. An example below shows creating a sample set of Events utilizing ECPSdkEventConstants.

## ECPSaleResponse

## ECPSaleOutcome

## ECPCardData

## ECPEmvData

# Client Token Block

Authorization via Client Token is required to use this SDK. In this SDK, we have introduced the concept of a Client Token Block which consumers will pass in to the **Initialize Sdk** method in order to ensure the SDK is able to associate and authenticate with the proper merchant/client.

Before integrating to our SDK, you should create an endpoint on your secure backend server which returns the proper PaySimple client token for a particular PaySimple user that you are trying to use this SDK with. How you map your application's users to a PaySimple user is up to you in your backend - you just need to be sure to use this Client Token Block to get a proper PaySimple token tied to the user you would like to utilize the SDK for each time you initialize. The type of authorization token currently supported will be <https://documentation.paysimple.com/v2019/docs/authorization#client-token-authorization-rarely-used> .

❗️

The client token code block you provide will then be called by our SDK as needed during various actions which require PaySimple authorization.

Here is a mock implementation of a Client Token Block to help get you started. **Notice how in the failure flows for getting the token, completion handler is called with nil and an error. When you successfully fetch the token, the completion handler should be called with the token and a nil error.**

## Client Token Authorization Example

After defining this client token block, you can then pass it into the Initialize SDK method. See below a sample call, on how we access this userClientTokenBlock variable which was created.

# Class Methods

## Shared Instance

Returns a shared instance of the ECPSdk service. If you would like, you can store this in a variable to later be accessed by your class.

Example Implementation:

# Instance Methods

🚧

Important

As best practice, make sure the completion handler of one operation within the ECPSdk is called prior to attempting to execute an additional operation, to avoid unintended behavior.

## Initialize SDK

Initializes the SDK. Provides a completion handler to determine the result of the SDK initialization. Returns YES if initialization occurred without error. Consumers must initialize the SDK prior to any other SDK actions. User must pass in environment, list of events they would like to subscribe to, and a **Client Token Block**

Example Implementation:

## Is Initialized

Returns BOOL to indicate if the SDK has been initialized.

Example Implementation:

## Reset SDK

Clears out SDK data. Clears processor data, client token block data, event initialization data, any data that was setup in Initialize SDK. Disconnects device. Allows consumer to start fresh with a reset instance of the SDK to help with changing users, clearing config.

Example Implementation:

## Discover Devices

Discovers devices powered on and within range of the iOS device to be used with the SDK. **Currently only officially supported for Stripe M2 Reader device. If you have another brand of bluetooth reader turned on and in range, the discover devices may show the device. However, only Stripe M2 will currently work with Connect Device.**

❗️

Mobile device settings warning (Stripe M2)

For the Stripe M2 Reader, do not use your own mobile device settings when pairing with an M2 reader using the SDK. Pairing the reader through your mobile device settings may make the reader unavailable to connect through our SDK. Please rely on our ECPSdk to help guide the connection process.

Example Implementation:

## Connect Device

**Currently only officially supported for Stripe M2 Reader device.** Connects to the card reader device and prepares the device to take payments, fire off events, report information. A reader can only connect to one instance of the SDK at a time. **Note - a reader may need to update on the connect process. The reader will not finish the connect process until required updates succeed. If a reader needs to update, ensure your reader is charged greater than 50 percent. Monitor ECPDeviceConfigStatusEvent and ECPDeviceConfigProgressEvent to track update status.**

Example Implementation: See the example below. This example uses discover devices to discover available devices to use, and then as an example selects the first device in the devices array. The first device from the devices array is then passed into the connectDevice method. We then attempt to connect to the device.

## Disconnect Device

Disconnects the currently connected device.

Example Implementation:

## Make Sale

Makes a sale for the amount specified. This requires that the SDK is initialized and that the Client Token Block above is set up correctly in order to retrieve a current client token for communication with PaySimple.

Example implementation:

## Stop Current Flow

Stops a payment from completing. This can be done before the payment method is collected. Once the payment method is collected, the payment flow will run to completion.

Example implementation:

## Get Device Info

Returns information about the connected device.

Example Implementation:

# Delegates / Events

The SDK provides an ECPSdkDelegate protocol to help expose delegate methods to report on SDK Events. Currently, the ECPSdkDelegate provides one optional method -(void)onDeviceEvent:(ECPSdkEvent \*)event; . In order to use this protocol within your application and listen to delegates, please mark the class you would like to use the protocol/delegate in as implementing the interface. For example, if you would like to use the protocol/delegate on the home page view controller of your application, your class declaration may look as follows:

In HomePageViewController.h file:

In HomePageViewController.m file, include the following delegate method:

The SDK also has an id<ECPSdkDelegate> type accessible through sharedECPSdk.delegate which needs to be wired up for use, to make everything work properly. You can wire up the delegate for use by attaching and wiring up to the delegate through a line of code like or similar to below in the class(es) which utilize the ECPSdkDelegate protocol:

## ECPSdkEvent Types

A generic type of event will be used as the base class for SDK events. This type is represented by a base class of ECPSdkEvent.

**ECPSdkEvent**

👍

Different subclasses of ECPSdkEvent will be utilized to represent different events. These classes are represented in the charts below.

**ECPConnectionChangedEvent**

Event that fires when a device connection status change is reported.

**ECPDeviceBatteryEvent**

Event that fires when a battery event is reported.

**ECPDeviceCardEvent**

Event that fires when a card is inserted or removed.

**ECPDeviceMessageEvent**

Event that fires when a device attempts to prompt a user.

**ECPDeviceConfigStatusEvent**

Event that fires when a config event takes place from a device. **Note - on a config update event some readers may be unusable until required updates are completed.**

**ECPDeviceConfigProgressEvent**

Event that fires to report on config event progress.

## onDeviceEvent - Optional Delegate

Delegate fires when one of the subclasses of ECPSdkEvent is reported from the SDK and the SDK consumer has chosen to subscribe to the particular event. See **ECPSdkEventConstants and the subscribedEvents parameter in Initialize Sdk for how to specify which events you would like to subscribe to.**

Example Implementation: See the below code block for sample implementation of listening and reporting on device events. This particular example uses if else statements and class type to determine the type of ECPSdkEvent that came through. Consumers are free to determine their own best practice for their particular use case to determine the type of ECPSdkEvent, below is just one example. Consumers can then utilize the specific event type that is known to exist and access event specific information to utilize in their application.

🚧

Important: If you are utilizing information in delegates to update UI, please follow best practices and dispatch UI changes to the main thread.