# 2. Retrieve (By-Alias)

## **Retrieve Record by Alias Information**

<mark style="color:green;">`GET`</mark>`{{WalletUrl}}/api/v1/wallet/by/alias/:alias`

{% hint style="info" %}
**Note:** Before using this service, it is mandatory to include the apikeypublic and apiclientpublic parameters in the Header section.

[<mark style="color:green;">**WalletAPI Address**</mark>](/payment-orchestration-integration-document/environment.md)
{% endhint %}

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

<table><thead><tr><th width="162">Parameter</th><th width="109.0859375">Type</th><th width="138.2109375">Compulsory</th><th width="403">Description</th></tr></thead><tbody><tr><td>apikeypublic</td><td>string</td><td>Yes</td><td>It is the shared key used for authentication in API calls.</td></tr><tr><td>apiclientpublic</td><td>string</td><td>Yes</td><td>It is the public key sent to indicate the identity of the client using the API.</td></tr></tbody></table>

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

```json
{
    "IsSuccess": true,
    "IsFailure": false,
    "Value": {
        "Id": "e75df134-185a-4b2b-b501-719dba2129c4",
        "WalletOwnerId": "0a949877-0ea0-48c3-9c92-41c9e33c461d",
        "Name": "External Test Wallet",
        "Alias": "5746347646",
        "RegionId": 1,
        "CurrencyCode": "TRY",
        "Balance": 0.00,
        "AvailableBalance": 0,
        "TotalGiftBalance": 0,
        "BlockedBalance": 0,
        "FrozenUntil": "0001-01-01T00:00:00",
        "IsFrozen": false,
        "IsDeleted": false,
        "CreatedAt": "2025-08-20T10:04:01.365948Z",
        "UpdatedAt": null,
        "AllowOverdraft": false,
        "OverdraftLimit": 0
    }
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

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

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.paywall.one/payment-orchestration-integration-document/wallet-services/2.-wallet/2.-retrieve-by-alias.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.