diff --git a/extension/docs/HowToRun.md b/extension/docs/HowToRun.md index ed520064f..d80ae8531 100644 --- a/extension/docs/HowToRun.md +++ b/extension/docs/HowToRun.md @@ -87,20 +87,20 @@ Extension module requires 1 environment variable to start. This environment vari ### Optional attributes -| Group | Name | Content | Default value | -| --------------- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -| `adyen` | `apiBaseUrl` | [Checkout endpoint](https://docs.adyen.com/development-resources/live-endpoints#checkout-endpoints) of Adyen. | `https://checkout-test.adyen.com/v71` (even though it is not required, you **need** to specify a URL for **live environment**) | -| `commercetools` | `apiUrl` | The commercetools HTTP API is hosted at that URL. | `https://api.europe-west1.gcp.commercetools.com` | -| `commercetools` | `authUrl` | The commercetools’ OAuth 2.0 service is hosted at that URL. | `https://auth.europe-west1.gcp.commercetools.com` | -| `commercetools` | `authentication` | This setting only takes effect when `basicAuth` ( a child attribute in `ADYEN_INTEGRATION_CONFIG` ) is set to `true`. It enables authentication mechanism to prevent unauthorized access to the extension module. When it is provided as a JSON object, it must contain 3 separate attributes. They are `scheme` attribute which supports `basic` type, `username` and `password` attribute defined by user. | | -| `other` | `basicAuth` | Boolean attribute to enable/disable basic authentication to prevent unauthorized 3rd-party from accessing extension endpoint | false | -| `other` | `adyenPaymentMethodsToNames` | Key-value object where key is `paymentMethod` attribute from Adyen AUTHORIZATION notification and value is the custom localized name that will be saved in CTP `payment.paymentMethodInfo.name`. | `{scheme: {en: 'Credit Card'}, pp: {en: 'PayPal'}, klarna: {en: 'Klarna'}, gpay: {en: 'Google Pay'}, affirm: {en: 'Affirm'}` | -| `other` | `removeSensitiveData` | Boolean attribute. When set to "false", Adyen fields with additional information about the payment will be saved in the interface interaction and in the custom fields. This attribute can also be overridden per request by adding `removeSensitiveData` to the request. For an example usage see [Store payment documentation](./StorePayment.md). | true | -| `other` | `port` | The port number on which the application will run. | 8080 | -| `other` | `logLevel` | The log level (`trace`, `debug`, `info`, `warn`, `error`, `fatal`). | `info` | -| `other` | `keepAliveTimeout` | Milliseconds to keep a socket alive after the last response ([Node.js docs](https://nodejs.org/dist/latest/docs/api/http.html#http_server_keepalivetimeout)). | Node.js default (5 seconds) | -| `other` | `generateIdempotencyKey` | If set to true, adyen-integration will generate the idempotency key for capture and refund requests. | false | -| `other` | `apiExtensionBaseUrl` | Publicly available URL of the Extension module. In case of any payment changes, [commercetools API extension](https://docs.commercetools.com/api/projects/api-extensions) will call this URL and pass the payment object in body. This attribute is used when calling `npm run setup-resources` | | +| Group | Name | Content | Default value | +| --------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `adyen` | `apiBaseUrl` | [Checkout endpoint](https://docs.adyen.com/development-resources/live-endpoints#checkout-endpoints) of Adyen. | `https://checkout-test.adyen.com/v71` (even though it is not required, you **need** to specify a URL for **live environment**) | +| `commercetools` | `apiUrl` | The commercetools HTTP API is hosted at that URL. | `https://api.europe-west1.gcp.commercetools.com` | +| `commercetools` | `authUrl` | The commercetools’ OAuth 2.0 service is hosted at that URL. | `https://auth.europe-west1.gcp.commercetools.com` | +| `commercetools` | `authentication` | This setting only takes effect when `basicAuth` ( a child attribute in `ADYEN_INTEGRATION_CONFIG` ) is set to `true`. It enables authentication mechanism to prevent unauthorized access to the extension module. When it is provided as a JSON object, it must contain 3 separate attributes. They are `scheme` attribute which supports `basic` type, `username` and `password` attribute defined by user. | | +| `other` | `basicAuth` | Boolean attribute to enable/disable basic authentication to prevent unauthorized 3rd-party from accessing extension endpoint | false | +| `other` | `adyenPaymentMethodsToNames` | Key-value object where key is `paymentMethod` attribute from Adyen AUTHORIZATION notification and value is the custom localized name that will be saved in CTP `payment.paymentMethodInfo.name`. | `{scheme: {en: 'Credit Card'}, pp: {en: 'PayPal'}, klarna: {en: 'Klarna'}, gpay: {en: 'Google Pay'}, affirm: {en: 'Affirm'}` | +| `other` | `removeSensitiveData` | Boolean attribute. When set to "false", Adyen fields with additional information about the payment will be saved in the interface interaction and in the custom fields. This attribute can also be overridden per request by adding `removeSensitiveData` to the request. For an example usage see [Store payment documentation](./StorePayment.md). | true | +| `other` | `port` | The port number on which the application will run. | 8080 | +| `other` | `logLevel` | The log level (`trace`, `debug`, `info`, `warn`, `error`, `fatal`). | `info` | +| `other` | `keepAliveTimeout` | Milliseconds to keep a socket alive after the last response ([Node.js docs](https://nodejs.org/dist/latest/docs/api/http.html#http_server_keepalivetimeout)). | Node.js default (5 seconds) | +| `other` | `generateIdempotencyKey` | If set to true, adyen-integration will generate the idempotency key for capture and refund requests. | false | +| `other` | `apiExtensionBaseUrl` | Publicly available URL of the Extension module. In case of any payment changes, [commercetools API extension](https://docs.commercetools.com/api/projects/api-extensions) will call this URL and pass the payment object in body. This attribute is used when calling `npm run setup-resources` | | ### External file configuration diff --git a/extension/docs/WebComponentsIntegrationGuide.md b/extension/docs/WebComponentsIntegrationGuide.md index 71f3c620e..be2a86161 100644 --- a/extension/docs/WebComponentsIntegrationGuide.md +++ b/extension/docs/WebComponentsIntegrationGuide.md @@ -396,7 +396,7 @@ In this case you have to handle it on the return URL front-end page. Extension module sends the `lineItems` field in the Adyen request, taking the data from the `lineItems` field in `createSessionRequest`. -If the field does not exist in `createSessionRequest`, then module automatically populates `lineItems` from the CommerceTools cart. +If the field does not exist in `createSessionRequest`, then module automatically populates `lineItems` from the CommerceTools cart. Extension module does not rely on the deprecated `addCommercetoolsLineItems` flag from the `createSessionRequest`.