4. Query (Wallet)

You can use this service to query the defined gift balance using the wallet's identity (Id) information where it was assigned.

Query Gift Balance Record with 'WalletId'

GET{{WalletUrl}}/api/v1/balance/gift/by/wallet/:id

Note: To use this service, it is mandatory to include the apikeypublic and apiclientpublic parameters in the Header field.

WalletAPI Address

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

Parameter	Type	Compolsory	Description
apikeypublic	string	Yes	It is the shared key information that provides general access to the API services.
apiclientpublic	string	Yes	It is the public client key information that identifies the client application.

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.

Service Reguest - 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
        }
    ]
}

Service Response

Parameter	Type	Description
IsFailure	bool	It returns false if the transaction failed, and true if it was successful.
IsSuccess	bool	It returns true if the transaction was successful, and false if it failed.
Errors	Array	It is an array structure containing the error details that occurred.
Value	Array	It contains a list of items that hold the result data.

Service Response (Value)

Parameter	Type	Description
Id	Guid	It is the identity number of the gift balance.
WalletId	Guid	It is the identity information of the wallet where the balance is assigned.
Amount	decimal	It is the amount of the gift balance.
RemainingAmount	decimal	It is the remaining balance amount.
ExpirationDate	DateTime	The expiration date of the gift balance.
IsUnlimited	bool	Indicates whether the gift balance has an expiration date or not. If there is an expiration date, it returns false, otherwise true
Description	string	It is the description provided at the time of defining the gift balance.
IsUsed	bool	Has the gift balance been used?
IsFullyUsed	bool	Has the gift balance been fully used?
IsPartiallyUsed	bool	Has the gift balance been partially used?
LastTransactionId	Guid	It is the unique identifier of the last transaction.
CreatedAt	DateTime	It is the creation date of the gift balance.
UpdatedAt	DateTime	It is the update date of the gift balance.