Skip to main content

KycSessionRequest

Request issued for creating a KYC session. The provided returnUrl will be used to redirect the customer at the end of the flow. If no return url is provided, the default return url will be used.

merchantRefNumMerchantReferenceNumber (string)required

This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system to embedded wallet objects.

Possible values: <= 255 characters

Example: 4bc2deb3-9766-4598-a08e-a98b60615936
returnUrlurl

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/
languagestring

Renders content for the merchant customer in the specified language. If not provided, the application will default to 'en'. Supported values are:
en
en-GB
cs-CZ
de-DE
el-GR
en-US
es-ES
es-US
fr-FR
it-IT
ko-KR
pl-PL
pt-BR
pt-PT
ru-RU
tr-TR
zh-CN

Example: en
KycSessionRequest
{
  "merchantRefNum": "4bc2deb3-9766-4598-a08e-a98b60615936",
  "returnUrl": "https://some-process.paysafe.com/",
  "language": "en"
}