Skip to main content

Instrument Verification with Secure Code

Manages a session of adding customer bank account.

    instrumentType InstrumentType (string)required

    Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT, CCI_BANK_ACCOUNT, CARD]

    Represents the type of the instrument.

    | Value | Description| |---|---| | SEPA_BANK_ACCOUNT| SEPA Bank account | | UK_BANK_ACCOUNT | UK Bank account | | US_BANK_ACCOUNT | US Bank account | | CCI_BANK_ACCOUNT | CCI Bank account | | CARD | Card |

    returnUrl urlrequired

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

    id stringrequired

    Instrument verification session ID

    redirectUrl urlrequired

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

    creationTime date-timerequired

    Represents RFC 3339, section 5.6 date-time.

    expirationTime date-timerequired

    Represents RFC 3339, section 5.6 date-time.

    instrument

    object

    Represents a reference to a Payment Instrument, used for Deposit or Withdrawal.

    id stringrequired

    Instrument identifier.

    instrumentType InstrumentType (string)required

    Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT, CCI_BANK_ACCOUNT, CARD]

    Represents the type of the instrument.

    | Value | Description| |---|---| | SEPA_BANK_ACCOUNT| SEPA Bank account | | UK_BANK_ACCOUNT | UK Bank account | | US_BANK_ACCOUNT | US Bank account | | CCI_BANK_ACCOUNT | CCI Bank account | | CARD | Card |

    sessionStatus Instrument Verification Status (string)required

    Possible values: [ACTIVE, ONGOING_VERIFICATION, AWAITING_USER_INPUT, COMPLETED, FAILED]

    Instrument verification session status reflects the current status of the session.

    • ACTIVE - The initial session status when it gets created
    • AWAITING_USER_INPUT - Awaiting user input in order to continue the verification process.
    • ONGOING_VERIFICATION - Payment instrument is obtained and is being verified against customer details in Paysafe.
    • COMPLETED - Verification process is completed, the instrument should be in VERIFIED status.
    • FAILED - Instrument verification failed. Check statusReason for details. If instrument is present in the session, it could be in either UNVERIFIED or in REJECTED status.
    statusReason Instrument Verification Failed Status Reason (string)

    Possible values: [UNSUPPORTED_BANK, NAME_MISMATCH, INSTRUMENT_NOT_UNIQUE, MISSING_DETAILS, INTERNAL_ERROR, SESSION_EXPIRED, USER_ABANDONED_PROCESS, USER_INTERACTION_ERROR, OTHER]

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

    • UNSUPPORTED_BANK - The verification process does not support the Bank.
    • NAME_MISMATCH - The bank account information does not match the customer information in Embedded Wallet. Account can be verified by manual submission of bank statement to Paysafe support.
    • INSTRUMENT_NOT_UNIQUE - Another customer is using the same instrument. Usually this happens when using shared bank account. Contact Paysafe support to resolve the issue.
    • INTERNAL_ERROR - Technical error in Paysafe system. Try adding instrument through new verification session.
    • SESSION_EXPIRED - Verification session expired. Start new verification session.
    • MISSING_DETAILS - Sufficient information could not be obtained by the bank to prove ownerhip.
    • USER_ABANDONED_PROCESS - The user has abondened the instrument verification process without providing enough details about their bank account.
    • USER_INTERACTION_ERROR - An error occurred when user was trying to select their bank account.
    • OTHER - Unexpected error, unable to classify. Contact Paysafe support to resolve the issue.
    secureCode string

    Base64 encoded string containing the secure code for authentication.

    secureCodeMethod string

    Default value: sha512

    The secure code hashing algorithm.