1. Block Balance

You can use this service to define a blocked balance for a specific wallet.

Block Balance

POST{{WalletUrl}}/api/v1/wallet/balance/blocked

Note: To use this service, the apikeypublic and apiclientpublic parameters must be included in the Header field.

WalletAPI Address

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

Parameter	Type	Compulsory	Description
apikeypublic	string	Yes	The general key used to provide API access.
apiclientpublic	string	Yes	The public identification key specific to the API client.

Service Response - JSON

{
  "Amount": 1000,
  "Description": "string",
  "Id": "2ea244d1-6ed2-4eca-a84b-273c62f64606",
  "ExternalReference": "{{$guid}}"
}

Service Response - 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
    }
}

Service Response

Parameter	Type	Description
IsFailure	bool	Indicates whether the operation was unsuccessful. If true, an error has occurred.
IsSuccess	bool	Indicates whether the operation was successful. If true, it has been completed successfully.
Errors	Array	A list containing the details of any errors that occurred.
Value	Array	Contains the main data content returned in the case of a successful response.

Service Response (Value)

Parameter	Type	Description
Id	Guid	Blocked balance identification number
WalletId	Guid	Wallet identification number
Amount	decimal	Blocked amount
Description	string	Description of the blocked balance
IsActive	bool	The active status of the blocked amount
CreatedAt	DateTime	The creation date of the record
UpdatedAt	DateTime	The date when the record was last updated