ANDRIOD SDK PAYMENT INTEGRATION KIT

Easy integration, Great support

Pre-Requisites

Below are the prerequisites to integrate with Payment Gateway:

Be an Approved Merchant: To use our payment gateway, you should be a registered and approved merchant by us. If not registered, please register to get started!
Obtain API Key: You should have received an API key from us on Approval.
API to receive Payment Response: You should have a self-hosted web server to receive the response and verify the payment details post payment.
Min SDK Requirements: You should ensure that your Android App’s SDK version should be greater than or equal to 21

Downloads

These are the download links available

Download AAR for SDK 19 to 27 : AAR for SDK 19 to 27
Download AAR for AndroidX : AAR for AndroidX

Sample code for SDK 19 to 27 : Sample code for SDK 19 to 27
Sample code for AndroidX : Sample code for AndroidX

Integration Steps

Download the appropriate Android AAR file and unzip it.
Copy the PGSDKVR4 AAR file and save this in your Desktop.

Add the PGSDKVR4 AAR library to your app:

Click File > New > New Module

Click Import .JAR/.AAR Package then click Next
Enter the location of the PGSDKVR4 AAR file then click Finish
Make sure ARR library is listed at the top of your settings.gradle file, as shown below :

For SDK 19-27 : include ':app', ':PGSDKVR4'
For AndroidX : include ':app', ':pgsdkv5ax'

Open your app module’s build.gradle file and add the below line to the dependencies block as shown in the following snippet:

For SDK 19-27 : dependencies: { implementation project(":PGSDKVR4") }
For AndroidX : dependencies: { implementation project(":pgsdkv5ax") }

Click Sync Project with Gradle Files

Make sure you have the below permissions in your manifest file:

android.permission.INTERNET
android.permission.ACCESS_WIFI_STATE

Set these payment parameters

pgPaymentParams.setAPiKey(SampleAppConstants.PG_API_KEY);

pgPaymentParams.setAmount(SampleAppConstants.PG_AMOUNT);

pgPaymentParams.setEmail(SampleAppConstants.PG_EMAIL);

pgPaymentParams.setName(SampleAppConstants.PG_NAME);

pgPaymentParams.setPhone(SampleAppConstants.PG_PHONE);

pgPaymentParams.setOrderId(SampleAppConstants.PG_ORDER_ID);

pgPaymentParams.setCurrency(SampleAppConstants.PG_CURRENCY);

pgPaymentParams.setDescription(SampleAppConstants.PG_DESCRIPTION);

pgPaymentParams.setCity(SampleAppConstants.PG_CITY);

pgPaymentParams.setState(SampleAppConstants.PG_STATE);

pgPaymentParams.setAddressLine1(SampleAppConstants.PG_ADD_1);

pgPaymentParams.setZipCode(SampleAppConstants.PG_ZIPCODE);

pgPaymentParams.setCountry(SampleAppConstants.PG_COUNTRY);

pgPaymentParams.setReturnUrl(SampleAppConstants.PG_RETURN_URL);

pgPaymentParams.setMode(SampleAppConstants.PG_MODE);

pgPaymentParams.setUdf1(SampleAppConstants.PG_UDF1);

pgPaymentParams.setUdf1(SampleAppConstants.PG_UDF2);

pgPaymentParams.setUdf1(SampleAppConstants.PG_UDF3);

pgPaymentParams.setUdf1(SampleAppConstants.PG_UDF4);

pgPaymentParams.setUdf1(SampleAppConstants.PG_UDF5);

Initiate the “com.test.pg.secure.pgsdkv4.PaymentParams” CLASS to

Initiate the payment

PaymentGatewayPaymentInitializer pgPaymentInitialzer = new PaymentGatewayPaymentInitializer(pgPaymentParams,MainActivity.this);

pgPaymentInitialzer.initiatePaymentProcess();

To receive the json response, override the onActivityResult() using the REQUEST_CODE and PAYMENT_RESPONSE variables from com.test.pg.secure.pgsdkv4.PaymentParams class

Payment Response Code

Note:

Request parameters are the parameters that will be sent to our server API for payment initiation. Client should store the order id and the amount before payment initiation and compare it with the order id and amount in the response Json from our server post payment process to ensure no end user tampering on the requested parameters.

List of Request Parameters

