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.
Authentication parameters need to be pass as POST parameters. You can find more details
about these parameters in Authentication parameters.
Auth Token Request
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 |
|---|---|---|---|
| partner.username | The username used to login the Partner's Interface of
.
This parameter is required for NON - REDEEM transactions. |
AN255
[a-zA-Z0-9] |
Conditional |
| merchant.username | The username used to login the Merchant's Interface of
.
This parameter is required for REDEEM transactions only. |
AN255
[A-Za-z0-9._%'-]+@[A-Za-z0-9.-]+\\.[a-zA-Z]{2,4} |
Conditional |
| authentication.sKey | Partner’s / Merchant's API key.
Merchant API key will be used in case of REDEEM transactions only. Use the merchant's API key provided in the Merchant Interface of . |
AN255
[A-Za-z0-9] |
Yes |
| authentication.partnerId | Partner’s unique ID assigned by to authenticate a transaction request. | N10
[0-9] |
Yes |
Auth Token Response
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 |
|---|---|---|---|
| partnerId | Partner’s unique ID assigned by to authenticate a transaction request. | N10
[0-9] |
Optional |
| status | Status of the transaction request. | AN255
[a-zA-Z0-9] |
Yes |
| result.code | The unique response code for successful or failed transaction. | N11
[0-9] |
Yes |
| result.description | Response description of the response code. | AN255 | Yes |
| timestamp | Shows at what time the transaction has been placed. | date
yyyy-MM-dd hh:mm:ss |
Yes |
| LoginName | Shows the login credential. | AN255
[a-zA-Z0-9] |
Optional |
| AuthToken | Returns the new auth token. | String | Yes |
Regenerate Auth Token Request
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.partnerId | Partner’s unique ID assigned by to authenticate a transaction request. | N10
[0-9] |
Yes |
| authToken | Old auth token used in the request. | String | Yes |
Regenerate Auth Token Response
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 |
|---|---|---|---|
| status | Status of the transaction request. | AN255
[a-zA-Z0-9] |
Yes |
| result.code | The unique response code for successful or failed transaction. | N11
[0-9] |
Yes |
| result.description | Response description of the response code. | AN255 | Yes |
| timestamp | Shows at what time the transaction has been placed. | date
yyyy-MM-dd hh:mm:ss |
Yes |
| LoginName | Shows the login credential. | AN255
[a-zA-Z0-9] |
Yes |
| AuthToken | Returns the new auth token. | String | Yes |
Purchase Request
| Parameter | Description | Format | Required |
|---|---|---|---|
| customer.customerId | Customer Id assigned by to authenticate a transaction request. | N10
[0-9] |
Yes |
| voucher | Number of vouchers selected with their quantity.
Eg: [{ "amount":"200.00","quantity":2 }] |
Array | Yes |
| totalAmount | Amount for the specific transaction.
For example:"100.00" |
N12
[0-9]{1,10}\.[0-9]{2} |
Yes |
| currency | Currency of the transaction.
For example: "EUR" |
A3
[a-zA-Z]{3} |
Yes |
| authentication.partnerId | Partner’s unique ID assigned by . | 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 |
| redirectUrl | Redirection URL where the customer needs to be redirected after the
transaction is completed
For example: "https://www.abc.com" |
AN2048 | Yes |
Purchase Response Parameters
| Parameter | Description | Format | Required |
|---|---|---|---|
| customerId | Customer ID sent by . | N10
[0-9] |
Yes |
| partnerId | Partner’s unique ID assigned by . | N10
[0-9] |
Yes |
| redirect.url | URL on which the the parameters need to be sent.
For example: "https://www.abc.com" |
AN2048 | Yes |
| redirect.parameters | Parameter array consists of Name-Value pair json which needs to
sent over the redirect URL.
In url encoded format |
Array | Yes |
| status | Status of the transaction. | AN255
[a-zA-Z0-9] |
Yes |
| timestamp | Shows at what time the transaction has been placed. | date
yyyy-MM-dd hh:mm:ss |
Yes |
Redeem Request
| Parameter | Description | Format | Required |
|---|---|---|---|
| order.amount | Voucher amount you want to redeem.
For example:"100.00" |
N12
[0-9]{1,10}\.[0-9]{2} |
Yes |
| order.currency | Currency in which the you want to redeem the voucher.
For example: "EUR" |
A3
[a-zA-Z]{3} |
Yes |
| order.merchantTransactionId | Unique order ID of the transaction. | AN255 | Yes |
| voucherNumber | A 20 digit voucher number. Multiple vouchers can also be redeemed. For exmaple : voucherNumber: ["12345000012345678901","12345000012345678902"] |
Array | 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 |
| authentication.memberId | Members’s unique ID assigned by . | N10
[0-9] |
Yes |
| authentication.transactionPassword | The transaction password set in the Customer Interface which will be used while redeeming the voucher. | AN50
[A-Za-z0-9!@#$%^&*()] |
Conditional |
| merchant.customerId | Members’s unique customer ID assigned. | AN255
[a-zA-Z0-9] |
Yes |
| customer.email | Customer's email used for login . | AN255
[A-Za-z0-9._%'-]+@[A-Za-z0-9.-]+\\.[a-zA-Z]{2,4} |
Conditional |
| customer.password | Customer's password credentials used for login . | AN50
[A-Za-z0-9!@#$%^&*()] |
Conditional |
Redeem Response Parameters
| Parameter | Description | Format | Required |
|---|---|---|---|
| customerId | Customer ID sent by . | N10
[0-9] |
Yes |
| status | Status of the transaction. | AN255
[a-zA-Z0-9] |
Yes |
| trackingId | Unique ID of the transaction. | N11
[0-9] |
Yes |
| result.code | The unique response code for successful or failed transaction. | N11
[0-9] |
Yes |
| result.description | Response description of the response code. | AN255 | Yes |
| timestamp | Shows at what time the transaction has been placed. | date
yyyy-MM-dd hh:mm:ss |
Yes |
| merchantTransactionId | Merchant's Order ID sent in the request . | AN255 | Yes |
| voucherDetails.redeemVoucher.voucherNumber | Redeemed voucher number. | N20 | Yes |
| voucherDetails.redeemVoucher.amount | Redeemed voucher amount. | N12
[0-9]{1,10}\.[0-9]{2} |
Yes |
| voucherDetails.newVoucher.voucherNumber | New voucher number genreated from Partial Redeem. | N20 | Optional |
| voucherDetails.newVoucher.amount | New voucher amount. | N12
[0-9]{1,10}\.[0-9]{2} |
Optional |
| order.amount | Order amount of the transaction.
For example:"100.00" |
N12
[0-9]{1,10}\.[0-9]{2} |
Yes |
| order.currency | Order currency of the transaction.
For example: "EUR" |
A3
[a-zA-Z]{3} |
Yes |
| order.voucherAmount | Amount of the Voucher used for placing the transaction.
For example:"100.00" |
N12
[0-9]{1,10}\.[0-9]{2} |
Yes |
| order.voucherCurrency | Currency of the Voucher used for placing the transaction.
For example: "EUR" |
A3
[a-zA-Z]{3} |
Yes |
| order.redeemAmount | Amount redeemed from the Voucher.
For example:"100.00" |
N12
[0-9]{1,10}\.[0-9]{2} |
Optional |
| order.redeemCurrency | Currency same as Voucher currency.
For example: "EUR" |
A3
[a-zA-Z]{3} |
Optional |
| order.merchantAmount | Converted order amount.
For example:"100.00" |
N12
[0-9]{1,10}\.[0-9]{2} |
Yes |
| order.merchantCurrency | Currency same as Order currency.
For example: "EUR" |
A3
[a-zA-Z]{3} |
Yes |