Branding

Branding lets you present VoPay-hosted experiences as your own. You upload a logo and choose two colours, and VoPay applies them to the products enabled for your account. Branding is applied per product, so the portal, eLinx, emails and the application form can each carry their own look, or you can apply one set of values to all of them at once.

What you can brand

Branding is enabled per product by VoPay. Only the products enabled for your account appear in the portal and are accepted by the API.

Emails that carry your branding

When email branding is enabled, these emails use your logo and colours, and your custom sending domain when one is verified:

• Transaction status notifications (sent, completed, failed, cancelled, returned)
• eLinx payment request, reminder and fulfilment emails
• Transaction approval requests sent to your approvers
• Contact and bank account verification emails
• Portal user welcome, password reset and account access emails
• Negative balance (NSF), low balance and send limit warnings
• Dispute and notification-of-change alerts

Emails VoPay sends to you as a VoPay customer, such as invoices and agreement copies, always keep VoPay branding and come from a vopay.com address.

What you can provide

Text colours are derived automatically. VoPay checks the perceived brightness of each colour and picks black or white text so that button labels and header text stay legible. You do not choose text colours yourself.

Logo requirements

• PNG or SVG only. Other formats are rejected.
• SVG files must be true vector artwork. An SVG that embeds a raster image, contains scripts, or references external files or fonts is rejected. If your logo only exists as a bitmap, upload a PNG instead.
• For emails, the logo is converted to PNG and fitted, without stretching, onto a 600 x 100 pixel canvas (a 2x render of the 300 x 50 header slot). A wide horizontal logo works best. Small logos are not upscaled.
• For the Application Form, the logo must be under 4 MB.
• Through the API, send the logo as a base64 data URI, for example data:image/png;base64,iVBORw0....

Defaults

Products without branding use the VoPay defaults: primary colour #FFD147, secondary colour #222222 and the VoPay logo. The embedded eLinx iframe also supports a dark mode, which swaps in a light-on-dark VoPay logo. Your own logo and colours are used in both modes.

How branding is resolved

Branding is inherited. When VoPay renders a page or email for an account, it looks for branding in this order and uses the first match:

1. The account's own branding for that product
2. Branding on the account's parent, then each parent up the hierarchy
3. Branding on the partner the account belongs to
4. VoPay defaults

So a partner can brand once and every sub-account without its own branding inherits it. A sub-account that needs a different look sets its own branding for the products it wants to override.

Where to update your branding

Account portal

Go to Settings → Branding Settings. The page shows one tile per enabled product with a live preview. Select a product, click Edit, upload your logos and set your colours, then Save. Tick Apply to all products to write the same values to every enabled product in one step.

Saving the Portal product re-themes the portal immediately for everyone on your account.

Updating branding requires a portal user with the Add Settings permission.

Partner portal

Partners use Settings → Branding in the partner dashboard. It works the same way and adds the Application Form product. Users with a view-only role can see the current branding but cannot change it.

When a partner saves Application Form or Emails branding, the logo and colours are also pushed to the onboarding application form if onboarding is configured for the partner.

API

Branding can be managed with the Branding endpoints. Account credentials use the /account/ routes; partner credentials use the matching /partner/ routes.

All three take a Product parameter with one of portal, elinx, email or onboarding. The account must have branding enabled for that product, otherwise the request is rejected.

Set branding

POST /api/v2/account/branding
Content-Type: application/x-www-form-urlencoded

AccountID=yourAccountID
Key=yourAPIKey
Signature=yourSignature
Product=portal
PrimaryColor=1A73E8
SecondaryColor=222222
Logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0i...
SmallLogo=data:image/png;base64,iVBORw0KGgo...

Fields you leave out keep their current value, so you can update colours without re-uploading the logo. The # on colours is optional.

{
  "Success": true,
  "ErrorMessage": ""
}

Fetch branding

GET /api/v2/account/branding-details?AccountID=...&Key=...&Signature=...&Product=email

{
  "Success": true,
  "ErrorMessage": "",
  "BrandingDetails": {
    "PrimaryColor": "#1A73E8",
    "SecondaryColor": "#222222",
    "TextColor": "#FFFFFF",
    "ButtonTextColor": "#FFFFFF",
    "Product": "email"
  },
  "Logo": "data:image/png;base64,iVBORw0KGgo...",
  "LogoUrl": "https://.../branding-logo.png",
  "SmallLogo": "data:image/png;base64,iVBORw0KGgo...",
  "SmallLogoUrl": "https://.../branding-logo.png",
  "PageTitle": "Acme Payments",
  "Favicon": ""
}

The response is the resolved branding, so an account that inherits from its partner receives the partner's values. PageTitle and Favicon come from your white-labelled hostname and are empty when no custom URL is configured. If Product is omitted, email is returned.

Remove branding

POST /api/v2/account/branding/delete

AccountID=...&Key=...&Signature=...&Product=elinx

Removing branding deactivates it for that product. The product falls back to inherited branding if any exists, otherwise to the VoPay defaults. Setting branding again reactivates it.

Enabling branding

Branding is switched on per product by your VoPay account manager. Ask to enable any of:

• Portal branding
• eLinx branding
• Email branding
• Application Form branding (partners only)

Once enabled, the Branding Settings page appears in the portal and the corresponding Product value is accepted by the API.