For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
DocsAPI Reference
DocsAPI Reference
    • What is Transak
  • Features
    • Auth Reliance
    • KYC Reliance using Sumsub
    • Webhooks
    • WebSockets
  • Products Overview
    • On Ramp
    • Off Ramp
    • NFT Checkout
  • Integration Options
    • API
  • Customization Options
    • Query Parameters
    • Customizing theme using query parameters
  • Guides
    • How To Create a Partner Dashboard Account
    • How to Add Partner Fees and Set Up Partner Payouts
    • How to Test using Sandbox Credentials
    • How to Test ACH Pull Transaction in Sandbox
    • How to Test Apple Pay in Sandbox
    • How to Track Order Status
    • Transak Different KYC Levels
    • How to Submit FCA Requirements
    • How to Use Advanced Query Params
    • How to Create a Widget URL with Parameters and Test Different Scenarios
    • How to Generate Calldata for NFT Checkout
    • How to Add NFT Smart Contract in the Dashboard and Create a contractId
    • Get Price based on User Region
    • How to Create Partner Access Token
    • How to Decrypt the Webhook Payload
    • How to add MCP Server for Transak Documentation
    • Widget with API Customization
    • Integration Update - Mandatory Migration to API based Transak Widget URL
    • Biconomy: Simplified Onboarding Using MEE-Compatible Smart Accounts
    • Partner FAQs
    • Need Help?
Dashboard
LogoLogo
On this page
  • Primary Button Colors
  • Color Mode
  • Complete Theme Customization
  • Brand and Text Colors
  • Surface and Background Colors
  • Status Colors
  • Putting It All Together
Customization Options

Customizing theme using query parameters

Customize the look and feel of the Transak widget
||View as Markdown|
Was this page helpful?
Edit this page
Previous

Query Parameters

Next

How To Create a Partner Dashboard Account

Built with

Use Transak’s theme-related query parameters in widgetParams to customize button colors, color mode, and the full widget theme.

Pass these parameters in the Create Widget URL API request body when generating a widgetUrl.

apiKey and referrerDomain are mandatory in widgetParams for all examples on this page.

Primary Button Colors

Use these parameters to customize the primary button background and text color.

ParameterDescription
primaryButtonFillColorHex color for the button background
primaryButtonTextColorHex color for the button text

Sample Result

Primary CTA button restyled to match brand mustard and dark grey text using primaryButtonFillColor and primaryButtonTextColor.

Primary button color customization example

Sample Request

$curl --request POST \
> --url https://api-gateway-stg.transak.com/api/v2/auth/session \
> --header 'accept: application/json' \
> --header 'access-token: YOUR_ACCESS_TOKEN' \
> --header 'content-type: application/json' \
> --data '{
> "widgetParams": {
> "apiKey": "YOUR_API_KEY",
> "referrerDomain": "yourdomain.com",
> "primaryButtonFillColor": "#F59E0B",
> "primaryButtonTextColor": "#0B0B0B"
> }
> }'

Color Mode

Use colorMode to switch the widget between light and dark themes.

ParameterAllowed valuesDescription
colorModeLIGHT, DARKSets the widget theme mode

Sample Result

Color mode dark theme example

Sample Request

$curl --request POST \
> --url https://api-gateway-stg.transak.com/api/v2/auth/session \
> --header 'accept: application/json' \
> --header 'access-token: YOUR_ACCESS_TOKEN' \
> --header 'content-type: application/json' \
> --data '{
> "widgetParams": {
> "apiKey": "YOUR_API_KEY",
> "referrerDomain": "yourdomain.com",
> "colorMode": "DARK"
> }
> }'

Complete Theme Customization

Use the following parameters together to fully align the widget with your brand.

Brand and Text Colors

ParameterDescription
brandColorPrimary brand color for accents and links
textPrimaryColorPrimary text color
textSecondaryColorSecondary or muted text color
labelTextColorForm label text color

Surface and Background Colors

ParameterDescription
surfaceFillColorCard or surface background
widgetBackgroundFillColorWidget container background
borderColorBorder color for inputs and cards

Status Colors

ParameterDescriptionExample value
greenColorSuccess or positive state#10B981
redColorError or negative state#EF4444

Putting It All Together

Below is an example combining color mode, primary button styling, and full theme customization into a single widget URL flow.

Sample Result

Complete theme customization example

Sample Request

$curl --request POST \
> --url https://api-gateway-stg.transak.com/api/v2/auth/session \
> --header 'accept: application/json' \
> --header 'access-token: YOUR_ACCESS_TOKEN' \
> --header 'content-type: application/json' \
> --data '{
> "widgetParams": {
> "apiKey": "YOUR_API_KEY",
> "referrerDomain": "yourdomain.com",
> "brandColor": "#F6DC2D",
> "textPrimaryColor": "#FFFFFF",
> "textSecondaryColor": "#8F8F8F",
> "labelTextColor": "#FFFFFF",
> "surfaceFillColor": "#452167",
> "widgetBackgroundFillColor": "#300856",
> "borderColor": "#6A4D85",
> "greenColor": "#34D399",
> "redColor": "#EF4444"
> }
> }'