Android SDK - User Registration Module

DOCS

Last updated: Aug 15th, 7:40am

The user registration module encompasses all functionality related to creating or updating a mobile wallet registration profile directly through the app.

Service	Description
UI Services	`com.paydiant.android.ui.service.userregistration.UserManagementService` `com.paydiant.android.ui.service.applicationinfo.ApplicationInfoRetrievalService`
Core Services	`com.paydiant.android.core.facade.UserRegistrationManagerFacade` `com.paydiant.android.core.facade.ApplicationInformationManagerFacade`

Set UI Package User Registration Service Listeners

To invoke the callback methods returned by the Paydiant service in response to the methods invoked by the user registration module of the SDK, the developer must set an implementation of the applicable listener interfaces in the UI Services class.

Note: Some methods of the user registration module are implemented by the ApplicationInfoRetrievalService class, so be sure to invoke the appropriate listener.

Item	Description
Set User Listener	`void setUserManagementServiceListener (IUserManagementListener listener);` `com.paydiant.android.ui.service.userregistration.IUserManagementListener` or an overridden instance of `com.paydiant.android.ui.service.userregistration.UserManagementListenerAdapter`
Set App Info Listener	`ApplicationInfoRetrievalService.setApplicationInfoRetrievalListener(IApplicationInfoRetrievalListener);` `com.paydiant.android.ui.service.applicationinfo.IApplicationInfoRetrievalListener` or an overridden instance of `com.paydiant.android.ui.service.applicationinfo.ApplicationInfoRetrievalListenerAdapter`
Remove Listener	`void removeListener();` Call this method from within the corresponding service class in order to remove the associated listener and set it to null.

Retrieve Client Token

Use this method to retrieve the client token required to initializes the PayPal SDK. Mobile Wallet issuers who have enabled support for an integrated PayPal user experience can launch the PayPal mobile integration from within the app.

For more information about implementing PayPal integration functionality in your wallet, refer to the PayPal Integration Guide.

Item	Description
UI Method	`void getClientToken(ClientTokenParameters clientTokenParameters);` `clientTokenParameters` - Parameters of the client token, including the provider of the client token and optional provider data.
Success	`void onClientTokenRetrieveSuccess (ClientToken clientToken);` `clientToken` - The token used to initialize the PayPal SDK.
Failure	`void onUserRegistrationError (PaydiantException exception);` The failure callback returns an instance of `PaydiantException` detailing the nature of the failure identified by relevant error codes.
Core Method	`public ClientToken getclientToken(ClientTokenParameters clientTokenParameters);` `clientTokenParameters` - Parameters of the client token, including the provider of the client token and optional provider data. Returns raw output for the requested client token or relevant exception.

Errors

The following error is relevant when requesting a client token:

Error	Description
`500`	An unknown error occurred internally in the server.

Validate Device

Use this method to check whether the mobile device on which the app is running is associated with an active wallet registration and has not been locked or otherwise disabled so you can determine what launch screen to display, if applicable.

Item	Description
UI Method	`void validateDeviceStatus (DeviceInfo deviceInfo);` `deviceInfo` - An instance of the object that identifies the attributes of the mobile device, such as its ID and name, that allow Paydiant to identify it in the platform.
Success	`void onValidateDeviceStatusSuccess (DeviceState deviceState);` `deviceState` - An object that specifies the results of the device status check, indicating whether the device is registered and active in the Paydiant system.
Failure	`void onUserRegistrationError (PaydiantException exception);` The failure callback returns an instance of `PaydiantException` for the `VALIDATE_DEVICE_STATUS_EVENT`, detailing the nature of the failure identified by relevant error codes.
Core Method	`public DeviceState validateDeviceStatus(DeviceInfo deviceInfo);` `deviceInfo` - An instance of the object that identifies the attributes of the mobile device, such as its ID and name, that allow Paydiant to identify it in the platform. returns raw output for the `deviceState` results or relevant exception.

Errors

When creating a new user registration, the following errors are applicable for the VALIDATE_DEVICE_STATUS_EVENT:

Error	Description
`426`	The application or SDK version is outdated and requires an update.
`500`	An unknown error occurred internally in the server.

Retrieve MFA Questions

