# 10. Deposit (Alias)

## **Deposit Money with Wallet 'Alias' Information**

<mark style="color:yellow;">`POST`</mark> `{{WalletUrl}}/api/v1/wallet/deposit/by/alias`&#x20;

{% hint style="info" %}
Note: In order to use this service, the **apikeypublic** and **apiclientpublic** parameters must be included 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="84.88671875">Type</th><th width="135.96875">Compulsory</th><th width="403">Description</th></tr></thead><tbody><tr><td>apikeypublic</td><td>string</td><td>Yes</td><td>It is the public 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 representing the client's system-defined identity.</td></tr></tbody></table>

{% tabs %}
{% tab title="Service Request - JSON" %}

```json
{
  "Amount": 1,
  "Description": "description",
  "Alias": "{{alias}}",
  "ExternalReference": "123321-123321-123321-123321"
}
```

{% endtab %}
{% endtabs %}

## **Service Request**

<table><thead><tr><th width="218.734375">Parameter</th><th width="180.171875">Type</th><th>Description</th></tr></thead><tbody><tr><td>Amount</td><td>decimal</td><td>The amount to be deposited.</td></tr><tr><td>Description</td><td>string</td><td>The description of the related transaction.</td></tr><tr><td>Alias</td><td>string</td><td>The account number assigned to the wallet (e.g., 1234567890).</td></tr><tr><td>ExternalReference</td><td>string</td><td>The transaction tracking number. You can track the transaction with this information.</td></tr></tbody></table>

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

```json
{
    "IsSuccess": true,
    "IsFailure": false,
    "Value": {
        "Id": "8adb2cbe-00ac-4a8b-befe-0fb204db6366",
        "Alias": "2816220769",
        "WalletId": "7883fb19-2359-4a9b-b917-f08a259898ed",
        "TransactionType": "Deposit",
        "Amount": 1,
        "GiftAmount": null,
        "Description": "string",
        "ExternalReference": "2679c1c1-64cb-42d8-bb2f-af0970c1998a",
        "CreatedAt": "2025-08-20T10:10:20.6305401Z",
        "UpdatedAt": null,
        "BalanceAfterTransaction": 3.00,
        "GiftBalanceId": null,
        "UniqueCode": "42e35902-05dd-495f-bf03-a55cf4aab41b",
        "CashbackAmount": 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 status flag that indicates whether the service call resulted in an error.</td></tr><tr><td>IsSuccess</td><td>bool</td><td>It is the confirmation that indicates the operation was successfully completed.</td></tr><tr><td>Errors</td><td>Array</td><td>It is the list structure that contains the error details that may occur during the operation.</td></tr><tr><td>Value</td><td>Array&#x3C;Items></td><td>It is the array that collects the data objects returned in the case of a successful operation.</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 entity registered in the system.</td></tr><tr><td>WalletOwnerId</td><td>Guid</td><td>It is the unique system identification number of the wallet owner.</td></tr><tr><td>Name</td><td>string</td><td>It is the name or title of the wallet user or corporate account.</td></tr><tr><td>Alias</td><td>string</td><td>It is the alias or alternative identifier name assigned to the wallet.</td></tr><tr><td>MerchantId</td><td>Guid</td><td>It is the unique identifier that represents the related merchant.</td></tr><tr><td>RegionId</td><td>string</td><td>It is the code representing the region to which the wallet owner is associated.</td></tr><tr><td>CurrencyCode</td><td>string</td><td>It is the code of the currency in which transactions in the wallet are conducted (e.g., TRY, USD).</td></tr><tr><td>Balance</td><td>decimal</td><td>It shows the total monetary value available in the wallet.</td></tr><tr><td>AvailableBalance</td><td>decimal</td><td>It is the currently available free balance.</td></tr><tr><td>TotalGiftBalance</td><td>decimal</td><td>It is the total gift balance value in the wallet.</td></tr><tr><td>BlockedBalance</td><td>decimal</td><td>It is the amount of balance subject to transaction restriction.</td></tr><tr><td>FrozenUntil</td><td>DateTime</td><td>It is the date information when the wallet is frozen and will be reactivated.</td></tr><tr><td>IsFrozen</td><td>bool</td><td>It is the information indicating whether the wallet is in a frozen status.</td></tr><tr><td>IsDeleted</td><td>bool</td><td>It indicates whether the relevant record is in a deleted status on the system.</td></tr><tr><td>CreatedAt</td><td>DateTime</td><td>It is the date and time information when the record was first created.</td></tr><tr><td>UpdatedAt</td><td>DateTime</td><td>It indicates the last update time of the record on the system.</td></tr><tr><td>TransactionId</td><td>Guid</td><td>It is the unique identifier of the performed transaction.</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/10.-deposit-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.