Skip to content

Commit 95b6788

Browse files
ohernandovisaohernandovisa
authored
Merge pull request #17 from cybersource-tpi/develop
Merging release candidate 23.2.0 to main
2 parents 9df5c17 + 18471cf commit 95b6788

File tree

41 files changed

+531
-255
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+531
-255
lines changed

‎documentation/Oracle Commerce Cloud Installation Guide v6.0.pdf

-456 KB
Binary file not shown.

‎documentation/Oracle Commerce Cloud- Cybersource User Installation Guide v7.0.pdf ‎documentation/Oracle Commerce Cloud- Cybersource User Installation Guide v8.0.pdf

4.53 MB
Binary file not shown.

‎documentation/Release Notes v23.1.0.docx

-19.3 KB
Binary file not shown.

‎documentation/Release Notes v23.1.1.docx ‎documentation/Release Notes v23.2.0.docx

26 KB
Binary file not shown.

‎documentation/package-contents.md

+2
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ The following settings can be configured in gateway:
106106
| | |
107107
| **Credit Card** | |
108108
| **payerAuthEnabled** | Enables payer authentication for credit cards |
109+
| **scaEnabled** | If enabled card holder will be 3DS Challenged when saving a card |
109110
| **flexSdkUrl** | Credit Card Flex SDK URL |
110111
| **isCVVRequiredForSavedCards** | Is the CVV required when using a saved card. |
111112
| **isCVVRequiredForScheduledOrders** | Is the CVV required for a Scheduled Order |
@@ -282,6 +283,7 @@ server-extension
282283
┃ ┃ ┃ ┃ ┃ ┣ mappers
283284
┃ ┃ ┃ ┃ ┃ ┃ ┣ index.ts
284285
┃ ┃ ┃ ┃ ┃ ┃ ┣ payerAuthMapper.ts
286+
┃ ┃ ┃ ┃ ┃ ┃ ┣ scaMapper.ts
285287
┃ ┃ ┃ ┃ ┃ ┃ ┣ saleCardMapper.ts
286288
┃ ┃ ┃ ┃ ┃ ┃ ┣ saleGenericMapper.ts
287289
┃ ┃ ┃ ┃ ┃ ┃ ┗ savedCardPaymentMapper.ts

‎documentation/payment-services/credit-card.md

