Generate One Time Passcode
Description
The generateOneTimePasscode
endpoint is used to generate a one time passcode for the users for additional security while they update their account settings such as email, Password, address etc.
Endpoint¶
ui/v1/generateOneTimePasscode
Method¶
POST
Headers¶
Content-Type: application/json
Body¶
{
"country": "USA",
"addressLine1": "4500 SE",
"addressLine2": "Pine Valley Street",
"addressLine3": null,
"city": "Port St.Lucie",
"state": "IA",
"zipCode": "30098",
"streetNumber": null,
"streetName": null,
"id": 340,
"userName": "merchant.admin",
"password": "$2a$11$Nd7xZkTganWBg1MFVDs3MeXH4aw8aur1q2VOvr2GKwUFf/t936TAq",
"status": {
"name": "ACTIVE"
},
"firstName": "Merchant",
"lastName": "Admin",
"phone": "",
"mobile": "",
"fax": "",
"jobTitle": "Manager",
"department": "Finance",
"roles": [{
"id": 1179,
"roleType": {
"name": "MERCHANT_ADMIN"
},
"checked": true,
"lastModifiedUserId": null
}],
"userChannelMap": [{
"id": 265,
"cardNotPresentChannel": {
"id": 1,
"channelName": "Sandpiper Bay Channel",
"channelStatus": {
"name": "ACTIVE"
},
"channelType": {
"name": "INTERNAL"
},
"createdDateTime": 1477321991000,
"merchantId": 1,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 1,
"lastModifiedUserId": 340,
"industryType": {
"name": "ECOMMERCE"
},
"allowCashAsPaymentMethodInd": false,
"allowMoneyOrderAsPaymentMethodInd": false,
"allowPaperCheckAsPaymentMethodInd": false,
"allowEStoreCreditAsPaymentMethodInd": false,
"paymentMethods": [{
"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": 340,
"createdDateTime": 1535409349000,
"lastUpdatedDateTime": 1545671577000,
"position": 13
}, {
"id": 242,
"paymentMethodType": {
"value": "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": 340,
"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": 340,
"createdDateTime": 1536677090000,
"lastUpdatedDateTime": 1545671577000,
"position": 31
}, {
"id": 1034,
"paymentMethodType": {
"value": "Gift Card",
"name": "GIFT_CARD"
},
"paymentGateway": {
"value": "Chase Paymentech (Orbital)",
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"cardBrand": {
"value": "Gift Card",
"name": "GIFT_CARD"
},
"cardId": null,
"createdUserId": 340,
"lastModifiedUserId": 340,
"createdDateTime": 1584369058000,
"lastUpdatedDateTime": null,
"position": 40
}],
"allowDynamicRoutingCapabilityInd": true,
"secondaryPaymentGateway": {
"value": "Chase Paymentech (NetConnect - Direct To Tandem)",
"name": "CHASE_PAYMENTECH_NETCONNECT"
},
"tertiaryPaymentGateway": {
"value": "Chase Paymentech (NetConnect - Direct To Tandem)",
"name": "CHASE_PAYMENTECH_NETCONNECT"
},
"userCount": null,
"assignedPaymentMethods": null,
"message": null,
"paymentMethodsCount": null,
"merchantName": null
},
"cardPresentChannel": {
"id": 1,
"channelName": "Sandpiper Bay Channel",
"channelStatus": {
"name": "ACTIVE"
},
"channelType": {
"name": "INTERNAL"
},
"createdDateTime": 1477321991000,
"merchantId": 1,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 1,
"lastModifiedUserId": 340,
"industryType": {
"name": "ECOMMERCE"
},
"allowCashAsPaymentMethodInd": false,
"allowMoneyOrderAsPaymentMethodInd": false,
"allowPaperCheckAsPaymentMethodInd": false,
"allowEStoreCreditAsPaymentMethodInd": false,
"paymentMethods": [{
"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": 340,
"createdDateTime": 1535409349000,
"lastUpdatedDateTime": 1545671577000,
"position": 13
}, {
"id": 242,
"paymentMethodType": {
"value": "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": 340,
"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": 340,
"createdDateTime": 1536677090000,
"lastUpdatedDateTime": 1545671577000,
"position": 31
}, {
"id": 1034,
"paymentMethodType": {
"value": "Gift Card",
"name": "GIFT_CARD"
},
"paymentGateway": {
"value": "Chase Paymentech (Orbital)",
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"cardBrand": {
"value": "Gift Card",
"name": "GIFT_CARD"
},
"cardId": null,
"createdUserId": 340,
"lastModifiedUserId": 340,
"createdDateTime": 1584369058000,
"lastUpdatedDateTime": null,
"position": 40
}],
"allowDynamicRoutingCapabilityInd": true,
"secondaryPaymentGateway": {
"value": "Chase Paymentech (NetConnect - Direct To Tandem)",
"name": "CHASE_PAYMENTECH_NETCONNECT"
},
"tertiaryPaymentGateway": {
"value": "Chase Paymentech (NetConnect - Direct To Tandem)",
"name": "CHASE_PAYMENTECH_NETCONNECT"
},
"userCount": null,
"assignedPaymentMethods": null,
"message": null,
"paymentMethodsCount": null,
"merchantName": null
},
"lastModifiedUserId": null
}],
"oldEmail": "",
"email": "merchant.admin@gmail.com",
"locale": "en_US",
"lastLoginDateTime": 1695390888000,
"securityQuestionsEnrolledInd": true,
"createdUserId": 340,
"lastModifiedUserId": "340",
"firstLoginDateTime": 1561039438000,
"maximumAllowedLoginDays": 99999,
"organizationName": "Club Med Management Services, Inc.",
"forceChangePasswordInd": false,
"originalUserId": null,
"loyaltyStatus": {
"name": "NOT_APPLICABLE"
},
"loyaltyRewardsNumber": null,
"loyaltyEnrolledDateTime": null,
"loyaltyTierLevel": {
"name": "NONE"
},
"totalOutstandingPoints": null,
"forgotPasswordGeneratedDateTime": null,
"numberOfFailedLoginAttempts": 0,
"numberOfFailedForgotPasswordAttempts": 0,
"changePasswordDateTime": 1691177238000,
"lockedDateTime": null,
"lockedByUserId": null,
"merchantId": 1,
"createdDateTime": 1591024280000,
"forceChangeSecurityQuestionsInd": false,
"passwordNeverExpiresInd": false,
"phoneCountryCallingCodeId": 1,
"mobileCountryCallingCodeId": 1,
"faxCountryCallingCodeId": 1,
"acceptTermsOfUseAgreementInd": true,
"acceptPrivacyPolicyAgreementInd": true,
"namePrefix": {},
"nameSuffix": {},
"middleInitial": "vela",
"paymentAction": {
"name": "SALE"
},
"mobilePhoneCarrierType": {
"emailDomain": "NUMBER@txt.att.net",
"value": "AT&T",
"countryCode": "USA",
"name": "ATT"
},
"transactionCategory": {
"name": "CARD_NOT_PRESENT"
},
"textMessageType": {
"name": "WHATSAPP"
},
"customer": null,
"oneTimePasscode": "56197816",
"oneTimePasscodeCreatedDateTime": 1695390544000,
"numberOfFailedOneTimePasscodeAttempts": 0,
"gender": {},
"message": null,
"customerId": null,
"address": null,
"fullName": null,
"minimumPasswordLength": "12",
"minimumLowercaseAlphabets": "1",
"minimumUppercaseAlphabets": "1",
"minimumNumerics": "1",
"minimumSpecialCharacters": "1",
"sessionId": null,
"uiType": null,
"customerName": null,
"customerNumber": null,
"geolocation": null,
"currentPassword": null,
"reEnterPassword": "$2a$11$Nd7xZkTganWBg1MFVDs3MeXH4aw8aur1q2VOvr2GKwUFf/t936TAq",
"reEnterEmail": "merchant.admin@gmail.com",
"merchantName": null,
"language": null,
"merchantCode": null,
"passwordAlreadyExists": false,
"currentPasswordValid": false,
"principal": null,
"userSession": null,
"selectedRoles": ["MERCHANT_ADMIN"],
"numberOfInactiveLoginDays": null,
"pwdStrengthPercentage": 100,
"reEnterPasswordStrengthPercentage": 100
}
Response¶
{
"country": "USA",
"addressLine1": "4500 SE",
"addressLine2": "Pine Valley Street",
"addressLine3": null,
"city": "Port St.Lucie",
"state": "IA",
"zipCode": "30097",
"streetNumber": null,
"streetName": null,
"id": 340,
"userName": "merchant.admin",
"password": "$2a$11$Nd7xZkTganWBg1MFVDs3MeXH4aw8aur1q2VOvr2GKwUFf/t936TAq",
"status": {
"name": "ACTIVE"
},
"firstName": "Merchant",
"lastName": "Admin",
"phone": "",
"mobile": "",
"fax": "",
"jobTitle": "Manager",
"department": "Finance",
"roles": [{
"id": 1179,
"roleType": {
"name": "MERCHANT_ADMIN"
},
"checked": true,
"lastModifiedUserId": null
}],
"userChannelMap": [{
"id": 265,
"cardNotPresentChannel": {
"id": 1,
"channelName": "Sandpiper Bay Channel",
"channelStatus": {
"name": "ACTIVE"
},
"channelType": {
"name": "INTERNAL"
},
"createdDateTime": 1477321991000,
"merchantId": 1,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 1,
"lastModifiedUserId": 340,
"industryType": {
"name": "ECOMMERCE"
},
"allowCashAsPaymentMethodInd": false,
"allowMoneyOrderAsPaymentMethodInd": false,
"allowPaperCheckAsPaymentMethodInd": false,
"allowEStoreCreditAsPaymentMethodInd": false,
"paymentMethods": [{
"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": 340,
"createdDateTime": 1535409349000,
"lastUpdatedDateTime": 1545671577000,
"position": 13
},
{
"id": 242,
"paymentMethodType": {
"value": "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": 340,
"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": 340,
"createdDateTime": 1536677090000,
"lastUpdatedDateTime": 1545671577000,
"position": 31
},
{
"id": 1034,
"paymentMethodType": {
"value": "Gift Card",
"name": "GIFT_CARD"
},
"paymentGateway": {
"value": "Chase Paymentech (Orbital)",
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"cardBrand": {
"value": "Gift Card",
"name": "GIFT_CARD"
},
"cardId": null,
"createdUserId": 340,
"lastModifiedUserId": 340,
"createdDateTime": 1584369058000,
"lastUpdatedDateTime": null,
"position": 40
}
],
"allowDynamicRoutingCapabilityInd": true,
"secondaryPaymentGateway": {
"value": "Chase Paymentech (NetConnect - Direct To Tandem)",
"name": "CHASE_PAYMENTECH_NETCONNECT"
},
"tertiaryPaymentGateway": {
"value": "Chase Paymentech (NetConnect - Direct To Tandem)",
"name": "CHASE_PAYMENTECH_NETCONNECT"
},
"userCount": null,
"assignedPaymentMethods": null,
"message": null,
"paymentMethodsCount": null,
"merchantName": null
},
"cardPresentChannel": {
"id": 1,
"channelName": "Sandpiper Bay Channel",
"channelStatus": {
"name": "ACTIVE"
},
"channelType": {
"name": "INTERNAL"
},
"createdDateTime": 1477321991000,
"merchantId": 1,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 1,
"lastModifiedUserId": 340,
"industryType": {
"name": "ECOMMERCE"
},
"allowCashAsPaymentMethodInd": false,
"allowMoneyOrderAsPaymentMethodInd": false,
"allowPaperCheckAsPaymentMethodInd": false,
"allowEStoreCreditAsPaymentMethodInd": false,
"paymentMethods": [{
"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": 340,
"createdDateTime": 1535409349000,
"lastUpdatedDateTime": 1545671577000,
"position": 13
},
{
"id": 242,
"paymentMethodType": {
"value": "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": 340,
"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": 340,
"createdDateTime": 1536677090000,
"lastUpdatedDateTime": 1545671577000,
"position": 31
},
{
"id": 1034,
"paymentMethodType": {
"value": "Gift Card",
"name": "GIFT_CARD"
},
"paymentGateway": {
"value": "Chase Paymentech (Orbital)",
"name": "CHASE_PAYMENTECH_ORBITAL"
},
"cardBrand": {
"value": "Gift Card",
"name": "GIFT_CARD"
},
"cardId": null,
"createdUserId": 340,
"lastModifiedUserId": 340,
"createdDateTime": 1584369058000,
"lastUpdatedDateTime": null,
"position": 40
}
],
"allowDynamicRoutingCapabilityInd": true,
"secondaryPaymentGateway": {
"value": "Chase Paymentech (NetConnect - Direct To Tandem)",
"name": "CHASE_PAYMENTECH_NETCONNECT"
},
"tertiaryPaymentGateway": {
"value": "Chase Paymentech (NetConnect - Direct To Tandem)",
"name": "CHASE_PAYMENTECH_NETCONNECT"
},
"userCount": null,
"assignedPaymentMethods": null,
"message": null,
"paymentMethodsCount": null,
"merchantName": null
},
"lastModifiedUserId": null
}],
"oldEmail": "",
"email": "merchant.admin@gmail.com",
"locale": "en_US",
"lastLoginDateTime": 1695390888000,
"securityQuestionsEnrolledInd": true,
"createdUserId": 340,
"lastModifiedUserId": 1,
"firstLoginDateTime": 1561039438000,
"maximumAllowedLoginDays": 99999,
"organizationName": "Club Med Management Services, Inc.",
"forceChangePasswordInd": false,
"originalUserId": null,
"loyaltyStatus": {
"name": "NOT_APPLICABLE"
},
"loyaltyRewardsNumber": null,
"loyaltyEnrolledDateTime": null,
"loyaltyTierLevel": {
"name": "NONE"
},
"totalOutstandingPoints": null,
"forgotPasswordGeneratedDateTime": null,
"numberOfFailedLoginAttempts": 0,
"numberOfFailedForgotPasswordAttempts": 0,
"changePasswordDateTime": 1691177238000,
"lockedDateTime": null,
"lockedByUserId": null,
"merchantId": 1,
"createdDateTime": 1591024280000,
"forceChangeSecurityQuestionsInd": false,
"passwordNeverExpiresInd": false,
"phoneCountryCallingCodeId": 1,
"mobileCountryCallingCodeId": 1,
"faxCountryCallingCodeId": 1,
"acceptTermsOfUseAgreementInd": true,
"acceptPrivacyPolicyAgreementInd": true,
"namePrefix": null,
"nameSuffix": null,
"middleInitial": "vela",
"paymentAction": {
"name": "SALE"
},
"mobilePhoneCarrierType": {
"emailDomain": "NUMBER@txt.att.net",
"value": "AT&T",
"countryCode": "USA",
"name": "ATT"
},
"transactionCategory": {
"name": "CARD_NOT_PRESENT"
},
"textMessageType": {
"name": "WHATSAPP"
},
"customer": null,
"oneTimePasscode": "38608085",
"oneTimePasscodeCreatedDateTime": 1695391143284,
"numberOfFailedOneTimePasscodeAttempts": 0,
"gender": null,
"message": {
"code": "199",
"type": {
"name": "SUCCESS"
},
"include_i_icon": false,
"description": "An Email and/or text message is on it's way with your One-time Passcode. Once you recieve your code, enter it below to verify your identity, and click Submit."
},
"customerId": 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,
"numberOfInactiveLoginDays": null
}
Updated As Of 5.9.0.7