Skip to main content

Payment instrument verification status event

POST 
/piv/events

The webhook is sent when there's an update with the status of payment instrument verification session.

Request​

Header Parameters

    Signature string

    HMAC signature of the request

    Content-Type stringrequired

    Default value: application/json

    application/json

Body

    id stringrequired

    Event id.

    sessionId stringrequired

    Payment instrument verification session id.

    customerId stringrequired

    Wallet customer identifier.

    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 - is 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 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.
    timestamp date-timerequired

    Represents RFC 3339, section 5.6 date-time.

Responses​

OK

Loading...