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

# Get RPS terminal settings

`GET /rest/v2/settings/terminal/rps`

## 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/rps/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve the RPS configuration for a terminal, including whether recurring payments are enabled.

## Headers

- `api-key` string, required

## Response `200`

ok

- RpsSettingsPayload: Contains the response data for the terminal's RPS configuration.
  - `rps-settings` RpsSettings: Contains Recurring Payment Service configuration for the terminal.
    - `enabled` true | false: Indicates whether the Recurring Payment Service (RPS) is enabled for the terminal.
  - `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)