Login API
User can use this API to login in the wallet.
The POST request will be send over HTTPS to the
endpoint.
Sample Request
![](../assets/img/ajax-loader.gif)
Sample Response
![](../assets/img/ajax-loader.gif)
Request Parameters
This reference lists all the standard flow parameters to be send in request.
Parameter | Description | Format | Required |
---|---|---|---|
userName | Username of the user entered while registering. | AN255
[a-zA-Z0-9] |
Yes |
telnocc | Country code of the user. | N
[0-9] |
Yes |
cust_password | Password of the user. | AN255
[a-zA-Z0-9] |
Yes |
cust_device_id | Unique device ID for Android and iOS. Not incase of Web | N
[0-9] |
Optional |
platformId | App platform Id Android-1 and iOS-2. | N
[0-9]{1} |
Yes |
walletOwnerId | Provided by Unique id. | N20
[0-9] |
Yes |
token | Provided by Unique token. | String | Yes |
Response Parameters
This reference list lists all the standard flow parameters to be received in response.
Parameter | Description | Format | Required |
---|---|---|---|
customerId | Generated unique customer id on per user sign up. | N
[0-9] |
Yes |
cust_name | Name of the user. | AN255
[a-zA-Z0-9] |
Yes |
cust_contact | Contact number of the user. | N
[0-9] |
Yes |
country_code | Country code of the user. | N
[0-9] |
Yes |
cust_email | Email address of the user. | AN255
[a-zA-Z0-9.@_-] |
Yes |
cust_dob | Date of birth of the user. | N
[0-9-] |
Yes |
loginStatus | Response status (SUCCESS/FAILED). | A [A-Z] |
Yes |
cust_profile_pic | Base64 string of the uploaded profile picture. | String | Yes |
noOfRequest | Number of pending requests . | N
[0-9] |
Yes |
accountType | Type of account which can be Customer or Merchant. | A
[a-zA-Z] |
Yes |
cust_gender | Gender of the user . | A
[a-zA-Z] |
Yes |
cust_currency | Default currency of the user . | A
[a-zA-Z] |
Yes |
isDealsUsed | Used to enable marketplace, can be configured by the user. If
|
N
[0-9] |
Yes |
secKey | Secret key of the user. | AN255
[a-zA-Z0-9] |
Yes |
vendorAddress | Address detials of the user. | AN255
[a-zA-Z0-9] |
Yes |
vendorCountry | Country of the user. | A50
[a-zA-Z] |
Yes |
isDealsWant | Used to configure marketplace by wallet owner. If
|
N
[0-9] |
Yes |
kycAccountType | Current active account type of the user. | A50
[a-zA-Z] |
Yes |
allowCustomerToActivateCard | Allow user to activate prepaid cards. If
|
N
[0-9] |
Yes |
isPrepaidCardFeatureRequired | Allow Prepaid cards feature for the user.
If
|
N
[0-9] |
Yes |
isRadioAllowed | Allow Radio feature to user.
If
|
N
[0-9] |
Yes |
isBlockchainAllowed | Allow Crypto currency feature to user.
If
|
N
[0-9] |
Yes |
isRechargeAllowed | Allow Recharge feature to the user.
If
|
N
[0-9] |
Yes |
isMyCardAllowed | Show and Add Card to the user.
If
|
N
[0-9] |
Yes |
isLoadMoneyAllowed | Allow the user to add balance.
If
|
N
[0-9] |
Yes |
isWithdrawMoneyAllowed | Allow user to withdraw/payout.
If
|
N
[0-9] |
Yes |
isSendMoneyAllowed | Allow user to send money.
If
|
N
[0-9] |
Yes |
isRequestMoneyAllowed | Allow user to request money.
If
|
N
[0-9] |
Yes |
isActivityLogAllowed | Allow user to check activity logs.
If
|
N
[0-9] |
Yes |
isMyWalletAllowed | Allow user to check/add multiple wallets.
If
|
N
[0-9] |
Yes |
isLoyaltyPointsAllowed | Allow loyalty points feature to the user.
If
|
N
[0-9] |
Yes |
isPayAllowed | Allow pay feature to the user.
If
|
N
[0-9] |
Yes |
qrCode | Text used to generate QRCode. | String | Yes |
isMobileVerified | Mobile number verified or not.There are 2 possibilities i.e: Verified , Not Verified | A50
[a-zA-Z] |
Yes |
isEmailVerified | Email address verified or not.There are 2 possibilities i.e: Verified , Not Verified | A50
[a-zA-Z] |
Yes |
city | City of the user. | A50
[a-zA-Z] |
Yes |
postalCode | Postal code of the user. | N
[0-9] |
Yes |
isWalletTransferAllowed | Allow wallet to wallet transfer feature to user.
If
|
N
[0-9] |
Yes |
isLoadWithWalletAllowed | Allow wallet to wallet transfer from add balance/Load feature.
If
|
N
[0-9] |
Yes |
loadIntegrationType | Allow user to add/load using api , checkout | A50
[a-zA-Z] |
Yes |
PlatformId | PlatformName |
---|---|
1 | Android |
2 | iOS |
3 | Web |