Change Password¶
Change Password process functionality contains three steps:
Step 1: checkUserCurrentPwd¶
The checkUserCurrentPwd endpoint is used to check/validate the user's current password.
Request
Endpoint
ui/v1/checkUserCurrentPwd
Method
POST
Body
{
"id": "513",
"status": {
"name": "ACTIVE"
},
"userName": "Merchantuser.2020",
"currentPwd": "Vela0!",
"newPwd": "Vela1!",
"reenterPwd": "Vela1!",
"pwdMisMatchError": false,
"newPwdStrengthError": false,
"reEnterPwdStrengthError": false,
"currentPwdMisMatchError": false,
"pwdLengthError": false,
"pwdInHistoryError": false,
"passwordExpiredInd": "false",
"minimumPasswordLength": "6",
"pwdStrengthPercentage": 100,
"reEnterPwdStrengthPercentage": 100,
"securityQuestionsEnrolledInd": false,
"passwordHistoryCount": "10",
"email": "merchantuser.2020@gmail.com",
"reEnterEmail": "merchantuser.2020@gmail.com",
"emailMisMatchError": false,
"password": "Vela0!"
}
}
Response
{
"country": "USA",
"addressLine1": "1234 Abc road",
"addressLine2": "Pine Valley Street",
"addressLine3": "",
"city": "Port st.Lucie",
"state": "FL",
"zipCode": "34952",
"id": 513,
"userName": "Merchantuser.2020",
"password": "$2a$11$bqiKSs1hWPeO1hsFLhK72.WqmadBWIpNLkHn1drvLTvOr9k.mFXkm",
"status": {
"value": "Active",
"name": "ACTIVE"
},
"firstName": "Merchant",
"lastName": "User",
"phone": "",
"mobile": "7777777777",
"fax": "",
"jobTitle": "Manager",
"department": "Accounting",
"roles": [{
"id": 1324,
"roleType": {
"value": "Merchant User",
"name": "MERCHANT_USER"
},
"checked": true
}],
"userChannelMap": [{
"id": 402,
"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": "merchantuser.2020@gmail.com",
"email": "merchantuser.2020@gmail.com",
"locale": "en_US",
"lastLoginDateTime": null,
"securityQuestionsEnrolledInd": false,
"createdUserId": 503,
"lastModifiedUserId": null,
"firstLoginDateTime": null,
"maximumAllowedLoginDays": 99999,
"organizationName": "",
"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": 1582046190000,
"lockedDateTime": null,
"lockedByUserId": null,
"merchantId": 1,
"createdDateTime": 1582045777000,
"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": "NUMBER@txt.att.net",
"value": "AT&T",
"countryCode": "USA",
"name": "ATT"
},
"transactionCategory": {
"value": "Card Present",
"name": "CARD_PRESENT"
},
"message": null,
"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
}
Step 2: checkPwdInHistory¶
The checkPwdInHistory endpoint can be used to check the password change history of the user.
Request
Endpoint
ui/v1/checkPwdInHistory
Method
POST
Body
{
"id": "513",
"status": {
"name": "ACTIVE"
},
"userName": "Merchantuser.2020",
"currentPwd": "",
"newPwd": "",
"reenterPwd": "",
"pwdMisMatchError": false,
"newPwdStrengthError": false,
"reEnterPwdStrengthError": false,
"currentPwdMisMatchError": false,
"pwdLengthError": false,
"pwdInHistoryError": false,
"passwordExpiredInd": "false",
"minimumPasswordLength": "6",
"pwdStrengthPercentage": 100,
"reEnterPwdStrengthPercentage": 100,
"securityQuestionsEnrolledInd": false,
"passwordHistoryCount": "10",
"email": "merchantuser.2020@gmail.com",
"reEnterEmail": "merchantuser.2020@gmail.com",
"emailMisMatchError": false,
"password": "Vela1!"
}
Response
{
"country": "USA",
"addressLine1": "1234 Abc road",
"addressLine2": "Pine Valley Street",
"addressLine3": "",
"city": "Port st.Lucie",
"state": "FL",
"zipCode": "34952",
"id": 513,
"userName": "Merchantuser.2020",
"password": "$2a$11$bqiKSs1hWPeO1hsFLhK72.WqmadBWIpNLkHn1drvLTvOr9k.mFXkm",
"status": {
"value": "Active",
"name": "ACTIVE"
},
"firstName": "Merchant",
"lastName": "User",
"phone": "",
"mobile": "7777777777",
"fax": "",
"jobTitle": "Manager",
"department": "Accounting",
"roles": [{
"id": 1324,
"roleType": {
"value": "Merchant User",
"name": "MERCHANT_USER"
},
"checked": true
}],
"userChannelMap": [{
"id": 402,
"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": "merchantuser.2020@gmail.com",
"email": "merchantuser.2020@gmail.com",
"locale": "en_US",
"lastLoginDateTime": null,
"securityQuestionsEnrolledInd": true,
"createdUserId": 503,
"lastModifiedUserId": null,
"firstLoginDateTime": null,
"maximumAllowedLoginDays": 99999,
"organizationName": "",
"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": 1582046190000,
"lockedDateTime": null,
"lockedByUserId": null,
"merchantId": 1,
"createdDateTime": 1582045777000,
"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": "NUMBER@txt.att.net",
"value": "AT&T",
"countryCode": "USA",
"name": "ATT"
},
"transactionCategory": {
"value": "Card Present",
"name": "CARD_PRESENT"
},
"message": null,
"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": true,
"currentPasswordValid": false,
"principal": null,
"userSession": null,
"selectedRoles": null
}
Step 3: updateUserPwd¶
The updateMyPwd endpoint is used to update user's password.
Request
Endpoint
ui/v1/updateMyPwd
Method
POST
Body
{
"id":"204",
"status":{
"name":"ACTIVE"
},
"userName":"Merchant.user",
"currentPwd":"",
"newPwd":"",
"reenterPwd":"",
"pwdMisMatchError":false,
"newPwdStrengthError":false,
"reEnterPwdStrengthError":false,
"currentPwdMisMatchError":false,
"pwdLengthError":false,
"pwdInHistoryError":false,
"passwordExpiredInd":"false",
"minimumPasswordLength":"6",
"pwdStrengthPercentage":0,
"reEnterPwdStrengthPercentage":0,
"securityQuestionsEnrolledInd":false,
"passwordHistoryCount":"10",
"forceChangePasswordInd":"false",
"lastModifiedUserId":"204",
"password":"Vela6!"
}
Response
{
"country": "USA",
"addressLine1": "12000 Findley Road",
"addressLine2": "",
"addressLine3": "",
"city": "Johns Creek",
"state": "GA",
"zipCode": "30097",
"id": 204,
"userName": "Merchant.user",
"password": "$2a$11$vsRPllGLJ4t1kCiWTtJL9eGqpEhmnsHy8B9CJNAMQUTHffe5fQG.G",
"status": {
"value": "Active",
"name": "ACTIVE"
},
"firstName": "Merchant",
"lastName": "User",
"phone": "",
"mobile": "",
"fax": "",
"jobTitle": "Manager",
"department": "Finance",
"roles": [
{
"id": 1086,
"roleType": {
"value": "Merchant User",
"name": "MERCHANT_USER"
},
"checked": true
}
],
"userChannelMap": [
{
"id": 171,
"channel": {
"id": 21,
"channelName": "Realex",
"channelStatus": {
"value": "Active",
"name": "ACTIVE"
},
"channelType": {
"value": "External",
"name": "EXTERNAL"
},
"createdDateTime": 1507557924000,
"merchantId": 1,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 14,
"lastModifiedUserId": 182,
"industryType": {
"value": "eCommerce",
"name": "ECOMMERCE"
},
"allowCashAsPaymentMethodInd": true,
"allowMoneyOrderAsPaymentMethodInd": true,
"allowPaperCheckAsPaymentMethodInd": true,
"paymentMethods": [
{
"id": 389,
"paymentMethodType": {
"value": "3D Secure",
"name": "THREE_D_SECURE"
},
"paymentGateway": {
"value": "Realex Payments",
"name": "REALEX"
},
"cardBrand": {
"value": "VERIFIED by VISA",
"name": "VERIFIED_BY_VISA"
},
"cardId": 7,
"createdUserId": 182,
"lastModifiedUserId": null,
"createdDateTime": 1558637755000,
"lastUpdatedDateTime": null,
"position": 121
},
{
"id": 383,
"paymentMethodType": {
"value": "Credit Card",
"name": "CREDIT_CARD"
},
"paymentGateway": {
"value": "Realex Payments",
"name": "REALEX"
},
"cardBrand": {
"value": "VISA",
"name": "VISA"
},
"cardId": 1,
"createdUserId": 182,
"lastModifiedUserId": null,
"createdDateTime": 1558637754000,
"lastUpdatedDateTime": null,
"position": 115
}
],
"userCount": null,
"assignedPaymentMethods": null,
"message": null,
"paymentMethodsCount": null,
"merchantName": null
}
}
],
"oldEmail": "merchant.user@gmail.com",
"email": "merchant.user@gmail.com",
"locale": "en_US",
"lastLoginDateTime": 1574178902000,
"securityQuestionsEnrolledInd": true,
"createdUserId": 204,
"lastModifiedUserId": 204,
"firstLoginDateTime": 1568912617000,
"maximumAllowedLoginDays": 99999,
"organizationName": "",
"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": 1574180277128,
"lockedDateTime": null,
"lockedByUserId": null,
"merchantId": 3,
"createdDateTime": 1567020065000,
"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": null,
"type": {
"value": "Success",
"name": "SUCCESS"
},
"text": null,
"include_i_icon": false,
"description": "Your <strong>Password</strong> has been changed successfully. Please log in with new credentials."
},
"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 5.3.0.2