Versions Compared

Old Version 1

changes.mady.by.user Brian Brotherton

Saved on

compared with

New Version 2

changes.mady.by.user Brian Brotherton

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Warning
titleDevelopment Notice

The Cardinal Virtual SDK is currently in Beta and is subject to changes within the codebase and documentation. Please reach out to your AE if there are any questions.


Overview

Tip
titleUniversal Reference Guide

The documentation below covers many communication methods when it comes to talking with the Cardinal systems. There may be fields that include notes for "Cruise Standard" and "Cruise Hybrid" that may not be applicable to this integration.

Include Page
CCen:Consumer Authentication
CCen:Consumer Authentication


Table of Contents

Virtual SDK Required Fields

The table below includes the required fields for the Virtual SDK implementation. These have been separated from the rest of the lookup documentation as they are specific to the Virtual SDK.

Virtual SDK Lookup Request Fields (Required)

Field NameDescriptionRequiredField Definition

SdkEphemPubKey

The public key component of the ephemeral key pair generated by the 3DS SDK and used to establish session keys between the 3DS SDK and ACS.

YJSON Object(6000)

SdkTransId

Universally unique transaction identifier assigned by the 3DS SDK to identify a single transaction.

YANString(36)

SdkAppId

Universally Unique ID created upon all installations and updates of the 3DS Requestor App on a Consumer Device. This will be newly generated and stored by the 3DS SDK for each installation or update.

YString(36)

SdkReferenceNumber

Identifies the vendor and version for the 3DS SDK that is integrated into a 3DS Requestor App, assigned by EMVCo when the 3DS SDK is approved.

YANString(32)
SdkEncDataJWE object containing data encrypted by the SDK for the DS to decrypt.YString(64000)
SdkMaxTimeout

Maximum time the SDK will wait for all message (in minutes).

Accepted Values: Greater than or = 05

YN(2)
DeviceChannel

Determines the channel that the transaction came through.

Possible Values: 

SDK

NOTE: The value of SDK is required for Cardinal Virtual SDK transactions

YAN(10)
DeviceRenderOptions

Defines the SDK UI types that the device supports for displaying specific challenge user interfaces within the SDK

NJSON Object

Virtual SDK Lookup Response Fields

Field NameDescriptionRequiredField Definition

ACSSignedContent

Contains the JWS object created by the ACS and returned on the ARes message.

The JWS object contains the following data:

  • ACS URL
  • ACS Ephemeral Public Key
  • SDK Ephemeral Public Key
CANString(5000)
ACSReferenceNumberUnique identifier assigned by the EMVCo secretariat upon testing and approval CANString(32)
ACSTransactionIDUnique transaction identifier assigned by the ACS to identify a single transaction.CANString(36)
ThreeDSServerTransactionIdUnique transaction identifier assigned by the 3DS Server to identify a single transaction.CANString(36)


Example

Code Block
themeEmacs
titleVirtual SDK Lookup Request Example
linenumberstrue
collapsetrue
<CardinalMPI>
	<ProcessorId>123</ProcessorId>
	<MerchantId>MERCHANT_ID</MerchantId>
	<TransactionPwd>123456789</TransactionPwd>
	<Version>1.7</Version>
	<MsgType>cmpi_lookup</MsgType>
	<TransactionType>C</TransactionType>
	<OrderNumber>abc123doerayme</OrderNumber>
	<AcctNumber>4012000000010288</AcctNumber>
	<PurchaseAmount>0</PurchaseAmount>
	<PurchaseCurrency>840</PurchaseCurrency>
	<CardNumber>4012000000010288</CardNumber>
	<CardExpMonth>09</CardExpMonth>
	<CardExpYear>2020</CardExpYear>
	<BillingCity>Mentor</BillingCity>
	<BillingAddress1>8100 Tyler Blvd 100</BillingAddress1>
	<BillingAddress2></BillingAddress2>
	<BillAddrPostCode>44094</BillAddrPostCode>
	<BillingCountryCode>840</BillingCountryCode>
	<BillAddrState>OH</BillAddrState>
	<CardholderName>
		<BillingFirstName>John Doe</BillingFirstName>
		<BillingLastName>John Doe</BillingLastName>
		<BillingFullName>John Doe</BillingFullName>
	</CardholderName>
	<ShippingCity>44094</ShippingCity>
	<ShippingAddress1>8100 Tyler Blvd 100</ShippingAddress1>
	<ShippingAddress2></ShippingAddress2>
	<ShippingPostalCode>44094</ShippingPostalCode>
	<DFReferenceId></DFReferenceId>
	<BillingPostalCode>44094</BillingPostalCode>
	<BillingState>OH</BillingState>
	<ShippingState>OH</ShippingState>
	<Email>cardinal.mobile.test@gmail.com</Email>
	<ShippingCountryCode>840</ShippingCountryCode>
	<Amount>0</Amount>
	<CurrencyCode>840</CurrencyCode>
	<SourceVersion>2.10</SourceVersion>
	<ChallengeRenderInterface>01</ChallengeRenderInterface>
	<ChallengeRenderType>01</ChallengeRenderType>
	<ChallengeRenderType>02</ChallengeRenderType>
	<ChallengeRenderType>03</ChallengeRenderType>
	<ChallengeRenderType>04</ChallengeRenderType>
	<ChallengeRenderType>05</ChallengeRenderType>
	<ThreeDSVersion>2.1.0</ThreeDSVersion>
	<DeviceChannel>sdk</DeviceChannel>
	<MerchantUrl>http://www.cardinalcommerce.com</MerchantUrl>
	<AcquirerId>88888</AcquirerId>
	<AcquirerMerchantId>89111</AcquirerMerchantId>
	<CategoryCode>5712</CategoryCode>
	<CountryCodeOverride>840</CountryCodeOverride>
	<MerchantName>Sid</MerchantName>
	<MessageCategory>01</MessageCategory>
	<ProductCode>01</ProductCode>

	<SdkMaxTimeout>25</SdkMaxTimeout>
	<AuthenticationIndicator>01</AuthenticationIndicator>
	<SdkTransId>e1c72b78-8534-49d2-ae18-1e9050e13c61</SdkTransId>
	<SdkEncData>ENCRYPTED DATA</SdkEncData>
	<SdkEphemPubKey>{"kty":"EC","crv":"P-256","x":"_NohgCJdJMwqAJLf0KvBibZk-kiiBLfVr1aFjq_MXsg","y":"xVWNBHhJpaMb8G6FMwSiD7CyxGji6GYMSyW1A380wuM"}</SdkEphemPubKey>
	<SdkAppId>6d9f1f0f-b15c-4200-a2d8-953181edfc6e</SdkAppId>
	<SdkReferenceNumber>SdkReferenceNumber</SdkReferenceNumber>
</CardinalMPI>


Include Page
CCen:Lookup Request/Response
CCen:Lookup Request/Response