Retrieve installation settings • Terminal API • Reservepay

API references

Search documentation... ⌘K

Terminal 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	Always present. The ID of the installation.
`name` string	Always present. The name of the installation.
`platform` string	Always present. The platform type of the installation (e.g., `WEB`, `IOS`, `ANDROID`, `TERMINAL`). Possible values: `WEB` `IOS` `ANDROID` `TERMINAL`
`identifier` string	Always present. The unique identifier for the installation on the platform.
`payment_methods` array<object.payment_method>	Always present. List of payment methods supported by this installation.
`email_capture` string	Always present. 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. Possible values: `disabled` `optional` `required`
`mobile_capture` string	Always present. 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. Possible values: `disabled` `optional` `required`
`address_capture` string	Always present. Billing-address capture configuration for this installation. 'disabled' means no address collection, 'optional' means address fields are shown but optional, 'required' means the fields listed in each payment method's `required_fields` are mandatory. Possible values: `disabled` `optional` `required`
`merchant_name` string	Always present. The name of the merchant that owns this installation.
`interest_bearer` string	Nullable. The merchant's default for who bears installment interest. When `merchant`, the customer pays only the original amount split across the installment months. When `customer`, the customer pays the original amount plus interest. `null` when the merchant has no default configured, in which case `interest_bearer` must be passed explicitly to `list-installment-plans` and `select-payment-method`. Possible values: `merchant` `customer`
`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).
`dark_logo_url` string	Nullable. URL for the dark logo (for dark backgrounds).
`sidebar_image_url` string	Nullable. URL for the sidebar background image.
`terminal_name` string	Always present. Display name of the terminal that requested these settings.
`terminal_branch_name` string	Always present. Branch name configured on the terminal, if any.
`terminal_kiosk_mode` boolean	Always present. Whether the terminal is in kiosk mode.

Payment method attributes

Attribute	Description
`name` string	Always present. The name of the payment method.
`display_name` string	Always present. The display name of the payment method.
`flow` string	Always present. the flow of the payment method.
`category` string	Always present. The category of the payment method.
`requires_address` boolean	Always present. Whether this payment method collects the cardholder's billing address. Already accounts for the installation's `address_capture` setting (`false` when `address_capture` is `disabled`).
`required_fields` array<string>	Always present. Address fields that are mandatory for this payment method when the installation's `address_capture` is `required` (e.g. `street_address_1`, `postal_code`).
`banks` array<object.bank>	Always present. The banks offering installment plans for this payment method. Always empty for payment methods that are not installments.

Bank attributes

Attribute	Description
`name` string	Always present. The name of the bank offering the installment plans.
`display_name` string	Always present. The display name of the bank

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.

Open in Markdown

CODE SAMPLES

curl

curl "https://api.reservepay.com/terminals/retrieve-installation-settings" \
  -X POST
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
        "merchant_id": "123456789012",
        "terminal_id": "trm_U4vfjCFwwK",
        "device_id": "b3a98022-59cf-4f87-99ed-51a0f1cb135e"      
      }'

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