# 2. Get by Wallet

## Identify the Wallet Record by WalletId

<mark style="color:green;">`GET`</mark> `{{WalletUrl}}/api/v1/wallet/transaction/by/wallet/:walletId?Page=1&PageSize=10&StartDate=2025-03-24T20:26:25.426Z&EndDate=2025-04-29T20:26:25.426Z&TransactionType=1`

{% hint style="info" %}
**Note:** Before calling this service, you must include the **apikeypublic** and **apiclientpublic** parameters in the Header section.

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

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

<table><thead><tr><th width="162">Parameter</th><th width="79">Type</th><th width="107">Required</th><th width="403">Description</th></tr></thead><tbody><tr><td>apikeypublic</td><td>string</td><td>Yes</td><td>It is the general key used for authentication in API access.</td></tr><tr><td>apiclientpublic</td><td>string</td><td>Yes</td><td>It is the general client key that indicates which client the request came from.</td></tr></tbody></table>

**The parameters that need to be sent to the service (QueryString) are as follows:**

<table><thead><tr><th width="212.58984375">Parameter</th><th width="503.9140625">Description</th></tr></thead><tbody><tr><td>walletId</td><td>Wallet owner types to be listed<br><br>See: <a href="broken-reference">Wallet Owner Types</a></td></tr><tr><td>Page</td><td>Page number</td></tr><tr><td>PageSize</td><td>The number of records to be retrieved per page.</td></tr><tr><td>StartDate</td><td>From the specified date onwards.</td></tr><tr><td>EndDate</td><td>Up to the specified date.</td></tr><tr><td>TransactionType</td><td>By transaction type<br><br>See: <a href="broken-reference">transaction Types</a></td></tr></tbody></table>

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

```json
{
    "Items": [
        {
            "Id": "a7b97d5c-d4ed-447b-ac01-1192839e3124",
            "WalletId": "30bac1c0-ad6b-4c50-a52e-1b34f9b487a7",
            "TransactionType": "Deposit",
            "Amount": 1.00,
            "GiftAmount": null,
            "Description": "description",
            "ExternalReference": "seamless.hps",
            "CreatedAt": "2025-04-24T09:06:47.215924Z",
            "UpdatedAt": null,
            "BalanceAfterTransaction": 1.00,
            "SourceWalletId": null,
            "DestinationWalletId": null,
            "GiftBalanceId": null,
            "MainTransactionId": null,
            "UniqueCode": "6b392dc4-ff46-4443-8653-b169c647005e",
            "UsedGiftBalances": null,
            "CashbackAmount": 0
        }
    ],
    "PageNumber": 1,
    "TotalPages": 1,
    "TotalCount": 1,
    "HasPreviousPage": false,
    "HasNextPage": false,
    "Errors": [],
    "IsSuccess": true,
    "IsFailure": false
}
```

{% 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 a boolean value that indicates whether the relevant service transaction has failed or not.</td></tr><tr><td>IsSuccess</td><td>bool</td><td>It indicates whether the relevant service has been successfully completed.</td></tr><tr><td>Errors</td><td>Array</td><td>It is the information field containing error messages that may occur during the service.</td></tr><tr><td>HasNextPage</td><td>bool</td><td>It indicates whether there is a next page in listing operations.</td></tr><tr><td>HasPreviousPage</td><td>bool</td><td>It is the indicator that shows the existence of a previous page.</td></tr><tr><td>TotalCount</td><td>int</td><td>It represents the total number of records queried.</td></tr><tr><td>TotalPages</td><td>int</td><td>It shows how many pages the results are spread across.</td></tr><tr><td>PageNumber</td><td>int</td><td>It specifies the number of the currently displayed page.</td></tr><tr><td>Items</td><td>List</td><td>It contains the list of data objects returned within the page.</td></tr></tbody></table>

## Service Response (Items)

<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 represents the unique identifier of the record or transaction in the system.</td></tr><tr><td>WalletId</td><td>Guid</td><td>It is the unique ID number of the wallet where the relevant transaction took place.</td></tr><tr><td>TransactionType</td><td>string</td><td>It defines the category of the transaction (e.g., payment, refund, transfer).</td></tr><tr><td>Amount</td><td>decimal</td><td>It represents the total amount used in the transaction.</td></tr><tr><td>GiftAmount</td><td>decimal</td><td>It is the amount used from the gift balance in the transaction.</td></tr><tr><td>Description</td><td>string</td><td>It is the brief explanatory information field related to the transaction.</td></tr><tr><td>ExternalReference</td><td>string</td><td>It is the reference code defined in an external system.</td></tr><tr><td>CreatedAt</td><td>DateTime</td><td>It specifies the timestamp of when the transaction was created.</td></tr><tr><td>UpdatedAt</td><td>DateTime</td><td>It is the timestamp of when the transaction was last updated.</td></tr><tr><td>BalanceAfterTransaction</td><td>decimal</td><td>It is the current balance remaining in the wallet after the transaction.</td></tr><tr><td>SourceWalletId</td><td>Guid</td><td>It shows the identity of the wallet from which the money was withdrawn.</td></tr><tr><td>DestinationWalletId</td><td>Guid</td><td>It is the identity information of the target wallet to which the money was sent.</td></tr><tr><td>GiftBalanceId</td><td>int</td><td>It is the identifier of the gift balance used in the transaction.</td></tr><tr><td>MainTransactionId</td><td>Guid</td><td>It is the system ID of the associated parent transaction.</td></tr><tr><td>UniqueCode</td><td>string</td><td>It is the unique identifier code specifically generated for the transaction.</td></tr><tr><td>UsedGiftBalances</td><td>List</td><td>It is the field that lists the details of the gift balances in use.</td></tr><tr><td>CashbackAmount</td><td>decimal</td><td>It shows the cashback amount provided to the user after the transaction.</td></tr></tbody></table>
