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

# Get PayLink settings

`GET /rest/v2/settings/terminal/paylink`

Retrieve the paylink configuration settings for a terminal, including enablement status and redirect URLs.

## Headers

- `api-key` string, required

## Response `200`

ok

- PayLinkPayload — payload
  - `paylink` Paylink — Contains the paylink configuration settings for the terminal.
    - `terminalId` integer, required — Identifier for the terminal associated with the Paylink settings.
    - `enabled` true | false, required — Indicates whether Paylink settings are enabled (true) or disabled (false).
    - `metadata` object, required — Optional key-value pairs for storing additional custom metadata.
    - `success-url` string, required — URL to redirect the user after a successful payment.
    - `cancel-url` string, required — URL to redirect the user if the payment is canceled.
  - `payloadType` string — Type of payload returned in the response.

## Other responses

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

---

[API](https://skmtc.net/xplorpay/apis/external-us-onboarding-workflow.md) · [All operations](https://skmtc.net/xplorpay/apis/external-us-onboarding-workflow/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xplorpay/external-us-onboarding-workflow/revisions/f37077c24b66/schema)