# Models

## PsBluetoothDevice (BBPOS Only)

## PsDeviceInfo

## PsSaleRequest

## PsSaleResponse

## PsSaleOutcome

## PsCardData

## PsEmvResponseData

🚧

EMV Receipt Requirements

**THE FOLLOWING ARE REQUIRED FOR EMV RECEIPTS** Application Identifier (AID) of the application used. Application Preferred Name (if available and supported) or Application Label Cryptogram type/value Host Response Code/Host Response Message (e.g. 00/AP, etc) Host Response Message

# Methods

## Initialize SDK - Class Method

Initializes the SDK and returns TRUE if initialization occurred without error. This method should only need to be called once while the app is running.

Example Implementation:

## Re-Initialize SDK - Class Method

Sets the shared instance to nil to allow the SDK to reinitialized with a different device type or environment. You must first disconnect the current device associated with the shared instance.

❗️

Disconnect current device first

The code sample below includes disconnecting the current device first which must be done before resetting the SDK.

Example Implementation:

## SharedInstance - Class Method

Returns a shared instance of the PsSDK service.

Example Implementation:

## IsInitialized - Class Method

Returns BOOL to indicate if the SDK has been initialized and a shared instance exists.

Example Implementation:

## Scan for Bluetooth enabled devices (BBPOS only) - Instance Method

**Optional for BBPOS device.** Will scan for all powered on BBPOS devices within range of the iOS device. Executes completion handler once scan is complete (2 - 5 seconds). Allows for connecting to a specific BBPOS device when multiple devices are present. Can associate returned serial numbers with devices and send a specific serial number to connect to in ConnectDeviceWithClientToken. Requires a client token in order to initiate the scan for devices that are enabled for your client/merchant key.

Example Implementation:

## ConnectDeviceWithClientToken - Instance Method

**Required for BBPOS device.** Connects to the card reader device. Not required for iDynamo or Rambler implementation. Executes completion handler once connected. Getting a new client token prior to calling this method is strongly recommended to avoid token validation/expiration issues.

Example Implementation:

## ConnectDeviceWithHandler - Instance Method

Connects to the card reader device. Optional for iDynamo since MakeSale will make the connection for you. Executes completion handler once connected.

Example Implementation:

## DisconnectDeviceWithHandler - Instance Method

Disconnects the device. Not explicitly needed in most situations but can be used to disconnect the device after a sale is made if you need to do some disconnect based logic in your app or to prevent any further swipe data being read.

Example Implementation:

## IsDeviceConnected - Instance Method

Returns BOOL to indicate if the device is connected or not.

Example Implementation:

## GetDeviceName - Instance Method

Returns **NSString** of the attached device name. Returns nil if no device is connected. Possible values: "iDynamo", "BBPOS"

Example Implementation:

## GetDeviceBatteryPercentage - Instance Method

Returns **NSString** of the attached device battery percentage. Returns nil if no device is connected. Possible values: "99", "50" etc

Example Implementation:

## MakeSaleWithClientToken - Instance Method

Makes a sale using a PaySimple [Client token](🔗), a **PsSaleRequest** object and a completion handler. Getting a new [Client token](🔗) prior to calling this method is strongly recommended to avoid token validation/expiration issues. For iDynamo this method will automatically attempt to connect to the iDynamo device so explicit separate connection logic is not needed. If no connection can be made to the iDynamo device and error will be returned to allow for retry logic in your implementation.

Example Implementation:

## StopCurrentBbposFlow - Instance Method

Call this method to stop the current BBPOS sale flow if it has already been started. For example you have prompted the customer to insert, swipe or chip read card. This is stop the sale flow connection with the BBPOS device and reset it to an idle state.

Example Implementation:

# Delegates

## deviceConnectionDidChange - Optional delegate

Delegate fires when the connection status if the device changes.

Example Implementation:

## onBbposDisplayText - Optional delegate

Delegate fires when the BBPOS device has text to display to the user such as prompts. Examples include "Insert, Swipe or Tap Card", "Remove Card", "Thank you" etc.

Example Implementation:

## onBbposRemoveCard - Optional delegate

Delegate fires when the BBPOS device detects that the card has been removed. Should stop current BBPOS sale flow if this delegate fires.

Example Implementation:

## onBbposDeviceInitializationProgress - Optional delegate

Delegate fires when the BBPOS device pairs with the phone or tablet. Will repeatedly fire until device pairs. First time device pairs to BBPOS, BBPOS must be at least 50% charged.

Example Implementation:

## onBbposBatteryLow - Optional delegate

Delegate fires when the BBPOS device battery level is low

Example Implementation:

## onBbposDidDisconnect - Optional delegate

Delegate fires when the BBPOS device disconnects

Example Implementation:

## onBbposDidError - Optional delegate

Delegate fires when the BBPOS device returns an error that is device related and not sale related.

Example Implementation: