Login As Guest User v2

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/v2/loginAsGuestRole

Method 

    POST

Header 

    Content-Type: application/json

Attributes

ELEMENT DESCRIPTION
MerchantCode Required

specific code used for each merchant
geolocation Required

geographic coordinates of the device or place

Request Body

{
  "merchantCode": "VELA",
  "geolocation": "{\"ip\":\"71.140.147.103\",\"type\":\"ipv4\",\"country_code\":\"US\",\"country_name\":\"United States\",\"region_code\":\"GA\",\"region_name\":\"Georgia\",\"city\":\"Duluth\",\"zip\":\"30097\",\"latitude\":34.028648376464844,\"longitude\":-84.1468276977539,\"location\":{\"geoname_id\":7169378,\"capital\":\"Washington D.C.\",\"is_eu\":false},\"userAgent\":\"Mozilla 5.0 Windows NT 10.0; Win64; x64 AppleWebKit 537.36 KHTML, like Gecko Chrome 140.0.0.0 Safari 537.36 Edg 140.0.0.0\"}"
}

Response

{
    "message": {
        "code": "122",
        "type": {
            "name": "SUCCESS"
        },
        "include_i_icon": false,
        "description": "GUEST_USER_LOGIN_SUCCESS",
        "parameters": null
    },
    "locationPath": null,
    "userId": null,
    "cardNotPresentChannelId": 136,
    "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": {
        "name": "GUEST"
    },
    "paymentAction": {
        "name": "SALE"
    },
    "merchantId": 14,
    "customerId": "EMPTY",
    "invoiceNumber": "EMPTY",
    "sessionId": "6B311914175D0DF9A52ECA8B6B72E9B8",
    "totalActivePaymentMethods": null,
    "loyaltyStatus": {
        "name": "NOT_ENROLLED"
    },
    "loyaltyRewardsNumber": null,
    "totalOutstandingLoyaltyPoints": 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 6.8.0.0