---
title: Enterprise API Integration
slug: enterprise-api-integration
description: Seamlessly integrate the Recover Enterprise API with your subscription management system or payment service provider. Learn about integration patterns, call flows, and timelines for a customized recovery solution.
docTags: 
createdAt: 2024-11-14T23:58:53.911Z
---

# Overview

The Recover Enterprise API offers maximum flexibility for integrating with your subscription management system and any Payment Service Provider(s). It can seamlessly integrate with any subscription service and be customized to accommodate unique payment processing logic.

Integrating with the Recover Enterprise API can follow one of two patterns:

1. Integrating retries with your **Payment Service Provider**
2. Integrating retries directly with your **Subscription Platform**

The choice of integration pattern typically depends on how subscriptions and payments are managed within your enterprise. The Butter team will collaborate with you to design and implement the optimal integration for your needs.

# Integration Call Flow

A typical integration with Recover follows the steps outlined below.

**Step 1: **The merchant performs a payment request as usual.

**Step 2: **Upon receiving the failed payment response from the Payment Processor, the merchant forwards the payment event to the Recover [Payments endpoint](https://docs.services.butterpayments.com/payments). Recover then analyzes the payment event in real-time to determine whether to retry the payment and, if so, the best way to recover the failed payment. Note: Successful transactions should also be provided to this endpoint as well in order to provide Butter with the full picture of your transaction activity, as well as to train the machine learning models.

**Step 3: **Just before performing the scheduled retry, Recover will query the merchant's [Retry Status endpoint](https://docs.services.butterpayments.com/retry-status) to determine if the retry should be performed against the associated invoice.

**Step 4: **If permitted, Recover performs the retry on behalf of the merchant.

**Step 5: **After obtaining the request response from the payment processor, Recover forwards the outcome via a Retry Result Webook to the merchant's [Retry Result Webhook endpoint](https://docs.services.butterpayments.com/retry-results) for reconciliation.

**Step 6: **At the end of dunning, merchants can optionally choose to receive an [End-of-Dunning Webhook](https://docs.services.butterpayments.com/end-of-dunning) to signify that dunning is complete and that Recover will no longer retry on the specified invoice.

**Payment Method Updates:** Payment method updates should be funnelled to Butter via the [Payment Method Updates](https://docs.services.butterpayments.com/payment-method-update) endpoint. As payment method updates can happen at any point during the dunning cycle, this step is not numbered in the diagram below.

![](https://api.archbee.com/api/optimize/hK73IE79BBdAWHhbLzj80-ilGsMNrVYR7cMA41DKRrc-20250220-201239.png)

# Integration Timeline

To accommodate development time, sandbox testing, and data validation - standard integration takes **4-6 weeks**. 

::Image[]{src="https://api.archbee.com/api/optimize/ulzW_Oabf9OtJM_doZF6z-MklEPPsqYy14mR_WRV10l-20241209-210449.png" size="80" width="1808" height="666" position="center" caption="Integration Phases" showCaption="true"}

:::hint{type="info"}
Please reference our [Integration Guide](docId\:VpNwLdN_9YsgCUPIICX-l) for an in-depth overview of how Recover can be integrated into your subscription platform. 
:::

:::hint{type="success"}
Interested in working with Butter to bring more revenue back to your business? Reach out to us here: [contact@butterpayments.com](mailto\:contact@butterpayments.com).
:::

****