You are here:
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.
-
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.
-
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
PaymentIdfrom the Claim Payment Summary object orItemIdfrom 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.
-
- From the App Launcher, find and select Vlocity Actions.
- Click New to add a custom payment action, or click an action in the list to edit it.
-
Enter details about the payment action.
-
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.

