Skip to main content

SCA Authentication Event Attempt Embedded or Hybrid Request

Embedded or Hybrid Strong Customer Authentication (SCA) authentication event attempt request, including details about the authentication process and outcome.

walletOperationIdstringrequired
verification objectrequired

Verification details associated with the SCA authentication event attempt.

methodSCA Authentication Event Attempt Verification Method (string)required

Method used for verifying the SCA authentication event attempt.

  • PASSWORD - A secret combination of characters, typically chosen by the user, used to authenticate their identity.
  • PIN - A numeric code, typically six digits, used to authenticate the user's identity.
  • PASSKEYS - A set of predefined keys or a pattern chosen by the user to authenticate their identity.
  • OTP - One-Time Password sent via SMS, email, or authenticator application to the user's registered device.
  • BIOMETRIC - Authentication based on unique physical characteristics of the user, such as fingerprint, facial recognition, or iris scan.

Possible values: [PASSWORD, PIN, PASSKEYS, OTP, BIOMETRIC]

Example: OTP
channelSCA Authentication Event Attempt Verification Channel (string)

Channel used to send the verification method to the user.

  • SMS - Verification method sent via SMS to the user's registered device.
  • EMAIL - Verification method sent via email to the user's registered address.
  • AUTHENTICATOR - Verification method generated by an authenticator application installed on the user's device.
  • PUSH_NOTIFICATION - Verification method sent via the user's mobile device prompting them to approve or deny the authentication request.
  • REDIRECT - Verification method that redirects the customer to a Url hosted by Paysafe in order to complete the operation.

Possible values: [SMS, EMAIL, AUTHENTICATOR, PUSH_NOTIFICATION, REDIRECT]

Example: SMS
action object

Contains Action required for verifying the SCA authentication event attempt (when available).

returnUrlurl

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/
redirectUrlurl

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

Example: https://some-process.paysafe.com/
SCA Authentication Event Attempt Embedded or Hybrid Request
{
  "walletOperationId": "string",
  "verification": {
    "method": "OTP",
    "channel": "SMS",
    "action": {
      "returnUrl": "https://some-process.paysafe.com/",
      "redirectUrl": "https://some-process.paysafe.com/"
    }
  }
}