Skip to main content

KycSession

KYC Session model.

    merchantRefNum MerchantReferenceNumber (string)required

    Possible values: <= 255 characters

    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.

    returnUrl url

    The return URL to which users must be redirected after competing the required activities in Paysafe hosted UI.

    language string

    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

    id string

    Generated sessionId

    customerId string

    Possible values: <= 40 characters

    Merchant's Paysafe wallet customer id

    externalId ExternalId (string)

    Possible values: non-empty and <= 40 characters

    Customer identifier used in Partner system.

    creationTime date-time

    Session creation time
    Represents RFC 3339, section 5.6 date-time.

    expirationTime date-time

    Session expiration time
    Represents RFC 3339, section 5.6 date-time.

    status KycSessionStatus (string)

    Possible values: [CREATED, INITIATED, CANCELLED, FAILED, ABANDONED, EXPIRED, COMPLETE]

    CREATED: Initial status given upon session creation.
    INITIATED: Once the end customer exchanges their code and enters the KYC flow
    COMPLETE: Customer successfully completes their session.
    CANCELLED: Customer has decided not to complete their session.
    ABANDONED: Customer has not started the KYC flow after session creation.
    EXPIRED: Customer did not complete their verification in time and their session has expired.

    redirectUrl url

    Redirect URL where the user should be redirected to in order to complete some action.