QR Checkout 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 |
|---|---|---|---|
| paymentMode | Payment method for paying amount. For ex: EW for Wallet |
AN32
[a-zA-Z0-9] {1,32} |
Yes |
| paymentBrand | Type of Card while placing the transaction. For ex: QR |
AN32
[a-zA-Z0-9] {1,32} |
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 |
| orderDescriptor | This is order description provided by the merchant . | AN255
[\p{L}\P{M}\p{M}\n\ra-zA-Z0-9:\\!@#$%^&{}\[\]()_+\-=,*.~'` ] |
No |
| notificationUrl | URL to which the transaction details are posted once our server notified. If left blank, no transaction details are sent | AN100
[a-zA-Z0-9.:/] |
Yes |
| amount | Amount of the transaction. The dot needs to add to separate the decimal. | N13
[0-9]{1,10}\.[0-9]{2} |
Yes |
| currency | Currency of the transaction. | A3
[a-zA-Z]{3} |
Yes |
| tmpl_amount | Customized amount of customer, template amount can be same as transaction amount, Accept only [0-9] and ‘.’ (Single point) | N11
[0-9]{1,8}\.[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. | AN3
[a-zA-Z0-9]{3} |
No |
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 |
| authentication.terminalId | Merchant’s terminal ID provided by | N6 [0-9]{1,4} |
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.email | Email address of the customer. |
AN50 [A-Za-z0-9._%'-]+@[A-Za-z0-9.-]+\\.[a-zA-Z]{2,4} |
No |
| customer.customerId | Customer ID in merchant's system. | AN100
[a-zA-Z0-9]{1,20} |
No |
Response Parameters
| Parameter | Description | Format | Required |
|---|---|---|---|
| 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 |
| paymentId | Unique transactionId sent by . | N10
[0-9] |
Yes |
| status | 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] |
Yes |
| paymentBrand | Type of Card being used by Customer for the payment | AN10
[a-zA-Z0-9] {1,10} |
Yes |
| paymentMode | Payment method for paying amount. For ex: CC for Credit Cards |
AN10
[a-zA-Z0-9] {1,10} |
Yes |
| amount | Amount of the transaction | N10
[0-9]{1,7}\.[0-9]{2} |
Yes |
| currency | Currency of the transaction | A3
[a-zA-Z\\p{Space}\\,]+ |
Yes |
| timestamp | Shows at what time the transaction has been placed. | date
yyyy-MM-dd hh:mm:ss |
Yes |
| merchantTransactionId | Unique id sent at the time of transaction. | AN100
[.\\p[0-9a-zA-Z\\p{Space}\\-]{0,100} |
Yes |
| tmpl_amount | Customized amount of customer, template amount can be same as transaction amount | N10
[0-9]{1,7}\.[0-9]{2} |
Yes |
| 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} |
Yes |
| orderDescription | Description of the order provided by the merchant . | AN255
[\p{L}\P{M}\p{M}\n\ra-zA-Z0-9:\\!@#$%^&{}\[\]()_+\-=,*.~'` ] |
Yes |