2. Retrieve (By-Alias)

This service should be used to access the record data corresponding to a specific alias value.

Retrieve Record by Alias Information

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

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 shared key used for authentication in API calls.
apiclientpublic	string	Yes	It is the public key sent to indicate the identity of the client using the API.

Service Response - 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 request has resulted in an error or not.
IsSuccess	bool	It is the statement that indicates whether the API operation was successfully completed or not.
Errors	Array	It is the data field where error records that occurred during the service execution are returned.
Value	Array<Items>	It represents the core data content returned by the API.

Service Response (Value)

Parameter	Type	Description
Id	Guid	It is the unique identifier of the object defined in the system.
WalletOwnerId	Guid	It is the unique identification number assigned to the wallet owner.
Name	string	It is the field that specifies the wallet owner's name or company name.
Alias	string	It is the nickname or alias assigned to the wallet.
MerchantId	Guid	It is the unique identifier of the merchant to which the wallet owner is associated.
RegionId	string	It is the geographic region ID to which the wallet owner is assigned.
CurrencyCode	string	It is the international standard code of the currency used in the transaction (e.g., TRY, USD, EUR).
Balance	decimal	It shows the total amount of money in the wallet.
AvailableBalance	decimal	It specifies the available (transaction-ready) balance amount.
TotalGiftBalance	decimal	It is the total gift balance amount in the wallet.
BlockedBalance	decimal	It is the blocked balance amount that cannot be used for transactions.
FrozenUntil	DateTime	It is the duration until the wallet's usage is temporarily suspended.
IsFrozen	bool	It is the indicator that shows whether the wallet is currently frozen.
IsDeleted	bool	It is the status field that indicates whether the wallet record has been deleted from the system.
CreatedAt	DateTime	It is the date and time when the record creation was completed.
UpdatedAt	DateTime	It is the timestamp that shows when the record was last updated.
TransactionId	Guid	It is the unique identifier assigned to the transaction record.