Sign Up 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).
The memberId, partnerId and checksum is required to authenticate every request and the POST method is used to send the authentication data. You can find more details about that in the Authentication Parameters.
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 sign up request. | N10
[0-9] |
Yes |
| authentication.partnerId | Partner's unique ID assigned by to authenticate a sign up request. | 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 |
Merchant
All the information about the merchant like his name, contact details and identification documents are hold by the merchant object.
| Parameter | Description | Format | Required |
|---|---|---|---|
| merchant.username | Login name of a Merchant. | AN [a-zA-Z0-9\\p{Space}\\,]+ |
Yes |
| merchant.newPassword | Password of a Merchant | AN [a-zA-Z0-9\\p{Space}\\,]+ |
Yes |
| merchant.conPassword | Confirmation password of a Merchant. | AN [a-zA-Z0-9\\p{Space}\\,]+ |
Yes |
| merchant.companyName | Company name of a Merchant. | AN [a-zA-Z0-9\\p{Space}\\,]+ |
Yes |
| merchant.website | Website of a Merchant. | AN [a-zA-Z0-9\\p{Space}\\,]+ |
No |
| merchant.contactName | Contact person name of a Merchant. | AN [a-zA-Z0-9\\p{Space}\\,]+ |
Yes |
| merchant.givenName | First name of a customer | AN [a-zA-Z0-9\\p{Space}\\,]+ |
No |
| merchant.surname | Last name or surname of a Merchant | AN
[a-zA-Z0-9\\p{Space}\\,]+ |
No |
| merchant.birthDate | Birth date of a Merchant in the format YYYYMMDD | AN10
{19|20)([0-9]{2})(0[1-9]|1[0-2])(0[1-9]|1[0-9]|2[0-9]|3[0-1]} |
No |
| merchant.sex | Gender of a Merchant. | A [FEMALE | MALE | Female | Male | female | male] |
No |
| merchant.phone | Phone number of a Merchant. | N [0-9-] |
Conditional |
| merchant.mobilecountrycode | Mobile number country code of a merchant. | N [+0-9]{2} |
Conditional |
| merchant.email | Email address of the Merchant | AN [A-Za-z0-9._%'-]+@[A-Za-z0-9.-]+\\.[a-zA-Z]{2,4} |
Yes |
| merchant.postcode | Zip code of the Merchant. | AN [A-Za-z0-9._%'-]+@[A-Za-z0-9.-]+\\.[a-zA-Z]{2,4} |
No |
| merchant.country | Country of Merchant. | AN [A-Za-z0-9._%'-]+@[A-Za-z0-9.-]+\\.[a-zA-Z]{2,4} |
No |
| merchant.otp | OTP required for merchant signup. | AN [0-9]{6} |
Conditional |
Response Parameters
| Parameter | Description | Format | Required |
|---|---|---|---|
| partnerId | Partner ID of the request. | AN32
[A-Za-z]* |
Conditional |
| memberId | Member ID of the request. | AN32
[A-Za-z]* |
Conditional |
| customerId | Generated customer ID. | N13
[0-9]{1,10}\.[0-9]{2} |
Yes |
| otp | Generated OTP while merchant signup. | N6
[0-9] |
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 |
| timestamp | Shows at what time the transaction has been placed | date
yyyy-MM-dd hh:mm:ss |
Yes |