Skip to content

Latest commit

 

History

History
193 lines (153 loc) · 15.4 KB

HowToRun.md

File metadata and controls

193 lines (153 loc) · 15.4 KB
Raw

How to run

Environment variable

Extension module requires 1 environment variable to start. This environment variable name is ADYEN_INTEGRATION_CONFIG and it must contain settings as attributes in a JSON structure.

{
  "commercetools": {
    "commercetoolsProjectKey1": {
      "clientId": "xxx",
      "clientSecret": "xxx"
    },
    "commercetoolsProjectKey2": {
      "clientId": "xxx",
      "clientSecret": "xxx"
    }
  },
  "adyen": {
    "adyenMerchantAccount1": {
      "apiKey": "xxx"
    },
    "adyenMerchantAccount2": {
      "apiKey": "xxx"
    }
  },
  "adyenPaymentMethodsToNames": {
    "scheme": {
      "en": "Credit Card"
    },
    "pp": {
      "en": "PayPal"
    },
    "klarna": {
      "en": "Klarna"
    },
    "gpay": {
      "en": "Google Pay"
    },
    "affirm": {
      "en": "Affirm"
    }
  }
}

ADYEN_INTEGRATION_CONFIG JSON structure contains different attribute groups and optional attributes as described below:

  • adyen attribute group: Multiple child attributes can be provided in the adyen attribute. Each direct child attribute must represent an adyen merchant account.
  • commercetools attribute group: Multiple child attributes can be provided in the commercetools attribute. Each direct child attribute must represent a commercetools project.
  • standalone optional attributes : Standalone attributes can be set as direct child attributes in the root of the JSON.

Preparing the credentials

  • Adyen credentials:
    • For test environment follow the official Adyen get started guide to set up your test account, get your API key.
    • For live environment follow the official Adyen documentation for details.
  • commercetools project credentials:
    • If you don't have the commercetools OAuth credentials,create a commercetools API Client.
      • Note that extension module requires manage_payments, view_orders scopes for the integration and manage_types, manage_extensions scopes for setting up required resources.

Required attributes

Group Name Content
adyen apiKey You'll be making API requests that are authenticated with an Adyen API key.
commercetools clientId OAuth 2.0 client_id and can be used to obtain a token.
commercetools clientSecret OAuth 2.0 client_secret and can be used to obtain a token.

Optional attributes

Group Name Content Default value
adyen apiBaseUrl Checkout endpoint 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.
/ basicAuth Boolean attribute to enable/disable basic authentication to prevent unauthorized 3rd-party from accessing extension endpoint false
/ 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'}
/ 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. true
/ port The port number on which the application will run. 8080
/ logLevel The log level (trace, debug, info, warn, error, fatal). info
/ keepAliveTimeout Milliseconds to keep a socket alive after the last response (Node.js docs). Node.js default (5 seconds)
/ generateIdempotencyKey If set to true, adyen-integration will generate the idempotency key for capture and refund requests. false
/ apiExtensionBaseUrl Publicly available URL of the Extension module. In case of any payment changes, commercetools API extension will call this URL and pass the payment object in body. This attribute is used when calling npm run setup-resources

Standalone Optional Attributes

Standalone optional attributes should be set as direct child attributes in ADYEN_INTEGRATION_CONFIG, as displayed below:

{
  "commercetools": {...},
  "adyen": {...},
  "logLevel": "DEBUG",
  "port": 8080,
  "keepAliveTimeout": 10000,
  "removeSensitiveData": false
}

External file configuration

In case you have a huge configuration that reaches above the environment limits (e.g the total size of all environment variables on AWS Lambda can't exceed 4 KB.), you could use the external file configuration instead of setting ADYEN_INTEGRATION_CONFIG environment variable. The extension module will look for the .extensionrc file in the extension folder. The file should contain the same JSON content as it's defined with environment variable.

Commercetools project requirements

Resources below are required for the extension module to operate correctly.

  1. The commercetools HTTP API Extension pointing to Adyen extension module
  2. Payment custom type
  3. Payment-interface-interaction custom type

First, you will need to configure ExtensionDraft destination according to your deployment. A destination contains all info necessary for the commercetools platform to call the extension module. Please follow the commercetools HTTP API Extension documentation for details.

After you change the destination, you can set up required resources in your commercetools projects by running the script npm run setup-resources, the script requires the ADYEN_INTEGRATION_CONFIG to be set as an environment variable.

export ADYEN_INTEGRATION_CONFIG=xxxx
npm run setup-resources

Other requirements

Affirm payment

Please run following CURL command in order to list out all payment methods in US supported by your Adyen account.` Make sure Affirm payment is inside the response.

curl https://checkout-test.adyen.com/v71/paymentMethods \
-H "x-API-key: YOUR_ADYEN_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "merchantAccount": "YOUR_ADYEN_MERCHANT_ACCOUNT",
  "countryCode": "US",
  "amount": {
    "currency": "USD",
    "value": 1000
  },
  "channel": "Web",
  "shopperLocale": "us-US"
}'

If Affirm payment is not supported, please contact Adyen technical support and provide all following information :

  • Affirm payment account public API key
  • Affirm payment account ARI

Adyen makes use of the provided credential to integrate your account to Affirm payment platform.

For more details about Affirm credential, please visit the Affirm doc and contact Affirm support through it.

Running

Docker

Refer to our docker hub page to see the latest releases and tags.

Running the Docker image

    docker run \
    -e ADYEN_INTEGRATION_CONFIG=xxxxxx \
    commercetools/commercetools-adyen-integration-extension:vX.X.X

Deployment

Extension module supports different deployment options. It could be either hosted on-premises (run docker containers behind the load balancer) or deployed as a serverless application.