# 1. Block Balance

## **Block Balance**

<mark style="color:yellow;">`POST`</mark>`{{WalletUrl}}/api/v1/wallet/balance/blocked`

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

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

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

<table><thead><tr><th width="162">Parameter</th><th width="79">Type</th><th width="107">Required	</th><th width="403">Description</th></tr></thead><tbody><tr><td>apikeypublic</td><td>string</td><td>Yes</td><td>The general key used to provide API access.</td></tr><tr><td>apiclientpublic</td><td>string</td><td>Yes</td><td>The public identification key specific to the API client.</td></tr></tbody></table>

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

```json
{
  "Id": "0000-0000-0000-0000-0000", // walletId
  "Amount": 0.01,
  "Description": "string"
}
```

{% endtab %}
{% endtabs %}

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

<pre class="language-json" data-line-numbers><code class="lang-json">{
<strong>    "Value": {
</strong>        "Id": "0001494f-522e-40e1-96d2-18c03caecd29",
        "WalletId": "8811e7f9-7a49-43c2-9193-1c4825b81c24",
        "Amount": 100,
        "Description": "string",
        "IsActive": true,
        "CreatedAt": "2025-05-01T15:34:43.7633053Z",
        "UpdatedAt": null
    },
    "Errors": [],
<strong>    "IsSuccess": true,
</strong><strong>    "IsFailure": false
</strong><strong>}
</strong></code></pre>

{% endtab %}
{% endtabs %}

## &#x20;**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 operation was unsuccessful. If true, an error has occurred.</td></tr><tr><td>IsSuccess</td><td>bool</td><td>Indicates whether the operation was successful. If true, it has been completed successfully.</td></tr><tr><td>Errors</td><td>Array</td><td>A list containing the details of any errors that occurred.</td></tr><tr><td>Value</td><td>Array</td><td>Contains the main data content returned in the case of a successful response.</td></tr></tbody></table>

## &#x20;**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>Blocked balance identification number</td></tr><tr><td>WalletId</td><td>Guid</td><td>Wallet identification number</td></tr><tr><td>Amount</td><td>decimal</td><td>Blocked amount</td></tr><tr><td>Description</td><td>string</td><td>Description of the blocked balance</td></tr><tr><td>IsActive</td><td>bool</td><td>The active status of the blocked amount</td></tr><tr><td>CreatedAt</td><td>DateTime</td><td>The creation date of the record</td></tr><tr><td>UpdatedAt</td><td>DateTime</td><td>The date when the record was last updated</td></tr></tbody></table>