Developer

API references

Search documentation... ⌘K

API references

Open merchant dashboard

Merchant API

- Available API versions
- Supported payment methods
- Find key
- List keys
- Revoke key
- Update key
- Get balance
- Find bank account
- Link bank account
- Set primary contact bank account
- Unlink bank account
- List monthly billing archives
- List plans
- List statements
- Retrieve current plan
- Retrieve monthly billing archive
- Select plan
- Confirm branding upload
- Generate branding upload url
- Remove branding document
- Retrieve branding
- Retrieve branding font
- Update branding
- Find card
- Forget card
- Save card
- Set default card
- Retrieve checkout
- Start checkout
- Add contact
- List contacts
- Remove contact
- Retrieve contact
- Update contact
- Disable installation
- Enable installation
- Find installation
- List installations
- Reconfigure installation
- Remove installation
- List metadata
- Retrieve metadata
- Sync metadata
- List email subscribers
- Retrieve email subscriber
- Retrieve notification topics
- Subscribe to topics
- Unsubscribe from all topics
- Add payment link
- Clone payment link
- Disable payment link
- Enable payment link
- Filter payment links
- Find payment link
- List payment link payments
- List payment links
- Abort payment on terminal
- Capture payment
- Filter payments
- Find payment
- Initiate payment flow
- List payment activities
- List payments
- List payments by contact
- List payments by terminal
- Refund payment
- Request payment
- Retrieve sales performance
- Reverse payment
- Start payment on terminal
- Void payment
- Filter payouts
- Find payout
- List payout activities
- List payouts
- List payouts by contact
- Send payout
- Send payout to contact
- Set primary bank account
- Turn off auto payout
- Turn on auto payout
- Find refund
- List refunds by payment
- Assign role
- List permissions
- List roles
- Add terminal
- Disable terminal
- Enable terminal
- Filter terminals
- Find terminal
- List terminals
- Remove terminal
- Reset terminal
- Update terminal
- List user invitations
- List users
- Disconnect webhook
- Find webhook
- List webhooks
- Pause webhook
- Reconnect webhook
- Resume webhook

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	Primary color used for buttons and main elements (hex format).
`secondary_color` string	Secondary color used for backgrounds and accents (hex format).
`sidebar_color` string	Background color for the sidebar (hex format).
`sidebar_background_type` string	The type of sidebar background to use (color or image).
`tile_sidebar_image` boolean	Whether to tile the sidebar image to fill the entire sidebar area.
`hide_logo` boolean	Whether to hide the logo completely from the payment interface.
`heading_font_family` string	Font family for headings.
`heading_font_variant` string	Font weight variant for headings.
`body_font_family` string	Font family for body text.
`body_font_variant` string	Font weight variant for body text.
`use_iso_code` boolean	Whether to use ISO currency codes instead of currency symbols.
`hide_non_significant_zeros` boolean	Whether to hide decimal places when they are zero.
`show_amount_in_button` boolean	Whether to display the payment amount in the button text.
`symbol_placement` string	Where to place the currency symbol relative to the amount.
`default_button_text` string	Default text displayed on payment buttons.
`button_shape` string	Border radius style for buttons.
`light_logo_url` string	URL for the light logo (for light backgrounds).
`light_logo_id` string	Upload ID for the light logo. Use this ID with remove-branding-document to remove the logo.
`light_logo_filename` string	Original filename of the uploaded light logo.
`light_logo_file_type` string	MIME type of the light logo file (e.g., 'image/png', 'image/jpeg').
`dark_logo_url` string	URL for the dark logo (for dark backgrounds).
`dark_logo_id` string	Upload ID for the dark logo. Use this ID with remove-branding-document to remove the logo.
`dark_logo_filename` string	Original filename of the uploaded dark logo.
`dark_logo_file_type` string	MIME type of the dark logo file (e.g., 'image/png', 'image/jpeg').
`sidebar_image_url` string	URL for the sidebar background image.
`sidebar_image_id` string	Upload ID for the sidebar image. Use this ID with remove-branding-document to remove the image.
`sidebar_image_filename` string	Original filename of the uploaded sidebar image.
`sidebar_image_file_type` string	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.

CODE SAMPLES

curl

Learn how to run these code samples in your terminal by reading our guide.