@paysafe/paysafe-wallet-saas-web
    Preparing search index...

    Interface InstrumentVerification

    Represents the verification session for an instrument.

    interface InstrumentVerification {
        creationTime: string;
        expirationTime: string;
        id: string;
        instrument?: PaymentInstrumentReference;
        instrumentType: InstrumentType;
        redirectUrl: string;
        returnUrl: string;
        sessionStatus: InstrumentVerificationStatus;
        statusReason?: InstrumentVerificationStatusReason;
    }
    Index

    Properties

    creationTime expirationTime id instrument? instrumentType redirectUrl returnUrl sessionStatus statusReason?

    Properties

    creationTime: string

    Creation time.

    Format should be ISO 8601 in UTC. Represents RFC 3339, section 5.6 date-time.

    "2024-05-08T14:43:33Z"
    expirationTime: string

    Expiration time.

    Format should be ISO 8601 in UTC. Represents RFC 3339, section 5.6 date-time.

    "2024-05-08T14:43:33Z"
    id: string

    Instrument verification session ID.

    instrument?: PaymentInstrumentReference

    The payment instrument.

    instrumentType: InstrumentType

    The instrument type.

    redirectUrl: string

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

    returnUrl: string

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

    sessionStatus: InstrumentVerificationStatus

    The status of the verification session.

    statusReason?: InstrumentVerificationStatusReason

    Holds information about the customer verification session failure reason. It helps determine the next course of action.

    Settings

    Member Visibility

    On This Page

    Properties