Payment

Gateway
APIs for integration

Document version 2.0.1 Last modified on: 18th Sep 2022

Contents
1 OVERVIEW ............................................................................................................................................. 3
2 PAYMENT REQUEST API ........................................................................................................................ 4
2.1 Steps for Integration ..................................................................................................................... 4
2.2 Parameters to be POSTed in Payment Request ............................................................................ 4
2.3 Response Parameters returned .................................................................................................... 8
3 ENCRYPTING / DECRYPTING PAYMENT REQUEST API ........................................................................ 10
3.1 Parameters to be POSTed in Encrypted Payment Request ........................................................ 10
3.2 Decryption of Response Parameters returned ........................................................................... 12
4 GET PAYMENT REQUEST URL (Two Step Integration) ........................................................................ 14
4.1 Steps for Integration ................................................................................................................... 14
4.2 Parameters to be posted in request ........................................................................................... 15
4.3 Successful Response Parameters returned................................................................................. 15
4.4 Manually Expire a Payment Request URL ................................................................................... 15
5 FETCH INTENT URL PAYMENT REQUEST ............................................................................................. 17
5.1 Steps for Integration ................................................................................................................... 17
6 PAYMENT STATUS API ......................................................................................................................... 18
6.1 Parameters to be POSTed ........................................................................................................... 18
6.2 Response Parameters ................................................................................................................. 19
7 REFUNDS APIs ..................................................................................................................................... 24
7.1 Refund request API ..................................................................................................................... 24
7.2 Refund Status API........................................................................................................................ 26
8 SPLIT API .............................................................................................................................................. 29
8.1 Split Settlement API .................................................................................................................... 29
8.1.1 Split transaction before settlement API.............................................................................. 29
9 VENDOR APIs....................................................................................................................................... 31
9.1 Add Vendor API ........................................................................................................................... 31
9.2 Modify Vendor API ...................................................................................................................... 33
9.3 Add Vendor Accounts API ........................................................................................................... 34
9.4 Delete Vendor API ....................................................................................................................... 36
9.5 Get Vendor API............................................................................................................................ 37
10 SETTLEMENT APIs ........................................................................................................................... 39

1
 10.1 Get Settlements API .................................................................................................................... 39
10.1.1 Parameters to be POSTed in Request ................................................................................. 39
10.2 Get Settlement Details API.......................................................................................................... 40
10.2.1 Parameters to be POSTed in Request ................................................................................. 41
11 CHALLAN PAYMENT APIs ................................................................................................................ 43
11.1 Request challan payment API ..................................................................................................... 43
11.2 Request challan payment API url ................................................................................................ 43
11.2.1 Request parameters are as following: ................................................................................ 44
11.2.2 Response from this API will be in JSON format: ................................................................. 44
11.2.3 List of error codes and corresponding messages: .............................................................. 45
12 SERVER TO SERVER CALL BACK (WEB HOOKS) ................................................................................ 46
12.1 Server to server response on Payment ....................................................................................... 46
12.2 Server to server response on Settlement ................................................................................... 47
13 SEAMLESS PAYMENT REQUEST API ................................................................................................ 48
13.1 Steps for Integration ................................................................................................................... 48
13.2 Parameters to be POSTed in Seamless Payment Request .......................................................... 48
13.3 Response Parameters ................................................................................................................. 50
14 APPENDIX 1 - References ................................................................................................................ 52
15 APPENDIX 2 - Hash calculation guide .............................................................................................. 53
15.1 How to Calculate Hash on API request ....................................................................................... 53
15.1.1 Hashing generation algorithm ............................................................................................ 53
15.2 How to check the response Hash................................................................................................ 53
15.2.1 Hash checking algorithm ..................................................................................................... 54
16 APPENDIX 3 - List of bank codes ..................................................................................................... 56
17 APPENDIX 4 - List of error codes ..................................................................................................... 65
18 APPENDIX 5 – Currency Codes ........................................................................................................ 68

2
1 OVERVIEW

This document describes the steps for technical integration process between merchant website /
application and Payment-Gateway.

Through Payment-Gateway, your customers can make electronic payments through various payment
modes such as:

• Credit cards
• Debit cards
• Net banking
• EMI
• Cash Cards/Wallets
• Mobile/web invoicing
• Integrated NEFT/RTGS
• Bank deposits
• Standing instruction on cards
• Customer account direct debit (e-NACH)
• UPI - Collect and Intent based
• BharatQR
• E-Collect

Payment-Gateway also offers you a web portal where you have access to all your prior
transaction/payment details, settlement details, analytics, etc. You can also use this portal to create
invoices singly or in bulk, set reminders, recurring billing, and many more features, manage your
payables, vendor payments, set split ratios for vendor payments, process refunds, etc. Ask Payment-
Gateway for management portal.

Following information will be required from Payment-Gateway for proceeding with integration, this
information will be available in management portal.

{pg_api_url} This is the domain url od Payment-Gateway APIs

api_key This is the key required for api access
salt This is like password to access APIs and used in HASH/CHECKSUM calculations in
request and responses. (Keep it safely do not share it publicly)
encryption key This is encryption key used in Payment request to encrypted the request data
(Keep it safely do not share it publicly)
decryption_key This is decryption key used for decrypting the payment response returned on
return_url (Keep it safely do not share it publicly)

3
2 PAYMENT REQUEST API
When you integrate with Payment-Gateway, the customer will be re -directed from your merchant
website to the Payment-Gateway payment page. After completion of the transaction, Payment-Gateway
will direct the customer back to the merchant website

URL: https://{pg_api_url}/v2/paymentrequest

Method: POST

Content-Type: application/x-www-form-urlencoded

2.1 Steps for Integration

• You need to submit a POST REQUEST to our server, at the above-mentioned URL; Note that it
should be a html form to be able to redirect to payment page e.g. <form method='post'
action=' https://{pg_api_url}/v2/paymentseamlessrequest '> </form>

Note: hash is a mandatory parameter. If your hash is not properly calculated or does not match
for whatever reason, we will not be able to process the payment. The usage of hash is explained
in subsequent sections.

• When you call this API, the customer is necessarily re-directed to Payment-Gateway’s payment
page. After the customer makes the payment through Payment-Gateway (entering his card
details or netbanking details etc.), we direct the customer back to your merchant site.

Note: If you need the customer to enter credit card details on your (merchant) website and
would NOT want us to redirect to the Payment-Gateway page, we can get that done, provided
you are PCI-DSS certified. If you are not certified and would like to get certified, let us know. We
will guide you appropriately on how to get it done.

• We recommend that you check the hash at your end again, after we send back the response to
you. This is essential to prevent user data tampering fraud.

• Transaction ID and order ID:

• When you submit your transaction request to Payment-Gateway, you need to submit an
order ID as part of the request. This order ID can be used by you as a universal reference
number for all transaction requests submitted by you.
• When your customer clicks the "Pay" button on the payment page, a unique transaction
ID is assigned to the transaction.
• Order ID acts as a "merchant reference number". You must maintain uniqueness of your
order IDs.

2.2 Parameters to be POSTed in Payment Request

URL: https://{pg_api_url}/v2/paymentrequest

4
Parameter Name Description Data type Optional /
Mandatory
api_key Payment-Gateway would assign a unique 36-digit varchar(36) mandatory
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.
order_id This is your (merchant) reference number. It must varchar(30) mandatory
be unique for every transaction. We do perform a
validation at our end and do not allow duplicate
order_ids for the same merchant.
mode This is the payment mode (TEST or LIVE are valid varchar(4) optional
values)
amount This is the payment amount. decimal(12,2 mandatory
)
currency This is the 3-digit currency code (INR) varchar(3) mandatory
description Brief description of product or service that the varchar(255) mandatory
customer is being charged for.
name Name of customer. varchar(255) mandatory
email Customer email address. varchar(255) mandatory
phone Customer phone number varchar(30) mandatory
address_line_1 Customer address varchar(255) optional
address_line_2 Customer address 2 varchar(255) optional
city Customer city varchar(255) mandatory
state Customer State varchar(255) optional
country Customer country varchar(100) mandatory

zip_code Customer zip code varchar(20) mandatory

timeout_duration Timeout duration (in seconds) varchar(10) optional
udf1 User defined field varchar(255) optional
udf2 User defined field 2 varchar(255) optional
udf3 User defined field 3 varchar(255) optional
udf4 User defined field 4 varchar(255) optional
udf5 User defined field 5 varchar(255) optional
return_url Return URL success - Payment-Gateway will make a varchar(255) mandatory
POST request to this URL after successful
transaction, with a set of parameters, which you can
process as you want to.
return_url_failure Return URL failure - Payment-Gateway will make a varchar(255) optional
POST request to this URL after a FAILED transaction,
with a set of parameters, which you can process as
you want to.
return_url_cancel Return URL success - Payment-Gateway will make a varchar(255) optional
POST request to this URL in case of transaction

5
 cancellation, with a set of parameters, which you
