{
  "title": "Branding APIs",
  "description": "Branding APIs enable you to customize all customer facing pages provided by Surfboard. The branding can be configured at various levels similar to the terminal config.",
  "endpoints": [
    {
      "fragment": "Create Branding for Merchant",
      "method": "PATCH",
      "link": "API_URL/merchants/:merchantId/branding"
    },
    {
      "fragment": "Create Branding for Store",
      "method": "PATCH",
      "link": "API_URL/merchants/:merchantId/stores/:storeId/branding"
    },
    {
      "fragment": "Create Branding for Terminal",
      "method": "PATCH",
      "link": "API_URL/merchants/:merchantId/stores/:storeId/terminals/:terminalId/branding"
    },
    {
      "fragment": "Create Branding for Partner",
      "method": "PATCH",
      "link": "API_URL/partners/:partnerId/branding"
    },
    {
      "fragment": "Fetch Branding for Merchant",
      "method": "GET",
      "link": "API_URL/merchants/:merchantId/branding"
    },
    {
      "fragment": "Fetch Branding for Store",
      "method": "GET",
      "link": "API_URL/merchants/:merchantId/stores/:storeId/branding"
    },
    {
      "fragment": "Fetch Branding for Terminal",
      "method": "GET",
      "link": "API_URL/merchants/:merchantId/stores/:storeId/terminals/:terminalId/branding"
    },
    {
      "fragment": "Fetch Branding for Partner",
      "method": "GET",
      "link": "API_URL/partners/:partnerId/branding"
    },
    {
      "fragment": "Remove Branding for Merchant",
      "method": "DELETE",
      "link": "API_URL/merchants/:merchantId/branding"
    },
    {
      "fragment": "Remove Branding for Store",
      "method": "DELETE",
      "link": "API_URL/merchants/:merchantId/stores/:storeId/branding"
    },
    {
      "fragment": "Remove Branding for Terminal",
      "method": "DELETE",
      "link": "API_URL/merchants/:merchantId/stores/:storeId/terminals/:terminalId/branding"
    },
    {
      "fragment": "Remove Branding for Partner",
      "method": "DELETE",
      "link": "API_URL/partners/:partnerId/branding"
    },
    {
      "fragment": "Generate Branding with AI for Partner",
      "method": "POST",
      "link": "API_URL/partners/:partnerId/ai/branding"
    }
  ],
  "apis": [
    {
      "heading": "Create Branding for Merchant",
      "description": "Create a branding configuration for customizable pages at merchant level",
      "reqParams": [
        {
          "name": "backgroundColor",
          "type": "string",
          "mandatory": false,
          "description": "Background color for the page."
        },
        {
          "name": "brandColor",
          "type": "string",
          "mandatory": false,
          "description": "Primary brand color for your page."
        },
        {
          "name": "footerColor",
          "type": "string",
          "mandatory": false,
          "description": "Footer's background color on the page."
        },
        {
          "name": "accentColor",
          "type": "string",
          "mandatory": false,
          "description": "This is a secondary color that complements your brand color."
        },
        {
          "name": "rectShape",
          "type": "string",
          "mandatory": false,
          "description": "Decides the shape of the page buttons. The available shapes are 'ROUNDED', 'PILL' and 'EDGY'.",
          "possibleValues": [
            "ROUNDED",
            "PILL",
            "EDGY"
          ]
        },
        {
          "name": "fontType",
          "type": "string",
          "mandatory": false,
          "description": "Font family for the customizable page. The available font types are 'sans-serif','serif' and 'mono'.",
          "possibleValues": [
            "serif",
            "sans-serif",
            "mono"
          ]
        },
        {
          "name": "logoUrl",
          "type": "string",
          "mandatory": false,
          "description": "Logo that will be displayed on the page."
        },
        {
          "name": "iconUrl",
          "type": "string",
          "mandatory": false,
          "description": "Icon that will be displayed on the page."
        },
        {
          "name": "primaryCoverImage",
          "type": "string",
          "mandatory": false,
          "description": "Primary cover image that will be displayed on the page."
        },
        {
          "name": "secondaryCoverImage",
          "comingSoon": true,
          "type": "string",
          "mandatory": false,
          "description": "Secondary cover image that will be displayed on the page."
        }
      ],
      "resParams": [
        {
          "name": "status",
          "type": "string",
          "description": "Status of the request, indicated as either 'SUCCESS' or 'ERROR'."
        },
        {
          "name": "message",
          "type": "string",
          "mandatory": true,
          "description": "A message that describes the status of the request."
        }
      ],
      "method": "PATCH",
      "path": "/merchants/:merchantId/branding",
      "examples": {
        "request": {
          "headers": [
            {
              "name": "Content-Type",
              "value": "application/json"
            },
            {
              "name": "API-KEY",
              "value": "YOUR_API_KEY"
            },
            {
              "name": "API-SECRET",
              "value": "YOUR_API_SECRET"
            },
            {
              "name": "MERCHANT-ID",
              "value": "YOUR_MERCHANT_ID"
            }
          ],
          "body": "{\"backgroundColor\":\"#667085\",\"brandColor\":\"#697085\",\"accentColor\":\"#787085\",\"rectShape\":\"ROUNDED\",\"fontType\":\"sans-serif\",\"logoUrl\":\"https://res.cloudinary.com/image/surfboard-icon.svg\",\"iconUrl\":\"https://res.cloudinary.com/image/surfboard-icon.svg\",\"footerColor\":\"#CD5C5B\",\"primaryCoverImage\":\"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\"secondaryCoverImage\":\"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\"}"
        },
        "response": [
          {
            "code": 200,
            "response": "\n{\n\t\"status\": \"SUCCESS\",\n\t\"message\": \"Branding configuration set successfully.\"\n}"
          }
        ]
      }
    },
    {
      "heading": "Create Branding for Store",
      "description": "Create a branding configuration for customizable pages at store level",
      "reqParams": [
        {
          "name": "backgroundColor",
          "type": "string",
          "mandatory": false,
          "description": "Background color for the page."
        },
        {
          "name": "brandColor",
          "type": "string",
          "mandatory": false,
          "description": "Primary brand color for your page."
        },
        {
          "name": "footerColor",
          "type": "string",
          "mandatory": false,
          "description": "Footer's background color on the page."
        },
        {
          "name": "accentColor",
          "type": "string",
          "mandatory": false,
          "description": "This is a secondary color that complements your brand color."
        },
        {
          "name": "rectShape",
          "type": "string",
          "mandatory": false,
          "description": "Decides the shape of the page buttons. The available shapes are 'ROUNDED', 'PILL' and 'EDGY'.",
          "possibleValues": [
            "ROUNDED",
            "PILL",
            "EDGY"
          ]
        },
        {
          "name": "fontType",
          "type": "string",
          "mandatory": false,
          "description": "Font family for the customizable page. The available font types are 'sans-serif','serif' and 'mono'.",
          "possibleValues": [
            "serif",
            "sans-serif",
            "mono"
          ]
        },
        {
          "name": "logoUrl",
          "type": "string",
          "mandatory": false,
          "description": "Logo that will be displayed on the page."
        },
        {
          "name": "iconUrl",
          "type": "string",
          "mandatory": false,
          "description": "Icon that will be displayed on the page."
        },
        {
          "name": "primaryCoverImage",
          "type": "string",
          "mandatory": false,
          "description": "Primary cover image that will be displayed on the page."
        },
        {
          "name": "secondaryCoverImage",
          "type": "string",
          "mandatory": false,
          "description": "Secondary cover image that will be displayed on the page."
        }
      ],
      "resParams": [
        {
          "name": "status",
          "type": "string",
          "description": "Status of the request, indicated as either 'SUCCESS' or 'ERROR'."
        },
        {
          "name": "message",
          "type": "string",
          "mandatory": true,
          "description": "A message that describes the status of the request."
        }
      ],
      "method": "PATCH",
      "path": "/merchants/:merchantId/stores/:storeId/branding",
      "examples": {
        "request": {
          "headers": [
            {
              "name": "Content-Type",
              "value": "application/json"
            },
            {
              "name": "API-KEY",
              "value": "YOUR_API_KEY"
            },
            {
              "name": "API-SECRET",
              "value": "YOUR_API_SECRET"
            },
            {
              "name": "MERCHANT-ID",
              "value": "YOUR_MERCHANT_ID"
            }
          ],
          "body": "{\"backgroundColor\":\"#667085\",\"brandColor\":\"#697085\",\"accentColor\":\"#787085\",\"rectShape\":\"ROUNDED\",\"fontType\":\"sans-serif\",\"logoUrl\":\"https://res.cloudinary.com/image/surfboard-icon.svg\",\"iconUrl\":\"https://res.cloudinary.com/image/surfboard-icon.svg\",\"footerColor\":\"#CD5C5B\",\"primaryCoverImage\":\"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\"secondaryCoverImage\":\"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\"}"
        },
        "response": [
          {
            "code": 200,
            "response": "\n{\n\t\"status\": \"SUCCESS\",\n\t\"message\": \"Branding configuration set successfully.\"\n}"
          }
        ]
      }
    },
    {
      "heading": "Create Branding for Terminal",
      "description": "Create a branding configuration for customizable pages at terminal level",
      "reqParams": [
        {
          "name": "backgroundColor",
          "type": "string",
          "mandatory": false,
          "description": "Background color for the page."
        },
        {
          "name": "brandColor",
          "type": "string",
          "mandatory": false,
          "description": "Primary brand color for your page."
        },
        {
          "name": "footerColor",
          "type": "string",
          "mandatory": false,
          "description": "Footer's background color on the page."
        },
        {
          "name": "accentColor",
          "type": "string",
          "mandatory": false,
          "description": "This is a secondary color that complements your brand color."
        },
        {
          "name": "rectShape",
          "type": "string",
          "mandatory": false,
          "description": "Decides the shape of the page buttons. The available shapes are 'ROUNDED', 'PILL' and 'EDGY'.",
          "possibleValues": [
            "ROUNDED",
            "PILL",
            "EDGY"
          ]
        },
        {
          "name": "fontType",
          "type": "string",
          "mandatory": false,
          "description": "Font family for the customizable page. The available font types are 'sans-serif','serif' and 'mono'.",
          "possibleValues": [
            "serif",
            "sans-serif",
            "mono"
          ]
        },
        {
          "name": "logoUrl",
          "type": "string",
          "mandatory": false,
          "description": "Logo that will be displayed on the page."
        },
        {
          "name": "iconUrl",
          "type": "string",
          "mandatory": false,
          "description": "Icon that will be displayed on the page."
        },
        {
          "name": "primaryCoverImage",
          "type": "string",
          "mandatory": false,
          "description": "Primary cover image that will be displayed on the page."
        },
        {
          "name": "secondaryCoverImage",
          "type": "string",
          "mandatory": false,
          "description": "Secondary cover image that will be displayed on the page."
        }
      ],
      "resParams": [
        {
          "name": "status",
          "type": "string",
          "description": "Status of the request, indicated as either 'SUCCESS' or 'ERROR'."
        },
        {
          "name": "message",
          "type": "string",
          "mandatory": true,
          "description": "A message that describes the status of the request."
        }
      ],
      "method": "PATCH",
      "path": "/merchants/:merchantId/stores/:storeId/terminals/:terminalId/branding",
      "examples": {
        "request": {
          "headers": [
            {
              "name": "Content-Type",
              "value": "application/json"
            },
            {
              "name": "API-KEY",
              "value": "YOUR_API_KEY"
            },
            {
              "name": "API-SECRET",
              "value": "YOUR_API_SECRET"
            },
            {
              "name": "MERCHANT-ID",
              "value": "YOUR_MERCHANT_ID"
            }
          ],
          "body": "{\"backgroundColor\":\"#667085\",\"brandColor\":\"#697085\",\"accentColor\":\"#787085\",\"rectShape\":\"ROUNDED\",\"fontType\":\"sans-serif\",\"logoUrl\":\"https://res.cloudinary.com/image/surfboard-icon.svg\",\"iconUrl\":\"https://res.cloudinary.com/image/surfboard-icon.svg\",\"footerColor\":\"#CD5C5B\",\"primaryCoverImage\":\"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\"secondaryCoverImage\":\"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\"}"
        },
        "response": [
          {
            "code": 200,
            "response": "\n{\n\t\"status\": \"SUCCESS\",\n\t\"message\": \"Branding configuration set successfully.\"\n}"
          }
        ]
      }
    },
    {
      "heading": "Create Branding for Partner",
      "description": "Create a branding configuration for customizable pages at partner level",
      "reqParams": [
        {
          "name": "backgroundColor",
          "type": "string",
          "mandatory": false,
          "description": "Background color for the page."
        },
        {
          "name": "brandColor",
          "type": "string",
          "mandatory": false,
          "description": "Primary brand color for your page."
        },
        {
          "name": "footerColor",
          "type": "string",
          "mandatory": false,
          "description": "Footer's background color on the page."
        },
        {
          "name": "accentColor",
          "type": "string",
          "mandatory": false,
          "description": "This is a secondary color that complements your brand color."
        },
        {
          "name": "rectShape",
          "type": "string",
          "mandatory": false,
          "description": "Decides the shape of the page buttons. The available shapes are 'ROUNDED', 'PILL' and 'EDGY'.",
          "possibleValues": [
            "ROUNDED",
            "PILL",
            "EDGY"
          ]
        },
        {
          "name": "fontType",
          "type": "string",
          "mandatory": false,
          "description": "Font family for the customizable page. The available font types are 'sans-serif','serif' and 'mono'.",
          "possibleValues": [
            "serif",
            "sans-serif",
            "mono"
          ]
        },
        {
          "name": "logoUrl",
          "type": "string",
          "mandatory": false,
          "description": "Logo that will be displayed on the page."
        },
        {
          "name": "iconUrl",
          "type": "string",
          "mandatory": false,
          "description": "Icon that will be displayed on the page."
        },
        {
          "name": "primaryCoverImage",
          "type": "string",
          "mandatory": false,
          "description": "Primary cover image that will be displayed on the page."
        },
        {
          "name": "secondaryCoverImage",
          "type": "string",
          "mandatory": false,
          "description": "Secondary cover image that will be displayed on the page."
        }
      ],
      "resParams": [
        {
          "name": "status",
          "type": "string",
          "description": "Status of the request, indicated as either 'SUCCESS' or 'ERROR'."
        },
        {
          "name": "message",
          "type": "string",
          "mandatory": true,
          "description": "A message that describes the status of the request."
        }
      ],
      "method": "PATCH",
      "path": "/partners/:partnerId/branding",
      "examples": {
        "request": {
          "headers": [
            {
              "name": "Content-Type",
              "value": "application/json"
            },
            {
              "name": "API-KEY",
              "value": "YOUR_API_KEY"
            },
            {
              "name": "API-SECRET",
              "value": "YOUR_API_SECRET"
            }
          ],
          "body": "{\"backgroundColor\":\"#667085\",\"brandColor\":\"#697085\",\"accentColor\":\"#787085\",\"rectShape\":\"ROUNDED\",\"fontType\":\"sans-serif\",\"logoUrl\":\"https://res.cloudinary.com/image/surfboard-icon.svg\",\"iconUrl\":\"https://res.cloudinary.com/image/surfboard-icon.svg\",\"footerColor\":\"#CD5C5B\",\"primaryCoverImage\":\"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\"secondaryCoverImage\":\"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\"}"
        },
        "response": [
          {
            "code": 200,
            "response": "\n{\n\t\"status\": \"SUCCESS\",\n\t\"message\": \"Branding configuration set successfully.\"\n}"
          }
        ]
      }
    },
    {
      "heading": "Fetch Branding for Merchant",
      "description": "Fetch existing branding configuration at merchant level.",
      "reqParams": [],
      "resParams": [
        {
          "name": "status",
          "type": "string",
          "description": "Status of the request, indicated as either 'SUCCESS' or 'ERROR'."
        },
        {
          "name": "data",
          "type": "object",
          "description": "Response data",
          "resParams": [
            {
              "name": "backgroundColor",
              "type": "string",
              "mandatory": false,
              "description": "Background color for the page."
            },
            {
              "name": "brandColor",
              "type": "string",
              "mandatory": false,
              "description": "Primary brand color for your page."
            },
            {
              "name": "footerColor",
              "type": "string",
              "mandatory": false,
              "description": "Footer's background color on the page."
            },
            {
              "name": "accentColor",
              "type": "string",
              "mandatory": false,
              "description": "This is a secondary color that complements your brand color."
            },
            {
              "name": "rectShape",
              "type": "string",
              "mandatory": false,
              "description": "Decides the shape of the page buttons. The available shapes are 'ROUNDED', 'PILL' and 'EDGY'."
            },
            {
              "name": "fontType",
              "type": "string",
              "mandatory": false,
              "description": "Font family for the customizable page. The available font types are 'sans-serif','serif' and 'mono'."
            },
            {
              "name": "logoUrl",
              "type": "string",
              "mandatory": false,
              "description": "Logo that will be displayed on the page."
            },
            {
              "name": "iconUrl",
              "type": "string",
              "mandatory": false,
              "description": "Icon that will be displayed on the page."
            },
            {
              "name": "primaryCoverImage",
              "type": "string",
              "mandatory": false,
              "description": "Primary cover image that will be displayed on the page."
            },
            {
              "name": "secondaryCoverImage",
              "type": "string",
              "mandatory": false,
              "description": "Secondary cover image that will be displayed on the page."
            }
          ]
        },
        {
          "name": "message",
          "type": "string",
          "description": "A message that describes the status of the request."
        }
      ],
      "method": "GET",
      "path": "/merchants/:merchantId/branding",
      "examples": {
        "request": {
          "headers": [
            {
              "name": "Content-Type",
              "value": "application/json"
            },
            {
              "name": "API-KEY",
              "value": "YOUR_API_KEY"
            },
            {
              "name": "API-SECRET",
              "value": "YOUR_API_SECRET"
            },
            {
              "name": "MERCHANT-ID",
              "value": "YOUR_MERCHANT_ID"
            }
          ]
        },
        "response": [
          {
            "code": 200,
            "response": "\n{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"backgroundColor\": \"#F08080\",\n\t\t\"brandColor\": \"#0E44E1\",\n\t\t\"rectShape\": \"ROUNDED\",\n\t\t\"fontType\": \"serif\",\n\t\t\"accentColor\": \"#F08080\",\n\t\t\"logoUrl\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n\t\t\"iconUrl\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n\t\t\"footerColor\": \"#CD5C5B\",\n\t\t\"primaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n\t\t\"secondaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\"\n\t},\n\t\"message\": \"Fetched Branding successfully\"\n}"
          }
        ]
      }
    },
    {
      "heading": "Fetch Branding for Store",
      "description": "Fetch existing branding configuration at store level.",
      "reqParams": [],
      "resParams": [
        {
          "name": "status",
          "type": "string",
          "description": "Status of the request, indicated as either 'SUCCESS' or 'ERROR'."
        },
        {
          "name": "data",
          "type": "object",
          "description": "Response data",
          "resParams": [
            {
              "name": "backgroundColor",
              "type": "string",
              "mandatory": false,
              "description": "Background color for the page."
            },
            {
              "name": "brandColor",
              "type": "string",
              "mandatory": false,
              "description": "Primary brand color for your page."
            },
            {
              "name": "footerColor",
              "type": "string",
              "mandatory": false,
              "description": "Footer's background color on the page."
            },
            {
              "name": "accentColor",
              "type": "string",
              "mandatory": false,
              "description": "This is a secondary color that complements your brand color."
            },
            {
              "name": "rectShape",
              "type": "string",
              "mandatory": false,
              "description": "Decides the shape of the page buttons. The available shapes are 'ROUNDED', 'PILL' and 'EDGY'."
            },
            {
              "name": "fontType",
              "type": "string",
              "mandatory": false,
              "description": "Font family for the customizable page. The available font types are 'sans-serif','serif' and 'mono'."
            },
            {
              "name": "logoUrl",
              "type": "string",
              "mandatory": false,
              "description": "Logo that will be displayed on the page."
            },
            {
              "name": "iconUrl",
              "type": "string",
              "mandatory": false,
              "description": "Icon that will be displayed on the page."
            },
            {
              "name": "primaryCoverImage",
              "type": "string",
              "mandatory": false,
              "description": "Primary cover image that will be displayed on the page."
            },
            {
              "name": "secondaryCoverImage",
              "type": "string",
              "mandatory": false,
              "description": "Secondary cover image that will be displayed on the page."
            }
          ]
        },
        {
          "name": "message",
          "type": "string",
          "description": "A message that describes the status of the request."
        }
      ],
      "method": "GET",
      "path": "/merchants/:merchantId/stores/:storeId/branding",
      "examples": {
        "request": {
          "headers": [
            {
              "name": "Content-Type",
              "value": "application/json"
            },
            {
              "name": "API-KEY",
              "value": "YOUR_API_KEY"
            },
            {
              "name": "API-SECRET",
              "value": "YOUR_API_SECRET"
            },
            {
              "name": "MERCHANT-ID",
              "value": "YOUR_MERCHANT_ID"
            }
          ]
        },
        "response": [
          {
            "code": 200,
            "response": "\n{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"backgroundColor\": \"#F08080\",\n\t\t\"brandColor\": \"#0E44E1\",\n\t\t\"rectShape\": \"ROUNDED\",\n\t\t\"fontType\": \"serif\",\n\t\t\"accentColor\": \"#F08080\",\n\t\t\"logoUrl\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n\t\t\"iconUrl\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n\t\t\"footerColor\": \"#CD5C5B\",\n\t\t\"primaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n\t\t\"secondaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\"\n\t},\n\t\"message\": \"Fetched Branding successfully\"\n}"
          }
        ]
      }
    },
    {
      "heading": "Fetch Branding for Terminal",
      "description": "Fetch existing branding configuration at terminal level.",
      "reqParams": [],
      "resParams": [
        {
          "name": "status",
          "type": "string",
          "description": "Status of the request, indicated as either 'SUCCESS' or 'ERROR'."
        },
        {
          "name": "data",
          "type": "object",
          "description": "Response data",
          "resParams": [
            {
              "name": "backgroundColor",
              "type": "string",
              "mandatory": false,
              "description": "Background color for the page."
            },
            {
              "name": "brandColor",
              "type": "string",
              "mandatory": false,
              "description": "Primary brand color for your page."
            },
            {
              "name": "footerColor",
              "type": "string",
              "mandatory": false,
              "description": "Footer's background color on the page."
            },
            {
              "name": "accentColor",
              "type": "string",
              "mandatory": false,
              "description": "This is a secondary color that complements your brand color."
            },
            {
              "name": "rectShape",
              "type": "string",
              "mandatory": false,
              "description": "Decides the shape of the page buttons. The available shapes are 'ROUNDED', 'PILL' and 'EDGY'."
            },
            {
              "name": "fontType",
              "type": "string",
              "mandatory": false,
              "description": "Font family for the customizable page. The available font types are 'sans-serif','serif' and 'mono'."
            },
            {
              "name": "logoUrl",
              "type": "string",
              "mandatory": false,
              "description": "Logo that will be displayed on the page."
            },
            {
              "name": "iconUrl",
              "type": "string",
              "mandatory": false,
              "description": "Icon that will be displayed on the page."
            },
            {
              "name": "primaryCoverImage",
              "type": "string",
              "mandatory": false,
              "description": "Primary cover image that will be displayed on the page."
            },
            {
              "name": "secondaryCoverImage",
              "type": "string",
              "mandatory": false,
              "description": "Secondary cover image that will be displayed on the page."
            }
          ]
        },
        {
          "name": "message",
          "type": "string",
          "description": "A message that describes the status of the request."
        }
      ],
      "method": "GET",
      "path": "/merchants/:merchantId/stores/:storeId/terminals/:terminalId/branding",
      "examples": {
        "request": {
          "headers": [
            {
              "name": "Content-Type",
              "value": "application/json"
            },
            {
              "name": "API-KEY",
              "value": "YOUR_API_KEY"
            },
            {
              "name": "API-SECRET",
              "value": "YOUR_API_SECRET"
            },
            {
              "name": "MERCHANT-ID",
              "value": "YOUR_MERCHANT_ID"
            }
          ]
        },
        "response": [
          {
            "code": 200,
            "response": "\n{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"backgroundColor\": \"#F08080\",\n\t\t\"brandColor\": \"#0E44E1\",\n\t\t\"rectShape\": \"ROUNDED\",\n\t\t\"fontType\": \"serif\",\n\t\t\"accentColor\": \"#F08080\",\n\t\t\"logoUrl\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n\t\t\"iconUrl\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n\t\t\"footerColor\": \"#CD5C5B\",\n\t\t\"primaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n\t\t\"secondaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\"\n\t},\n\t\"message\": \"Fetched Branding successfully\"\n}"
          }
        ]
      }
    },
    {
      "heading": "Fetch Branding for Partner",
      "description": "Fetch existing branding configuration at partner level.",
      "reqParams": [],
      "resParams": [
        {
          "name": "status",
          "type": "string",
          "description": "Status of the request, indicated as either 'SUCCESS' or 'ERROR'."
        },
        {
          "name": "data",
          "type": "object",
          "description": "Response data",
          "resParams": [
            {
              "name": "backgroundColor",
              "type": "string",
              "mandatory": false,
              "description": "Background color for the page."
            },
            {
              "name": "brandColor",
              "type": "string",
              "mandatory": false,
              "description": "Primary brand color for your page."
            },
            {
              "name": "footerColor",
              "type": "string",
              "mandatory": false,
              "description": "Footer's background color on the page."
            },
            {
              "name": "accentColor",
              "type": "string",
              "mandatory": false,
              "description": "This is a secondary color that complements your brand color."
            },
            {
              "name": "rectShape",
              "type": "string",
              "mandatory": false,
              "description": "Decides the shape of the page buttons. The available shapes are 'ROUNDED', 'PILL' and 'EDGY'."
            },
            {
              "name": "fontType",
              "type": "string",
              "mandatory": false,
              "description": "Font family for the customizable page. The available font types are 'sans-serif','serif' and 'mono'."
            },
            {
              "name": "logoUrl",
              "type": "string",
              "mandatory": false,
              "description": "Logo that will be displayed on the page."
            },
            {
              "name": "iconUrl",
              "type": "string",
              "mandatory": false,
              "description": "Icon that will be displayed on the page."
            },
            {
              "name": "primaryCoverImage",
              "type": "string",
              "mandatory": false,
              "description": "Primary cover image that will be displayed on the page."
            },
            {
              "name": "secondaryCoverImage",
              "type": "string",
              "mandatory": false,
              "description": "Secondary cover image that will be displayed on the page."
            }
          ]
        },
        {
          "name": "message",
          "type": "string",
          "description": "A message that describes the status of the request."
        }
      ],
      "method": "GET",
      "path": "/partners/:partnerId/branding",
      "examples": {
        "request": {
          "headers": [
            {
              "name": "Content-Type",
              "value": "application/json"
            },
            {
              "name": "API-KEY",
              "value": "YOUR_API_KEY"
            },
            {
              "name": "API-SECRET",
              "value": "YOUR_API_SECRET"
            }
          ]
        },
        "response": [
          {
            "code": 200,
            "response": "\n{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"backgroundColor\": \"#F08080\",\n\t\t\"brandColor\": \"#0E44E1\",\n\t\t\"rectShape\": \"ROUNDED\",\n\t\t\"fontType\": \"serif\",\n\t\t\"accentColor\": \"#F08080\",\n\t\t\"logoUrl\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n\t\t\"iconUrl\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n\t\t\"footerColor\": \"#CD5C5B\",\n\t\t\"primaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\",\n\t\t\"secondaryCoverImage\": \"https://images.app.goo.gl/PxBcTVm4Q1xJFhCn6\"\n\t},\n\t\"message\": \"Fetched Branding successfully\"\n}"
          }
        ]
      }
    },
    {
      "heading": "Remove Branding for Merchant",
      "description": "Removes the existing branding configuration at the merchant level.",
      "reqParams": [],
      "resParams": [
        {
          "name": "status",
          "type": "string",
          "description": "Status of the request, indicated as either 'SUCCESS' or 'ERROR'."
        },
        {
          "name": "message",
          "type": "string",
          "description": "A message describing the outcome of the request."
        }
      ],
      "method": "DELETE",
      "path": "/merchants/:merchantId/branding",
      "examples": {
        "request": {
          "headers": [
            {
              "name": "Content-Type",
              "value": "application/json"
            },
            {
              "name": "API-KEY",
              "value": "YOUR_API_KEY"
            },
            {
              "name": "API-SECRET",
              "value": "YOUR_API_SECRET"
            },
            {
              "name": "MERCHANT-ID",
              "value": "YOUR_MERCHANT_ID"
            }
          ]
        },
        "response": [
          {
            "code": 200,
            "response": "\n{\n  \"status\": \"SUCCESS\",\n  \"message\": \"Configuration deleted successfully for id [8113d3f8403b380409] and type MERCHANT\"\n}"
          }
        ]
      }
    },
    {
      "heading": "Remove Branding for Store",
      "description": "Removes the existing branding configuration at the store level.",
      "reqParams": [],
      "resParams": [
        {
          "name": "status",
          "type": "string",
          "description": "Status of the request, indicated as either 'SUCCESS' or 'ERROR'."
        },
        {
          "name": "message",
          "type": "string",
          "description": "A message describing the outcome of the request."
        }
      ],
      "method": "DELETE",
      "path": "/merchants/:merchantId/stores/:storeId/branding",
      "examples": {
        "request": {
          "headers": [
            {
              "name": "Content-Type",
              "value": "application/json"
            },
            {
              "name": "API-KEY",
              "value": "YOUR_API_KEY"
            },
            {
              "name": "API-SECRET",
              "value": "YOUR_API_SECRET"
            },
            {
              "name": "MERCHANT-ID",
              "value": "YOUR_MERCHANT_ID"
            }
          ]
        },
        "response": [
          {
            "code": 200,
            "response": "\n{\n  \"status\": \"SUCCESS\",\n  \"message\": \"Configuration deleted successfully for id [8113d3f8403b380409] and type STORE\"\n}"
          }
        ]
      }
    },
    {
      "heading": "Remove Branding for Terminal",
      "description": "Removes the existing branding configuration at the terminal level.",
      "reqParams": [],
      "resParams": [
        {
          "name": "status",
          "type": "string",
          "description": "Status of the request, indicated as either 'SUCCESS' or 'ERROR'."
        },
        {
          "name": "message",
          "type": "string",
          "description": "A message describing the outcome of the request."
        }
      ],
      "method": "DELETE",
      "path": "/merchants/:merchantId/stores/:storeId/terminals/:terminalId/branding",
      "examples": {
        "request": {
          "headers": [
            {
              "name": "Content-Type",
              "value": "application/json"
            },
            {
              "name": "API-KEY",
              "value": "YOUR_API_KEY"
            },
            {
              "name": "API-SECRET",
              "value": "YOUR_API_SECRET"
            },
            {
              "name": "MERCHANT-ID",
              "value": "YOUR_MERCHANT_ID"
            }
          ]
        },
        "response": [
          {
            "code": 200,
            "response": "\n{\n  \"status\": \"SUCCESS\",\n  \"message\": \"Configuration deleted successfully for id [833b9e1cf983580704] and type TERMINAL\"\n}"
          }
        ]
      }
    },
    {
      "heading": "Remove Branding for Partner",
      "description": "Removes the existing branding configuration at the partner level.",
      "reqParams": [],
      "resParams": [
        {
          "name": "status",
          "type": "string",
          "description": "Status of the request, indicated as either 'SUCCESS' or 'ERROR'."
        },
        {
          "name": "message",
          "type": "string",
          "description": "A message describing the outcome of the request."
        }
      ],
      "method": "DELETE",
      "path": "/partners/:partnerId/branding",
      "examples": {
        "request": {
          "headers": [
            {
              "name": "Content-Type",
              "value": "application/json"
            },
            {
              "name": "API-KEY",
              "value": "YOUR_API_KEY"
            },
            {
              "name": "API-SECRET",
              "value": "YOUR_API_SECRET"
            }
          ]
        },
        "response": [
          {
            "code": 200,
            "response": "\n{\n  \"status\": \"SUCCESS\",\n  \"message\": \"Configuration deleted successfully for id [8113d3f8403b380409] and type PARTNER\"\n}"
          }
        ]
      }
    },
    {
      "heading": "Generate Branding with AI for Partner",
      "description": "Generate ready-to-use branding suggestions for a partner from a website. Supply the URL of a site and Surfboard analyzes it to propose one or more complete branding options — colors, button shape, font, logo and icon — that you can apply to a partner, merchant, store, or terminal.",
      "reqParams": [
        {
          "name": "url",
          "type": "string",
          "mandatory": false,
          "description": "Website address to derive branding suggestions from, for example the partner's marketing site. When omitted, an empty URL is used and generic suggestions are returned."
        }
      ],
      "resParams": [
        {
          "name": "status",
          "type": "string",
          "description": "Status of the request, indicated as either 'SUCCESS' or 'ERROR'."
        },
        {
          "name": "data",
          "type": "object",
          "description": "The generated branding suggestions.",
          "resParams": [
            {
              "name": "brandingOptions",
              "type": "array",
              "description": "The suggested branding configurations. Each entry is a complete set of branding values you can apply.",
              "resParams": [
                {
                  "name": "backgroundColor",
                  "type": "string",
                  "description": "Suggested background color for the page, as a hex color code."
                },
                {
                  "name": "brandColor",
                  "type": "string",
                  "description": "Suggested primary brand color, as a hex color code."
                },
                {
                  "name": "accentColor",
                  "type": "string",
                  "description": "Suggested secondary color that complements the brand color, as a hex color code."
                },
                {
                  "name": "rectShape",
                  "type": "string",
                  "description": "Suggested shape for the page buttons.",
                  "possibleValues": [
                    "ROUNDED",
                    "PILL",
                    "EDGY"
                  ]
                },
                {
                  "name": "fontType",
                  "type": "string",
                  "description": "Suggested font family for the page.",
                  "possibleValues": [
                    "serif",
                    "sans-serif",
                    "mono"
                  ]
                },
                {
                  "name": "logoUrl",
                  "type": "string",
                  "description": "URL of the suggested logo to display on the page."
                },
                {
                  "name": "iconUrl",
                  "type": "string",
                  "description": "URL of the suggested icon to display on the page."
                },
                {
                  "name": "footerColor",
                  "type": "string",
                  "description": "Suggested footer background color, as a hex color code."
                }
              ]
            },
            {
              "name": "metadata",
              "type": "object",
              "description": "Details about the generation run.",
              "resParams": [
                {
                  "name": "inputTokens",
                  "type": "number",
                  "description": "Number of input tokens consumed to generate the suggestions."
                },
                {
                  "name": "outputTokens",
                  "type": "number",
                  "description": "Number of output tokens produced while generating the suggestions."
                },
                {
                  "name": "outputType",
                  "type": "string",
                  "description": "The kind of output that was generated."
                }
              ]
            }
          ]
        },
        {
          "name": "message",
          "type": "string",
          "description": "A message that describes the status of the request."
        }
      ],
      "method": "POST",
      "path": "/partners/:partnerId/ai/branding",
      "examples": {
        "request": {
          "headers": [
            {
              "name": "Content-Type",
              "value": "application/json"
            },
            {
              "name": "API-KEY",
              "value": "YOUR_API_KEY"
            },
            {
              "name": "API-SECRET",
              "value": "YOUR_API_SECRET"
            }
          ],
          "body": "{\"url\":\"https://www.surfboard.se\"}"
        },
        "response": [
          {
            "code": 200,
            "response": "\n{\n\t\"status\": \"SUCCESS\",\n\t\"data\": {\n\t\t\"brandingOptions\": [\n\t\t\t{\n\t\t\t\t\"backgroundColor\": \"#F5F5F5\",\n\t\t\t\t\"brandColor\": \"#0E44E1\",\n\t\t\t\t\"accentColor\": \"#F08080\",\n\t\t\t\t\"rectShape\": \"ROUNDED\",\n\t\t\t\t\"fontType\": \"sans-serif\",\n\t\t\t\t\"logoUrl\": \"https://res.cloudinary.com/image/surfboard-logo.svg\",\n\t\t\t\t\"iconUrl\": \"https://res.cloudinary.com/image/surfboard-icon.svg\",\n\t\t\t\t\"footerColor\": \"#CD5C5B\"\n\t\t\t}\n\t\t],\n\t\t\"metadata\": {\n\t\t\t\"inputTokens\": 1024,\n\t\t\t\"outputTokens\": 256,\n\t\t\t\"outputType\": \"json\"\n\t\t}\n\t},\n\t\"message\": \"Branding generated successfully\"\n}"
          },
          {
            "code": 400,
            "response": "\n{\n\t\"status\": \"ERROR\",\n\t\"message\": \"Unable to generate branding\"\n}"
          },
          {
            "code": 401,
            "response": "\n{\n\t\"status\": \"ERROR\",\n\t\"message\": \"Authentication failed\"\n}"
          }
        ]
      },
      "params": {
        "url": "https://www.surfboard.se"
      }
    }
  ]
}