6. Freeze

To temporarily freeze a record and prevent transactions, information must be sent through this service.

Send Information to Apply Freeze Operation on the Record

POST {{WalletUrl}}/api/v1/wallet/freeze

Note: In order to use this service, the apikeypublic and apiclientpublic parameters must be included in the Header section.

WalletAPI Address

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

Parameter	Type	Required	Description
apikeypublic	string	Yes	It is the authentication key used in every request made through the API.
apiclientpublic	string	Yes	It is the public key sent to authenticate the identity of the client using the API.

Service Request - JSON

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

Service Request

Parameter	Type	Description
Id	Guid	The identity information of the wallet account to be frozen.
FrozenUntil	DateTime?	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.

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

Service Response

Parameter	Type	Description
IsFailure	bool	Indicates whether the service call was successful or not, in a boolean value.
IsSuccess	bool	A boolean value that shows whether the operation was completed successfully or not.
Errors	Array	An array structure that lists the detailed error records generated in the service.
Value	Array<Items>	The list of data objects returned as the result of the request.

Service Response (Value)

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