Skip to content

Commit bc1170a

Browse files
Merge pull request #25 from cybersource-tpi/develop
Develop
2 parents ff25f37 + a6f3ee9 commit bc1170a

File tree

9 files changed

+18
-18
lines changed

9 files changed

+18
-18
lines changed
Binary file not shown.
Binary file not shown.

documentation/installation.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -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,7 +91,7 @@ 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 [Possible card types: VISA, MASTERCARD, AMEX, DISCOVER, DINERSCLUB, JCB, CARTESBANCAIRES, MAESTRO, CARNET, CUP]
94+
- Select supported credit/debit card types from the list [Possible card types: VISA, MASTERCARD, AMEX, DISCOVER, DINERSCLUB, JCB, CARTESBANCAIRES, MAESTRO, CARNET, CUP]
9595
- You might want to also provide list of supported billing countries as well as default one
9696
- Save Changes
9797

documentation/introduction.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ 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 v2
17+
- Tokenized card payment based on Microform v2
1818
- Payer authentication support (3D Secure)
1919
- Network tokenization
2020
- Store tokenized credit card against user profile

documentation/occ.md

+1-1
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 |

documentation/package-contents.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ The following settings can be configured in gateway:
108108
| **payerAuthEnabled** | Enables payer authentication for credit cards |
109109
| **scaEnabled** | If enabled card holder will be 3DS Challenged when saving a card |
110110
| **networkTokenUpdates** | Subscribe to Network Token Life cycle updates |
111-
| **flexSdkUrl** | Credit Card Flex SDK URL |
111+
| **microformSdkUrl** | Credit Card Microform SDK URL |
112112
| **isCVVRequiredForSavedCards** | Is the CVV required when using a saved card. |
113113
| **isCVVRequiredForScheduledOrders** | Is the CVV required for a Scheduled Order |
114114
| | |
@@ -341,7 +341,7 @@ server-extension
341341
| **Endpoint** | **Description** |
342342
|---------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|
343343
| `/ccstorex/custom/isv-payment/v2/paymentMethods` | Returns list of supported payment types. Consumer: Payment Widget |
344-
| `/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 |
345345
| `/ccstorex/custom/isv-payment/v2/payments` | Generic Payments Webhook handler endpoint. Consumer: Payment Widget |
346346
| `/ccstorex/custom/isv-payment/v2/applepay/validate` | Validates ApplePay session. Consumer: Payment Widget |
347347
| `/ccstorex/custom/isv-payment/v2/report/daily` | Returns daily conversion report for a given date. Consumer: Fulfillment |

documentation/payment-services/credit-card.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
1. [Description](#description)
44
2. [Implementation Details](#implementation-details)
55
1. [Configuration](#configuration)
6-
2. [FlexMicroform Card Payments](#flexmicroform-card-payments)
6+
2. [Microform Card Payments](#microform-card-payments)
77
1. [UI integration details](#ui-integration-details)
88
2. [Backend (SSE) integration details](#backend-sse-integration-details)
99
3. [Payer Authentication](#payer-authentication)
@@ -27,13 +27,13 @@ The Credit Card payment service provides the following operations:
2727

2828
The following applies to credit card payments:
2929

30-
- Credit card payments using [FlexMicroform v2](https://developer.cybersource.com/api/developer-guides/dita-flex/SAFlexibleToken/FlexMicroform.html). The transient token represents both card number (PAN) and CVV. Only token, card expiration date and masked card number going to be sent in a webhook request.
30+
- Credit card payments using [Microform v2](https://developer.cybersource.com/api/developer-guides/dita-flex/SAFlexibleToken/FlexMicroform.html). The transient token represents both card number (PAN) and CVV. Only token, card expiration date and masked card number going to be sent in a webhook request.
3131
- Payer Authentication (3D Secure)
3232
- Shopper can choose to save credit card as part of profile
3333
- Subscribe to Network Token life cycle updates
3434
- Shopper can pay with a saved card
3535

36-
![Note](../images/note.jpg) With Flex Microform, the capture of card number and security code (CVV) are fully outsourced to the payment provider, which can qualify merchants for SAQ A-based assessments. Flex Microform provides the most secure method for tokenizing card data. Sensitive data is encrypted on the customer's device before HTTPS transmission to the payment provider. This method mitigates any compromise of the HTTPS connection through a man in the middle attack.
36+
![Note](../images/note.jpg) With Microform, the capture of card number and security code (CVV) are fully outsourced to the payment provider, which can qualify merchants for SAQ A-based assessments. Microform provides the most secure method for tokenizing card data. Sensitive data is encrypted on the customer's device before HTTPS transmission to the payment provider. This method mitigates any compromise of the HTTPS connection through a man in the middle attack.
3737

3838
## Implementation Details
3939

@@ -61,7 +61,7 @@ Default values:
6161
- `isCVVRequiredForScheduledOrders`: false
6262
- `saleEnabled` - by default SALE is disabled for Card payments. Can be enabled in OCC Admin
6363

64-
### FlexMicroform Card Payments
64+
### Microform Card Payments
6565

6666
The following describes the end to end use case with an option to save credit card:
6767

@@ -83,7 +83,7 @@ The following describes the end to end use case with an option to save credit ca
8383

8484
**Note:** Saved Card feature is supported only during checkout
8585

86-
![Flex Microform](images/credit-card-payment-flow.png)
86+
![Microform](images/credit-card-payment-flow.png)
8787

8888
#### UI integration details
8989

@@ -192,7 +192,7 @@ plugins
192192
- Before Payment Widget is rendered available payment methods are retrieved from SSE `/ccstorex/custom/isv-payment/v2/paymentMethods` endpoint. Saved credit cards are also retrieved from OCC in case user is logged-in.
193193
- `Card` component renders by default list of saved cards if it is not empty and user is logged-in. Otherwise credit card form is rendered
194194
- Credit card form is managed by `IsvCheckoutCardDetails` component. Saved cards are managed by `IsvCheckoutSavedCards` component. Shopper can switch between both components to choose preferable way to pay.
195-
- FlexMicroform is initialized by fetching keys from SSE using `/ccstorex/custom/isv-payment/v2/keys` endpoint
195+
- Microform is initialized by fetching keys from SSE using `/ccstorex/custom/isv-payment/v2/keys` endpoint
196196
- Transient token is generated client side and is then included into payment details during order submission
197197
- In case shopper pays with saved card only savedCardId is sent and transient token is not generated. Shopper can also choose to set card as default
198198

@@ -201,7 +201,7 @@ plugins
201201
List of related controllers:
202202

203203
- `server-extension/src/controllers/paymentMethods.ts` - return supported payment method configurations
204-
- `server-extension/src/controllers/flex.ts` - generate Flex keys
204+
- `server-extension/src/controllers/flex.ts` - generate Microform keys
205205

206206
The list of handlers processing credit card Webhook requests in SSE can be found in `server-extension/src/services/payments/index.ts`
207207

@@ -227,7 +227,7 @@ The list of handlers processing credit card Webhook requests in SSE can be found
227227
Consume authentication is supported through the means of [Cardinal Cruise](https://cardinaldocs.atlassian.net/wiki/spaces/CC/overview?mode=global) integration. According to documentation:
228228
> If you are using tokenization, you must use the Direct integration method.
229229
230-
Considering FlexMicroform is based on credit card tokenization and same is applicable to saved credit cards the Direct integration method has being considered for implementation. Please refer to the following documentation on how Direct integration method works:
230+
Considering Microform is based on credit card tokenization and same is applicable to saved credit cards the Direct integration method has being considered for implementation. Please refer to the following documentation on how Direct integration method works:
231231

232232
- [Cybersource Payer Authentication using Simple Order API](https://developer.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SO_API/Payer_Authentication_SO_API.pdf)
233233
- [Direct Payer Authentication](https://developer.cybersource.com/content/dam/docs/cybs/en-us/payer-authentication/developer/all/rest/payer-auth.pdf)
@@ -243,7 +243,7 @@ Payer authentication is enabled by default using `payerAuthEnabled` gateway sett
243243
Generally payer authentication services are executed together with credit card authorization:
244244

245245
1. PayerAuth setup is created using card information using `/ccstorex/custom/isv-payment/v2/payerAuth/setup` SSE endpoint
246-
2. Credit card is tokenized as per process described in the [FlexMicroform Card Payments](#flexmicroform-card-payments) section
246+
2. Credit card is tokenized as per process described in the [Microform Card Payments](#microform-card-payments) section
247247
3. Order is created and "Authorize" Webhook request is triggered
248248
4. Credit card Authorization service is called along with Payer Auth Enrollment
249249
5. In case credit card is enrolled in payer authentication, authorization is rejected with specific reason code (10000). The response from payment provider will contain all data needed to start consumer authentication flow in storefront

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@
202202
"type": "stringType",
203203
"labelResourceId": "flexSdkUrlLabel",
204204
"helpTextResourceId": "flexSdkUrlHelpText",
205-
"defaultValue": "flexSdkUrl",
205+
"defaultValue": "microformSdkUrl",
206206
"required": true,
207207
"public": false
208208
},

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@
6262
"googlePayMerchantNameHelpText": "Merchant name encoded as UTF-8. Merchant name is rendered in the payment sheet. In TEST environment, or if a merchant isn't recognized, a “Pay Unverified Merchant” message is displayed in the payment sheet",
6363
"googlePaySupportedNetworksLabel": "Google Pay Supported Networks",
6464
"googlePaySupportedNetworksHelpText": "Comma separated list of networks. eg: 'AMEX,DISCOVER,INTERAC,JCB,MASTERCARD,VISA'",
65-
"flexSdkUrlLabel": "Credit Card Flex SDK URL",
65+
"flexSdkUrlLabel": "Credit Card Microform SDK URL",
6666
"flexSdkUrlHelpText": "",
6767
"applePayDisplayNameLabel": "Apple Pay Display Name",
6868
"applePayDisplayNameHelpText": "Name to be displayed on Apple Pay payment sheet",

0 commit comments

Comments
 (0)