# HPP Settings

## Get HPP Settings

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

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"paths":{"/rest/v2/settings/terminal/hpp":{"get":{"tags":["HPP Settings"],"summary":"Get HPP Settings","description":"Retrieve the Hosted Payment Page (HPP) configuration settings for the terminal.","operationId":"getSettings_5","parameters":[{"name":"api-key","in":"header","description":"An access API key issued to you by Xplor Pay.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hpp-settings-payload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/hpp-settings-payload"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}}}}}}}},"components":{"schemas":{"hpp-settings-payload":{"type":"object","properties":{"hpp-settings":{"$ref":"#/components/schemas/hpp-settings"},"payloadType":{"type":"string","description":"Indicates the type of payload returned in the response.","xml":{"name":"type","attribute":true}}},"description":"payload","xml":{"name":"payload"}},"hpp-settings":{"required":["enabled","hpp-domain","hpp-public-key"],"type":"object","properties":{"hpp-public-key":{"type":"string","description":"Public key used to encrypt payment data on the Hosted Payment Page."},"enabled":{"type":"boolean","description":"Indicates whether the Hosted Payment Page (HPP) settings are enabled for the terminal. Set true (enable) or false (disable).","enum":[true,false]},"hpp-domain":{"type":"string","description":"HTTPS domain URL where the Hosted Payment Page is hosted."}},"description":"Contains the Hosted Payment Page configuration details for the terminal.","xml":{"name":"hpp-settings"}},"ErrorPayloadResponsePayload":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ErrorPayload"},"payloadType":{"type":"string","description":"Type of payload returned in the response.","xml":{"name":"type","attribute":true}}},"description":"Payload","xml":{"name":"payload"}},"ErrorPayload":{"type":"object","properties":{"error-message":{"type":"string","description":"Describes the reason for the error."},"result-code":{"type":"string","description":"Numeric code that identifies the type of error returned by the request."},"time-stamp":{"type":"string","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"xml":{"name":"error"}}}}}
```

## Create HPP Settings

> Create and configure Hosted Payment Page (HPP) settings for a terminal.

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"paths":{"/rest/v2/settings/terminal/hpp":{"post":{"tags":["HPP Settings"],"summary":"Create HPP Settings","description":"Create and configure Hosted Payment Page (HPP) settings for a terminal.","operationId":"createSettings_2","parameters":[{"name":"api-key","in":"header","description":"An access API key issued to you by Xplor Pay.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hpp-settings"}}},"required":true},"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hpp-settings-payload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/hpp-settings-payload"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}}}}}}}},"components":{"schemas":{"hpp-settings":{"required":["enabled","hpp-domain","hpp-public-key"],"type":"object","properties":{"hpp-public-key":{"type":"string","description":"Public key used to encrypt payment data on the Hosted Payment Page."},"enabled":{"type":"boolean","description":"Indicates whether the Hosted Payment Page (HPP) settings are enabled for the terminal. Set true (enable) or false (disable).","enum":[true,false]},"hpp-domain":{"type":"string","description":"HTTPS domain URL where the Hosted Payment Page is hosted."}},"description":"Contains the Hosted Payment Page configuration details for the terminal.","xml":{"name":"hpp-settings"}},"hpp-settings-payload":{"type":"object","properties":{"hpp-settings":{"$ref":"#/components/schemas/hpp-settings"},"payloadType":{"type":"string","description":"Indicates the type of payload returned in the response.","xml":{"name":"type","attribute":true}}},"description":"payload","xml":{"name":"payload"}},"ErrorPayloadResponsePayload":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ErrorPayload"},"payloadType":{"type":"string","description":"Type of payload returned in the response.","xml":{"name":"type","attribute":true}}},"description":"Payload","xml":{"name":"payload"}},"ErrorPayload":{"type":"object","properties":{"error-message":{"type":"string","description":"Describes the reason for the error."},"result-code":{"type":"string","description":"Numeric code that identifies the type of error returned by the request."},"time-stamp":{"type":"string","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"xml":{"name":"error"}}}}}
```

## Update HPP Settings

