Overview

By integrating with our Hosted Capital API, partners can render dynamic funding offers within their platform and enable users to seamlessly start pre-configured funding applications hosted on wayflyer.com.

While funding applications are in progress, users will be notified of any outstanding actions required to complete their funding journey from within the Embedded component. This ensures users stay informed and engaged at every step, fostering a transparent and efficient process.

Where funds have been successfully deployed to a customer, funding prompts will reappear when subsequent offers are available, starting the cycle again.

The following diagram visualises how partners may integrate with Wayflyer's funding system using the Hosted Capital API:

Authenticate

All communication with the Hosted Capital API must be encrypted and authenticated per-company. Partners should request company tokens from their backend and forward them to their frontend to authenticate and authorize all calls to the Hosted Capital API.

For more details, see the Authentication section.

Upload anonymous data [Recommended]

While optional, partners can pre-share anonymized company data with Wayflyer to enable personalized, pre-qualified indicative offers for their customers. This data also allows the banner to be hidden for ineligible companies, avoiding frustrating user experiences.

Where no anonymized data has been shared, Wayflyer will present users with with a generic funding call-to-action. Wayflyer can also provide basic funding eligibility criteria to partners, enabling them to filter out potentially ineligible customers without requiring any data sharing.

For more information on sharing anonymous data for pre-qualified offers see the Anonymous Data Sharing section.

Get Call-to-Action (CTA)

Using a valid company token, the partner's frontend can request the latest call-to-action for the logged-in company and user. The response will dictate the type and content of the CTA that should be displayed to the user. Typically, the CTA will contain a generic or pre-qualified indicative funding offer. However, where a funding application is in progress, the CTA will update to include specific information on any outstanding actions a user must complete to advance their application.

Users may dismiss the CTA, which will temporarily hide unwanted notifications behind an exponential backoff.

For more information see the Call-to-Action section.

Start Hosted Application

When a user clicks on the displayed CTA and applies for funding, the partner should call the start hosted application API. This call initiates a funding application for that company, pre-filled with any data about the company and user that the partner has available and has shared with Wayflyer, following appropriate user consent. The response from this API call will contain a URL which the partner should then redirect the user to. This URL leads to a co-branded landing page where the user can continue their application.

For more information see the Starting an Application section.

Integration Options

Wayflyer Hosted Capital supports a number of different integration options depending on partner preference. Partners may:

1. Use our themeable UI SDK to take care of rendering the UI, managing the user journey and making calls to the Embedded Finance API
2. Use our Headless SDK which wraps up and caches interactions with our API, while implementing their own UI.
3. Call the API directly, giving partners the full control over their frontend implementation.

For more information see the Using the SDK section and/or the API documentation.

Sandbox and Reference App

To help partners develop their integration with Wayflyer Hosted Capital, we support a sandbox environment that allows developers to fully exercise the Hosted Capital API surface and simulate all stages of a customer's application process.

Additionally, our Reference App allows partners to explore the Hosted Capital service before starting their own integration.

For more information, see the Sandbox and Reference App section and the Sandbox API documentation.