cp_int_pos_custom_installation

Welcome to the Developer Portal

Default UI Integration
- Integrating Default UI
- Migrating from PayButton to Default UI
- Managing Default UI Properties
- Summary Screen
- Incremental Authorization
- Custom Receipt Printing
- Automatic Receipt Printing
- Standalone Receipt Printing
- Sending Receipts via Email
- Customization
- Mobile UI Customization
- Release Notes

PayButton Integration
- Integration
- Stripe Transactions
- Alipay
- Summary Screen
- On-Reader Tipping
- Tip Adjust
- Loyalty and Bonus Cards
- Pre-Auth and Capture
- Refunds
- Custom Receipts
- Testing
- Going Live
- Release Notes

Custom Integration
- Installation
- Integration
- Stripe Transactions
- Signature
- Refunds
- Email & Print Receipts
- Custom Receipts
- Custom Receipts for PAX Terminals
- Preformatted Receipts
- Alipay
- On-Reader Tipping
- Tip Adjust
- Loyalty & Bonus Cards
- Pre-Auth & Capture
- Connection Keep-Alive
- Testing
- Going Live

Backend Integration
- API Endpoints and Authentication
- WebHooks
- Query Transactions
- Refunds
- Custom Receipts
- Going Live
- API Documentation

Merchant Setup
- AMEX Merchant Setup
- Barclaycard APACS Merchant Setup
- Barclaycard HISO Merchant Setup
- Credorax Merchant Setup
- Elavon Merchant Setup
- EVRY Merchant Setup
- net-m Privatbank Merchant Setup
- Nexi Merchant Setup
- Stripe Merchant Setup
  - Stripe Direct and Stripe Connect
  - Stripe Connect

Installing the SDK

The SDK is designed to work with iOS 10 and higher. Use these instructions to install the SDK via CocoaPods. To install the SDK manually, use these instructions.

Installing the SDK via CocoaPods

Put this in your

Podfile

and then run

pod install

source 'https://github.com/CocoaPods/Specs.git'
source 'https://github.com/visa/mpos.sdk.ios.pods.git'
use_frameworks!
                    
target :"<your-app-target>" do
   pod 'payworks', '2.63.0'
 end

Additional Step for Bluetooth Devices

For a Bluetooth device, such as a Miura card reader, to connect as an external accessory and to be able to receive messages while the app is in the background, add additional entries to your

Info.plist

Key: Supported external accessory protocols (

UISupportedExternalAccessoryProtocols

), Value:

com.miura.shuttle

–- for Miura readers.

Key: Required background modes (

UIBackgroundModes

), Value: App communicates with an accessory (

external-accessory

)

Then, import the framework in your header file:

#import <mpos_core/mpos_extended.h>

You can now implement your first transaction workflow.

Installing the SDK

The SDK is designed to work with Android 5 and higher. To install the SDK via our Gradle repository, use these instructions. To install the SDK manually, see these instructions.

Installing the SDK via Gradle

Add our repository to your project's

build.gradle

allprojects {
    repositories {
        jcenter()
        maven {
            url "https://repo.visa.com/mpos-releases/"
        }
    }
}

For version 2.45.0 and above, make sure the app support Java 8 features by setting the compatibility levels:

android{

    ...

    compileOptions {
        sourceCompatibility = 1.8
        targetCompatibility = 1.8
    }
}

Add the following exclusion rules to your module's

build.gradle

(inside the Android section):

packagingOptions {
    exclude 'META-INF/*'
    exclude 'LICENSE.txt'
    exclude 'asm-license.txt'
}

Add the libraries to the dependencies section of your module's

build.gradle

dependencies {implementation 'io.payworks:mpos.android.core:2.89.0'
                    
// Add these three dependencies if you want to use a Miura card reader
                    
implementation 'io.payworks:mpos.java.accessories.miura:2.89.0'
implementation 'io.payworks:mpos.android.comlinks.bluetooth:2.89.0:@aar'
implementation 'io.payworks:mpos.java.comlinks.tcp:2.89.0'
                    
// Add these two dependencies if you want to use a Verifone card reader
implementation 'io.payworks:mpos.java.accessories.vipa:2.89.0'
implementation 'io.payworks:mpos.java.comlinks.tcp:2.89.0'
}

If you want to use ProGuard with your application, make sure to add the necessary rules to your ProGuard configuration.

Make sure to update your

AndroidManifest.xml

file to enable a larger heap size by setting the parameter and value:

android:largeHeap="true"

. This setting is required to accommodate situations in which an update of the terminals is required and bigger chunks of data are requested and transferred.

    <application
        [...]
        android:largeHeap="true">
            [...]
    </application>

Custom Integration

Related information