# Get Paylink settings

To get the current paylink settings for a terminal:

{% stepper %}
{% step %}
Use the GET method with the `/rest/v2/settings/terminal/paylink` endpoint.
{% endstep %}

{% step %}
Add the following header parameter in the request.

<table><thead><tr><th width="100.3333740234375">Name</th><th width="119.66668701171875">Data type</th><th width="119.66668701171875">Required?</th><th>Description</th></tr></thead><tbody><tr><td><code>api-key</code></td><td>String</td><td>Required</td><td>The API key used to securely access the service.</td></tr></tbody></table>
{% endstep %}
{% endstepper %}

The following response code appears when Paylink settings are retrieved successfully:

{% code lineNumbers="true" %}

```json
{
    "code": "200",
    "status": "SUCCESS",
    "exchange-id": "ID-clearent-gss-2-af985d57-7d87-4ba6-88c7-249b1b6d7283",
    "links": [
        {
            "rel": "terminal",
            "href": "https://gateway-sb.clearent.net/rest/v2/settings/terminal"
        }.
        {
            "rel": "hpp",
            "href": "https://gateway-sb.clearent.net/rest/v2/settings/terminal/hpp"
        },
        {
            "rel": "self",
            "href": "https://gateway-sb.clearent.net/rest/v2/settings/terminal/paylink"
        }
    ],
    "payload": {
        "paylink": {
            "terminalId": 42930,
            "enabled": true,
            "metadata": {
                "show-billing-address": "true
                "require-billing-address": "true",    
            },
            "success-url": "https://www.website.com/success",
            "cancel-url": "https://www.website.com/cancel"
        },
        "payloadType": "paylink-settings"
    }
}

```

{% endcode %}

The following table describes the fields in the response body for the retrieved Paylink settings:

<table><thead><tr><th width="160.333251953125" valign="top">Name</th><th width="140" valign="top">Data type</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top"><code>status</code></td><td valign="top">Text</td><td valign="top"><p>A text in response to your API authentication request, such as:</p><ul><li><strong>Success</strong>: The API request was authenticated successfully.</li><li><strong>Fail</strong>: The API request failed authentication.</li></ul></td></tr><tr><td valign="top"><code>exchange-id</code></td><td valign="top">String</td><td valign="top">The GUID (Global Unique Identifier) associated with the paylink settings.</td></tr><tr><td valign="top"><code>links</code></td><td valign="top">Array</td><td valign="top">List of links associated with the merchant’s paylink settings.</td></tr><tr><td valign="top"><code>rel</code></td><td valign="top">Text</td><td valign="top">The current status of the paylink setting. This field shows <strong><code>self</code></strong> when the setting is enabled for a merchant.</td></tr><tr><td valign="top"><code>href</code></td><td valign="top">Text</td><td valign="top">The URL associated with the merchant’s paylink settings.</td></tr><tr><td valign="top"><code>payload</code></td><td valign="top">Object</td><td valign="top">Contains the details of the payload settings.</td></tr><tr><td valign="top"><code>payload.paylink</code></td><td valign="top">Object</td><td valign="top">Contains the details of the paylink settings and configurations</td></tr><tr><td valign="top"><code>payload.paylink.terminalId</code></td><td valign="top">Text</td><td valign="top">The internal terminal ID associated with the merchant’s paylink settings.</td></tr><tr><td valign="top"><code>payload.paylink.enabled</code></td><td valign="top">Boolean</td><td valign="top"><p>Indicates whether the paylink setting is enabled.</p><ul><li><code>true</code> – The paylink setting is enabled.</li><li><code>false</code> – The paylink setting is disabled.</li></ul></td></tr><tr><td valign="top"><code>payload.paylink.metadata</code></td><td valign="top">Object</td><td valign="top">Contains the details of the paylink configurations and attributes.</td></tr><tr><td valign="top"><code>payload.paylink.metadata.show-billing-address</code></td><td valign="top">Boolean</td><td valign="top"><p>Indicates whether the billing address section is shown on the payment form.</p><ul><li><code>true</code> – The billing address section is shown.</li><li><code>false</code> – The billing address section is hidden.</li></ul></td></tr><tr><td valign="top"><code>payload.paylink.metadata.required-biiling-address</code></td><td valign="top">Boolean</td><td valign="top"><p>Indicates whether the billing address section is required on the payment form.</p><ul><li><code>true</code> – The billing address section is required.</li><li><code>false</code> – The billing address section is optional.</li></ul></td></tr><tr><td valign="top"><code>payload.success-url</code></td><td valign="top">String</td><td valign="top">The URL where customers are redirected after a successful payment.</td></tr><tr><td valign="top"><code>payload.cancel-url</code></td><td valign="top">String</td><td valign="top">The URL where customers are redirected after canceling a payment.</td></tr><tr><td valign="top"><code>payload.payloadType</code></td><td valign="top">String</td><td valign="top">The payload type classification.</td></tr></tbody></table>