--- title: "Returns the customizations as configured in the BonifiQ admin panel" method: GET path: "/v1/pvt/Customization" tags: ["Customization"] --- # Returns the customizations as configured in the BonifiQ admin panel `GET /v1/pvt/Customization` ## Request - Base URL: `https://api.bonifiq.com.br` - URL: `https://api.bonifiq.com.br/v1/pvt/Customization` - Auth: HTTP basic Returns the customizations as configured in the BonifiQ admin panel This method returns two types of rewards: Discounts (Value Discounts and Percent Discounts) or Cashback. Altough not commom, it is possible to have all types of rewards active at the same time. ## Main properties - `ProgramName` The name of the loyalty program. This could be different from the store name. Eg: "MyStore Rewards" - `WidgetIconUrl`: The URL of the icon used as reference in the loyaty program. Used in widget an landing pages. If null, the default icon should be used - `HaveIconUrl`: if true the icon URL is set and should be used. If false, the default icon should be used - `WidgetColor`: if `HaveIconUrl` is false, this color should be used in the widget. - `MainColor`: the hexadecimal color used as a main theme color for the program. - `Logo`: The URL of the store. This is usually used in the e-mails sent do customers. - `Url`: The URL of the store or loyalty landing page. It could be useful when communicating with the customer for sending him to the store. - `CompanyName`: Name of the store or company. Can be used in communications. - `PointsNameSingular` and `PointNamePlural`: The user can change the name "Points" to something like "Coins". These are the Singular and Plural versions - `CashbackName`: The user can change the name "cashback" to something like "Giftback". If null, the name was not customized and "cashback" should be used. - `CustomerMainKey`: The primary customer identification key configured for the tenant: "email" or "document". Defaults to "email". - `CashbackActive`: true when the cashback reward is active. If false, show the balance in points only. - `OtherRewardsActive`: true when any reward other than cashback is active. If only cashback is active, show the balance in cashback only. ## Defining Loyalty Program Icon The Loyalty Programa usually have an unique visual identification, as a logo or icon. This icon is used in the widget and landing pages to identify the program. If the `WidgetIconUrl` is null them the logo is not set and a default icon should be used instead. The rule therefore should be: - If `HaveIconUrl` is `true` use the `WidgetIconUrl` as the icon as a link to an image - If `HaveIconUrl` is `false` display the default widget icon. Usually it is the `giftcard` icon from Material UI. Use [this link](https://shorturl.at/Hxd9r) for instructios on how to use it - If using the default icon, use `WidgetColor` to set the icon color as set in the BonifiQ admin configuration. ## Response `200` - ExternalAPICustomizationResponse - `Logo` string, nullable: The URL of the store. This is usually used in the e-mails sent do customers. - `CashbackName` string, nullable: The user can change the name "cashback" to something like "Giftback". Returned as plain text, exactly as configured. If null, the name was not customized and "cashback" (or its translation) should be used - `ProgramName` string, nullable: The name of the loyalty program. This could be different from the store name. Eg: "MyStore Rewards" - `FontName` string, nullable: Name of the font set. If null use a default font - `FontUrl` string, nullable: URL for the font. For webfonts the FontUrl is null otherwise the URL if given in this field - `MainColor` string: The hexadecimal color used as a main theme color for the program. - `Url` string, nullable: The URL of the store or loyalty landing page. It could be useful when communicating with the customer for sending him to the store. - `CompanyName` string: Name of the store or company. Can be used in communications. - `Locale` string, nullable: Locale configured for the tenant. - `WidgetIconUrl` string, nullable: The URL of the icon used as reference in the loyaty program. Used in widget an landing pages. If null, the default icon should be used - `HaveIconUrl` boolean: if true the icon URL is set and should be used. If false, the default icon should be used - `WidgetColor` string, nullable: if `HaveIconUrl` is false, this color should be used in the widget. - `PointsNameSingular` string: The user can change the name "Points" to something like "Coins". This is the Singular version - `PointNamePlural` string: The user can change the name "Points" to something like "Coins". This is the Plural version - `CustomerMainKey` string: Customer identification key configured for the tenant: "email" or "document". Defaults to "email". - `CashbackActive` boolean: True when the cashback reward is active. When false, the customer's balance should be shown in points only - `OtherRewardsActive` boolean: True when at least one reward other than cashback (discount coupons, free shipping or customized rewards) is active. When only the cashback reward is active (`CashbackActive` true and this false), the balance should be shown in cashback only ## Changes - **2026-10-20** `3a6f89088416`: 2 info - added the optional property `CashbackActive` to the response with the `200` status - added the optional property `OtherRewardsActive` to the response with the `200` status - **2026-09-12** `0492a8200489`: 1 info - added the optional property `CashbackName` to the response with the `200` status - **2026-09-04** `7d1b524f93bd`: 1 info - added the optional property `CustomerMainKey` to the response with the `200` status [Operation history](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/changes/v1/pvt/Customization/get.md) --- [API](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis.md) - [All operations](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/revisions/bac0977b23d5?raw)