Developers

Search for documents

Dev

Branding

Operations related to brand configuration and theming

All endpoints require a JWT Bearer token in the Authorization header; most also require an API key in the X-API-KEY header.

GET `/v1/branding/{domain}`

Get branding configuration by domain

Retrieves the branding configuration for a specific domain. This endpoint is used to fetch theme settings, logos, colors, and metadata for white-label implementations when no user is authenticated.

Parameters

Name	In	Type	Required	Description
`domain`	path	`string`	Yes	The domain to retrieve branding configuration for (e.g., 'dockmaster.valpay.com', 'portal.roepay.com')

Responses

Status	Description
`200`	Branding configuration retrieved successfully
`404`	Brand with specified domain not found

Response schema (2xx)

Field	Type	Required
`success`	`boolean`	No
`data`	`object`	No
`message`	`string`	No

Examples

GET `/v1/branding/{domain}`

curl https://api.valpay.com/v1/branding/portal.example.com \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

curl https://api.valpay.com/v1/branding/portal.example.com \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

curl https://api.valpay.com/v1/branding/portal.example.com \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Response 200 (illustrative):

{
  "success": true,
  "data": {
    "name": "Example Brand",
    "theme": { "primaryColor": "#0A2540" },
    "logoUrl": "https://example.com/logo.svg"
  },
  "message": "Branding configuration retrieved successfully"
}

{
  "success": true,
  "data": {
    "name": "Example Brand",
    "theme": { "primaryColor": "#0A2540" },
    "logoUrl": "https://example.com/logo.svg"
  },
  "message": "Branding configuration retrieved successfully"
}

{
  "success": true,
  "data": {
    "name": "Example Brand",
    "theme": { "primaryColor": "#0A2540" },
    "logoUrl": "https://example.com/logo.svg"
  },
  "message": "Branding configuration retrieved successfully"
}