---
title: "BannerData"
url: "https://docs.wayflyer.com/apis/embedded-finance-sandbox-api-1/versions/89e9f620-626b-413f-b4ac-7605711a516f/schemas/BannerData"
---

> Full API specification: https://docs.wayflyer.com/apis/embedded-finance-sandbox-api-1/versions/89e9f620-626b-413f-b4ac-7605711a516f.md

# BannerData

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Embedded Finance Sandbox
  version: "1"
servers:
  - url: https://sandbox-api.wayflyer.com/financing/
    description: Production
components:
  schemas:
    Offer:
      properties:
        amount:
          description: Amount of the offer in `currency`
          title: Amount
          type: integer
        currency:
          $ref: "#/components/schemas/SupportedCurrencyCode"
          description: ISO 4217 code for the currency of the offer
      required:
        - amount
        - currency
      title: Offer
      type: object
    ContinueEmbeddedApplicationBannerConfig:
      properties:
        text:
          description: Display text for the CTA
          title: Text
          type: string
        bullet_points:
          description: List of text bullet points to display in the CTA
          items:
            type: string
          title: Bullet Points
          type: array
        button_label:
          description: Label for the button
          title: Button Label
          type: string
        embedded_application_uuid:
          description: UUID of the embedded application currently in progress
          title: Embedded Application Uuid
          type: string
      required:
        - text
        - button_label
        - embedded_application_uuid
      title: ContinueEmbeddedApplicationBannerConfig
      type: object
    ContinueApplicationBannerConfig:
      properties:
        text:
          description: Display text for the CTA
          title: Text
          type: string
        bullet_points:
          description: List of text bullet points to display in the CTA
          items:
            type: string
          title: Bullet Points
          type: array
        button_label:
          description: Label for the button
          title: Button Label
          type: string
        required_action:
          $ref: "#/components/schemas/RequiredAction"
          description: Action the user is required to perform.
        application_uuid:
          description: UUID of the hosted application currently in progress, if any.
          title: Application Uuid
          type: string
      required:
        - text
        - button_label
        - required_action
        - application_uuid
      title: ContinueApplicationBannerConfig
      type: object
    OfferBannerConfig:
      properties:
        text:
          description: Display text for the CTA
          title: Text
          type: string
        bullet_points:
          description: List of text bullet points to display in the CTA
          items:
            type: string
          title: Bullet Points
          type: array
        button_label:
          description: Label for the button
          title: Button Label
          type: string
        funding_cycle:
          description: Number of user funding cycles.
          title: Funding Cycle
          type: integer
      required:
        - text
        - button_label
        - funding_cycle
      title: OfferBannerConfig
      type: object
    SupportedCurrencyCode:
      enum:
        - USD
        - CAD
        - AUD
        - EUR
        - GBP
        - SEK
        - DKK
      title: SupportedCurrencyCode
      type: string
    RequiredAction:
      enum:
        - complete_application
        - provide_additional_info
        - select_offer
        - complete_kyc
        - sign_contract
      title: RequiredAction
      type: string
    BannerData:
      properties:
        offer:
          anyOf:
            - $ref: "#/components/schemas/Offer"
            - type: "null"
          description: Offer data to display in the CTA
        config:
          anyOf:
            - $ref: "#/components/schemas/ContinueEmbeddedApplicationBannerConfig"
            - $ref: "#/components/schemas/ContinueApplicationBannerConfig"
            - $ref: "#/components/schemas/OfferBannerConfig"
          description: Configuration for the CTA
          title: Config
      required:
        - config
      title: BannerData
      type: object
```