Configuring Refund Handling
← Setting Up Payments/Payouts Management
In JustOn Cash Management, refunds track money being returned to a payer in connection with a previously received payment.
Depending on your JustOn Cash Management version, configuring the refund handling may involve the following tasks:
- Enabling refund statuses
- Enabling refund information display
- Enabling refund approval
- Enabling user interactions on refunds
- Setting refund reasons
- Setting refund cancellation reasons
Enabling Refund Statuses
If you have upgraded JustOn Cash Management from a pre-1.33 or pre-1.49 version, you may have to add the new picklist values to the Status
field of the Refund object. To do so:
- Click to enter Setup, then navigate to the object management settings of the Refund object (
JPAY1__Refund__c
). - Click Fields & Relationships.
- Click the name of the
Status
field. -
In the Values section, click New.
Add the relevant status values, each in a new line. The required values include
Prepared
Approved
Pending
Refunded
Failed
Canceled
-
Click Save.
This saves the specified status values as required.
For details about modifying the values of picklist fields, see Add or Edit Picklist Values in the Salesforce Help.
Info
As of v1.49, you can remove the deprecated values Issued
, Open
, Reversed
and Rejected
from the Status
picklist.
Enabling Refund Information Display
JustOn Cash Management 1.49 has enhanced the support for handling refunds. If you have upgraded JustOn Cash Management from a pre-1.49 version, you may have to manually add two new fields to the user interface:
Refund
→ Bank Statement Item layoutMatching Result
→ Refund layout
To do so:
- Click to enter Setup.
- Navigate to the object management settings of the Bank Statement Item object.
- Click Page Layouts.
- In the Bank Statement Item Layout row, click , then select Edit.
- Drag the field
Refund
to the page layout. - Click Save.
- Navigate to the object management settings of the Refund object (
JPAY1__Refund__c
). - Click Page Layouts.
- In the Refund Layout row, click , then select Edit.
- Drag the field
Matching Result
to the page layout. - Click Save.
Enabling Refund Approval
To allow a fine-grained control over which users can approve refunds, the relevant permissions are not part of the default permission sets. Instead, JustOn Cash Management provides two dedicated custom permissions: one for approving refunds and another that additionally allows for changing the payment instrument to be used.
Custom Permission | Description |
---|---|
Approve Refund | Allows setting the refund status Approved , making the refund ready for payout. |
Approve Unreferenced Refund | Allows refunding money using a payment method other than the original. To be used only when the original payment method is no longer available to prevent money laundering. |
Summary
Users who approve refunds must be assigned the custom permission Approve Refund.
Users who both approve refunds and change refund payment instruments must be assigned the custom permission Approve Unreferenced Refund.
Assign the custom permissions via a permission set, which is the preferred way, or a profile.
To assign a custom permission via a permission set:
- Click to enter Setup, then navigate to Users > Permission Sets.
-
Click the name of the relevant permission set.
Alternatively, create a new, dedicated permission set. For details, see Create Permission Sets in the Salesforce Help.
-
In the Apps section, click Custom Permissions.
- Click Edit.
-
Select
JPAY1.Approve Refund
orJPAY1.Approve Unreferenced Refund
and move it to the Enabled Custom Permissions column. -
Click Save.
-
Assign the permission set to the relevant users.
For details, see Assign Permission Sets to a Single User in the Salesforce Help.
Enabling Refund User Interactions
If you have upgraded JustOn Cash Management from a pre-1.61 version, you may have to enable the refund user interactions manually.
Summary
Depending on your org's state, enabling refund user interactions may involve:
- Activating the newest Refund record page
- Adding action buttons to the Refund record page
Activating Refund Record Page
To activate the latest Refund record page shipped with JustOn Cash Management v1.61:
- Click to enter Setup, then navigate to the object management settings of the Refund object (
JPAY1__Refund__c
). - Click Lightning Record Pages.
- Click the name of the latest record page.
- Click View.
- Click Activation....
-
Open the tab for the option to set (ORG DEFAULT or APP DEFAULT), and click Assign as Org Default or Assign as App Default, respectively.
Follow the instructions in the activation dialog.
-
Click Save.
This activates the selected Refund record page and with the dedicated quick action buttons.
Info
The Refund record page shipped with JustOn Cash Management v1.61 already includes the refund interaction buttons.
Adding Refund Interaction Buttons
If you use a custom Refund record page, you can add the quick action buttons, along with visibility rules, to the top panel ("Highlights"):
-
Open your custom Refund record detail page in the Lightning App Builder.
-
Open a Refund record.
Click to access the App Launcher, and select Cash Management > Refunds > record name.
-
Click to open the Setup menu, then select Edit Page.
-
-
Select the top panel ("Highlights").
-
If you have not yet enabled dynamic actions, click Upgrade Now.
If applicable, follow the instructions to migrate available actions from an existing page layout.
-
Click Add Action.
In the Actions window, select an action, add the required visibility filters, then click Done.
Add the following actions to the Refund record page:
Action Set Action Visibility Show component when Edit Refund
Record > Status Equal Prepared
Record > Status Equal Approved
Any filters are true
Approve Refund
Record > Status Equal Prepared
Unapprove Refund
Record > Status Equal Approved
Switch to Credit Transfer and Approve
Record > Status Equal Prepared
Record > Status Equal Approved
Any filters are true
Cancel Refund
Record > Status Equal Prepared
Record > Status Equal Approved
Record > Status Equal Failed
Any filters are true
Retry Refund
Record > Status Equal Failed
-
Click Save.
This makes the customized record page available to users, enabling them to handle refunds as required.
For more details about editing Lightning pages, see Create and Configure Lightning Experience Record Pages in the Salesforce Help.
Setting Refund Reasons
Your business can define custom refund reasons and allow users to specify individual reasons.
Defining Custom Refund Reasons
To add org-specific refund reasons:
- Click to enter Setup, then navigate to the object management settings of the Refund object (
JPAY1__Refund__c
). - Click Fields & Relationships.
- Click the name of the
Refund Reason
field. -
In the Values section, click New.
Add the relevant refund reasons, like
Retry with SEPA
, each in a new line. -
Click Save.
This saves the specified refund reasons, making them available for users when creating refunds.
Enabling Individual Refund Reasons
To allow users specifying individual refund reasons, add the value Other
to the Refund Reason
picklist. To do so:
- Click to enter Setup, then navigate to the object management settings of the Refund object (
JPAY1__Refund__c
). - Click Fields & Relationships.
- Click the name of the
Refund Reason
field. -
In the Values section, click New.
Add the value
Other
. -
Click Save.
This saves the value
Other
. When selectingOther
as the refund reason on refund creation, users can specify an individual refund reason.
Using a translated user interface?
If you use a translated user interface, make sure to still set the API name Other
. You can then use the Translation Workbench to provide an appropriate translation (or just specify a corresponding picklist label).
Setting Refund Cancellation Reasons
Your business can define custom Cancellation reasons and allow users to specify individual reasons.
Defining Custom Cancellation Reasons
To add org-specific cancellation reasons:
- Click to enter Setup, then navigate to the object management settings of the Refund object (
JPAY1__Refund__c
). - Click Fields & Relationships.
- Click the name of the
Cancellation Reason
field. -
In the Values section, click New.
Add the relevant refund reasons, like
Retry with SEPA
, each in a new line. -
Click Save.
This saves the specified cancellation reasons, making them available for users when cancelling refunds.
Enabling Individual Cancellation Reasons
To allow users specifying individual cancellation reasons, add the value Other
to the Cancellation Reason
picklist. To do so:
- Click to enter Setup, then navigate to the object management settings of the Refund object (
JPAY1__Refund__c
). - Click Fields & Relationships.
- Click the name of the
Cancellation Reason
field. -
In the Values section, click New.
Add the value
Other
. -
Click Save.
This saves the value
Other
. When selectingOther
as the cancellation reason on refund cancellation, users can specify an individual cancellation reason.
Using a translated user interface?
If you use a translated user interface, make sure to still set the API name Other
. You can then use the Translation Workbench to provide an appropriate translation (or just specify a corresponding picklist label).