Recover user guide

Follow the steps below to add a Recover strategy to your workflow in order to improve transaction success without any API changes. All gateways available in Composer are supported by Recover.

Add Recover as a paid service

Recover is an optional paid service that enables you to automatically retry declined transactions on a backup gateway in the case of an outage or decline. This improves the chance that a transaction is ultimately successful and builds system resilience.

📘

If you have interest in Recover please contact your account manager or reach out to [email protected].

Note: Recover is available in sandbox mode for testing. See How to test Recover using test gateways for more information.

Select a Recover mode

1. After adding a primary gateway to your workflow, select Add recovery strategy .

   
   

2. Select a recover mode.

View documentation for outage and standard error code mappings.

Select Recover gateways

1. Configure up to two gateways to attempt to recover your transaction if the mode selected applies.

📘

Note: When a transaction on the workflow's primary gateway fails due to the Recover mode selected, the transaction is reattempted using the first Recover gateway saved on the workflow. If the first Recover gateway attempt fails due to any reason, the transaction is reattempted using the second Recover gateway saved on the workflow.

[Optional] Add a Recover configuration

In combination with an outage or standard mode, fine tune your strategy with a more aggressive or conservative approach by selecting additional error codes for recovery.

1. Create a Recover configuration and apply it to your workflow. After selecting a Recover mode (Outage or Standard + Outage), select Create and update Recover configurations. Select Create Recover configuration within the Recover configurations drawer.

2. Add a description to reference your new Recover configuration, select the desired failure reasons from the dropdown and click save.

📘

The failure_reason is a normalized field (managed by Spreedly) that is sent in the API response. The failure_reason values available have been normalized across all supported gateways in Composer. See documentation to view the full list and the associated gateway error code mapping.

3. Update your Recover configuration(s) directly in your workflow by selecting the gear icon. Any changes saved will be applied immediately if the Recover configuration is currently used in a workflow within your environment.

4. Apply a Recover configuration to your Recover Strategy by selecting from the dropdown. Select Save changes to the workflow.

Manage Recover configurations in your environment

1. To manage the Recover configurations in your environment, you can follow the steps above or visit the Recover configuration page. You can navigate here by selecting the Recover configuration tab on the Composer landing page.

2. Create a new Recover configuration by selecting the Create Recover configuration button or manage an existing configuration by selecting the gear icon. Any Recover configuration created can be applied to any workflow within your environment.