API references
Search documentation... ⌘K
Open merchant dashboard
Merchant API
All our references

Retrieve Merchant Branding

Get the current visual branding settings for your merchant account. This includes colors, typography, button styling, display preferences, and uploaded assets (logos, sidebar images) for your payment interface.

The response includes all branding configuration options that can be customized through the update-branding endpoint, as well as URLs to any uploaded branding assets.

Common use cases for this endpoint include: - Checking your current branding configuration - Previewing how your payment interface will look to customers - Verifying that uploaded logos and images are properly configured - Getting branding settings for integration with your own systems

This endpoint requires authentication and will only return branding details for the authenticated merchant.

Endpoint signature
This endpoint requires an API key. Read our authentication guide for more information.
POST https://api.reservepay.com/merchants/retrieve-branding HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <token>
{}
Returns: object
New to Reservepay? Read our guide on how to call endpoints to get started.
Response attributes
Attribute Description
primary_color
string

Always present. Primary color used for buttons and main elements (hex format).
secondary_color
string

Always present. Secondary color used for backgrounds and accents (hex format).
sidebar_color
string

Always present. Background color for the sidebar (hex format).
sidebar_background_type
string

Always present. The type of sidebar background to use (color or image).

Possible values:
  • color
  • image
tile_sidebar_image
boolean

Always present. Whether to tile the sidebar image to fill the entire sidebar area.
hide_logo
boolean

Always present. Whether to hide the logo completely from the payment interface.
heading_font_family
string

Always present. Font family for headings.
heading_font_variant
string

Always present. Font weight variant for headings.

Possible values:
  • Thin
  • ExtraLight
  • Light
  • Regular
  • Medium
  • SemiBold
  • Bold
  • ExtraBold
  • Black
body_font_family
string

Always present. Font family for body text.
body_font_variant
string

Always present. Font weight variant for body text.

Possible values:
  • Thin
  • ExtraLight
  • Light
  • Regular
  • Medium
  • SemiBold
  • Bold
  • ExtraBold
  • Black
use_iso_code
boolean

Always present. Whether to use ISO currency codes instead of currency symbols.
hide_non_significant_zeros
boolean

Always present. Whether to hide decimal places when they are zero.
show_amount_in_button
boolean

Always present. Whether to display the payment amount in the button text.
symbol_placement
string

Always present. Where to place the currency symbol relative to the amount.

Possible values:
  • use_default
  • before_amount
  • after_amount
default_button_text
string

Always present. Default text displayed on payment buttons.
button_shape
string

Always present. Border radius style for buttons.

Possible values:
  • rounded_none
  • rounded_full
  • rounded_xs
  • rounded_sm
  • rounded_md
  • rounded_lg
  • rounded_xl
light_logo_url
string

Nullable. URL for the light logo (for light backgrounds).
light_logo_id
string

Nullable. Upload ID for the light logo. Use this ID with remove-branding-document to remove the logo.
light_logo_filename
string

Nullable. Original filename of the uploaded light logo.
light_logo_file_type
string

Nullable. MIME type of the light logo file (e.g., 'image/png', 'image/jpeg').
dark_logo_url
string

Nullable. URL for the dark logo (for dark backgrounds).
dark_logo_id
string

Nullable. Upload ID for the dark logo. Use this ID with remove-branding-document to remove the logo.
dark_logo_filename
string

Nullable. Original filename of the uploaded dark logo.
dark_logo_file_type
string

Nullable. MIME type of the dark logo file (e.g., 'image/png', 'image/jpeg').
sidebar_image_url
string

Nullable. URL for the sidebar background image.
sidebar_image_id
string

Nullable. Upload ID for the sidebar image. Use this ID with remove-branding-document to remove the image.
sidebar_image_filename
string

Nullable. Original filename of the uploaded sidebar image.
sidebar_image_file_type
string

Nullable. MIME type of the sidebar image file (e.g., 'image/png', 'image/jpeg').
Errors common to all endpoints
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.

Open in Markdown
CODE SAMPLES
curl
curl "https://api.reservepay.com/merchants/retrieve-branding" \
  -X POST
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $(RESERVEPAY_API_KEY)" \
  -d '{}'
Learn how to run these code samples in your terminal by reading our guide.