QR 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.



Basic Payment

This reference list lists all the standard flow parameters to be send in request.

Parameter Description Format Required
paymentId Transaction ID of a new transaction. N10
[0-9]
Yes (PA)
No (DB)
amount Amount of the transaction. The dot needs to add to separate the decimal. N13
[0-9]{1,10}\.[0-9]{2}
Yes (PA)
No (DB)
currency Currency of the transaction. A3
[a-zA-Z]{3}
Yes (PA)
No (DB)
paymentBrand Type of Card while placing the transaction.
For ex: QR
AN32
[a-zA-Z0-9] {1,32}
Yes
paymentMode Payment method for paying amount.
For ex: EW for Wallet
AN32
[a-zA-Z0-9] {1,32}
Yes
paymentType The payment type for the request. You can send a transaction requests with one of the following types:
  • PA: Dynamic
  • DB: Static
A2
((PA|DB))
Yes
merchantTransactionId This reference number is provided by the merchant, should be unique for the transactions and is visible on the end customer’s statement. [.\\p[0-9a-zA-Z\\p{Space}\\-]{0,1024} Yes


Inquiry Status

Below parameter is necessary for Inquiry Status API call .

Parameter Description Format Required
paymentType Payment type of the transaction.
  • IN: Inquiry
A2
((IN))
Yes


Confirm

Below parameter is necessary for confirm API call .

Parameter Description Format Required
status Status of the transaction.
Status has to be success / fail / cancel .
[.\\p[0-9a-zA-Z\\p{Space}\\-]{0,1024} Yes
walletAmount Amount of the transaction . N
[0-9]{1,10}\.[0-9]{10}
Optional
walletCurrency Currency of the wallet. A3
[a-zA-Z]{3}
Optional


Authentication

Authentication data is required in all requests. You can find a set of valid credentials in the tutorials. But if you want to set up another credential for your terminal please contact us.

Parameter Description Format Required
authentication.memberId Merchant’s unique ID assigned by to authenticate a transaction request. N10
[0-9]
Yes (DB)
No (PA)
authentication.partnerId Partner’s unique ID assigned by to authenticate a transaction request. N10
[0-9]
No


Customer

All the information about the customer like his name, contact details and identification documents are hold by the customer object.

Parameter Description Format Required
customer.givenName First name of the customer. AN
[a-zA-Z0-9\\p{Space}\\,.:'"-=+)({}[]]+
Yes
customer.surname Last name or surname of the customer. AN
[a-zA-Z0-9\\p{Space}\\,.:'"-=+)({}[]]+
Yes
customer.email Email address of the customer. AN50
[A-Za-z0-9._%'-]+@[A-Za-z0-9.-]+\\.[a-zA-Z]{2,4}
Yes
customer.walletId Customer’s wallet ID. AN255
[a-zA-Z0-9\\p{Space}\\,]+[a-zA-Z0-9\\p{Space}\\,]+
Yes
customer.walletCurrency Currency of the wallet. A3
[a-zA-Z]{3}
Yes
customer.walletAmount Amount of the transaction . N
[0-9]{1,10}\.[0-9]{10}
Yes


Response Parameters

Parameter Description Format Required
paymentId Unique transactionId sent by . N10
[0-9]
Optional
status Status of the transaction. You can refer status descriptions for more detailed information. AN255
[a-zA-Z0-9]
Optional
result.code The unique response code for successful or failed transaction. 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
merchantWalletId Wallet ID of the merchant AN255
[a-zA-Z0-9\\p{Space}\\,]+[a-zA-Z0-9\\p{Space}\\,]+
Optional
paymentBrand Type of Card while placing the transaction.
For ex: VISA, MASTER
A50
[A-Za-z]
Conditional
paymentMode Payment method for paying amount.
For ex: CC for Credit Cards
A50
[A-Za-z]
Conditional
amount Amount of the transaction. N13
[0-9]{1,10}\.[0-9]{2}
Conditional
currency Currency of the transaction. A3
[a-zA-Z\\p{Space}\\,]+
Conditional
descriptor Display name of the merchant. AN127
[a-zA-Z0-9\\p{Space}\\,]+[a-zA-Z0-9\\p{Space}\\,]+
Conditional
transactionStatus Status of the transaction processed. Possible values are,
‘Y’ – Successfully processed
‘N’ – Failed
‘P’ – Pending
‘3D’ – Pending for 3D authentication
‘C’ – Cancelled
AN2
[Y|N|P|3D|C]
Conditional
merchantTransactionId Unique ID sent at the time of transaction. AN1024
[.\\p[0-9a-zA-Z\\p{Space}\\-]{0,1024}
Conditional
timestamp Shows at what time the transaction has been placed. date
yyyy-MM-dd hh:mm:ss
Yes
customer.email Email address of the customer. AN50
[A-Za-z0-9._%'-]+@[A-Za-z0-9.-]+\\.[a-zA-Z]{2,4}
Optional
customer.id Customer ID in merchant’s system. AN20
[A-Za-z0-9]
Optional
eci eci is the two or three digit code that is returned by the credit card processing networks and issuing banks.For VISA eci code is (05,06,07)and for MasterCard eci code is(01,02). N3
[0-9]
Optional
firstName First name of the cardholder. AN20
[A-Za-z0-9]
Optional
lastName Last name of the cardholder. AN20
[A-Za-z0-9]
Optional
tmpl_amount Customized amount of customer, template amount can be same as transaction amount. N13
[0-9]{1,9}\.[0-9]{2}
No
tmpl_currency Currency of the customized amount to facilitate customer, template currency can be same as transaction currency, Accept only 3 character currency code in capital letters. A3
[a-zA-Z]{3}
No
companyName Name of the company provided. AN255
[a-zA-Z0-9\\p{Space}\\,]+[a-zA-Z0-9\\p{Space}\\,]+
Optional
merchantContact Contact person name provided by the merchant . AN255
[a-zA-Z0-9\\p{Space}\\,]+[a-zA-Z0-9\\p{Space}\\,]+
Optional
Copyright © . All Rights Reserved