Update Merchant Branding
Update the visual branding settings for your merchant account. This includes colors, typography, button styling, and display preferences for your payment interface.
All parameters are optional - you can update individual settings without affecting others. The endpoint returns true if the branding was successfully updated.
Note: For uploading logo and sidebar images, use the generate-branding-upload-url and confirm-branding-upload endpoints.
primary_color
string
Optional. Primary color used for buttons and main elements (hex format, e.g., #FF0000).
secondary_color
string
Optional. Secondary color used for backgrounds and accents (hex format, e.g., #00FF00).
sidebar_color
string
Optional. Background color for the sidebar (hex format, e.g., #0000FF).
sidebar_background_type
string
Optional. The type of sidebar background to use (color or image).
Allowed values:colorimage
tile_sidebar_image
boolean
Optional. Whether to tile the sidebar image to fill the entire sidebar area.
hide_logo
boolean
Optional. Whether to hide the logo completely from the payment interface.
heading_font_family
string
Optional. Font family for headings. Must be a valid Google Font or default font.
heading_font_variant
string
Optional. Font weight variant for headings.
Allowed values:ThinExtraLightLightRegularMediumSemiBoldBoldExtraBoldBlack
body_font_family
string
Optional. Font family for body text. Must be a valid Google Font or default font.
body_font_variant
string
Optional. Font weight variant for body text.
Allowed values:ThinExtraLightLightRegularMediumSemiBoldBoldExtraBoldBlack
use_iso_code
boolean
Optional. Whether to use ISO currency codes instead of currency symbols.
hide_non_significant_zeros
boolean
Optional. Whether to hide decimal places when the amount has no subunits (e.g., $10 instead of $10.00).
show_amount_in_button
boolean
Optional. Whether to display the payment amount in the payment button.
symbol_placement
string
Optional. Whether to place currency symbols before or after the amount.
Allowed values:use_defaultbefore_amountafter_amount
default_button_text
string
Optional. Default text to display on payment buttons.
button_shape
string
Optional. The border radius style for buttons.
Allowed values:rounded_nonerounded_fullrounded_xsrounded_smrounded_mdrounded_lgrounded_xl
INVALID_ARGUMENTS
This error occurs when the request contains invalid parameters. Common cases include invalid hex color formats, unsupported font families, or invalid font variants for the specified font family.
UNHANDLED_ERROR
This error occurs when the server encounters an unexpected internal error that it cannot handle gracefully. This typically happens due to bugs, infrastructure issues, or edge cases that weren't anticipated during development.
INVALID_ARGUMENTS
This error occurs when the request contains invalid or missing parameters. Common cases include missing required fields, or values that don't match the expected format or type.
BAD_VERSION
This error occurs when making requests to an API version that does not exist. This commonly happens when using an outdated SDK or when the API version specified in the request URL is incorrect.
