Pre-vet form API Specifications
Introduction
We created a complete and detailed description of the Platform Pre-vet form API. Here you can find all parameters with descriptions.
The Pre-vet includes the below profile details:
Hosts
- Test:
- Live:
Security / Authentication
All requests must be sent over SSL (Secure Socket Layer).
The memberId and checksum are in need to authenticate every request against a particular terminal.
And the POST parameters are used to send the authentication data.
Authentication Profile
This reference list provides all the parameters related to authentication.
| Parameter | Description | Format | Required |
|---|---|---|---|
| memberId | Merchant’s unique ID – assigned by | N10
[0-9] |
Yes |
| 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 |
| random | Any random generated number with ten digits | N10
[0-9] |
Yes |
| mode | It is used to indicate the mode of merchant application form.
|
A6
[CREATE|UPDATE] |
Yes |
Company Profile
This reference list provides all the parameters related to company profile.
| Parameter | Description | Format | Required |
|---|---|---|---|
| companyEmailAddress | Company's email address | AN255
[A-Za-z0-9._%'-]+@[A-Za-z0-9.-]+\\.[a-zA-Z]{2,4} |
Yes
|
| companyRegistrationNumber | Company’s registration number | AN15
[a-zA-Z0-9] |
Yes |
| companyTelephoneNO | Company's contact number | N15 [0-9] |
Yes |
| companyphonecc1 | Company's country code. It depends on Country name | N3 [0-9] |
Yes |
| contactName | General contact person's name | AN255 [a-zA-Z0-9]{space} |
No |
| corporateName | Corporate/Business name of company | AN255
[a-zA-Z0-9]{space} |
Yes |
| locationAddress | Company's address | AN255
[a-zA-Z0-9][`!@#$%^&*()_+=]{space} |
Yes |
| merchantCountry | Company's country name | AN255
[a-zA-Z0-9][`!@#$%^&*()_+=]{space} |
Yes |
| merchantName | Name of Company | AN255
[a-zA-Z0-9]{space} |
Yes |
| merchantZipCode | Company's zip code | A9
[a-zA-Z-s]{4,9} |
No |
| merchantCity | Company's city name | A255
[a-zA-Z]+$ |
No |
| vatIdentification | The VAT (Value Added Tax)Identification number of company | AN15
[a-zA-Z0-9] |
No |
Business Profile
Business Profile contains website and business details related to company
| Parameter | Description | Format | Required |
|---|---|---|---|
| Urls | Used to indicate, URL of Redirect Page where the Merchant to be redirected after processing | AN30
([a-zA-Z]{3,5}((\\.){1}|(\\W){1}\/\/)[a-zA-Z\\S]{0,4}[a-zA-Z\\S]*(\\.)[a-zA-Z]{2,5}(\\.?)[A-Za-z]{0,3}) |
Yes |
Bank Profile
This reference list provides all the parameters related to company profile.
| Parameter | Description | Format | Required |
|---|---|---|---|
| currency_products_INR | Products sold in INR currency | A1
(Y|N) |
No |
| currency_products_USD | Products sold in USD currency | A1
(Y|N) |
No |
| currency_products_EUR | Products sold in EUR currency | A1
(Y|N) |
No |
| currency_products_GBP | Products sold in GBP currency | A1
(Y|N) |
No |
| currency_products_JPY | Products sold in JPY currency | A1
(Y|N) |
No |
| currency_products_PEN | Products sold in PEN currency | A1
(Y|N) |
No |
| currency_products_HKD | Products sold in HKD currency | A1
(Y|N) |
No |
| currency_products_AUD | Products sold in AUD currency | A1
(Y|N) |
No |
| currency_products_CAD | Products sold in CAD currency | A1
(Y|N) |
No |
| currency_products_DKK | Products sold in DKK currency | A1
(Y|N) |
No |
| currency_products_SEK | Products sold in SEK currency | A1
(Y|N) |
No |
| currency_products_NOK | Products sold in NOK currency | A1
(Y|N) |
No |
Response Parameters
| Parameter | Description | Format | Required |
|---|---|---|---|
| applicationId | It is necessary to identify the Pre-vet request later. The value appears in the ID field of a Pre-vet application. | N10
[0-9] |
Yes |
| applicationSaved | applicationSaved indicates Pre-vet Form saved or not | A2
[Y/N] |
Yes |
| appliedToModify | It indicates that whether the merchant has permission to modify the Pre-vet or not | A2
[Y/N] |
Yes |
| maf_Status | Status of the Pre-vet application (Successfully submitted/Failed to submit) | AN32
[A-Za-z]* |
Yes |
| memberId | Merchant’s unique ID assigned by to authenticate a transaction request | N13
[0-9]{10} |
Yes |
| notificationMessage | It indicates the error message or validation message of the Pre-vet application | A50
[a-zA-Z\\p{Space}\\,]+ |
Conditional |
| status | Status of the MAF application and Pre-vet application | AN127
[a-zA-Z0-9\\p{Space}\\,]+[a-zA-Z0-9\\p{Space}\\,]+ |
Yes |
| user | It indicates the category of the user that is Merchant | AN10
[A-Za-z]{10} |
Yes |
| 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}\\,]+ |
No |