Skip to content

Latest commit

 

History

History
145 lines (95 loc) · 3.39 KB

README.md

File metadata and controls

145 lines (95 loc) · 3.39 KB
Raw

NOTE: This repo is deprecated. Please use the new REST APIs

HitPay Android SDK (Point-Of-Sale Only)

License

About the SDK

This Android SDK is specifically designed for Point-of-Sales apps that wish to integrate Card Reader and Paynow transactions into their application.

NOTE: If you are looking for online payment acceptance please refer to these REST API docs

Example App

To run the example project, clone the repo, and open example app to android studio then run app.

Functionality

  • Authentication Allow your merchant to log in to their hitpay account.
  • Connect Card Reader Allow your merchant to connect their card reader to start accepting card payments
  • Accept Card Payment Allow your merchant to initiate a payment using the connected card reader
  • Accept PayNow Allow your merchant to initiate a payment using the PayNow QR code
  • Refund Transaction Allow merchant to perform a full refund on any transactions

Installation

HitPay-Android-SDK is available through Maven. To install it, simply add the following line to your Podfile:

  1. Add to Top-level build.gradle:
buildscript {
    ...
    dependencies {
        ...
        classpath 'com.dipien:bye-bye-jetifier:1.2.1'
    }
}
allprojects {
    repositories {
        ...
        //Hitpay
        maven { url 'https://jitpack.io' }
        maven { url 'https://d37ugbyn3rpeym.cloudfront.net/terminal/android-betas' }

    }
}
  1. Add to app build.gradle:
android {
  buildFeatures {
          dataBinding true
       }
}
dependencies {
    implementation 'com.hit-pay.android:com.hitpay.terminalsdk:0.0.6'
}

Authentication

Hitpay.initiateAuthentication()

// To get authentication listener: 
Hitpay.setHitPayAuthenticationListener(this);

// Sign out
HitPay.signOut()

Set Environment

//To set production environment set it = true, sandbox set it = false, defalt is true (production)
Hitpay.setEnv(true/false);

Connect Card Reader

// Enable or disable terminal simulation, default is disable.
Hitpay.setSimulatedTerminal(true/false);

// init Teminal
Hitpay.initiateTerminalSetup();

 // To get Terminal listener: 
Hitpay.setHitPayTerminalListener(this);

Accept Card Payment

Hitpay.makeTerminalPayment(amount: amount, currency: "sgd");

// Cancel current terminal payment, 
HitPay.cancelTerminalPayment()

 // To get Terminal Charge listener: chargeTerminalCompleted(), cancelTerminalPayment()
Hitpay.setHitPayTerminalChargeListener(this);

Accept PayNow QR

Hitpay.makePayNowPayment(amount: amount, currency: "sgd", , generateImage: true);
// "qrCode" represents the string value of the QRCode to be displayed.
// "qrImage" represents UIImage of the QRCode if generateImage set to true
  
  
 // To get Terminal Charge listener: 
Hitpay.setHitPayPayNowChargeListener(this);

Refund Transaction

Hitpay.refundCharge(charge_id: charge_id);

 // To get Refund listener: 
 Hitpay.setHitPayRefundListener(this);

Contact

Support: support@hit-pay.com

Author: 1bannamgiauten

License

HitPay-Android-SDK is available under the MIT license. See the LICENSE file for more info.