Developer

API references

Search documentation... ⌘K

SDK API

All our references

Retrieve the installation settings

This endpoint allows you to retrieve the settings and configuration for a specific installation (e.g. your iOS app, Android app, website, or terminal). The settings contain important information like the supported payment methods and UI customization options.

Endpoint signature

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

Content-Type: application/json

Accept: application/json

{

merchant_id: string,

installation_id: string,

}

Returns: object

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

Request arguments

merchant_id string

Required. Your merchant ID that uniquely identifies your account.

installation_id string

Required. The installation ID for this platform (e.g. your iOS app, Android app, website, or terminal).

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.

Errors specific to this endpoint


              NOT_FOUND

This error occurs when we cannot find the merchant account or installation with the IDs provided. Double check that you are using the correct IDs.

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 is either deprecated or not yet released. This commonly happens when using an outdated SDK or when the API version specified in the request URL is incorrect.

CODE SAMPLES

curl

curl "https://api.reservepay.com/sdk/retrieve-installation-settings" \
  -X POST
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
        "merchant_id": "123456789012",
        "installation_id": "ins_xhBi6ypq9G"
      }'

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