Install CPR
Learn how to install and configure the Configurable Payment Retry (CPR) app, including setting up OAuth credentials, creating custom fields, and managing retry cycles.
Configurable Payment Retry requires OAuth credentials to properly authenticate to your Zuora tenant and deploy necessary custom fields. After app creation, you can add OAuth credentials to an existing instance; however, it will not create the required custom fields in arrears. Create the custom fields manually, as they are required to process any application. The following are the CPR custom fields:
Object and Category | Field Label | API Name | Data Type |
|---|---|---|---|
Account Fields (Indexed) | Retry Status | RetryStatus__c | Text (255) |
Debit Memo Only available if the Invoice Settlement feature is enabled on your tenant. | Retry Status | RetryStatus__c | Text (255) |
Invoice Fields (Indexed) | Retry Status | RetryStatus__c | Text (255) |
When deploying Configurable Payment Retry, ensure you install the Production build version. Use this build in all tenant environments, testing or production.
Stopping an app instance of CPR does not prevent already scheduled retries from executing. To stop further retries:
-
For Invoices and Accounts with existing retry cycles, use the CPR APIs to help remove them. For more information, see Developer Center .
-
Deactivate the callout notification to prevent new cycles from beginning. For more information, see CPR configuration details.
While creating the Configurable Payment Retry (CPR) app, Zuora provides a list of response codes from any gateway configured in your tenant. To add more response codes or gateways, Configure Response Codes .
You can create additional mapping headers for a more flexible retry logic.
For instance, you can have the following headers:
-
Hard Decline - Never retried
-
Medium Decline - Retired, but not as frequent as a soft decline (for example, retry twice)
-
Soft Decline - Retried, to exhaust all possible retry attempts.
For example, you may be uncertain whether a specific payment error should be retried. In that case, it is advisable to map it as a 'Soft Decline' and monitor for further insights to determine if it's recoverable. You can change mappings at any time.
If a new gateway is added to your payment operations after you have installed CPR, you must add the new gateway's codes to your existing mapping. In the app instance, navigate to Response Codes > Menu > Export CSV and select Master Code List.
- Copy the codes of your new gateway.
- Add to 'My Code List' export.
- Upload into CPR instance.
Once a mapping is modified (for example, switching from 'Hard Decline' to 'Soft Decline'), CPR will utilize this change in future scheduled retry attempts. However, the next immediate retry attempt that was already scheduled before the configuration change will not be impacted. Any retry cycles that have already been completed will not be restarted due to the configuration change.
To immediately stop further retries, you must manually stop the retry cycle. For more information on using the CPR APIs to complete this action, see the Zuora Developer Center .
When bulk editing response codes or migrating CPR app instance configurations between environments, always download and save the current mapping list (referred to as 'My Code List'). After making any edits to your list, save your updated 'My Code List' for easy reference.
When importing a new or modified list of response codes, it will replace all existing codes. If you want new codes, add them to your existing code list and then import them.