VCAS

Stepup request is communicate by the VCAS platform to the partner, and the partner responds with parameters necessary for VCAS to perform the step-up challenge.

post/pws/stepup/

Request

  • Base URL
    https://api.uat.paymentology.com/ppws/api
  • URL
    https://api.uat.paymentology.com/ppws/api/pws/stepup/
  • Auth
    none declared

Request body

IssuerIdstring required

Cardinal provided identifier for the partner. Length - Up to 24 Characters

MessageVersionstring required

Version of the message based on 3DS spec. Examples - 1.0.2, 2.1.0, 2.2.0

ProcessorIdstring required

Cardinal provided identifier for the partner. Length - Up to 24 Characters

StepupCounterinteger required

Counter for tracking the number of Stepups. Each stepup can go from Stepup -> InitiateAction -> Validate. If the user requests a "resend" via the browser templates it will initiate another Stepup request.

StepupRequestIdstring required

Unique identifier to identify the particular Stepup request. Length will be 36 Characters.

TransactionIdstring required

VCAS generated transaction reference id. Length - Up to 36 Characters. 3DS 1.0.2 - 28 character alpha-numeric. EMV 3DS - 36 character GUID.

DSTransactionIdstring

Directory Server (DS) generated transaction reference id. GUID Format. Note: EMV 3DS Transactions only

DeviceLocalestring

Device Locale from the browser header or from the app's language settings. This value can be a single locale value or multiple concatenated together via commas. In 3DS1 this value will be directly from the browser's "Accept-Language" header. However, in 3DS2 this is not available due to new flows so this will be a single language value following BCP 47 format e.g. en-US or en,es-PE;q=0.9,es;q=0.8

DeviceUserAgentstring

Device user agent from the browser header or the app's device identifier. Length - Up to 2048 Characters

RDXMessageVersionstring

Version of the RDX protocol being used. This will be used to enable new features without breaking current integrations. Example: 2.2.0 and 2.2.1

StepupReason'CARDHOLDER_RESEND'

Used to identify the reason the Stepup request was initiated. Only available for Cardholder Resend, future values and scenarios may be added.

3RIIndicatorstring

Indicates the type of 3RI request for EMV transactions.

ThreeDSRequestorAuthenticationIndstring

Indicates the type of Authentication request. This data element provides additional information to the ACS to determine the best approach for handling an authentication request.

MessageCategorystring

Identifies the category of the message for a specific use case.

Response

Successful Response

IssuerIdstring required

Echoed from Request. Length - Up to 24 Characters

ProcessorIdstring required

Echoed from Request. Length - Up to 24 Characters

Status'SUCCESS' | 'FAILURE' | 'RETRY' | 'PENDING' | 'BLOCKED' | 'STEPUP' | 'ERROR' | 'ATTEMPTS' | 'FAILWITHFEEDBACK' | 'REJECTED' | 'FAIL' | 'CHALLENGE' | 'AUTHENTICATED' required

ERROR is returned on any interal/technical issues. ATTEMPTS is only supported for 1.0.2 transactions. REJECTED is only supported for 2.x.x transactions. AUTHENTICATED will return a Y back to the merchant

StepupRequestIdstring required

Echoed from Request. Length - 36 Characters

TransactionIdstring required

Echoed from Request. Length - Up to 36 Characters

Languagestring

Language to display the instructions and prompt to the cardholder. This value will decide which template is loaded, provided the correct template language is available. If not provided, the language is selected based on Issuer configuration and browser preference e.g. en-US. Length - Up to 8 Characters

StepupType'CHOICE' | 'OTP' | 'KBA' | 'BIOMETRIC' | 'OUTOFBAND' | 'OTP_AND_KBA' | 'OTP_CHOICE_AND_KBA'

Used to identify what type of stepup.

RiskIndicatorstring

If returned, this value will be used in the creation of certain Authentication Values (AV) for EMV 3DS. The value passed must conform to the current AV value the Issuer is using. This may also depend on the card brand of the transaction. For example, CAVV and IAV accept different values. On Challenge responses (Stepup, Initiate, Validate) this value is currently ignored for CAVV usages in favor of mapping to the 'Credential Type'. For Enhanced IAV SPA2 usage, if passed, this value will override the mapping to the 'Credential Type'. Note: This field is only available for EMV 3DS transactions and not available on 3DS 1 transactions Note: The value here will be converted to the Hexadecimal equivalent. Please see 'VCAS Enhanced AV' document for more details on current AVs available and the corresponding values.

IsBbConsentRequiredboolean

Indicates if legal consent is required for the behavioral biometrics flow.

TransStatusReasonstring

Provides information on why the Transaction Status field has the specified value.

oobAppURLstring

URL provided for OOB app-based authentication flow. The URL will redirect the user to the appropriate location within the authentication app. Not applicable for browser-based authentication.

Changes