View Flexible Payments
Learn how to view flexible payments, whether they are scheduled payments, installment payments, or Recurring Orders with a Saved Payment.
Note
If you have enabled Salesforce multi-currency, Salesforce introduces the Currency field on all object layouts within your org.
While new Schedule and Schedule Lines records get created, the Currency field value on these records gets populated based on the Currency field value of the Entity that these records are linked with.
Also, once the record is saved, you will not be allowed to edit the value of the Currency field.
View a Constituent's Schedule Lines
You can always go to the Schedules tab to view schedules and the child schedule lines but it can also be helpful to view schedule lines directly from a constituent's account record. We provide a couple of ways to view this info. If a scheduled payment fails, an error message will now be captured in the Status Detail field on the corresponding Schedule Line making it easier to diagnose problems.
This applies to one-time scheduled and installment payments only, since Recurring Orders with a Saved Payment do not use schedule lines.
- To process past recurring schedules with both,
Ongoing
andFailed
statuses, the administrator must follow the following steps:
From Setup, enter
Custom Metadata Types
in the Quick Find box, then select Installed Packages.Click Configure next to the Nimble AMS package.
- Under Flexible Payment Settings, check the box for Process Eligible Past Date Rec. Schedules.
- Click Save.
Expected Result
By default, when the checkbox is unchecked, the scheduled job will only process failed recurring schedules from the past. However, when it is checked, the job will process both failed and ongoing recurring schedules from the past.
- To process past payment (one-time and installment) schedules with both,
Ongoing
andFailed
statuses, the administrator must follow the following steps:
- From Setup, enter
Custom Metadata Types
in the Quick Find box, then select Installed Packages. - Click Configure next to the Nimble AMS package.
- Under Flexible Payment Settings, check the box for Process Eligible Past Date Inst. Schedules.
- Click Save.
Expected Result
By default, the checkbox is unchecked.
When the box is unchecked, the scheduled job will select only the failed payment schedules from the past and the ongoing payment schedules for today.
However, when the box is checked, it should also include the past-dated ongoing payment schedules.
Cancellation/Adjustment of Schedule Lines in Partial Payment
In case a staff user makes a partial payment to one-time scheduled or installment payments, the schedule lines are canceled or updated automatically by Nimble AMS.
As an example, if there is an order with a total amount of $43.6 and it is scheduled with 4 installments of amount $10.90 each, then 4 schedule lines get created. If the staff user pays off $25 on the constituent's behalf, then the first two schedule lines get canceled and the third schedule line's amount gets adjusted to $7.70.
This can be viewed on the payment step of the order processor. Alternatively, you can also go to the schedule record of this order and view the schedule lines on it.
From the Related List
While schedule lines is a child of schedules, they are also directly associated with the schedule's Account, so you can view both schedules and schedule lines from the account record:
- Open the constituent's account record
View the Schedule Lines related list.
On the default Nimble AMS Lightning record pages for accounts and person accounts, the Schedule Lines related list is on the Order tab of the account record page. It's also visible from the Related List Quick Links section.
From the Scheduled Payments Flow
Once an admin has enabled the Scheduled Payments
flow and add it to your Lightning record pages for accounts or person accounts, staff can view a constituent's recent or upcoming schedule lines for a particular status (determined by the Admin). The flow is visible from the account record page's Notifications tab in the right sidebar, unless your admin has placed the flow elsewhere.
For the account you're viewing, the flow displays all schedule lines with one of the following statuses:
Canceled
Failed
Pending
Awaiting Confirmation
(When communication failure prevents the payment gateway from sending confirmation of a payment success or failure)Processed
If the admin also specified the number of days to include, the flow limits the results to a relative date range. The flow displays the status as well as the date range, if there is one.
In the list of results, staff can click the link for a particular schedule line to go to that record and view more details or take action.
View the Health of a Flexible Payment
Staff can view two different fields to understand the current status of a flexible payment and whether there is any need to manually intervene:
- From a schedule,
Health
displays a visual indicator for the current stage of the schedule. - For one-time scheduled and installment payments: from a scheduled line,
Status
states the current status of the schedule line.