REST API Specifications


Introduction

We created a complete and detailed description of the Platform API. Here you can find all parameter descriptions.


Hosts

  • Test:
  • Live:

Security / Authentication

All requests must be sent over SSL (Secure Socket Layer).

You need to generate an Authentication token to authenticate your request. Authentication parameters needs to be send in the header with each request. To generate authentication token please refer Auth token API.


Member ID and checksum can also be required in some cases. Please refer specific APIs for more details.


Authentication parameters need to be pass as POST parameters. You can find more details about these parameters in Authentication parameters.


Generate OTP

Parameter Description Format Required
authentication.partnerId Partner's unique ID assigned by to authenticate a transaction request N10
[0-9]
Yes
authentication.checksum Cryptographic hash generated by MD5 as follows.
All the processes has different combination of
parameters to generate hash (all values
separated by pipe). Kindly refer sample
given in tutorial for each case.
AN255
[a-zA-Z0-9]
Yes
merchant.country Country of the merchant. AN3
[a-zA-Z0-9]{2,3}
Yes
merchant.phone Phone number of the merchant. AN25
[a-zA-Z0-9\+-.]{6,25}
Yes
merchant.email Email address of the merchant. AN50
[A-Za-z0-9._%'-]+@[A-Za-z0-9.-]+\\.[a-zA-Z]{2,4}
Yes


Verify OTP

Parameter Description Format Required
authentication.partnerId Partner's unique ID assigned by to authenticate a transaction request N10
[0-9]
Yes
authentication.checksum Cryptographic hash generated by MD5 as follows.
All the processes has different combination of
parameters to generate hash (all values
separated by pipe). Kindly refer sample
given in tutorial for each case.
AN255
[a-zA-Z0-9]
Yes
merchant.country Country of the merchant. AN3
[a-zA-Z0-9]{2,3}
Yes
merchant.phone Phone number of the merchant. AN25
[a-zA-Z0-9\+-.]{6,25}
Yes
merchant.email Email address of the merchant. AN50
[A-Za-z0-9._%'-]+@[A-Za-z0-9.-]+\\.[a-zA-Z]{2,4}
Yes
merchant.otp OTP number of the merchant. N6
[0-9]{6}
Yes


Merchant Sign-up

Parameter Description Format Required
authentication.partnerId Partner's unique ID assigned by to authenticate a transaction request N10
[0-9]
Yes
authentication.checksum Cryptographic hash generated by MD5 as follows.
All the processes has different combination of
parameters to generate hash (all values
separated by pipe). Kindly refer sample
given in tutorial for each case.
AN255
[a-zA-Z0-9]
Yes
merchant.username Merchant’s username credential. AN50
[a-zA-Z0-9][,./?><”:’;}{][+_)(*&^%$#@!=-|\]{space}
Yes
merchant.password Merchant’s password credential. AN50
[a-zA-Z0-9][,./?><”:’;}{][+_)(*&^%$#@!=-|\]{space}
Yes
merchant.conPassword Confirm Merchant’s password. AN50
[a-zA-Z0-9][,./?><”:’;}{][+_)(*&^%$#@!=-|\]{space}
Yes
merchant.email Email address of the merchant. AN50
[A-Za-z0-9._%'-]+@[A-Za-z0-9.-]+\\.[a-zA-Z]{2,4}
Yes
merchant.contactName Contact name of the merchant . AN
[a-zA-Z0-9\\p{Space}\\,.:'"-=+)({}[]]+
Yes
merchant.country Country of the merchant. AN3
[a-zA-Z0-9]{2,3}
Yes
merchant.telnocc Country code of the merchant. N3
[0-9+]
Yes
merchant.phone Phone number of the merchant. AN25
[a-zA-Z0-9\+-.]{6,25}
Yes
merchant.isMobileVerified Used to indicate mobile number is verified or not . Default value is N . A1
(Y|N)
Yes


Merchant Login

Parameter Description Format Required
authentication.partnerId Partner's unique ID assigned by to authenticate a transaction request N10
[0-9]
Yes
merchant.username Merchant’s username credential. AN50
[a-zA-Z0-9][,./?><”:’;}{][+_)(*&^%$#@!=-|\]{space}
Yes
merchant.password Merchant’s password credential. AN50
[a-zA-Z0-9][,./?><”:’;}{][+_)(*&^%$#@!=-|\]{space}
Yes


Change Password

Parameter Description Format Required
authentication.memberId Merchant’s unique ID assigned by to authenticate a transaction request. N10
[0-9]
Yes
merchant.username Merchant’s username credential. AN50
[a-zA-Z0-9][,./?><”:’;}{][+_)(*&^%$#@!=-|\]{space}
Yes
merchant.password Merchant’s password credential. AN50
[a-zA-Z0-9][,./?><”:’;}{][+_)(*&^%$#@!=-|\]{space}
Yes
merchant.conPassword Confirm Merchant’s password. AN50
[a-zA-Z0-9][,./?><”:’;}{][+_)(*&^%$#@!=-|\]{space}
Yes


Forgot Password

Parameter Description Format Required
merchant.username Merchant’s username credential. AN50
[a-zA-Z0-9][,./?><”:’;}{][+_)(*&^%$#@!=-|\]{space}
Yes


Response Parameters

Parameter Description Format Required
result.code The unique response code that indicates the response status of the request. See the Response codes for more detailed information. AN11
[0-9\.]{2,11}
Yes
result.description Response description of the response code. AN255
[a-zA-Z0-9\\p{Space}\\,]+[a-zA-Z0-9\\p{Space}\\,]+
Yes
timestamp Shows at what time the transaction has been placed. date
yyyy-MM-dd hh:mm:ss
Yes
country Country of the merchant. AN3
[a-zA-Z0-9]{2,3}
Conditional
mobilenumber Mobile number of the merchant. N15
[0-9+]
Conditional
partnerId Partner's unique ID provided by . N10
[0-9]
Conditional
memberId Merchant's unique ID provided by . N10
[0-9]
Conditional
secureKey Merchant’s secure key which is used to authenticate the transaction. AN32
[A-Za-z0-9]
Conditional
email Email address of the merchant. AN50
[A-Za-z0-9._%'-]+@[A-Za-z0-9.-]+\\.[a-zA-Z]{2,4}
Conditional
telno Phone number of the merchant. AN15
[a-zA-Z0-9\+-.]{25}
Conditional
contactPerson Contact name of the merchant . AN
[a-zA-Z0-9\\p{Space}\\,.:'"-=+)({}[]]+
Conditional
LoginName Merchant’s login credential. AN50
[a-zA-Z0-9][,./?><”:’;}{][+_)(*&^%$#@!=-|\]{space}
Conditional
AuthToken Token generated after login. AN
[a-zA-Z0-9][,./?><”:’;}{][+_)(*&^%$#@!=-|\]{space}
Conditional
isemailverified Used to indicate email is verified or not . A1
(Y|N)
Yes
isMobileVerified Used to indicate mobile number is verified or not . A1
(Y|N)
Yes
isActive Used to indicate merchant is active or not . A1
(Y|N)
Yes
Copyright © . All Rights Reserved