Multi-factor Authentication (MFA) questions are used as a source of secondary identification and authentication to grant a user access to a wallet account. Often, the user is required to provide answers for a certain number of questions in order to register, but may choose which questions from a larger pool.

Use this method to retrieve the full set of available questions in order to present them to the user for selection and response submission based on the requirements specified by the wallet issuer.

Item	Description
UI Method	`void retrieveMfaQuestions();`
Success	`void onRetrieveMfaQuestionsSuccess(MFAQuestionList mfaQuestionList);` `mfaQuestionList` - The set of questions available for selection as secondary questions for this wallet issuer. Depending on the issuer configuration, the questions may be returned as a set of strings, or as a set of `MFAQuestion` objects containing metadata related to the question’s status and requirement. The list will also specify the number of questions from the set that the user is required to answer in order to register.
Failure	`void onUserRegistrationError (PaydiantException exception);` The failure callback returns an instance of `PaydiantException` for the `RETRIEVE_MFA_QUESTIONS_EVENT`, detailing the nature of the failure identified by relevant error codes.
Core Method	`public MFAQuestionList retrieveMfaQuestions();` Returns raw output for the list of MFA Questions or relevant exception.

Errors

When retrieving the set of available MFA questions, the following errors are applicable for the RETRIEVE_MFA_QUESTIONS_EVENT:

Error	Description
`500`	An unknown error occurred internally in the server.

Retrieve App Policy Information

Use these methods to obtain the mobile wallet’s legal content in order to display it in the app.

Note: These methods are called by the ApplicationInfoRetrievalService class, so be sure to set the appropriate listener interface.

Item	Description
UI Methods	`void retrieveTermsOfUse();` `void retrievePrivacyPolicy();`
Success	`void RetrieveTermsOfUseSuccess(String termsOfUse);` `void RetrievePrivacyPolicySuccess(String privacyPolicy);` `termsOfUse` - The content of the legal terms of use agreement, as provided by the app issuer. `privacyPolicy` - The content of the legal privacy policy, as provided by the app issuer.
Failure	`void onApplicationInfoRetrievalError (PaydiantException exception);` The failure callback returns the `PaydiantException` for the relevant event (`RETRIEVE_PRIVACY_POLICY_EVENT` or `RETRIEVE_TERMS_OF_USE_EVENT`) detailing the nature of the failure identified by relevant error codes.
Core Method	`public String retrieveTermsOfUse();` `public String retrievePrivacyPolicy();` Returns raw output for the requested legal policy content or relevant exception.

Errors

The following errors apply to the RETRIEVE_PRIVACY_POLICY_EVENT or the RETRIEVE_TERMS_OF_USE_EVENT:

Error	Description
`500`	An unknown error occurred internally in the server.

Retrieve Password Policy Configuration

Use this method to retrieve the password rules set by the wallet issuer about the level of complexity required for the password value. Use these details to warn users of requirments to prevent failure due to password non-compliance. For example, the policy configuration can indicate if the password requires:

a minimum or maximum number of characters
an uppercase character or a number
a symbol
entry completed before the password will expire

Item	Description
UI Method	`void retrievePasswordPolicyConfiguration();`
Success	`void onRetrievePasswordPolicyConfigurationSuccess (PasswordConfiguration passwordConfiguration);` `passwordConfiguration` - An instance of the object defining the minimum requirements for password values, such as the combination of an uppercase letter, a lowercase letter and a number.
Failure	`void onUserRegistrationError (PaydiantException exception);` The failure callback returns the `PaydiantException` for the relevant event `RETRIEVE_PASSWORD_POLICY_CONFIGURATION_EVENT` detailing the nature of the failure identified by relevant error codes.
Core Method	`public PasswordConfiguration retrievePasswordPolicyConfiguration();` Returns raw output for the password configuration rules or relevant exception.

Errors

The following errors apply to the RETRIEVE_PASSWORD_POLICY_CONFIGURATION_EVENT:

Error	Description
`500`	An unknown error occurred internally in the server.

Retrieve Passcode Policy Configuration

Use this method to retrieve the passcode (PIN) rules set by the wallet issuer about the level of complexity required for the passcode value. Use these details to warn users of requirments to prevent failure due to password non-compliance. For example, the policy configuration can indicate if the passcode requires:

