StepupRequest

If the Risk assessment results in a status of Stepup, the issuer then determines how they want to challenge the cardholder. The result of this step consists mainly of a list of ways that the cardholder can be challenged, also known as “Credentials”.

StepupRequest API Reference: Interactive request/response specification

StepupRequest Code Recipe: Pseudocode resource with code snippets

NameDescriptionTypeLengthRequired
ProcessorIdVCAS generated transaction reference id: 24-character GUID value.String24 charactersRequired
IssuerIdVCAS generated transaction reference id: 24-character GUID value.String24 charactersRequired
TransactionIdVCAS generated transaction reference id: 36-character GUID value.StringUp to 36 charactersRequired
DSTransactionIdDirectory Server (DS) generated transaction reference id. GUID format.String36 charactersConditional
3RIIndicator

Indicates the type of 3RI request for EMV transactions.

Note: Please allow for future values in this field. EMV has reserved up to 99 values for future use.

3RI Indicator Values

StringString; enumOptional
ThreeDSRequestorAuthenticationInd

Indicates the type of 3RI request for EMV transactions.

Note: Please allow for future values in this field. EMV has reserved up to 99 values for future use.

3DS Requestor Authentication Values

String2 charactersOptional
StepupRequestIdUnique identifier to identify the particular Stepup request. Length is 36 characters.StringUp to 36 charactersOptional
StepupCounter

Counter for tracking the number of Stepup calls.
Each Stepup can go from Stepup ➤ InitiateAction ➤ Validate.

If the user requests a "resend" via the browser or native app templates it will initiate another Stepup request. Note: Initial value will be 0 (zero).

IntegerRequired
DeviceLocale

Device Locale from the browser header or from the native application’s language settings. This value can be a single locale value or multiple values concatenated via commas. In EMV 3DS this is not available due to new flows so this will be a single language value following BCP 47 format.

Examples:

  • en-US

  • en,es-PE;q=0.9,es;q=0.8
StringUp to 2048 charactersOptional
DeviceUserAgentDevice user agent from the browser header or the app’s device identifierStringUp to 2048 charactersOptional
MessageVersion

Version of the 3DS protocol based on 3DS spec.

This version will increment with each new specification released by EMVCo for 2.x. This will typically follow a X.Y.Z version format.
Examples:

  • 2.1.0

  • 2.2.0
StringUp to 8 characters.Required
RDXMessageVersionMessage Version of the RDX protocol being used. This will be used to enable new features without breaking current integrations. Example: 2.2.3 or 2.2.4StringUp to 8 charactersOptional
MessageCategory

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


  • 01 = PA

  • 02 = NPA

  • 03-79 = Reserved for EMVCo future use

  • 80-99 = Reserved for DS use
String2 charactersOptional
StepupReasonThe reason the Stepup request was initiated. Example: CARDHOLDER_RESEND - When the cardholder is challenged and clicks the Resend button on the OTP validate page, the next Stepup request will contain this value.
Note: Only available for Cardholder Resend, future values and scenarios may be added.
StringEnumOptional
MerchantInfo

Object containing the Merchant information.

StepupRequest.MerchantInfo

ObjectNAOptional
PaymentInfo

Object containing the PaymentInfo.

StepupRequest.PaymentInfo

ObjectNAOptional
TransactionInfo

Object containing the Transaction information.

StepupRequest.TransactionInfo

ObjectNAOptional
CardBrandName

Name of the card network for a specific transaction. Values include:

  • DISCOVER

  • VISA

  • MASTERCARD

  • JCB

  • AMEX

  • DINERS

  • ELO

  • UPI

  • EFTPOS

  • MADA

  • MYDEBIT

  • TAKAPAY

  • ITMX

  • JAYWAN
StringEnumRequired
CardholderSelectionInfo

Object defining the consumers selection during the Cardholder Selection OTP flow. This feature is only populated and enabled for issuers supporting this flow.

StepupRequest.CardholderSelectionInfo

ObjectNAOptional
ExtensionDataObject defining data extension information related to the transaction.
Stepup.Request.ExtensionData (Object)
EmbeddedOOBResponseUrlThe issuer must redirect to this URL when validation is complete, during an Embedded OOB challenge.StringNAConditional