1. Retrieve

This service should be used with the Id parameter to access a specific record in the system.

Identify Wallet Record by WalletId

GET {{WalletUrl}}/api/v1/wallet/by/id/:id

Note: Before using this service, it is mandatory to include the apikeypublic and apiclientpublic parameters 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 key value used for general authentication purposes in API requests.
apiclientpublic	string	Yes	It is the public client key that specifies which client is making the API request.

Service Request - JSON

{
    "Value": {
        "Id": "30bac1c0-ad6b-4c50-a52e-1b34f9b487a7",
        "WalletOwnerId": "b5708099-be62-4d34-af06-27132082eb78",
        "Name": "Wilson",
        "Alias": "8203287943",
        "MerchantId": 2071,
        "RegionId": 1,
        "CurrencyCode": "TRY",
        "Balance": 1.00,
        "AvailableBalance": 1.00,
        "TotalGiftBalance": 0,
        "BlockedBalance": 0,
        "FrozenUntil": "0001-01-01T00:00:00",
        "IsFrozen": false,
        "IsDeleted": false,
        "CreatedAt": "2025-04-24T09:05:47.980805Z",
        "UpdatedAt": "2025-04-24T09:06:47.216932Z",
        "TransactionId": null
    },
    "Errors": [],
    "IsSuccess": true,
    "IsFailure": false
}

Service Response

Parameter	Type	Description
IsFailure	bool	It is the field that indicates whether the operation has resulted in failure or not.
IsSuccess	bool	It indicates whether the API call was successfully completed or not.
Errors	Array	It is the data field where the error records encountered during the service are listed.
Value	Array<Items>	It represents the main data object returned in the API response.

Service Response (Value)

Parameter	Type	Description
Id	Guid	It is the unique identifier of the record in the system.
WalletOwnerId	Guid	It is the unique identifier assigned to the wallet owner.
Name	string	It is the name or title of the wallet owner.
Alias	string	It is the nickname or short name assigned to the wallet.
MerchantId	Guid	It is the merchant ID to which the relevant wallet owner is associated.
RegionId	string	It is the geographic region ID to which the wallet owner is associated.
CurrencyCode	string	It is the currency code of the wallet's associated currency (e.g., TRY, USD).
Balance	decimal	It is the financial value that shows the total balance of the wallet.
AvailableBalance	decimal	It is the available balance information suitable for making transactions.
TotalGiftBalance	decimal	It is the total gift balance amount in the wallet.
BlockedBalance	decimal	It is the blocked balance amount that is restricted from use.
FrozenUntil	DateTime	It is the date and time when the wallet was frozen.
IsFrozen	bool	It is the field that indicates whether the wallet is actively frozen (in a freeze state).
IsDeleted	bool	It is the flag that indicates whether the wallet has been deleted in the system.
CreatedAt	DateTime	It is the date and timestamp when the record was created.
UpdatedAt	DateTime	It is the date and time when the record was last updated in the system.
TransactionId	Guid	It is the unique identifier of the transaction record.