a minimum or maximum number of digits
that the sequence not repeat
a range of expected numbers
entry completed before the password will expire

Item	Description
UI Method	`void retrievePasscodeConfiguration();`
Success	`void onRetrievePasscodeConfigurationSuccess (PasscodeConfiguration passcodeConfiguration);` `passcodeConfiguration` - An instance of the object defining the minimum requirements that passcode values must meet.
Failure	`void onUserRegistrationError (PaydiantException exception);` The failure callback returns the `PaydiantException` for the relevant event `RETRIEVE_PASSCODE_CONFIGURATION_EVENT` that details the nature of the failure identified by relevant error codes.
Core Method	`public PasscodeConfiguration retrievePasscodeConfiguration();` Returns raw output for the passcode configuration rules or relevant exception.

Errors

The following error applies to the RETRIEVE_PASSCODE_CONFIGURATION_EVENT:

Error	Description
`500`	An unknown error occurred internally in the server.

Register User

Use this method to submit the profile data input by a user during the new registration screen flow in order to create a new mobile wallet registration.

Item	Description
UI Method	`void registerUser(CreateCustomer createCustomer);` `createCustomer` - An instance of the object that specifies the values that are required by the issuer for a new mobile wallet registration, as input by the user and collected from the device properties.
Success	`void onRegisterUserSuccess(CreatedCustomer createdCustomer);` `createdCustomer` - An object that confirms the successful completion of the new registration and profile values.
Failure	`void onUserRegistrationError (PaydiantException exception);` The failure callback returns an instance of `PaydiantException` for the `REGISTER_USER_EVENT`, detailing the nature of the failure identified by relevant error codes.
Core Method	`public CreatedCustomer registerUser(CreateCustomer customer);` `customer` - An instance of the object that specifies the values that are required by the issuer for a new mobile wallet registration, as input by the user and collected from the device properties. Returns raw output for the registration status or relevant exception.

Errors

When creating a new user registration, the following errors are applicable for the REGISTER_USER_EVENT:

Error	Description
`400`	One or more required parameters is missing or invalid.
`416`	The specified email address is already in use by an existing wallet.
`418`	Mobile gateway email verification is enabled, but device email
`419`	Password field level validation failed.
`420`	Passcode field level validation failed.
`500`	An unknown error occurred internally in the server.

Register SSO Customer

Paydiant’s SSO framework allows issuers to integrate mobile payments functionality into their existing apps and pull profile data from the external system in order to register a new user in the Paydiant system, allowing for a seamless user experience between the two apps. Call this overloaded method to register a new user, populating the Customer object with the profile data pulled from the external Identity Provider (IDP).

Call the Retrieve SSO Customer Profile Metadata method to pull the profile metadata values for registration.

Item	Description
UI Method	`void registerUser(Customer customer);` `customer` - An instance of the object that specifies the values that are required for a new mobile wallet registration, as obtained from the SSO Identity Provider (IDP) and collected from the device properties.
Success	`void onRegisterUserSuccess(RegisterCustomerResponse customerResponse);` `customerResponse` - An object that confirms the successful completion of the new registration and profile values.
Failure	`void onUserRegistrationError (PaydiantException exception);` The failure callback returns an instance of `PaydiantException` for the `REGISTER_IDP_USER_EVENT`, detailing the nature of the failure identified by relevant error codes.
Core Method	`public RegisterCustomerResponse registerUser(Customer customer);` `customer` - An instance of the object that specifies the values required for a new mobile wallet registration, as obtained from the SSO Identity Provider and collected from the device properties. Returns raw output for the registration status or relevant exception.

Errors

When creating a new user registration, the following errors are applicable for the REGISTER_IDP_USER_EVENT:

Error	Description
`400`	One or more required parameters is missing or invalid.
`401`	Unauthorized due to invalid nonce.
`408`	Passcode field level validation failed.
`410`	MFA input is required.
`416`	The specified email address is already in use by an existing wallet.
`500`	An unknown error occurred internally in the server.

Retrieve SSO Customer Profile Metadata

Paydiant’s SSO framework allows issuers to integrate mobile payments functionality into their existing apps and manage user profiles and authentication in their own identity provider (IDP).

