InitiateActionRequest
The Initiate Action request is used to signal to the client to take action on an item.
InitiateAction API Reference: Interactive request/response specification
InitiateAction Code Recipe: Pseudocode resource with code snippets
| Name | Description | Type | Length | Required |
|---|---|---|---|---|
| ProcessorId | VCAS provided identifier for the client. | String | 24 characters | Required |
| IssuerId | VCAS provided identifier for the client. | String | 24 characters | Required |
| TransactionId | VCAS generated transaction reference id: 36-character GUID value. | String | Up to 36 characters | Required |
| DSTransactionId | Directory Server (DS) generated transaction reference id. GUID format. | String | 36 characters | Conditional |
| 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. | String | enum | Optional |
| ThreeDSRequestorAuthenticationInd | 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. | String | 2 characters | Optional |
| StepupRequestId | Unique identifier to identify the particular Stepup request. Length is 36 characters. | String | Up to 36 characters | Optional |
| 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). | Integer | Required | |
| StepupType | The StepupType value that was returned in the RDX Stepup Response, RDX will echo back this field on the InitiateAction request. Stepup Type Values | String | Enum | Optional |
| OtpReferenceCode | 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. Note: issuers using this field should consult with their VCAS representative to ensure it displays on their consumer-facing screens. | String | Up to 8 characters | Optional |
| OOBPushCallbackUrl | URL provided by VCAS to be used by issuer to return the OOBValidateStatus response back to the RDX/VCAS service during the OOB API Push flow. Issuer will append transaction status to URL. Examples: UAT/STAGE: https://uat.oobpush.api.vcas.visa.com/V1/OOBPushValidateStatus PROD: https://oobpush.api.vcas.visa.com/V1/OOBPushValidateStatus | String | Up to 62 characters | Optional |
| VerificationToken | Token to be sent to cardholder. | String | Up to 18 characters | Optional |
| 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. Example: 2.2.0 | String | Up to 8 characters. | Required |
| RDXMessageVersion | Message Version of the RDX protocol being used. This will be used to enable new features without breaking current integrations. Example: 2.2.2 | String | Up to 8 characters | Optional |
| MessageCategory | Identifies the category of the message for a specific use case.
| String | 2 characters | Optional |
| Credentials | A list of Credential objects that will be used to challenge the user. This must contain at least one consumer contact information. | List.Object | Minimum one character | Required |
| MerchantInfo | Object containing the Merchant information. | Object | NA | Optional |
| PaymentInfo | Object containing the Payment Information. | Object | NA | Optional |
| TransactionInfo | Object containing the Transaction information. | Object | NA | Optional |
| CardBrandName | Name of the card network for a specific transaction. Values include:
| String | Enum | Required |
Updated 26 days ago