# 3. Deactivate

## Deactivate

<mark style="color:blue;">`PUT`</mark> `{{BaseAddress}}/api/paywall/checkout/passive`

{% hint style="info" %}
**Important:** To use the **Deactivate Payment** service, you must include the **apikeypublic** and **apiclientpublic** parameters in the **Header**.\
\
[<mark style="color:green;">**PaymentAPI Address**</mark>](/payment-orchestration-integration-document/environment.md)
{% endhint %}

**The header information that needs to be sent to the service is as follows:**

<details>

<summary><strong>Parameters and descriptions</strong></summary>

<table><thead><tr><th width="198">Parameter</th><th width="131.8828125">Type</th><th width="139.3125">Compulsory</th><th width="403">Description</th></tr></thead><tbody><tr><td>apikeypublic</td><td>string</td><td>Yes</td><td>The <strong>Public Key</strong> obtained from the merchant panel.</td></tr><tr><td>apiclientpublic</td><td>string</td><td>Yes</td><td>The <strong>Public Client</strong> obtained from the merchant panel.</td></tr><tr><td>Id</td><td>int</td><td>Yes</td><td>The <strong>Id</strong> value returned in the response when creating the Shared Payment page. To perform this operation, this value must be stored in your system at the time of creation.</td></tr></tbody></table>

</details>

{% tabs %}
{% tab title="JSON" %}

```json5
{
    "Id": 205334385
}
```

{% endtab %}
{% endtabs %}

**The parameters returned from the service are as follows:**

<details>

<summary><strong>Parameter descriptions</strong></summary>

<table><thead><tr><th width="189">Parameter</th><th width="100.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td>ErrorCode</td><td>int</td><td>Error code. Returns '0' if the operation is successful</td></tr><tr><td>Result</td><td>bool</td><td>Returns true or false. If the operation is successful, it returns true</td></tr><tr><td>Message</td><td>string</td><td>If the operation fails, it returns the relevant error message and provides language support based on the locale parameter</td></tr><tr><td>Body</td><td>string</td><td>Returns the payment link under the Link parameter</td></tr></tbody></table>

</details>

{% tabs %}
{% tab title="JSON" %}
{% code lineNumbers="true" %}

```json
{
    "ErrorCodeType": 1,
    "ErrorMessage": null,
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": null
}
```

{% endcode %}
{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.paywall.one/payment-orchestration-integration-document/checkout-page-service/3.-deactivate.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.