If the user does not already have a profile in the issuer’s external system, this method will obtain the profile properties required by the issuer so they can be displayed for user input in the app to create a new registration through the SSO framework.

Item	Description
UI Method	`void retrieveCustomerProfileMetaData(CustomerMetaDataParametersProxied customerMetaDataParametersProxied);` `customerMetaDataParametersProxied` - An object that passes the authorization code and relevant IDP from which profile information is requested, plus specifies the properties to return.
Success	`void onRetrieveCustomerProfileMetaData(CustomerMetaData customerMetaData);` `customerMetaData` - An object instance containing the requested profile metadata from the external system for use in populating Paydiant’s profile, as well as the one-time session code (nonce) that will allow the user’s first login to the Paydiant app for device registration.
Failure	`void onUserRegistrationError (PaydiantException exception);` The failure callback returns an instance of `PaydiantException` for the `RETRIEVE_CUSTOMER_PROFILE_METADATA_EVENT`, detailing the nature of the failure identified by relevant error codes.
Core Method	`public CustomerMetaData retrieveCustomerProfileMetaData(CustomerMetaDataParametersProxied customerMetaDataParametersProxied);` `customerMetaDataParametersProxied` - An instance of the class that identifies the IDP credentials (`authorizationCode` and `IdentityProvider`), as well as needed device properties. Returns raw output for the retrieval status or relevant exception.

Errors

When creating a new user registration, the following errors are applicable for the RETRIEVE_CUSTOMER_PROFILE_METADATA_EVENT:

Error	Description
`400`	One or more required parameters is missing or invalid.
`401`	Unauthorized due to invalid authorization code.
`500`	An unknown error occurred internally in the server.

Resend Email Verification Email

When a wallet issuer’s partner configuration has email verification enabled, an email is sent to a newly registered user to verify that the address input during registration is a valid email account to which the user has access. Once the user responds to the email, the account is considered verified and the user can log in. Use this method to provide a means by which the user can request to have the email resent.

Item	Description
UI Method	`void resendVerificationEmail(String username);` `username` - The username associated with the logged-in user, which provides the registration lookup for the purpose of identifying the email address to which the verification email will be sent.
Success	`void onResendVerificationEmailSuccess(String message);` `message` - An object that confirms resending of the email and the address to which it was sent.
Failure	`void onUserRegistrationError (PaydiantException exception);` The failure callback returns an instance of `PaydiantException` for the `RESEND_VERIFICATION_EMAIL_EVENT`, detailing the nature of the failure identified by relevant error codes.
Core Method	`String resendVerificationEmail(String username);` `username` - The username associated with the logged-in user, which provides the registration lookup for the purpose of identifying the email address to which the verification email will be sent. Returns raw output for the resend or relevant exception.

Note: Often, the username value is populated with the email address, but the lookup logic requires the username value, nonetheless, for backward compatibility and security.

Errors

When creating a new user registration, the following errors are applicable for the RESEND_VERIFICATION_EMAIL_EVENT:

Error	Description
`500`	An unknown error occurred internally in the server.

Resend Application Verification Email

When a user attempts to link an existing wallet registration to a new device by logging into the app from an unknown device, Paydiant sends a verification email to the address associated with that wallet to ensure that the new application instance is, in face, intended and authorized by the wallet owner. If the wallet owner does not verify the app instance, upon the next login attempt, the app developer can handle the unverified app instance error returned by the SDK (error 511) by providing a means by which the user can request that the email be resent and invoking this call.

Item	Description
UI Method	`void resendAppInstanceVerificationEmail(String usernameOrEmail);` `usernameOrEmail` - The username or email address associated with wallet into which the user is attempting to log-in, which provides the registration lookup for the purpose of identifying the email address to which the verification email will be sent.
Success	`void onResendAppInstanceVerificationEmailSuccess();`
Failure	`void onUserRegistrationError (PaydiantException exception);` The failure callback returns an instance of PaydiantException for the `RESEND_APP_INSTANCE_VERIFICATION_EMAIL_EVENT`, detailing the nature of the failure identified by relevant error codes.
Core Method	`resendAppInstanceVerificationEmail(String usernameOrEmail, String deviceId;, String deviceTypeName);` `usernameOrEmail` - The username or email address associated with wallet into which the user is attempting to log-in, which provides the registration lookup for the purpose of identifying the email address to which the verification email will be sent. `deviceId` - The manufacturer’s unique identifier of the device. `deviceTypeName` - The manufacturer identifier of the type of Android device (for example, Samsung Galaxy). This mentod returns no payload for success; relevant exception for failure.