+17-3
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
3. [Payer Authentication](#payer-authentication)
1010
1. [UI integration details](#ui-integration-details-1)
1111
2. [Backend (SSE) integration details](#backend-sse-integration-details-1)
12+
3. [Strong Customer Authentication (SCA)](#strong-customer-authentication-sca)
1213
4. [Capturing funds during authorization (SALE)](#capturing-funds-during-authorization-sale)
1314

1415
## Description
@@ -42,14 +43,16 @@ The following gateway settings apply to credit card payments
4243
|-------------------------------------|---------------------------------------------------------------------------------------------------|
4344
| **paymentMethodTypes** | Enabled Payment Methods. 'Credit & Debit Card' should be enabled |
4445
| **paymentOptions** | Payment options enabled for payment using Payment Widget. 'Credit & Debit Card' should be enabled |
45-
| **payerAuthEnabled** | Enables payer authentication (3D Secure) for credit cards | | |
46+
| **payerAuthEnabled** | Enables payer authentication (3D Secure) for credit cards |
47+
| **scaEnabled** | If enabled card holder will be 3DS Challenged when saving a card |
4648
| **saleEnabled** | Indicates if authorizing and taking payment will be done at the same time |
4749
| **isCVVRequiredForSavedCards** | Should be disabled as CVV is not required in backend |
4850
| **isCVVRequiredForScheduledOrders** | Should be disabled as CVV is not required in backend |
4951

5052
Default values:
5153

5254
- `payerAuthEnabled`: true. Payer authentication is enabled by default
55+
- `scaEnabled` : false
5356
- `isCVVRequiredForSavedCards`: false
5457
- `isCVVRequiredForScheduledOrders`: false
5558
- `saleEnabled` - by default SALE is disabled for Card payments. Can be enabled in OCC Admin
@@ -135,7 +138,6 @@ plugins
135138
 | | | ├── meta.js
136139
 | | | └── styles.css
137140
 | | ├── isv-payment-utility
138-
 | | | ├── common.js
139141
 | | | ├── flex-microform.js
140142
 | | | ├── flex-microForm-api.js
141143
 | | | └── script-loader.js
@@ -145,7 +147,9 @@ plugins
145147
 | | ├── meta.js
146148
 | | └── styles.css
147149
 | ├── .eslintrc
150+
| ├── constants.js
148151
 | ├── index.js
152+
| ├── isv-common.js
149153
 | └── meta.js
150154
 ├── endpoints
151155
 | ├── flex-microform-endpoint
@@ -261,10 +265,20 @@ The following UI component contains Payer Authentication integration logic `plug
261265

262266
#### Backend (SSE) integration details
263267

264-
- `server-extension/src/controllers/payerAuth.ts` Controller for generating a signed PayerAuth JWT
268+
- `server-extension/src/controllers/payerAuth.ts` Controller for payer auth setup
265269
- `server-extension/src/services/payments/converters/request/mappers/payerAuthEnrollMapper.ts` Including payer auth reference id into PSP card authorization request
266270
- `server-extension/src/services/payments/converters/request/mappers/payerAuthValidationMapper.ts` Including payer auth validation token into PSP card authorization request
267271

272+
#### Strong Customer Authentication (SCA)
273+
274+
When `Payer Authentication` is enabled, if a transaction gets declined with the reason as Strong Customer Authentication required, then another request will be sent from Oracle Commerce Cloud automatically for the same order and the customer will be 3DS challenged.
275+
276+
In case merchants would like the cardholder to be 3DS Challenged when saving a card `scaEnabled` gateway setting can be updated to enable it for credit cards.
277+
278+
In case 'Strong Customer Authentication' is enabled for credit cards, '10000' response code is sent back in Webhook response so that OCC becomes aware of that.
279+
280+
*Note:* The `scaEnabled` setting is applicable only if `Payer Authentication` is enabled.
281+
268282
### Capturing funds during authorization (SALE)
269283

270284
In case merchants would like funds to be captured (settled) during card authorizations `saleEnabled` gateway setting can be updated to enable it for credit cards.

‎lib/sse/occ.js

+13-35
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
//occ.js
22
const https = require('https');
3-
const request = require('request');
3+
const superagent = require('superagent');
44
const fs = require('fs-extra');
55
const common = require('../common/occ');
66
const path = require('path');
@@ -60,42 +60,20 @@ async function listSSEFiles(url, accessToken) {
6060

6161
async function doSSEFileUploadMultipart(url, accessToken, appName, archiveFile) {
6262
return new Promise((resolve, reject) => {
63-
/** Setup Progress Bar */
64-
const fileStream = fs.createReadStream(archiveFile);
65-
66-
request.post(
67-
`https://${url}/ccadmin/v1/serverExtensions`,
68-
{
69-
headers: {
70-
Authorization: 'Bearer ' + accessToken
71-
},
72-
formData: {
73-
filename: `${appName}.zip`,
74-
uploadType: 'extensions',
75-
force: 'true',
76-
fileUpload: {
77-
value: fileStream,
78-
options: {
79-
filename: `${appName}.zip`
80-
}
81-
}
82-
}
83-
},
84-
(err, httpResponse, body) => {
85-
if (!err && httpResponse.statusCode === 200) {
63+
superagent
64+
.post(`https://${url}/ccadmin/v1/serverExtensions`)
65+
.set("Authorization", 'Bearer ' + accessToken)
66+
.field('filename', `${appName}.zip`)
67+
.field('uploadType', 'extensions')
68+
.field('force', 'true')
69+
.attach('fileUpload', archiveFile)
70+
.end((err, res) => {
71+
if(res.status === 200){
8672
fs.removeSync(archiveFile);
87-
return resolve(body);
88-
} else {
89-
if (err) {
90-
message = err;
91-
} else {
92-
message = body;
93-
}
94-
return reject(message);
9573
}
96-
}
97-
);
98-
});
74+
resolve(res.text);
75+
});
76+
})
9977
}
10078