Parameter Name	Descrpition	Required	Datatype
api_key	We would assign a unique 40-digit merchant key to you. This key is exclusive to your business/login account. If you have multiple login accounts, there will necessarily be one different api_key per login account that is assigned to you.	Mandatory	String - Max:40
order_id	This is your (merchant) reference number. It must be unique for every transaction. We do perform a validation at our end and do not allow duplicate order_ids for the same merchant.	Mandatory	String - Max:30
mode	This is the payment mode (TEST or LIVE are valid values)	Optional	String - Max:4
amount	This is the payment amount	Mandatory	Max digits before decimal 15 + Max digits before decimal 2
currency	This is the 3-digit currency code INR	Mandatory	String - Max:3
description	Brief description of product or service that the customer is being charged for	Mandatory	String - Max:200
name	Name of the customer	Mandatory	String - Max:200
email	Customer email address	Mandatory	String - Max:200
phone	Customer phone number	Mandatory	String - Max:30
address_line_1	Customer's address line 1	Optional	String - Max:255
address_line_2	Customer's address line 2	Optional	String - Max:255
city	Customer city	Mandatory	String - Max:50
state	Customer state	optional	String - Max:50
country	Customer Country	Mandatory	String - Max:10
zip_code	Customer zipcode	Mandatory	Integer - Min:0,Max:1000
timeout_duration	Timeout Duration (in seconds)	Optional	String - Max:300
udf1	User defined field 1	Optional	String - Max:300
udf2	User defined field 2	Optional	String - Max:300
udf3	User defined field 3	Optional	String - Max:300
udf4	User defined field 4	Optional	String - Max:300
udf5	User defined field 5	Optional	String - Max:300
return_url	Return URL success - Omniware will make a POST request to this URL after successful transaction, with a set of parameters, which you can process as you want to.	Mandatory	String - Max:200
return_url_failure	Return URL failure - Omniware will make a POST request to this URL after a FAILED transaction, with a set of parameters, which you can process as you want to	Optional	String - Max:200
return_url_cancel	Return URL failure - Omniware will make a POST request to this URL after a FAILED transaction, with a set of parameters, which you can process as you want to	Optional	String - Max:200
percent_tdr_by_user	Percent of tdr amount paid by user (optional) (max value:100)	Optional	Integer - Min:0,Max:100
flatfee_tdr_by_user	Fixed fee paid by user	Optional	Integer - Min:0, Max:99999999
show_convenience_fee	Controls whether the convenience fee amount (for surcharge merchants) is displayed to the customer (on the payment page) or not	Optional	String - Max:1
split_enforce_strict	Controls whether payment is required to be split before settlement. By default, it is set to 'n', If this is set to 'y' then settlement will be on HOLD until splitsettlement api is called to provide split information	Optional	String - Max:1
payment_options	payment options to be displayed such credit card (cc), net banking (nb), wallet (w), ATM card (atm) and debit card with pin (dp). Tabs will be displayed by order in which values are sent . Values accepted are: cc,nb,w,atm,upi,dp (comma separated string)	Optional	String - Max:20
payment_page_display_text	This text will be displayed below the logo on payment page.	Optional	String - Max:200

List of Response Codes