Errors

When resending the app verification email, the following errors are applicable for the RESEND_APP_INSTANCE_VERIFICATION_EMAIL_EVENT:

Error	Description
`500`	An unknown error occurred internally in the server.

Update User

Use this method to update the profile of an existing wallet with any changed values input by the user in the update profile screen flow.

If the user profile includes custom defined additionalCustomerInformation properties, changes are applied based on the following specifications in the passed object:

Properties that are included in the object with a specified value are updated with the passed value. If the passed value is the same as the existing value, the ModifiedDate for the property will still reflect that a change was made.
Properties that are omitted from the object instance remain unchanged.
Properties that are included in the object with a null value are deleted from the record.

Note: If the externalId property of the customer object is populated prior to the update, persist the same value in the update request to preserve its population. A null value is treated as a deletion.

Item	Description
UI Method	`void updateUser(UpdateCustomer updateCustomer);` `updateCustomer` - An instance of the object that contains the updated profile data values input by the user.
Success	`void onUpdateUserSuccess(UpdatedCustomerStatus updatedCustomerStatus);` `updatedCustomerStatus` - An object relaying the successful completion of the updated values.
Failure	`void onUserRegistrationError (PaydiantException exception);` The failure callback returns an instance of `PaydiantException` for the `UPDATE_USER_EVENT`, detailing the nature of the failure identified by relevant error codes.
Core Method	`public UpdatedCustomerStatus updateUser(UpdateCustomer updateCustomer);` `updateCustomer` - An instance of the object that contains the updated profile data values input by the user. Returns raw output for the update status or relevant exception.

Errors

When updating the MFA questions responses for a user, the following errors are applicable for the UPDATE_USER_EVENT:

Error	Description
`400`	One or more required parameter values are missing or invalid.
`406`	The password provided has been used previously for this registration. Password updates must be unique in the user’s history.
`416`	The specified email address is already in use by an existing mobile wallet and cannot be used for this wallet.
`420`	The password provided does not meet the minimum requirements.
`500`	An unknown error occurred internally in the server.

Update MFA Responses

Use this method to submit a user-initiated update to the MFA Question responses associated with the user’s wallet profile. For MFA question and answer updates, the following behavior is enforced:

The app must populate the updatedMFAAnsweres instance with the exact number of required MFA question/answer key-value pairs, as specified in the numberOfRequiredQuestions value of the mfaQuestionList instance returned in the Retrieve MFA Questions callback.
If the updatedMFAAnswers instance contains fewer or more question/answer pair definitions than the specified required number, the update operation will fail.
Once updated, previously set question/answer values are deleted from the user profile.

Item	Description
UI Method	`void updateMfaAnswers(updateMFAAnswers);` `updateMFAAnswers` - A map object of key-value strings representing the MFA questions to be updated and the corresponding new answers. The key identifies the question and the value that is populated with the new answer input by the user.
Success	`void onUpdateMfaAnswersSuccess(UpdatedMFAAnswersStatus updatedMFAAnswersStatus);` `updatedMFAAnswersStatus` - An object relaying the successful completion of the updated values.
Failure	`void onUserRegistrationError (PaydiantException exception);` The failure callback returns an instance of `PaydiantException` for the `UPDATE_MFA_ANSWERS_EVENT`, detailing the nature of the failure identified by relevant error codes.
Core Method	`public UpdatedMFAAnswersStatus updateMfaAnswers(UpdateMFAAnswers updateMFAAnswers);` `updateMFAAnswers` - A map object of key-value strings representing the MFA questions to be updated and the corresponding new answers. The key identifies the question and the value is populated with the new answer input by the user. Returns raw output for the update status or relevant exception.

Errors

When updating the MFA questions responses for a user, the following errors are applicable for the UPDATE_MFA_ANSWERS_EVENT:

