Search
K
Embedded Finance Sandbox

BannerData

object
offerAny Of

Offer data to display in the CTA

Offerobject
Show Child Parameters
configAny Of
required

Configuration for the CTA

ContinueApplicationBannerConfigobject
Show Child Parameters
Example

BannerResponse

object
statestringrequired

The type of CTA to display

Allowed values:continue_applicationindicative_offergeneric_offer

dataobjectrequired

Data to display in the CTA

Show Child Parameters
dismissal_keyAny Of

Opaque key identifying this CTA instance. Use it when dismissing the banner.

Variant 1string
Example

BannerState

string

Allowed values:continue_applicationindicative_offergeneric_offer

ContinueApplicationBannerConfig

object
textstringrequired

Display text for the CTA

bullet_pointsarray[string]

List of text bullet points to display in the CTA

button_labelstringrequired

Label for the button

required_actionstringrequired

Action the user is required to perform.

Allowed values:complete_applicationprovide_additional_infoselect_offercomplete_kycsign_contract

application_uuidstringrequired

UUID of the hosted application currently in progress, if any.

Example

Offer

object
amountintegerrequired

Amount of the offer in currency

currencystringrequired

ISO 4217 code for the currency of the offer

Allowed values:USDCADAUDEURGBPSEKDKK

Example