Login As Guest User v3

Description¶

The loginAsGuestRole endpoint is used to log a user into the VELA application who is not a registered user of the application.

Request¶

Endpoint

    /ui/v3/loginAsGuestRole  

Method

    POST  

Header

    Content-Type: application/json  

Attributes

ELEMENT	DESCRIPTION
userName	Required specific username for each merchant
password	Required Depends on merchant-specific password policy
MerchantCode	Required Specific code used for each merchant
geolocation	Required Device or place attributes such as IP Address, City, Country Code, Latitude, Longitude, and User Agent

Request Body

{
    "userName": "vela-velaguestuser",
    "password": "Vela-velaGuestuser12&*",
    "geolocation": "{\"ip\":\"12.197.184.98\",\"latitude\":34.21099853515625,\"longitude\":-84.17929077148438,\"city\":\"Cumming\",\"country\":\"United States\",\"userAgent\":\"Mozilla/5.0 (Linux; Android 6.0; Nexus 5 Build MRA58N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/144.0.0.0 Mobile Safari/537.36\"}",
    "merchantCode": "vela-vela"
}

Response¶

{
    "message": {
        "code": "122",
        "type": {
            "name": "SUCCESS"
        },
        "include_i_icon": false,
        "description": "GUEST_USER_LOGIN_SUCCESS",
        "parameters": null
    },
    "locationPath": null,
    "userId": 666,
    "cardNotPresentChannelId": 72,
    "cardPresentChannelId": null,
    "forceChangePasswordInd": false,
    "userLocale": null,
    "passwordExpiryDaysIn": null,
    "securityQuestionsEnrolledInd": false,
    "userEmail": null,
    "mobile": null,
    "uiType": null,
    "createdUserId": null,
    "unpaidInvoiceCount": null,
    "acceptTermsOfUseAgreementInd": false,
    "acceptPrivacyPolicyAgreementInd": false,
    "roleType": null,
    "paymentAction": {
        "name": "SALE"
    },
    "merchantId": 42,
    "customerId": null,
    "invoiceNumber": "EMPTY",
    "sessionId": "34FD784330612AB9F31ADE54895FD893",
    "totalActivePaymentMethods": null,
    "loyaltyStatus": {
        "name": "NOT_APPLICABLE"
    },
    "loyaltyRewardsNumber": null,
    "totalOutstandingLoyaltyPoints": null,
    "numberOfNotifications": null
}

Negative Request & Response

If a negative request has been passed, then the Response would be as follows:

Request Body

{
    "merchantCode": "1234"

}

Response

{
    "message": {
        "code": "254",
        "type": {
            "name": "ERROR"
        },
        "include_i_icon": false,
        "description": "ONE_OR_MORE_REQUIRED_FIELDS_ARE_MISSING ",
        "parameters": null
    },
    "locationPath": null,
    "userId": null,
    "cardNotPresentChannelId": null,
    "cardPresentChannelId": null,
    "userRoles": null,
    "forceChangePasswordInd": false,
    "userLocale": null,
    "passwordExpiryDaysIn": null,
    "securityQuestionsEnrolledInd": false,
    "userEmail": null,
    "mobile": null,
    "uiType": null,
    "createdUserId": null,
    "unpaidInvoiceCount": null,
    "acceptTermsOfUseAgreementInd": false,
    "acceptPrivacyPolicyAgreementInd": false,
    "roleType": null,
    "paymentAction": null,
    "merchantId": null,
    "customerId": null,
    "invoiceNumber": null,
    "sessionId": "F9B6730261AD02A0FF3AD304C9D265C3",
    "totalActivePaymentMethods": null,
    "loyaltyStatus": {
        "name": "NOT_ENROLLED"
    },
    "loyaltyRewardsNumber": null,
    "totalOutstandingLoyaltyPoints": null
}

Updated As Of Version 7.2.0.0