Skip to content

Commit c929184

Browse files
Merge pull request #7 from cybersource-tpi/main
Release 23.3.0
2 parents 200917a + bc1170a commit c929184

File tree

75 files changed

+15632
-14406
lines changed

Some content is hidden

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

75 files changed

+15632
-14406
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Please refer to the [official documentation](documentation/occ.md) to get all de
99
## Prerequisites
1010

1111
- Yarn version: [1.22.4](https://classic.yarnpkg.com/en/docs/install/#mac-stable)
12-
- NodeJS version: 16.15.0, You could use [NVM](https://github.com/nvm-sh/nvm) to manage multiple versions locally
12+
- NodeJS version: 18.16.1, You could use [NVM](https://github.com/nvm-sh/nvm) to manage multiple versions locally
1313

1414

1515
## Install dependencies
Binary file not shown.
Binary file not shown.
-27 KB
Binary file not shown.
1.19 MB
Loading
File renamed without changes.
-85.6 KB
Binary file not shown.
Binary file not shown.

documentation/installation.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ Please pay attention to installation steps documented for both SSE and widgets (
2727

2828
The following is required before going through installation steps:
2929

30-
1. Yarn version: [1.22.18](https://classic.yarnpkg.com/en/docs/install/#mac-stable)
31-
2. NodeJS version: 16.15.0, You could use [NVM](https://github.com/nvm-sh/nvm) to manage multiple versions locally
30+
1. Yarn version: [1.22.4](https://classic.yarnpkg.com/en/docs/install/#mac-stable)
31+
2. NodeJS version: 18.16.1, You could use [NVM](https://github.com/nvm-sh/nvm) to manage multiple versions locally
3232
3. OCC environment
3333
- OCC Admin interface: https://asbx80c1dev-admin-{env}.oraclecloud.com/occs-admin/
3434
- OCC Storefront: https://asbx80c1dev-store-{env}.oraclecloud.com
@@ -44,9 +44,9 @@ You need to build all packages at once using `yarn build:prod` command from proj
4444

4545
### Configure gateway
4646

47-
Before installing payment gateway you should decide whether you will support all payment methods or only some of it. There are two ways you can manage it:
47+
Before installing a payment gateway you should decide whether you will support all payment methods or only some. There are two ways it can be managed:
4848

49-
1. Disabling payment type from OCC Admin interface which will result in payment option not being rendered in UI (Payment Widget)
49+
1. Disabling payment type from OCC Admin interface which will result in the payment option not being rendered in UI (Payment Widget)
5050
2. Removing unrelated configuration properties from `packages/payment-gateway/gateway/isv-occ-gateway/config/config.json`
5151

5252
![Important](images/important.jpg) In most cases just disabling unsupported payment type from OCC Admin is preferable. Removing unsupported configuration properties can be done in case particular payment types (e.g. GooglePay) should be initially excluded from OCC Admin interface.
@@ -91,8 +91,8 @@ After successful deployment you will need to enable payment gateway:
9191
- Configure gateway settings by providing values (e.g. merchant credentials) for particular channel (Preview, Storefront, Agent)
9292
- Save Changes
9393
- Go back to the 'Payment Types' type
94-
- Select supported credit card types from the list
95-
- You might want to also provide list of supported billing countries as well as default one
94+
- Select supported credit/debit card types from the list [Possible card types: VISA, MASTERCARD, AMEX, DISCOVER, DINERSCLUB, JCB, CARTESBANCAIRES, MAESTRO, CARNET, CUP]
95+
- You might want to also provide list of supported billing countries as well as default one
9696
- Save Changes
9797

9898
## Configure Generic Webhooks
@@ -198,16 +198,16 @@ yarn occ deploy
198198
### Add widget to the Checkout layout
199199

200200
1. Go to the OCC admin design tab and replace the default checkout-continue-to-review-order-button component with the IsvCheckoutContinueToReviewOrderButton on the checkout-payment page
201-
![isf review order path](images/isv-review-order-path.png)
202-
Drag ![isf review order button](images/isv-review-order-button.png) from the Components tray into the layout container.
201+
![isv review order path](images/isv-review-order-path.png)
202+
Drag ![isv review order button](images/isv-review-order-button.png) from the Components tray into the layout container.
203203

204204
2. Go to the OCC admin design tab and replace the default checkout-place-order-button component with the IsvCheckoutPlaceOrderButton on the checkout-review-order page
205-
![isf place order path](images/isv-place-order-path.png)
206-
Drag ![isf place order button](images/isv-place-order-button.png) from the Components tray into the layout container.
205+
![isv place order path](images/isv-place-order-path.png)
206+
Drag ![isv place order button](images/isv-place-order-button.png) from the Components tray into the layout container.
207207

208208
3. Layout the IsvPaymentMethod component on the checkout payments container
209-
![isf payment method path](images/isv-payment-method-path.png)
210-
Remove the checkout-credit-card component from the layout and replace it with ![isf payment method](images/isv-payment-method.png).
209+
![isv payment method path](images/isv-payment-method-path.png)
210+
Remove the checkout-credit-card component from the layout and replace it with ![isv payment method](images/isv-payment-method.png).
211211

212212
4. Publish all changes
213213

documentation/introduction.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,9 @@ The custom payment plugin solution provides an integration layer between OCC and
1414
- Void (Authorization Reversal)
1515
- Capture
1616
- Refund
17-
- Tokenized card payment based on FlexMicroform v0.11
17+
- Tokenized card payment based on Microform v2
1818
- Payer authentication support (3D Secure)
19+
- Network tokenization
1920
- Store tokenized credit card against user profile
2021
- Payments using stored credit cards
2122
2. Online Authorizations

documentation/occ.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
| [Package Contents](package-contents.md) | Detailed explanation of each package included into solution. Documents available payment gateway settings |
1212
| [Installation](installation.md) | Go through installation steps to deploy and configure payment extensions to OCC |
1313
| _Payment Services_ | |
14-
| [Credit Card](payment-services/credit-card.md) | Detailed information about credit card payment services, e.g. FlexMicroform integration, Payer Authentication (3DSecure) etc |
14+
| [Credit Card](payment-services/credit-card.md) | Detailed information about credit card payment services, e.g.Microform integration, Payer Authentication (3DSecure) etc |
1515
| [GooglePay](payment-services/googlepay.md) | Documents GooglePay integration and related technical details |
1616
| [ApplePay](payment-services/applepay.md) | Documents ApplePay integration and related technical details. Includes ApplePay setup steps |
1717
| [Settlement and Refund](payment-services/settlement-refund.md) | Additional payment services to allow fulfillment processes to settle or refund particular transactions when needed |
@@ -64,6 +64,8 @@ This document is written for merchants who want to use Payment and Value added B
6464

6565
- Supplemental Technical Resource Guide for OCC ( [HTML](https://community.oracle.com/docs/DOC-1038707) )
6666
- Generic Payment Gateway Integration ( [HTML](https://docs.oracle.com/en/cloud/saas/cx-commerce/20c/ccdev/create-generic-payment-gateway-integration1.html) )
67-
- SSE Development Best Practices ( [HTML](https://community.oracle.com/customerconnect/discussion/630679/server-side-extension-development-best-practices) )
68-
- Developing OSF in OCC ( [HTML](https://docs.oracle.com/en/cloud/saas/cx-commerce/dosfa/index.html ) )
67+
- Payment Integration with OCC ( [HTML](https://community.oracle.com/docs/DOC-1032741) )
68+
- OCC Payment FAQ ( [HTML](https://community.oracle.com/docs/DOC-1032746) )
69+
- SSE Development Best Practices ( [HTML](https://community.oracle.com/groups/oracle-commerce-cloud-group/blog/2018/11/08/server-side-extension-development-best-practices) )
70+
- Developing Widgets in OCC ( [HTML](https://docs.oracle.com/en/cloud/saas/cx-commerce/20c/widge/create-widget1.html) )
6971
- Cybersource REST API Reference ( [HTML](https://developer.cybersource.com/api-reference-assets/index.html) )

documentation/package-contents.md

+11-7
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The CLI tool is a combined version of utilities shared in the following communit
2121
By running `yarn occ` you will get the list of supported commands
2222

2323
```bash
24-
yarn run v1.22.18
24+
yarn run v1.22.4
2525
$ node ./bin/index.js
2626
Usage: index [options] [command]
2727

@@ -107,7 +107,8 @@ The following settings can be configured in gateway:
107107
| **Credit Card** | |
108108
| **payerAuthEnabled** | Enables payer authentication for credit cards |
109109
| **scaEnabled** | If enabled card holder will be 3DS Challenged when saving a card |
110-
| **flexSdkUrl** | Credit Card Flex SDK URL |
110+
| **networkTokenUpdates** | Subscribe to Network Token Life cycle updates |
111+
| **microformSdkUrl** | Credit Card Microform SDK URL |
111112
| **isCVVRequiredForSavedCards** | Is the CVV required when using a saved card. |
112113
| **isCVVRequiredForScheduledOrders** | Is the CVV required for a Scheduled Order |
113114
| | |
@@ -199,7 +200,8 @@ server-extension
199200
┃ ┃ ┣ paymentMethods.ts
200201
┃ ┃ ┣ paymentRefund.ts
201202
┃ ┃ ┣ paymentRouter.js
202-
┃ ┃ ┗ report.ts
203+
┃ ┃ ┣ report.ts
204+
┃ ┃ ┗ webhookRouter.ts
203205
┃ ┣ errors
204206
┃ ┃ ┣ handlers
205207
┃ ┃ ┃ ┣ api400ResponseHandler.ts
@@ -294,7 +296,8 @@ server-extension
294296
┃ ┃ ┃ ┃ ┃ ┣ captureEndpoint.ts
295297
┃ ┃ ┃ ┃ ┃ ┣ common.ts
296298
┃ ┃ ┃ ┃ ┃ ┣ index.ts
297-
┃ ┃ ┃ ┃ ┃ ┗ refundEndpoint.ts
299+
┃ ┃ ┃ ┃ ┃ ┣ refundEndpoint.ts
300+
┃ ┃ ┃ ┃ ┃ ┗ subscribeApi.js
298301
┃ ┃ ┃ ┃ ┗ common.ts
299302
┃ ┃ ┃ ┣ paymentMethod
300303
┃ ┃ ┃ ┃ ┣ configBuilder.ts
@@ -318,7 +321,8 @@ server-extension
318321
┃ ┃ ┣ cacheService.ts
319322
┃ ┃ ┣ cryptoService.ts
320323
┃ ┃ ┣ jwtService.ts
321-
┃ ┃ ┗ loggingService.ts
324+
┃ ┃ ┣ loggingService.ts
325+
┃ ┃ ┗ publicKeyApi.js
322326
┃ ┣ types
323327
┃ ┃ ┗ occ-sdk.d.ts
324328
┃ ┣ app.ts
@@ -337,7 +341,7 @@ server-extension
337341
| **Endpoint** | **Description** |
338342
|---------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|
339343
| `/ccstorex/custom/isv-payment/v2/paymentMethods` | Returns list of supported payment types. Consumer: Payment Widget |
340-
| `/ccstorex/custom/isv-payment/v2/keys` | Generates Flex public key (capture context). Consumer: Payment Widget |
344+
| `/ccstorex/custom/isv-payment/v2/keys` | Generates Microform public key (capture context). Consumer: Payment Widget |
341345
| `/ccstorex/custom/isv-payment/v2/payments` | Generic Payments Webhook handler endpoint. Consumer: Payment Widget |
342346
| `/ccstorex/custom/isv-payment/v2/applepay/validate` | Validates ApplePay session. Consumer: Payment Widget |
343347
| `/ccstorex/custom/isv-payment/v2/report/daily` | Returns daily conversion report for a given date. Consumer: Fulfillment |
@@ -405,7 +409,7 @@ The table below lists available middleware components
405409

406410
Additional configuration properties managed by 'nconf' library available in OCC environment are located at `packages/server-extension/config`. Please notice there are version for local and production (deployed) environments
407411

408-
SSE communicates with PSP using client [NodeJS SDK v0.0.20](https://github.com/CyberSource/cybersource-rest-client-node). Typescript friendly SDK wrapper is located in the `packages/payment-sdk`. It declares TS type definition's for the PSP API. You can manage generated type definitions by tweaking `packages/payment-sdk/generator/cybersource-ts-template/api.mustache` template. In order to generate new types from the updated template run the following:
412+
SSE communicates with PSP using client [NodeJS SDK v0.0.43](https://github.com/CyberSource/cybersource-rest-client-node). Typescript friendly SDK wrapper is located in the `packages/payment-sdk`. It declares TS type definition's for the PSP API. You can manage generated type definitions by tweaking `packages/payment-sdk/generator/cybersource-ts-template/api.mustache` template. In order to generate new types from the updated template run the following:
409413

410414
```bash
411415
cd packages/payment-sdk

0 commit comments

Comments
 (0)