Loading
Salesforce now sends email only from verified domains. Read More
Insurance
Table of Contents
Select Filters

          No results
          No results
          Here are some search tips

          Check the spelling of your keywords.
          Use more general search terms.
          Select fewer filters to broaden your search.

          Search all of Salesforce Help
          Configure Custom Payment Actions

          Configure Custom Payment Actions

          Configure custom actions that invoke your own front- and back-end processes when users click specific payment actions. For example, configure a custom Request Authority payment action to invoke an integration procedure that changes a payment detail status to Pending Authority, and that invokes an approval process.

          Before You Begin

          Get a head start with the Vlocity Actions DataPack for Payment Actions. It includes a PaymentDetailRequestAuthorityAction Vlocity Action that you can customize or use as a template. See Download and Import Vlocity Actions DataPack for Payment Actions.

          You can also use a Request Ex Gratia Vlocity Action included with your org. See Configure the Request Ex Gratia Payment Action.

          1. Configure a business process, typically an approval process, for your custom payment action.

            For example, if you plan to use the PaymentDetailRequestAuthorityAction Vlocity Action, configure an approval process to run when users click Request Authority.

          2. Create an integration procedure associated with this payment action.

            For example, if you're configuring the PaymentDetailRequestAuthorityAction Vlocity Action, create an integration procedure that:

            • Accept as input either PaymentId from the Claim Payment Summary object or ItemId  from the Claim Coverage Payment Detail object.

              Format the JSON structure like this:

              {
                "itemIds": [
                  {
                    "Id": "0l25c000000CalvAAC"
                  },
                  {
                    "Id": "0l25c000000CalvAAC"
                  }
                ]
              }
              
            • Updates the status of a payment detail record to a value such as Authority Requested.

            • Launches your approval process.

          3. From the App Launcher, find and select Vlocity Actions.
          4. Click New to add a custom payment action, or click an action in the list to edit it.
          5. Enter details about the payment action.

            Vlocity Actions Name

            A description of the payment action.

            Applicable Type

            Remove All from the Chosen list, and add ClaimCoveragePaymentDetail.

            If ClaimCoveragePaymentDetail is missing from the list, go to Object Manager and open Vlocity Action. Then add ClaimCoveragePaymentDetail as a picklist value to the Applicable Type field.

            Display Label

            The label to show users for this action.

            Filter

            The payment status values that go along with this payment action. Users can click the payment action only if the payment detail status meets the filter criteria.

            If you're configuring the PaymentDetailRequestAuthorityAction Vlocity Action, specify which unpaid payment detail statuses show the Request Authority payment action.

            Format: Status IN ('<value>', '<value>', ..., '<value>')

            Example: Status IN ('New', 'Open', 'Authority Denied')

            Target URL

            or

            Invocation Class Name, Invocation Method Name

            Use these fields to configure either a front-end or back-end process.

            • For a front-end process, for Target URL, enter the URL of an OmniScript to launch when the user clicks the payment action.

            • For a back-end process, for Invocation Class Name and Invocation Method Name, enter the class and method names for the remote action to launch when the user clicks the payment action.

            If you're configuring the PaymentDetailRequestAuthorityAction Vlocity Action, have it call the integration procedure you configured for the Request Authority payment action.

            Example of a configured PaymentDetailRequestAuthorityAction​ payment action
          6. Confirm that the user interface lets users click the payment action for the correct claim payment statuses.

            If a claim's Financials tab doesn't show the action, clear the session cache and reload the page.

            Make sure that individual payment details show the action, and that the action dropdown at the top of the page shows the action only if it applies to all the selected payment details. Also confirm that front- and back-end processes launch as expected for the new action.

            Multiple payment details selected with an option to pay them all

          Users who process claims can select the payment action if selected claim payment detail statuses meet the filter criteria for that action.

          An open payment detail with options to edit, delete, or request approval
           
          Loading
          Salesforce Help | Article