Skip to main content

Instrument Verification with Secure Code

Manages a session of adding customer bank account.

instrumentTypeInstrumentType (string)required

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 |

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

Example: CARD
returnUrlurlrequired

The return URL to which users must be redirected after completing the required actions in Paysafe hosted UI. The Partner is required to communicate the provided returnUrl to Paysafe in advance for the it to be whitelisted and considered valid.

Once the redirect process is finished, the customer will be redirected back to the Partner, and the returnUrl will be enhanced with extra properties that include relevant details about the SCA authentication process, such as status:

  • status - It holds the outcome of the SCA authentication event, such as success or fail.
Example: https://some-process.paysafe.com/
idstringrequired

Instrument verification session ID

Example: 2cb56b2749af52d6b257054ef3de0
redirectUrlurlrequired

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

Example: https://some-process.paysafe.com/
creationTimedate-timerequired

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z
expirationTimedate-timerequired

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z
instrument object

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

idstringrequired

Instrument identifier.

Example: 1001
instrumentTypeInstrumentType (string)required

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 |

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

Example: CARD
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]

secureCodestring

Base64 encoded string containing the secure code for authentication.

Example: c2Rmc2ZzZmRzZGZzZGY=
secureCodeMethodstring

The secure code hashing algorithm.

Default value: sha512
Example: sha512
Instrument Verification with Secure Code
{
  "instrumentType": "CARD",
  "returnUrl": "https://some-process.paysafe.com/",
  "id": "2cb56b2749af52d6b257054ef3de0",
  "redirectUrl": "https://some-process.paysafe.com/",
  "creationTime": "2021-07-15T17:54:12Z",
  "expirationTime": "2021-07-15T17:54:12Z",
  "instrument": {
    "id": "1001",
    "instrumentType": "CARD"
  },
  "sessionStatus": "ACTIVE",
  "statusReason": "UNSUPPORTED_BANK",
  "secureCode": "c2Rmc2ZzZmRzZGZzZGY=",
  "secureCodeMethod": "sha512"
}