{"title":"Set up the extension","category":"default","creationDate":1781619336,"content":"
\n

Deprecated<\/strong>
\nThis Oracle Commerce Cloud extension is deprecated and we are no longer accepting integrations with it.
\nWe are working on a new extension for Oracle Commerce Cloud.<\/p>\n<\/div><\/div>\n

Step 1: Set up the Adyen Customer Area<\/h2>\n

Set up an API key<\/h3>\n

To set up an API key in the Adyen Customer Area:<\/p>\n

    \n
  1. Log in to your Customer Area<\/a> and select your Company<\/strong> account.<\/li>\n
  2. Go to Developers<\/strong> > API credentials<\/strong>.<\/li>\n
  3. Select the Payments<\/strong> or Platforms<\/strong> tab, depending on your integration type.<\/li>\n
  4. Select the credential username.<\/li>\n
  5. Under Server settings<\/strong> > Authentication<\/strong> select the API key<\/strong> tab.<\/li>\n
  6. Select Generate API key<\/strong>.<\/li>\n
  7. Select the copy icon <\/i> and store your API key securely in your system.\n
    \n

    You cannot copy the API key again after you leave the page.<\/p>\n<\/div>\n<\/li>\n

  8. Select Save changes<\/strong>.<\/li>\n<\/ol>\n

    Set up the capture delay<\/h3>\n

    To set up the capture delay in the Adyen Customer Area:<\/p>\n

      \n
    1. In the Adyen\u00a0Customer Area<\/a>, go\u00a0to\u00a0Settings<\/strong>\u00a0>\u00a0Account settings<\/strong>.<\/li>\n
    2. In the Capture Delay<\/strong> drop-down menu, set the field to immediate<\/strong> (if not already set). In immediate captures, payments are captured immediately after authorisation.<\/li>\n
    3. Select\u00a0Submit<\/strong>.<\/li>\n<\/ol>\n
      \n

      Oracle Commerce Cloud does not support manual captures needed for asynchronous payment methods like Boleto. When an order is submitted using Boleto, you cannot manually capture the payment in the Oracle Commerce Cloud. You need to do so in your order management system.<\/p>\n<\/div>\n

      Step 2: Configure the extension<\/h2>\n

      You need to configure the extension in your Oracle Commerce Cloud for your test environment (Preview<\/strong>). When you move to your live environment (Storefront<\/strong> or Agent<\/strong>), set these fields with your live configuration values.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
      Field<\/th>\nAction<\/th>\n<\/tr>\n<\/thead>\n
      Payment Methods<\/td>\nSelect the payment methods that you will provide.<\/td>\n<\/tr>\n
      Merchant Account<\/td>\nEnter your merchant account name.<\/td>\n<\/tr>\n
      API Key<\/td>\nEnter the API Key<\/a> that you set up in the Adyen Customer Area<\/a>.<\/td>\n<\/tr>\n
      Client Key<\/td>\nEnter the client key<\/a> you set up in the Adyen Customer Area<\/a>.<\/td>\n<\/tr>\n
      Stored Payment Methods<\/td>\nSelect if your shoppers can store their payment details for one-click or recurring payments (or both).<\/td>\n<\/tr>\n
      Environment<\/td>\nSet to Test<\/strong> or Live<\/strong>, depending on your integration.<\/td>\n<\/tr>\n
      Enable installments<\/td>\nSelect this option to enable installments<\/a>. If you enable installments, enter the Installments option code<\/a> that you get from the installments option wizard.<\/td>\n<\/tr>\n
      Boleto Validity<\/td>\n(Fill in this field only if you are providing Boleto as a payment method). Specify the number of days the Boleto is valid for payment.<\/td>\n<\/tr>\n
      Boleto payment instructions<\/td>\n(Fill in this field only if you are providing Boleto as a payment method). Enter the text that will be shown in the Boleto payment instructions.<\/td>\n<\/tr>\n
      Enable card holder name<\/td>\nSelect this option to show the card holder name field for card payments. If shown, the card holder name is a required field.<\/td>\n<\/tr>\n
      Country Code<\/td>\nFill in this field with the two-letter country code. This is a required field for some payment methods, for example Klarna, iDEAL, or Boleto.
      Format: the two-letter ISO-3166-1 alpha-2<\/a> country code. Exception: QZ<\/strong> (Kosovo).<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

      Set up Generic Payment Function API<\/h3>\n

      The Generic Payment URL can be used to send authorisation requests externally. The Oracle Commerce Cloud uses webhooks to send JSON notifications to specified URLs every time an event occurs, for example, every time a shopper completes an order.<\/p>\n

        \n
      1. Go to Settings<\/strong> > Web APIs<\/strong>.<\/li>\n
      2. In the Webhook<\/strong> tab, go to the Function APIs<\/strong> section and open the Generic Payment - Preview<\/strong> entry.<\/li>\n
      3. Fill in the following:<\/li>\n<\/ol>\n\n\n\n\n\n\n\n
        Field<\/th>\nValue<\/th>\n<\/tr>\n<\/thead>\n
        URL<\/td>\nYour web store URL followed by \/ccstorex\/custom\/adyen\/v1\/payments<\/code>. The URL must use HTTPS.<\/td>\n<\/tr>\n
        Username<\/td>\nChoose any username for this field.<\/td>\n<\/tr>\n
        Password<\/td>\nChoose any password for this field.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

        Optional configuration: Installments<\/h2>\n

        To provide installments in your Oracle Commerce Cloud integration, you need to use an external tool to set your preferred installment rules. You can provide installments to your shoppers if your ecommerce store is in Brazil and Mexico.<\/p>\n

        Define installments<\/h3>\n

        To define your installments:<\/p>\n

          \n
        1. Go to the Adyen Oracle Commerce Cloud installments options wizard.<\/li>\n
        2. Select Create<\/strong>.<\/li>\n
        3. Add the installment options you want to offer to your shoppers. For each installment, specify:\n