> 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/9.-deposit-wallet.md).

# 9. Deposit (Wallet)

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

<mark style="color:yellow;">`POST`</mark> `{{WalletUrl}}/api/v1/wallet/deposit`&#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="102.3203125">Type</th><th width="137.5">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 to grant access permission in API requests.</td></tr><tr><td>apiclientpublic</td><td>string</td><td>Yes</td><td>It is the public identity key sent with each request to authenticate the client's identity.</td></tr></tbody></table>

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

```json
{
  "Id": "{{walletId}}",
  "Amount": 1,
  "Description": "description",
  "ExternalReference": "123321-123321-123321-123321"
}
```

{% endtab %}
{% endtabs %}

## **Service Request**

| Parameter         | Type    | Description                                                                           |
| ----------------- | ------- | ------------------------------------------------------------------------------------- |
| Id                | Guid    | The identity information of the wallet to which the money is to be deposited.         |
| Amount            | decimal | The amount to be deposited.                                                           |
| Description       | string  | The description of the related transaction.                                           |
| ExternalReference | string  | The transaction tracking number. You can track the transaction with this information. |

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

```json
{
    "IsSuccess": true,
    "IsFailure": false,
    "Value": {
        "Id": "aa230ce5-127d-44a0-b480-7f9c4a24a9fd",
        "Alias": "2816220769",
        "WalletId": "7883fb19-2359-4a9b-b917-f08a259898ed",
        "TransactionType": "Deposit",
        "Amount": 1,
        "GiftAmount": null,
        "Description": "string",
        "ExternalReference": "4dcac110-5511-4cdf-9047-c27bfdb203fb",
        "CreatedAt": "2025-08-20T10:09:37.0074611Z",
        "UpdatedAt": null,
        "BalanceAfterTransaction": 1.00,
        "GiftBalanceId": null,
        "UniqueCode": "68b977f6-58dc-4c48-857a-86fea5ef35c5",
        "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 control field that determines whether the performed operation resulted in an error or not.</td></tr><tr><td>IsSuccess</td><td>bool</td><td>It is the flag field that indicates whether the relevant service was successfully completed.</td></tr><tr><td>Errors</td><td>Array</td><td>It is the data list containing the error details encountered during the request.</td></tr><tr><td>Value</td><td>Array&#x3C;Items></td><td>It refers to the area where the data objects returned by the service are collectively stored.</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 automatically generated for each record in the system.</td></tr><tr><td>WalletOwnerId</td><td>Guid</td><td>It is the unique identification number assigned to the wallet owner within the system.</td></tr><tr><td>Name</td><td>string</td><td>It is the textual expression representing the wallet owner's name or the organization’s name.</td></tr><tr><td>Alias</td><td>string</td><td>It is the alternative name or short description assigned to the wallet.</td></tr><tr><td>MerchantId</td><td>Guid</td><td>It is the unique identifier number that represents the merchant.</td></tr><tr><td>RegionId</td><td>string</td><td>It is the code representing the geographic region where the wallet owner is registered.</td></tr><tr><td>CurrencyCode</td><td>string</td><td>It is the short code of the currency used in transactions (e.g., TRY, USD).</td></tr><tr><td>Balance</td><td>decimal</td><td>It is the total monetary balance held by the wallet.</td></tr><tr><td>AvailableBalance</td><td>decimal</td><td>It is the amount of available free balance for immediate use.</td></tr><tr><td>TotalGiftBalance</td><td>decimal</td><td>It shows the total gift balance accumulated in the wallet.</td></tr><tr><td>BlockedBalance</td><td>decimal</td><td>It is the blocked balance information that is restricted from use.</td></tr><tr><td>FrozenUntil</td><td>DateTime</td><td>It shows the date when the wallet is suspended and when it will be reopened.</td></tr><tr><td>IsFrozen</td><td>bool</td><td>It indicates whether the wallet is in a frozen (inactive) state.</td></tr><tr><td>IsDeleted</td><td>bool</td><td>It is the field that indicates whether the related record has been marked as deleted in the system.</td></tr><tr><td>CreatedAt</td><td>DateTime</td><td>It is the date when the record was first created in the system.</td></tr><tr><td>UpdatedAt</td><td>DateTime</td><td>It contains the date and time when the record was last edited.</td></tr><tr><td>TransactionId</td><td>Guid</td><td>It is the unique identifier of the related transaction movement.</td></tr></tbody></table>