Skip to content

Latest commit

 

History

History
143 lines (96 loc) · 5.69 KB

README.md

File metadata and controls

143 lines (96 loc) · 5.69 KB
Raw

  • Cm POS Payments ECR app

    Version 3.0.0

    The ECR application handles the merchant UI, card payments and transaction result user guidance. The application is designated for Sunmi Android platform, but will work on other Android device and in the Android Emulator as well.

    Release notes

    This app includes a basic implementation of the Cm POS payments Android POS integration library (a.k.a SDK) as an example. The complete functionality included in the library is used in this example.

    Compatibility table

    ECR SDK Terminal

  • | 3.1.1 | 1.1.4 | 2.7.0 | | 3.0.0 | 1.1.2 | 2.0.0 | | 2.1.0 | 1.1.0 | 1.2.0 | | 2.0.1 | 1.0.1 | 1.1.1 | | 2.0.0 | 1.0.0 | 1.1.1 |

    Versions

    3.1.1

    • Use new version 1.1.4 of the Android POS Integration library
    • Refactor some parts of the application

    3.0.0

    • Rebrand from generic brand to CM brand
    • Bug fixes

    2.1.0

    • Adds pre authorization functionality:
      • Start pre authorization
      • Cancel pre authorization
      • Confirm pre authorization
    • Receipt view fixed
    • Stability improvementss

    2.0.1

    • Handles AUTO_TIMEZONE_NOT_ENABLED error

    2.0.0

    Includes a basic implementation of the SDK integration.

    Getting started

    Hardware devices

    • This app is designed and tested for Sunmi devices.
    • This app has been tested in Sunmi P2 lite, Sunmi P2 Pro and Sunmi P2 mini.

    Prerequisites

    • Cm POS Payments Terminal application must be installed in the device. Version 1.1.1 or higher.
    • Android 7 (api 25) or higher.
    • The device you'll use must have installed 'SunmiPayHardwareService'. Version v3.3.140 or higher.

    Installation

    • Check if Java 8 (for Android Studio) and Java 11 (for Gradle) are installed. It can be done through Android Studio.

    • Then, save your global credentials (optional):

      git config --global user.email "<your_user_name_here>@<your_domain>.com"
git config --global user.password "<your_password_here>"

    • Clone this repository and import into Android Studio

      git clone https://github.com/cmdotcom/sunmi-ecr-example-kotlin.git

    Development notes

    • This application is implemented in kotlin language (provided by Android Studio).
    • Is a standard Android Studio project.
    • The version of Android Studio used at the time of writing this is Android Studio Artic Fox | 2020.3.1 Patch 4 64 bits version
    • Android 7.1.1 (Nougat) SDK 25 must be installed in Android Studio
    • The gradle version used for build the project is 7.0.3 64 bits version

    Build notes

    • Is up to development team configure build types. Debug build is available by default. The proper version of the integration SDK must be imported as a gradle dependency:

      • Repository to import dependencies:

        dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven { url 'https://jitpack.io' }
    }
}

      • Debug:

        dependencies {
    // CM|PayPlaza Android POS Integration library
    implementation 'com.github.cmdotcom.android-pos-integration-sdk-kotlin:androidposintegrationsdk-debug:<version-tag>'
}

      • Production:

        dependencies {
    // CM|PayPlaza Android POS Integration library
    implementation 'com.github.cmdotcom.android-pos-integration-sdk-kotlin:androidposintegrationsdk:<version-tag>'
}

    Features

    • Transactions.

      • Payment. Just select the desired amount and tap on check in the bottom-right of the numeric keypad. Follow the instructions to present the card and check the receipt.

      • Refund. Fill the previous from with refund password, operation STAN, amount to refund (never higher than the refunded payment) and select the date when the payment was done. Follow the instructions to present the card and check the receipt.

        *Note: STAN is provided in the receipt of the payment.

    • Last receipt. Shows the receipt of the last operation.

    • Day totals. Shows the operations done during the current day.

    • Pre-authorization. Saves an amount of money that can be canceled or confirmed in the future. To cancel or confirm a transaction is necessary the STAN code of the transaction. The STAN code is in the receipt showed after start a pre-authorization. Confirm pre-authorization also needs the amount. This amount can't be higher than the amount of start pre-authorization but it can be lower. It is also necesary to indicate the date of the previous pre authorized transaction in order to confirm or cancel the first pre authorization transaction.

      • Start pre-authorization.
      • Cancel pre-authorization.
      • Confirm-preauthorization.

    • Recovery process. Shows the operation statuses. It allows check the status of the last operation so user can decide if a refund is necessary or whatever action is needed.

      *Note: you can access each feature from the menu but recovery process. It is launched when Terminal application crashes or there is a pending receipt to be shown. For more details please check SDK integration guide.