Skip to main content

PaymentInstrumentVerificationEvent

Event for tracking payment instrument verifications status updates.

idstringrequired

Event id.

sessionIdstringrequired

Payment instrument verification session id.

customerIdstringrequired

Wallet customer identifier.

sessionStatusInstrument Verification Status (string)required

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.

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

statusReasonInstrument Verification Failed Status Reason (string)

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.

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

timestampdate-timerequired

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z
PaymentInstrumentVerificationEvent
{
  "id": "string",
  "sessionId": "string",
  "customerId": "string",
  "sessionStatus": "ACTIVE",
  "statusReason": "UNSUPPORTED_BANK",
  "timestamp": "2021-07-15T17:54:12Z"
}