---
title: "Get HPP terminal settings"
method: GET
path: "/rest/v2/settings/terminal/hpp"
tags: ["HPP Settings"]
---

# Get HPP terminal settings

`GET /rest/v2/settings/terminal/hpp`

## Request

- The document declares no server URL.
- Auth: none declared. Required headers: `api-key`
- TypeScript: <https://skmtc.dev/xplorpay/apis/external-us-onboarding-workflow/docs/rest/v2/settings/terminal/hpp/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve the Hosted Payment Page (HPP) configuration settings for the terminal.

## Headers

- `api-key` string, required

## Response `200`

ok

- HppSettingsPayload: payload
  - `hpp-settings` HppSettings: Contains the Hosted Payment Page configuration details for the terminal.
    - `hpp-public-key` string, required: Public key used to encrypt payment data on the Hosted Payment Page.
    - `enabled` true | false, required: Indicates whether the Hosted Payment Page (HPP) settings are enabled for the terminal. Set true (enable) or false (disable).
    - `hpp-domain` string, required: HTTPS domain URL where the Hosted Payment Page is hosted.
  - `payloadType` string: Indicates the type of payload returned in the response.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

---

[API](https://skmtc.dev/xplorpay/apis/external-us-onboarding-workflow.md) - [All operations](https://skmtc.dev/xplorpay/apis/external-us-onboarding-workflow/llms.txt) - [OpenAPI document](https://skmtc.dev/xplorpay/apis/external-us-onboarding-workflow/revisions/f37077c24b66?raw)