PromoConfig

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/affirm/refs/heads/main/json-schema/promos-promo-config-schema.json",
  "title": "PromoConfig",
  "description": "Internal configuration data returned with the promo response.",
  "type": "object",
  "properties": {
    "promo_prequal_enabled": {
      "type": "boolean",
      "description": "Indicates whether prequalification is enabled for this merchant.",
      "example": true
    },
    "merchant_name": {
      "type": "string",
      "description": "The merchant's display name.",
      "example": "Example Merchant"
    },
    "merchant_ari": {
      "type": "string",
      "description": "Affirm Resource Identifier for the merchant.",
      "example": "example_value"
    },
    "user_ari": {
      "type": "string",
      "description": "Affirm Resource Identifier for the current user session.",
      "example": "example_value"
    },
    "toast_enabled": {
      "type": "boolean",
      "description": "Indicates whether toast notifications are enabled for this integration.",
      "example": true
    },
    "enabled_integrations": {
      "type": "array",
      "description": "List of enabled Affirm integration features for this merchant.",
      "items": {
        "type": "string"
      },
      "example": [
        "example_value"
      ]
    },
    "images": {
      "type": "object",
      "description": "Image asset URLs for use in the promotional modal.",
      "properties": {
        "hero": {
          "type": "string",
          "format": "uri",
          "description": "Standard resolution hero image URL."
        },
        "hero2x": {
          "type": "string",
          "format": "uri",
          "description": "High resolution (2x) hero image URL."
        },
        "logo": {
          "type": "string",
          "format": "uri",
          "description": "Standard resolution Affirm logo URL."
        },
        "logo2x": {
          "type": "string",
          "format": "uri",
          "description": "High resolution (2x) Affirm logo URL."
        }
      },
      "example": {
        "hero": "https://example.com",
        "hero2x": "https://example.com",
        "logo": "https://example.com",
        "logo2x": "https://example.com"
      }
    }
  }
}