My Account
This functionality contains two steps.
Step 1:
The getUser endpoint is used to fetch the user's data from the VELA application.
Request¶
Endpoint¶
ui/v1/getUser/id
Note
Replace id above with the internal id of the user.
Method¶
GETHeader¶
Content-Type: application/json
Response¶
{
"country": "USA",
"addressLine1": "12000 Findley Road",
"addressLine2": "",
"addressLine3": "",
"city": "Johns Creek",
"state": "GA",
"zipCode": "30097",
"id": 195,
"userName": "vela.merchantadmin",
"password": "$2a$11$HmG5A89rqKsynRpGDyGDE.8wzKsQLFSIvFpLG42b7rR/.A5/V1Dj6",
"status": {
"value": "Active",
"name": "ACTIVE"
},
"firstName": "vela",
"lastName": "merchantadmin",
"phone": "",
"mobile": "4566546438",
"fax": "",
"jobTitle": "",
"department": "",
"roles": [
{
"id": 1080,
"roleType": {
"value": "Merchant Admin",
"name": "MERCHANT_ADMIN"
},
"checked": true
}
],
"userChannelMap": [
{
"id": 165,
"channel": {
"id": 45,
"channelName": "Cybersource",
"channelStatus": {
"value": "Active",
"name": "ACTIVE"
},
"channelType": {
"value": "External",
"name": "EXTERNAL"
},
"createdDateTime": 1555006414000,
"merchantId": 1,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 1,
"lastModifiedUserId": 195,
"industryType": {
"value": "eCommerce",
"name": "ECOMMERCE"
},
"allowCashAsPaymentMethodInd": false,
"allowMoneyOrderAsPaymentMethodInd": false,
"allowPaperCheckAsPaymentMethodInd": false,
"paymentMethods": [
{
"id": 380,
"paymentMethodType": {
"value": "eCheck (ACH)",
"name": "ECHECK"
},
"paymentGateway": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"cardBrand": {
"value": "eCheck (ACH)",
"name": "ECHECK"
},
"cardId": null,
"createdUserId": 1,
"lastModifiedUserId": 195,
"createdDateTime": 1558635800000,
"lastUpdatedDateTime": null,
"position": 109
},
{
"id": 367,
"paymentMethodType": {
"value": "3D Secure",
"name": "THREE_D_SECURE"
},
"paymentGateway": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"cardBrand": {
"value": "VERIFIED by VISA",
"name": "VERIFIED_BY_VISA"
},
"cardId": 127,
"createdUserId": 1,
"lastModifiedUserId": 195,
"createdDateTime": 1558635799000,
"lastUpdatedDateTime": null,
"position": 96
},
{
"id": 373,
"paymentMethodType": {
"value": "PINless Debit Card",
"name": "PIN_LESS_DEBIT_CARD"
},
"paymentGateway": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"cardBrand": {
"value": "VISA Debit",
"name": "VISA_DEBIT"
},
"cardId": 133,
"createdUserId": 1,
"lastModifiedUserId": 195,
"createdDateTime": 1558635800000,
"lastUpdatedDateTime": null,
"position": 102
},
{
"id": 341,
"paymentMethodType": {
"value": "Credit Card",
"name": "CREDIT_CARD"
},
"paymentGateway": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"cardBrand": {
"value": "VISA",
"name": "VISA"
},
"cardId": 101,
"createdUserId": 1,
"lastModifiedUserId": 195,
"createdDateTime": 1558635797000,
"lastUpdatedDateTime": null,
"position": 70
},
{
"id": 381,
"paymentMethodType": {
"value": "VISA Checkout",
"name": "VISA_CHECKOUT"
},
"paymentGateway": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"cardBrand": {
"value": "VISA Checkout",
"name": "VISA_CHECKOUT"
},
"cardId": null,
"createdUserId": 1,
"lastModifiedUserId": 195,
"createdDateTime": 1558635801000,
"lastUpdatedDateTime": null,
"position": 110
},
{
"id": 467,
"paymentMethodType": {
"value": "PayPal",
"name": "PAYPAL"
},
"paymentGateway": {
"value": "PayPal",
"name": "PAYPAL"
},
"cardBrand": {
"value": "PayPal",
"name": "PAYPAL"
},
"cardId": null,
"createdUserId": 195,
"lastModifiedUserId": null,
"createdDateTime": 1571345178000,
"lastUpdatedDateTime": null,
"position": 129
}
],
"userCount": null,
"assignedPaymentMethods": null,
"message": null,
"paymentMethodsCount": null
}
}
],
"oldEmail": "vela.merchantadmin@datumsoftware.com",
"email": "vela.merchantadmin@gmail.com",
"locale": "en_US",
"lastLoginDateTime": 1571766109000,
"securityQuestionsEnrolledInd": true,
"createdUserId": 1,
"lastModifiedUserId": 195,
"firstLoginDateTime": 1563308542000,
"maximumAllowedLoginDays": 99999,
"organizationName": "Vela",
"forceChangePasswordInd": false,
"originalUserId": null,
"loyaltyStatus": {
"value": "Not Enrolled",
"name": "NOT_ENROLLED"
},
"loyaltyRewardsNumber": null,
"loyaltyEnrolledDateTime": null,
"loyaltyTierLevel": {
"value": "None",
"name": "NONE"
},
"totalOutstandingPoints": null,
"forgotPasswordGeneratedDateTime": null,
"numberOfFailedLoginAttempts": 0,
"numberOfFailedForgotPasswordAttempts": 0,
"changePasswordDateTime": 1571673944000,
"lockedDateTime": null,
"lockedByUserId": null,
"merchantId": 3,
"createdDateTime": 1563308478000,
"forceChangeSecurityQuestionsInd": false,
"passwordNeverExpiresInd": false,
"phoneCountryCallingCodeId": 1,
"mobileCountryCallingCodeId": 34,
"faxCountryCallingCodeId": 1,
"customerId": null,
"acceptTermsOfUseAgreementInd": true,
"acceptPrivacyPolicyAgreementInd": true,
"namePrefix": null,
"nameSuffix": null,
"middleInitial": "",
"paymentAction": {
"value": "Pre-Authorization",
"name": "PRE_AUTHORIZATION"
},
"mobilePhoneCarrierType": {
"emailDomain": "NUMBER@clarotorpedo.com.br",
"value": "Claro",
"countryCode": "BRA",
"name": "CLARO"
},
"transactionCategory": {
"value": "Card Present",
"name": "CARD_PRESENT"
},
"message": null,
"address": null,
"fullName": null,
"minimumPasswordLength": "6",
"minimumLowercaseAlphabets": "1",
"minimumUppercaseAlphabets": "1",
"minimumNumerics": "1",
"minimumSpecialCharacters": "1",
"sessionId": null,
"uiType": null,
"customerName": null,
"customerNumber": null,
"geoLocation": null,
"currentPassword": null,
"reEnterPassword": "$2a$11$HmG5A89rqKsynRpGDyGDE.8wzKsQLFSIvFpLG42b7rR/.A5/V1Dj6",
"reEnterEmail": "vela.merchantadmin@gmail.com",
"merchantName": null,
"language": null,
"merchantCode": null,
"passwordAlreadyExists": false,
"currentPasswordValid": false,
"principal": null,
"userSession": null,
"selectedRoles": [
"MERCHANT_ADMIN"
]
}
Step 2:
The updateUser endpoint is used to update the user's profile related information.
Request¶
Endpoint¶
ui/v1/updateUserMethod¶
POSTHeader¶
Content-Type: application/jsonBody¶
{
"country": "USA",
"addressLine1": "4500 SE",
"addressLine2": "Pine Valley Street",
"addressLine3": "",
"city": "Port st.Lucie",
"state": "FL",
"zipCode": "34952",
"id": 503,
"userName": "Performance.tester",
"password": "$2a$11$EuTcyu7VIC97gFy97WuppOo4X2cDE9XKEvLRdcyvzOE5YNcyxEM8u",
"status": {
"value": "Active",
"name": "ACTIVE"
},
"firstName": "Performance",
"lastName": "Tester",
"phone": "",
"mobile": "",
"fax": "",
"jobTitle": "Manager",
"department": "Accounting",
"roles": [{
"id": 1314,
"roleType": {
"value": "Merchant Admin",
"name": "MERCHANT_ADMIN"
},
"checked": true
}],
"userChannelMap": [{
"id": 392,
"channel": {
"id": 1,
"channelName": "Sandpiper Bay Channel",
"channelStatus": {
"value": "Active",
"name": "ACTIVE"
},
"channelType": {
"value": "Internal",
"name": "INTERNAL"
},
"createdDateTime": 1477321991000,
"merchantId": 1,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 1,
"lastModifiedUserId": 1,
"industryType": {
"value": "eCommerce",
"name": "ECOMMERCE"
},
"allowCashAsPaymentMethodInd": true,
"allowMoneyOrderAsPaymentMethodInd": true,
"allowPaperCheckAsPaymentMethodInd": true,
"paymentMethods": [{
"id": 242,
"paymentMethodType": {
"value": "PINless Debit Card",
"name": "PIN_LESS_DEBIT_CARD"
},
"paymentGateway": {
"value": "Chase Paymentech (Orbital)",
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"cardBrand": {
"value": "VISA Debit",
"name": "VISA_DEBIT"
},
"cardId": 712,
"createdUserId": 112,
"lastModifiedUserId": 1,
"createdDateTime": 1535409349000,
"lastUpdatedDateTime": 1545671577000,
"position": 22
}, {
"id": 290,
"paymentMethodType": {
"value": "eCheck (ACH)",
"name": "ECHECK"
},
"paymentGateway": {
"value": "Chase Paymentech (Orbital)",
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"cardBrand": {
"value": "eCheck (ACH)",
"name": "ECHECK"
},
"cardId": null,
"createdUserId": 1,
"lastModifiedUserId": 1,
"createdDateTime": 1536677090000,
"lastUpdatedDateTime": 1545671577000,
"position": 31
}, {
"id": 233,
"paymentMethodType": {
"value": "Credit Card",
"name": "CREDIT_CARD"
},
"paymentGateway": {
"value": "Chase Paymentech (Orbital)",
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"cardBrand": {
"value": "AMERICAN EXPRESS",
"name": "AMEX"
},
"cardId": 703,
"createdUserId": 112,
"lastModifiedUserId": 1,
"createdDateTime": 1535409349000,
"lastUpdatedDateTime": 1545671577000,
"position": 13
}],
"userCount": null,
"assignedPaymentMethods": null,
"message": null,
"paymentMethodsCount": null,
"merchantName": null
}
}],
"oldEmail": "Performance.tester@gmail.com",
"email": "Performance.tester@gmail.com",
"locale": "en_US",
"lastLoginDateTime": 1582047851000,
"securityQuestionsEnrolledInd": true,
"createdUserId": 340,
"lastModifiedUserId": "503",
"firstLoginDateTime": 1580404502000,
"maximumAllowedLoginDays": 99999,
"organizationName": "ClubMed Sandpiper",
"forceChangePasswordInd": false,
"originalUserId": null,
"loyaltyStatus": {
"value": "Not Enrolled",
"name": "NOT_ENROLLED"
},
"loyaltyRewardsNumber": null,
"loyaltyEnrolledDateTime": null,
"loyaltyTierLevel": {
"value": "None",
"name": "NONE"
},
"totalOutstandingPoints": null,
"forgotPasswordGeneratedDateTime": null,
"numberOfFailedLoginAttempts": 0,
"numberOfFailedForgotPasswordAttempts": 0,
"changePasswordDateTime": 1580405284000,
"lockedDateTime": null,
"lockedByUserId": null,
"merchantId": 1,
"createdDateTime": 1580403635000,
"forceChangeSecurityQuestionsInd": false,
"passwordNeverExpiresInd": false,
"phoneCountryCallingCodeId": 1,
"mobileCountryCallingCodeId": 1,
"faxCountryCallingCodeId": 1,
"customerId": null,
"acceptTermsOfUseAgreementInd": true,
"acceptPrivacyPolicyAgreementInd": true,
"namePrefix": null,
"nameSuffix": null,
"middleInitial": "",
"paymentAction": {
"value": "Pre-Authorization",
"name": "PRE_AUTHORIZATION"
},
"mobilePhoneCarrierType": {
"emailDomain": "",
"value": "Select",
"countryCode": "UNKNOWN",
"name": "UNKNOWN"
},
"transactionCategory": {
"value": "Card Not Present",
"name": "CARD_NOT_PRESENT"
},
"message": null,
"address": null,
"fullName": null,
"minimumPasswordLength": "6",
"minimumLowercaseAlphabets": "1",
"minimumUppercaseAlphabets": "1",
"minimumNumerics": "1",
"minimumSpecialCharacters": "1",
"sessionId": null,
"uiType": null,
"customerName": null,
"customerNumber": null,
"geoLocation": null,
"currentPassword": null,
"reEnterPassword": "$2a$11$EuTcyu7VIC97gFy97WuppOo4X2cDE9XKEvLRdcyvzOE5YNcyxEM8u",
"reEnterEmail": "Performance.tester@gmail.com",
"merchantName": null,
"language": null,
"merchantCode": null,
"passwordAlreadyExists": false,
"currentPasswordValid": false,
"principal": null,
"userSession": null,
"selectedRoles": ["MERCHANT_ADMIN"],
"pwdStrengthPercentage": 100,
"reEnterPwdStrengthPercentage": 100,
"pwdLengthError": false,
"pwdMisMatchError": false,
"pwdStrengthError": false,
"reEnterPwdStrengthError": false,
"emailMisMatchError": false
}
Response¶
{
"country": "USA",
"addressLine1": "4500 SE",
"addressLine2": "Pine Valley Street",
"addressLine3": "",
"city": "Port st.Lucie",
"state": "FL",
"zipCode": "34952",
"id": 503,
"userName": "Performance.tester",
"password": "$2a$11$EuTcyu7VIC97gFy97WuppOo4X2cDE9XKEvLRdcyvzOE5YNcyxEM8u",
"status": {
"value": "Active",
"name": "ACTIVE"
},
"firstName": "Performance",
"lastName": "Tester",
"phone": "",
"mobile": "",
"fax": "",
"jobTitle": "Manager",
"department": "Accounting",
"roles": [{
"id": 1314,
"roleType": {
"value": "Merchant Admin",
"name": "MERCHANT_ADMIN"
},
"checked": true
}],
"userChannelMap": [{
"id": 392,
"channel": {
"id": 1,
"channelName": "Sandpiper Bay Channel",
"channelStatus": {
"value": "Active",
"name": "ACTIVE"
},
"channelType": {
"value": "Internal",
"name": "INTERNAL"
},
"createdDateTime": 1477321991000,
"merchantId": 1,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 1,
"lastModifiedUserId": 1,
"industryType": {
"value": "eCommerce",
"name": "ECOMMERCE"
},
"allowCashAsPaymentMethodInd": true,
"allowMoneyOrderAsPaymentMethodInd": true,
"allowPaperCheckAsPaymentMethodInd": true,
"paymentMethods": [{
"id": 242,
"paymentMethodType": {
"value": "PINless Debit Card",
"name": "PIN_LESS_DEBIT_CARD"
},
"paymentGateway": {
"value": "Chase Paymentech (Orbital)",
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"cardBrand": {
"value": "VISA Debit",
"name": "VISA_DEBIT"
},
"cardId": 712,
"createdUserId": 112,
"lastModifiedUserId": 1,
"createdDateTime": 1535409349000,
"lastUpdatedDateTime": 1545671577000,
"position": 22
},
{
"id": 290,
"paymentMethodType": {
"value": "eCheck (ACH)",
"name": "ECHECK"
},
"paymentGateway": {
"value": "Chase Paymentech (Orbital)",
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"cardBrand": {
"value": "eCheck (ACH)",
"name": "ECHECK"
},
"cardId": null,
"createdUserId": 1,
"lastModifiedUserId": 1,
"createdDateTime": 1536677090000,
"lastUpdatedDateTime": 1545671577000,
"position": 31
},
{
"id": 233,
"paymentMethodType": {
"value": "Credit Card",
"name": "CREDIT_CARD"
},
"paymentGateway": {
"value": "Chase Paymentech (Orbital)",
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"cardBrand": {
"value": "AMERICAN EXPRESS",
"name": "AMEX"
},
"cardId": 703,
"createdUserId": 112,
"lastModifiedUserId": 1,
"createdDateTime": 1535409349000,
"lastUpdatedDateTime": 1545671577000,
"position": 13
}
],
"userCount": null,
"assignedPaymentMethods": null,
"message": null,
"paymentMethodsCount": null,
"merchantName": null
}
}],
"oldEmail": "Performance.tester@gmail.com",
"email": "Performance.tester@gmail.com",
"locale": "en_US",
"lastLoginDateTime": 1582047851000,
"securityQuestionsEnrolledInd": true,
"createdUserId": 340,
"lastModifiedUserId": 503,
"firstLoginDateTime": 1580404502000,
"maximumAllowedLoginDays": 99999,
"organizationName": "ClubMed Sandpiper",
"forceChangePasswordInd": false,
"originalUserId": null,
"loyaltyStatus": {
"value": "Not Enrolled",
"name": "NOT_ENROLLED"
},
"loyaltyRewardsNumber": null,
"loyaltyEnrolledDateTime": null,
"loyaltyTierLevel": {
"value": "None",
"name": "NONE"
},
"totalOutstandingPoints": null,
"forgotPasswordGeneratedDateTime": null,
"numberOfFailedLoginAttempts": 0,
"numberOfFailedForgotPasswordAttempts": 0,
"changePasswordDateTime": 1580405284000,
"lockedDateTime": null,
"lockedByUserId": null,
"merchantId": 1,
"createdDateTime": 1580403635000,
"forceChangeSecurityQuestionsInd": false,
"passwordNeverExpiresInd": false,
"phoneCountryCallingCodeId": 1,
"mobileCountryCallingCodeId": 1,
"faxCountryCallingCodeId": 1,
"customerId": null,
"acceptTermsOfUseAgreementInd": true,
"acceptPrivacyPolicyAgreementInd": true,
"namePrefix": null,
"nameSuffix": null,
"middleInitial": "",
"paymentAction": {
"value": "Pre-Authorization",
"name": "PRE_AUTHORIZATION"
},
"mobilePhoneCarrierType": {
"emailDomain": "",
"value": "Select",
"countryCode": "UNKNOWN",
"name": "UNKNOWN"
},
"transactionCategory": {
"value": "Card Not Present",
"name": "CARD_NOT_PRESENT"
},
"message": {
"code": "99",
"type": {
"value": "Success",
"name": "SUCCESS"
},
"text": null,
"include_i_icon": false,
"description": "Your profile has been updated successfully. <strong>You may need to log out and log back in for your changes to be reflected.</strong>"
},
"address": null,
"fullName": null,
"minimumPasswordLength": null,
"minimumLowercaseAlphabets": null,
"minimumUppercaseAlphabets": null,
"minimumNumerics": null,
"minimumSpecialCharacters": null,
"sessionId": null,
"uiType": null,
"customerName": null,
"customerNumber": null,
"geoLocation": null,
"currentPassword": null,
"reEnterPassword": null,
"reEnterEmail": null,
"merchantName": null,
"language": null,
"merchantCode": null,
"passwordAlreadyExists": false,
"currentPasswordValid": false,
"principal": null,
"userSession": null,
"selectedRoles": null
}
Updated As Of 2.4.0.0