Skip to main content

Customer Credentials Management Initialization Response

Response to the Credentials Management process initiation request.

languagestring

Specifies the language of the content displayed to the customer in the Paysafe Hosted UI.

It follows the ISO 639-1 standard for language codes, with the option to combine them with ISO 3166 Alpha-2 country codes to specify regional language variations. For example the locale code en-US represents English spoken in the USA.

Default value: en
Example: en-US
flowCustomer Credentials Management Flow (string)required

The flow defining the credentials management process:

  • PIN_SETUP - Used for setting up the customer's PIN.
  • PIN_RESET - Used for resetting the customer's PIN.
  • PASSWORD_SETUP - Used for setting up the customer's password.
  • PASSWORD_RESET - Used for resetting the customer's password.

Possible values: [PIN_SETUP, PIN_RESET, PASSWORD_SETUP, PASSWORD_RESET]

returnUrlurlrequired

The return URL to which users must be redirected after completing the required actions in Paysafe hosted UI. The Partner is required to communicate the provided returnUrl to Paysafe in advance for the it to be whitelisted and considered valid.

Once the redirect process is finished, the customer will be redirected back to the Partner, and the returnUrl will be enhanced with extra properties that include relevant details about the SCA authentication process, such as status:

  • status - It holds the outcome of the SCA authentication event, such as success or fail.
Example: https://some-process.paysafe.com/
redirectUrlstringrequired

The URL the customer is directed to, based on the provided input parameters and linked to the current session..

Example: https://auth.paysafe.com/v1/auth/brands/{brandIdentity}/credentials?lang=en_US&fingerprint=19e0abfb...&flow=PIN_SETUP&token=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lk..&processId=...&returnURL=https://.......
Customer Credentials Management Initialization Response
{
  "language": "en-US",
  "flow": "PIN_SETUP",
  "returnUrl": "https://some-process.paysafe.com/",
  "redirectUrl": "https://auth.paysafe.com/v1/auth/brands/{brandIdentity}/credentials?lang=en_US&fingerprint=19e0abfb...&flow=PIN_SETUP&token=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lk..&processId=...&returnURL=https://......."
}