10179
function getExtensionServerLogs(url, accessToken, date = '', loggingLevel = 'debug') {

‎package.json

-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,6 @@
6868
"dependencies": {
6969
"@popperjs/core": "^2.11.6",
7070
"jwt-decode": "^3.1.2",
71-
"request":"^2.88.2",
7271
"tsc-alias": "^1.7.1"
7372

7473
},

‎packages/occ-sse-gateway/lib/types/occ-sdk.d.ts

+6
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,12 @@ declare namespace OCC {
233233
ipAddress?: string;
234234
httpBrowserJavaScriptEnabled?: boolean;
235235
httpAcceptContent?: string;
236+
pauseRequestId?: string;
237+
238+
stepUpUrl?: string;
239+
accessToken?: string;
240+
pareq?: string;
241+
challengeCode?: string;
236242
}
237243

238244
export interface CaptureContextRequest {

‎packages/payment-gateway/gateway/isv-occ-gateway/config/config.json

+8
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,14 @@
163163
"defaultValue": true,
164164
"public": false
165165
},
166+
{
167+
"id": "scaEnabled",
168+
"type": "booleanType",
169+
"labelResourceId": "scaEnabledLabel",
170+
"helpTextResourceId": "scaEnabledHelpText",
171+
"defaultValue": false,
172+
"public": false
173+
},
166174
{
167175
"id": "saleEnabled",
168176
"type": "multiSelectOptionType",

‎packages/payment-gateway/gateway/isv-occ-gateway/config/locales/en.json

+3-1
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,8 @@
8282
"deviceFingerprintOrgIdLabel": "Device Fingerprint Organization Id",
8383
"deviceFingerprintOrgIdHelpText": "",
8484
"deviceFingerprintEnabledLabel": "Device Fingerprint Enabled",
85-
"deviceFingerprintEnabledHelpText": ""
85+
"deviceFingerprintEnabledHelpText": "",
86+
"scaEnabledLabel": "Enforce SCA for Saving Card",
87+
"scaEnabledHelpText": "If enabled, card holder will be 3DS challenged when saving a card (enforcing Strong Customer Authentication)"
8688
}
8789
}

‎packages/payment-gateway/settings.json