Error	Description
`500`	An unknown error occurred internally in the server.

Update Password

Use this method to update an existing user wallet with a changed password provided by the logged-in user.

Item	Description
UI Method	`void updateUserPassword (UpdatePassword updatePassword);` `updatePassword` - An instance of the object specifying the input parameters for the password update request, including the current value, the proposed new value and the confirmed new value.
Success	`void onUpdateUserPasswordSuccess(UpdatedPasswordStatus updatedPasswordStatus);` `updatedPasswordStatus` - An object relaying the successful completion of the updated value.
Failure	`void onUserRegistrationError (PaydiantException exception);` The failure callback returns an instance of `PaydiantException` for the `UPDATE_USER_PASSWORD_EVENT`, detailing the nature of the failure identified by relevant error codes.
Core Method	`public UpdatedPasswordStatus updateUserPassword(UpdatePassword updatePassword);` `updatePassword` - An instance of the object specifying the input parameters for the password update request, including the current value, the proposed new value and the confirmed new value. Returns raw output for the update status or relevant exception.

Errors

When updating a user’s password value, the following errors are applicable for the UPDATE_USER_PASSWORD_EVENT:

Error	Description
`400`	One or more required parameter values is missing or invalid.
`406`	The proposed password has already been used within a period defined by the issuer as requiring unique password updates.
`416`	The current password provided is not correct.
`417`	The proposed password and confirmation values do not match.
`419`	The password provided does not meet the minimum requirements stipulated by the issuer.
`500`	An unknown error occurred internally in the server.

Update Passcode

Use this method to update an existing user wallet with a changed passcode (PIN) provided by the logged-in user.

Item	Description
UI Method	`void updateUserPasscode (UpdatePasscode updatePasscode);` `updatePasscode` - An instance of the object specifying the input parameters for the passcode update request, including the current value, the proposed new value and the confirmed new value.
Success	`void onUpdateUserPasscodeSuccess(UpdatedPasscodeStatus updatedPasscodeStatus);` `updatedPasscodeStatus` - An object relaying the successful completion of the updated value.
Failure	`void onUserRegistrationError (PaydiantException exception);` The failure callback returns an instance of `PaydiantException` for the `UPDATE_USER_PASSCODE_EVENT`, detailing the nature of the failure identified by relevant error codes.
Core Method	`public UpdatedPasscodeStatus updateUserPasscode(UpdatePasscode updatePasscode);` `updatePasscode` - An instance of the object specifying the input parameters for the passcode update request, including the current value, the proposed new value and the confirmed new value. Returns raw output for the update status or relevant exception.

Errors

When updating a user’s password value, the following errors are applicable for the UPDATE_USER_PASSCODE_EVENT:

Error	Description
`400`	One or more required parameter values is missing or invalid.
`416`	The current passcode value provided is not correct.
`420`	The passcode provided does not meet the minimum requirements stipulated by the issuer.
`500`	An unknown error occurred internally in the server.

Forgot Password

Use this method to initiate a login support request when the forgot password button is activated, which sends an email to the registered email address of the user containing a link that redirects the user to a secure site where the password can be reset once the user correctly answers the secret questions.

Item	Description
UI Method	`void forgotPassword(ForgotPassword forgotPassword);` `forgotPassword` - An instance of the object containing the username associated with the logged-in user, which provides the lookup to obtain the email address to which the reset link will be sent.
Success	`void onForgotPasswordUsernameSubmissionSuccess (ForgotPasswordStatus forgotPasswordStatus);` `forgotPasswordStatus` - An object relaying the successful completion of the reset operation.
Failure	`void onUserRegistrationError (PaydiantException exception);` The failure callback returns an instance of `PaydiantException` for the `FORGOT_PASSWORD_EVENT`, detailing the nature of the failure identified by relevant error codes.
Core Method	`public ForgotPasswordStatus forgotPassword(ForgotPassword forgotPassword);` `forgotPassword` - An instance of the object containing the username associated with the logged-in user, which provides the lookup to obtain the email address to which the reset link will be sent. Returns raw output for the email transmission status or relevant exception.

Note: The username value is often also the email address, but the lookup logic requires the username value, nonetheless, for backward compatibility and security

