> For the complete documentation index, see [llms.txt](https://developer.paywall.one/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.paywall.one/payment-orchestration-integration-document/wallet-services/2.-wallet/1.-retrieve.md).

# 1. Retrieve

## **Identify Wallet Record by WalletId**

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

{% 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="110.35546875">Type</th><th width="139.52734375">Compulsory</th><th width="403">Description</th></tr></thead><tbody><tr><td>apikeypublic</td><td>string</td><td>Yes</td><td>It is the key value used for general authentication purposes in API requests.</td></tr><tr><td>apiclientpublic</td><td>string</td><td>Yes</td><td>It is the public client key that specifies which client is making the API request.</td></tr></tbody></table>

{% tabs %}
{% tab title="Service Request - 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 operation has resulted in failure or not.</td></tr><tr><td>IsSuccess</td><td>bool</td><td>It indicates whether the API call was successfully completed or not.</td></tr><tr><td>Errors</td><td>Array</td><td>It is the data field where the error records encountered during the service are listed.</td></tr><tr><td>Value</td><td>Array&#x3C;Items></td><td>It represents the main data object returned in the API response.</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 record in the system.</td></tr><tr><td>WalletOwnerId</td><td>Guid</td><td>It is the unique identifier assigned to the wallet owner.</td></tr><tr><td>Name</td><td>string</td><td>It is the name or title of the wallet owner.</td></tr><tr><td>Alias</td><td>string</td><td>It is the nickname or short name assigned to the wallet.</td></tr><tr><td>MerchantId</td><td>Guid</td><td>It is the merchant ID to which the relevant 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 associated.</td></tr><tr><td>CurrencyCode</td><td>string</td><td>It is the currency code of the wallet's associated currency (e.g., TRY, USD).</td></tr><tr><td>Balance</td><td>decimal</td><td>It is the financial value that shows the total balance of the wallet.</td></tr><tr><td>AvailableBalance</td><td>decimal</td><td>It is the available balance information suitable for making transactions.</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 is restricted from use.</td></tr><tr><td>FrozenUntil</td><td>DateTime</td><td>It is the date and time when the wallet was frozen.</td></tr><tr><td>IsFrozen</td><td>bool</td><td>It is the field that indicates whether the wallet is actively frozen (in a freeze state).</td></tr><tr><td>IsDeleted</td><td>bool</td><td>It is the flag that indicates whether the wallet has been deleted in the system.</td></tr><tr><td>CreatedAt</td><td>DateTime</td><td>It is the date and timestamp when the record was created.</td></tr><tr><td>UpdatedAt</td><td>DateTime</td><td>It is the date and time when the record was last updated in the system.</td></tr><tr><td>TransactionId</td><td>Guid</td><td>It is the unique identifier of the transaction record.</td></tr></tbody></table>