Skip to main content
Brand settings control the fonts, colours, button style and logo on the PayChoice Widget and the Create Token page. They are stored per merchant and applied to every page served for that merchant.

​
Endpoints

Brand settings are part of the merchant profile API and use the same base URL and Basic Authentication as every other request. /api/v5/ is identical. {merchant} is the merchant GUID. An agency credential can access its own merchants; a merchant credential can access only itself.

​
Read settings

GET returns the standard Billing envelope with the settings under branding_settings:
If no settings have been saved yet, the response is 400 with "message": "Unable to fetch settings". POST your settings first.

​
Update settings

POST as multipart/form-data. The call creates the settings if none exist and updates them otherwise. Only the fields you send are changed; fields cannot be cleared (empty, 0, null and false values are ignored).
​
string
HKGrotesk, DM Sans, Inter, Space Mono, Space Grotesk, Work Sans, Syne, Libre Franklin, Cormorant, Fira Sans or Eczar.
​
hex colour
Also paragraph_font_color, button_font_color, button_background. Hex #RGB, #RRGGBB or #RRGGBBAA.
​
string
Also paragraph_font_size, button_font_size. One of 12px, 14px, 16px, 18px, 20px, 22px.
​
string
Also paragraph_font_weight. One of bold, 400, 500.
​
string
One of 0px, 2px, 5px, 10px, 20px, 30px.
PNG or JPEG.
​
hex colour
Also input_field_background_color, input_field_text_color, label_text_color, card_background_color, section_background_color, table_header_background_color, border_color. Accepted and stored now; applied to the hosted pages in a coming release.
On success the response is 200 with message_text “Data Updated”. A failure (for example an unsupported logo file type) returns 400 “Unable to update settings”.