Skip to main content

Initiate a Customer Credentials Management Process

POST 
/v2/customers/:customerId/credentials

Initiates Customer Credentials Management process. Based on the provided flow and returnUrl, a redirectUrl will be returned to where the customer must be redirected in order to complete the operation:

  • returnUrl - should contain the location where the customer will be redirected after completing the required actions in Paysafe hosted UI. It must be on a Paysafe-whitelisted partner domain.
  • redirectUrl - redirect url associated with this session. The url contains Paysafe hosted UI, that carries the user through the credentials setup process. It has a short expiration time and will not be usable after it expires.

The Paysafe Hosted UI guides the customer through the management of the wallet credentials step by step. After successfully finishing the process the customer is being redirected back to the provided returnUrl. The behavior of the Paysafe Hosted UI changes depending on the flow attribute:

  • PASSWORD_SETUP / PIN_SETUP - the customer completes the credentials setup process and is automatically logged in upon successful completion.
  • PASSWORD_RESET / PIN_RESET - the customer completes the credentials reset process and, after being redirected to the partner's returnUrl, must manually log in.

Request​

Responses​

OK