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.
Customer registration
This reference list lists all the resistration parameters to be send in request.
| Parameter | Description | Format | Required |
|---|---|---|---|
| cust_request_id | Unique Customer ID in merchant’s system. | N10
[0-9]{1,10}\.[0-9]{2} |
Yes |
| partnerId | Merchant’s Partner Id | N10
[0-9]{1,10}\.[0-9]{2} |
Yes |
| firstName | Customer's first Name | A50 [a-zA-Z]{50} |
Yes |
| lastName | Customer’s last name. | A50 [a-zA-Z]{50} |
Yes |
| emailId | Customer’s Email id. |
AN255 [A-Za-z0-9._%'-]+@[A-Za-z0-9.-]+\\.[a-zA-Z]{2,4} |
No |
| countryCode | Customers country code. | ISO 3166-1 Alpha-2 | No |
| Phone | Customers contact number. | N10 [0-9]{10} |
No |
| customerRegDate | Customer's Date of registration. | Date
(yyyy-mm-dd) |
Yes |
| customerIpAddress | Customers Ip address. |
AN255 (?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?) |
Yes |
| id_type | Type of document customer will provide for document
verification.
|
[0-9]{2} | No |
| id_value | Id value is an open text value that represents the ID Type selected. | A255 [0-9]{255} |
No |
| Zip | Postal code | N10
[0-9]{10} |
No |
| dob | Date of Birth of customer | Date (yyyy-mm-dd) |
No |
| Address1 | customer address | AN255 | No |
| Address2 | customer address | AN255 | No |
| city | customer city | AN255 | No |
| state | customer state | AN255 | No |
| province | customer province | AN255 | 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.partnerId | Merchant’s unique ID assigned by to authenticate a Registration request. | N10
[0-9] |
Yes |
Document verification
All the information about the customer like his name, contact details and identification documents are hold by the customer object.
| Parameter | Description | Format | Required |
|---|---|---|---|
| customerRegId | customer registration id for which document will verified. | AN 0-9 |
Yes |
| method | Document verification method.
|
AN
[0-9] |
Yes |
| file | Document file. | (gif, jpg, png, doc, bmp, docx and pdf) | Yes |
| file2 | Document file. | (gif, jpg, png, doc, bmp, docx and pdf) | Conditional |
| file3 | Document file. | (gif, jpg, png, doc, bmp, docx and pdf) | Conditional |
| file4 | Document file. | (gif, jpg, png, doc, bmp, docx and pdf) | Conditional |
| authentication.partnerId | Merchant’s unique ID assigned by to authenticate a Verification request. | N10
[0-9] |
Yes |
| partnerId | Merchant’s unique ID assigned by to authenticate a Verification request. | N10
[0-9] |
Yes |
| notificationUrl | A merchant callback URL to get callback response. | String (50) | Yes |
New Transaction
All the information about the customer required for New transaction .
| Parameter | Description | Format | Required |
|---|---|---|---|
| memberid | Merchant’s Member Id | N20
[0-9]{1,20} |
Yes |
| trackingid | Merchant’s Transaction Id. | N10
[0-9]{1,10} |
Conditional |
| description | Description at merchant site. | AN255
[a-zA-Z0-9\\p{Space}\\,]+[a-zA-Z0-9\\p{Space}\\,]+ |
Conditional |
| firstName | Customer's First Name. | A50
[a-zA-Z]{50} |
Conditional |
| lastName | Customer’s Last Name. | A50
[a-zA-Z]{50} |
Conditional |
| emailId | Customer’s Email id. | AN255
[A-Za-z0-9._%'-]+@[A-Za-z0-9.-]+\\.[a-zA-Z]{2,4} |
Conditional |
| address1/ street | Customer Address . | AN255 | Yes |
| city | Customer City. | AN30
[0-9] |
Yes |
| state | Customer State. | AN20
[0-9] |
Conditional |
| countryCode | Customers country code. | ISO 3166-1 Alpha-2 | Conditional |
| zip | Postal code | N10
[0-9]{10} |
Yes |
| phone | Customers Contact Number. | N10
[0-9]{10} |
Conditional |
| customerIpAddress | Customers Ip address. | N50
(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?) |
Yes |
| firstsix | First 6 digits of the card number. Only required if Payment Method Type is Credit Card. | N6
[0-9]{6} |
Yes |
| payment_method_last_digits | Last 4 digits of the card number. Only required if Payment Method Type is Credit Card. | N4
[0-9]{4} |
Yes |
| deposit_limits_dl_min | Minimum deposit limit. | N10
[0-9]{10} |
Yes |
| deposit_limits_dl_daily | Daily deposit limit. | N10
[0-9]{10} |
Yes |
| deposit_limits_dl_weekly | Weekly deposit limit. | N10
[0-9]{10} |
Yes |
| deposit_limits_dl_monthly | Monthly deposit limit. | N10
[0-9]{10} |
Yes |
| paymenttype | The payment type for the request. | A2
[A-Za-z] |
Yes |
| authentication.partnerId | Merchant’s unique ID assigned by to authenticate a Registration request. | N10
[0-9] |
Yes |
| website | Merchant’s name of the webiste. | AN2048
([htpfs]{3,5}\\:?\\/\\/[\\w\\.\\:\\/]*\\??[a-zA-Z0-9]*) |
Conditional |
| user_name | Username of the Merchant. | AN50
[a-zA-Z0-9] |
Conditional |
| user_number | User number. | AN50
[A-Za-z0-9._%'-]+@[A-Za-z0-9.-]+\\.[a-zA-Z]{2,4} |
Conditional |
| currency | Currency of he transaction. | A3
[a-zA-Z]{3} |
Conditional |
| amount | Amount of the transaction. The dot needs to add to separate the decimal. | N13
[0-9]{1,10}\.[0-9]{2} |
Conditional |
| time | Shows at what time the transaction has been placed. | date
yyyy-MM-dd hh:mm:ss |
Yes |
Response Parameters
| Parameter | Description | Format | Required |
|---|---|---|---|
| customerRegId (/Customer SignUp) | It is necessary to identify the Sign up request later. The value appears in the ID field of a Registration's response. Later you can use this value as Registration ID or for sending reference tracking requests. | N10
[0-9] |
Yes |
| recommendation | Recommendation from For approval or rejection. | AN32
[A-Za-z]* |
Yes |
| description | Result of the Sign up process. | AN32
[A-Za-z]* |
Yes |
| score | Final score based on the verification process. | N13
[0-9]{1,10}\.[0-9]{2} |
Yes |
| cust_request_id | Customer id comes from the request. | N10
[0-9] |
Yes |
| reference_id | It is necessary to verify the score later. | N10
[0-9] |
Yes |
| responseCode | The unique response code that indicates the response status of the request | AN11
[0-9\.]{2,11} |
Yes |
| status | Result of the Verifiocation process. | AN32
[A-Za-z]* |
Yes |
| result.code | The unique response code that indicates the response status of the request. | 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}\\,]+ |
No |
| timestamp | Shows at what time the transaction has been placed. | date
yyyy-MM-dd hh:mm:ss |
Yes |
| fraud_result | Response description with rules triggered. | JSON | Yes |