Important Update: Our Knowledge base has moved! Visit our new documentation site at documentation.flexpay.io.
Open navigation

Integration Overview

Before we can start recovering your failed payments, your CRM needs to integrate with FlexPay. There are two methods of doing this; API post (Enterprise, Enterprise with Scheduler, Recovery Advisor) or flat file (Quick Start Recovery). In this overview, we'll focus on integration mechanisms that leverage our REST API. Let's explore each one of these options:

Enterprise Integration

In this failed payment recovery method, FlexPay acts like a transparent layer between the system of record and the payment gateway. Retry attempts are sent through FlexPay to your native gateway. We analyze your request, as well as the response from the gateway, and return our own enhanced response payload in real-time. If the transaction declines again, our response will include a Retry Date & Time. Every subsequent rebill attempt goes through FlexPay until either the transaction is approved, hard declined, or the AI determines it is not recoverable. 

For step-by-step details, please see FlexPay Enterprise Process

For the API reference documents, go to Enterprise API reference

Enterprise with Scheduler Integration

In this integration, retry attempts are sent through FlexPay to your payment gateway. Similar to our standard Enterprise integration, we conduct an analysis of your request, coupled with the original response received from the gateway. An enhanced payload is generated and transmitted by FlexPay. If the transaction declines again, we evaluate the received response and internally schedule a new attempt on a future date. This day has been derived as the one with the higher chance of approval by our recovery engine. We pursue this scheduling and retry process, drawing insights from our machine learning models, until the payment either gets approved, faces a hard decline, or is deemed unrecoverable.

For the integration guide and more details, please see Enterprise with Scheduler Integration Guide

For the API reference documents, go to Enterprise API reference

Recovery Advisor Integration

In this method, FlexPay doesn't communicate with your payment gateway. Instead, your CRM calls FlexPay via API and provides details of a transaction that has declined on its native gateway. FlexPay analyzes the provided payload and responds immediately with a recommendation on when to retry that transaction in the future.

For step-by-step details, please see FlexPay Recovery Advisor Process

For the API reference documents, go to Recovery Advisor API reference


D
Daniel is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.