> 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/6.-gift-balance/4.-query-wallet.md).

# 4. Query (Wallet)

## Query Gift Balance Record with 'WalletId'

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

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

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

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

<table><thead><tr><th width="162">Parameter</th><th width="107.6171875">Type</th><th width="140.0234375">Compolsory</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 information that provides general access to the API services.</td></tr><tr><td>apiclientpublic</td><td>string</td><td>Yes</td><td>It is the public client key information that identifies the client application.</td></tr></tbody></table>

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

| Parameter | Description                                                                              |
| --------- | ---------------------------------------------------------------------------------------- |
| Id        | It is the identity information of the wallet where the defined gift balance is assigned. |

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

```json
{
    "IsSuccess": true,
    "IsFailure": false,
    "Value": [
        {
            "Id": "29bddd16-16d1-4b16-bca9-906f9ef80725",
            "WalletId": "7883fb19-2359-4a9b-b917-f08a259898ed",
            "Amount": 100.00,
            "RemainingAmount": 100.00,
            "ExpirationDate": "2025-11-10T21:00:00Z",
            "IsUnlimited": false,
            "Description": "External Gift Balance",
            "IsUsed": false,
            "IsFullyUsed": false,
            "IsPartiallyUsed": false,
            "LastTransactionId": null,
            "CreatedAt": "2025-08-20T14:32:16.468416Z",
            "UpdatedAt": null
        },
        {
            "Id": "47c4ec69-58d2-415c-841e-c1144542181b",
            "WalletId": "7883fb19-2359-4a9b-b917-f08a259898ed",
            "Amount": 100.00,
            "RemainingAmount": 100.00,
            "ExpirationDate": null,
            "IsUnlimited": true,
            "Description": "External Gift Balance",
            "IsUsed": false,
            "IsFullyUsed": false,
            "IsPartiallyUsed": false,
            "LastTransactionId": null,
            "CreatedAt": "2025-08-20T14:33:15.741943Z",
            "UpdatedAt": null
        }
    ]
}
```

{% 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 returns false if the transaction failed, and true if it was successful.</td></tr><tr><td>IsSuccess</td><td>bool</td><td>It returns true if the transaction was successful, and false if it failed.</td></tr><tr><td>Errors</td><td>Array</td><td>It is an array structure containing the error details that occurred.</td></tr><tr><td>Value</td><td>Array</td><td>It contains a list of items that hold the result data.</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 identity number of the gift balance.</td></tr><tr><td>WalletId</td><td>Guid</td><td>It is the identity information of the wallet where the balance is assigned.</td></tr><tr><td>Amount</td><td>decimal</td><td>It is the amount of the gift balance.</td></tr><tr><td>RemainingAmount</td><td>decimal</td><td>It is the remaining balance amount.</td></tr><tr><td>ExpirationDate</td><td>DateTime</td><td>The expiration date of the gift balance.</td></tr><tr><td>IsUnlimited</td><td>bool</td><td><p>Indicates whether the gift balance has an expiration date or not.</p><p><br>If there is an expiration date, it returns <code>false</code>, otherwise <code>true</code></p></td></tr><tr><td>Description</td><td>string</td><td>It is the description provided at the time of defining the gift balance.</td></tr><tr><td>IsUsed</td><td>bool</td><td>Has the gift balance been used?</td></tr><tr><td>IsFullyUsed</td><td>bool</td><td>Has the gift balance been fully used?</td></tr><tr><td>IsPartiallyUsed</td><td>bool</td><td>Has the gift balance been partially used?</td></tr><tr><td>LastTransactionId</td><td>Guid</td><td>It is the unique identifier of the last transaction.</td></tr><tr><td>CreatedAt</td><td>DateTime</td><td>It is the creation date of the gift balance.</td></tr><tr><td>UpdatedAt</td><td>DateTime</td><td>It is the update date of the gift balance.</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://developer.paywall.one/payment-orchestration-integration-document/wallet-services/6.-gift-balance/4.-query-wallet.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.