+6-5
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
{
22
"paymentMethodTypes": "card,generic",
33
"paymentOptions": "card,googlepay,applepay",
4-
"merchantID": "merchantID",
5-
"merchantKeyId": "merchantKeyId",
6-
"merchantsecretKey": "merchantsecretKey",
4+
"merchantID": "",
5+
"merchantKeyId": "",
6+
"merchantsecretKey": "",
77
"authenticationType": "http_signature",
88
"keyAlias": "keyAlias",
99
"keyPass": "keyPass",
1010
"keyFileName": "keyFileName",
1111
"runEnvironment": "apitest.cybersource.com",
1212
"payerAuthEnabled": true,
13+
"scaEnabled": false,
1314
"saleEnabled": "card",
1415
"flexSdkUrl": "https://flex.cybersource.com/cybersource/assets/microform/0.11/flex-microform.min.js",
1516
"isCVVRequiredForSavedCards": false,
@@ -18,15 +19,15 @@
1819
"googlePayEnvironment": "TEST",
1920
"googlePayGateway": "googlePayGateway",
2021
"googlePayGatewayMerchantId": "googlePayGatewayMerchantId",
21-
"googlePayMerchantId": "googlePayMerchantId",
22+
"googlePayMerchantId": "",
2223
"googlePayMerchantName": "googlePayMerchantName",
2324
"googlePaySupportedNetworks": "AMEX,DISCOVER,INTERAC,JCB,MASTERCARD,VISA",
2425
"applePayMerchantId": "applePayMerchantId",
2526
"applePayInitiative": "web",
2627
"applePayInitiativeContext": "AdminServerUrl",
2728
"applePayDisplayName": "applePayDisplayName",
2829
"applePaySupportedNetworks": "visa,masterCard,amex,discover",
29-
"dmDecisionSkip": "card,googlepay,applepay",
30+
"dmDecisionSkip": "googlepay,applepay",
3031
"deviceFingerprintEnabled": false,
3132
"deviceFingerprintUrl": "https://h.online-metrix.net/fp/tags.js",
3233
"deviceFingerprintOrgId": "deviceFingerprintOrgId",

‎packages/payment-sdk/index.d.ts

+5
Original file line numberDiff line numberDiff line change
@@ -3108,6 +3108,7 @@ declare module 'cybersource-rest-client' {
31083108
* Name of the profile selector rule that chooses the profile to use for the transaction. If no profile selector exists, the value is Default Active Profile.
31093109
*/
31103110
'selectorRule'?: string;
3111+
'action'?: 'PAYERAUTH_INVOKE' | 'PAYERAUTH_SKIP' | 'PAYERAUTH_EXTERNAL';
31113112
}
31123113
export interface PtsV2PaymentsPost201ResponseRiskInformationProviders {
31133114
'providerName'?: Array<PtsV2PaymentsPost201ResponseRiskInformationProvidersProviderName>;
@@ -4135,6 +4136,10 @@ declare module 'cybersource-rest-client' {
41354136
* Reference ID that corresponds to the device fingerprinting data that was collected previously. Note Required for Hybrid integration.
41364137
*/
41374138
'referenceId'?: string;
4139+
/**
4140+
* The URL of the merchant’s return page. CyberSource adds this return URL to the step-up JWT and returns it in the response of the Payer Authentication enrollment call. The merchant's return URL page serves as a listening URL. Once the bank session completes, the merchant receives a POST to their URL. This response contains the completed bank session’s transactionId. The merchant’s return page should capture the transaction ID and send it in the Payer Authentication validation call.
4141+
*/
4142+
'returnUrl'?: string;
41384143
/**
41394144
* This field indicates the maximum amount of time for all 3DS 2.0 messages to be communicated between all components (in minutes). Possible Values: Greater than or equal to 05 (05 is the minimum timeout to set) Cardinal Default is set to 15 NOTE: This field is a required 3DS 2.0 field and Cardinal sends in a default of 15 if nothing is passed
41404145
*/

‎packages/server-extension/config/app.local.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"report.daily.download.path": "",
1313
"crypto.service.key": "l8myMlkZiBX/kLbpDcn3Nw==",
1414
"partner.developerId": "999",
15-
"partner.solutionId": "Z1BIKTOZ",
15+
"partner.solutionId": "VWLU11FQ",
1616
"logging.webhook.http": true,
1717
"logging.api.error": true,
1818
"logging.api.access": true

‎packages/server-extension/config/app.prod.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
"crypto.service.key": "l8myMlkZiBX/kLbpDcn3Nw==",
55
"feature.gatewaysettings.payload": "disabled",
66
"partner.developerId": "999",
7-
"partner.solutionId": "Z1BIKTOZ",
7+
"partner.solutionId": "VWLU11FQ",
88
"logging.webhook.http": true,
99
"logging.api.error": true,
1010
"logging.api.access": true,
11-
"payments.secret.key": "eAGpAMAGj2wmssjvREMe1a/LGXvB/VC+B1ZV+QMc+NA4xTgpqMw4AjQRSQhEkgxEDuHgWY6nvBqx7cAaR+bPaA=="
11+
"payments.secret.key": ""
1212
}

‎packages/server-extension/src/app.ts

-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ function loadConfiguration(app: Application) {
2626

2727
export default function configureApp(app: Application, baseRoutePath = '') {
2828
loadConfiguration(app);
29-
//added header
3029
app.use((req, res, next) => {
3130
res.setHeader("X-Frame-Options", "same-origin");
3231
next();

‎packages/server-extension/src/controllers/paymentRouter.js

-3
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ const { errorHandler } = require('../errors/handlers/errorHandler');
1616
* @param {Object} res - Transaction response
1717
*/
1818
async function paymentRouteHandler(req, res) {
19-
//const logger = (global.occ.logger) ? global.occ.logger : console;
2019
const logger = LogFactory.logger();
2120

2221
//Get gateway module name
@@ -33,8 +32,6 @@ async function paymentRouteHandler(req, res) {
3332
throw new Error('Missing gateway module name');
3433
}
3534

36-
// Set payment type
37-
// const paymentType = req.params.paymentType;
3835
logger.debug(
3936
`${req.method} ${req.path}; order=${req.body.orderId}; paymentGroup=${req.body.paymentId}`
4037
);

‎packages/server-extension/src/server.ts

-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ app.use(cors());
3636

3737
// Enable 'bodyParser' for dev environment
3838
app.use(bodyParser.json());
39-
4039
nconf
4140
.file({ file: path.join(__dirname, '../config/app.local.json') })
4241
.argv()

‎packages/server-extension/src/services/payments/converters/request/mappers/payerAuthEnrollMapper.ts

+29-15
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,21 @@ import { CreatePaymentRequest } from 'cybersource-rest-client';
33
import { PaymentRequestMapper } from '../../common';
44

55
const isNotPayerAuthValidation = (webhookRequest: OCC.GenericPaymentWebhookRequest) =>
6-
!Boolean(webhookRequest.customProperties?.authenticationTransactionId);
6+
!Boolean(webhookRequest.customProperties?.authenticationTransactionId);
77

8+
const getChallengeCode = (context: PaymentContext) => {
9+
if (context.requestContext.gatewaySettings?.scaEnabled && context.webhookRequest.cardDetails?.saveCard || context.webhookRequest.customProperties?.challengeCode == '04') {
10+
context.webhookRequest.customProperties = {
11+
...context.webhookRequest.customProperties,
12+
challengeCode: '04'
13+
}
14+
return {
15+
challengeCode: '04'
16+
}
17+
}
18+
else
19+
return {}
20+
}
821

922
export const payerAuthEnrollMapper: PaymentRequestMapper = {
1023
supports: (context: PaymentContext) =>
@@ -21,22 +34,23 @@ export const payerAuthEnrollMapper: PaymentRequestMapper = {
2134
consumerAuthenticationInformation: {
2235
requestorId: 'requestorId',
2336
referenceId: webhookRequest.customProperties?.referenceId,
24-
returnUrl:webhookRequest.customProperties?.returnUrl,
25-
deviceChannel:webhookRequest.customProperties?.deviceChannel,
37+
returnUrl: webhookRequest.customProperties?.returnUrl,
38+
deviceChannel: webhookRequest.customProperties?.deviceChannel,
39+
...getChallengeCode(context),
2640
},
2741
deviceInformation: {
28-
httpBrowserJavaEnabled:webhookRequest.customProperties?.httpBrowserJavaEnabled,
29-
httpAcceptBrowserValue:webhookRequest.customProperties?.httpAcceptBrowserValue,
30-
httpBrowserLanguage:webhookRequest.customProperties?.httpBrowserLanguage,
31-
httpBrowserColorDepth:webhookRequest.customProperties?.httpBrowserColorDepth,
32-
httpBrowserScreenHeight:webhookRequest.customProperties?.httpBrowserScreenHeight,
33-
httpBrowserScreenWidth:webhookRequest.customProperties?.httpBrowserScreenWidth,
34-
httpBrowserTimeDifference:webhookRequest.customProperties?.httpBrowserTimeDifference,
35-
userAgentBrowserValue:webhookRequest.customProperties?.userAgentBrowserValue,
36-
ipAddress:webhookRequest.customProperties?.ipAddress,
37-
httpBrowserJavaScriptEnabled:webhookRequest.customProperties?.httpBrowserJavaScriptEnabled,
38-
httpAcceptContent:webhookRequest.customProperties?.httpAcceptContent
39-
}
42+
httpBrowserJavaEnabled: webhookRequest.customProperties?.httpBrowserJavaEnabled,
43+
httpAcceptBrowserValue: webhookRequest.customProperties?.httpAcceptBrowserValue,
44+
httpBrowserLanguage: webhookRequest.customProperties?.httpBrowserLanguage,
45+
httpBrowserColorDepth: webhookRequest.customProperties?.httpBrowserColorDepth,
46+
httpBrowserScreenHeight: webhookRequest.customProperties?.httpBrowserScreenHeight,
47+
httpBrowserScreenWidth: webhookRequest.customProperties?.httpBrowserScreenWidth,
48+
httpBrowserTimeDifference: webhookRequest.customProperties?.httpBrowserTimeDifference,
49+
userAgentBrowserValue: webhookRequest.customProperties?.userAgentBrowserValue,
50+
ipAddress: webhookRequest.customProperties?.ipAddress,
51+
httpBrowserJavaScriptEnabled: webhookRequest.customProperties?.httpBrowserJavaScriptEnabled,
52+
httpAcceptContent: webhookRequest.customProperties?.httpAcceptContent
53+
}
4054
};
4155
}
4256
};

‎packages/server-extension/src/services/payments/converters/request/mappers/payerAuthValidationMapper.ts

+9-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@ import { PaymentContext } from '@server-extension/common';
22
import { CreatePaymentRequest } from 'cybersource-rest-client';
33
import { PaymentRequestMapper } from '../../common';
44

5+
6+
const getPauseRequestId = (context: PaymentContext) => {
7+
const pauseRequestId = context.webhookRequest.customProperties?.pauseRequestId;
8+
return pauseRequestId ? { clientReferenceInformation: { pauseRequestId } } : {};
9+
}
10+
11+
512
export const payerAuthValidationMapper: PaymentRequestMapper = {
613
supports: (context: PaymentContext) => Boolean(context.webhookRequest.customProperties?.authenticationTransactionId),
714

@@ -14,7 +21,8 @@ export const payerAuthValidationMapper: PaymentRequestMapper = {
1421
},
1522
consumerAuthenticationInformation: {
1623
authenticationTransactionId: webhookRequest.customProperties!.authenticationTransactionId
17-
}
24+
},
25+
...getPauseRequestId(context)
1826
};
1927
}
2028
};

0 commit comments

Comments
 (0)