can process as you want to.
percent_tdr_by_user Percent of tdr amount paid by user (optional) (max decimal(5,2) optional
value:100)
flatfee_tdr_by_user fixed fee paid by user (optional) decimal(10,2 optional
)
show_convenience_fee Controls whether the convenience fee amount (for varchar(1) optional
surcharge merchants) is displayed to the customer
(on the payment page) or not
split_enforce_strict Controls whether payment is required to be split varchar(1) Mandatory
before settlement. By default, it is set to 'n', If this is if
set to 'y' then settlement will be on HOLD until settlement
splitsettlement api is called to provide split amount
information. needs to be
split with
vendors.
Optional
Otherwise
split_info Split info is for splitting the payment between varchar(500) Mandatory
vendor and themselves. In this field one must if
provide vendor code and what is the amount of the settlement
payment to be made to vendors. Following is an amount
example how it will look needs to be
{"vendors":[{"vendor_code":"2VEN449","split_amo split with
unt_fixed":"20"},{"vendor_code":"2VEN450","split_a vendors.
mount_fixed":"20"}]} Optional
All field in this JSON are mandatory. Otherwise
payment_options payment options to be displayed such credit card varchar(50) optional
(cc), net banking (nb), wallet (w), ATM card (atm),
UPI (upi) 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), sequence of values will also
determine the tab sequence on payment page.
payment_page_display_ This text will be displayed below the logo on varchar(100) optional
text payment page.
allowed_bank_codes Bank codes sent in this filed will be allowed in varchar(250) optional
payment page, other bank codes will not be allowed
to proceed with payment. Refer appendix 3 for the
list of bank codes. To send multiple bank codes send
a comma separated list. E.g. to allow only credit
cards: MACC,VICC,DINC,VISC,RUPC,MASC, AMXC
allowed_emi_tenure This will be a comma separated integer list varchar(50) optional
depending upon the tenure (in months) of loan
allowed to show in EMI payment method. Ex( 3 , 6,
9 etc.)

6
allowed_bins BIN is Bank Identification Number, on a card it is varchar(250) optional
first 6 digits. BINs passed here will only be allowed
to transact, multiple BINs can be sent as comma
separated list. Refer appendix 3 for the list if the
payment mode is card
offer_code If there is any discount / offer provided by merchant varchar(100) optional
on EMIs, then predefined codes must be mentioned
in this field. (This is for specific use case; more
information can be provided on demand)
emi_info This is an optional param which is to be posted to varchar(100) optional
issuer end in case emi detail are required.the format
will be as mentioned below
"emi_info": {
"subvention": "0.0",
"aggregator_name": "BENOW",
"bank_merchant_id": null,
"bank_term_id": null,
"bank_sku_code": null
} all the fields are optional and have varchar as data
type.
product_details Contains information regarding the goods/product varchar(2048 optional
for which the payment (emi) is being made. Values )
in this field should be sent in JSON format, for
example:
{"manufacturer": "Samsung","category":
"Phone","sub_category_1": "Smart
Phone","sub_category_2": "High-
end","model_name": "Samsung Galaxy S10 Pro"}
Felds such as manufacturer, category, model_name
are self-explanatory; sub_category_1 and
sub_category_2 further describe the variants/types
of that product.
All fields in this JSON are optional.
enable_auto_refund Payment request is auto refunded in case of delay varchar(1) optional
success depending upon the value present in the
field is 'y' or 'n'. If this filed is not sent default set for
your account at the time of setup will take effect.
hash You need to compute a hash of all your parameters varchar(255) mandatory
and pass that hash to Payment-Gateway, for details
about calculating hash refer Appendix 2.

Note: the SALT will be provided by Payment-

Gateway separately. NEVER PASS SALT IN A FORM,
DO NOT STORE SALT IN ANDROID APP APK or
IPHONE APP package

7
2.3 Response Parameters returned
Parameter name Description
transaction_id A unique ID that can be used to trace the transaction uniquely within
Payment-Gateway. Transaction IDs are alphanumeric. An example transaction
ID is HDVISC1299876438
payment_mode This tells the payment mode used by customer - example: "credit card", "debit
card", "netbanking", etc.
payment_channel This tells the payment channel used by customer - example: "Visa", "HDFC
Bank", "Paytm", etc.
payment_datetime Date and Time of this payment in "DD-MM-YYYY HH:MM:SS" format
response_code Status of the transaction (return code). 0 signifies successful transaction. Non-
zero values signify error. Response Code returned is documented in Appendix
4
response_message The response message associated with the transaction.
error_desc The detailed error description, if any
order_id The same order_id that was originally posted by the merchant in the request.
amount The same original amount that was sent by the merchant in the transaction
request. In case of customer surcharge model this will be the amount paid by
customer **.
currency This is the 3digit currency code (INR), it will be same value that was originally
sent by merchant.
description The same description that was originally sent by the merchant in the
transaction request.
name The same value that was originally sent by merchant
email The same value that was originally sent by merchant
phone The same value that was originally sent by merchant
address_line_1 The same value that was originally sent by merchant
address_line_2 The same value that was originally sent by merchant
city The same value that was originally sent by merchant
state The same value that was originally sent by merchant
country The same value that was originally sent by merchant
zip_code The same value that was originally sent by merchant
udf1 The same value that was originally sent by merchant
udf2 The same value that was originally sent by merchant
udf3 The same value that was originally sent by merchant
udf4 The same value that was originally sent by merchant
udf5 The same value that was originally sent by merchant
tdr_amount This is the TDR charged on the transaction **
tax_on_tdr_amount This is the Tax (GST) charged on the TDR Amount **
amount_orig This is the amount requested by merchant **.
Typically, this will be same as the amount field, but in case of customer
surcharge model this will be a different value.

8
 cardmasked Masked card number which was used to make the transaction **. For
example, 437748******0069
emi_tenure This field is returned if "send_emi_details" merchant param is enabled and/or
in payment request emi_info param is set to get this in response
emi_rate_of_interest This field is returned if "send_emi_details" merchant param is enabled and/or
in payment request emi_info param is set to get this in response
hash Payment-Gateway calculates the hash using the same algorithm which was
outlined earlier. Hence, the merchant needs to check whether this returned
hash matches the calculated hash.
** Note: This parameter will be returned as part of the response only if the merchant’s account has
been enabled for the same. Please speak to your Payment-Gateway relationship manager if you would
like this information to be returned in response.

Note: It is important to validate the hash after you receive the response from Payment-Gateway. A
failed response sent from Payment-Gateway server to your server via browser could be tampered by a
malicious end-user and turned into “success”. To make sure the transaction response is the same as
what Payment-Gateway server sent please check the hash before considering the transaction response
as final.

Note: Format of transaction ID is as follows: HDVISC1299876438". The 3rd to 6th digits (both inclusive) in
the transaction ID signify the "bankcode". This information is enough to obtain the payment method and
payment channel. A list of bankcodes and corresponding payment mode/channel is available in
Appendix 3 of this document.

9
3 ENCRYPTING / DECRYPTING PAYMENT REQUEST API

• This section focuses on encrypting a payment request that we built in previous section
• For encrypting and decrypting payment request, encryption and decryption keys will be
provided by Payment-Gateway.
• Payment request is encrypted using AES-265-CBC algorithm with encryption key and then
posted to payment-gateway as explained in following sections.
• Payment-Gateway will post the final response of the transaction in encrypted format on the
return_url provided in the request, this response needs to be decrypted using the decryption
key as described in following sections and then processed further.

3.1 Parameters to be POSTed in Encrypted Payment Request

URL: https://{pg_api_url}/v2/paymentrequest

Method: POST

Content-Type: application/x-www-form-urlencoded

Parameter Name Description Data type Optional /

Mandatory
api_key Payment-Gateway would assign a unique varchar(40) mandatory
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.
encrypted_data This field will contain encrypted data varchar(5000) mandatory
(Following section explains how to
prepare data and then encrypt it.)
iv This field will contain initial vector that is varchar(16) mandatory
used for encryption, it must be 16 byte
long cryptographically secure random
string.

1. Preparation of data: - First you need to create JSON formatted data and then encrypt the JSON
string. Following is the structure of JSON. Details of each field is same as defined in payment
request in previous section.
{
"api_key": "f14e50fd-82f0-4ce0-bd4e-de924908d4ff",

10
 "address_line_1": "Address Line 1",
"address_line_2": "Address Line 2",
"amount": "35.56",
"city": "Bangalore",
"country": "IND",
"currency": "INR",
"description": "Payment Short Description",
"email": "[email protected]",
"mode": "LIVE",
"name": "Amit",
"order_id": "XYZ419",
"phone": "9900990099",
"return_url": "https://yoursite.com/return_page_success.php",
"return_url_failure": "https://yoursite.com/return_page_failure.php",
"return_url_cancel": "https://yoursite.com/return_page_success.php",
"state": "Karnataka",
"udf1": "Users Defined Value",
"udf2": "",
"udf3": "",
"udf4": "",
"udf5": "",
"zip_code": "560001",
"hash":
"23CD8F59DB509F55951CE74C922879128098F4998C72BFD7400011C6B305290DD9333101C1C
C70CEB04587C49E6949AA864F83D54088F691FD57C7222CDB2572"
}

2. Encrypting the JSON data: - After encrypting the json data above result will be passed in
encrypted_data and iv fields, to encrypt we use 256-bit AES encryption, encryption method is
AES-256-CBC, encrypted data should be base64 encoded before posting. Encryption key will be
provided by Payment-Gateway. Note that both encrypted_data and iv are base64 encoded, if
not already done (some encryption libraries do not base 64 encode the resulting encryption and
the randomly generated iv bytes)

Sample encryption code in PHP is provided below for your reference. you can easily get libraries in other
languages (.NET, JAVA, Nodejs) to do AES-256-CBC encryption and base64 encoding

/**
* AES-256-CBC Encryption method, First it encrypts the data and then encodes it to
base64
* @param string $plain_data Plain text Data to be encrypted
* @param string $encryption_key Provided by Payment Gateway
* @return array
*/

11
function encryptData($plain_data, $encryption_key)
{
$iv = openssl_random_pseudo_bytes(16); //random 16 byte/char long string or unix-
timestamp(10chars)+random-string(6chars) time().mt_rand(100000, 999999)
$encrypted = openssl_encrypt($plain_data, "AES-256-CBC", $encryption_key,
OPENSSL_RAW_DATA, $iv);

return [base64_encode($encrypted), base64_encode($iv)];

}

Following is sample HTML form to post data and redirect to payment page.

<form action="https://{pg_api_url}/v2/paymentrequest" method="post">

<input type="hidden" value="<?php echo $post_values['api_key']; ?>"
name="api_key"/>
<input type="hidden" value="<?php echo $encrypted_data; ?>"
name="encrypted_data"/>
<input type="hidden" value="<?php echo $iv; ?>" name="iv"/>

<!-- Generally instead of showing the submit button do an auto submit using
javascript onload="document.forms[0].submit()" -->
<input type="submit" value="Submit">
</form>

3.2 Decryption of Response Parameters returned

In the response, you will receive AES-256-CBC encrypted data which needs to be decrypted. Following
sections explains how to decrypt the encrypted data.

Parameter Name Description

api_key Payment-Gateway would assign a unique 36-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.
encrypted_data This field will contain encrypted data (Following section explains how
to decrypt and get the response data.)
iv This field will contain initial vector use this to decrypt the
encrypted_data received in response

Decrypting the encrypted data: - To decrypt we use 256 bit AES encryption algorithm, decryption
method is AES-256-CBC, decrypted data should be base64 decoded before using. Decrypted data will be
in JSON format as shown below. Decryption key will be provided by Payment-Gateway.

Sample decryption code in PHP, you can easily get libraries in other languages (.NET, JAVA, Nodejs) to do
AES-256-CBC decryption and base64 decoding.

/**
* AES-256-CBC Decryption method, First it decodes base64 encoded encrypted data and
* then decrypts it to get JSON data string
*

12
 * @param String $encrypted_data Encrypted data received in response
* @param String $decryption_key Provided by Payment Gateway
* @param String $iv Initial Vector iv as received in response
*/
function decryptData($encrypted_data, $decryption_key, $iv)
{
return openssl_decrypt(base64_decode($encrypted_data), 'AES-256-CBC',
$decryption_key, OPENSSL_RAW_DATA, base64_decode($iv));
}

JSON response after decryption will be as following, .

{
"transaction_id": “FBEEBN12311231231”,
"payment_mode": “NetBanking”,
"payment_channel": “Federal Bank”,
"payment_datetime": "2018-09-19 16:19:46",
"response_code": 1043,
"response_message": "Transaction cancelled",
"error_desc": "Transaction cancelled",
"order_id": "607",
"amount": "100.81",
"currency": "INR",
"description": "Payment Short Description",
"name": "Amit",
"email": "[email protected]",
"phone": "9900990099",
"address_line_1": “Address Line 1”,
"address_line_2": “Address Line 2”,
"city": "Bangalore",
"state": "Karnataka",
"country": "IND",
"zip_code": "560001",
"udf1": null,
"udf2": null,
"udf3": null,
"udf4": null,
"udf5": null,
"hash":
"64948C7CA2F8861285A246738FF48347FCAEB81D7EBB0F2D00B6BE661EAC1DADCFD59A0FA878CE878
9F0DB9E045FC0943661A9DE4B5984F5D6E32DDEE1BBD4B6"
}

13
4 GET PAYMENT REQUEST URL (Two Step Integration)

Payment-Gateway provides an API which returns a unique payment page URL on your merchant server
in response which can be used in any browser to show the payment selection page and complete the
transaction. This process gets complete in two steps.

URL: https://{pg_api_url}/v2/getpaymentrequesturl

4.1 Steps for Integration

• First step is, you need to submit a POST REQUEST to API URL

Note: hash is a mandatory parameter. If your hash is not properly calculated or does not match
for whatever reason, we will not be able to process the payment. The usage of hash is explained
in subsequent sections.

• In response you will get a payment execution URL. Following is the sample response message in
case of success.

{
"data": {
"url": "https://{pg_api_url}/v2/executepaymentrequesturl/3c1943aa-13be-4866-925e-
d56c32c62d47",
"uuid": "3c1943aa-13be-4866-925e-d56c32c62d47",
"expiry_datetime": "2019-06-14 16:38:36",
"order_id": "T103"
}
}

• The response message apart from payment URL will contain a UUID (unique identification
number for this transaction request), expiry date/time (this url will not work after the given
expiry date/time) and order id (the one sent in the request by merchant). For every get payment
URL request a unique UUID is generated in response.

• Second step is after getting the URL, open it in any browser or app webview for showing the
payment method selection page to customer to complete the payment.

It is best to use this API if payments are going to be done through mobile apps for preventing frauds or
hash / data tampering. The request can be built on your server and the unique URL can be sent to Client
app, from where the payment process would continue.

14
4.2 Parameters to be posted in request

URL: https://{pg_api_url}/v2/getpaymentrequesturl

Parameters to be posted for this API are exactly same as in v2/paymentrequest API (see Section 2.2),
except for one additional optional parameter for defining the url expiry in minutes

Parameter Name Description Data type Optional /

Mandatory
expiry_in_minutes This field is to define the response url varchar(10) optional
expiry in minutes. This field excepts
integer value minimum of 15 (15
minutes) and maximum of 10080 (7 days)

4.3 Successful Response Parameters returned

Parameter
Name Description
url Payment URL, which can open in any browser
expiry_datetime The Payment URL expiration time, by default set for 15 mins
uuid Unique ID generated for every request
This is your (merchant) reference number which you submitted while making the original
order_id transaction.

4.4 Manually Expire a Payment Request URL

This API is used if the links created by getpaymentrequesturl API needs to be expired before it
automatically expires as per expiry_in_minutes. After this API is successfully run then user prevented
from making a transaction on calling /v2/executepaymentrequesturl/{uuid} URL

URL: https://{pg_api_url}/v2/expirepaymentrequesturl

Parameter Name Description Data type Optional /

Mandatory
api_key Payment-Gateway would assign a unique varchar(36) Mandatory
36-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.

15
 uuid This is the uuid returned by the varchar(40) mandatory
getpaymentrequesturl api
hash You need to compute a hash of all your varchar(255) mandatory
parameters and pass that hash to
Payment-Gateway, for details about
calculating hash refer Appendix 2.

Note: the SALT will be provided by

Payment-Gateway separately. NEVER
PASS SALT IN A FORM, DO NOT STORE
SALT IN ANDROID APP APK or IPHONE
APP package

The expire payment request url parameter will be in jquery format as shown below:

form.append("api_key", "f14e50fd-82f0-4ce0-bd4e-de234sffd4ff");
form.append("uuid", "3c1943aa-13be-4866-925e-d56c32c62d47");
form.append("hash", "AAAAAAAAAAAAAAAAAAA77AAABCSDKANSKAKSBFKKASKAKS");

On successful call to this API the response posted in jquery format will be as shown below:

{
"data": {
"code": "SUCCESS",
"message": "The URL is expired",
}
}

If the transaction is already in progress, the API will return an error message

{
{
"error": {
"code": “TRANSACTION-IN-PROGRESS”,
"message": " Your request cannot be processed"
}
}

16
5 FETCH INTENT URL PAYMENT REQUEST
Payment Gateway will provide an API which returns a unique payment page URL on your merchant
server in response which can be used in any browser to show the payment selection page and complete
the transaction. This process gets complete in two steps.

URL: https://{pg_api_url}/v2/getpaymentrequestintenturl

5.1 Steps for Integration

• First step is, you need to submit a POST REQUEST to API URL
• In response you will get a payment intent URL. Following is the sample response message in
case of success.

{
"data": {
"upi_intent_url":
"upi:\/\/pay?pa=MERCUAT@bank&pn=Karmendra+Biz&am=13.45&mam=13.45&tr=6478789&tn=P
ayment+for+6478789&mc=5021&mode=04&purpose=00&utm_campaign=DEBIT&utm_medium=
PAYFAIRUAT&utm_source=6478789",
"payment_request_id": 6478789,
“order_id” : 123456
}
}
• The response message contains the intent url, transaction id and order id sent in the payment
request.
• Second step is after getting the URL is to use trigger an app from the respective mobile device.

It is best to use this API if payments are going to be done through mobile payment apps for preventing
frauds or hash / data tampering.

17
6 PAYMENT STATUS API

Payment-Gateway provides an API which you can use to check the status of any prior transaction. You
can use this to reconcile transactions. We strongly recommend that you make it a practice to use this for
every transaction that was made. This serves two purposes:

• The response might not reach you due to network issues or other problems such as user clicking
refresh button on their browser, etc.
• This also protects against any tampering, since you have a second fallback check here.

Payment-Gateway offers a sophisticated API wherein you can apply "filters" on the resultset you want to
retrieve. You can search our system by the transaction ID, or the order ID, or even by parameters such as
date range, customer phone number, etc. You can also pass in various combinations of these parameters
to get the resultset of your choice.

Note: Your designated server IP will need to be whitelisted by Payment-Gateway for this API to work. If
you receive errors such as "Unauthorized" while accessing this API, please contact your Payment-Gateway
relationship manager to get this fixed.

URL: https://{pg_api_url}/v2/paymentstatus

6.1 Parameters to be POSTed

Parameter Name Description Data type Optional /

Mandatory
api_key Payment-Gateway would assign a unique varchar(36) Mandatory
36-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.
order_id This is your (merchant) reference number varchar(30) Optional
which you submitted while making the
original transaction. You can send multiple
order ids in this field as comma (,)
separated list
transaction_id This is the transaction ID generated by varchar(30) Optional
Payment-Gateway for the given transaction
bank_code This is the 4-letter bankcode which denotes varchar(4) Optional
the payment mode/channel of the
payment.
response_code The numeric response code returned by number(4) Optional
Payment-Gateway during the original
transaction

18
 customer_phone Phone number of the customer, as varchar(30) Optional
provided during the original
paymentrequest API
customer_email Email address of the customer, as provided varchar(255) Optional
during the original paymentrequest API
customer_name Name of the customer, as provided during varchar(255) Optional
the original paymentrequest API
date_from Start date of date range to retrieve varchar(20) Optional
transactions, in DD-MM-YYYY or YYYY-MM-
DD HH:MM:SS format
date_to End date of date range to retrieve varchar(20) Optional
transactions, in DD-MM-YYYY or YYYY-MM-
DD HH:MM:SS format
page_number Page number you need to retrieve, its value integer Optional
is limited by information received in the
first response that is received
per_page Number to records need to see per page, integer Optional
this value should be between 1 and 50
hash You need to compute a hash of all your varchar(255) Mandatory
parameters and pass that hash to Payment-
Gateway, for details about calculating hash
refer Appendix 2.

Note: the SALT will be provided by

Payment-Gateway separately. NEVER PASS
SALT IN A FORM, DO NOT STORE SALT IN
ANDROID APP APK or IPHONE APP package

6.2 Response Parameters

On successful call to this API you will receive JSON response. You can read the JSON response
and process it at your end. If your result set is greater than 50 transactions, you would need to
use pagination.

Note: few parameters in response will be visible only if it is enabled for your account, for
example: refund_details will be available if it is enabled for your merchant account.

A few sample responses for given requests are provided below:

In case of success,

{
"data": [
{
"transaction_id": "SFSBIN2783912661",

19
 "bank_code": "SBIN",
"payment_mode": "Netbanking",
"payment_channel": "State Bank of India",
"payment_datetime": "2018-06-13 16:44:03",
"response_code": 1000,
"response_message": "FAILED",
"authorization_staus": null,
"order_id": "427641",
"amount": "27.36",
"amount_orig": "2.00",
"tdr_amount": 21.49,
"tax_on_tdr_amount": 3.87,
"description": "Web Payment for 433487",
"error_desc": "FAILED",
"customer_phone": "9900990099",
"customer_name": "sharathkumar hegde",
"customer_email": "[email protected]"
"currency": "INR",
"cardmasked": null,
"udf1": null,
"udf2": null,
"udf3": null,
"udf4": null,
"udf5": null,
"refund_details": {
"refund_amount": 0
}
},
{
"transaction_id": "HDVISC4291974106",
"bank_code": "VISC",
"payment_mode": "Credit Card",
"payment_channel": "Visa",
"payment_datetime": "2018-06-13 16:45:39",
"response_code": 0,
"response_message": "SUCCESS",
"authorization_staus": "captured",
"order_id": "427643",
"amount": "1.93",
"amount_orig": "1.90",
"tdr_amount": 0.03,
"tax_on_tdr_amount": 0,

20
 "description": "Web Payment for 433489",
"error_desc": null,
"customer_phone": "9900990099",
"customer_name": "sharathkumar hegde",
"customer_email": "[email protected]"
"currency": "INR",
"cardmasked": null,
"udf1": null,
"udf2": null,
"udf3": null,
"udf4": null,
"udf5": null,
"refund_details": {
"refund_amount": 0
}
}
],
"page": {
"total": 175,
"per_page": 10,
"current_page": 1,
"last_page": 18,
"from": 1,
"to": 10
},
"hash":
"30FAAD865191B4064576F063177F0A4692C3DBBBF35D1A20463EAA449269C4715FD13528EA069B3A8
D5C25C62637ED825C297C2337CDC1CFB7FCD0D60DCFEB9D"
}

In case of error,

{
"error": {
"code": 1001,
"message": "The api key field is incorrect"
}
}

In case there is no record present in our system for the combination of input, following error is
returned

21
{
"error": {
"code": 1050,
"message": "No data record found for the given input"
}
}

In case there is no transaction id in our system for the order_id, merchant_order_id or

transaction_id, following error is returned

{
"error": {
"code": 1028,
"message": "No Transaction found"
}
}

If there are more than 50 transactions for which the status is requested, you would see following error

{
"error": {
"code": 1086,
"message": "More than 50 records, refine your search criteria or use pagination"
}
}

In such cases where result set is expected to have status of more than 50 transactions, it is required to
use pagination.

Pagination allows to access data in smaller chunks making it easier for server to return data quickly.

To allow for pagination one need to pass following additional parameter in request

Parameter Name Description Data type Optional /

Mandatory
page_number Page number you need to retrieve, its value is integer optional
limited by information received in the first
response that is received
per_page Number to records need to see per page, this integer optional
value should be between 1 and 50

If above parameters are passed, response will have additional information about pagination as following

"page": {
"total": 175,
"per_page": 10,

22
 "current_page": 1,
"last_page": 18,
"from": 1,
"to": 10
},

This pagination information should be used in page_number filed for subsequent api request.

23
7 REFUNDS APIs
Payment-Gateway provides a refund API which merchants can use to programmatically issue refunds
instead of clicking the "refund" button in the Payment-Gateway UI. This API can be invoked on any prior
successful transaction. The transaction which is being refunded should be in either "paid" or "settled"
state, or in "refunded" state (in case of partial amount refunds). Refunds can be either for the full
amount paid by the customer, or any part of it.

The API needs a valid transaction ID as input.

Note: processing of refunds is subject to availability of funds in subsequent settlement cycles. This API
will return a failure response in case sufficient funds are not available to process the refund.

7.1 Refund request API

URL: https://{pg_api_url}/v2/refundrequest

Request Parameters:

Parameter Name Description Data type Optional /

Mandatory
api_key Payment-Gateway would assign a varchar(36) Mandatory
unique 36-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.

transaction_id The unique alphanumeric transaction varchar(30) Mandatory

ID generated by Payment-Gateway for
a prior transaction.

merchant_refund_id This is your (merchant) refund varchar(30) Optional

reference number. It must be unique
for every refund request. If a refund
request is sent with same
merchant_refund_id we return the
response of the previously successful
refund request. Warning: If you are
NOT using this filed then be careful, as
each request will be treated as a new
refund request. Thus it is
recommended to use this field.

24
 merchant_order_id This is your (merchant) reference varchar(30) Optional
number which you submitted while
making the original transaction. Note
that if this value does not match with
related transaction_id field then you
will get error. In typical cases do not
send this field.

amount The amount which needs to be decimal(10,2) Mandatory

refunded. This needs to be less than or
equal to the transaction amount.

description Description of the refund. Usually the varchar(500) Mandatory

reason for issuing refund, as specified
by merchant.

hash You need to compute a hash of all varchar(255) Mandatory

your parameters and pass that hash to
Payment-Gateway, for details about
calculating hash refer Appendix 2.

Note: the SALT will be provided by

Payment-Gateway separately. NEVER
PASS SALT IN A FORM, DO NOT STORE
SALT IN ANDROID APP APK or IPHONE
APP package

Response Parameters:

The output is a JSON which contains the error(s), if any, in validation, or a simple success message which
confirms that the refund request has been accepted and will be processed during subsequent
settlement cycle.

If the request is successfully processed response you will get a “data” block, and in case of failure you
will see “error” block, you will not get “data” key in case of error.

In case of success, NOTE: that refund_reference_no is returned by the bank and it can be null in
case refunds are not initiate by bank immediately, but is done at end of the day.

{
"data": {
"transaction_id": "HDVISC7472820193",
"refund_id": 4351,

25
 "refund_reference_no": null
"merchant_refund_id": 76783_R_1,
"merchant_order_id": 76783,
}
}

In case of error,

{
"error": {
"code": 1039,
"message": "The refund amount is greater than transaction amount"
}
}

7.2 Refund Status API

If a refund is initiated either from merchant or payment gateway end and merchant wants to check its
status (details such as if it is refunded or not how much amount was paid and how much is refunded will
be posted in response). To check the status of any refund which was initiated merchant should post the
API request.

URL: https://{pg_api_url}/v2/refundstatus

Request Parameters:

Parameter Name Description Data type Optional /

Mandatory
api_key Payment-Gateway would assign a varchar(36) Mandatory
unique 36-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.

26
 transaction_id The unique alphanumeric transaction varchar(30) Mandatory
ID generated by Payment-Gateway for
a prior transaction.

merchant_order_id This is your (merchant) reference varchar(30) Optional

number which you submitted while
making the original transaction. Note
that if this value does not match with
related transaction_id field then you
will get error. In typical cases do not
send this field.

hash You need to compute a hash of all varchar(255) Mandatory

your parameters and pass that hash to
Payment-Gateway, for details about
calculating hash refer Appendix 2.

Note: the SALT will be provided by

Payment-Gateway separately. NEVER
PASS SALT IN A FORM, DO NOT STORE
SALT IN ANDROID APP APK or IPHONE
APP package

Response Parameters:

The output is a JSON it will give all details about a refund if any initiated for this transaction, if not it will
give json with error. Partial multiple refunds are also shown in refund_details

If the request is successfully processed response you will get a “data” block, and in case of failure you
will see “error” block, you will not get “data” key in case of error.

NOTE: that refund_reference_no is returned by the bank and it can be null in case refunds are
not initiate by bank immediately but is done at end of the day.

{
"data": {
"transaction_id": "FDAXIP9740656834",
"merchant_order_id": "351177",
"refund_amount": 2.04,
"transaction_amount": "2.04",
"refund_details": [
{
"refund_id": 3523,
"refund_reference_no": "602201803257434370",

27
 "merchant_refund_id": null,
"refund_amount": "2.04",
"refund_status": "Customer Refunded",
"date": "2018-02-01 11:19:49"
}
]
},
"hash":
"20D8CB42D14C35AAEF06BB200C82E560DCC1D0C19EEFFBFD07CBEEB3BD39AE746AFB30A5803D6375
27CE1A45AE367565E8AF5933809E3F597D7CDDDCDB3C28FE"
}
In case of error,

{
"error": {
"code": 1050,
"message": "No data record found for the given input"
}
}

28
8 SPLIT API
8.1 Split Settlement API
8.1.1 Split transaction before settlement API

URL: https://{pg_api_url}/v2/splitsettlementrequest

If the split information is missing during payment request, this API can be used to send split information
to the system. The split information needs to be sent before settlements are done. Otherwise, it will be
rejected.

Request Parameters:

Parameter Description Data type Optional /

Name Mandatory
api_key The unique key provided to the merchant varchar(36) Mandatory
order_id The order id of the transaction Mandatory
split_info The json format data can contain json Mandatory
vendor_code and vendor_percent or
vendor_code and vendor_amount, see the
json structure below.
hash You need to compute a hash of all your varchar(255) Mandatory
parameters and pass that hash to Payment-
Gateway, for details about calculating hash
refer Appendix 2.

Note: the SALT will be provided by Payment-

Gateway separately. NEVER PASS SALT IN A
FORM, DO NOT STORE SALT IN ANDROID APP
APK or IPHONE APP package

hash = strtoupper(hash(‘sha512’,
salt|api_key|order_id|split_info))

The split_info parameter will be in json format as shown below:

{
"vendors":[
{
"vendor_code":"2VEN449",
"split_amount_percentage":"80"

29
 },
{
"vendor_code":"XYZ123",
"split_amount_fixed":"11"
}
]
}

Response Parameters:

The response will be in json format as show below:

In case of success,
{
"data": {
"message": "The split settlement request is successful."
}
}

In case of total split percentage or amount exceeds 100% or total settlement amount
{
"error": {
"code": 1024,
"message": "Sum of split amount should be less than or equal
to settlement amount."
}
}
In case of vendor code invalid or not approved
{
"error": {
"code": 1007,
"message": "One or more Codes is either not added or not
approved."
}
}

30
9 VENDOR APIs
9.1 Add Vendor API

URL: https://{pg_api_url}/v2/addvendor

This API allows the merchant to register new vendors with the Payment-Gateway system. These vendors
can also be added manually from the Payment-Gateway dashboard.

When a vendor is added, it is "non-approved" by default. Payment-Gateway will approve the vendors
separately. This is for security purposes.

Parameter Name Description Data type Optional /

Mandatory
Payment-Gateway would assign a unique 36-
api_key digit merchant key to you. This key is varchar(36) mandatory
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.
This is the vendor code that you wish to add
vendor_code in the Payment-Gateway system. This has to varchar(30) mandatory
be unique. Alphanumeric values are
permitted here.
vendor_name A descriptive name to identify the vendor. varchar(100) mandatory
vendor_contact_email Email address where the vendor can be varchar(200) mandatory
contacted. Has to be a valid email address.
vendor_contact_num Phone number where the vendor can be varchar(10) mandatory
contacted.
vendor_contact_address Address where the vendor can be reached. varchar(300) optional
account_name Account holder name (of the vendor bank varchar(300) optional
account). Optional if UPI details are given.
account_number Account number of the vendor. Optional if varchar(50) optional
UPI details are given.
ifsc_code IFSC code of the vendor’s bank. Optional if varchar(50) optional
UPI details are given.
bank_name Bank name of the vendor’s bank. Optional if varchar(200) optional
UPI details are given.
bank_branch Bank branch of the vendor’s bank. Optional varchar(300) optional
if UPI details are given.
upi_id UPI VPA of the vendor. Optional if bank varchar(50) optional
account details are given.
vendor_pan PAN number of the vendor varchar(10) optional
description_1 Vendor description 1 varchar(200) optional
description_2 Vendor description 2 varchar(200) optional

31
 activate_bharat_qr Pass 'y' in case bharat qr needs to be varchar(1) optional
generated for this vendor
aadhar_number Aadhar number is required if bharat qr varchar(12) optional
needs to be generated
You need to compute a hash of all your
hash parameters and pass that hash to Payment- varchar(200) mandatory
Gateway, for details about calculating hash
refer Appendix 2.

Note: the SALT will be provided by Payment-

Gateway separately. NEVER PASS SALT IN A
FORM, DO NOT STORE SALT IN ANDROID
APP APK or IPHONE APP package

Please ensure that the concatenated string

(upon which the hash will be computed) is
computed based on columns in alphabetical
order. Please include only those columns in
your hash calculation which you are actually
passing to us. For example, if you are not
passing vendor_contact_address do not
include that in hash calculation.

Note: This API will return error if the vendor already exists in the system AND is active. If an
inactive/disapproved vendor exists, this API will update the details for that vendor code.

The response will be in json format as show below:

In case of success,
{
"data": {
"code":"SUCCESS",
"account_id":0026,
"message": "Vendor is added Successfully"
"static_qr_code": "0002010102110216407758000003774806
1661004600000385150821hdfc000000162713126410010A0000005240116yap94026@
equitas02031.027230010A00000052401059402628300010A00000052401121234123
412345204739953033565802IN5907abc
pay6032bangalore610656000162120708940260012314D41"
}
}

In case vendor already exists

{
"error": {
"code": 1024,

32
 "message": "Vendor code already exists"
}
}

9.2 Modify Vendor API

URL: https://{pg_api_url}/v2/modifyvendor

Pre-existing vendors in the system can be modified using this API. This API works on approved as well as
non-approved vendors. However, any modification to a pre-existing active vendor will immediately
disapprove that vendor, automatically. If the vendor that is being modified does not exist, the API will
return an error and will NOT automatically add the vendor. This will change the default account for the
vendor

Parameter Name Description Data type Optional/

Mandatory
Payment-Gateway would assign a unique 36-
api_key digit merchant key to you. This key is varchar(36) mandatory
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.
This is the vendor code that you wish to
vendor_code modify in the Payment-Gateway system. This varchar(30) mandatory
value must already exist in the system,
failing which Payment-Gateway will return
an error.
vendor_name A descriptive name to identify the vendor. varchar(100) optional
vendor_contact_email Email address where the vendor can be varchar(200) optional
contacted. Has to be a valid email address.
vendor_contact_num Phone number where the vendor can be varchar(10) optional
contacted.
vendor_contact_address Address where the vendor can be reached. varchar(300) optional
Optional.
account_id Account id which needs to be modified. The varchar(10) optional
account_id is returned in the addvendor API.
If it is not passed, the last approved account
of the vendor is updated
account_name Account holder name (of the vendor bank varchar(300) optional
account). Optional if UPI details are given.
account_number Account number of the vendor. Optional if varchar(50) optional
UPI details are given.
ifsc_code IFSC code of the vendor’s bank. Optional if varchar(50) optional
UPI details are given.

33
 bank_name Bank name of the vendor’s bank. Optional if varchar(200) optional
UPI details are given.
bank_branch Bank branch of the vendor’s bank. Optional varchar(300) optional
if UPI details are given.
upi_id UPI VPA of the vendor. Optional if bank varchar(50) optional
account details are given
vendor_pan PAN number of the vendor varchar(10) optional
description_1 Vendor description 1 varchar(200) optional
description_2 Vendor description 2 varchar(200) optional
activate_bharat_qr Pass 'y' in case bharat qr needs to be varchar(1) optional
generated for this vendor
aadhar_number Aadhar number is required if bharat qr varchar(12) optional
needs to be generated
You need to compute a hash of all your
hash parameters and pass that hash to Payment- varchar(200) mandatory
Gateway, for details about calculating hash
refer Appendix 2.

Note: the SALT will be provided by Payment-

Gateway separately. NEVER PASS SALT IN A
FORM, DO NOT STORE SALT IN ANDROID
APP APK or IPHONE APP package

Please ensure that the concatenated string

(upon which the hash will be computed) is
computed based on columns in alphabetical
order. Please include only those columns in
your hash calculation which you are actually
passing to us. For example, if you are not
passing vendor_contact_address do not
include that in hash calculation.

The response will be in json format as show below:

In case of success,

{
"data": {
"code":"SUCCESS",
"message": " Vendor Details Updated Successfully"
}
}

9.3 Add Vendor Accounts API

URL: https://{pg_api_url}/v2/addvendoraccount

Multiple accounts can be added to pre-existing vendors in the system using this API. This API works on

34
approved as well as non-approved vendors. If the vendor that is being given does not exist, the API will
return an error and will NOT automatically add details to the vendor.

Parameter Name Description Data type Optional/

Mandatory
Payment-Gateway would assign a unique 36-
api_key digit merchant key to you. This key is varchar(36) mandatory
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.
This is the vendor code that you wish to
vendor_code modify in the Payment-Gateway system. This varchar(30) mandatory
value must already exist in the system,
failing which Payment-Gateway will return
an error.
account_name Account holder name (of the vendor bank varchar(300) optional
account). Optional if UPI details are given.
account_number Account number of the vendor. Optional if varchar(50) optional
UPI details are given.
ifsc_code IFSC code of the vendor’s bank. Optional if varchar(50) optional
UPI details are given.
bank_name Bank name of the vendor’s bank. Optional if varchar(200) optional
UPI details are given.
bank_branch Bank branch of the vendor’s bank. Optional varchar(300) optional
if UPI details are given.
upi_id UPI VPA of the vendor. Optional if bank varchar(50) optional
account details are given
default_account Whether this will be the default account of varchar(1) mandatory
the vendor or not. Possible values are "y" or
"n".
IMPORTANT: System can have only one
default account, if the value is passed as ‘y’
and default account exist, error will be
displayed
You need to compute a hash of all your
hash parameters and pass that hash to Payment- varchar(200) mandatory
Gateway, for details about calculating hash
refer Appendix 2.

Note: the SALT will be provided by Payment-

Gateway separately. NEVER PASS SALT IN A
FORM, DO NOT STORE SALT IN ANDROID
APP APK or IPHONE APP package

Please ensure that the concatenated string

(upon which the hash will be computed) is

35
 computed based on columns in alphabetical
order. Please include only those columns in
your hash calculation which you are actually
passing to us. For example, if you are not
passing vendor_contact_address do not
include that in hash calculation.

The response will be in json format as show below:

In case of success,

{
"data": {
"code":"SUCCESS",
"account_id":"12313",
"message": " Vendor account is added Successfully"
}
}

9.4 Delete Vendor API

URL: https://{pg_api_url}/v2/deletevendor

This API can be used to delete a pre-existing vendor from the Payment-Gateway system. Subsequent to
deletion, there can be no further split payments to this vendor. Importantly, deletion of a vendor will
NOT impact pending payouts to the vendor. Any pending settlements will still occur

Parameter Description Data type Optional/

Name Mandatory
Payment-Gateway would assign a unique 36-digit
api_key merchant key to you. This key is exclusive to your varchar(36) mandatory
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.
This is the vendor code that you wish to delete from
vendor_code the Payment-Gateway system. This value must already varchar(30) mandatory
exist in the system, failing which Payment-Gateway will
return an error.
You need to compute a hash of all your parameters and
hash pass that hash to Payment-Gateway, for details about varchar(255) mandatory
calculating hash refer Appendix 2.

Note: the SALT will be provided by Payment-Gateway

separately. NEVER PASS SALT IN A FORM, DO NOT
STORE SALT IN ANDROID APP APK or IPHONE APP
package

36
 hash = toUpper ( sha512 (SALT| api_key
|vendor_code))

This API can be used to delete a pre-existing vendor from the Payment-Gateway system. Subsequent to
deletion, there can be no further split payments to this vendor. Importantly, deletion of a vendor will
NOT impact pending payouts to the vendor. Any pending settlements will still occur
The response will be in json format as show below:
In case of success,
{
"data": {
"code":"SUCCESS",
"message": " Vendor is deleted Successfully"
}
}

9.5 Get Vendor API

URL: https://{pg_api_url}/v2/vendorstatus

This API can be used to delete a pre-existing vendor from the Payment-Gateway system.

Parameter Description Data type Optional/

Name Mandatory
Payment-Gateway would assign a unique 36-digit
api_key merchant key to you. This key is exclusive to your varchar(36) mandatory
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.
This is the vendor code that you wish to retrieve from
vendor_code the Payment-Gateway system. This value must already varchar(30) mandatory
exist in the system, failing which Payment-Gateway will
return an error.
You need to compute a hash of all your parameters and
hash pass that hash to Payment-Gateway, for details about varchar(255) mandatory
calculating hash refer Appendix 2.

Note: the SALT will be provided by Payment-Gateway

separately. NEVER PASS SALT IN A FORM, DO NOT
STORE SALT IN ANDROID APP APK or IPHONE APP
package

hash = toUpper ( sha512 (SALT| api_key

|vendor_code))

This API can be used to get details of a pre-existing vendor from the Payment-Gateway system.

37
The response will be in json format as show below:

In case of success,
{
"data": {
"vendor_code": "5d1ee6743a3asd2d476a669b",
"vendor_name": "Sindhu",
"vendor_contact_email": "[email protected]",
"vendor_contact_num": "9900990099",
"vendor_contact_address": "Domlur, Indira Nagar, Bangalore",
"vendor_pan": "ARSPH1234Q",
"vendor_approved": "y",
"vendor_split_percentage": null,
"vendor_split_amount": null,
"earliest_settlement_time_frame": null,
"latest_settlement_time_frame": null,
"vendor_logo": null,
"qr_code":
"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJMAAACTAQMAAACwK7lWAAA
ABlBMVEX///8AAABVwtN+AAAAAXRSTlMAQObYZgAAAAlwSFlzAAAOxAAADsQBlSsOGwAA…
……vRou3ed6h+OmH3Ch8fMD+wfnU1Eyj4zFVQAAAABJRU5ErkJggg==",
"bank_accounts": [
{
"account_id": 3288,
"account_name": "Dummy",
"account_number": "1000000001",
"ifsc_code": "UTIB0000003",
"bank_name": "Dummy Bank",
"bank_branch": "Demo Road",
"upi_id": null,
"bank_approved": "y",
"default_account": "y"
}
]
}
}

38
10 SETTLEMENT APIs
10.1 Get Settlements API
URL: https://{pg_api_url}/v2/getsettlements

This API allows a merchant to programmatically access the status of any of his past settlements and
other pertinent information pertaining to a prior settlement. If this API returns a blank
bank_reference_number, it means the amount is not yet settled. If the API returns no data, it means
that the system has not calculated settlements yet, you would need to re-check after 12:30 AM.

Please note that this API will not provide any information for failed transactions since, there can be no
settlement for a failed transaction. To obtain information about failed transactions, use the payment
status API described in an earlier section.

10.1.1 Parameters to be POSTed in Request

Parameter Description Data type Optional /

Name Mandatory
Payment-Gateway would assign a unique 36-digit
api_key merchant key to you. This key is exclusive to your varchar(36) Mandatory
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.
bank_reference The bank reference number of the actual varchar(100) Optional
NEFT/IMPS/RTGS transaction performed by Payment-
Gateway to the merchant’s current account
date_from The start date from which you need to retrieve varchar(10) Optional
settlement information. This needs to be passed in
DD-MM-YYYY format.
date_to The end date at which you need to retrieve varchar(10) Optional
settlement information. This needs to be passed in
DD-MM-YYYY format.
completed Whether settlement is completed or not. Pass in ‘y’ or varchar(1) Optional
‘n’ here.
settlement_id The unique numeric settlement ID assigned to each number(20) Optional
settlement
hash You need to compute a hash of all your parameters Mandatory
and pass that hash to Payment-Gateway, for details varchar(255)
about calculating hash refer Appendix 2.

Note: the SALT will be provided by Payment-Gateway

separately. NEVER PASS SALT IN A FORM, DO NOT

39
 STORE SALT IN ANDROID APP APK or IPHONE APP
package.

This API returns a JSON in the following format:

{
"data": [
{
"settlement_id": 10075,
"bank_reference": "710061536126",
"payout_amount": "2.06",
"completed": "y",
"account_name": "Tester Sharma",
"account_number": "50100012341231",
"ifsc_code": "HDFC0000002",
"bank_name": "HDFC BANK",
"bank_branch": "CMH RD, INDIRA NAGAR BRANCH",
“settlement_datetime": "2017-02-20 16:31:28",
"sale_amount": "3.00",
"chargeback_amount": “0.00”,
"refund_amount": "0.00"
}
],
"hash":
"684CDA22F7A429D68281444A8F6809A5FEFEA7A055258984E129554AC359C956E58E36B67A4EB9F948
1E616888E722DDB95A81EFBED4416B24F19E3126077F5E"
}

In case there is no record found in the system for the combination of input parameter,
following error is returned

{
"error": {
"code": 404,
"message": "No record found"
}
}

10.2 Get Settlement Details API

URL: https://{pg_api_url}/v2/getsettlementdetails

This API allows a merchant to programmatically access the status of any of his past settlement details
(transaction level settlements).

40
Please note that this API will not provide any information for failed transactions since by definition,
there can be no settlement for a failed transaction. To obtain information about failed transactions, use
the payment status API described in an earlier section.

10.2.1 Parameters to be POSTed in Request

Parameter Description Data type Optional /

Name Mandatory
Payment-Gateway would assign a unique 36-digit
api_key merchant key to you. This key is exclusive to your varchar(36) mandatory
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.
order_id Order ID passed by the merchant during the original varchar(30) optional
payment transaction request
transaction_id Transaction ID assigned by Payment-Gateway for this varchar(30) optional
successful transaction
bank_code Bank code signifying payment mode and channel varchar(4) optional
customer_phone Phone number of customer as provided during the varchar(30) optional
original paymentrequest API call
customer_email Email ID of customer as provided during the original varchar(255) optional
paymentrequest API call
customer_name Name of customer as provided during the original varchar(255) optional
paymentrequest API call
date_from The start date from which you need to retrieve varchar(10) optional
settlement detail information. This needs to be
passed in DD-MM-YYYY format.
date_to The end date at which you need to retrieve varchar(10) optional
settlement detail information. This needs to be
passed in DD-MM-YYYY format.
completed Whether settlement is completed or not. Pass in ‘y’ varchar(1) optional
or ‘n’ here.
settlement_id The unique numeric settlement ID assigned to each number(20) optional
settlement
hash You need to compute a hash of all your parameters mandatory
and pass that hash to Payment-Gateway, for details varchar(255)
about calculating hash refer Appendix 2.

Note: the SALT will be provided by Payment-Gateway

separately. NEVER PASS SALT IN A FORM, DO NOT
STORE SALT IN ANDROID APP APK or IPHONE APP
package.

This API returns a JSON in the following format:

41
{
"data": [
{
"transaction_id": "HDMASC2746901262",
"order_id": "225495",
"settlement_id": 27837,
"bank_reference": "710061536126",
"settlement_datetime": null,
"customer_name": "Tester",
"customer_email": "[email protected]",
"customer_phone": "8050603774",
"completed": "y",
"description": "Settlement for Rs. 2.06 paid through transaction ID HDMASC2746901262 on 2017-
09-28 13:36:19 for merchant hotel booking",
"gross_transaction_amount": "2.06",
"payment_mode": "Credit Card",
"payment_channel": "Master",
"applicable_tdr_percent": "3.00",
"applicable_tdr_fixed_fee": "0.00",
"percent_tdr_paid_by_merchant": "0",
"tdr_amount": "0.06",
"tax_on_tdr_amount": "0.00",
"amount_reimbursed": "2.00"
}
],
"hash":
"D2EFF4776D973DA46563DA0F80139B84AFED77C58496A34DD0D653272A0EE1E5D09F4C94AD439451
2B16341A5A44906B4B10FF5B6AA1F03DE98A164B39881C4E"
}

In case there is no record found in the system for the combination of input parameter,
following error is returned

{
"error": {
"code": 404,
"message": "No record found"
}
}

42
11 CHALLAN PAYMENT APIs
11.1 Request challan payment API

URL: https://{pg_api_url}/v1/requestchallan

This API allows the merchant to create a link which can be sent to customers by email and/or SMS. This
link allows the customer to make easy payments without data entry hassles.

On clicking this link, the customer is taken directly to a confirmation page where he can verify his details
(email ID, name and amount), and on confirmation, he is taken to the payment page.

Parameter Description Data type Optional/

Name Mandatory
api_key Payment-Gateway would assign a unique 36-digit varchar(36) mandatory
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.
name Name of the person whom the invoice is addressed to. varchar(100) Mandatory
mobile Phone number of the person whom the invoice is varchar(10) mandatory
addressed to.
email Email ID of the person whom the invoice is addressed varchar(100) mandatory
to.
amount Amount which the user needs to pay. decimal(15,2) mandatory
purpose Purpose of payment - this should be a descriptive string varchar(100) mandatory
which clearly tells the user what he is paying for.
hash You need to compute a hash of all your parameters and varchar(255) mandatory
pass that hash to Payment-Gateway, for details about
calculating hash refer Appendix 2.

Note: the SALT will be provided by Payment-Gateway

separately. NEVER PASS SALT IN A FORM, DO NOT
STORE SALT IN ANDROID APP APK or IPHONE APP
package.

11.2 Request challan payment API url

URL: https://{pg_api_url}/v1/generatechallanurl

This API allows the merchant to create a url which can be sent to customers by email and/or SMS.
This url allows the customer to make easy payments without data entry hassles.

43
On clicking above url, the customer is taken directly to a confirmation page where he can verify his
details (email ID, name and amount), and on confirmation, he is taken to the payment page.

11.2.1 Request parameters are as following:

Parameter Description Data type Optional/
Name Mandatory
api_key Payment-Gateway would assign a unique 36-digit varchar(36) mandatory
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.
name Name of the person whom the invoice is addressed to. varchar(100) Mandatory
mobile Phone number of the person whom the invoice is varchar(10) mandatory
addressed to.
email Email ID of the person whom the invoice is addressed to. varchar(100) mandatory
amount Amount which the user needs to pay. decimal(15,2) mandatory
purpose Purpose of payment - this should be a descriptive string varchar(100) mandatory
which clearly tells the user what he is paying for.
hash You need to compute a hash of all your parameters and varchar(255) Mandatory
pass that hash to Payment-Gateway, using the following
mechanism:
toUpper ( sha512 (SALT|amount| api_key |
email|mobile|name|purpose))
Note: the SALT will be provided by Payment-Gateway
separately.
Please ensure that the concatenated string (upon which
the hash will be computed) is in alphabetical order.
Note: NEVER PASS SALT IN A FORM

11.2.2 Response from this API will be in JSON format:

On successful call to this API you will receive JSON response in following format.
{
"data": {
"url": "http://biz.localhost.com/challan/b39b0596-73c4-4b7e-b63d-
bbc13361e044",
"uuid": "b39b0596-73c4-4b7e-b63d-bbc13361e044",
"tnp_id": 81600
}
}
data - successful response will have "data" tag.
url - this is the url what can be distributes as suitable.
uuid - this is the unique identifier for this request.
tnp_id - this is another unique identifier that can be used for getting the transaction details using
paymentStatusById API.

On failure json response is as following:

{

44
 "error": {
"code": 221,
"message": "GEN-UNAUTHORIZED - The api key field is incorrect"
}
}
error - erred response will have "error" tag.
code - this is error category code
message - this is more descriptive error tag and error message.

11.2.3 List of error codes and corresponding messages:

Code Message
221 GEN-UNAUTHORIZED
The api key field is incorrect
The hash key field is invalid
998 GEN-INVALID-PARAMS
The name field is required.
The email field is required.
The mobile field is required.
The amount field is required.
The purpose field is required.
The hash field is required.

45
12 SERVER TO SERVER CALL BACK (WEB HOOKS)
12.1 Server to server response on Payment
To get server to server response, add callback URL in parameter named "Payment Callback URL" in your
Payment-Gateway dashboard. If this is not found contact Payment-Gateway to set this up for you.

Whenever there is a successful payment done by your customer apart from receiving success or failure
message on customers’ browser, following response parameters are also posted to the mentioned
callback URL.

These are very same response that we send as response to paymentrequest API.

Parameter name Description

transaction_id A unique ID that can be used to trace the transaction uniquely within Payment-
Gateway. Transaction IDs are alphanumeric.
payment_method This tells the payment method used by customer - example: "credit card", "debit
card", "netbanking", etc.
payment_datetime Date and Time of this payment in “DD-MM-YYYY HH:MM:SS” format
response_code Status of the transaction (return code). 0 signifies successful transaction. Non-
zero values signify error.
response_message Can have a value of "success" or "failure". Order
order_id The same order_id that was originally posted by the merchant in the request.
amount The same original amount that was sent by the merchant in the transaction
request.
currency This is the 3digit currency code (INR), it will be same value that was originally
sent by merchant.
description The same description that was originally sent by the merchant in the transaction
request.
name The same value that was originally sent by merchant
email The same value that was originally sent by merchant
phone The same value that was originally sent by merchant
address_line_1 The same value that was originally sent by merchant
address_line_2 The same value that was originally sent by merchant
city The same value that was originally sent by merchant
state The same value that was originally sent by merchant
country The same value that was originally sent by merchant
zip_code The same value that was originally sent by merchant
udf1 The same value that was originally sent by merchant
udf2 The same value that was originally sent by merchant
udf3 The same value that was originally sent by merchant
udf4 The same value that was originally sent by merchant
udf5 The same value that was originally sent by merchant
hash Payment-Gateway calculates the hash using the same algorithm which was
outlined earlier. Hence, the merchant needs to check whether this returned
hash matches the calculated hash.

46
12.2 Server to server response on Settlement
To get server to server response, add callback URL in parameter named "Settlement Callback URL" in
your Payment-Gateway dashboard. If this is not found contact Payment-Gateway to set this up for you.

Whenever there is a successful settlement done by Payment-Gateway to your bank account apart from
receiving success or failure email message, following response parameters are also posted to the
mentioned callback URL.

These are very same response that we send as response to getsettlements API.

Parameter name Description

settlement_id Settlement Id for this aggregated settlement
bank_reference Bank reference Number
payout_amount Aggregated Amount paid to merchant
completed Settlement is completed or not, 'y' or 'n'
account_name Account Holders Name to which the Amount is settled
account_number Account Number to which the Amount is settled
ifsc_code IFSC Code of the branch to which Account Number belongs
bank_name Bank name to which Account Number belongs
settlement_datetime Date of settlement
sale_amount Total sale amount for the transactions included in this aggregated settlement
chargeback_amount Amount deducted from the sale amount for chargeback adjustment
refund_amount Amount deducted from the sale amount for refunds adjustment.

47
13 SEAMLESS PAYMENT REQUEST API
In case you perform the normal payment integration process as outlined earlier in the document, the
customer will necessarily be redirected to the Payment-Gateway payment page wherein he will be
required to enter his card details or select the appropriate bank/payment instrument (such as wallets
etc.) with which he would like to make the payment.

If you would like your customer to perform the bank selection and/or enter his card information on your
site, without using the Payment-Gateway payment page, this can be achieved using the seamless
payment request API. Payment-Gateway would provide you a list of appropriate bankcodes which you
would be required to pass along with the payment request. These bankcodes are available in Appendix 3
of this document.

Please note that in order to use our seamless payment request API you would need to be PCI-DSS
compliant. For more information on PCI compliance, or if you would like us to assist you in your PCI
compliance efforts, please contact your Payment-Gateway relationship manager.

13.1 Steps for Integration

• You need to submit a POST REQUEST to our server, at the below-mentioned URL; Note that it
should be a html form to be able to redirect to payment page e.g. <form method='post'
action=' https://{pg_api_url}/v2/paymentseamlessrequest '> </form>
•
• Note: hash is a mandatory parameter. If your hash is not properly calculated or does not match
for whatever reason, we will not be able to process the payment. The usage of hash is explained
in subsequent sections.
• When you submit your transaction request to Payment-Gateway, we assign a transaction ID to
you.
• The customer is automatically redirected to the appropriate bank or 3D-secure page, as the case
may be.
• After the customer pays the entire amount using one or more payment instruments, he is
redirected back to the merchant site.
• We recommend that you check the hash at your end again, after we send back the response to
you. This is essential to prevent user data tampering fraud.

13.2 Parameters to be POSTed in Seamless Payment Request

URL: https://{pg_api_url}/v2/paymentseamlessrequest

Method: POST

Content-Type: application/x-www-form-urlencoded

48
Parameter Name Description Data type Optional /
Mandatory
api_key Payment-Gateway would assign a unique 40- varchar(36) Mandatory
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.
order_id This is your (merchant) reference number. It varchar(30) Mandatory
must be unique for every transaction.
mode This is the payment mode (TEST or LIVE are varchar(4) Optional
valid values). Defaults to LIVE.
amount This is the payment amount. decimal(15,2) Mandatory
currency This is the 3digit currency code (INR) varchar(3) Mandatory
description Brief description of product or service that varchar(500) Mandatory
the customer is being charged for.
name Name of customer. varchar(100) Mandatory
email Customer email address. varchar(100) Mandatory
phone Customer phone number varchar(50) Mandatory
address_line_1 Customer address varchar(100) Optional
address_line_2 Customer address 2 varchar(100) Optional
city Customer city varchar(50) Mandatory
state Customer State varchar(50) Optional
country Customer country must be IND varchar(50) Mandatory
zip_code Customer zip code varchar(20) Mandatory
udf1 User defined field 1 varchar(300) Optional
udf2 User defined field 2 varchar(300) Optional
udf3 User defined field 3 varchar(300) Optional
udf4 User defined field 4 varchar(300) Optional
udf5 User defined field 5 varchar(300) Optional
bank_code Bank code identifies the payment mode and varchar(20) Mandatory
channel.
card_number Card number (11 to 19 digits) varchar(19) Conditional
expiry_date Expiry date in mm/yyyy format varchar(7) Conditional
card_holder_name Card holder name varchar(30) Conditional
cvv CVV/CVC varchar(4) Conditional
payer_virtual_address UPI id of the customer, required when varchar(50) Conditional
bank_code is UPIU
return_url Return URL success - Payment-Gateway will varchar(300) Mandatory
make a POST request to this URL after
successful transaction, with a set of
parameters, which you can process as you
want to.
return_url_failure Return URL failure - Payment-Gateway will varchar(300) Optional
make a POST request to this URL after failed
transaction, with a set of parameters, which

49
 you can process as you want to. Defaults to
return_url.
return_url_cancel Return URL cancel - Payment-Gateway will varchar(300) Optional
make a POST request to this URL after user-
cancelled transaction, with a set of
parameters, which you can process as you
want to.
hash You need to compute a hash of all your varchar(255) Mandatory
parameters and pass that hash to Payment-
Gateway, for details about calculating hash
refer Appendix 2.

Note: the SALT will be provided by Payment-

Gateway separately. NEVER PASS SALT IN A
FORM, DO NOT STORE SALT IN ANDROID APP
APK or IPHONE APP package.

13.3 Response Parameters

Response sent after complete amount is paid. This is a server to browser response

Parameter name Description

transaction_id A unique ID that can be used to trace the transaction uniquely within
Payment-Gateway. Transaction IDs are alphanumeric.
payment_mode This tells the payment mode used by customer - example: "credit card",
"debit card", "netbanking", etc.
Payment_channel The actual payment channel - for example Visa, Master, Diners, HDFC Bank,
MobiKwik, etc.
payment_datetime Date and Time of this payment in "DD-MM-YYYY HH:MM:SS" format
response_code Status of the transaction (return code). 0 signifies successful transaction.
Non-zero values signify error.
response_message Can have a value of "Transaction Successful" or "Transaction Failed" or
“Transaction Cancelled”.
error_desc Failure reason (if transaction is failed)
order_id The same order_id that was originally posted by the merchant in the
request.
amount The same original amount that was sent by the merchant in the transaction
request.
currency This is the 3digit currency code (INR), it will be same value that was originally
sent by merchant.
description The same description that was originally sent by the merchant in the
transaction request.
name The same value that was originally sent by merchant
email The same value that was originally sent by merchant
phone The same value that was originally sent by merchant
address_line_1 The same value that was originally sent by merchant
address_line_2 The same value that was originally sent by merchant

50
city The same value that was originally sent by merchant
state The same value that was originally sent by merchant
country The same value that was originally sent by merchant
zip_code The same value that was originally sent by merchant
udf1 The same value that was originally sent by merchant
udf2 The same value that was originally sent by merchant
udf3 The same value that was originally sent by merchant
udf4 The same value that was originally sent by merchant
udf5 The same value that was originally sent by merchant
cardmasked The card number used by customer for making payment. This will NOT BE
SENT by default, and is sent only in case the merchant has been explicitly
approved to receive this information. Else this is always sent as null.
hash Payment-Gateway calculates the hash using the same algorithm which was
outlined earlier. Hence, the merchant needs to check whether this returned
hash matches the calculated hash.

51
14 APPENDIX 1 - References

We have sample code in PHP available for payment gateway integration, we also have SDKs and various
pre-built plugins of popular cart applications, to get the same get in contact with your contact person at
Payment-Gateway

52
15 APPENDIX 2 - Hash calculation guide

15.1 How to Calculate Hash on API request

To calculate hash, you will need the salt provided by Payment-Gateway.

15.1.1 Hashing generation algorithm

Following are the steps to calculate hash.

1. Create a | (pipe) delimited string called hash_data with first value as the salt.
2. Now sort the post fields based on their keys and create a | delimited string, for the fields with
values.
3. Hash the hash_data string using SHA512 hashing algorithm and save the hash in secure_hash
string
4. Convert the secure_hash string to upper case

15.1.1.1 Example PHP code to generate hash

/**
* @param array $parameters
* @param string $salt
* @param string $hashing_method
* @return null|string
*/
function generateHashKey($parameters, $salt, $hashing_method = 'sha512')
{
$secure_hash = null;
ksort($parameters);
$hash_data = $salt;
foreach ($parameters as $key => $value) {
if (strlen($value) > 0) {
$hash_data .= '|' . trim($value);
}
}

if (strlen($hash_data) > 0) {
$secure_hash = strtoupper(hash($hashing_method, $hash_data));
}

return $secure_hash;
}

15.2 How to check the response Hash

It is important to make sure the response received from Payment-Gateway is genuine, and to do so you
will need to do a hash check on your server on receiving the response.

53
Every response received has a field called hash. Sometimes it is null, which means it in not important to
check hash for the response, but if there is a hash present please perform hash check as described
below and make sure integrity of the response received from Payment-Gateway APIs.

To check hash, you will need the salt provided by Payment-Gateway.

15.2.1 Hash checking algorithm

15.2.1.1 Example PHP code to check hash
/**
* @param string $salt
* @param array $response_array
* @return bool
*/
function responseHashCheck($salt, $response_array)
{

/* If hash field is null no need to check hash for such response */

if (is_null($response_array['hash'])) {
return true;
}

$response_hash = $response_array['hash'];
unset($response_array['hash']);

/* Now we have response json without the hash */

$calculated_hash = hashCalculate($salt, $response_array);

return ($response_hash == $calculated_hash) ? true : false;

}

/**
* @param string $salt
* @param array $input
* @return string
*/

function hashCalculate($salt, $input)

{
/* Columns used for hash calculation, Donot add or remove values from $hash_columns
array */
$hash_columns = array_keys($input);
/*Sort the array before hashing*/
sort($hash_columns);

/*Create a | (pipe) separated string of all the $input values which are available
in $hash_columns*/
$hash_data = $salt;
foreach ($hash_columns as $column) {
if (isset($input[$column])) {
if (strlen($input[$column]) > 0) {
$hash_data .= '|' . trim($input[$column]);
}
}
}
$hash = strtoupper(hash("sha512", $hash_data));

54
 return $hash;
}

15.2.1.2 Example PHP code to check hash if response is JSON

/**
* @param $salt
* @param $response_json
* @return bool
*/
function responseHashCheck($salt, $response_array)
{

/* If hash field is null no need to check hash for such response */

if (is_null($response_array['hash'])) {
return true;
}

$response_hash = $response_array['hash'];
unset($response_array['hash']);
$response_json = json_encode($response_array, JSON_UNESCAPED_SLASHES);

/* Now we have response json without the hash */

$calculated_hash = hashCalculate($salt, $response_json);

return ($response_hash == $calculated_hash) ? true : false;

}

/**
* @param $salt
* @param $input_json
* @return string
*/
function hashCalculate($salt, $input_json)
{

/* Prepend salt with input json and calculate the hash using SHA512 */
$hash_data = $salt . $input_json;
$hash = strtoupper(hash('sha512', $hash_data));

return $hash;
}

55
16 APPENDIX 3 - List of bank codes

Bankcode Payment Payment Channel Description

Mode
VISC Credit Card Visa Visa Credit Card
MASC Credit Card Master Master Credit Cards
DINC Credit Card Diners Diners Credit Card
AMXC Credit Card Amex American Express Credit Card
RUPC Credit Card Rupay Rupay Credit Card
VICC Commercial Visa Visa Commercial Credit Card
Credit Card
MACC Commercial Master Master Commercial Credit Card
Credit Card
VICI International Visa Visa International Credit Card
Credit Card
MACI International Master Master International Credit Card
Credit Card
AMXI International Amex American Express International Credit
Credit Card Card
DINI International Diners Diners International Credit Card
Credit Card
VISD Debit Card Visa Visa Debit Card
MASD Debit Card Master Master Debit Card
MAED Debit Card Maestro (non-SBI) Maestro Debit Card (non-SBI)
MSED Debit Card Maestro (SBI) Maestro Debit Card (SBI)
RUPD Debit Card Rupay Rupay Debit Card
VIDI International Visa Visa International Debit Card
Debit Card
MADI International Master Master International Debit Card
Debit Card
IOBP Debit Pin Indian Overseas Bank Indian Overseas Bank
SYDP Debit Pin Syndicate Bank Syndicate Bank
AXIP Debit Pin AXIS Bank AXIS Bank
ADBP Debit Pin Andhra Bank Andhra Bank
UCOP Debit Pin UCO Bank UCO Bank
SUBP Debit Pin Suryodaya Bank Suryodaya Bank
ICIP Debit Pin ICICI Bank ICICI Bank
IDFP Debit Pin IDFC Bank IDFC Bank
SBIP Debit Pin State Bank Of India State Bank Of India
CBIP Debit Pin Central Bank Of India Central Bank Of India
ALLN Netbanking Allahabad Bank NetBanking Allahabad Bank NetBanking (Erstwhile
(Erstwhile Indian Bank) Indian Bank)

56
ADBN Netbanking Union Bank of India (Erstwhile Union Bank of India (Erstwhile Andhra
Andhra Bank) Bank)
ADBM Netbanking Union Bank of India (Erstwhile Union Bank of India (Erstwhile Andhra
Andhra Bank) - Corporate Bank) - Corporate
AXIN Netbanking AXIS Bank AXIS Bank NetBanking
BDNN Netbanking Bandhan bank Bandhan Bank
BBKN Netbanking Bank of Bahrain and Kuwait Bank of Bahrain and Kuwait
BBRM Netbanking Bank of Baroda - Corporate Bank of Baroda Corporate Banking
BBRN Netbanking Bank of Baroda - Retail Bank of Baroda Retail Banking
BOIN Netbanking Bank of India Bank of India
BOMN Netbanking Bank of Maharashtra Bank of Maharashtra
BCBN Netbanking Bassein Catholic Bank Bassein Catholic Bank
BMBN Netbanking Bharatiya Mahila Bank Bharatiya Mahila Bank
CANN Netbanking Canara Bank Canara Bank
CSBN Netbanking Catholic Syrian Bank Catholic Syrian Bank
CBIN Netbanking Central Bank Of India Central Bank Of India
CITN Netbanking Citi Bank NetBanking Citi Bank NetBanking
CUBN Netbanking City Union Bank City Union Bank
CRPN Netbanking Union Bank of India (Erstwhile Union Bank of India (Erstwhile
Corporation Bank) Corporation Bank)
COSN Netbanking Cosmos Bank Cosmos Bank
DBSN Netbanking DBS Bank DBS Bank
DCBM Netbanking DCB Bank - Corporate DCB Bank - Corporate Netbanking
DENN Netbanking Dena Bank Dena Bank
DSHN Netbanking Deutsche Bank Deutsche Bank
DCBN Netbanking Development Credit Bank Development Credit Bank
DHNM Netbanking Dhanlakshmi Bank - Corporate Dhanalakshmi Bank - corporate
Net Banking
DHNN Netbanking Dhanlakshmi Bank Dhanalakshmi Bank
FEDN Netbanking Federal Bank Federal Bank
HDFN Netbanking HDFC Bank HDFC Bank
ICIN Netbanking ICICI Bank ICICI Netbanking
IDFN Netbanking IDFC Bank IDFC Bank
ININ Netbanking Indian Bank Indian Bank
IOBN Netbanking Indian Overseas Bank Indian Overseas Bank
INDN Netbanking IndusInd Bank IndusInd Bank
IDBN Netbanking IDBI Industrial Development Bank of India
INGN Netbanking ING Vysya Bank ING Vysya Bank
JAKN Netbanking Jammu and Kashmir Bank Jammu and Kashmir Bank
JSBN Netbanking Janata Sahakari Bank Janata Sahakari Bank
KJBN Netbanking Kalyan Janata Sahakari Bank Kalyan Janata Sahakari Bank
KRKN Netbanking Karnataka Bank Karnataka Bank

57
KRVN Netbanking Karur Vysya - Retail Karur Vysya
KRVM Netbanking Karur Vysya - Corporate Karur Vysya - Corporate Netbanking
KKBN Netbanking Kotak Mahindra Bank Kotak Mahindra Bank
LVBN Netbanking Laxmi Vilas Bank Laxmi Vilas Bank - Retail
LVBM Netbanking Laxmi Vilas Bank - Corporate Laxmi Vilas Bank - Corporate
MSBN Netbanking The Mehsana Urban Co Op Bank The Mehsana Urban Co Op Bank Ltd.
Ltd
NKBN Netbanking NKGSB Bank NKGSB Bank
OBCN Netbanking PNB (Erstwhile-Oriental Bank of PNB (Erstwhile-Oriental Bank of
Commerce) Commerce)
PMCN Netbanking Punjab & Maharashtra Coop Punjab & Maharashtra Coop Bank
Bank
PSBN Netbanking Punjab & Sind Bank Punjab & Sind Bank
PNBN Netbanking Punjab National Bank - Retail Punjab National Bank - Retail Banking
PNBM Netbanking Punjab National Bank - Corporate Punjab National Bank-Corporate
RTNN Netbanking RBL Bank Limited RBL Bank Limited
RTNM Netbanking RBL Bank Limited- Corporate Net RBL Bank Limited- Corporate Net Banking
Banking
SRSN Netbanking Saraswat Bank Saraswat Bank
SVCN Netbanking Shamrao Vitthal Co-operative Shamrao Vitthal Co-operative Bank
Bank
SVCM Netbanking Shamrao Vitthal Co-operative Shamrao Vitthal Co-operative Bank -
Bank - Corporate Corporate
SOIN Netbanking South Indian Bank South Indian Bank
SCBN Netbanking Standard Chartered Bank Standard Chartered Bank
SBJN Netbanking State Bank of Bikaner and Jaipur State Bank of Bikaner and Jaipur
SBHN Netbanking State Bank of Hyderabad State Bank of Hyderabad
SBIN Netbanking State Bank of India State Bank of India
SBMN Netbanking State Bank of Mysore State Bank of Mysore
SBPN Netbanking State Bank of Patiala State Bank of Patiala
SBTN Netbanking State Bank of Travancore State Bank of Travancore
SYDN Netbanking Syndicate Bank (Erstwhile Canara Syndicate Bank (Erstwhile Canara Bank)
Bank)
TMBN Netbanking Tamilnad Mercantile Bank Ltd. Tamilnad Mercantile Bank Ltd.
TSCN Netbanking Tamilnadu State Coop Bank Tamilnadu State Coop Bank
TJSN Netbanking TJSB Bank TJSB Bank
UCON Netbanking UCO Bank UCO Bank
UBIM Netbanking Union Bank of India - Corporate Union Bank - Corporate Netbanking
UBIN Netbanking Union Bank of India - Retail Union Bank of India
UNIN Netbanking PNB (Erstwhile-United Bank of PNB (Erstwhile-United Bank of India)
India)
VIJN Netbanking Vijaya Bank Vijaya Bank
YESN Netbanking Yes Bank Yes Bank

58
ESFN Netbanking Equitas Bank Equitas Small Finance Bank Limited
PNYN Netbanking PNB YUVA Bank PNB YUVA Bank
KCCN Netbanking The Kalupur Commercial The Kalupur Commercial Cooperative
Cooperative Bank Limited Bank Limited
AIRN Netbanking Airtel Payment Bank Airtel Payment Bank
BHAN Netbanking Bharat Bank Bharat Bank
NBLN Netbanking Nainital Bank Nainital Bank
DEMN Netbanking Demo Bank Demo Netbanking
GPPN Netbanking GP Parsik Sahakari Bank GP Parsik Sahakari Bank
AUSN Netbanking AU Small Finance Bank AU Small Finance Bank
FESN Netbanking Federal Bank Scan And Pay Federal Bank Scan And Pay
SUBN Netbanking Suryoday Small Finance Bank Suryoday Small Finance Bank
VRBN Netbanking Varachha Co-Operative Bank Varachha Co-Operative Bank
NEBN Netbanking North East Small Finance Bank North East Small Finance Bank
IDBM Netbanking IDBI Bank - Corporate Industrial Development Bank of India -
Corporate
YESM Netbanking Yes Bank - Corporate Yes Bank - Corporate
CRPM Netbanking Union Bank of India (Erstwhile Union Bank of India (Erstwhile
Corporation Bank) - Corporate Corporation Bank) - Corporate
ADCN Netbanking Ahmedabad District Co-operative Ahmedabad District Co-operative Bank
Bank
ESAN Netbanking ESAF Small Finance Bank ESAF Small Finance Bank
BRLM Netbanking Barclays Corporate Banking Barclays Corporate Banking
ZOBN Netbanking Zoroastrian Co-operative Bank Zoroastrian Co-operative Bank
ABPN Netbanking Aditya Birla Payments Bank Aditya Birla Payments Bank
ALLM Netbanking Allahabad Bank Corporate Allahabad Bank Corporate Netbanking
Netbanking (Erstwhile Indian (Erstwhile Indian Bank)
Bank)
AXIM Netbanking AXIS Bank - Corporate AXIS Bank - Corporate NetBanking
ICIM Netbanking ICICI Bank - Corporate ICICI Bank - Corporate NetBanking
RBSN Netbanking Royal Bank Of Scotland Royal Bank Of Scotland NetBanking
JSFN Netbanking Jana Small Finance Jana Small Finance NetBanking
HSBN Netbanking HSBC NetBanking HSBC NetBanking
USFN Netbanking Ujjivan Small Finance Bank Ujjivan Small Finance NetBanking
FSFN NetBanking Fincare Small Finance Bank Fincare Small Finance Bank
BDNM Netbanking Bandhan bank - Corporate Bandhan bank - Corporate
APGN Netbanking Andhra Pragathi Grameena Bank Andhra Pragathi Grameena Bank
BCCN Netbanking Bassien Catholic Coop Bank Bassien Catholic Coop Bank
CPFN Netbanking Capital Small Finance Bank Capital Small Finance Bank
GSCN Netbanking Gujarat State Co-operative Bank Gujarat State Co-operative Bank Limited
Limited
JPBN Netbanking Jio Payments Bank Jio Payments Bank
KVGN NetBanking Karnataka Vikas Grameena Bank Karnataka Vikas Grameena Bank

59
MGBN Netbanking Maharashtra Gramin Bank Maharashtra Gramin Bank
SOMN Netbanking SBM Bank India SBM Bank India
SPCN Netbanking The Surat People’s Co-operative The Surat People’s Co-operative Bank
Bank Limited Limited
SUCN Netbanking The Sutex Co-op Bank Ltd The Sutex Co-op Bank Ltd
TBSN Netbanking Thane Bharat Sahakari Bank Ltd Thane Bharat Sahakari Bank Ltd
UTSN Netbanking Utkarsh Small Finance Bank Utkarsh Small Finance Bank
VCBN Netbanking The Varachha Co-operative Bank The Varachha Co-operative Bank
PYTN Netbanking Paytm Bank Paytm Net Banking
KGBN NetBanking Kaveri Grameena Bank Kaveri Grameena Bank
NNBN Netbanking Nutan Nagarik Sahakari Bank Nutan Nagarik Sahakari Bank Limited
Limited
SMCN Netbanking Shivalik Mercantile Cooperative Shivalik Mercantile Cooperative Bank Ltd
Bank Ltd
ABAN Netbanking ABN Amro Bank ABN Amro Bank
MCBN NetBanking The Mugberia Central Co- The Mugberia Central Co-operative Bank
operative Bank Ltd Ltd
ACCN NetBanking The Akola District Central The Akola District Central Cooperative
Cooperative Bank Ltd Bank Ltd
PGBN NetBanking Pragathi Gramin Bank Pragathi Gramin Bank
SGBN NetBanking Shreyas Gramin Bank Shreyas Gramin Bank
KABN Netbanking Karnataka Gramin Bank Karnataka Gramin Bank
PDBN Netbanking Pandyan Grama Bank Pandyan Grama Bank
SSSN Netbanking SUCO SOUHARDA SAHAKARI SUCO SOUHARDA SAHAKARI BANK
BANK
MDCN Netbanking MALDA DISTRICT CENTRAL MALDA DISTRICT CENTRAL COOPERATIVE
COOPERATIVE BANK LTD BANK LTD
OGBN Netbanking Odisha Gramya Bank Odisha Gramya Bank
BGVN Netbanking Bangiya Gramin Vikash Bank Bangiya Gramin Vikash Bank
MRBN Netbanking MANIPUR RURAL BANK MANIPUR RURAL BANK
AGVN Netbanking Assam Gramin VIkash Bank Assam Gramin VIkash Bank
TGBN Netbanking Tripura Gramin Bank Tripura Gramin Bank
TGCN Netbanking Tamluk-Ghatal Central Co- Tamluk-Ghatal Central Co-operative Bank
operative Bank Ltd Ltd
SDCN Netbanking The Surat District Co-Op Bank The Surat District Co-Op Bank
WUCN Netbanking The Washim Urban Co-operative The Washim Urban Co-operative Bank Ltd
Bank Ltd
AMCN Netbanking THE AHMEDABAD MERCANTILE THE AHMEDABAD MERCANTILE CO-OP
CO-OP BANK LTD BANK LTD
PCBN Netbanking Prime Co-Operative Bank Ltd Prime Co-Operative Bank Ltd
HGBN Netbanking Haryana Gramin Bank Haryana Gramin Bank
PLGN Netbanking Pallavan Grama Bank Pallavan Grama Bank
UUCN Netbanking The Udaipur Urban Co-op Bank The Udaipur Urban Co-op Bank Ltd
Ltd

60
KDCN Netbanking The Kasaragod District Co- The Kasaragod District Co-operative bank
operative bank Ltd Ltd
RCCN Netbanking Raiganj Central Co op Bank Ltd Raiganj Central Co op Bank Ltd
PSCN Netbanking THE PUNJAB STATE THE PUNJAB STATE COOPERATIVE BANK
COOPERATIVE BANK LTD LTD
JNSN Netbanking Jodhpur Nagrik Sahakari Bank Jodhpur Nagrik Sahakari Bank Limited
Limited
FCCN Netbanking THE FARIDKOT CENTRAL CO- THE FARIDKOT CENTRAL CO-OPERATIVE
OPERATIVE BANK LTD BANK LTD
ISBN Netbanking Indraprastha Sehkari Bank Ltd Indraprastha Sehkari Bank Ltd
MPCN Netbanking The Malappuram District Co- The Malappuram District Co-operative
operative Bank Limited Bank Limited
SNSN Netbanking Smriti Nagrik Sahakari Bank Smriti Nagrik Sahakari Bank
JCCN Netbanking THE JALANDHAR CENTRAL THE JALANDHAR CENTRAL COOPERATIVE
COOPERATIVE BANK LIMITED BANK LIMITED
LCCN Netbanking THE LUDHIANA CENTRAL THE LUDHIANA CENTRAL COOPERATIVE
COOPERATIVE BANK LTD BANK LTD
NJGN Netbanking Narmada Jhabua Gramin Bank Narmada Jhabua Gramin Bank
MUCN Netbanking Shree Mahalaxmi Urban Co-op Shree Mahalaxmi Urban Co-op Credit
Credit Bank Ltd Bank Ltd
JUCN Netbanking The Junagadh Commercial Co-op The Junagadh Commercial Co-op Bank Ltd
Bank Ltd
SCCN Netbanking THE SATARA DISTRICT CENTRAL THE SATARA DISTRICT CENTRAL CO-
CO-OPERATIVE BANK LTD OPERATIVE BANK LTD
TDCN Netbanking Thrissur District Cooperative Thrissur District Cooperative Bank Ltd
Bank Ltd
FZCN Netbanking THE FAZILKA CENTRAL COOP. THE FAZILKA CENTRAL COOP. BANK LTD
BANK LTD
MCCN Netbanking Mumbai District Central Co-op Mumbai District Central Co-op Bank Ltd
Bank Ltd
BOIM Netbanking Bank Of India - Corporate Bank Of India - Corporate
CUBM Netbanking City Union Bank - Corporate City Union Bank - Corporate
HDFM Netbanking HDFC Bank - Corporate HDFC Bank - Corporate
IOBM Netbanking Indian Overseas Bank - Corporate Indian Overseas Bank - Corporate
SBIM Netbanking State Bank of India - Corporate State Bank of India - Corporate
BBBN Netbanking Bank of Baroda - Retail(B2B) Bank of Baroda Retail Banking(B2B)
BBBM Netbanking Bank of Baroda - Corporate(B2B) Bank of Baroda Corporate Banking(B2B)
HSBE EMI Hong Kong And Shanghai Banking Hong Kong And Shanghai Banking Credit
Credit EMI EMI
YESE EMI Yes Bank Credit EMI Yes Bank Credit EMI
SCBE EMI Standard Chartered Bank Credit Standard Chartered Bank Credit EMI
EMI
AXIE EMI AXIS Bank Credit EMI AXIS Bank Credit EMI
RBLE EMI RBL Bank Credit EMI RBL Bank Credit EMI
HDFE EMI HDFC Bank Credit EMI HDFC Bank Credit EMI

61
CITE EMI CITIBANK Credit EMI CITIBANK Credit EMI
KKBE EMI Kotak Mahindra Bank Credit EMI Kotak Mahindra Bank Credit EMI
INDE EMI Indusind Bank Credit EMI Indusind Bank Credit EMI
AMXE EMI American Express Credit EMI American Express Credit EMI
ICIE EMI ICICI Bank Credit EMI ICICI Bank Credit EMI
SBIE EMI State Bank of India Credit EMI State Bank of India Credit EMI
BOBE EMI Bank of Baroda Credit EMI Bank of Baroda Credit EMI
AXDE EMI AXIS BANK DEBIT EMI AXIS Bank Debit EMI
HDDE EMI HDFC Bank Debit EMI HDFC Bank Debit EMI
BODE EMI Bank of Baroda Debit EMI Bank of Baroda Debit EMI
ICDE EMI ICICI Bank Debit EMI ICICI Bank Debit EMI
KKDE EMI Kotak Mahindra Bank Debit EMI Kotak Mahindra Bank Debit EMI
SBDE EMI State Bank of India Debit EMI State Bank of India Debit EMI
KKBL Direct EMI Kotak Mahindra Bank Credit EMI Kotak Mahindra Bank Credit EMI
BOBL Direct EMI Bank of Baroda Credit EMI Bank of Baroda Credit EMI
ICIL Direct EMI ICICI Bank Credit EMI ICICI Bank Credit EMI
SBIL Direct EMI State Bank of India Credit EMI State Bank of India Credit EMI
AXDL Direct EMI AXIS BANK DEBIT EMI AXIS Bank Debit EMI
AXIL Direct EMI AXIS Bank Credit EMI AXIS Bank Credit EMI
HDFL Direct EMI HDFC BANK Credit EMI HDFC Bank Credit EMI
ICDL Direct EMI ICICI Bank Debit EMI ICICI Bank Debit EMI
HDDL Direct EMI HDFC Bank Debit EMI HDFC Bank Debit EMI
AUIL Direct EMI AU Small Finance Bank Credit AU Small Finance Bank Credit EMI
EMI
RBLL Direct EMI RBL Bank Credit Card EMI RBL Bank Credit Card EMI
SCBL Direct EMI Standard Chartered Bank Credit Standard Chartered Bank Credit Card EMI
Card EMI
YESL Direct EMI Yes Bank Credit Card EMI Yes Bank Credit Card EMI
BOIA ATM Card Bank of India Bank of India ATM Card
PNBA ATM Card Punjab National Bank Punjab National Bank ATM Card
BOBA ATM Card Bank of Baroda Bank of Baroda ATM Card
BMBA ATM Card Bharatiya Mahila Bank Bharatiya Mahila Bank ATM Card
BOMA ATM Card Bank of Maharashtra Bank of Maharashtra ATM Card
CANA ATM Card Canara Bank Canara Bank ATM Card
INDA ATM Card IndusInd Bank IndusInd Bank ATM Card
IDFA ATM Card IDFC IDFC ATM Card
IOBA ATM Card Indian Overseas Bank Indian Overseas Bank ATM Card
KGBA ATM Card Kerala Gramin Bank Kerala Gramin Bank ATM Card
LVBA ATM Card Laxmi Vilas Bank Laxmi Vilas Bank ATM Card
PKGA ATM Card Pragathi Krishna Gramin Bank Pragathi Krishna Gramin BankATM Card
RSCA ATM Card Rajasthan State Coop Bank Rajasthan State Coop Bank ATM Card

62
SMCA ATM Card Shivalik Mercantile Co-Op Bank Shivalik Mercantile Co-Op Bank Limited
Limited ATM Card
UBIA ATM Card Union Bank of India Union Bank of India ATM Card
ITZH Cash Card ITZ Cash Card ITZ Cash card
ICSH Cash Card Icash Card Icash card
DONH Cash Card DONE Cash Card DONE Cash Card
PWMH Cash Card PayWorld Cash Card PayWorld Cash Card
PTMW Wallet Paytm Paytm wallet
MBKW Wallet Mobikwik Mobikwik Wallet
OXIW Wallet Oxigen Oxigen Wallet
MRPW Wallet mRupee mRupee Wallet
JIOW Wallet Reliance JioMoney Reliance Jio Money wallet
TMWW Wallet The Mobile Wallet The Mobile Wallet
PYCW Wallet Paycash Paycash wallet
OLAW Wallet Ola Money Ola Money Wallet
JNCW Wallet Jana Cash Jana Cash
ATLW Wallet Airtel Money Airtel Money
PNBW Wallet PNB Wallet PNB Wallet
FRCW Wallet FreeCharge FreeCharge Wallet
EZCW Wallet ezeClick ezeClick Wallet
VDFW Wallet mPesa Wallet mPesa - Vodafone Wallet
SBIW Wallet SBI Buddy SBI Buddy
AMPW Wallet Amazon Pay Amazon Pay
PZAW Wallet Payzapp Payzapp wallet
IDMW Wallet Idea Money Idea Money
CITW Wallet Citibank Reward Points Citibank Reward Points
YPAW Wallet YpayCash YpayCash
ZIPW Wallet ZipCash ZipCash
YESW Wallet Yes Pay Yes Pay
BKSW Wallet bKash Wallet bKash Wallet
DCBW Wallet DCB Cippy DCB Cippy
PHPW Wallet PhonePe PhonePe wallet
AMRW Wallet Airtel Money Rwanda Airtel Money Rwanda
MTRW Wallet MTN Rwanda MTN Rwanda
VISP Prepaid Card Visa Visa Prepaid Card
MASP Prepaid Card Master Master Prepaid Card
RUPP Prepaid Card Rupay Rupay Prepaid Card
ZEMF Cardless EMI ZestMoney ZestMoney
INCF Cardless EMI Instacred Instacred
EASF Cardless EMI EarlySalary EarlySalary
BHQR Bharat QR Bharat QR Bharat QR Payments(Dynamic)

63
BSQR Bharat Bharat QR(Static) Bharat QR Payments(Static)
QR(Static)
ECLV E-Collect E-Collect E-Collect(Virtual Accounts)
UPIU UPI Unified Payments Interface Unified Payments Interface
LYWA WhatsApp Lyra WhatsApp Lyra WhatsApp
EZP1 EazyPay EazyPay EazyPay
PYM1 Pharmarack Pharmarack Pharmarack Credit Card
Credit Card

64
17 APPENDIX 4 - List of error codes

Error Error Code Error Description

Numeric
Code
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
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- Maximum credit amount limit set for the terminal for a day
LIMIT has been crossed
1020 MAXIMUM-DEBIT-AMOUNT- Maximum debit amount set for per card for rolling 24 hrs
CROSS has been crossed
1021 MAXIMUM-CREDIT-AMOUNT- Maximum credit amount set for per card for rolling 24 hrs
CROSS has been crossed
1022 MAXIMUM-TRANSACTION- Maximum transaction set for per card for rolling 24 hrs has
CROSS 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

65
1031 AUTO-REFUNDED Transaction auto refunded
1032 REFUNDED Transaction refunded
1033 SINGLE-TRANSACTION-LOWER- The amount provided is less than transaction lower limit
LIMIT-CROSS
1034 SINGLE-TRANSACTION-UPPER- The amount provided is more than transaction upper limit
LIMIT-CROSS
1035 TRANSACTION-DAILY-LIMIT- The daily transaction limit is exceeded for the merchant
CROSS
1036 TRANSACTION-MONTHLY-LIMIT- The monthly transaction limit is exceeded for the merchant
CROSS
1037 DAILY-TRANSACTION-NUMBER- The daily transaction number is exceeded for the merchant
CROSS
1038 MONTHLY-TRANSACTION- The monthly transaction number is exceeded for the
NUMBER-CROSS 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- Transaction already captured
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- Transaction amount limit has exceeded
LIMIT
1060 ACQUIRER-MIN-TRANSACTION- The amount provide is less than minimum transaction
LIMIT 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

66
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 declined 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 INVALID-ACCOUNT The customers account is invalid
1094 TRANSACTION-COUNT- Transaction count limit has exceeded for the customer
EXCEEDED
1095 AMOUNT-MISMATCH Transaction amount mismatched may be due to a
attempted tampering in response
9999 UNKNOWN-ERROR Unknown error occurred

67
18 APPENDIX 5 – Currency Codes

Currency Currency Code

INR Indian Rupee
USD US Dollar
EUR Euro
AED UAE Dirham
GBP Pound Sterling
MUR Mauritius Rupee
RWF Rwanda Franc
LKR Sri Lanka Rupee

68