Login
Description¶
The login
endpoint is used to Sign in a user into the VELA application.
Request¶
Endpoint
/ui/v1/login
Method
POST
Header
Content-Type: application/json
Attributes
ELEMENT | DESCRIPTION |
---|---|
Username | Required Can be username, email, or Mobile Number |
Password | Required |
MerchantCode | Required specific code used for each merchant |
mobileCountryCallingCodeId | Conditional If mobile number is not unique |
Request Body : Login via Username
{
"userName": "johnsmith",
"password": "Password12#$!",
"merchantCode": "VELA"
}
Request Body : Login via Email address
{
"userName": "johnsmith@gmail.com",
"password": "Password12#$!",
"merchantCode": "VELA"
}
Request Body : Login via Mobile Number
{
"userName": "4567899876",
"password": "Password12#$!",
"merchantCode": "VELA"
}
Request Body : Login via Mobile Number - Multiple accounts with same mobile number
{
"password": "Vela12345^&!",
"userName": "123456789",
"merchantCode": "VELA",
"mobileCountryCallingCodeId": 1
}
Response¶
{
"message": {
"code": "28",
"type": {
"name": "SUCCESS"
},
"include_i_icon": false,
"description": "USER_CREDENTIALS_AUTHENTICATION_SUCCESS",
"parameters": [
{
"name": null,
"value": null
}
]
},
"locationPath": "home",
"userId": 586,
"cardNotPresentChannelId": 86,
"cardPresentChannelId": 87,
"userRoles": "MERCHANT_ADMIN",
"forceChangePasswordInd": false,
"userLocale": {
"name": "en_US"
},
"passwordExpiryDaysIn": -1,
"securityQuestionsEnrolledInd": true,
"userEmail": "fiserv.ecommerce@gmail.com",
"mobile": null,
"loyaltyStatus": {
"name": "NOT_APPLICABLE"
},
"loyaltyRewardsNumber": null,
"uiType": null,
"createdUserId": 491,
"unpaidInvoiceCount": 0,
"acceptTermsOfUseAgreementInd": true,
"acceptPrivacyPolicyAgreementInd": true,
"roleType": {
"name": "MERCHANT_ADMIN"
},
"paymentAction": {
"name": "PRE_AUTHORIZATION"
},
"merchantId": null,
"customerId": null,
"invoiceNumber": null,
"sessionId": "676B24C7FD5D0BFE337695AD09AB5D6E",
"totalActivePaymentMethods": 0
}
Negative Request & Response
If a negative request has been passed for example with incorrect password, then the Response would be as follows:
Request Body
{
"userName": "johnsmith",
"password": "Password12345",
"merchantCode: "VELA"
}
Response
{
"message": {
"code": "4",
"type": {
"name": "ERROR"
},
"include_i_icon": false,
"description": "LOGIN_CREDENTIALS_INVALID_ERROR",
"parameters": [
{
"name": null,
"value": null
}
]
},
"locationPath": null,
"userId": null,
"cardNotPresentChannelId": null,
"cardPresentChannelId": null,
"userRoles": null,
"forceChangePasswordInd": false,
"userLocale": null,
"passwordExpiryDaysIn": null,
"securityQuestionsEnrolledInd": false,
"userEmail": null,
"mobile": null,
"loyaltyStatus": {
"name": "NOT_ENROLLED"
},
"loyaltyRewardsNumber": null,
"uiType": null,
"createdUserId": null,
"unpaidInvoiceCount": null,
"acceptTermsOfUseAgreementInd": false,
"acceptPrivacyPolicyAgreementInd": false,
"roleType": null,
"paymentAction": null,
"merchantId": null,
"customerId": null,
"invoiceNumber": null,
"sessionId": "E54A6392DD0FCE85C762412A358CCB74",
"totalActivePaymentMethods": null
}
Note
BASE_URL is derived from the merchant code.
For Test Environment, to obtain the BASE_URL, please contact vela@datumtg.com.
For Production Environment, to obtain the BASE_URL, please contact vela@datumtg.com.
Updated As Of Version 6.7.0.2