Recharge
This guide outlines the steps for integrating your Recharge account with Recover. The integration leverages the following information from Recharge:
- Failed Payments Feed: A webhook providing real-time updates on all failed transactions.
- Subscription Status: Access to up-to-date information on the state of Recharge subscriptions.
- Customers and Active Payment Methods: Retrieval of limited customer entities and active payment methods currently associated with a subscription.
These integrations ensure seamless functionality and reliable payment recovery.
Recover has a few configuration options that the Merchant can select from, these include:
- Dunning Length: Required by Recover, this is the length of time determined by the business in which a failed payment will be attempted to be recovered. A common length many merchants settle on is 30 days.
- End of Dunning Actions: If configured, Recover will cancel subscriptions on the Merchant's behalf when an invoice is unable to be recovered by the close of the dunning cycle.
Butter offers direct support for integrating your system with Recover by assigning a dedicated Butter Solutions Engineer. This engineer will serve as your hands-on resource, guiding you through the configuration process and ensuring a smooth integration with Recover.
This is the first step in granting Butter Payments access to your Recharge environment. Recover will use this key to integrate with your Recharge Account via API to manage retry attempts on your behalf.
It is important that the dedicated Recharge API key is configured with the appropriate user role permissions.
To create the API Key navigate to:
Apps > API Tokens > Create an Admin API token
For the token nickname, you can use Butter Payments, and you can add [email protected] as the contact email.
API Key Permissions
Field | Permission |
|---|---|
Orders | Read |
Discounts | Read |
Subscriptions | Read* |
Payments | Read and Write |
Customers | Read |
Products | Read |
* If Butter is taking over subscription cancellations, we would also need Write access to Subscriptions.
This is an automated step initiated by the Butter once we receive a Stripe API key from your account with all the necessary permissions.
After the API key has been generated and shared with Butter, the Butter team will initialize your account setup. This automated process will include:
- Register your API key in Recover
- Provision a Webhook endpoint to receive events from your Recharge Account.
- Provision Webhooks on your account to send events to Recover
The webhook endpoint URL will have the following syntax, though this is only visable by interacting with the Recharge API:
Where ts_xxxxx is the transaction source (uniquely generated) for the webhook.
Recover requires your Recharge account to begin forwarding payment data to Recover before going live. During this pre-launch period, no failed payments will be retried.
Required Pre-Launch Data Ingest | 7 Days |
|---|
The purpose of this data ingestion phase is to ensure that all failed payments are fully captured by Recover before it takes over managing payment retries.
This phase starts only after all prior setup steps have been successfully completed.
On launch day, your Butter Solutions Engineer will work closely with your team to make sure all configurations are setup correctly and done in the required order.
Disable existing Recharge Retry Strategy
The launch process requires careful sequencing to prevent duplicate retries from being executed by multiple retry systems. This involves disabling Recharge Retries and any third-party decline salvage services.
Once this step is complete, Butter will update Recover to take full responsibility for managing all retry attempts on failed invoices moving forward.
Rate Limiting
Butter will reach out to Recharge on the merchant's behalf if, based on the merchant's volume, a higher rate limit is needed.
Once you are live with Recover, the Butter team will be closely tracking performance of failed payments as they are ingested and then optimally scheduled for Retry.
ButterBoard
As part of your Go Live onto Recover, you will receive email invitation to your Butter Account and access to your company's ButterBoard. The ButterBoard provides realtime performance of Revenue Recovered, your recovery rate, and feed of most recent recovered transactions.
