Citrus Payments Android SDK

Welcome to the open-source Android SDK Documentation of Citrus Payments Solution! ##Note: Prior to Version 3.4.3 we were using google analytics. We have removed google analytics from SDK. Please make sure you have removed google analytics dependecy from your build.gradle.

Please remove below line from your build.gradle if it exists

compile 'com.google.android.gms:play-services-analytics:7.8.0'

Download

Update your project’s build.gradle

Retrofit Version	Gradle Dependencies
Retrofit 1.9
	// Using Citrus SDK compile 'com.citrus.sdk:payment-sdk:3.4.3:retrofitoldRelease@aar' // citrus sdk dependencies for retrofit // For retrofit 1.9 compile 'com.squareup.retrofit:retrofit:1.9.0' compile 'com.squareup.okhttp:okhttp:2.3.0' // Other retrofit dependencies.( This is mandatory for retrofit 1.9 and retrofit 2.0) compile 'com.squareup.okhttp:okhttp-urlconnection:2.3.0' compile 'com.squareup.okio:okio:1.3.0' compile 'com.orhanobut:logger:1.8' compile "com.facebook.conceal:conceal:1.0.1@aar" <br /> <br /> // Other additional dependencies (You may skip these if you are already using these in your app). <br /> compile 'com.android.support:appcompat-v7:23.1.1' <br /> </td>
Retrofit 2.0
	// Using Citrus SDK compile 'com.citrus.sdk:payment-sdk:3.4.3:retrofitnewRelease@aar' // citrus sdk dependencies for retrofit // For retrofit version 2.0 compile('com.squareup.retrofit:retrofit:2.0.0-beta2') { exclude module: 'okhttp' } compile 'com.squareup.okhttp:okhttp:2.5.0' compile 'com.squareup.retrofit:converter-gson:2.0.0-beta2' compile 'com.squareup.okhttp:logging-interceptor:2.6.0' //to enable logging // Other retrofit dependencies.( This is mandatory for retrofit 1.9 and retrofit 2.0) compile 'com.squareup.okhttp:okhttp-urlconnection:2.3.0' compile 'com.squareup.okio:okio:1.3.0' compile 'com.orhanobut:logger:1.8' compile "com.facebook.conceal:conceal:1.0.1@aar" <br /> <br /> // Other additional dependencies (You may skip these if you are already using these in your app). <br /> compile 'com.android.support:appcompat-v7:23.1.1' <br /> </td>

If you are using Google Play Services library in your project and if you are facing multidex problem , update build.gradle as below

compile ('com.citrus.sdk:payment-sdk:3.4.3:retrofitoldRelease@aar')  {
    transitive = false
}

        OR 
        
compile ('com.citrus.sdk:payment-sdk:3.4.3:retrofitnewRelease@aar')  {
    transitive = false
}

Release Notes

Update Top-level build.gradle.

buildscript {
    repositories {
        mavenCentral()
        jcenter()
}
dependencies {
        classpath 'com.android.tools.build:gradle:1.3.1'
        }
}
allprojects {
    repositories {
        maven { url "http://dl.bintray.com/populov/maven" } 
        mavenCentral()
        jcenter() 
    }
}

Eclipse

* Get the code git clone https://github.com/citruspay/citrus-android-sdk.git
* Import citrus-library project in your workspace
* Copy files from Example/libs into your apps libs folder
* You are good to go!

---

Introduction

___ * This document details the merchant's Android App integration with Citrus Payment gateway.There is a difference between Normal(PG) Payment and Prepaid Payment! * Normal payment requires only email and mobile. Citrus User account will be created by only using email and mobile combination. We call it as Bind. Once user is Bind, card can be saved against his account, saved cards can be fetched against his account. * Prepaid Payment requires email and password. Citrus User account will be created by using email and password combination. We call it prepaid account.

This is enhanced version of SDK V2 wherein you can implement your App with features such as:

• Pay using Credit Card/Debit Card & Netbanking
• Pay Using Citrus Cash - user can make a payment using Citrus Cash account if he has sufficient amount for payment.
• Get Citrus Cash balance
• Load Money – money can be loaded to user’s account using CC/DC/NB option.
• Save Cards and Bank options to user account for faster checkout
• Fetch Saved cards of user
• Delete Cards
• Send Money
• Logout your user from App
• Withdraw your Money

Few more points on SDK V3

___ * SDK response time optimization- over 5x faster response compared to V2 * Everything is Object now. No more JSON parsing required. * Improved WebView. WebView is handled by SDK. * Uniform responses from SDK across different API’s * Support for Citrus Cash. * Added support to gradle/Android Studio * Less Integration Time Required. * Zero click payment using Citrus Cash.

Prerequisites

* Before you Start

Lets Start...

Initiation

• Initiate Citrus SDK
• How to enable logs

Implementation for User creation and management

• See if the User is logged/Signed in  
• Link User Extended
• Reset Password
• Logout the User

Get Payment Options

• Fetch Normal(PG) Payment Options (Required while making a Normal payment)
• Fetch Load Money Payment Options (Required during Adding/Loading Money to Wallet)

Wallet

• Get Citrus Cash balance (Note: User should be Signed In for this Implementation)
• Add Money/Load Money into Citrus Account
• Add Money/Load Money into Citrus Account using Saved cards

Payment

• Pay using Credit/Debit Card & Net Banking
• Get Wallet (It fetches all Saved Cards and Bank options of the User's account)
• Pay using Saved Cards and Net banking
• Pay using Citrus Cash (Note: User should be Signed In for this Implementation)

#####Dynamic Pricing Offer Coupons and Surcharge

• How to use dynamic pricing ?

One Tap Card Payment

• One Tap Card Payment

How to save Cards option and Banks

• Save Debit/Credit Card and Net banking

Others...

• Send Money To Your Friend
• Withdraw Money to Your Account

---

How to Go Live...

• Changes inside Bill Generator and Returl Url Files
• Keys and Environment inside citrusClient.init
• Progaurd changes(If required)

---