{"title":"Authorization Reversal","category":"default","creationDate":1674038040,"content":"

Authorization Reversal is a Salesforce feature that enables you to release the reserved authorization amount on a shopper's card, for example when you can no longer fulfill the order. To use the feature, you make a request to the Salesforce Payment Authorization Reversal Service API<\/a>.<\/p>\n

You can enable Authorization Reversal with our OMS package to handle the request in the back-end and process the reversal. An Authorization Reversal in Salesforce is equivalent to cancelling a payment<\/a> in Adyen.<\/p>\n

Requirements<\/h2>\n
    \n
  1. Have a fully functional Salesforce OMS Org that is connected to your Salesforce Commerce Cloud (SFCC)<\/a> storefront.<\/li>\n
  2. Install and set up the Adyen Salesforce OMS package<\/a> v3.1.0 or later.<\/li>\n
  3. Read the Salesforce documentation for the Payment Authorization Reversal Service API<\/a>.<\/li>\n<\/ol>\n

    Step 1: Expose the Salesforce site endpoint<\/h2>\n

    Adyen uses webhooks<\/a> to inform you of changes to payment statuses. To receive these webhooks, expose your Salesforce site endpoint.<\/p>\n

      \n
    1. In your Salesforce Org, go to Setup<\/strong>.<\/li>\n
    2. In the Quick Find<\/strong> box, search for User Interface<\/strong>.<\/li>\n
    3. Under User Interface<\/strong>, go to Sites and Domains<\/strong> > Sites<\/strong>.<\/li>\n
    4. Select the Adyen<\/strong> site. This opens the Site Details<\/strong> page.<\/li>\n
    5. Select Public Access Settings<\/strong>. This opens the Public Access Settings<\/strong> page.<\/li>\n
    6. Under Apps<\/strong>, select Apex Class Access<\/strong>.<\/li>\n
    7. Select Edit<\/strong>.<\/li>\n
    8. Under Available Apex Classes<\/strong>, select adyen_payment.NonPaymentWebhookHandler<\/strong>, and then select Add<\/strong> to move it to the Enabled Apex Classes<\/strong> list.<\/li>\n
    9. Select Save<\/strong>.<\/li>\n<\/ol>\n

      Step 2: Configure webhooks in Adyen<\/h2>\n
      \n

      If you are on Salesforce OMS 3.3.0 or later, you do not need to configure an additional webhook for Authorization Reversal.<\/p>\n<\/div><\/div>\n

      When our package processes the authorization reversal in Salesforce, you receive a CANCELLATION<\/strong> webhook that informs you of the outcome at the endpoint that you have exposed<\/a>. To set up this webhook:<\/p>\n

        \n
      1. \n

        In your Customer Area<\/a>, go to Developers<\/strong>\u00a0>\u00a0 Webhooks<\/strong>. Switch to the merchant account that you use to process captures and refunds.<\/p>\n<\/li>\n

      2. \n

        Select <\/i> Webhook<\/strong>.<\/p>\n<\/li>\n

      3. \n

        From the list of webhooks, next to Standard webhook<\/strong>, select Add<\/strong>.
        \nThis opens the configuration page for the standard webhook.<\/p>\n<\/li>\n

      4. \n

        Under General<\/strong>, configure the following:<\/p>\n\n\n\n\n\n\n\n
        Setting<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
        Enabled<\/strong><\/td>\nSelect the toggle to enable or disable the webhook.<\/td>\n<\/tr>\n
        Version<\/strong><\/td>\nThe webhook version.<\/td>\n<\/tr>\n
        Description<\/strong><\/td>\nYour description of the webhook.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n
      5. \n

        Under Server configuration<\/strong>, configure the following:<\/p>\n\n\n\n\n\n\n\n
        Setting<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
        URL<\/strong><\/td>\nYOUR_SALESFORCE_SITE_URL\/adyen\/services\/apexrest\/adyen_payment\/nonPaymentWebhook\/v1<\/strong><\/td>\n<\/tr>\n
        Method<\/strong><\/td>\nJSON<\/strong><\/td>\n<\/tr>\n
        Encryption protocol<\/strong><\/td>\nThe latest TLS version<\/strong> in the list.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n
      6. \n

        Under Security<\/strong>, configure the following:<\/p>\n\n\n\n\n\n
        Setting<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
        HMAC Key<\/strong><\/td>\nEnter your existing HMAC key that you generated when you set up the package<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n
      7. \n

        Under Events<\/strong>, select CANCELLATION<\/strong>.<\/p>\n<\/li>\n

      8. \n

        Select Save configuration<\/strong>.<\/p>\n<\/li>\n<\/ol>\n

        \n

        Our package only supports cancelling the payment for the order in Salesforce. To cancel the order itself, you must implement your own logic.<\/p>\n<\/div>\n

        Step 3: Make an Authorization Reversal request<\/h2>\n

        Follow the Salesforce documentation<\/a> to learn about how to make a request using the Payment Authorization Reversal Service API.<\/p>\n

        In your request, make sure that the value for the amount<\/code> field you send in your request matches the Available to Capture<\/strong> amount that you see in the Order Payment Summary object<\/a>.<\/p>\n

        Step 4: Get the outcome<\/h2>\n

        After you make a request to reverse an authorization, our package processes the authorization reversal. You can monitor the status of your reversal request in the Salesforce logs<\/a>, but you get the final outcome from Adyen in a webhook<\/a>.<\/p>\n

        Monitor Salesforce logs<\/h3>\n

        You can monitor Salesforce Payment Gateway logs<\/a> to stay informed on the status of your authorization reversal request.<\/p>\n

        For an authorization reversal, the PaymentGatewayLog<\/code> object contains:<\/p>\n