Errors

When updating a user’s password value, the following errors are applicable for the FORGOT_PASSWORD_EVENT:

Error	Description
`400`	One or more required parameter values is missing or invalid.
`410`	The username does not match that of a registered user.
`500`	An unknown error occurred internally in the server.

Forgot Passcode

Use this method to initiate a login support request when the Forgot Passcode button is activated, which sends an email to the registered email address of the user containing a link that redirects the user to a secure site where the passcode can be reset once the user correctly answers the secret questions.

Item	Description
UI Method	`void forgotPasscode(ForgotPasscode forgotPasscode);` `forgotPasscode` - An instance of the object containing the username associated with the logged-in user, which provides the lookup to obtain the email address to which the reset link will be sent.
Success	`void onForgotPasscodeUsernameSubmissionSuccess (ForgotPasscodeStatus forgotPasscodeStatus);` `forgotPasscodeStatus` - An object relaying the successful completion of the reset operation.
Failure	`void onUserRegistrationError (PaydiantException exception);` The failure callback returns an instance of `PaydiantException` for the `FORGOT_PASSCODE_EVENT`, detailing the nature of the failure identified by relevant error codes.
Core Method	`public ForgotPasscodeStatus forgotPasscode (ForgotPasscode forgotPasscode);` `forgotPasscode` - An instance of the object containing the username associated with the logged-in user, which provides the lookup to obtain the email address to which the reset link will be sent. Returns raw output for the email transmission status or relevant exception.

Note: The username value is often also the email address, but the lookup logic requires the username value, nonetheless, for backward compatibility and security.

Errors

When updating a user’s password value, the following errors are applicable for the FORGOT_PASSCODE_EVENT:

Error	Description
`400`	One or more required parameter values is missing or invalid.
`410`	The username does not match that of a registered user.
`500`	An unknown error occurred internally in the server.

Change Expired Password

Use this method to update a password value that has expired with a new value input by the user.

Item	Description
UI Method	`void updateExpiredPassword (UpdateExpiredPassword updateExpiredPassword);` `updateExpiredPassword` - An instance of the object specifying the input parameters for the passcode update request, including the username string, and the old, new, and confirmed new passwords.
Success	`void onUpdateExpiredPasswordSuccess (UpdatedExpiredPasswordStatus updatedExpiredPasswordStatus);` `updatedExpiredPasswordStatus` - An object relaying the successful completion of the updated value.
Failure	`void onUserRegistrationError (PaydiantException exception);` The failure callback returns an instance of `PaydiantException` for the `UPDATE_EXPIRED_PASSWORD_EVENT`, detailing the nature of the failure identified by relevant error codes.
Core Method	`public UpdatedExpiredPasswordStatus updateExpiredPassword (UpdateExpiredPassword updateExpiredPassword);` `updateExpiredPassword` - An instance of the object specifying the input parameters for the passcode update request, including the username string, and the old, new, and confirmed new passwords. Returns raw output for the update status or relevant exception.

Errors

When updating a user’s password value, the following errors are applicable for the UPDATE_EXPIRED_PASSWORD_EVENT:

Error	Description
`400`	One or more required parameter values is missing or invalid.
`406`	The proposed password has already been used within a period defined by the issuer as requiring unique password updates.
`416`	The current password provided is not correct.
`417`	The proposed password and confirmation values do not match.
`419`	The password provided does not meet the minimum requirements stipulated by the issuer.
`500`	An unknown error occurred internally in the server.

Android SDK - User Registration Module

Set UI Package User Registration Service Listeners

Retrieve Client Token

Errors

Validate Device

Errors

Retrieve MFA Questions

Errors

Retrieve App Policy Information

Errors

Retrieve Password Policy Configuration

Errors

Retrieve Passcode Policy Configuration

Errors

Register User

Errors

Register SSO Customer

Errors

Retrieve SSO Customer Profile Metadata

Errors

Resend Email Verification Email

Errors

Resend Application Verification Email

Errors

Update User

Errors

Update MFA Responses

Errors

Update Password

Errors

Update Passcode

Errors

Forgot Password

Errors

Forgot Passcode

Errors

Change Expired Password

Errors

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more