# 7. Freeze

## **Send Information to Apply Freeze Operation on the Record**

<mark style="color:yellow;">`POST`</mark> `{{WalletUrl}}/api/v1/wallet/freeze`&#x20;

{% hint style="info" %}
**Note:** In order to use this service, the apikeypublic and apiclientpublic parameters must be included in the Header section.

[<mark style="color:green;">**WalletAPI Address**</mark>](/payment-orchestration-integration-document/environment.md)
{% endhint %}

**The parameters that must be sent to the service are as follows:**

<table><thead><tr><th width="162">Parameter</th><th width="116.5234375">Type</th><th width="149.296875">Compulsory</th><th width="403">Description</th></tr></thead><tbody><tr><td>apikeypublic</td><td>string</td><td>Yes</td><td>It is the authentication key used in every request made through the API.</td></tr><tr><td>apiclientpublic</td><td>string</td><td>Yes</td><td>It is the public key sent to authenticate the identity of the client using the API.</td></tr></tbody></table>

{% tabs %}
{% tab title="Service Request - JSON" %}

```json
{
  "Id": "{{walletId}}",
  "FrozenUntil": null
}
```

{% endtab %}
{% endtabs %}

## **Service Request**

<table><thead><tr><th>Parameter</th><th>Type</th><th width="400.2578125">Description</th></tr></thead><tbody><tr><td>Id</td><td>Guid</td><td>The identity information of the wallet account to be frozen.</td></tr><tr><td>FrozenUntil</td><td>DateTime?</td><td>When left blank, the related account will remain frozen until it is manually unfreezed by you. If a specific date is provided, the account will remain frozen until the specified date/time and will automatically become available afterwards.</td></tr></tbody></table>

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

```json
{
    "Value": {
        "Id": "30bac1c0-ad6b-4c50-a52e-1b34f9b487a7",
        "WalletOwnerId": "b5708099-be62-4d34-af06-27132082eb78",
        "Name": "juzdan1",
        "Alias": "8203287943",
        "MerchantId": 2071,
        "RegionId": 1,
        "CurrencyCode": "TRY",
        "Balance": 1.00,
        "AvailableBalance": 1.00,
        "TotalGiftBalance": 0,
        "BlockedBalance": 0,
        "FrozenUntil": "2026-03-24T20:26:25.426Z",
        "IsFrozen": true,
        "IsDeleted": false,
        "CreatedAt": "2025-04-24T09:05:47.980805Z",
        "UpdatedAt": "2025-04-25T12:20:29.7070288Z",
        "TransactionId": null
    },
    "Errors": [],
    "IsSuccess": true,
    "IsFailure": false
}
```

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

## **Service Response**

<table><thead><tr><th width="192">Parameter</th><th width="147.89192708333331">Type</th><th>Description</th></tr></thead><tbody><tr><td>IsFailure</td><td>bool</td><td>Indicates whether the service call was successful or not, in a boolean value.</td></tr><tr><td>IsSuccess</td><td>bool</td><td>A boolean value that shows whether the operation was completed successfully or not.</td></tr><tr><td>Errors</td><td>Array</td><td>An array structure that lists the detailed error records generated in the service.</td></tr><tr><td>Value</td><td>Array&#x3C;Items></td><td>The list of data objects returned as the result of the request.</td></tr></tbody></table>

## **Service Response** (Value)

<table><thead><tr><th width="234.05859375">Parameter</th><th width="162.38671875">Type</th><th width="348.94140625">Description</th></tr></thead><tbody><tr><td>Id</td><td>Guid</td><td>Represents the unique identification number of the entity in the system.</td></tr><tr><td>WalletOwnerId</td><td>Guid</td><td>The unique identification value assigned to the wallet owner.</td></tr><tr><td>Name</td><td>string</td><td>Represents the name or registered company name of the wallet owner.</td></tr><tr><td>Alias</td><td>string</td><td>The alternative short name assigned to the wallet.</td></tr><tr><td>MerchantId</td><td>Guid</td><td>The identifier of the merchant to which the wallet owner is associated.</td></tr><tr><td>RegionId</td><td>string</td><td>The representative code of the region the wallet owner is registered in.</td></tr><tr><td>CurrencyCode</td><td>string</td><td>The ISO code of the currency used in transactions for the wallet.</td></tr><tr><td>Balance</td><td>decimal</td><td>The total balance available in the wallet.</td></tr><tr><td>AvailableBalance</td><td>decimal</td><td>The amount of balance that is currently available for spending.</td></tr><tr><td>TotalGiftBalance</td><td>decimal</td><td>The total gift balance available in the wallet.</td></tr><tr><td>BlockedBalance</td><td>decimal</td><td>The amount of balance that is blocked and restricted from use.</td></tr><tr><td>FrozenUntil</td><td>DateTime</td><td>The duration until which the wallet is frozen, indicating when it will be unlocked.</td></tr><tr><td>IsFrozen</td><td>bool</td><td>Indicates whether the wallet is currently in a frozen state (cannot be used).</td></tr><tr><td>IsDeleted</td><td>bool</td><td>Indicates whether the wallet record has been deleted from the system.</td></tr><tr><td>CreatedAt</td><td>DateTim</td><td>The date and timestamp when the wallet record was created in the system.</td></tr><tr><td>UpdatedAt</td><td>DateTime</td><td>The date and timestamp when the wallet record was last updated in the system.</td></tr><tr><td>TransactionId</td><td>Guid</td><td>The unique identifier of the transaction record in the system.</td></tr></tbody></table>


---

# 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/wallet-services/2.-wallet/7.-freeze.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.