> Update the Hosted Payment Page (HPP) settings for a terminal.

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"paths":{"/rest/v2/settings/terminal/hpp":{"put":{"tags":["HPP Settings"],"summary":"Update HPP Settings","description":"Update the Hosted Payment Page (HPP) settings for a terminal.","operationId":"updateSettings_3","parameters":[{"name":"api-key","in":"header","description":"An access API key issued to you by Xplor Pay.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hpp-settings"}}},"required":true},"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hpp-settings-payload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/hpp-settings-payload"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}}}}}}}},"components":{"schemas":{"hpp-settings":{"required":["enabled","hpp-domain","hpp-public-key"],"type":"object","properties":{"hpp-public-key":{"type":"string","description":"Public key used to encrypt payment data on the Hosted Payment Page."},"enabled":{"type":"boolean","description":"Indicates whether the Hosted Payment Page (HPP) settings are enabled for the terminal. Set true (enable) or false (disable).","enum":[true,false]},"hpp-domain":{"type":"string","description":"HTTPS domain URL where the Hosted Payment Page is hosted."}},"description":"Contains the Hosted Payment Page configuration details for the terminal.","xml":{"name":"hpp-settings"}},"hpp-settings-payload":{"type":"object","properties":{"hpp-settings":{"$ref":"#/components/schemas/hpp-settings"},"payloadType":{"type":"string","description":"Indicates the type of payload returned in the response.","xml":{"name":"type","attribute":true}}},"description":"payload","xml":{"name":"payload"}},"ErrorPayloadResponsePayload":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ErrorPayload"},"payloadType":{"type":"string","description":"Type of payload returned in the response.","xml":{"name":"type","attribute":true}}},"description":"Payload","xml":{"name":"payload"}},"ErrorPayload":{"type":"object","properties":{"error-message":{"type":"string","description":"Describes the reason for the error."},"result-code":{"type":"string","description":"Numeric code that identifies the type of error returned by the request."},"time-stamp":{"type":"string","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"xml":{"name":"error"}}}}}
```

## Delete HPP Settings

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

```json
{"openapi":"3.0.1","info":{"title":"Gateway Settings API","version":"2.0"},"paths":{"/rest/v2/settings/terminal/hpp":{"delete":{"tags":["HPP Settings"],"summary":"Delete HPP Settings","description":"Delete the Hosted Payment Page (HPP) configuration settings for the terminal.","operationId":"deleteSettings_1","parameters":[{"name":"api-key","in":"header","description":"An access API key issued to you by Xplor Pay.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hpp-settings-payload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/hpp-settings-payload"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ErrorPayloadResponsePayload"}}}}}}}},"components":{"schemas":{"hpp-settings-payload":{"type":"object","properties":{"hpp-settings":{"$ref":"#/components/schemas/hpp-settings"},"payloadType":{"type":"string","description":"Indicates the type of payload returned in the response.","xml":{"name":"type","attribute":true}}},"description":"payload","xml":{"name":"payload"}},"hpp-settings":{"required":["enabled","hpp-domain","hpp-public-key"],"type":"object","properties":{"hpp-public-key":{"type":"string","description":"Public key used to encrypt payment data on the Hosted Payment Page."},"enabled":{"type":"boolean","description":"Indicates whether the Hosted Payment Page (HPP) settings are enabled for the terminal. Set true (enable) or false (disable).","enum":[true,false]},"hpp-domain":{"type":"string","description":"HTTPS domain URL where the Hosted Payment Page is hosted."}},"description":"Contains the Hosted Payment Page configuration details for the terminal.","xml":{"name":"hpp-settings"}},"ErrorPayloadResponsePayload":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ErrorPayload"},"payloadType":{"type":"string","description":"Type of payload returned in the response.","xml":{"name":"type","attribute":true}}},"description":"Payload","xml":{"name":"payload"}},"ErrorPayload":{"type":"object","properties":{"error-message":{"type":"string","description":"Describes the reason for the error."},"result-code":{"type":"string","description":"Numeric code that identifies the type of error returned by the request."},"time-stamp":{"type":"string","description":"Date and time when the error occurred, ISO 8601 format (UTC)."}},"xml":{"name":"error"}}}}}
```