Code	Response Code	Response Message
0	SUCCESS	Transaction successful
1000	FAILED	Transaction failed
1001	INVALID-API-KEY	The api key field is incorrect
1002	INVALID-LIVE-MODE-ACCESS	The live mode access is not allowed
1003	INVALID-ORDER-ID-FIELD	The order id field should to be unique
1004	ORDER-ID-FIELD-NOT-FOUND	The order id field is not found
1005	INVALID-AUTHENTICATION	Invalid authentication at bank
1006	WAITING-BANK-RESPONSE	Waiting for the response from bank
1007	INVALID-INPUT-REQUEST	Invalid input in the request message
1008	TRANSACTION-TAMPERED	Transaction tampered
1009	DECLINED-BY-BANK	Bank Declined Transaction
1010	INVALID-AMOUNT	Amount cannot be less than 1
1011	AUTHORIZATION-REFUSED	Authorization refused
1012	INVALID-CARD	Invalid Card/Member Name data
1013	INVALID-EXPIRY-DATE	Invalid expiry date
1014	DENIED-BY-RISK	Transaction denied by risk
1015	INSUFFICIENT-FUND	Insufficient Fund in Customer Account
1016	INVALID-AMOUNT-LIMIT	Total Amount limit set for the terminal for transactions has been crossed
1017	INVALID-TRANSACTION-LIMIT	Total transaction limit set for the terminal has been crossed
1018	INVALID-DEBIT-AMOUNT-LIMIT	Maximum debit amount limit set for the terminal for a day has been crossed
1019	INVALID-CREDIT-AMOUNT-LIMIT	Maximum credit amount limit set for the terminal for a day has been crossed
1020	MAXIMUM-DEBIT-AMOUNT-CROSS	Maximum debit amount set for per card for rolling 24 hrs has been crossed
1021	MAXIMUM-CREDIT-AMOUNT-CROSS	Maximum credit amount set for per card for rolling 24 hrs has been crossed
1022	MAXIMUM-TRANSACTION-CROSS	Maximum transaction set for per card for rolling 24 hrs has been crossed
1023	HASH-MISMATCH	Hash Mismatch
1024	INVALID-PARAMS	Invalid parameters
1025	INVALID-BANK-CODE	Invalid bank code
1026	INVALID-MERCHANT	Merchant is not active
1027	INVALID-TRANSACTION	Invalid transaction
1028	TRANSACTION-NOT-FOUND	Transaction not found
1029	TRANSACTION-TERMINATED	Transaction terminated.
1030	TRANSACTION-INCOMPLETE	Transaction incomplete
1031	AUTO-REFUNDED	Transaction auto refunded
1032	REFUNDED	Transaction refunded
1033	SINGLE-TRANSACTION-LOWER-LIMIT-CROSS	The amount provided is less than transaction lower limit
1034	SINGLE-TRANSACTION-UPPER-LIMIT-CROSS	The amount provided is more than transaction upper limit
1035	TRANSACTION-DAILY-LIMIT-CROSS	The daily transaction limit is exceeded for the merchant
1036	TRANSACTION-MONTHLY-LIMIT-CROSS	The monthly transaction limit is exceeded for the merchant
1037	DAILY-TRANSACTION-NUMBER-CROSS	The daily transaction number is exceeded for the merchant
1038	MONTHLY-TRANSACTION-NUMBER-CROSS	The monthly transaction number is exceeded for the merchant
1039	INVALID-REFUND-AMOUNT	The refund amount is greater than transaction amount.
1040	INVALID-CVV	Invalid Card Verification Code.
1041	AUTO-REFUNDED-TNP	Transaction is auto refunded by TnP
1042	FAILED-NO-RESPONSE	Transaction failed as there was no response from bank.
1043	TRANSACTION-CANCELLED	Transaction cancelled
1044	UNAUTHORIZED	Unauthorized.
1045	FORBIDDEN	Forbidden Access.
1046	TRANSACTION-ALREADY-CAPTURED	Transaction already captured.
1047	AUTHORIZED	Transaction authorized.
1048	CAPTURED	Transaction captured.
1049	VOIDED	Transaction voided.
1050	NO-RECORD-FOUND	No data record found for the given input.
1051	ACQUIRER-ERROR	Error occurred at the bank end.
1052	INVALID-EMAIL	Invalid Email ID.
1053	INVALID-PHONE	Invalid phone number.
1054	SESSION-TIMEOUT	Session expired. Please go back and try again.
1055	SEAMLESS-NOT-ALLOWED	Seamless payment not allowed.
1056	INVALID-VPA	Virtual Payee Address is invalid.
1057	3DS-FAILED	3D Secure authentication failed.
1058	ACCOUNT-BLOCKED	Bank Account is blocked.
1059	ACQUIRER-MAX-TRANSACTION-LIMIT	Transaction amount limit has exceeded.
1060	ACQUIRER-MIN-TRANSACTION-LIMIT	The amount provide is less than minimum transaction amount allowed.
1061	ACQUIRER-VELOCITY-LIMIT	Transaction frequency limit has exceeded.
1062	CARD-EXPIRED	Card has expired.
1063	HOTLISTED	Stolen or Lost Card.
1064	INACTIVE-CARD	The card is inactive.
1065	INCORRECT-PIN	Incorrect PIN.
1066	INSUFFICIENT-BALANCE	Insufficient Balance
1068	INVALID-BIN	Bin not found
1069	INVALID-CARDHOLDER-NAME	Invalid card holder name.
1070	INVALID-CARD-INFO	Invalid brand or bin range not enabled.
1071	INVALID-INPUT-DATA	Invalid input data.
1072	ISSUER-DECLINE	Payment decline by bank.
1073	ISSUER-DISALLOWED	Transaction not allowed by the issuer.
1074	ISSUER-ERROR	Payment processing failed due to error at bank.
1075	ISSUER-LIMIT-DECLINE	Exceeds withdrawal frequency or count limit.
1076	MAX-RETRIES	Maximum number of PIN retries exceeded.
1077	OTP-LIMIT-EXCEEDED	OTP validation attempts limit exceeded.
1078	PIN-ATTEMPTS-EXCEEDED	PIN attempts limit exceeded.
1079	RESTRICTED-CARD	Restricted card.
1080	SUSPECTED-FRAUD	Suspected fraud.
1081	TIMEOUT	Payment was not completed on time.
1082	UPI-PIN-NOT-SET	UPI PIN is not set.
1083	UPI-REQUEST-EXPIRED	UPI request expired.
1084	USER-BACK-REFRESH	User pressed refresh button.
1085	ACQUIRER-DOWN	Payment acquirer is down.
1086	TOO-MANY-RECORDS	Response contains too many records, use pagination.
1087	NOT-ENOUGH-PARAMETERS	Not enough parameters to get response, add one or more optional parameters.
1088	TRANSACTION-IN-PROCESS	We are processing your transaction.
1089	INVALID-ACCESS-TOKEN	Invalid access token.
1090	TEST-MODE-DISABLED	The test mode access is not allowed.
1091	INVALID-TRANSFER-TYPE	The disbursement transfer type is not allowed.
1092	INACTIVE-ACCOUNT	The customers account is inactive.
1093	INACTIVE-ACCOUNT	The customers account is invalid.
1094	TRANSACTION-COUNT-EXCEEDED	Transaction count limit has exceeded for the customer.
1095	AMOUNT-MISMATCH	Transaction amount mismatch in payment response.
9999	UNKNOWN ERROR	Unknown error occurred.