You must have the following to complete a CCA integration:
Created a Cardinal Merchant Account for CCA
It is important to note that the Cardinal Cruise integration of Javascript, specifically Songbird.js, uses TLS 1.2 cipher suites and protocols and above. If you are currently using a deprecated TLS cipher suite and protocol (Ie: TLS 1.0 or 1.1) you will be required to upgrade to the latest and approved TLS 1.2 cipher suites and protocols. You can find the approved cipher suite list here. |
The following steps outline the requirements for integrating the Consumer Authentication into your baseline Cardinal Cruise JS integration, which was completed by following the steps in the Getting Started section.
Step 1: JWT Creation
Step 2: Include the Script
Step 3: Configure It
Step 4: Listen for Events
Step 5: Initialize It
Step 6: Include BIN Detection
Step 7: Order Object Requirements
Step 8: Start Cardinal Consumer Authentication
Step 9: Handling the CCA Response
Step 10: JWT Validation
The below document outlines the transactional flow to complete a CCA Standard transaction.
The below steps are required to enable CCA with your Cardinal Cruise JS Standard integration. We included a section for building the Order Object, Start CCA, and listening for payments.validated in addition to the already completed Getting Started steps.
The following fields are required to be present within the order object sent to Cardinal for a CCA transaction. These values must be passed in on the Cardinal.start() event shown in the next section at the latest. Here is a JSON example.
Cardinal Consumer Authentication is initiated by the merchant, typically when the customer clicks 'Place Order" or 'Submit Order' button. Instead of getting a card authorization, you need to initiate the Cardinal.start() before authorization.
Cardinal.start will only work after the payment.setupComplete event has been triggered. Try running Cardinal.start later in your flow if payments.setupComplete has not triggered yet. |
Cardinal.start("cca", data); |
In this example, the second argument of data
is a Request Order Object. You can construct this object ahead of time or pass it directly, as shown here:
Cardinal.start("cca", { OrderDetails: { OrderNumber: "1234567890" }, Consumer: { Account: { AccountNumber: "XXXXXXXXXXXX1234", ExpirationMonth: "01", ExpirationYear: "2099" } } ... }); |
AccountNumber in the above example is splatted only for security in this document. You must pass the full AccountNumber. The Order Object used in the example was shortened for brevity. |
Songbird.js will handle all the user interactions up until CCA has returned back the authentication result. The next step in the integration is to add logic to your payments.validated event to handle specific return values for CCA. The field ActionCode should be used as the primary transaction status indicator. Below are the possible values for ActionCode and what they indicate.
The below example is what you should expect the response JWT to contain on a successful CCA transaction.
NOTE: It is highly recommended that you verify the Amount and Currency values within the response prior to sending to authorization. The values returned on payments.validated will represent the values used during authentication; these values should match the values at the time of authorization. Step 10: JWT ValidationOnce the response JWT is received in the payments.validated event, you will need to send the response JWT to your backend to verify and extract the results. We recommend that any values sent to 3rd parties are sourced from the response JWT after it has been properly validated.
You can begin testing transactions after you have completed the above steps for integrating Cardinal Cruise Standard into your merchant front end environment. |