At the start time of the payment scheduler, payment batch runs start processing payment schedule items based on the defined criteria.
Required Editions
| Available in: Lightning Experience |
| Available in: Enterprise, Unlimited, and Developer Editions with Revenue Cloud |
| To integrate a native payment gateway, you have two options. Use Salesforce Payments, which runs on Stripe and is available with the the Revenue Cloud Billing license on a cost-per-transaction basis. Or, connect your own Adyen account, contracted directly with Adyen. |
Process Overview
Understand the steps involved in processing payment schedule items and applying the corresponding payments.
- Payment batch runs process Payment Schedule Item records that are in the Ready for Processing status and are related to Payment Schedule records that are in the Open status.
- A Payment record is created for each payment schedule item that’s successfully processed.
- The payment batch run then applies the Payment record to the corresponding Invoice or Invoice Line record based on the payment application level.
Billing applies payments based on the descending order of invoice line balances, that is, a payment is first applied to an invoice line with the highest balance.
Payment Methods
For automatically created payment schedules and payment schedule items, the payment gateway collects payments by using the default saved payment method.
For manually created payment schedules and payment schedule items, the payment gateway collects payments by using the most recently created saved payment method for the account that’s related to the invoice.
Statuses of Payment Schedules and Payment Schedule Items
The status of the payment schedule item is updated at various stages of the payment batch run.
| Payment Batch Run Stage | Payment Schedule Item Status |
|---|---|
| A payment batch run picks up the payment schedule item for processing. | Processing |
| A payment batch run completes collecting the amount of the payment schedule by using the merchant account. | Processed |
| A payment batch run applies the payment schedule item to an invoice or invoice line. | Applied |
| A payment batch run fails to process the payment schedule. | Failed |
| A payment batch run fails to apply the payment schedule item to an invoice or invoice line. | Apply Failed |
| A payment batch run successfully processes a payment schedule. | Completed |
| The balance of the corresponding invoice is less than that of the payment schedule line. | Canceled |
Results of Payment Application
After payments are collected and applied, Billing automatically creates and updates these fields and records.
| Payment Application Level | Updated Payment Schedule and Payment Schedule Item Fields | Updated Invoice Fields | New Records |
|---|---|---|---|
| Invoice |
Payment Schedule fields:
Payment Schedule Item fields:
|
|
|
| Invoice Line |
Payment Schedule fields:
Payment Schedule Item fields:
|
|
|
Payment Batch Run Failures
To troubleshoot failed payment schedule items, check the Revenue Transaction Error Logs related list on the Payment Batch Run and Payment Schedule records.
To automatically retry failed payments, set up payment retry rules, define a default payment retry rule set, and then enable the retry failed payments feature on the Billing Settings page.
To manually retry processing of failed payments, change the status of the failed payment schedule items to Canceled. Then, create new payment schedule items with the same details and schedule a payment batch run.