> For the complete documentation index, see [llms.txt](https://developer.paywall.one/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.paywall.one/payment-orchestration-integration-document/wallet-services/9.-blocked-balance/1.-block-balance.md).

# 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>](/payment-orchestration-integration-document/environment.md)
{% endhint %}

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

<table><thead><tr><th width="162">Parameter</th><th width="119.40625">Type</th><th width="133.30078125">Compulsory</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
{
  "Amount": 1000,
  "Description": "string",
  "Id": "2ea244d1-6ed2-4eca-a84b-273c62f64606",
  "ExternalReference": "{{$guid}}"
}
```

{% endtab %}
{% endtabs %}

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

```json
{
    "IsSuccess": true,
    "IsFailure": false,
    "Value": {
        "Id": "6ec397e1-3162-43d5-b4e5-98ae8e5c2914",
        "WalletId": "2ea244d1-6ed2-4eca-a84b-273c62fa64606",
        "Amount": 1000,
        "Description": "string",
        "IsActive": true,
        "CreatedAt": "2025-08-20T15:26:08.3846533Z",
        "UpdatedAt": null
    }
}
```

{% endcode %}
{% 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>