Search
K
Embedded Finance

Embedded Finance

1.0.0OAS 3.1
API Base URL
  • Server 1:https://api.wayflyer.com/financing/

    Production

Security
CompanyToken (http)

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

PartnerToken (http)

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Get CTA configuration

Retrieve the CTA configuration for a given company or responds with a 204 if no CTA should be shown.

The indicative offer CTA config will be returned if:

  • Data has been uploaded to the anon-data-upload service and an indicative offer is available.

The generic offer CTA config will be returned if:

  • No indicative offer available, the company is not marked ineligible and has not started an application.

The “Continue” CTA config will be returned if:

  • The company has started an application, had a user sign up, and has an open sales deal.

No CTA config will be returned if:

  • The company has started an application, had a user sign up, and doesn’t have an open sales deal.
  • The company has been marked ineligible by the anon-data-upload service.
get
https://api.wayflyer.com/financing/v1/company/cta/

Response

application/json

OK

BannerResponse

statestringrequired

The type of CTA to display

Allowed values:continue_applicationindicative_offergeneric_offer

dataobjectrequired

Data to display in the CTA

Show Child Parameters
get/v1/company/cta/
 
application/json

Dismiss CTA

Track state of banner dismissals from users.

post
https://api.wayflyer.com/financing/v1/company/cta/dismiss/

Body

application/json

BannerDismissInput

banner_statestringrequired

Allowed values:continue_applicationindicative_offergeneric_offer

Response

No Content

post/v1/company/cta/dismiss/

Body

{ "banner_state": "continue_application" }