VCAS

Initiate Action

Changed on

Initiate Action request is used to signal to the partner to take action on an item.

post/pws/initiateaction/

Request

  • Base URL
    https://api.uat.paymentology.com/ppws/api
  • URL
    https://api.uat.paymentology.com/ppws/api/pws/initiateaction/
  • 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

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

Used to identify what type of stepup.

OtpReferenceCodestring

This is a unique value generated with each new OTP value or 'VerificationToken'. In the instance where the consumer can receive multiple OTPs for the same transaction, this can be leveraged to show the consumer which OTP the system is expecting to be entered. This value should be sent in the SMS or Email along with the VerificationToken and then displayed on the consumer screen.

VerificationTokenstring

Token to be sent to cardholder.

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

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.

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

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.

TransStatusReasonstring

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

Changes