Developer

API references

Search documentation... ⌘K

Terminals API

All our references

Retrieve the installation settings

Returns settings and configuration for the installation linked to the terminal (payment methods, UI options, etc.), after verifying the bound device.

The terminal must be connected via connect-device and must have an installation configured on the merchant terminal record.

Endpoint signature

POST https://api.reservepay.com/terminals/retrieve-installation-settings HTTP/1.1

Content-Type: application/json

Accept: application/json

{

merchant_id: string,

terminal_id: string,

device_id: string,

}

Returns: object

New to Reservepay? Read our guide on how to call endpoints to get started.

Request arguments

merchant_id string

Required. The merchant ID this terminal belongs to.

terminal_id string

Required. Terminal ID (trm_…).

device_id string

Required. Device UUID bound to this terminal (same as connect-device).

Response attributes

Attribute	Description
`installation_id` string	The ID of the installation.
`name` string	The name of the installation.
`platform` string	The platform type of the installation (e.g., `WEB`, `IOS`, `ANDROID`, `TERMINAL`).
`identifier` string	The unique identifier for the installation on the platform.
`payment_methods` array	List of payment methods supported by this installation.
`email_capture` string	Email capture configuration for this installation. 'disabled' means no email collection, 'optional' means email is collected if provided by customer, 'required' means email is mandatory for all customers.
`mobile_capture` string	Mobile phone capture configuration for this installation. 'disabled' means no mobile number collection, 'optional' means mobile number is collected if provided by customer, 'required' means mobile number is mandatory for all customers.
`merchant_name` string	The name of the merchant that owns this installation.
`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).
`dark_logo_url` string	URL for the dark logo (for dark backgrounds).
`sidebar_image_url` string	URL for the sidebar background image.
`terminal_name` string	Display name of the terminal that requested these settings.
`terminal_branch_name` string	Branch name configured on the terminal, if any.
`terminal_kiosk_mode` boolean	Whether the terminal is in kiosk mode.

Errors specific to this endpoint


              NOT_FOUND

The merchant or terminal could not be found, or no device is bound to the terminal.


              UNRECOGNIZED_DEVICE

The device_id does not match the one bound to the terminal.


              NOT_ENABLED

The terminal exists but is disabled.


              NOT_CONFIGURED

The terminal has no installation linked; assign an installation to the terminal first.

Errors common to all endpoints


              UNHANDLED_ERROR

Raised when the server encounters an unexpected internal error.


              INVALID_ARGUMENTS

Raised when the request contains invalid or missing parameters.


              BAD_VERSION

Raised when requesting an unsupported or deprecated API version.

CODE SAMPLES

curl

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