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;
}

Properties

creationTime expirationTime id instrument? instrumentType redirectUrl returnUrl sessionStatus statusReason?

Properties

creationTime

creationTime: string

Creation time.

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

Example

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

expirationTime

expirationTime: string

Expiration time.

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

Example

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

id

id: string

Instrument verification session ID.

Optional instrument

instrument?: PaymentInstrumentReference

The payment instrument.

instrumentType

instrumentType: InstrumentType

The instrument type.

redirectUrl

redirectUrl: string

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

returnUrl

returnUrl: string

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

sessionStatus

sessionStatus: InstrumentVerificationStatus

The status of the verification session.

Optional statusReason

statusReason?: InstrumentVerificationStatusReason

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

Settings

Member Visibility

Theme

On This Page

creationTimeexpirationTimeidinstrumentinstrumentTyperedirectUrlreturnUrlsessionStatusstatusReason