Get subscriptions associated with lender
How we communicate
The Lender API relies on webhooks to communicate changes about our customers or their applications. A webhook is nothing more than an endpoint, setup in your integration, which is able to accept a POST request from Funding Options.
Funding Options will use that endpoint to notify you of events relating to the customer in real time. This gives you the benefit of being able to action the customers request as soon as possible.
Below is an example of a customer who has previously received an offer, and has indicated to Funding Options that they would like to proceed with it.
As you'll see towards the bottom of the diagram, the communication between yourself and the Lender API is bidirectional. That's because the Lender API has its own webhook URL, where lenders are able to send POST requests back. This will be discussed later when we talk about the decisions endpoint.
Within the lenders endpoint, you'll be able to set up your webhook_url and find information on the subscriptions you currently have. We will discuss subscriptions and how they affect your notifications later.
At Funding Options we recognise that not all lenders have a fully automated process and a webhook implementation may not be possible at this time. For that reason, we've provided lenders with the
lender_eventsendpoint, which can be queried for any event you have subscribed to. From there, you can go through your events and update Funding Options with anydecisionsyou make, when it's appropriate for your business.
This endpoint provides information on your webhook_url and the subscriptions currently associated with your integration. Each subscription will have a number of events associated with it.